Move app registration test apps to test_utils

django-cms · czpython · Jun 26, 2018 · Jun 14, 2018 · Jun 14, 2018 · Jun 15, 2018
commit c1b606ebe447fca8deea67fcaec68150b01a9762
diff --git a/cms/app_base.py b/cms/app_base.py
@@ -95,8 +95,22 @@ def get_urls(self, page=None, language=None, **kwargs):
         return self._urls
 
 
-class CMSAppConfig():
+class CMSAppConfig(object):
     """Base class that all cms app configurations should inherit from"""
 
     def configure_app(self, app):
+        """
+        Implement this method if the app provides functionality that
+        other apps can use and configure.
+
+        This method will be run once for every app that defines an
+        attribute like "<app_label>_enabled" as True on its cms app
+        config class.
+        So for example if app A with label "app_a" implements this
+        method and app B and app C define app_a_enabled = True on their
+        cms config classes, the method app A has defined will run twice,
+        once for app B and once for app C.
+
+        :param app: django app that has defined the feature as enabled
+        """
         raise NotImplementedError()
diff --git a/cms/test_utils/project/app_using_non_feature/__init__.py b/cms/test_utils/project/app_using_non_feature/__init__.py
@@ -0,0 +1 @@
+default_app_config = 'cms.test_utils.project.app_using_non_feature.apps.NonFeatureCMSConfig'
diff --git a/...p_registry/app_using_non_feature/admin.py → ...ls/project/app_using_non_feature/admin.py b/...p_registry/app_using_non_feature/admin.py → ...ls/project/app_using_non_feature/admin.py
diff --git a/...pp_registry/app_using_non_feature/apps.py → ...ils/project/app_using_non_feature/apps.py b/...pp_registry/app_using_non_feature/apps.py → ...ils/project/app_using_non_feature/apps.py
@@ -2,5 +2,5 @@
 
 
 class NonFeatureCMSConfig(AppConfig):
-    name = 'cms.tests.test_app_registry.app_using_non_feature'
+    name = 'cms.test_utils.project.app_using_non_feature'
     label = 'app_using_non_feature'
diff --git a/...istry/app_using_non_feature/cms_config.py → ...oject/app_using_non_feature/cms_config.py b/...istry/app_using_non_feature/cms_config.py → ...oject/app_using_non_feature/cms_config.py
diff --git a/..._registry/app_using_non_feature/models.py → ...s/project/app_using_non_feature/models.py b/..._registry/app_using_non_feature/models.py → ...s/project/app_using_non_feature/models.py
diff --git a/...p_registry/app_using_non_feature/views.py → ...ls/project/app_using_non_feature/views.py b/...p_registry/app_using_non_feature/views.py → ...ls/project/app_using_non_feature/views.py
diff --git a/cms/test_utils/project/app_with_bad_cms_file/__init__.py b/cms/test_utils/project/app_with_bad_cms_file/__init__.py
@@ -0,0 +1 @@
+default_app_config = 'cms.test_utils.project.app_with_bad_cms_file.apps.BadCMSFileConfig'
diff --git a/...p_registry/app_with_bad_cms_file/admin.py → ...ls/project/app_with_bad_cms_file/admin.py b/...p_registry/app_with_bad_cms_file/admin.py → ...ls/project/app_with_bad_cms_file/admin.py
diff --git a/...pp_registry/app_with_bad_cms_file/apps.py → ...ils/project/app_with_bad_cms_file/apps.py b/...pp_registry/app_with_bad_cms_file/apps.py → ...ils/project/app_with_bad_cms_file/apps.py
@@ -2,5 +2,5 @@
 
 
 class BadCMSFileConfig(AppConfig):
-    name = 'cms.tests.test_app_registry.app_with_bad_cms_file'
+    name = 'cms.test_utils.project.app_with_bad_cms_file'
     label = 'bad_cms_file'
diff --git a/...istry/app_with_bad_cms_file/cms_config.py → ...oject/app_with_bad_cms_file/cms_config.py b/...istry/app_with_bad_cms_file/cms_config.py → ...oject/app_with_bad_cms_file/cms_config.py
diff --git a/..._registry/app_with_bad_cms_file/models.py → ...s/project/app_with_bad_cms_file/models.py b/..._registry/app_with_bad_cms_file/models.py → ...s/project/app_with_bad_cms_file/models.py
diff --git a/...p_registry/app_with_bad_cms_file/views.py → ...ls/project/app_with_bad_cms_file/views.py b/...p_registry/app_with_bad_cms_file/views.py → ...ls/project/app_with_bad_cms_file/views.py
diff --git a/cms/test_utils/project/app_with_cms_config/__init__.py b/cms/test_utils/project/app_with_cms_config/__init__.py
@@ -0,0 +1 @@
+default_app_config = 'cms.test_utils.project.app_with_cms_config.apps.CMSConfigConfig'
diff --git a/...app_registry/app_with_cms_config/admin.py → ...tils/project/app_with_cms_config/admin.py b/...app_registry/app_with_cms_config/admin.py → ...tils/project/app_with_cms_config/admin.py
diff --git a/..._app_registry/app_with_cms_config/apps.py → ...utils/project/app_with_cms_config/apps.py b/..._app_registry/app_with_cms_config/apps.py → ...utils/project/app_with_cms_config/apps.py
@@ -2,5 +2,5 @@
 
 
 class CMSConfigConfig(AppConfig):
-    name = 'cms.tests.test_app_registry.app_with_cms_config'
+    name = 'cms.test_utils.project.app_with_cms_config'
     label = 'app_with_cms_config'
diff --git a/...egistry/app_with_cms_config/cms_config.py → ...project/app_with_cms_config/cms_config.py b/...egistry/app_with_cms_config/cms_config.py → ...project/app_with_cms_config/cms_config.py
diff --git a/...pp_registry/app_with_cms_config/models.py → ...ils/project/app_with_cms_config/models.py b/...pp_registry/app_with_cms_config/models.py → ...ils/project/app_with_cms_config/models.py
diff --git a/...app_registry/app_with_cms_config/views.py → ...tils/project/app_with_cms_config/views.py b/...app_registry/app_with_cms_config/views.py → ...tils/project/app_with_cms_config/views.py
diff --git a/cms/test_utils/project/app_with_cms_feature/__init__.py b/cms/test_utils/project/app_with_cms_feature/__init__.py
@@ -0,0 +1 @@
+default_app_config = 'cms.test_utils.project.app_with_cms_feature.apps.CMSFeatureConfig'
diff --git a/...pp_registry/app_with_cms_feature/admin.py → ...ils/project/app_with_cms_feature/admin.py b/...pp_registry/app_with_cms_feature/admin.py → ...ils/project/app_with_cms_feature/admin.py
diff --git a/...app_registry/app_with_cms_feature/apps.py → ...tils/project/app_with_cms_feature/apps.py b/...app_registry/app_with_cms_feature/apps.py → ...tils/project/app_with_cms_feature/apps.py
@@ -2,5 +2,5 @@
 
 
 class CMSFeatureConfig(AppConfig):
-    name = 'cms.tests.test_app_registry.app_with_cms_feature'
+    name = 'cms.test_utils.project.app_with_cms_feature'
     label = 'app_with_cms_feature'
diff --git a/...gistry/app_with_cms_feature/cms_config.py → ...roject/app_with_cms_feature/cms_config.py b/...gistry/app_with_cms_feature/cms_config.py → ...roject/app_with_cms_feature/cms_config.py
diff --git a/...p_registry/app_with_cms_feature/models.py → ...ls/project/app_with_cms_feature/models.py b/...p_registry/app_with_cms_feature/models.py → ...ls/project/app_with_cms_feature/models.py
diff --git a/...pp_registry/app_with_cms_feature/views.py → ...ils/project/app_with_cms_feature/views.py b/...pp_registry/app_with_cms_feature/views.py → ...ils/project/app_with_cms_feature/views.py
diff --git a/cms/test_utils/project/app_with_two_cms_app_classes/__init__.py b/cms/test_utils/project/app_with_two_cms_app_classes/__init__.py
@@ -0,0 +1 @@
+default_app_config = 'cms.test_utils.project.app_with_two_cms_app_classes.apps.TwoCMSAppClassesConfig'
diff --git a/...try/app_with_two_cms_app_classes/admin.py → ...ect/app_with_two_cms_app_classes/admin.py b/...try/app_with_two_cms_app_classes/admin.py → ...ect/app_with_two_cms_app_classes/admin.py
diff --git a/...stry/app_with_two_cms_app_classes/apps.py → ...ject/app_with_two_cms_app_classes/apps.py b/...stry/app_with_two_cms_app_classes/apps.py → ...ject/app_with_two_cms_app_classes/apps.py
@@ -2,5 +2,5 @@
 
 
 class TwoCMSAppClassesConfig(AppConfig):
-    name = 'cms.tests.test_app_registry.app_with_two_cms_app_classes'
+    name = 'cms.test_utils.project.app_with_two_cms_app_classes'
     label = 'app_with_two_cms_app_classes'
diff --git a/...pp_with_two_cms_app_classes/cms_config.py → ...pp_with_two_cms_app_classes/cms_config.py b/...pp_with_two_cms_app_classes/cms_config.py → ...pp_with_two_cms_app_classes/cms_config.py
diff --git a/...ry/app_with_two_cms_app_classes/models.py → ...ct/app_with_two_cms_app_classes/models.py b/...ry/app_with_two_cms_app_classes/models.py → ...ct/app_with_two_cms_app_classes/models.py
diff --git a/...try/app_with_two_cms_app_classes/views.py → ...ect/app_with_two_cms_app_classes/views.py b/...try/app_with_two_cms_app_classes/views.py → ...ect/app_with_two_cms_app_classes/views.py
diff --git a/cms/test_utils/project/app_without_cms_app_class/__init__.py b/cms/test_utils/project/app_without_cms_app_class/__init__.py
@@ -0,0 +1 @@
+default_app_config = 'cms.test_utils.project.app_without_cms_app_class.apps.WithoutCMSAppClassConfig'
diff --git a/...gistry/app_without_cms_app_class/admin.py → ...roject/app_without_cms_app_class/admin.py b/...gistry/app_without_cms_app_class/admin.py → ...roject/app_without_cms_app_class/admin.py
diff --git a/...egistry/app_without_cms_app_class/apps.py → ...project/app_without_cms_app_class/apps.py b/...egistry/app_without_cms_app_class/apps.py → ...project/app_without_cms_app_class/apps.py
@@ -2,5 +2,5 @@
 
 
 class WithoutCMSAppClassConfig(AppConfig):
-    name = 'cms.tests.test_app_registry.app_without_cms_app_class'
+    name = 'cms.test_utils.project.app_without_cms_app_class'
     label = 'app_without_cms_app_class'
diff --git a/...y/app_without_cms_app_class/cms_config.py → ...t/app_without_cms_app_class/cms_config.py b/...y/app_without_cms_app_class/cms_config.py → ...t/app_without_cms_app_class/cms_config.py
diff --git a/...istry/app_without_cms_app_class/models.py → ...oject/app_without_cms_app_class/models.py b/...istry/app_without_cms_app_class/models.py → ...oject/app_without_cms_app_class/models.py
diff --git a/...gistry/app_without_cms_app_class/views.py → ...roject/app_without_cms_app_class/views.py b/...gistry/app_without_cms_app_class/views.py → ...roject/app_without_cms_app_class/views.py
diff --git a/cms/test_utils/project/app_without_cms_file/__init__.py b/cms/test_utils/project/app_without_cms_file/__init__.py
@@ -0,0 +1 @@
+default_app_config = 'cms.test_utils.project.app_without_cms_file.apps.WithoutCMSFileConfig'
diff --git a/...pp_registry/app_without_cms_file/admin.py → ...ils/project/app_without_cms_file/admin.py b/...pp_registry/app_without_cms_file/admin.py → ...ils/project/app_without_cms_file/admin.py
diff --git a/...app_registry/app_without_cms_file/apps.py → ...tils/project/app_without_cms_file/apps.py b/...app_registry/app_without_cms_file/apps.py → ...tils/project/app_without_cms_file/apps.py
@@ -2,5 +2,5 @@
 
 
 class WithoutCMSFileConfig(AppConfig):
-    name = 'cms.tests.test_app_registry.app_without_cms_file'
+    name = 'cms.test_utils.project.app_without_cms_file'
     label = 'app_without_cms_file'
diff --git a/...p_registry/app_without_cms_file/models.py → ...ls/project/app_without_cms_file/models.py b/...p_registry/app_without_cms_file/models.py → ...ls/project/app_without_cms_file/models.py
diff --git a/...pp_registry/app_without_cms_file/views.py → ...ils/project/app_without_cms_file/views.py b/...pp_registry/app_without_cms_file/views.py → ...ils/project/app_without_cms_file/views.py
diff --git a/cms/tests/test_app_registration.py b/cms/tests/test_app_registration.py
@@ -15,8 +15,8 @@
 class AutodiscoverTestCase(CMSTestCase):
 
     @override_settings(INSTALLED_APPS=[
-        'cms.tests.test_app_registry.app_with_cms_feature',
-        'cms.tests.test_app_registry.app_without_cms_file'
+        'cms.test_utils.project.app_with_cms_feature',
+        'cms.test_utils.project.app_without_cms_file'
     ])
     def test_adds_cms_app_attribute_to_django_app_config(self):
         app_registration.autodiscover_cms_configs()
@@ -30,7 +30,7 @@ def test_adds_cms_app_attribute_to_django_app_config(self):
         self.assertFalse(hasattr(app_list[1], 'cms_app'))
 
     @override_settings(INSTALLED_APPS=[
-        'cms.tests.test_app_registry.app_with_bad_cms_file',
+        'cms.test_utils.project.app_with_bad_cms_file',
     ])
     def test_raises_exception_raised_in_cms_file(self):
         # The cms file intentionally raises a KeyError. We need
@@ -40,15 +40,15 @@ def test_raises_exception_raised_in_cms_file(self):
             app_registration.autodiscover_cms_configs()
 
     @override_settings(INSTALLED_APPS=[
-        'cms.tests.test_app_registry.app_without_cms_app_class',
+        'cms.test_utils.project.app_without_cms_app_class',
     ])
     def test_raises_exception_when_no_cms_app_class_found_in_cms_file(self):
         # No cms config defined in the cms file so raise exception
         with self.assertRaises(ImproperlyConfigured):
             app_registration.autodiscover_cms_configs()
 
     @override_settings(INSTALLED_APPS=[
-        'cms.tests.test_app_registry.app_with_two_cms_app_classes',
+        'cms.test_utils.project.app_with_two_cms_app_classes',
     ])
     def test_raises_exception_when_more_than_one_cms_app_class_found_in_cms_file(self):
         # More than one cms config defined so raise exception
@@ -226,9 +226,9 @@ def test_setup_cms_apps_function_run_on_startup(self, mocked_setup):
         mocked_setup.assert_called_once()
 
     @override_settings(INSTALLED_APPS=[
-        'cms.tests.test_app_registry.app_with_cms_feature',
-        'cms.tests.test_app_registry.app_without_cms_file',
-        'cms.tests.test_app_registry.app_with_cms_config'
+        'cms.test_utils.project.app_with_cms_feature',
+        'cms.test_utils.project.app_without_cms_file',
+        'cms.test_utils.project.app_with_cms_config'
     ])
     def test_cms_apps_setup_after_setup_function_run(self):
         # This is the function that gets run on startup
@@ -253,8 +253,8 @@ def test_cms_apps_setup_after_setup_function_run(self):
         self.assertTrue(config_app.cms_app.configured)
 
     @override_settings(INSTALLED_APPS=[
-        'cms.tests.test_app_registry.app_with_cms_config',
-        'cms.tests.test_app_registry.app_using_non_feature'
+        'cms.test_utils.project.app_with_cms_config',
+        'cms.test_utils.project.app_using_non_feature'
     ])
     def test_raises_not_implemented_exception_when_feature_app_doesnt_implement_configure_method(self):
         with self.assertRaises(NotImplementedError):

diff --git a/cms/tests/test_app_registry/__init__.py b/cms/tests/test_app_registry/__init__.py
diff --git a/cms/tests/test_app_registry/app_using_non_feature/__init__.py b/cms/tests/test_app_registry/app_using_non_feature/__init__.py
diff --git a/cms/tests/test_app_registry/app_with_bad_cms_file/__init__.py b/cms/tests/test_app_registry/app_with_bad_cms_file/__init__.py
diff --git a/cms/tests/test_app_registry/app_with_cms_config/__init__.py b/cms/tests/test_app_registry/app_with_cms_config/__init__.py
diff --git a/cms/tests/test_app_registry/app_with_cms_feature/__init__.py b/cms/tests/test_app_registry/app_with_cms_feature/__init__.py
diff --git a/cms/tests/test_app_registry/app_with_two_cms_app_classes/__init__.py b/cms/tests/test_app_registry/app_with_two_cms_app_classes/__init__.py
diff --git a/cms/tests/test_app_registry/app_without_cms_app_class/__init__.py b/cms/tests/test_app_registry/app_without_cms_app_class/__init__.py
diff --git a/cms/tests/test_app_registry/app_without_cms_file/__init__.py b/cms/tests/test_app_registry/app_without_cms_file/__init__.py
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		default_app_config = 'cms.test_utils.project.app_using_non_feature.apps.NonFeatureCMSConfig'