support always writing a new file, even if no changes

Author: mr-c

Makefile

@@ -32,7 +32,7 @@ DEVPKGS=diff_cover black pylint pep257 pydocstyle flake8 tox tox-pyenv \
 	-rtest-requirements.txt -rmypy-requirements.txt
 DEBDEVPKGS=pylint python3-coverage sloccount \
 	   python3-flake8 shellcheck
-VERSION=1.2.3  # please also update setup.py
+VERSION=1.2.4  # please also update setup.py
 
 ## all                    : default task (install cwl-upgrader in dev mode)
 all: dev

cwlupgrader/main.py

@@ -12,9 +12,10 @@
 from pathlib import Path
 from typing import Any, Callable, Dict, List, MutableMapping, Optional, Set, Union
 
+from schema_salad.sourceline import SourceLine, add_lc_filename, cmap
+
 import ruamel.yaml
 from ruamel.yaml.comments import CommentedMap  # for consistent sort order
-from schema_salad.sourceline import SourceLine, add_lc_filename, cmap
 
 _logger = logging.getLogger("cwl-upgrader")  # pylint: disable=invalid-name
 defaultStreamHandler = logging.StreamHandler()  # pylint: disable=invalid-name
@@ -46,6 +47,11 @@ def parse_args(args: List[str]) -> argparse.Namespace:
     parser.add_argument(
         "--dir", help="Directory in which to save converted files", default=Path.cwd()
     )
+    parser.add_argument(
+        "--always-write",
+        help="Always write a file, even if no changes were made.",
+        action="store_true",
+    )
     parser.add_argument(
         "inputs",
         nargs="+",
@@ -93,7 +99,7 @@ def run(args: argparse.Namespace) -> int:
                 target_version=target_version,
                 imports=imports,
             )
-            if upgraded_document is not None:
+            if upgraded_document is not document or not args.always_write:
                 write_cwl_document(upgraded_document, Path(path).name, args.dir)
     return 0
 
@@ -154,9 +160,9 @@ def upgrade_document(
     elif version == "v1.2":
         if target_version == "v1.2":
             _logger.info("Not upgrading v1.2 document as requested.")
-            return
+            return document
         elif target_version == "latest":
-            return
+            return document
     else:
         _logger.error(f"Unknown cwlVersion in source document: {version}")
         return

setup.py

@@ -13,7 +13,7 @@
 
 setup(
     name="cwl-upgrader",
-    version="1.2.3",
+    version="1.2.4",
     description="Common Workflow Language standalone document upgrader",
     long_description=open(README).read(),
     author="Common Workflow Language contributors",

tests/test_complete.py

@@ -73,6 +73,22 @@ def test_v1_1_to_v1_2(tmp_path: Path) -> None:
     assert upgraded == expected
 
 
+def test_v1_2_to_v1_2(tmp_path: Path) -> None:
+    """CWL v1.2 to CWL v1.2 no change test."""
+    doc = load_cwl_document(get_data("testdata/v1.2/networkaccess.cwl"))
+    upgraded = upgrade_document(doc, str(tmp_path), "v1.2")
+    expected = load_cwl_document(get_data("testdata/v1.2/networkaccess.cwl"))
+    assert upgraded == expected
+
+
+def test_v1_2_to_latest(tmp_path: Path) -> None:
+    """CWL v1.2 to latest no change test."""
+    doc = load_cwl_document(get_data("testdata/v1.2/networkaccess.cwl"))
+    upgraded = upgrade_document(doc, str(tmp_path), "latest")
+    expected = load_cwl_document(get_data("testdata/v1.2/networkaccess.cwl"))
+    assert upgraded == expected
+
+
 def test_packed_graph(tmp_path: Path) -> None:
     """Test packed document with $graph."""
     main(