Adding utility for verifying a set of statements contains a function call

Author: thk123

unit/testing-utils/require_goto_statements.cpp

@@ -409,3 +409,39 @@ require_goto_statements::require_entry_point_argument_assignment(
       .get_identifier();
   return argument_tmp_name;
 }
+
+/// Verify that a collection of statements contains a function call to a
+///   function whose symbol identifier matches the provided identifier
+/// \param statements: The collection of statements to inspect
+/// \param function_call_identifier: The symbol identifier of the function
+///   that should have been called
+/// \return The first code_function_callt to the relevant function or throws a
+///   no_matching_function_callt if no call is found
+code_function_callt require_goto_statements::require_function_call(
+  const std::vector<codet> &statements,
+  const irep_idt &function_call_identifier)
+{
+  // TODO: Would appreciate some review comments on whether it makes the most sense:
+  // - return a vector of matching code_function_calls
+  // - return an optionalt with the first matching call
+  // - return a code_function_callt throwing an exception if none found
+  for(const codet &statement : statements)
+  {
+    if(statement.get_statement() == ID_function_call)
+    {
+      const code_function_callt &function_call =
+        to_code_function_call(statement);
+
+      if(function_call.function().id() == ID_symbol)
+      {
+        if(
+          to_symbol_expr(function_call.function()).get_identifier() ==
+          function_call_identifier)
+        {
+          return function_call;
+        }
+      }
+    }
+  }
+  throw no_matching_function_callt(function_call_identifier);
+}

unit/testing-utils/require_goto_statements.h

@@ -47,6 +47,25 @@ class no_decl_found_exceptiont : public std::exception
   std::string _varname;
 };
 
+class no_matching_function_callt : public std::exception
+{
+public:
+  explicit no_matching_function_callt(const irep_idt &function_identifier)
+    : function_identifier(function_identifier)
+  {
+  }
+
+  virtual const char *what() const throw()
+  {
+    std::ostringstream stringStream;
+    stringStream << "Failed to find function call for: " << function_identifier;
+    return stringStream.str().c_str();
+  }
+
+private:
+  irep_idt function_identifier;
+};
+
 pointer_assignment_locationt find_struct_component_assignments(
   const std::vector<codet> &statements,
   const irep_idt &structure_name,
@@ -85,6 +104,10 @@ const irep_idt &require_struct_array_component_assignment(
 const irep_idt &require_entry_point_argument_assignment(
   const irep_idt &argument_name,
   const std::vector<codet> &entry_point_statements);
+
+code_function_callt require_function_call(
+  const std::vector<codet> &statements,
+  const irep_idt &function_call_identifier);
 }
 
 #endif // CPROVER_TESTING_UTILS_REQUIRE_GOTO_STATEMENTS_H