Merge ~mthaddon/charm-test/+git/charm-test:python3 into charm-test:master

[Tom Haddon]

Rewrite in python3

Rewrite in python3

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Stuart Bishop (stub)]

Comments inline.

All landable as is, with tweaks from comments in future branches.

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision d882026f697f9aaac50ec38c0c946cc6c913c6e6

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..f8db829
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,2 @@
+lint:
+	@find . -name \*.py -exec python /usr/bin/flake8 --config=/dev/null --max-line-length=120 --max-complexity=10 --hang-closing {} +
diff --git a/charm-test b/charm-test
index e290ccb..97be0ca 100755
--- a/charm-test
+++ b/charm-test
@@ -1,111 +1,153 @@
-#!/bin/bash
-
-# Script to run lint and test suite inside LXC. Expects to be run from the
-# root of a charm directory.
-
-function usage() {
-    echo "$0 [controller-name] [container-name] [juju-model-name]"
-    echo ""
-    echo " controller-name: the name of a pre-configured Juju 2 controller to"
-    echo "                  run tests against (defaults to currently selected)"
-    echo " container-name: optional name of LXC container to create (defaults"
-    echo "                 to charm-test)"
-    echo " juju-model-name: optional name of juju model to create and use"
-    echo "                  (defaults to charm-test)"
-    echo ""
-    echo " Examples:"
-    echo "   $0"
-    echo "   $0 my-aws-controller"
-    echo "   $0 my-aws-controller my-graylog-container"
-    echo "   $0 my-aws-controller my-graylog-container my-juju-model"
-    echo ""
-    echo "This script will:"
-    echo " 1. Create an LXC, install all bundletester dependencies."
-    echo " 2. Copy charm source into LXC."
-    echo " 3. Run charm build in LXC."
-    echo " 4. Copy Juju credentials into the LXC."
-    echo " 5. Run bundletester tests on the specified Juju controller from"
-    echo "    within the LXC. This includes creating a Juju model to run"
-    echo "    tests against."
-    echo ""
-    exit 1
-}
-
-if [[ "$1" == "--help" ]] || [[ "$1" == "-h" ]]; then
-    usage
-fi
-
-set -eu
-
-CONTROLLER_NAME=${1:-$(juju switch | cut -d: -f1)}
-CONTAINER_NAME=${2:-charm-test}
-JUJU_MODEL_NAME=${3:-charm-test}
-
-function log_info() {
-    echo "$(date '+%Y-%m-%d %H:%M:%S') INFO: $1"
-}
-
-function lxc_run() {
-    cmd=$1
-    log_info "Running command \"${cmd}\" in container \"${CONTAINER_NAME}\" as root"
-    lxc exec ${CONTAINER_NAME} -- bash -c "${cmd}"
-}
-
-function lxc_run_as_ubuntu() {
-    cmd=$1
-    log_info "Running command \"${cmd}\" in container \"${CONTAINER_NAME}\" as ubuntu"
-    lxc exec ${CONTAINER_NAME} -- sudo -u ubuntu -i -- ${cmd}
-}
-
-function recreate_lxc() {
-    set +e
-    log_info "Checking if container exists"
-    lxc list | grep ${CONTAINER_NAME}
-    if [ $? -eq 0 ]; then
-        log_info "Found old container, deleting"
-        lxc delete --force ${CONTAINER_NAME}
-    fi
-    set -e
-    lxc launch ubuntu:16.04 ${CONTAINER_NAME}
-    # We shouldn't need to just wait here, but there doesn't appear to be an
-    # lxc wait command.
-    log_info "Sleeping for 20 seconds while LXC comes up with networking"
-    sleep 20
-    # First of all, copy the current charm directory into the LXC.
-    lxc_run_as_ubuntu "mkdir -p /home/ubuntu/charmsrc"
-    tar cf - . | lxc exec ${CONTAINER_NAME} -- tar xvf - -C /home/ubuntu/charmsrc
+#!/usr/bin/python3
+
+# Copyright (c) 2018 Canonical Ltd
+# License: GPLv3
+# Author: Tom Haddon <[e-mail]>
+
+import argparse
+import datetime
+import os
+import subprocess
+import time
+import yaml
+
+# Script to run lint and test suite inside LXC in a stanardized way.
+# This script will:
+#  1. Create an LXC, install test dependencies as defined by the charm's
+#     Makefile.
+#  2. Copy charm source into the LXC.
+#  3. Run charm build in the LXC.
+#  4. Copy Juju credentials into the LXC.
+#  5. Run make test. Any Juju operations will use the specified Juju contoller.
+
+
+def _get_default_controller():
+    """If we don't specify a controller, return currently selected"""
+    output_list = subprocess.check_output(['juju', 'switch'], universal_newlines=True).split(":")
+    if len(output_list) != 2:
+        raise Exception("Unexpected output from juju switch: {}".format(":".join(output_list)))
+    return output_list[0]
+
+
+def print_log(msg, level="INFO"):
+    print("{} {} {}".format(level, datetime.datetime.now(), msg))
+
+
+def find_charm(args):
+    metadata_yaml = os.path.join(args.charm_directory, 'metadata.yaml')
+    if not os.path.exists(metadata_yaml):
+        raise Exception("Unable to find metadata.yaml in directory, got: {}".format(metadata_yaml))
+    parsed_metadata = yaml.safe_load(open(metadata_yaml, 'r').read())
+    return parsed_metadata["name"]
+
+
+def lxc_run(cmd, args):
+    print_log('Running command "{}" in container "{}" as root'.format(" ".join(cmd), args.container_name))
+    lxc_cmd = ['lxc', 'exec', args.container_name, '--'] + cmd
+    lxc_run = subprocess.check_output(lxc_cmd, universal_newlines=True)
+    if lxc_run:
+        print_log("Output of command: {}".format(lxc_run))
+
+
+def lxc_run_as_ubuntu(cmd, args):
+    print_log('Running command "{}" in container "{}" as ubuntu'.format(" ".join(cmd), args.container_name))
+    lxc_cmd = ['lxc', 'exec', args.container_name, '--', 'sudo', '-u', 'ubuntu', '-i', '--'] + cmd
+    lxc_run = subprocess.check_output(lxc_cmd, universal_newlines=True)
+    if lxc_run:
+        print_log("Output of command: {}".format(lxc_run))
+
+
+def recreate_lxc(args):
+    print_log("Checking if container exists")
+    lxc_list = subprocess.check_output(['lxc', 'list', args.container_name], universal_newlines=True)
+    if args.container_name in lxc_list:
+        print_log("Found old container, deleting...")
+        deleted = subprocess.check_output(['lxc', 'delete', '--force', args.container_name], universal_newlines=True)
+        if deleted:
+            print_log("Output from deletion: {}".format(deleted))
+    lxc_launch = subprocess.check_output(['lxc', 'launch', 'ubuntu:16.04', args.container_name],
+                                         universal_newlines=True)
+    if lxc_launch:
+        print_log("Output from LXC creation: {}".format(lxc_launch))
+    print_log("Sleeping for 20 seconds while LXC comes up with networking")
+    time.sleep(20)
+    # Copy the charm directory into the LXC
+    os.chdir(args.charm_directory)
+    lxc_run_as_ubuntu(["mkdir", "-p", "/home/ubuntu/charmsrc"], args)
+    copy_charm_cmd = "tar cf - . | lxc exec {} -- tar xvf - -C /home/ubuntu/charmsrc".format(args.container_name)
+    copy_charm = subprocess.Popen(copy_charm_cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
+                                  universal_newlines=True)
+    output = copy_charm.communicate()[0]
+    print_log("Output from charm copy: {}".format(output))
     # Install test dependencies.
-    lxc_run "apt-get update"
-    lxc_run "apt-get install make"
-    lxc_run_as_ubuntu "make -C /home/ubuntu/charmsrc testdeps"
+    lxc_run(["apt-get", "update"], args)
+    lxc_run(["apt-get", "install", "make"], args)
+    lxc_run_as_ubuntu(["make", "-C", "/home/ubuntu/charmsrc", "testdeps"], args)
     # Build the charm inside the LXC.
-    lxc_run_as_ubuntu "make -C /home/ubuntu/charmsrc charmbuild BUILDDEST=/home/ubuntu/charmbuilt"
+    lxc_run_as_ubuntu(["make", "-C", "/home/ubuntu/charmsrc", "charmbuild", "BUILDDEST=/home/ubuntu/charmbuilt"],
+                      args)
     # Copy config for Juju access.
-    lxc_run "mkdir -p /home/ubuntu/.local/share/juju/"
-    cd ~/.local/share/juju && tar cf - . | lxc exec ${CONTAINER_NAME} -- tar xvf - -C /home/ubuntu/.local/share/juju
-    lxc_run "chown -R ubuntu:ubuntu /home/ubuntu/.local/share/juju"
-}
-
-FOUND_CHARM=$(find . -maxdepth 1 -name metadata.yaml | xargs grep '^name' | awk '{print $2}')
-log_info "About to run charm-test against the \"${FOUND_CHARM}\" charm"
-
-log_info "Recreating container \"${CONTAINER_NAME}\""
-recreate_lxc
-
-# Provide a visual break so it's more obvious set up has finished and you're
-# now looking at output you care about
-log_info ""
-log_info "--------------------------------------------"
-log_info "Set up complete, about to run lint and tests"
-log_info "--------------------------------------------"
-log_info ""
-
-lxc_run_as_ubuntu "juju add-model -c ${CONTROLLER_NAME} ${JUJU_MODEL_NAME}"
-# Even though we're running this in the charmsrc directory, because we're
-# passing in the BUILDDEST variable it'll run tests inside the charm we've
-# built above.
-lxc_run_as_ubuntu "make -C /home/ubuntu/charmsrc test BUILDDEST=/home/ubuntu/charmbuilt JUJU_MODEL=${CONTROLLER_NAME}:${JUJU_MODEL_NAME}"
-
-log_info "Cleaning up"
-lxc_run_as_ubuntu "juju destroy-model -y ${CONTROLLER_NAME}:${JUJU_MODEL_NAME}"
-lxc delete --force ${CONTAINER_NAME}
+    lxc_run(["mkdir", "-p", "/home/ubuntu/.local/share/juju/"], args)
+    os.chdir(os.path.expanduser('~/.local/share/juju'))
+    copy_juju_config_cmd = "tar cf - . | lxc exec {} -- tar xvf - -C /home/ubuntu/.local/share/juju".format(
+        args.container_name)
+    copy_juju_config = subprocess.Popen(copy_juju_config_cmd, shell=True, stdout=subprocess.PIPE,
+                                        stderr=subprocess.STDOUT, universal_newlines=True)
+    output = copy_juju_config.communicate()[0]
+    print_log("Output from Juju config copy: {}".format(output))
+    lxc_run(["chown", "-R", "ubuntu:ubuntu", "/home/ubuntu/.local/share/juju"], args)
+
+
+def visual_break():
+    print_log("")
+    print_log("--------------------------------------------")
+    print_log("Set up complete, about to run lint and tests")
+    print_log("--------------------------------------------")
+    print_log("")
+
+
+def add_juju_model(args):
+    lxc_run_as_ubuntu(["juju", "add-model", "-c", args.controller_name, args.juju_model_name], args)
+
+
+def run_tests(args):
+    lxc_run_as_ubuntu(["make", "-C", "/home/ubuntu/charmsrc", "test", "BUILDDEST=/home/ubuntu/charmbuilt",
+                       "JUJU_MODEL={}:{}".format(args.controller_name, args.juju_model_name)], args)
+
+
+def clean_up(args):
+    print_log("Cleaning up")
+    lxc_run_as_ubuntu(["juju", "destroy-model", "-y" "{}:{}".format(args.controller_name, args.juju_model_name)],
+                      args)
+    lxc_delete = subprocess.check_output(['lxc', 'delete', '--force', args.container_name], universal_newlines=True)
+    if lxc_delete:
+        print_log("Output of LXC delete: {}".format(lxc_delete))
+
+
+def parse_args():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-d", "--charm-directory", default=".", help="Directory of charm to run tests from (defaults to"
+                                                                     "current working directory).")
+    parser.add_argument("--controller-name", default=_get_default_controller(),
+                        help="The name of a pre-configured Juju 2 controller to run tests against (defaults to "
+                             "currently selected).")
+    parser.add_argument("--container-name", default="charm-test", help="optional name of LXC container to create "
+                                                                       "(defaults to 'charm-test')")
+    parser.add_argument("-j", "--juju-model-name", default="charm-test",
+                        help="optional name of juju model to create and use (defaults to 'charm-test')")
+    return parser.parse_args()
+
+
+def main():
+    args = parse_args()
+    charm = find_charm(args)
+    print_log("About to run charm-test against the '{}' charm".format(charm))
+    recreate_lxc(args)
+    visual_break()
+    add_juju_model(args)
+    run_tests(args)
+    clean_up(args)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/charm-test.py b/charm-test.py
new file mode 120000
index 0000000..a024413
--- /dev/null
+++ b/charm-test.py
@@ -0,0 +1 @@
+charm-test
\ No newline at end of file