Merge lp:~mthaddon/codetree/comments-only into lp:codetree

[Tom Haddon]

Make sure we correctly process config files that are empty or comments only

Make sure we correctly process config files that are empty or comments only

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Daniel Manrique (roadmr)]

LGTM, thanks!

review: Approve

[lp:~mthaddon/codetree/comments-only]

118. By Tom Haddon on 2020-06-09

Clarify comment about workers needing to be at least one

[Joel Sing (jsing)]

LGTM

review: Approve (+1)

[Benjamin Allot (ballot)]

LGTM

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 117

=== modified file 'codetree/config.py'
--- codetree/config.py	2020-04-08 09:58:38 +0000
+++ codetree/config.py	2020-06-09 14:39:18 +0000
@@ -241,7 +241,10 @@
                 workers = None
 
         if not workers:
-            workers = len(self.directive_map)
+            # Make sure there is at least one worker, even if our directive_map
+            # is empty, which can happen if the file contains comments or
+            # blank lines only.
+            workers = len(self.directive_map) or 1
 
         self.executor = concurrent.futures.ThreadPoolExecutor(
             max_workers=workers)

=== modified file 'tests/test_config.py'
--- tests/test_config.py	2020-04-20 06:38:12 +0000
+++ tests/test_config.py	2020-06-09 14:39:18 +0000
@@ -260,6 +260,12 @@
             }
         self.assertEqual(collect_info["hashes"], expected_hashes)
 
+    def test_empty_collect_file(self):
+        # Test that an empty collect file (or a file with comments only)
+        # is handled correctly and doesn't throw an error due to 0 workers.
+        collect_config = Config('tests/test_data/comments_only')
+        self.assertEqual(collect_config.build(), [])
+
 
 class TestConfigResults(TestCase):
     def test_true(self):

=== added file 'tests/test_data/comments_only'
--- tests/test_data/comments_only	1970-01-01 00:00:00 +0000
+++ tests/test_data/comments_only	2020-06-09 14:39:18 +0000
@@ -0,0 +1,1 @@
+# This file includes comments only