Code review changes

.vscode/launch.json

@@ -38,7 +38,7 @@
             "request": "launch",
             "justMyCode": false,
             "program": "/venv/bin/deploy-tools",
-            "args": "validate ${input:from-scratch} ${input:test-build} ${input:deploy-folder} ${input:config-folder}",
+            "args": "validate ${input:allow-all} ${input:from-scratch} ${input:test-build} ${input:deploy-folder} ${input:config-folder}",
             "console": "integratedTerminal",
             "env": {
                 // Enable break on exception when debugging tests (see: tests/conftest.py)
@@ -51,7 +51,7 @@
             "request": "launch",
             "justMyCode": false,
             "program": "/venv/bin/deploy-tools",
-            "args": "compare ${input:use-previous} ${input:deploy-folder}",
+            "args": "compare ${input:compare-mode} ${input:deploy-folder}",
             "console": "integratedTerminal",
             "env": {
                 // Enable break on exception when debugging tests (see: tests/conftest.py)
@@ -64,7 +64,7 @@
             "request": "launch",
             "justMyCode": false,
             "program": "/venv/bin/deploy-tools",
-            "args": "sync ${input:from-scratch} ${input:deploy-folder} ${input:config-folder}",
+            "args": "sync ${input:allow-all} ${input:from-scratch} ${input:deploy-folder} ${input:config-folder}",
             "console": "integratedTerminal",
             "env": {
                 // Enable break on exception when debugging tests (see: tests/conftest.py)
@@ -91,32 +91,43 @@
             "default": "${workspaceFolder}/src/deploy_tools/demo_configuration/",
             "type": "promptString"
         },
+        {
+            "id": "allow-all",
+            "description": "Allow all lifecycle transitions",
+            "options": [
+                "",
+                "--allow-all"
+            ],
+            "default": "",
+            "type": "pickString"
+        },
         {
             "id": "from-scratch",
             "description": "Allow a complete redeployment to an empty directory",
             "options": [
-                "--not-from-scratch",
+                "",
                 "--from-scratch"
             ],
-            "default": "--no-from-scratch",
+            "default": "",
             "type": "pickString"
         },
         {
-            "id": "use-previous",
-            "description": "Compare against previous Deployment snapshot",
+            "id": "compare-mode",
+            "description": "Compare against previous Deployment snapshot or from scratch",
             "options": [
                 "--use-current",
-                "--use-previous"
+                "--use-previous",
+                "--from-scratch"
             ],
-            "default": "--no-use-previous",
+            "default": "--use-current",
             "type": "pickString"
         },
         {
             "id": "test-build",
             "description": "Include test build of the deployment changes",
             "options": [
                 "--test-build",
-                "--no-test-build"
+                ""
             ],
             "default": "--test-build",
             "type": "pickString"

.vscode/tasks.json

@@ -21,7 +21,7 @@
         {
             "label": "Sync modules",
             "type": "shell",
-            "command": "deploy-tools sync ${input:from-scratch} ${input:deploy-folder} ${input:config-folder}",
+            "command": "deploy-tools sync ${input:allow-all} ${input:from-scratch} ${input:deploy-folder} ${input:config-folder}",
             "problemMatcher": []
         },
         {
@@ -33,13 +33,13 @@
         {
             "label": "Validate deployment",
             "type": "shell",
-            "command": "deploy-tools validate ${input:from-scratch} ${input:test-build} ${input:deploy-folder} ${input:config-folder}",
+            "command": "deploy-tools validate ${input:allow-all} ${input:from-scratch} ${input:test-build} ${input:deploy-folder} ${input:config-folder}",
             "problemMatcher": []
         },
         {
             "label": "Compare deployment to snapshot",
             "type": "shell",
-            "command": "deploy-tools compare ${input:use-previous} ${input:deploy-folder}",
+            "command": "deploy-tools compare ${input:compare-mode} ${input:deploy-folder}",
             "problemMatcher": []
         },
     ],
@@ -62,32 +62,43 @@
             "default": "${workspaceFolder}/src/deploy_tools/demo_configuration/",
             "type": "promptString"
         },
+        {
+            "id": "allow-all",
+            "description": "Allow all lifecycle transitions",
+            "options": [
+                "",
+                "--allow-all"
+            ],
+            "default": "",
+            "type": "pickString"
+        },
         {
             "id": "from-scratch",
             "description": "Allow a complete redeployment to an empty directory",
             "options": [
-                "--not-from-scratch",
+                "",
                 "--from-scratch"
             ],
-            "default": "--no-from-scratch",
+            "default": "",
             "type": "pickString"
         },
         {
-            "id": "use-previous",
-            "description": "Compare against previous Deployment snapshot",
+            "id": "compare-mode",
+            "description": "Compare against previous Deployment snapshot or from scratch",
             "options": [
                 "--use-current",
-                "--use-previous"
+                "--use-previous",
+                "--from-scratch"
             ],
-            "default": "--no-use-previous",
+            "default": "--use-current",
             "type": "pickString"
         },
         {
             "id": "test-build",
             "description": "Include test build of the deployment changes",
             "options": [
                 "--test-build",
-                "--no-test-build"
+                ""
             ],
             "default": "--test-build",
             "type": "pickString"

README.md

@@ -47,8 +47,8 @@ bit different to the CLI commands; see `deploy-tools --help` for more informatio
 
 |**Step**|**Description**                                                                                                                                                                                                                                  |
 |--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|Compare |Compare the snapshot taken of the previous deployment with the modulefiles and built modules that already exist. This ensures that the Deployment Area is in a healthy state                                                                     |
 |Validate|Process the updated configuration. By comparing the new configuration files with a snapshot from the previous deployment, we determine the set of actions that need to be taken                                                                  |
-|Check   |With the set of expected changes, perform some basic checks of the deployment area to ensure there are no major issues preventing the Deploy step from running                                                                                   |
 |Build   |Generate entrypoint scripts, configuration files and environment variables for a given Module. These are output to the Build Area                                                                                                                |
 |Deploy  |Move all built Modules from the Build Area into the Modules Area. A link to the built modulefile is moved to either the Modulefiles Folder or Deprecated Folder, depending on its deprecation status. Update default versions for the modulefiles|
 
@@ -85,7 +85,7 @@ in greater detail.
 |Generate Schema               |`deploy-tools schema`     |Generate the yaml schema (in .json format) for the top-level configuration files                                                                                                                                    |
 |Clean deployment              |`rm -rf <Deployment Root>`|Wipe the deployment area local to your own checkout of deploy-tools, enabling you to test a deployment from scratch                                                                                                 |
 |Sync Modules                  |`deploy-tools sync`       |Synchronise the Deployment configuration with the Deployment Area                                                                                                                                                   |
-|Validate deployment           |`deploy-tools validate`   |Compare the new configuration with that previously used when deploying modules, and check that all expected Deploy operations are unlikely to fail. This will also test the build process if requested.             |
+|Validate deployment           |`deploy-tools validate`   |Compare the new configuration with that previously used when deploying modules, and test the build process if requested                                                                                             |
 |Compare deployment to snapshot|`deploy-tools compare`    |Compare the configuration stored from the last `deploy-tools sync` run, with the state of any deployed Modules. This should always be run by CI/CD before attempting to Deploy, and any differences will be reported|
 
 ## Glossary

src/deploy_tools/__main__.py

@@ -8,7 +8,7 @@
 from .compare import compare_to_snapshot
 from .models.schema import generate_schema
 from .sync import synchronise
-from .validate import validate_and_check_configuration
+from .validate import validate_and_test_configuration
 
 __all__ = ["main"]
 
@@ -35,6 +35,7 @@
         dir_okay=True,
         writable=True,
         show_default=False,
+        resolve_path=True,
         help="Root of the deployment area to use.",
     ),
 ]
@@ -45,6 +46,7 @@
         file_okay=False,
         dir_okay=True,
         show_default=False,
+        resolve_path=True,
         help="Folder containing configuration for deployment.",
     ),
 ]
@@ -56,20 +58,33 @@
         dir_okay=True,
         writable=True,
         show_default=False,
+        resolve_path=True,
         help="Output path to write all .json schema files to.",
     ),
 ]
+ALLOW_ALL_OPTION = Annotated[
+    bool,
+    typer.Option(
+        "--allow-all",
+        show_default="False",  # Shows default as 'False'
+        help="Allow all lifecycle transitions. This still requires the deployment area "
+        "to be in a healthy state.",
+    ),
+]
 FROM_SCRATCH_OPTION = Annotated[
     bool,
     typer.Option(
-        "--from-scratch/--not-from-scratch",
+        "--from-scratch",
+        show_default="False",  # Shows default as 'False'
         help="Deploy into an empty deployment area.",
     ),
 ]
 TEST_BUILD_OPTION = Annotated[
     bool,
     typer.Option(
-        "--test-build/--no-test-build", help="Test the build in a temporary directory."
+        "--test-build",
+        show_default="False",  # Shows default as 'False'
+        help="Test the build in a temporary directory.",
     ),
 ]
 USE_PREVIOUS_OPTION = Annotated[
@@ -100,6 +115,7 @@
 def sync(
     deployment_root: DEPLOYMENT_ROOT_ARGUMENT,
     config_folder: CONFIG_FOLDER_ARGUMENT,
+    allow_all: ALLOW_ALL_OPTION = False,
     from_scratch: FROM_SCRATCH_OPTION = False,
     verbose: VERBOSE_OPTION = 0,
 ) -> None:
@@ -108,31 +124,39 @@
     This will also run the validate command beforehand, but without printing the
     expected changes.
     """
-    synchronise(deployment_root, config_folder, from_scratch)
+    if from_scratch:
+        allow_all = True
+
+    synchronise(deployment_root, config_folder, allow_all, from_scratch)
 
 
 @app.command(no_args_is_help=True)
 def validate(
     deployment_root: DEPLOYMENT_ROOT_ARGUMENT,
     config_folder: CONFIG_FOLDER_ARGUMENT,
     from_scratch: FROM_SCRATCH_OPTION = False,
-    test_build: TEST_BUILD_OPTION = True,
+    allow_all: ALLOW_ALL_OPTION = False,
+    test_build: TEST_BUILD_OPTION = False,
     verbose: VERBOSE_OPTION = 0,
 ) -> None:
     """Validate deployment configuration and print a list of expected module changes.
 
     If specified, this includes a test build of the provided configuration. The
     configuration validation is the same as used by the deploy-tools sync command.
     """
-    validate_and_check_configuration(
-        deployment_root, config_folder, from_scratch, test_build
+    if from_scratch:
+        allow_all = True
+
+    validate_and_test_configuration(
+        deployment_root, config_folder, allow_all, from_scratch, test_build
     )
 
 
 @app.command(no_args_is_help=True)
 def compare(
     deployment_root: DEPLOYMENT_ROOT_ARGUMENT,
     use_previous: USE_PREVIOUS_OPTION = False,
+    from_scratch: FROM_SCRATCH_OPTION = False,
     verbose: VERBOSE_OPTION = 0,
 ) -> None:
     """Compare the deployment snapshot to deployed modules in the deployment root.
@@ -141,7 +165,7 @@
     deploy step, we can use this function to determine any required steps for fixing
     files in the deployment root.
     """
-    compare_to_snapshot(deployment_root, use_previous)
+    compare_to_snapshot(deployment_root, use_previous, from_scratch)
 
 
 @app.command(no_args_is_help=True)