[__main__] add executable support for table inclusion and exclusion filters

new command line arguments and comma separated table definition syntax

Author: chrissimpkins

lib/fdiff/__main__.py

@@ -8,7 +8,7 @@
 from fdiff import __version__
 from fdiff.color import color_unified_diff_line
 from fdiff.diff import u_diff
-from fdiff.utils import file_exists
+from fdiff.utils import file_exists, get_tables_argument_list
 
 
 def main():  # pragma: no cover
@@ -28,9 +28,9 @@ def main():  # pragma: no cover
 
 
 def run(argv):
-    # ===========================================================
+    # ------------------------------------------
     # argparse command line argument definitions
-    # ===========================================================
+    # ------------------------------------------
     parser = argparse.ArgumentParser(
         description="An OpenType table diff tool for fonts."
     )
@@ -47,14 +47,43 @@ def run(argv):
     parser.add_argument(
         "-l", "--lines", type=int, default=3, help="Number of context lines (default 3)"
     )
+    parser.add_argument(
+        "--include",
+        type=str,
+        default=None,
+        help="Comma separated list of tables to include",
+    )
+    parser.add_argument(
+        "--exclude",
+        type=str,
+        default=None,
+        help="Comma separated list of tables to exclude",
+    )
     parser.add_argument("PREFILE", help="Font file path 1")
     parser.add_argument("POSTFILE", help="Font file path 2")
 
     args = parser.parse_args(argv)
 
+    # /////////////////////////////////////////////////////////
     #
-    #  File path argument validations
+    #  Validations
     #
+    # /////////////////////////////////////////////////////////
+
+    # ----------------------------------
+    #  Incompatible argument validations
+    # ----------------------------------
+    #   --include and --exclude are mutually exclusive options
+    if args.include and args.exclude:
+        sys.stderr.write(
+            f"[*] Error: --include and --exclude are mutually exclusive options. "
+            f"Please use ONLY one of these options in your command.{os.linesep}"
+        )
+        sys.exit(1)
+
+    # -------------------------------
+    #  File path argument validations
+    # -------------------------------
 
     if not file_exists(args.PREFILE):
         sys.stderr.write(
@@ -67,18 +96,40 @@ def run(argv):
         )
         sys.exit(1)
 
+    # /////////////////////////////////////////////////////////
     #
-    #  Unified diff logic
+    #  Command line logic
     #
+    # /////////////////////////////////////////////////////////
 
+    # ---------------
+    #  Unified diff
+    # ---------------
+
+    # parse explicitly included or excluded tables in
+    # the command line arguments
+    # set as a Python list if it was defined on the command line
+    # or as None if it was not set on the command line
+    include_list = get_tables_argument_list(args.include)
+    exclude_list = get_tables_argument_list(args.exclude)
+
+    # perform the unified diff analysis
     try:
-        diff = u_diff(args.PREFILE, args.POSTFILE, context_lines=args.lines)
+        diff = u_diff(
+            args.PREFILE,
+            args.POSTFILE,
+            context_lines=args.lines,
+            include_tables=include_list,
+            exclude_tables=exclude_list,
+        )
     except Exception as e:
         sys.stderr.write(
-            f"[*] ERROR: During the attempt to diff the requested files the following error was encountered: {str(e)}"
+            f"[*] ERROR: During the attempt to diff the requested files the following error was encountered: "
+            f"{e}{os.linesep}"
         )
         sys.exit(1)
 
+    # print unified diff results to standard output stream
     if args.color:
         for line in diff:
             sys.stdout.write(color_unified_diff_line(line))

tests/test_main.py

@@ -12,6 +12,9 @@
 ROBOTO_UDIFF_EXPECTED_PATH = os.path.join("tests", "testfiles", "roboto_udiff_expected.txt")
 ROBOTO_UDIFF_COLOR_EXPECTED_PATH = os.path.join("tests", "testfiles", "roboto_udiff_color_expected.txt")
 ROBOTO_UDIFF_1CONTEXT_EXPECTED_PATH = os.path.join("tests", "testfiles", "roboto_udiff_1context_expected.txt")
+ROBOTO_UDIFF_HEADONLY_EXPECTED_PATH = os.path.join("tests", "testfiles", "roboto_udiff_headonly_expected.txt")
+ROBOTO_UDIFF_HEADPOSTONLY_EXPECTED_PATH = os.path.join("tests", "testfiles", "roboto_udiff_headpostonly_expected.txt")
+ROBOTO_UDIFF_EXCLUDE_HEADPOST_EXPECTED_PATH = os.path.join("tests", "testfiles", "roboto_udiff_ex_headpost_expected.txt")
 
 
 # Setup: define the expected diff text for unified diff
@@ -27,6 +30,18 @@
 with open(ROBOTO_UDIFF_1CONTEXT_EXPECTED_PATH, "r") as robo_udiff_contextlines:
     ROBOTO_UDIFF_1CONTEXT_EXPECTED = robo_udiff_contextlines.read()
 
+# Setup: define the expected diff text for head table only diff
+with open(ROBOTO_UDIFF_HEADONLY_EXPECTED_PATH, "r") as robo_udiff_headonly:
+    ROBOTO_UDIFF_HEADONLY_EXPECTED = robo_udiff_headonly.read()
+
+# Setup: define the expected diff text for head and post table only diff
+with open(ROBOTO_UDIFF_HEADPOSTONLY_EXPECTED_PATH, "r") as robo_udiff_headpostonly:
+    ROBOTO_UDIFF_HEADPOSTONLY_EXPECTED = robo_udiff_headpostonly.read()
+
+# Setup: define the expected diff text for head and post table only diff
+with open(ROBOTO_UDIFF_EXCLUDE_HEADPOST_EXPECTED_PATH, "r") as robo_udiff_ex_headpost:
+    ROBOTO_UDIFF_EXCLUDE_HEADPOST_EXPECTED = robo_udiff_ex_headpost.read()
+
 #
 # File path validations tests
 #
@@ -54,6 +69,20 @@ def test_main_filepath_validations_false_secondfont(capsys):
         assert exit_info.value.code == 1
 
 
+#
+#  Mutually exclusive argument tests
+#
+
+def test_main_include_exclude_defined_simultaneously(capsys):
+    args = ["--include", "head", "--exclude", "head", ROBOTO_BEFORE_PATH, ROBOTO_AFTER_PATH]
+
+    with pytest.raises(SystemExit) as exit_info:
+        run(args)
+        captured = capsys.readouterr()
+        assert captured.error.startswith("[*] Error: --include and --exclude are mutually exclusive options")
+        assert exit_info.value.code == 1
+
+
 #
 #  Unified diff integration tests
 #
@@ -119,3 +148,106 @@ def test_main_run_unified_context_lines_1(capsys):
             assert line[0:9] == expected_string_list[x][0:9]
         else:
             assert line == expected_string_list[x]
+
+
+def test_main_run_unified_head_table_only(capsys):
+    args = ["--include", "head", ROBOTO_BEFORE_PATH, ROBOTO_AFTER_PATH]
+
+    run(args)
+    captured = capsys.readouterr()
+
+    res_string_list = captured.out.split("\n")
+    expected_string_list = ROBOTO_UDIFF_HEADONLY_EXPECTED.split("\n")
+
+    # have to handle the tests for the top two file path lines
+    # differently than the rest of the comparisons because
+    # the time is defined using local platform settings
+    # which makes tests fail on different remote CI testing services
+    for x, line in enumerate(res_string_list):
+        # treat top two lines of the diff as comparison of first 10 chars only
+        if x in (0, 1):
+            assert line[0:9] == expected_string_list[x][0:9]
+        else:
+            assert line == expected_string_list[x]
+
+
+def test_main_run_unified_head_post_tables_only(capsys):
+    args = ["--include", "head,post", ROBOTO_BEFORE_PATH, ROBOTO_AFTER_PATH]
+
+    run(args)
+    captured = capsys.readouterr()
+
+    res_string_list = captured.out.split("\n")
+    expected_string_list = ROBOTO_UDIFF_HEADPOSTONLY_EXPECTED.split("\n")
+
+    # have to handle the tests for the top two file path lines
+    # differently than the rest of the comparisons because
+    # the time is defined using local platform settings
+    # which makes tests fail on different remote CI testing services
+    for x, line in enumerate(res_string_list):
+        # treat top two lines of the diff as comparison of first 10 chars only
+        if x in (0, 1):
+            assert line[0:9] == expected_string_list[x][0:9]
+        else:
+            assert line == expected_string_list[x]
+
+
+def test_main_run_unified_exclude_head_post_tables(capsys):
+    args = ["--exclude", "head,post", ROBOTO_BEFORE_PATH, ROBOTO_AFTER_PATH]
+
+    run(args)
+    captured = capsys.readouterr()
+
+    res_string_list = captured.out.split("\n")
+    expected_string_list = ROBOTO_UDIFF_EXCLUDE_HEADPOST_EXPECTED.split("\n")
+
+    # have to handle the tests for the top two file path lines
+    # differently than the rest of the comparisons because
+    # the time is defined using local platform settings
+    # which makes tests fail on different remote CI testing services
+    for x, line in enumerate(res_string_list):
+        # treat top two lines of the diff as comparison of first 10 chars only
+        if x in (0, 1):
+            assert line[0:9] == expected_string_list[x][0:9]
+        else:
+            assert line == expected_string_list[x]
+
+
+def test_main_include_with_bad_table_definition(capsys):
+    args = ["--include", "bogus", ROBOTO_BEFORE_PATH, ROBOTO_AFTER_PATH]
+
+    with pytest.raises(SystemExit) as exit_info:
+        run(args)
+        captured = capsys.readouterr()
+        assert captured.error.startswith("[*] ERROR:")
+        assert exit_info.value.code == 1
+
+
+def test_main_include_with_bad_table_definition_in_multi_table_request(capsys):
+    args = ["--include", "head,bogus", ROBOTO_BEFORE_PATH, ROBOTO_AFTER_PATH]
+
+    with pytest.raises(SystemExit) as exit_info:
+        run(args)
+        captured = capsys.readouterr()
+        assert captured.error.startswith("[*] ERROR:")
+        assert exit_info.value.code == 1
+
+
+def test_main_exclude_with_bad_table_definition(capsys):
+    args = ["--exclude", "bogus", ROBOTO_BEFORE_PATH, ROBOTO_AFTER_PATH]
+
+    with pytest.raises(SystemExit) as exit_info:
+        run(args)
+        captured = capsys.readouterr()
+        assert captured.error.startswith("[*] ERROR:")
+        assert exit_info.value.code == 1
+
+
+def test_main_exclude_with_bad_table_definition_in_multi_table_request(capsys):
+    args = ["--exclude", "head,bogus", ROBOTO_BEFORE_PATH, ROBOTO_AFTER_PATH]
+
+    with pytest.raises(SystemExit) as exit_info:
+        run(args)
+        captured = capsys.readouterr()
+        assert captured.error.startswith("[*] ERROR:")
+        assert exit_info.value.code == 1