Merge pull request #235 from rodrigogansobarbieri/manual_functest

charm test runner: manual_functest and remote-build

openstack/tools/charmed_openstack_functest_runner.sh

@@ -7,8 +7,11 @@
 #
 FUNC_TEST_PR=
 FUNC_TEST_TARGET=
+MANUAL_FUNCTESTS=false
 MODIFY_BUNDLE_CONSTRAINTS=true
+REMOTE_BUILD=
 SKIP_BUILD=false
+SLEEP=
 WAIT_ON_DESTROY=true
 
 usage () {
@@ -36,12 +39,22 @@ OPTIONS:
     --no-wait
         By default we wait before destroying the model after a test run. This
         flag can used to override that behaviour.
+    --manual-functests
+        Runs functest commands separately (deploy,configure,test) instead of
+        the entire suite.
+    --remote-build
+        Builds the charm in a remote location and transfers the charm file over.
+        The destination needs to be prepared for the build and authorized for
+        ssh. Implies --skip-build. Specify parameter as <destination>,<path>.
+        Example: --remote-build [email protected],~/git/charm-nova-compute
     --skip-build
         Skip building charm if already done to save time.
     --skip-modify-bundle-constraints
         By default we modify test bundle constraints to ensure that applications
         have the resources they need. For example nova-compute needs to have
         enough capacity to boot the vms required by the tests.
+    --sleep
+        Specify amount of seconds to sleep between functest steps.
     --help
         This help message.
 EOF
@@ -60,15 +73,27 @@ while (($# > 0)); do
             FUNC_TEST_PR=$2
             shift
             ;;
+        --manual-functests)
+            MANUAL_FUNCTESTS=true
+            ;;
         --no-wait)
             WAIT_ON_DESTROY=false
             ;;
+        --remote-build)
+            REMOTE_BUILD=$2
+            SKIP_BUILD=true
+            shift
+            ;;
         --skip-modify-bundle-constraints)
             MODIFY_BUNDLE_CONSTRAINTS=false
             ;;
         --skip-build)
             SKIP_BUILD=true
             ;;
+        --sleep)
+            SLEEP=$2
+            shift
+            ;;
         --help|-h)
             usage
             exit 0
@@ -139,6 +164,15 @@ if ! $SKIP_BUILD; then
     lxd init --auto || true
 
     tox -re build
+else
+    if [[ -n $REMOTE_BUILD ]]; then
+        IFS=',' read -ra remote_build_params <<< "$REMOTE_BUILD"
+        REMOTE_BUILD_DESTINATION=${remote_build_params[0]}
+        REMOTE_BUILD_PATH=${remote_build_params[1]}
+        ssh $REMOTE_BUILD_DESTINATION "cd $REMOTE_BUILD_PATH;git log -1;rm -rf *.charm;tox -re build"
+        rm -rf *.charm
+        rsync -vza $REMOTE_BUILD_DESTINATION:$REMOTE_BUILD_PATH/*.charm .
+    fi
 fi
 
 # 3. Run functional tests.
@@ -179,10 +213,20 @@ if $MODIFY_BUNDLE_CONSTRAINTS; then
     )
 fi
 
+# We don't need to rebuild when running different bundles for the same branch
+rm -rf .tox/func-target
+rm -rf .tox/func-noop
+
 for target in ${!func_targets[@]}; do
     [[ -d src ]] && pushd src &>/dev/null || true
     fail=false
-    tox -re func-target -- $target || fail=true
+    if ! $MANUAL_FUNCTESTS; then
+        tox -e func-target -- $target || fail=true
+        model=`juju list-models| egrep -o "^zaza-\S+"|tr -d '*'`
+    else
+        $TOOLS_PATH/manual_functests_runner.sh $target $SLEEP || fail=true
+        model=test-$target
+    fi
 
     if $fail; then
         func_targets[$target]='fail'
@@ -194,7 +238,6 @@ for target in ${!func_targets[@]}; do
         read -p "Destroy model and run next test? [ENTER]"
     fi
     # cleanup before next run
-    model=`juju list-models| egrep -o "^zaza-\S+"|tr -d '*'`
     juju destroy-model --no-prompt $model --force --no-wait --destroy-storage
 done
 popd &>/dev/null || true

openstack/tools/func_test_tools/manual_functests_runner.sh

@@ -0,0 +1,54 @@
+#!/bin/bash -eu
+
+# This file assists the main charmed_functest_runner script but can also be invoked separately
+# by passing the target (jammy-antelope, focal-yoga, etc) to run and a sleep timer between the
+# configure and test run. If run manually, the .charm file must exist in the source code folder
+# and the environment variables need to have been exported prior to invoking this script.
+#
+# What this script does is run the functions functest-deploy, functest-configure and
+# functest-test separately one after the other, instead of the entire suite run in the
+# same command that the command functest-target does.
+#
+# The main advantages of this is that it is easier for debugging, and it can also help
+# when there are race conditions running the charm test (by using the sleep parameter).
+#
+# Ideally, all those issues should be worked out in zaza, but having this alternative
+# makes it easier for debugging, testing, and validating the race condition.
+
+TARGET=$1
+SLEEP=$2
+
+if [[ ! -d ./.tox/func-noop ]]; then
+    tox -e func-noop
+fi
+
+juju add-model test-$TARGET --no-switch
+
+# Those below are the parameters that are used when functest-target creates a model named "zaza-<hash>"
+
+juju model-config -m test-$TARGET test-mode=true transmit-vendor-metrics=false enable-os-upgrade=false default-series=jammy automatically-retry-hooks=false
+
+source ./.tox/func-noop/bin/activate
+
+functest-deploy -b tests/bundles/$TARGET.yaml -m test-$TARGET
+
+juju status -m test-$TARGET
+
+functest-configure -m test-$TARGET
+
+juju status -m test-$TARGET
+
+echo "Sleeping for $SLEEP seconds"
+
+sleep $SLEEP
+
+echo "Woke up"
+
+juju status -m test-$TARGET
+
+functest-test -m test-$TARGET
+
+juju status -m test-$TARGET
+
+echo "Finished $TARGET"
+

tox.ini

@@ -59,6 +59,7 @@ bashfiles =
     {toxinidir}/openstack/tools/upload_octavia_amphora_image.sh
     {toxinidir}/openstack/tools/install_local_ca.sh
     {toxinidir}/openstack/tools/charmed_openstack_functest_runner.sh
+    {toxinidir}/openstack/tools/func_test_tools/manual_functests_runner.sh
     {toxinidir}/openstack/tools/instance_launch.sh
     {toxinidir}/openstack/tools/setup_tempest.sh
     {toxinidir}/openstack/tools/create_octavia_lb.sh