Added tests with mocks

Signed-off-by: Victor Moene <victor.moene@northern.tech>

Author: victormlg

src/cfengine_cli/validate.py

@@ -15,6 +15,8 @@
 import os
 import subprocess
 
+cmd_cache = {}
+
 
 def validate_state_bootstrap(bootstrap):
     state = read_json(CLOUD_STATE_FPATH)
@@ -51,9 +53,16 @@ def validate_version(version, edition):
 
 
 def validate_vagrant_box(box):
-    ret = subprocess.run(["vagrant", "box", "list"], capture_output=True, text=True)
+    cmd = ("vagrant", "box", "list")
+    if cmd in cmd_cache:
+        cmd_output = cmd_cache[cmd]
+    else:
+        ret = subprocess.run(cmd, capture_output=True, text=True)
+        cmd_output = ret.stdout
+        cmd_cache[cmd] = cmd_output
+
     box_list = [
-        line.split()[0] for line in ret.stdout.split("\n") if len(line.split()) > 0
+        line.split()[0] for line in cmd_output.split("\n") if len(line.split()) > 0
     ]
 
     if box not in box_list:
@@ -124,7 +133,7 @@ def validate_gcp_credentials():
             creds_data["gcp"]["key_path"],
         )
     except KeyError:
-        raise UserError("Incomplete AWS credential info")  # TODO: report missing keys
+        raise UserError("Incomplete GCP credential info")  # TODO: report missing keys
 
     region = creds_data["gcp"].get("region", "europe-west1-b")
 

tests/run-up-validate-tests.sh

@@ -0,0 +1,30 @@
+#/usr/bin/env bash
+
+set -e
+
+echo "These tests expect cfengine CLI to be installed globally or in venv"
+
+echo "Looking for CFEngine CLI"
+cfengine --version
+
+echo "Check that test files are in expected location:"
+ls -al tests/up-validate/*.yaml
+
+rm -rf tmp
+mkdir -p tmp/bin
+mkdir -p tmp/home/.cfengine/cf-remote
+
+# Mocking vagrant
+cp tests/up-validate/mocks/vagrant tmp/bin/.
+export PATH="$(pwd)/tmp/bin:$PATH"
+
+# Mocking cloud_config.json
+cp tests/up-validate/mocks/cloud_config.json tmp/home/.cfengine/cf-remote/.
+MOCK_HOME="$(pwd)/tmp/home"
+
+for file in tests/up-validate/*.yaml; do
+  HOME="$MOCK_HOME" cfengine up "$file" --validate
+done
+
+echo "All cfengine up --validate tests successful!"
+

tests/up-validate/001_complex_config.yaml

@@ -0,0 +1,72 @@
+templates:
+  cfengine3.27:
+    version: 3.27.0
+    edition: enterprise
+    bootstrap: hub1
+    demo: false
+
+  cfengine-master:
+    remote_download: true
+    hub_package: "http://buildcache.cfengine.com/packages/testing-pr/jenkins-master-nightly-pipeline-333/PACKAGES_HUB_x86_64_linux_debian_11/cfengine-nova-hub_3.28.0a.1433c0c2f~133.debian11_amd64.deb"
+    client_package: "http://buildcache.cfengine.com/packages/testing-pr/jenkins-master-nightly-pipeline-333/PACKAGES_x86_64_linux_debian_11/cfengine-nova_3.28.0a.1433c0c2f~133.debian11_amd64.deb"
+    bootstrap: hub2
+
+groups:
+  - hub1:
+      role: hub
+      cfengine: cfengine3.27
+      source:
+        mode: spawn
+        spawn:
+          provider: vagrant
+          vagrant:
+            box: ubuntu/focal64
+            memory: 512
+            cpus: 1
+            sync_folder: null
+            provision: null
+        count: 1
+
+  - hub2:
+      role: hub
+      cfengine: cfengine-master
+      source:
+        mode: save
+        hosts: ["8.8.8.8"]
+
+  - client2:
+      role: client
+      cfengine: cfengine3.27
+      source:
+        mode: spawn
+        spawn:
+          provider: aws
+          aws:
+            image: debian-13
+            size: xlarge
+        count: 3
+          
+  - client3:
+      role: client
+      cfengine: cfengine-master
+      source:
+        mode: spawn
+        spawn:
+          provider: gcp
+          gcp:
+            image: debian-13
+            network: null
+            public_ip: true
+            size: n1-standard-1
+        count: 2
+
+  - client4:
+      role: client
+      source:
+        mode: spawn
+        spawn:
+          provider: vagrant
+          vagrant:
+            box: generic/centos7
+        count: 1
+

tests/up-validate/mocks/cloud_config.json

@@ -0,0 +1,16 @@
+{
+  "aws": {
+    "key": "TBD",
+    "secret": "TBD",
+    "key_pair": "TDB",
+    "security_groups": [
+      "TDB"
+    ],
+    "region": "eu-west-2"
+  },
+  "gcp" : {
+    "project_id" : "TDB",
+    "service_account_id" : "TDB",
+    "key_path" : "TDB"
+  }
+}

tests/up-validate/mocks/vagrant

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+if [[ "$1" == "box" && "$2" == "list" ]]; then
+    echo "generic/centos7 (virtualbox, 4.3.12, (amd64))"
+    echo "ubuntu/focal64  (virtualbox, 20240821.0.1)"
+    exit 0
+fi
+
+echo "Mock Vagrant: Unknown command $@" >&2
+exit 1
+