Added cfengine test, a one-stop command to lint/build/deploy/run a policy-set

First iteration of the `cfengine test`-command, with the intention of
being used in a future "CFEngine testing framework"

Ticket: ENT-14443

Signed-off-by: Simon Halvorsen <simon.halvorsen@northern.tech>

Author: SimonThalvorsen

src/cfengine_cli/cfengine_wrapper/cfengine_commands.py

@@ -287,6 +287,18 @@ def deploy(
     return error
 
 
+def test(hub=None) -> int:
+    rc = build_command()
+    if rc != 0:
+        return rc
+
+    agent = require_executable("cf-agent", hub)
+    location = "localhost" if agent.location == "local" else agent.location
+
+    error = deploy_command([location], None)
+    return error if error else agent.run("-KIf update.cf", "-KI")
+
+
 def show(target: list[str] | None = None) -> int:
     if target == [] or target is None:
         return show_command(False)

src/cfengine_cli/commands.py

@@ -12,6 +12,7 @@
 from cfengine_cli.initialize_project import init_policy_module, init_promise_type
 from cf_remote.paths import cf_remote_dir
 from cfbs.commands import init_command
+from cfengine_cli.cfengine_wrapper.cfengine_commands import test as _cfengine_test
 from pydantic import ValidationError
 
 
@@ -47,6 +48,17 @@ def lint(files, strict, syntax_path) -> int:
     return errors
 
 
+def test(files, strict, hub) -> int:
+    errors = _lint(files, strict, None)
+    if errors != 0:
+        plural = "error" if errors == 1 else "errors"
+        print(f"Lint failed, {errors} {plural} in total. Skipping build/deploy/run.")
+        return errors
+
+    print("Lint passed, no errors found.")
+    return _cfengine_test(hub)
+
+
 def dev(subcommand, args) -> int:
     return dispatch_dev_subcommand(subcommand, args)
 

src/cfengine_cli/main.py

@@ -88,6 +88,26 @@ def _get_arg_parser():
     )
     lnt.add_argument("files", nargs="*", help="Files to lint")
 
+    tst = subp.add_parser(
+        "test",
+        help="Lint, then build/deploy/run a cfbs project as one non-interactive check",
+        description="A convenience wrapper chaining `cfengine lint` and `cfengine build` "
+        "to quickly test a module or policy-set end-to-end. "
+        "Without --hub HUB specified, you will be prompted, else the chosen hub will be used.",
+    )
+    tst.add_argument(
+        "--strict",
+        type=str,
+        default="yes",
+        help="Strict mode for linting. Default=yes, checks for undefined promise types, bundles, bodies, functions",
+    )
+    tst.add_argument("--hub", help="Hub to deploy to after building", type=str)
+    tst.add_argument(
+        "files",
+        nargs="*",
+        help="Files/Folder to lint (default is . (the entire project) )",
+    )
+
     dev_parser = subp.add_parser(
         "dev", help="Utilities intended for developers / maintainers of CFEngine"
     )
@@ -245,6 +265,12 @@ def run_command_with_args(args) -> int:
             (args.strict.lower() in ("y", "ye", "yes")),
             args.syntax_description,
         )
+    if args.command == "test":
+        return commands.test(
+            args.files,
+            (args.strict.lower() in ("y", "ye", "yes")),
+            args.hub,
+        )
     if args.command == "report":
         return cfengine_commands.report(
             target=args.hub,

tests/shell/006-test.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -e
+set -x
+
+# Setup: create a temp directory for test files
+tmpdir=$(mktemp -d)
+trap "rm -rf $tmpdir" EXIT
+
+cfengine test --help
+
+# A file with a lint error should make `cfengine test` fail on the lint step
+# and not go through to build/deploy/run.
+printf 'bundle agent main\n{\n  reports:\n      "missing semicolon"\n}\n' > "$tmpdir/bad.cf"
+
+output_file=$(mktemp)
+trap "rm -rf $tmpdir $output_file" EXIT
+
+if cfengine test "$tmpdir/bad.cf" > "$output_file" 2>&1; then
+	cat "$output_file"
+	echo "FAIL: expected cfengine test to fail on a lint error"
+	exit 1
+fi
+cat "$output_file"
+grep -q "Lint failed" "$output_file"
+grep -q "Skipping build/deploy/run" "$output_file"