#210 Added support to run genattrib with a zip file and tests

Author: pombredanne

about_code_tool/genattrib.py

@@ -134,6 +134,37 @@ def check_about_file_existence_and_format(input_list):
 Create a verification CSV output for the attribution
 """
 
+def extract_zip(location):
+    """
+    Extract a zip file at location in a temp directory and return the temporary
+    directory where the archive was extracted.
+    """
+    import zipfile
+    import tempfile
+    if not zipfile.is_zipfile(location):
+        raise Exception('Incorrect zip file %(location)r' % locals())
+
+    archive_base_name = os.path.basename(location).replace('.zip', '')
+    base_dir = tempfile.mkdtemp()
+    target_dir = os.path.join(base_dir, archive_base_name)
+    os.makedirs(target_dir)
+
+    with zipfile.ZipFile(location) as zipf:
+        for info in zipf.infolist():
+            name = info.filename
+            content = zipf.read(name)
+            target = os.path.join(target_dir, name)
+            if not os.path.exists(os.path.dirname(target)):
+                os.makedirs(os.path.dirname(target))
+            if not content and target.endswith(os.path.sep):
+                if not os.path.exists(target):
+                    os.makedirs(target)
+            if not os.path.exists(target):
+                with open(target, 'wb') as f:
+                    f.write(content)
+    return target_dir
+
+
 def main(parser, options, args):
     overwrite = options.overwrite
     verbosity = options.verbosity
@@ -200,6 +231,10 @@ def main(parser, options, args):
         parser.print_help()
         sys.exit(errno.EEXIST)
 
+    if input_path.lower().endswith('.zip'):
+        # accept zipped ABOUT files as input
+        input_path = extract_zip(input_path)
+
     if isdir(output_path):
         print('Output must be a HTML file.')
         parser.print_help()

about_code_tool/tests/test_genattrib.py

@@ -21,6 +21,8 @@
 
 from about_code_tool import genattrib
 
+from about_code_tool.tests.test_about import get_temp_file
+
 
 TESTS_DIR = os.path.abspath(os.path.dirname(__file__))
 TESTDATA_DIR = os.path.join(TESTS_DIR, 'testdata')
@@ -69,3 +71,29 @@ def test_component_subset_to_sublist(self):
         expected = ['/tmp/', '/tmp/t1/']
         result = genattrib.component_subset_to_sublist(test)
         self.assertEqual(expected, result)
+
+    def test_genattrib_basic(self):
+        about_dir = 'about_code_tool/tests/testdata/genattrib/basic/'
+        generated_attrib = get_temp_file('generated.html')
+        args = [about_dir, generated_attrib]
+        options = None
+        genattrib_command_tester(args, options)
+        expected = open('about_code_tool/tests/testdata/genattrib/basic.html').read()
+        result = open(generated_attrib).read()
+        assert expected ==result
+
+    def test_genattrib_from_zipped_dir(self):
+        about_dir = 'about_code_tool/tests/testdata/genattrib/zipped_about.zip'
+        generated_attrib = get_temp_file('generated.html')
+        args = [about_dir, generated_attrib]
+        options = None
+        genattrib_command_tester(args, options)
+        expected = open('about_code_tool/tests/testdata/genattrib/zipped_about.html').read()
+        result = open(generated_attrib).read()
+        assert expected ==result
+
+
+def genattrib_command_tester(args, options):
+    parser = genattrib.get_parser()
+    options, args = parser.parse_args(args, options)
+    genattrib.main(parser, options, args)