Added tests on Types hierarchy and selected field for migrate_handler() method

EditorialModel/test/test_model.py

@@ -1,5 +1,5 @@
 import unittest
-from unittest.mock import MagicMock, patch
+from unittest.mock import patch
 
 from EditorialModel.model import Model
 from EditorialModel.classes import EmClass
@@ -20,7 +20,7 @@ from EditorialModel.migrationhandler.dummy import DummyMigrationHandler
 class TestModel(unittest.TestCase):
 
     def setUp(self):
-        self.me = Model(EmBackendJson('EditorialModel/test/me.json'))
+        self.ed_mod = Model(EmBackendJson('EditorialModel/test/me.json'))
 
     def test_init(self):
         """ Instanciation test """
@@ -43,52 +43,52 @@ class TestModel(unittest.TestCase):
         """ Test components fetching """
         uid_l = list()
         for comp_class in [EmClass, EmType, EmField, EmFieldGroup]:
-            comp_l = self.me.components(comp_class)
+            comp_l = self.ed_mod.components(comp_class)
             #Testing types of returned components
             for component in comp_l:
                 self.assertTrue(isinstance(component, comp_class), "Model.components method doesn't return EmComponent of the right type. Asked for {} but got {}".format(type(comp_class), type(component)))
                 uid_l.append(component.uid)
 
         #Testing that we have fetched all the components
-        for uid in self.me._components['uids']:
+        for uid in self.ed_mod._components['uids']:
             self.assertIn(uid, uid_l, "Component with uid %d was not fetched" % uid)
 
         #Testing components method without parameters
-        uid_l = [comp.uid for comp in self.me.components()]
+        uid_l = [comp.uid for comp in self.ed_mod.components()]
 
-        for uid in self.me._components['uids']:
+        for uid in self.ed_mod._components['uids']:
             self.assertIn(uid, uid_l, "Component with uid %d was not fetched using me.components()" % uid)
 
-        self.assertFalse(self.me.components(EmComponent))
-        self.assertFalse(self.me.components(int))
+        self.assertFalse(self.ed_mod.components(EmComponent))
+        self.assertFalse(self.ed_mod.components(int))
 
     def test_component(self):
         """ Test component fetching by uid """
         #assert that __hash__, __eq__ and components() are corrects
-        for comp in self.me.components():
-            self.assertEqual(comp, self.me.component(comp.uid))
+        for comp in self.ed_mod.components():
+            self.assertEqual(comp, self.ed_mod.component(comp.uid))
 
         for baduid in [-1, 0xffffff, "hello"]:
-            self.assertFalse(self.me.component(baduid))
+            self.assertFalse(self.ed_mod.component(baduid))
 
     def test_sort_components(self):
         """ Test that Model.sort_components method actually sort components """
         # disordering an EmClass
-        cl_l = self.me.components(EmClass)
+        cl_l = self.ed_mod.components(EmClass)
         last_class = cl_l[0]
         last_class.rank = 10000
-        self.me.sort_components(EmClass)
-        self.assertEqual(self.me._components['EmClass'][-1].uid, last_class.uid, "The sort_components method doesn't really sort by rank")
+        self.ed_mod.sort_components(EmClass)
+        self.assertEqual(self.ed_mod._components['EmClass'][-1].uid, last_class.uid, "The sort_components method doesn't really sort by rank")
 
     def test_new_uid(self):
         """ Test that model.new_uid return a new uniq uid """
-        new_uid = self.me.new_uid()
-        self.assertNotIn(new_uid, self.me._components['uids'].keys())
+        new_uid = self.ed_mod.new_uid()
+        self.assertNotIn(new_uid, self.ed_mod._components['uids'].keys())
 
     def test_create_component_fails(self):
         """ Test the create_component method with invalid arguments """
 
-        testDatas = {
+        test_datas = {
             'name': 'FooBar',
             'classtype': 'entity',
             'help_text': None,
@@ -96,31 +96,31 @@ class TestModel(unittest.TestCase):
         }
 
         #Invalid uid
-        used_uid = self.me.components()[0].uid
+        used_uid = self.ed_mod.components()[0].uid
         for bad_uid in [used_uid, -1, -1000, 'HelloWorld']:
             with self.assertRaises(ValueError, msg="The component was created but the given uid (%s) whas invalid (allready used, negative or WTF)" % bad_uid):
-                self.me.create_component('EmClass', testDatas, uid=bad_uid)
+                self.ed_mod.create_component('EmClass', test_datas, uid=bad_uid)
 
         #Invalid component_type
         for bad_comp_name in ['EmComponent', 'EmFoobar', 'int', int]:
             with self.assertRaises(ValueError, msg="The create_component don't raise when an invalid classname (%s) is given as parameter" % bad_comp_name):
-                self.me.create_component(bad_comp_name, testDatas)
+                self.ed_mod.create_component(bad_comp_name, test_datas)
 
         #Invalid rank
         for invalid_rank in [-1, 10000]:
             with self.assertRaises(ValueError, msg="A invalid rank (%s) was given" % invalid_rank):
-                foodat = testDatas.copy()
+                foodat = test_datas.copy()
                 foodat['rank'] = invalid_rank
-                self.me.create_component('EmClass', foodat)
+                self.ed_mod.create_component('EmClass', foodat)
         with self.assertRaises(TypeError, msg="A non integer rank was given"):
-            foodat = testDatas.copy()
+            foodat = test_datas.copy()
             foodat['rank'] = 'hello world'
-            self.me.create_component('EmClass', foodat)
+            self.ed_mod.create_component('EmClass', foodat)
 
         #Invalid datas
         for invalid_datas in [dict(), [1, 2, 3, 4], ('hello', 'world')]:
             with self.assertRaises(TypeError, msg="Invalid datas was given in parameters"):
-                self.me.create_component('EmClass', invalid_datas)
+                self.ed_mod.create_component('EmClass', invalid_datas)
 
     def test_create_components(self):
         """ Test the create_component method mocking the EmComponent constructors """
@@ -137,7 +137,7 @@ class TestModel(unittest.TestCase):
                 'cls': EmType,
                 'cdats': {
                     'name': 'FooType',
-                    'class_id': self.me.components(EmClass)[0].uid,
+                    'class_id': self.ed_mod.components(EmClass)[0].uid,
                     'fields_list': [],
                 }
             },
@@ -145,14 +145,14 @@ class TestModel(unittest.TestCase):
                 'cls': EmFieldGroup,
                 'cdats': {
                     'name': 'FooFG',
-                    'class_id': self.me.components(EmClass)[0].uid,
+                    'class_id': self.ed_mod.components(EmClass)[0].uid,
                 },
             },
             'EmField': {
                 'cls': EmFieldChar,
                 'cdats': {
                     'name': 'FooField',
-                    'fieldgroup_id': self.me.components(EmFieldGroup)[0].uid,
+                    'fieldgroup_id': self.ed_mod.components(EmFieldGroup)[0].uid,
                     'fieldtype': 'char',
                     'max_length': 64,
                     'optional': True,
@@ -165,18 +165,18 @@ class TestModel(unittest.TestCase):
             }
         }
 
-        for n in params:
-            tmpuid = self.me.new_uid()
-            cdats = params[n]['cdats']
+        for cnt in params:
+            tmpuid = self.ed_mod.new_uid()
+            cdats = params[cnt]['cdats']
             cdats['string'] = MlString()
             cdats['help_text'] = MlString()
-            with patch.object(params[n]['cls'], '__init__', return_value=None) as initmock:
+            with patch.object(params[cnt]['cls'], '__init__', return_value=None) as initmock:
                 try:
-                    self.me.create_component(n, params[n]['cdats'])
+                    self.ed_mod.create_component(cnt, params[cnt]['cdats'])
                 except AttributeError:  # Raises because the component is a MagicMock
                     pass
                 cdats['uid'] = tmpuid
-                cdats['model'] = self.me
+                cdats['model'] = self.ed_mod
                 #Check that the component __init__ method was called with the good arguments
                 initmock.assert_called_once_with(**cdats)
 
@@ -184,9 +184,9 @@ class TestModel(unittest.TestCase):
         """ Test the delete_component method """
 
         #Test that the delete_check() method is called
-        for comp in self.me.components():
+        for comp in self.ed_mod.components():
             with patch.object(comp.__class__, 'delete_check', return_value=False) as del_check_mock:
-                ret = self.me.delete_component(comp.uid)
+                ret = self.ed_mod.delete_component(comp.uid)
                 del_check_mock.assert_called_once_with()
                 #Check that when the delete_check() returns False de delete_component() too
                 self.assertFalse(ret)
@@ -207,23 +207,18 @@ class TestModel(unittest.TestCase):
         """ Test the set_backend method """
 
         for backend in [EmBackendJson('EditorialModel/test/me.json'), EmBackendDummy()]:
-            self.me.set_backend(backend)
-            self.assertEqual(self.me.backend, backend)
+            self.ed_mod.set_backend(backend)
+            self.assertEqual(self.ed_mod.backend, backend)
 
         for bad_backend in [None, 'wow', int, EmBackendJson]:
             with self.assertRaises(TypeError, msg="But bad argument (%s %s) was given" % (type(bad_backend), bad_backend)):
-                self.me.set_backend(bad_backend)
+                self.ed_mod.set_backend(bad_backend)
 
-    ##
-    # @todo Test selected fields application
-    # @todo Test types hierarchy application
-    def test_migrate_handler(self):
+    def test_migrate_handler_order(self):
         """ Test that the migrate_handler() method create component in a good order """
-
-        #Testing component creation
         with patch.object(Model, 'create_component', return_value=None) as create_mock:
             try:
-                self.me.migrate_handler(None)
+                self.ed_mod.migrate_handler(None)
             except AttributeError:  # Raises because of the mock
                 pass
             order_comp = ['EmClass', 'EmType', 'EmFieldGroup', 'EmField']  # Excpected creation order
@@ -233,11 +228,11 @@ class TestModel(unittest.TestCase):
                 while order_comp[cur_comp] != mcall[1][0]:
                     cur_comp += 1
                     if cur_comp >= len(order_comp):
-                        self.assertTrue(False, 'The order of create_component() calls was not respected by migrate_handler() methods')
+                        self.fail('The order of create_component() calls was not respected by migrate_handler() methods')
 
                 #Testing uid
-                comp = self.me.component(mcall[1][2])
-                ctype = self.me.name_from_emclass(comp.__class__)
+                comp = self.ed_mod.component(mcall[1][2])
+                ctype = self.ed_mod.name_from_emclass(comp.__class__)
                 self.assertEqual(mcall[1][0], ctype, "A component was created using a uid belonging to another component type")
                 #Testing arguments of create_component
                 comp_dump = comp.attr_dump()
@@ -248,16 +243,47 @@ class TestModel(unittest.TestCase):
 
                 self.assertEqual(mcall[1][1], comp_dump)
 
-        #Now testing the select type application
-        pass
-        #Now testing the type hierarchy
-        pass
+    def test_migrate_handler_relations(self):
+        """ Test that the migrate_handler() method create Type relations correctly (selected fields and type hierarchy) """
+        field_list_orig = []
+        superiors_list_orig = dict()
+        field_list_new = []
+        superiors_list_new = dict()
+
+        for emtype in self.ed_mod.components(EmType):
+            for fluid in emtype.fields_list:
+                field_list_orig.append(fluid)
+            for nat, sup_l in emtype.superiors().items():
+                superiors_list_orig[nat] = [sup.uid for sup in sup_l]
 
-        #Now testing the hashes
         with patch.object(DummyMigrationHandler, 'register_change', return_value=None) as mh_mock:
-            new_me = self.me.migrate_handler(DummyMigrationHandler())
+            self.ed_mod.migrate_handler(DummyMigrationHandler())
+            #Getting cloned EM instance
+            new_me = mh_mock.mock_calls[-1][1][0]
+            for emtype in new_me.components(EmType):
+                for fluid in emtype.fields_list:
+                    field_list_new.append(fluid)
+                for nat, sup_l in emtype.superiors().items():
+                    superiors_list_new[nat] = [sup.uid for sup in sup_l]
+
+            for fluid in field_list_orig:
+                self.assertIn(fluid, field_list_orig, "Missing selected field (%d) when migrate_handler() is run" % fluid)
+            for fluid in field_list_new:
+                self.assertIn(fluid, field_list_new, "A field (%d) is selected when migrate_handler() is run but shouldn't be" % fluid)
+            for nat, sup_l in superiors_list_orig.items():
+                for supuid in sup_l:
+                    self.assertIn(supuid, superiors_list_new[nat], "Missing superiors (%d) when migrate_handler() is run" % supuid)
+            for nat, sup_l in superiors_list_new.items():
+                for supuid in sup_l:
+                    self.assertIn(supuid, superiors_list_orig[nat], "A superior (%d) is present when migrate_handler is called but shouldn't be" % supuid)
+
+    def test_migrate_handler_hashes(self):
+        """ Testing that the migrate_handler() method create an EM with the same hash as the original EM """
+        with patch.object(DummyMigrationHandler, 'register_change', return_value=None) as mh_mock:
+            self.ed_mod.migrate_handler(DummyMigrationHandler())
+            #Getting the cloned EM instance
             last_call = mh_mock.mock_calls[-1]
-            self.assertEqual(hash(last_call[1][0]), hash(self.me))
+            self.assertEqual(hash(last_call[1][0]), hash(self.ed_mod))
 
     def test_hash(self):
         """ Test that __hash__ and __eq__ work properly on models """
@@ -291,7 +317,7 @@ class TestModel(unittest.TestCase):
 
         for comp_cls in [EmClass, EmFieldGroup, EmType]:
             self.assertEqual(Model.name_from_emclass(comp_cls), comp_cls.__name__)
-        for comp in self.me.components(EmField):
+        for comp in self.ed_mod.components(EmField):
             self.assertEqual(Model.name_from_emclass(comp.__class__), 'EmField')
 
         for cls in [EmComponent, int, str]: