Ready for initial release

Signed-off-by: Ole Herman Schumacher Elgesem <ole.elgesem@northern.tech>

Author: olehermanse

.gitignore

@@ -2,7 +2,7 @@ build
 dist
 /cfengine_cli/VERSION
 /cfengine_cli/__pycache__/
-/cfengine_cli.egg-info/
+/cfengine.egg-info/
 /venv
 /.venv
 __pycache__/

README.md

@@ -1,222 +1,43 @@
-# cf-remote
+# CFEngine CLI
 
-`cf-remote` is a tool to deploy CFEngine.
-It works by contacting remote hosts with SSH and using `ssh` / `scp` to copy files and run commands.
-Commands for provisioning hosts in the cloud (AWS or GCP) are also available.
-
-## Requirements
-
-- cf-remote requires python 3.6 or greater.
-- SSH must be configured in such a way that cf-remote can login without a password.
-- An sftp server for transferring files on UNIX hosts. e.g. openssh-sftp-server for debian-based distributions.
+A simple CLI for interacting with various CFEngine tools, such as cf-agent, cf-remote, cf-hub, cf-remote, and cfbs.
 
 ## Installation
 
-Install with pip3:
-
-```
-$ pip3 install cf-remote
-```
-
-## Examples
-
-### See information about remote host
-
-The `info` command can be used to check basic information about a system.
-The --hosts/-H option accepts [user@]hostname[:port] for the hostname.
-In the case that hostname is an ipv6 address use literal square brackets as described in RFC-3986 (https://www.ietf.org/rfc/rfc3986.txt)
-
-e.g. user@[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:8022
-
-```
-$ cf-remote info -H 34.241.203.218
-
-ubuntu@34.241.203.218
-OS            : ubuntu (debian)
-Architecture  : x86_64
-CFEngine      : 3.12.1
-Policy server : 172.31.42.192
-Binaries      : dpkg, apt
-```
-
-(You must have ssh access).
-
-### Installing and bootstrapping CFEngine Enterprise Hub
-
-The `install` command can automatically download and install packages as well as bootstrap both hubs and clients.
-
-```
-$ cf-remote install --hub 34.247.181.100 --bootstrap 172.31.44.146 --demo
-
-ubuntu@34.247.181.100
-OS            : ubuntu (debian)
-Architecture  : x86_64
-CFEngine      : Not installed
-Policy server : None
-Binaries      : dpkg, apt
-
-Package already downloaded: '/Users/olehermanse/.cfengine/cf-remote/packages/cfengine-nova-hub_3.12.1-1_amd64.deb'
-Copying: '/Users/olehermanse/.cfengine/cf-remote/packages/cfengine-nova-hub_3.12.1-1_amd64.deb' to '34.247.181.100'
-Installing: 'cfengine-nova-hub_3.12.1-1_amd64.deb' on '34.247.181.100'
-CFEngine 3.12.1 was successfully installed on '34.247.181.100'
-Bootstrapping: '34.247.181.100' -> '172.31.44.146'
-Bootstrap successful: '34.247.181.100' -> '172.31.44.146'
-Transferring def.json to hub: '34.247.181.100'
-Copying: '/Users/olehermanse/.cfengine/cf-remote/json/def.json' to '34.247.181.100'
-Triggering an agent run on: '34.247.181.100'
-Disabling password change on hub: '34.247.181.100'
-Triggering an agent run on: '34.247.181.100'
-Your demo hub is ready: https://34.247.181.100/ (Username: admin, Password: password)
-```
-
-Note that this demo setup (`--demo`) is notoriously insecure.
-It has default passwords and open access controls.
-Don't use it in a production environment.
-
-### Spawning instances in AWS EC2
-
-`cf-remote spawn` can create cloud instances on demand, for example in AWS EC2, but you'll have to add some credentials and settings:
-
-```
-$ cf-remote spawn --init-config
-Config file /home/olehermanse/.cfengine/cf-remote/cloud_config.json created, please complete the configuration in it.
-$ cat /home/olehermanse/.cfengine/cf-remote/cloud_config.json
-{
-  "aws": {
-    "key": "TBD",
-    "secret": "TBD",
-    "key_pair": "TBD",
-    "security_groups": [
-      "TBD"
-    ],
-    "region": "OPTIONAL (DEFAULT: eu-west-1)"
-  },
-  "gcp": {
-    "project_id": "TBD",
-    "service_account_id": "TBD",
-    "key_path": "TBD",
-    "region": "OPTIONAL (DEFAULT: europe-west1-b)"
-  }
-}
-```
-
-You can skip the `gcp` values if you will only be using AWS. After filling out those 4, it should just work:
+Install using pip:
 
 ```
-$ cf-remote spawn --count 1 --platform ubuntu-20-04-x64 --role hub --name hub
-Spawning VMs....DONE
-Waiting for VMs to get IP addresses..........DONE
-Details about the spawned VMs can be found in /home/olehermanse/.cfengine/cf-remote/cloud_state.json
+pip install cfengine
 ```
 
-You can now install nightlies, and use the ```--demo``` to make testing easier (**Not** secure for production use).
-Referring to the group names set by spawn, makes the commands a lot shorter and easier to script:
+## Usage
 
-```
-$ cf-remote --version master install --hub hub --bootstrap hub --demo
-
-ubuntu@52.214.209.170
-OS            : ubuntu (debian)
-Architecture  : x86_64
-CFEngine      : Not installed
-Policy server : None
-Binaries      : dpkg, apt
-
-Downloading package: '/home/olehermanse/.cfengine/cf-remote/packages/cfengine-nova-hub_3.18.0a.a24173342~12762.ubuntu18_amd64.deb'
-Copying: '/home/olehermanse/.cfengine/cf-remote/packages/cfengine-nova-hub_3.18.0a.a24173342~12762.ubuntu18_amd64.deb' to 'ubuntu@52.214.209.170'
-Installing: 'cfengine-nova-hub_3.18.0a.a24173342~12762.ubuntu18_amd64.deb' on 'ubuntu@52.214.209.170'
-CFEngine 3.18.0a.a24173342 (Enterprise) was successfully installed on 'ubuntu@52.214.209.170'
-Bootstrapping: '52.214.209.170' -> '172.31.5.84'
-Bootstrap successful: '52.214.209.170' -> '172.31.5.84'
-Transferring def.json to hub: 'ubuntu@52.214.209.170'
-Copying: '/home/olehermanse/.cfengine/cf-remote/json/def.json' to 'ubuntu@52.214.209.170'
-Triggering an agent run on: '52.214.209.170'
-Disabling password change on hub: 'ubuntu@52.214.209.170'
-Triggering an agent run on: '52.214.209.170'
-Your demo hub is ready: https://52.214.209.170/ (Username: admin, Password: password)
-```
-
-Mission portal will be available at that IP, using the username and password from the last log message.
-
-When you are done, you can decommision your spawned instance(s) using:
-
-```
-$ cf-remote destroy --all
-Destroying all hosts
-```
-
-### Deploying a version of masterfiles you're working on locally
-
-The `deploy` command allows you to deploy your local checkout of masterfiles, to test policy while working on it:
-
-```
-$ cf-remote deploy --hub hub ~/code/northern.tech/cfengine/masterfiles
-
-ubuntu@18.202.238.128
-OS            : ubuntu (debian)
-Architecture  : x86_64
-CFEngine      : 3.18.0a.a24173342 (Enterprise)
-Policy server : None
-Binaries      : dpkg, apt
+To perform an agent run:
 
-Copying: '/home/olehermanse/.cfengine/cf-remote/masterfiles.tgz' to 'ubuntu@18.202.238.128'
-Running: 'systemctl stop cfengine3 && rm -rf /var/cfengine/masterfiles && mv masterfiles /var/cfengine/masterfiles && systemctl start cfengine3 && cf-agent -Kf update.cf && cf-agent -K'
-$
 ```
-
-### Specify an SSH key
-
-If you have more than one key in `~/.ssh` you may need to specify which key `cf-remote` is to use.
-
-```
-$ export CF_REMOTE_SSH_KEY="~/.ssh/id_rsa.pub"
-```
-
-### Working on the local host
-
-`cf-remote` can work on the local host when the target host is `localhost`. In this case, it executes commands locally without connecting over SSH.
-
-```
-$ cf-remote info -H localhost
-
-ubuntu@localhost
-OS            : ubuntu (debian)
-Architecture  : x86_64
-CFEngine      : 3.12.1
-Policy server : 172.31.42.192
-Binaries      : dpkg, apt
+cfengine run
 ```
 
-When performing actions locally, `cf-remote` may require your password to run commands with `sudo`:
+To get additional help:
 
 ```
-$ cf-remote install --clients localhost
-ubuntu@localhost
-OS            : debian
-Architecture  : x86_64
-CFEngine      : Not installed
-Policy server :
-Binaries      : dpkg, apt
-Installing: '/home/ubuntu/.cfengine/cf-remote/packages/cfengine-nova_3.15.3-1.debian10_amd64.deb' on 'localhost'
-[sudo] password for ubuntu:
-CFEngine 3.15.3 (Enterprise) was successfully installed on 'localhost'
+cfengine help
 ```
 
-## Contribute
-
-Feel free to open pull requests to expand this documentation, add features or fix problems.
-You can also pick up an existing task or file an issue in [our bug tracker](https://northerntech.atlassian.net/issues/?filter=10068).
+## Supported platforms and versions
 
-## Development
+This tool will only support a limited number of platforms, it is not int.
+Currently we are targeting:
 
-To install `cf-remote` so that it reflects any changes in this source directory use:
-
-```
-$ pip install --editable .
-```
+- Officially supported versions of macOS, Ubuntu, and Fedora.
+- Officially supported versions of Python.
 
-## cloud_data.py tips
+It is not intended to be installed on all hosts in your infrastructure.
+CFEngine itself supports a wide range of platforms, but this tool is intended to run on your laptop, your workstation, or the hub in your infrastructure, not all the other hosts.
 
-In order to find AWS images for a particular owner to work on cloud_data.py name_pattern list the names for an owner with the following `aws` command:
+## Backwards compatibility
 
-aws ec2 describe-images --region us-east-2 --owners 801119661308 --query 'Images[*].[Name]' --output text
+This CLI is entirely intended for humans.
+If you put it into scripts and automation, expect it to break in the future.
+In order to make the user experience better, we might add, change, or remove commands.
+We will also be experimenting with different types of interactive prompts and input.

cfengine_cli/commands.py

@@ -1,12 +1,13 @@
-def run():
+def run() -> int:
     print("RUN")
     return 0
 
 
-def update():
+def update() -> int:
     print("UPDATE")
+    return 0
 
 
-def help():
+def help() -> int:
     print("HELP")
     return 0

cfengine_cli/main.py

@@ -2,20 +2,16 @@
 import os
 import sys
 
-from cfengine_cli import log
+from cf_remote import log
 from cfengine_cli import version
 from cfengine_cli import commands
-from cf_remote.utils import (
-    user_error,
-)
-from cf_remote.utils import cache
+from cfengine_cli.utils import UserError
 
 
 def print_version_info():
     print("CFEngine CLI version %s" % version.string())
 
 
-@cache
 def _get_arg_parser():
     ap = argparse.ArgumentParser(
         description="Human-oriented CLI for interacting with CFEngine tools",
@@ -62,29 +58,36 @@ def get_args():
     return args
 
 
-def run_command_with_args(command, _):
+def run_command_with_args(command, _) -> int:
     if command == "info":
         return commands.info()
     if command == "run":
         return commands.run()
     if command == "update":
         return commands.update()
-    user_error("Unknown command: '{}'".format(command))
+    raise UserError("Unknown command: '{}'".format(command))
 
 
 def validate_command(_command, _args):
     pass
 
 
 def main():
-    args = get_args()
-    if args.log_level:
-        log.set_level(args.log_level)
-    validate_command(args.command, args)
-
-    exit_code = run_command_with_args(args.command, args)
-    assert type(exit_code) is int
-    sys.exit(exit_code)
+    try:
+        args = get_args()
+        if args.log_level:
+            log.set_level(args.log_level)
+        validate_command(args.command, args)
+
+        exit_code = run_command_with_args(args.command, args)
+        assert type(exit_code) is int
+        sys.exit(exit_code)
+    except AssertionError as e:
+        print(f"Error: {str(e)} (programmer error, please file a bug)")
+        sys.exit(-1)
+    except UserError as e:
+        print(str(e))
+        sys.exit(-1)
 
 
 if __name__ == "__main__":

cfengine_cli/utils.py

@@ -0,0 +1,8 @@
+class UserError(Exception):
+    """Exception raised when a user has most likely made a mistake"""
+
+    def __init__(self, message):
+        super().__init__(message)
+
+    def __str__(self):
+        return f"Error: {self.message}"