Fix coverage count of safelisted Django models (#12)

Also adds a comment to the top of the safelist to clarify that
annotations need to be added and highlights that fact in the seed
safelist command.

Author: bmedx

code_annotations/__init__.py

@@ -4,4 +4,4 @@
 
 from __future__ import absolute_import, unicode_literals
 
-__version__ = '0.2.0'
+__version__ = '0.2.1'

code_annotations/base.py

@@ -220,8 +220,8 @@ def _plugin_load_failed_handler(self, *args, **kwargs):
         Raises:
             ConfigurationException
         """
-        self.echo(args)
-        self.echo(kwargs)
+        self.echo(str(args), fg='red')
+        self.echo(str(kwargs), fg='red')
         raise ConfigurationException('Failed to load a plugin, aborting.')
 
     def _configure_extensions(self):

code_annotations/find_django.py

@@ -63,12 +63,24 @@ def seed_safelist(self):
         safelist_data = {self.get_model_id(model): {} for model in self.non_local_models}
 
         with open(self.config.safelist_path, 'w') as safelist_file:
-            yaml_ordered_dump(safelist_data, stream=safelist_file)
-
-        self.echo('Successfully created safelist file "{}".'.format(self.config.safelist_path))
-        self.echo('Now, you need to:')
-        self.echo('  1) Make sure that any un-annotated models in the safelist are annotated, and')
-        self.echo('  2) Annotate any LOCAL models (see --list_local_models).')
+            safelist_comment = """
+# This is a Code Annotations automatically-generated Django model safelist file.
+# These models must be annotated as follows in order to be counted in the coverage report.
+# See https://code-annotations.readthedocs.io/en/latest/safelist.html for more information.
+#
+# fake_app_1.FakeModelName:
+#    ".. no_pii::": "This model has no PII"
+# fake_app_2.FakeModel2:
+#    ".. choice_annotation::": foo, bar, baz
+
+            """
+            safelist_file.write(safelist_comment.strip())
+            yaml_ordered_dump(safelist_data, stream=safelist_file, default_flow_style=False)
+
+        self.echo('Successfully created safelist file "{}".'.format(self.config.safelist_path), fg='red')
+        self.echo('Now, you need to:', fg='red')
+        self.echo('  1) Make sure that any un-annotated models in the safelist are annotated, and', fg='red')
+        self.echo('  2) Annotate any LOCAL models (see --list_local_models).', fg='red')
 
     def list_local_models(self):
         """
@@ -228,6 +240,8 @@ def search(self):
                     self.uncovered_model_ids.add(model_id)
                     self.echo.echo_vv("      {} is in the safelist.".format(model_id))
                     self._add_error("{} is in the safelist but has no annotations!".format(model_id))
+                else:
+                    self._increment_count('annotated')
 
                 self._append_safelisted_model_annotations(safelisted_models, model_id, model_annotations)
                 self.format_file_results(annotated_models, [model_annotations])

code_annotations/helpers.py

@@ -97,67 +97,70 @@ class VerboseEcho(object):
 
     verbosity = 1
 
-    def __call__(self, output):
+    def __call__(self, output, **kwargs):
         """
         Echo the given output regardless of verbosity level.
 
         This is just a convenience method to avoid lots of `self.echo.echo()`.
 
         Args:
             output: Text to output
+            kwargs: Any additional keyword args to pass to click.echo
         """
-        self.echo(output)
+        self.echo(output, **kwargs)
 
     def set_verbosity(self, verbosity):
         """
         Override the default verbosity level.
 
         Args:
             verbosity: The verbosity level to set to
-
-        Returns:
-            None
+            kwargs: Any additional keyword args to pass to click.echo
         """
         self.verbosity = verbosity
         self.echo_v("Verbosity level set to {}".format(verbosity))
 
-    def echo(self, output, verbosity_level=0):
+    def echo(self, output, verbosity_level=0, **kwargs):
         """
         Echo the given output, if over the verbosity threshold.
 
         Args:
             output: Text to output
             verbosity_level: Only output if our verbosity level is >= this.
+            kwargs: Any additional keyword args to pass to click.echo
         """
         if verbosity_level <= self.verbosity:
-            click.echo(output)
+            click.secho(output, **kwargs)
 
-    def echo_v(self, output):
+    def echo_v(self, output, **kwargs):
         """
         Echo the given output if verbosity level is >= 1.
 
         Args:
             output: Text to output
+            kwargs: Any additional keyword args to pass to click.echo
         """
-        self.echo(output, 1)
+        self.echo(output, 1, **kwargs)
 
-    def echo_vv(self, output):
+    def echo_vv(self, output, **kwargs):
         """
         Echo the given output if verbosity level is >= 2.
 
         Args:
             output: Text to output
+            kwargs: Any additional keyword args to pass to click.echo
         """
-        self.echo(output, 2)
+        self.echo(output, 2, **kwargs)
 
-    def echo_vvv(self, output):
+    def echo_vvv(self, output, **kwargs):
         """
         Echo the given output if verbosity level is >= 3.
 
         Args:
             output: Text to output
+            kwargs: Any additional keyword args to pass to click.echo
         """
-        self.echo(output, 3)
+        self.echo(output, 3, **kwargs)
 
 
 def clean_abs_path(filename_to_clean, parent_path):

tests/test_find_django.py

@@ -32,7 +32,12 @@ def test_find_django_simple_success(**kwargs):
     """
     Tests the basic case where all models have annotations, with an empty safelist.
     """
-    test_models = {FakeChildModelSingleAnnotation, FakeChildModelMultiAnnotation, FakeChildModelSingleWithAnnotation}
+    test_models = {
+        FakeChildModelSingleAnnotation,
+        FakeChildModelMultiAnnotation,
+        FakeChildModelSingleWithAnnotation,
+        FakeBaseModelWithNoDocstring
+    }
     mock_get_models_requiring_annotations = kwargs['get_models_requiring_annotations']
     mock_get_models_requiring_annotations.return_value = (
         test_models,
@@ -54,15 +59,21 @@ def report_callback(report_contents):
         for model in test_models:
             assert 'object_id: {}'.format(DjangoSearch.get_model_id(model)) in report_contents
 
+    fake_safelist = """
+    fake_app_2.FakeBaseModelWithNoDocstring:
+        ".. no_pii::": "No PII"
+    """
+
     result = call_script_isolated(
-        ['django_find_annotations', '--config_file', 'test_config.yml', '--lint', '--report', '--coverage'],
-        test_filesystem_report_cb=report_callback
+        ['django_find_annotations', '--config_file', 'test_config.yml', '--lint', '--report', '--coverage', '-vvv'],
+        test_filesystem_report_cb=report_callback,
+        fake_safelist_data=fake_safelist
     )
 
     assert result.exit_code == EXIT_CODE_SUCCESS
     assert 'Linting passed without errors' in result.output
     assert 'Generating report to' in result.output
-    assert 'Search found 5 annotations' in result.output
+    assert 'Search found 6 annotations' in result.output
 
 
 @patch.multiple(