fix #1 / Problem with generating mocks for templates.

Author: kris-jusiak

README.md

@@ -55,6 +55,7 @@ find project -iname "*.h" -or -iname "*.hpp" | xargs "project/externals/gmock.py
  + easy integration with the project build system -> generate mocks files for each interface from given files limited to the project (for example via project namespace)
  + able to generate cpp files with default constructors (to speed up compilation times)
  + generate pretty output (one mock per file)
+ + mocking class templates
  + easy to extend (~300 lines of code)
  + handle c++ operators
 
@@ -73,6 +74,8 @@ find project -iname "*.h" -or -iname "*.hpp" | xargs "project/externals/gmock.py
 # file: interface file name
 # dir: interface directory
 # guard: header guard
+# template: template parameters
+# template_interface: template interface class
 # interface: interface class
 # mock_methods: generated gmock methods
 # generated_dir: generated directory
@@ -93,7 +96,7 @@ file_template_hpp = """\
 
 %(namespaces_begin)s
 
-class %(interface)sMock : public %(interface)s
+%(template)sclass %(interface)sMock : public %(template_interface)s
 {
 public:
 %(mock_methods)s

gmock.conf

@@ -2,6 +2,8 @@
 # file: interface file name
 # dir: interface directory
 # guard: header guard
+# template: template parameters
+# template_interface: template interface class
 # interface: interface class
 # mock_methods: generated gmock methods
 # generated_dir: generated directory
@@ -22,7 +24,7 @@ file_template_hpp = """\
 
 %(namespaces_begin)s
 
-class %(interface)sMock : public %(interface)s
+%(template)sclass %(interface)sMock : public %(template_interface)s
 {
 public:
 %(mock_methods)s

gmock.py

@@ -58,10 +58,11 @@ class mock_method:
         'operator~'   : 'complement_operator'
     }
 
-    def __init__(self, result_type, name, is_const, args_size, args, args_prefix = 'arg'):
+    def __init__(self, result_type, name, is_const, is_template, args_size, args, args_prefix = 'arg'):
         self.result_type = result_type
         self.name = name
         self.is_const = is_const
+        self.is_template = is_template
         self.args_size = args_size
         self.args = args
         self.args_prefix = args_prefix
@@ -110,9 +111,10 @@ def to_string(self, gap = '    '):
 
         mock.append(gap)
         mock.append(
-            "MOCK_%(const)sMETHOD%(nr)s(%(name)s, %(result_type)s(%(args)s));" % {
+            "MOCK_%(const)sMETHOD%(nr)s%(template)s(%(name)s, %(result_type)s(%(args)s));" % {
             'const' : self.is_const and 'CONST_' or '',
             'nr' : self.args_size,
+            'template' : self.is_template and '_T' or '',
             'name' : name,
             'result_type' : self.result_type,
             'args' : self.args
@@ -121,6 +123,9 @@ def to_string(self, gap = '    '):
         return ''.join(mock)
 
 class mock_generator:
+    def __is_template_class(self, decl):
+        return '<' in decl
+
     def __is_const_function(self, tokens):
         for token in reversed(tokens):
             if token == 'const':
@@ -151,6 +156,36 @@ def __get_result_type(self, tokens, name):
                 result_type.append(' ')
         return ''.join(result_type)
 
+    def __pretty_template(self, decl):
+        first = False
+        typename = []
+        typenames = []
+        for token in decl.split("::")[-1]:
+            if token == '<':
+                first = True
+            elif token == ',':
+                typenames.append(''.join(typename))
+                typename = []
+            elif token == '>':
+                typenames.append(''.join(typename))
+                typename = []
+            elif token == ' ':
+                continue
+            elif first:
+                typename.append(token)
+
+        result = []
+        if len(typenames) > 0:
+            result.append("template<")
+            for i, t in enumerate(typenames):
+                i != 0 and result.append(", ")
+                result.append("typename ")
+                result.append(t)
+            result.append(">")
+            result.append("\n")
+
+        return ''.join(result)
+
     def __pretty_mock_methods(self, mock_methods):
         result = []
         for i, mock_method in enumerate(mock_methods):
@@ -173,31 +208,44 @@ def __pretty_namespaces_end(self, decl):
             result.append("} // namespace " + namespace)
         return ''.join(result)
 
-    def __get_mock_methods(self, node, mock_methods, class_decl = ""):
+    def __get_interface(self, decl):
+        result = []
+        ignore = False
+        for token in decl.split("::")[-1]:
+            if token == '<':
+                ignore = True
+            if not ignore:
+                result.append(token)
+            if token == '>':
+                ignore = False
+        return ''.join(result)
+
+    def __get_mock_methods(self, node, mock_methods, decl = ""):
         name = str(node.displayname, self.encode)
         if node.kind == CursorKind.CXX_METHOD:
-            tokens = [str(token.spelling, self.encode) for token in node.get_tokens()]
             spelling = str(node.spelling, self.encode)
+            tokens = [str(token.spelling, self.encode) for token in node.get_tokens()]
             file = str(node.location.file.name, self.encode)
             if self.__is_pure_virtual_function(tokens):
-                mock_methods.setdefault(class_decl, [file]).append(
+                mock_methods.setdefault(decl, [file]).append(
                     mock_method(
                          self.__get_result_type(tokens, spelling),
                          spelling,
                          self.__is_const_function(tokens),
+                         self.__is_template_class(decl),
                          len(list(node.get_arguments())),
                          name[len(node.spelling) + 1 : -1]
                     )
                 )
-        elif node.kind in [CursorKind.STRUCT_DECL, CursorKind.CLASS_DECL, CursorKind.NAMESPACE]:
-            class_decl = class_decl == "" and name or class_decl + (name == "" and "" or "::") + name
-            if class_decl.startswith(self.decl):
-                [self.__get_mock_methods(c, mock_methods, class_decl) for c in node.get_children()]
+        elif node.kind in [CursorKind.CLASS_TEMPLATE, CursorKind.STRUCT_DECL, CursorKind.CLASS_DECL, CursorKind.NAMESPACE]:
+            decl = decl == "" and name or decl + (name == "" and "" or "::") + name
+            if decl.startswith(self.decl):
+                [self.__get_mock_methods(c, mock_methods, decl) for c in node.get_children()]
         else:
-            [self.__get_mock_methods(c, mock_methods, class_decl) for c in node.get_children()]
+            [self.__get_mock_methods(c, mock_methods, decl) for c in node.get_children()]
 
     def __generate_file(self, decl, mock_methods, file_type, file_template_type):
-        interface = decl.split("::")[-1]
+        interface = self.__get_interface(decl)
         mock_file = {
             'hpp' : self.mock_file_hpp % { 'interface' : interface },
             'cpp' : self.mock_file_cpp % { 'interface' : interface },
@@ -214,6 +262,8 @@ def __generate_file(self, decl, mock_methods, file_type, file_template_type):
                 'file' : os.path.basename(mock_methods[0]),
                 'namespaces_begin' : self.__pretty_namespaces_begin(decl),
                 'interface' : interface,
+                'template_interface' : decl.split("::")[-1],
+                'template' : self.__pretty_template(decl),
                 'mock_methods' : self.__pretty_mock_methods(mock_methods[1:]),
                 'namespaces_end' : self.__pretty_namespaces_end(decl)
             })

test/given/I3.hpp

@@ -2,7 +2,6 @@
 #define I3_HPP
 
 namespace n1 {
-namespace {
 
 class I3
 {
@@ -30,7 +29,6 @@ class I3
     virtual void f1() = 0;
 };
 
-} // namespace
 } // namespace n1
 
 #endif

test/given/I3I4.hpp

@@ -2,7 +2,6 @@
 #define I3I4_HPP
 
 namespace n1 {
-namespace {
 
 struct I3
 {
@@ -16,8 +15,6 @@ struct I3
     virtual void f1() = 0;
 };
 
-} // namespace
-
 class I4
 {
 public:

test/given/T.hpp

@@ -0,0 +1,12 @@
+namespace n {
+
+template <typename Elem>
+class T {
+  virtual ~T();
+
+  virtual int GetSize() const = 0;
+  virtual void Push(const Elem& x) = 0;
+};
+
+} // namespace n
+

test/gmock_test.py

@@ -76,6 +76,12 @@ def test_gmock_long_args(self):
         self.assertTrue('I2_mock.cpp' in os.listdir(self.generated_dir))
         self.assertMocks();
 
+    def test_gmock_class_templates(self):
+        self.assertEqual(0, gmock.main(['../gmock.py', '-d', self.generated_dir, 'given/T.hpp']))
+        self.assertEqual(1, len([name for name in os.listdir(self.generated_dir)]))
+        self.assertTrue('TMock.hpp' in os.listdir(self.generated_dir))
+        self.assertMocks();
+
 if __name__ == '__main__':
     unittest.main()
 

test/test.conf

@@ -9,7 +9,7 @@ file_template_hpp = """\
 
 %(namespaces_begin)s
 
-class %(interface)s_mock : public %(interface)s
+%(template)sclass %(interface)s_mock : public %(template_interface)s
 {
 public:
     %(interface)s_mock();

test/then/I3Mock.hpp

@@ -8,7 +8,6 @@
 #include "./given/I3I4.hpp"
 
 namespace n1 {
-namespace  {
 
 class I3Mock : public I3
 {
@@ -17,7 +16,6 @@ class I3Mock : public I3
 };
 
 } // namespace n1
-} // namespace 
 
 #endif // I3MOCK_HPP
 

test/then/TMock.hpp

@@ -0,0 +1,23 @@
+/*
+ * file generated by gmock: TMock.hpp
+ */
+#ifndef TMOCK_HPP
+#define TMOCK_HPP
+
+#include <gmock/gmock.h>
+#include "./given/T.hpp"
+
+namespace n {
+
+template<typename Elem>
+class TMock : public T<Elem>
+{
+public:
+    MOCK_CONST_METHOD0_T(GetSize, int());
+    MOCK_METHOD1_T(Push, void(const Elem &));
+};
+
+} // namespace n
+
+#endif // TMOCK_HPP
+