Further cleanup, tests, and docs

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

Author: olehermanse

.gitignore

@@ -7,3 +7,4 @@ dist
 /.venv
 __pycache__/
 **/.DS_STORE
+.pytest_cache

HACKING.md

@@ -0,0 +1,65 @@
+# Developing / maintaining the CFEngine CLI
+
+This document aims to have relevant information for people contributing to and maintaining the CFEngine CLI.
+It is not necessary for users of the tool to know about these processes.
+For general user information, see the [README](./README.md).
+
+## Releasing new versions
+
+Releases are [automated using a GH Action](https://github.com/cfengine/cfengine-cli/blob/main/.github/workflows/pypi-publish.yml)
+We create tags and releases through the GitHub UI.
+Go to the releases section in GitHub:
+
+https://github.com/cfengine/cfengine-cli/releases
+
+Determine the new version number according to SemVer:
+
+- Look at what is the latest released version.
+- Increase the first number if you are releasing breaking changes.
+- Or, increase the second number if there are new features (but no breaking changes).
+- Otherwise, increase the last number (only backwards compatible bugfixes).
+
+Sometimes, it's not 100% clear, so use your best judgement.
+
+Once you know the version number, proceed with making the release:
+
+1. Enter the version number into the **Choose a tag** dropdown.
+2. Click the **Create new tag on publish** alternative.
+3. Target should say **main**, don't change it.
+4. Put exactly the same version number into the **Release title** field.
+5. Click **Generate release notes**.
+   - In general, it's not necessary to edit the release notes.
+   - Sometimes you might want to add a link to a release blog post.
+   - Or, if there is a lot of noise, for example changes to docs and tests which don't affect users, you can remove those.
+6. Leave the checkboxes below as is (latest release checked, pre-release unchecked).
+7. Click **Publish release**.
+8. Watch the release happen:
+   - In GitHub Actions: https://github.com/cfengine/cfengine-cli/actions
+   - And if all is well, the new version should appear on PyPI: https://pypi.org/project/cfengine/
+
+If it does not work, click the failing GitHub Actions and try to understand what went wrong.
+
+## Rotating secrets
+
+The GH Action shown above requires a PyPI token to have access to publish new versions to PyPI.
+Sometimes, this needs to be rotated.
+[Log in](https://pypi.org/account/login/) to PyPI (need account access) and go to account settings:
+
+https://pypi.org/manage/account/
+
+Delete the old `cfengine-cli` token and generate a new one with the same name and correct scope (only access to `cfengine` project).
+Copy the token and paste it into the GitHub Secret named `PYPI_PASSWORD`.
+`PYPI_USERNAME` should be there already, you don't have to edit it, it is simply `__token__`.
+Don't store the token anywhere else - we generate new tokens if necessary.
+
+## Code formatting
+
+We use automated code formatters to ensure consistent code style / indentation.
+Please format Python code with [black](https://pypi.org/project/black/), and YAML and markdown files with [Prettier](https://prettier.io/).
+For simplicity's sake, we don't have a custom configuration, we use the tool's defaults.
+
+If your editor does not do this automatically, you can run these tools from the command line:
+
+```
+black . && prettier . --write
+```

README.md

@@ -1,6 +1,11 @@
-# CFEngine CLI
+# CFEngine command line interface (CLI)
 
-A simple CLI for interacting with various CFEngine tools, such as cf-agent, cf-remote, cf-hub, cf-remote, and cfbs.
+A CLI for humans to interact with CFEngine, enabling downloading and installing packages, building policy sets, deploying, and enforcing policy.
+It is practically a wrapper around our other tools, like `cf-agent`, `cf-hub`, `cf-remote` and `cfbs`.
+
+**Warning:** This is an early version.
+Things might be missing or changed.
+Proceed with caution and excitement.
 
 ## Installation
 
@@ -41,3 +46,8 @@ 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.
+
+## Development, maintenance, contributions, and releases
+
+Looking for more information related to contributing code, releasing new versions or otherwise maintaining the CFEngine CLI?
+Please see the [HACKING.md](./HACKING.md) file.

tests/docker/001-docker-install-test.sh

@@ -1,4 +1,10 @@
-#!/usr/bin/env bash
+#!/bin/bash
+
+# This test sets up a docker container running an SSH server,
+# where we test ssh based commands
+# (such as cf-remote install).
+# TODO: Actually install / test something in container
+
 set -ex
 set -o pipefail
 
@@ -10,7 +16,7 @@ error () {
 trap error ERR
 
 dir=$(dirname "$0")
-name=cf-remote-debian-test-host
+name=cfengine-cli-debian-test-host
 
 docker stop "$name" || true
 docker rm "$name" || true
@@ -19,8 +25,12 @@ docker run -d -p 8822:22 --name "$name" "$name" >>log 2>&1
 ip_addr=$(hostname -i)
 ssh -o StrictHostKeyChecking=no -p 8822 root@"$ip_addr" hostname >>log 2>&1
 echo "ssh returned exit code $?"
-echo "=== cf-remote info ===" | tee -a log
-cf-remote --log-level DEBUG info -H root@"$ip_addr":8822 2>&1 | tee -a log
-echo "cf-remote info got return code $?"
-echo "=== cf-remote install ===" | tee -a log
+echo "=== cf-remote --version ===" | tee -a log
+cf-remote --version 2>&1 | tee -a log
+echo "cf-remote --version got return code $?"
+echo "=== cfengine version ===" | tee -a log
+cfengine version 2>&1 | tee -a log
+echo "=== cfengine --version ===" | tee -a log
+cfengine --version 2>&1 | tee -a log
+echo "=== cfengine help ===" | tee -a log
 cfengine help 2>&1 | tee -a log

tests/shell/001-help.sh

@@ -1 +1,2 @@
+#!/bin/bash
 cfengine help

tests/test_cache.py

@@ -0,0 +1,14 @@
+"""Just some very basic tests to ensure we can use functions from the
+cfbs and cf-remote dependencies"""
+
+from cf_remote.utils import canonify
+from cfbs.utils import is_a_commit_hash
+
+
+def test_cfbs_is_a_commit_hash():
+    assert is_a_commit_hash("6072060c63c5f6bc74897bf4be2681d3e9d3bf32")
+    assert not is_a_commit_hash("blah")
+
+
+def test_cf_remote_canonify():
+    assert canonify(" CF-REMOTE ") == "cf_remote"