[Tests] add tests for entire copy_help_texts_to_database function

Author: vanadium23

django_db_comments/db_comments.py

@@ -67,6 +67,19 @@ def add_table_comments_to_database(table_comment_dict, using=DEFAULT_DB_ALIAS):
                 cursor.execute(query_for_table_comment, [comment])
 
 
+def _check_app_config(app_config, using):
+    app_label = app_config.label
+    if not app_config.models_module:
+        return False
+
+    if settings.DATABASES[using]["ENGINE"] not in ALLOWED_ENGINES:
+        return False
+
+    if not router.allow_migrate(using, app_label):
+        return False
+    return True
+
+
 def copy_help_texts_to_database(
     app_config,
     verbosity=2,
@@ -78,21 +91,19 @@ def copy_help_texts_to_database(
     """
     Create content types for models in the given app.
     """
-    if not app_config.models_module:
-        return
-
-    if settings.DATABASES[using]["ENGINE"] not in ALLOWED_ENGINES:
-        return
-
-    app_label = app_config.label
-    if not router.allow_migrate(using, app_label):
+    if not _check_app_config(app_config, using):
         return
 
-    app_config = apps.get_app_config(app_label)
     app_models = [
         app_model
         for app_model in app_config.get_models()
-        if not any([app_model.abstract, app_model.proxy, not app_model.managed])
+        if not any(
+            [
+                app_model._meta.abstract,
+                app_model._meta.proxy,
+                not app_model._meta.managed,
+            ]
+        )
     ]
 
     columns_comments = {

tests/models.py

@@ -0,0 +1,23 @@
+from django.db import models
+
+
+class TimestampedModel(models.Model):
+    created_at = models.DateTimeField("model creation time")
+
+    class Meta:
+        abstract = True
+
+
+class ExampleModel(TimestampedModel):
+    class Meta:
+        verbose_name = "This is an example for table comment"
+
+
+class ProxyModel(ExampleModel):
+    class Meta:
+        proxy = True
+
+
+class UnmanagedModel(models.Model):
+    class Meta:
+        managed = False

tests/settings.py

@@ -23,6 +23,8 @@
     "django.contrib.contenttypes",
     "django.contrib.sites",
     "django_db_comments",
+
+    "tests",
 ]
 
 SITE_ID = 1

tests/test_db_comments.py

@@ -11,8 +11,10 @@
 from mock import patch
 from psycopg2 import sql
 
+from django.apps import apps
 from django.db import models, DEFAULT_DB_ALIAS
 from django.test import TestCase
+
 try:
     from django.utils.translation import ugettext_lazy as _
 except ImportError:
@@ -25,6 +27,7 @@
     add_table_comments_to_database,
     POSTGRES_COMMENT_SQL,
     POSTGRES_COMMENT_ON_TABLE_SQL,
+    copy_help_texts_to_database,
 )
 
 
@@ -38,7 +41,7 @@ class Model(models.Model):
             )
 
             class Meta:
-                app_label = "tests"
+                app_label = "unit_test"
 
         column_comments = get_comments_for_model(Model)
         self.assertDictEqual(
@@ -91,7 +94,7 @@ def test_add_table_comments_to_database(self, mock_connections):
         mock_cursor.execute.assert_called_once_with(query, [comment])
 
     def test_ugettext_lazy_workaround(self):
-        class Model(models.Model):
+        class GettextLazyModel(models.Model):
             # Example from Django auth.User
             is_superuser = models.BooleanField(
                 _("superuser status"),
@@ -102,13 +105,36 @@ class Model(models.Model):
             )
 
             class Meta:
-                app_label = "tests"
+                app_label = "unit_test"
 
-        column_comments = get_comments_for_model(Model)
+        column_comments = get_comments_for_model(GettextLazyModel)
         self.assertDictEqual(
             column_comments,
             {
                 "is_superuser": "superuser status | Designates that this user has all "
                 "permissions without explicitly assigning them."
             },
         )
+
+    def test_post_migrate_signal(self):
+        app_config = apps.get_app_config("tests")
+        with patch(
+            "django_db_comments.db_comments._check_app_config", return_value=True
+        ):
+            with patch(
+                "django_db_comments.db_comments.add_column_comments_to_database",
+                return_value=True,
+            ) as mock_column_comments:
+                with patch(
+                    "django_db_comments.db_comments.add_table_comments_to_database",
+                    return_value=True,
+                ) as mock_table_comments:
+                    copy_help_texts_to_database(app_config)
+                    mock_table_comments.assert_called_once_with(
+                        {"tests_examplemodel": "This Is An Example For Table Comment"},
+                        "default",
+                    )
+                    mock_column_comments.assert_called_once_with(
+                        {"tests_examplemodel": {"created_at": "model creation time"}},
+                        "default",
+                    )