Added --validate and updated README

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

Author: victormlg

README.md

@@ -77,6 +77,33 @@ cfengine build
 
 (This is equivalent to running `cfbs build`).
 
+### Spawn and install cfengine from a config
+
+**this feature is still in work in progress**
+
+Given a yaml config:
+
+```yaml
+templates:
+  ubuntu:
+    count: 1
+    mode: spawn
+    spawn:
+      provider: vagrant
+      vagrant:
+        box: ubuntu/focal64
+
+groups:
+  myhub:
+    role: hub
+    source: ubuntu
+```
+
+It up will spawn the necessary VMs and install cfengine using cf-remote
+```
+cfengine up config.yaml
+```
+
 ## Supported platforms and versions
 
 This tool will only support a limited number of platforms, it is not intended to run everywhere CFEngine runs.

src/cfengine_cli/commands.py

@@ -152,16 +152,18 @@ def profile(args) -> int:
     return 0
 
 
-def up(config) -> int:
+def up(args) -> int:
     content = None
     try:
-        with open(config, "r") as f:
+        with open(args.config, "r") as f:
             content = yaml.safe_load(f)
     except yaml.YAMLError:
-        raise UserError("'%s' is not a valid yaml config" % config)
+        raise UserError("'%s' is not a valid yaml config" % args.config)
     except FileNotFoundError:
-        raise UserError("'%s' doesn't exist" % config)
+        raise UserError("'%s' doesn't exist" % args.config)
 
-    print("Starting VMs...")
     validate_config(content)
+    if args.validate:
+        return 0
+    print("Starting VMs...")
     return 0

src/cfengine_cli/main.py

@@ -120,6 +120,9 @@ def _get_arg_parser():
     up_parser.add_argument(
         "config", default="config.yaml", nargs="?", help="Path to yaml config"
     )
+    up_parser.add_argument(
+        "--validate", action="store_true", help="Validate the given config"
+    )
     return ap
 
 
@@ -154,7 +157,7 @@ def run_command_with_args(args) -> int:
     if args.command == "profile":
         return commands.profile(args)
     if args.command == "up":
-        return commands.up(args.config)
+        return commands.up(args)
     raise UserError(f"Unknown command: '{args.command}'")
 
 

src/cfengine_cli/validate.py

@@ -1,5 +1,5 @@
 from cf_remote.paths import CLOUD_CONFIG_FPATH, CLOUD_STATE_FPATH
-from cf_remote.utils import read_json, CFRUserError, is_package_url
+from cf_remote.utils import read_json, is_package_url
 from cf_remote.spawn import (
     Providers,
     get_cloud_driver,
@@ -10,6 +10,8 @@
 from cf_remote.cloud_data import aws_image_criteria
 from cf_remote.remote import Releases
 
+from cfengine_cli.utils import UserError
+
 import os
 import subprocess
 
@@ -22,15 +24,15 @@ def validate_state_bootstrap(bootstrap):
 
     # TODO: Change how to check this if cloud_state.json changes format
     if key in state and state[key].values()[1]["role"] != "hub":
-        raise CFRUserError("Cannot bootstrap to an existing host that is not a hub")
+        raise UserError("Cannot bootstrap to an existing host that is not a hub")
 
 
 def validate_package(package, remote_download=False):
     if package is None:
         return
 
     if remote_download and not is_package_url(package):
-        raise CFRUserError("Package '{}' is not a valid package URL")
+        raise UserError("Package '{}' is not a valid package URL")
 
 
 def validate_version(version, edition):
@@ -39,7 +41,7 @@ def validate_version(version, edition):
     if version:
         release = releases.pick_version(version)
     if release is None:
-        raise CFRUserError(
+        raise UserError(
             "Could not find a release for version {}. The supported versions are {}".format(
                 version, releases
             )
@@ -55,13 +57,13 @@ def validate_vagrant_box(box):
     ]
 
     if box not in box_list:
-        raise CFRUserError("Box '{}' is not installed or doesn't exist".format(box))
+        raise UserError("Box '{}' is not installed or doesn't exist".format(box))
 
 
 def validate_aws_image(platform):
     platform_name = platform.split("-")[0]
     if platform_name not in aws_image_criteria:
-        raise CFRUserError(
+        raise UserError(
             "Platform '%s' is not in our set of image criteria. (Available platforms: %s)"
             % (platform, ", ".join(aws_image_criteria.keys()))
         )
@@ -83,7 +85,7 @@ def validate_aws_credentials():
         creds_data = read_json(CLOUD_CONFIG_FPATH)
 
     if not creds_data:
-        raise CFRUserError("Cloud configuration not found at %s" % CLOUD_CONFIG_FPATH)
+        raise UserError("Cloud configuration not found at %s" % CLOUD_CONFIG_FPATH)
     creds = None
     try:
         creds = _get_aws_creds_from_env() or AWSCredentials(
@@ -92,9 +94,7 @@ def validate_aws_credentials():
             creds_data["aws"].get("token", ""),
         )
     except KeyError:
-        raise CFRUserError(
-            "Incomplete AWS credential info"
-        )  # TODO: report missing keys
+        raise UserError("Incomplete AWS credential info")  # TODO: report missing keys
 
     region = creds_data["aws"].get("region", "eu-west-1")
     sec_groups = creds_data["aws"]["security_groups"]
@@ -104,7 +104,7 @@ def validate_aws_credentials():
         try:
             get_cloud_driver(Providers.AWS, creds, region)
         except InvalidCredsError as error:
-            raise CFRUserError(
+            raise UserError(
                 "Invalid credentials, check cloud_config.json (%s.)" % str(error)[1:-1]
             )
     return creds, region, sec_groups, key_pair
@@ -116,17 +116,15 @@ def validate_gcp_credentials():
         creds_data = read_json(CLOUD_CONFIG_FPATH)
 
     if not creds_data:
-        raise CFRUserError("Cloud configuration not found at %s" % CLOUD_CONFIG_FPATH)
+        raise UserError("Cloud configuration not found at %s" % CLOUD_CONFIG_FPATH)
     try:
         creds = GCPCredentials(
             creds_data["gcp"]["project_id"],
             creds_data["gcp"]["service_account_id"],
             creds_data["gcp"]["key_path"],
         )
     except KeyError:
-        raise CFRUserError(
-            "Incomplete AWS credential info"
-        )  # TODO: report missing keys
+        raise UserError("Incomplete AWS credential info")  # TODO: report missing keys
 
     region = creds_data["gcp"].get("region", "europe-west1-b")