incremental_override -> incremental_loading_override

Author: CarlosCoelhoSL

digital_land/cli.py

@@ -648,7 +648,7 @@ def config_load_cmd(ctx, config_path):
     default="collection/resource",
     help="directory containing resources",
 )
-@click.option("--incremental-override", type=click.BOOL, default=False)
+@click.option("--incremental-loading-override", type=click.BOOL, default=False)
 @click.option(
     "--output-path",
     "-o",
@@ -661,15 +661,15 @@ def save_state_cmd(
     collection_dir,
     pipeline_dir,
     resource_dir,
-    incremental_override,
+    incremental_loading_override,
     output_path,
 ):
     save_state(
         specification_dir,
         collection_dir,
         pipeline_dir,
         resource_dir,
-        incremental_override,
+        incremental_loading_override,
         output_path,
     )
 
@@ -702,7 +702,7 @@ def save_state_cmd(
     default="collection/resource",
     help="directory containing resources",
 )
-@click.option("--incremental-override", type=click.BOOL, default=False)
+@click.option("--incremental-loading-override", type=click.BOOL, default=False)
 @click.option(
     "--state-path",
     type=click.Path(),
@@ -714,14 +714,14 @@ def check_state_cmd(
     collection_dir,
     pipeline_dir,
     resource_dir,
-    incremental_override,
+    incremental_loading_override,
     state_path,
 ):
     # If the state isn't the same, use a non-zero return code so scripts can
     # detect this, and print a message. If it is the same, exit silenty wirh a
     # 0 retun code.
 
-    if incremental_override:
+    if incremental_loading_override:
         print("State comparison skipped as incremental override enabled")
         sys.exit(1)
 
@@ -730,9 +730,13 @@ def check_state_cmd(
         collection_dir,
         pipeline_dir,
         resource_dir,
-        incremental_override,
+        incremental_loading_override,
         state_path,
     )
+    with open("state_difference.json") as f:
+        f.write({"differences": diffs if diffs else []})
+        f.write({"incremental_loading_override": incremental_loading_override})
+
     if diffs:
         print(f"State differs from {state_path} - {', '.join(diffs)}")
         sys.exit(1)

digital_land/commands.py

@@ -1476,15 +1476,15 @@ def save_state(
     collection_dir,
     pipeline_dir,
     resource_dir,
-    incremental_override,
+    incremental_loading_override,
     output_path,
 ):
     state = State.build(
         specification_dir=specification_dir,
         collection_dir=collection_dir,
         pipeline_dir=pipeline_dir,
         resource_dir=resource_dir,
-        incremental_override=incremental_override,
+        incremental_loading_override=incremental_loading_override,
     )
     state.save(
         output_path=output_path,
@@ -1496,7 +1496,7 @@ def compare_state(
     collection_dir,
     pipeline_dir,
     resource_dir,
-    incremental_override,
+    incremental_loading_override,
     state_path,
 ):
     """Compares the current state against the one in state_path.
@@ -1506,14 +1506,14 @@ def compare_state(
         collection_dir=collection_dir,
         pipeline_dir=pipeline_dir,
         resource_dir=resource_dir,
-        incremental_override=incremental_override,
+        incremental_loading_override=incremental_loading_override,
     )
     # in here current incremental override must be false
 
     compare = State.load(state_path)
     # we don't want to include whether the previous state was an incremental override in comparison
-    current.pop("incremental_override", None)
-    compare.pop("incremental_override", None)
+    current.pop("incremental_loading_override", None)
+    compare.pop("incremental_loading_override", None)
 
     if current == compare:
         return None

digital_land/state.py

@@ -17,7 +17,7 @@ def build(
         collection_dir,
         pipeline_dir,
         resource_dir,
-        incremental_override,
+        incremental_loading_override,
     ):
         """Build a state object from the current configuration and code"""
         return State(
@@ -29,7 +29,7 @@ def build(
                 ),
                 "resource": State.get_dir_hash(resource_dir),
                 "pipeline": State.get_dir_hash(pipeline_dir),
-                "incremental_override": incremental_override,
+                "incremental_loading_override": incremental_loading_override,
             }
         )
 

tests/e2e/test_state.py

@@ -28,7 +28,7 @@ def test_state(tmp_path):
         collection_dir=os.path.join(test_data_dir, "collection"),
         pipeline_dir=os.path.join(test_data_dir, "pipeline"),
         resource_dir=os.path.join(test_data_dir, "resource"),
-        incremental_override=True,
+        incremental_loading_override=True,
         output_path=state_path,
     )
 
@@ -41,22 +41,22 @@ def test_state(tmp_path):
             "collection",
             "resource",
             "pipeline",
-            "incremental_override",
+            "incremental_loading_override",
         ]
         assert state_data["code"] == get_code_hash()
         assert state_data["specification"] == specification_hash
         assert state_data["collection"] == collection_hash
         assert state_data["pipeline"] == pipeline_hash
         assert state_data["resource"] == resource_hash
-        assert state_data["incremental_override"]
+        assert state_data["incremental_loading_override"]
 
     assert (
         compare_state(
             specification_dir=os.path.join(test_data_dir, "specification"),
             collection_dir=os.path.join(test_data_dir, "collection"),
             pipeline_dir=os.path.join(test_data_dir, "pipeline"),
             resource_dir=os.path.join(test_data_dir, "resource"),
-            incremental_override=True,
+            incremental_loading_override=True,
             state_path=state_path,
         )
         is None
@@ -68,7 +68,7 @@ def test_state(tmp_path):
             collection_dir=os.path.join(test_data_dir, "collection_exclude"),
             pipeline_dir=os.path.join(test_data_dir, "pipeline"),
             resource_dir=os.path.join(test_data_dir, "resource"),
-            incremental_override=True,
+            incremental_loading_override=True,
             state_path=state_path,
         )
         is None
@@ -79,7 +79,7 @@ def test_state(tmp_path):
         collection_dir=os.path.join(test_data_dir, "collection_blank"),
         pipeline_dir=os.path.join(test_data_dir, "pipeline"),
         resource_dir=os.path.join(test_data_dir, "resource"),
-        incremental_override=True,
+        incremental_loading_override=True,
         state_path=state_path,
     ) == ["collection"]
 
@@ -88,7 +88,7 @@ def test_state(tmp_path):
         collection_dir=os.path.join(test_data_dir, "collection"),
         pipeline_dir=os.path.join(test_data_dir, "pipeline"),
         resource_dir=os.path.join(test_data_dir, "resource_diff"),
-        incremental_override=True,
+        incremental_loading_override=True,
         state_path=state_path,
     ) == ["resource"]
 
@@ -100,7 +100,7 @@ def test_state(tmp_path):
             collection_dir=os.path.join(test_data_dir, "collection"),
             pipeline_dir=os.path.join(test_data_dir, "pipeline"),
             resource_dir=os.path.join(test_data_dir, "resource"),
-            incremental_override=False,
+            incremental_loading_override=False,
             state_path=state_path,
         )
         is None