Use click to test TTY cli code

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

Author: pombredanne

tests/test_cmd.py

@@ -29,7 +29,7 @@
 from attributecode import cmd
 from attributecode import Error
 
-from testing_utils import run_about_command_test
+from testing_utils import run_about_command_test_click
 from testing_utils import get_test_loc
 
 
@@ -250,16 +250,17 @@ def check_about_stdout(options, expected_loc, regen=False):
     command success and that the stdout is equal to the `expected_loc` test file
     content.
     """
-    stdout, _stderr = run_about_command_test(options)
+    result = run_about_command_test_click(options)
     if regen:
         expected_file = get_test_loc(expected_loc, must_exists=False)
         with open(expected_file, 'wb') as ef:
-            ef.write(stdout)
+            ef.write(result.output_bytes)
 
     expected_file = get_test_loc(expected_loc, must_exists=True)
-    expected = open(expected_file, 'rb').read()
-    # we do not keep ends to ignore LF/CRF differences across OSes
-    assert expected.splitlines(False) == stdout.splitlines(False)
+    with open(expected_file, 'rb') as ef:
+        expected = ef.read()
+
+    assert expected.splitlines(False) == result.output_bytes.splitlines(False)
 
 
 def test_about_help_text(regen=False):

tests/testdata/test_cmd/help/about_attrib_help.txt

@@ -2,26 +2,24 @@ 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.
+  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.
+  --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
+  --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.
+  --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_gen_help.txt

@@ -8,35 +8,33 @@ Usage: about gen [OPTIONS] LOCATION OUTPUT
   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.
+  --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:
+                                  The following additional
+                                  options are required:
 
-                                  api_url - URL to the DejaCode
-                                  License Library API endpoint
+                                  api_url - URL to the
+                                  DejaCode License Library API endpoint
 
-                                  api_key -
-                                  DejaCode API key
+                                  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.
+                                  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
+                                  (./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

@@ -3,8 +3,8 @@ 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.
+  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.
 

tests/testdata/test_cmd/help/about_inventory_help.txt

@@ -11,10 +11,10 @@ Options:
                            key=value e.g. "license_expression=gpl-2.0
   -f, --format [json|csv]  Set OUTPUT inventory file format.  [default: csv]
   --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
+                           (./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/testing_utils.py

@@ -171,3 +171,42 @@ def run_about_command_test(options, expected_rc=0):
         ).format(**locals())
         assert rc == expected_rc, error
     return stdout, stderr
+
+
+def run_about_command_test_click(options, expected_rc=0, monkeypatch=None, ):
+    """
+    Run an "about" command as a Click-controlled subprocess with the `options`
+    list of options. Return a click.testing.Result object.
+
+    If monkeypatch is provided, a tty with a size (80, 43) is mocked.
+    """
+    import click
+    from click.testing import CliRunner
+    from attributecode import cmd
+    if monkeypatch:
+        monkeypatch.setattr(click._termui_impl, 'isatty', lambda _: True)
+        monkeypatch.setattr(click , 'get_terminal_size', lambda : (80, 43,))
+    runner = CliRunner()
+
+    result = runner.invoke(cmd.cli, options, catch_exceptions=False)
+
+    output = result.output
+    if result.exit_code != expected_rc:
+        opts = get_opts(options)
+        error = '''
+Failure to run: about %(opts)s
+output:
+%(output)s
+''' % locals()
+        assert result.exit_code == expected_rc, error
+    return result
+
+
+def get_opts(options):
+    try:
+        return ' '.join(options)
+    except:
+        try:
+            return b' '.join(options)
+        except:
+            return b' '.join(map(repr, options))