Add new test to validate CLI help

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

tests/test_cmd.py

@@ -18,6 +18,8 @@
 from __future__ import print_function
 from __future__ import unicode_literals
 
+import unittest
+
 from attributecode import CRITICAL
 from attributecode import DEBUG
 from attributecode import ERROR
@@ -27,8 +29,11 @@
 from attributecode import cmd
 from attributecode import Error
 
+from testing_utils import run_about_command_test
+from testing_utils import get_test_loc
+
 
-# NB: these tests depends on py.test stdout/err capture capabilities
+# NB: the test_report_errors* tests depend on py.test stdout/err capture capabilities
 
 def test_report_errors(capsys):
     errors = [
@@ -146,86 +151,138 @@ def test_report_errors_with_verbose_flag(capsys):
     assert expected_out == out
     assert '' == err
 
-def test_filter_errors_default():
-    errors = [
-        Error(CRITICAL, 'msg1'),
-        Error(ERROR, 'msg2'),
-        Error(INFO, 'msg3'),
-        Error(WARNING, 'msg4'),
-        Error(DEBUG, 'msg4'),
-        Error(NOTSET, 'msg4'),
-    ]
-    expected = [
-        Error(CRITICAL, 'msg1'),
-        Error(ERROR, 'msg2'),
-        Error(WARNING, 'msg4'),
-    ]
-    assert expected == cmd.filter_errors(errors)
 
+class TestFilterError(unittest.TestCase):
+    def test_filter_errors_default(self):
+        errors = [
+            Error(CRITICAL, 'msg1'),
+            Error(ERROR, 'msg2'),
+            Error(INFO, 'msg3'),
+            Error(WARNING, 'msg4'),
+            Error(DEBUG, 'msg4'),
+            Error(NOTSET, 'msg4'),
+        ]
+        expected = [
+            Error(CRITICAL, 'msg1'),
+            Error(ERROR, 'msg2'),
+            Error(WARNING, 'msg4'),
+        ]
+        assert expected == cmd.filter_errors(errors)
 
-def test_filter_errors_with_min():
-    errors = [
-        Error(CRITICAL, 'msg1'),
-        Error(ERROR, 'msg2'),
-        Error(INFO, 'msg3'),
-        Error(WARNING, 'msg4'),
-        Error(DEBUG, 'msg4'),
-        Error(NOTSET, 'msg4'),
-    ]
-    expected = [
-        Error(CRITICAL, 'msg1'),
-    ]
-    assert expected == cmd.filter_errors(errors, CRITICAL)
 
+    def test_filter_errors_with_min(self):
+        errors = [
+            Error(CRITICAL, 'msg1'),
+            Error(ERROR, 'msg2'),
+            Error(INFO, 'msg3'),
+            Error(WARNING, 'msg4'),
+            Error(DEBUG, 'msg4'),
+            Error(NOTSET, 'msg4'),
+        ]
+        expected = [
+            Error(CRITICAL, 'msg1'),
+        ]
+        assert expected == cmd.filter_errors(errors, CRITICAL)
 
-def test_filter_errors_no_errors():
-    errors = [
-        Error(INFO, 'msg3'),
-        Error(DEBUG, 'msg4'),
-        Error(NOTSET, 'msg4'),
-    ]
-    assert [] == cmd.filter_errors(errors)
 
+    def test_filter_errors_no_errors(self):
+        errors = [
+            Error(INFO, 'msg3'),
+            Error(DEBUG, 'msg4'),
+            Error(NOTSET, 'msg4'),
+        ]
+        assert [] == cmd.filter_errors(errors)
 
-def test_filter_errors_none():
-    assert [] == cmd.filter_errors([])
 
+    def test_filter_errors_none(self):
+        assert [] == cmd.filter_errors([])
 
-def test_parse_key_values_empty():
-    assert ({}, []) == cmd.parse_key_values([])
-    assert ({}, []) == cmd.parse_key_values(None)
 
+class TestParseKeyValues(unittest.TestCase):
 
-def test_parse_key_values_simple():
-    test = [
-        'key=value',
-        'This=THat',
-        'keY=bar',
-    ]
-    expected = {
-        'key': ['value', 'bar'],
-        'this': ['THat']
+    def test_parse_key_values_empty(self):
+        assert ({}, []) == cmd.parse_key_values([])
+        assert ({}, []) == cmd.parse_key_values(None)
+
+
+    def test_parse_key_values_simple(self):
+        test = [
+            'key=value',
+            'This=THat',
+            'keY=bar',
+        ]
+        expected = {
+            'key': ['value', 'bar'],
+            'this': ['THat']
+            }
+        keyvals, errors = cmd.parse_key_values(test)
+        assert expected == keyvals
+        assert not errors
+
+
+    def test_parse_key_values_with_errors(self):
+        test = [
+            'key',
+            '=THat',
+            'keY=',
+            'FOO=bar'
+        ]
+        expected = {
+            'foo': ['bar'],
         }
-    keyvals, errors = cmd.parse_key_values(test)
-    assert expected == keyvals
-    assert not errors
+        keyvals, errors = cmd.parse_key_values(test)
+        assert expected == keyvals
+        expected = [
+            'missing <key> in "=THat".',
+            'missing <value> in "keY=".',
+            'missing <value> in "key".'
+        ]
+        assert expected == errors
 
 
-def test_parse_key_values_with_errors():
-    test = [
-        'key',
-        '=THat',
-        'keY=',
-        'FOO=bar'
-    ]
-    expected = {
-        'foo': ['bar'],
-    }
-    keyvals, errors = cmd.parse_key_values(test)
-    assert expected == keyvals
-    expected = [
-        'missing <key> in "=THat".',
-        'missing <value> in "keY=".',
-        'missing <value> in "key".'
-    ]
-    assert expected == errors
+###############################################################################
+# Run full cli command
+###############################################################################
+
+def check_about_stdout(options, expected_loc, regen=False):
+    """
+    Run the about command with the `options` list of options. Assert that
+    command success and that the stdout is equal to the `expected_loc` test file
+    content.
+    """
+    stdout, _stderr = run_about_command_test(options)
+    if regen:
+        expected_file = get_test_loc(expected_loc, must_exists=False)
+        with open(expected_file, 'wb') as ef:
+            ef.write(stdout)
+
+    expected_file = get_test_loc(expected_loc, must_exists=True)
+    assert open(expected_file).read() == stdout
+
+
+def test_about_help_text(regen=False):
+    check_about_stdout(['--help'], 'test_cmd/help/about_help.txt')
+
+
+def test_about_inventory_help_text(regen=False):
+    check_about_stdout(
+        ['inventory', '--help'],
+        'test_cmd/help/about_inventory_help.txt')
+
+
+def test_about_gen_help_text(regen=False):
+    check_about_stdout(
+        ['gen', '--help'],
+        'test_cmd/help/about_gen_help.txt')
+
+
+def test_about_check_help_text(regen=False):
+    check_about_stdout(
+        ['check', '--help'],
+        'test_cmd/help/about_check_help.txt')
+
+
+def test_about_attrib_help_text(regen=False):
+    check_about_stdout(
+        ['attrib', '--help'],
+        'test_cmd/help/about_attrib_help.txt')

tests/test_validate.py

@@ -20,48 +20,47 @@
 from __future__ import unicode_literals
 
 import os
-import subprocess
+
+from testing_utils import run_about_command_test
 
 """
-Common and global checks such as codestyle and related.
+Common and global checks such as codestyle and check own ABOUT files.
 """
 
 
 root_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
 
 
 def disabled_test_codestyle():
+
     # TODO: enable me
+    import subprocess
     args = [
         os.path.join(root_dir, 'bin', 'pycodestyle'),
         '--ignore',
         'E501,W503,W504,W605',
         '--exclude=lib,lib64,tests,thirdparty,docs,bin,man,settings,local,tmp',
         '.',
     ]
+
     subprocess.check_output(args=args, cwd=root_dir)
 
 
 def check_about(path):
-    args = [os.path.join(root_dir, 'bin', 'about'), 'check', path]
-    try:
-        subprocess.check_output(args=args, cwd=root_dir)
-    except subprocess.CalledProcessError as cpe:
-        print('Failed to validate ABOUT files:\n' + cpe.output)
-        raise Exception(cpe.output)
+    run_about_command_test(['check', path])
 
 
 def test_about_thirdparty():
-    check_about('thirdparty')
+    run_about_command_test(['check', 'thirdparty'])
 
 
 def test_about_src():
-    check_about('src')
+    run_about_command_test(['check', 'src'])
 
 
 def test_about_etc():
-    check_about('etc')
+    run_about_command_test(['check', 'etc'])
 
 
 def test_about_myself():
-    check_about('about.ABOUT')
+    run_about_command_test(['check', 'about.ABOUT'])

tests/testdata/test_cmd/help/about_attrib_help.txt

@@ -0,0 +1,27 @@
+Usage: about attrib [OPTIONS] LOCATION OUTPUT
+
+  Generate an attribution document at OUTPUT using .ABOUT files at LOCATION.
+
+  LOCATION: Path to a file, directory or .zip archive containing .ABOUT
+  files.
+
+  OUTPUT: Path where to write the attribution document.
+
+Options:
+  --template TEMPLATE_FILE_PATH  Path to an optional custom attribution
+                                 template to generate the attribution
+                                 document.
+  --variable <key>=<value>       Add variable(s) as key=value for use in a
+                                 custom attribution template.
+  --inventory PATH               Path to an optional JSON or CSV inventory
+                                 file listing the subset of .ABOUT files paths
+                                 to consider when generating the attribution
+                                 document.
+  --mapping                      Use the default file mapping.config
+                                 (./attributecode/mapping.config) with mapping
+                                 between input keys and ABOUT field names.
+  --mapping-file FILE            Use a custom mapping file with mapping
+                                 between input keys and ABOUT field names.
+  -q, --quiet                    Do not print error or warning messages.
+  --verbose                      Show all error and warning messages.
+  -h, --help                     Show this message and exit.

tests/testdata/test_cmd/help/about_check_help.txt

@@ -0,0 +1,9 @@
+Usage: about check [OPTIONS] LOCATION
+
+  Check .ABOUT file(s) at LOCATION for validity and print error messages.
+
+  LOCATION: Path to a file or directory containing .ABOUT files.
+
+Options:
+  --verbose   Show all error and warning messages.
+  -h, --help  Show this message and exit.

tests/testdata/test_cmd/help/about_gen_help.txt

@@ -0,0 +1,42 @@
+Usage: about gen [OPTIONS] LOCATION OUTPUT
+
+  Generate .ABOUT files in OUTPUT directory from a JSON or CSV inventory of
+  .ABOUT files at LOCATION.
+
+  LOCATION: Path to a JSON or CSV inventory file.
+
+  OUTPUT: Path to a directory where ABOUT files are generated.
+
+Options:
+  --fetch-license KEY             Fetch license data and texts from a a
+                                  DejaCode License Library API. Create
+                                  <license>.LICENSE files from the text of
+                                  each license key side-by-side with the
+                                  generated .ABOUT file. Also enhance the
+                                  .ABOUT file with other data such name and
+                                  category.
+                                  
+                                  The following additional options
+                                  are required:
+                                  
+                                  api_url - URL to the DejaCode
+                                  License Library API endpoint
+                                  
+                                  api_key -
+                                  DejaCode API key
+                                  Example syntax:
+                                  
+                                  about gen
+                                  --fetch-license 'api_url' 'api_key'
+  --license-notice-text-location PATH
+                                  Copy the 'license_file' from the directory
+                                  to the generated location.
+  --mapping                       Use the default file mapping.config
+                                  (./attributecode/mapping.config) with
+                                  mapping between input keys and ABOUT field
+                                  names.
+  --mapping-file FILE             Use a custom mapping file with mapping
+                                  between input keys and ABOUT field names.
+  -q, --quiet                     Do not print error or warning messages.
+  --verbose                       Show all error and warning messages.
+  -h, --help                      Show this message and exit.

tests/testdata/test_cmd/help/about_help.txt

@@ -0,0 +1,19 @@
+Usage: about [OPTIONS] COMMAND [ARGS]...
+
+  Generate licensing attribution and credit notices from .ABOUT files and
+  inventories.
+
+  Read, write and collect provenance and license inventories from .ABOUT
+  files to and from JSON or CSV files.
+
+  Use about <command> --help for help on a command.
+
+Options:
+  --version   Show the version and exit.
+  -h, --help  Show this message and exit.
+
+Commands:
+  attrib     Generate an attribution document from .ABOUT files.
+  check      Validate that the format of .ABOUT files is correct.
+  gen        Generate .ABOUT files from an inventory as CSV or JSON.
+  inventory  Collect .ABOUT files and write an inventory as CSV or JSON.