Switch render_patterns to do most of its logging to stderr

Author: thibaudcolas

pattern_library/management/commands/render_patterns.py

@@ -39,7 +39,7 @@ def handle(self, **options):
         request = factory.get('/')
 
         if self.verbosity >= 2:
-            self.stdout.write(f'Target directory: {self.output_dir}')
+            self.stderr.write(f'Target directory: {self.output_dir}')
 
         # Resolve the output dir according to the directory the command is run from.
         parent_dir = Path.cwd().joinpath(self.output_dir)
@@ -52,9 +52,9 @@ def handle(self, **options):
     def render_group(self, request, parent_dir: Path, pattern_templates):
         for template in pattern_templates['templates_stored']:
             if self.verbosity >= 2:
-                self.stdout.write(f'Pattern: {template.pattern_name}')
+                self.stderr.write(f'Pattern: {template.pattern_name}')
             if self.verbosity >= 1:
-                self.stdout.write(template.origin.template_name)
+                self.stderr.write(template.origin.template_name)
 
             render_path = parent_dir.joinpath(template.pattern_name)
             rendered_pattern = render_pattern(request, template.origin.template_name)
@@ -70,7 +70,7 @@ def render_group(self, request, parent_dir: Path, pattern_templates):
 
         for pattern_type_group, pattern_templates in pattern_templates['template_groups'].items():
             if self.verbosity >= 2:
-                self.stdout.write(f'Group: {pattern_type_group}')
+                self.stderr.write(f'Group: {pattern_type_group}')
             group_parent = parent_dir.joinpath(pattern_type_group)
             if not self.dry_run:
                 group_parent.mkdir(exist_ok=True)

tests/templates/patterns/atoms/icons/icon.yaml

@@ -0,0 +1,2 @@
+context:
+  name: close

tests/tests/test_commands.py

@@ -13,40 +13,39 @@ class RenderPatternsTests(SimpleTestCase):
 
     def test_displays_patterns(self):
         stdout = io.StringIO()
-        call_command('render_patterns', dry_run=True, stdout=stdout)
-        stdout = stdout.getvalue()
+        stderr = io.StringIO()
+        call_command('render_patterns', dry_run=True, stdout=stdout, stderr=stderr)
         self.assertIn("""patterns/atoms/tags_test_atom/tags_test_atom.html
 patterns/atoms/test_atom/test_atom.html
-""", stdout)
+""", stderr.getvalue())
 
     def test_verbose_output(self):
         stdout = io.StringIO()
-        call_command('render_patterns', dry_run=True, stdout=stdout, verbosity=2)
-        stdout = stdout.getvalue()
+        stderr = io.StringIO()
+        call_command('render_patterns', dry_run=True, stdout=stdout, stderr=stderr, verbosity=2)
         self.assertIn("""Target directory: dpl-rendered-patterns
 Group: atoms
-Group: tags_test_atom
-Pattern: tags_test_atom.html
-patterns/atoms/tags_test_atom/tags_test_atom.html
-
-
-SANDWICH
-SANDNoneWICH
-SAND0WICH
-""", stdout)
+Group: icons
+Pattern: icon.html
+patterns/atoms/icons/icon.html
+""", stderr.getvalue())
+        self.assertIn("""<svg class="icon icon--close" aria-hidden="true" focusable="false">
+    <use xlink:href="#close"></use>
+</svg>""", stdout.getvalue())
 
     def test_quiet_output(self):
         stdout = io.StringIO()
-        call_command('render_patterns', dry_run=True, stdout=stdout, verbosity=0)
-        stdout = stdout.getvalue()
-        self.assertEqual(stdout, '')
+        stderr = io.StringIO()
+        call_command('render_patterns', dry_run=True, stdout=stdout, stderr=stderr, verbosity=0)
+        self.assertEqual(stdout.getvalue(), '')
+        self.assertEqual(stderr.getvalue(), '')
 
     def test_shows_output_folder(self):
         stdout = io.StringIO()
+        stderr = io.StringIO()
         temp = tempfile.gettempdir()
-        call_command('render_patterns', dry_run=True, stdout=stdout, output=temp, verbosity=2)
-        stdout = stdout.getvalue()
-        self.assertIn(temp, stdout)
+        call_command('render_patterns', dry_run=True, stdout=stdout, stderr=stderr, output=temp, verbosity=2)
+        self.assertIn(temp, stderr.getvalue())
 
 
 class RenderPatternsFileSystemTests(SimpleTestCase):
@@ -60,19 +59,21 @@ def tearDown(self):
 
     def test_uses_output(self):
         stdout = io.StringIO()
+        stderr = io.StringIO()
         modification_time_before = Path(self.output).stat().st_mtime
-        call_command('render_patterns', dry_run=False, stdout=stdout, output=self.output)
+        call_command('render_patterns', dry_run=False, stdout=stdout, stderr=stderr, output=self.output)
         self.assertNotEqual(Path(self.output).stat().st_mtime, modification_time_before)
-        stdout = stdout.getvalue()
 
     def test_uses_subfolders(self):
         stdout = io.StringIO()
-        call_command('render_patterns', dry_run=False, stdout=stdout, output=self.output)
+        stderr = io.StringIO()
+        call_command('render_patterns', dry_run=False, stdout=stdout, stderr=stderr, output=self.output)
         subfolders = Path(self.output).iterdir()
         self.assertIn('atoms', [p.name for p in subfolders])
 
     def test_outputs_html(self):
         stdout = io.StringIO()
-        call_command('render_patterns', dry_run=False, stdout=stdout, output=self.output)
+        stderr = io.StringIO()
+        call_command('render_patterns', dry_run=False, stdout=stdout, stderr=stderr, output=self.output)
         html_files = Path(self.output).glob('**/*.html')
         self.assertIn('test_atom.html', [p.name for p in html_files])