From 1399f22e66e88080bc01d509ead68ea9a9e67643 Mon Sep 17 00:00:00 2001 From: Alex Kavanagh Date: Tue, 1 Feb 2022 20:13:54 +0000 Subject: [PATCH] Update to build using charmcraft Due to a build problem with the reactive plugin, this change falls back on overriding the steps and doing a manual build, but it also ensures the CI system builds the charm using charmcraft. Changes: - add a build-requirements.txt - modify charmcraft.yaml - modify osci.yaml -> indicate build with charmcraft - modify tox.ini -> tox -e build does charmcraft build/rename -> tox -e build-reactive does the reactive build - modify bundles to use the .charm artifact in tests. and fix deprecation warning re: prefix - tox inception to enable tox -e func-test in the CI Change-Id: Id14cd0d06f6c98c02d1cffb30c2cd4fe73ed5691 --- build-requirements.txt | 7 +++++++ charmcraft.yaml | 18 +++++++++++++++--- osci.yaml | 1 + rename.sh | 13 +++++++++++++ src/test-requirements.txt | 3 +++ src/tests/bundles/focal-xena.yaml | 6 ++++-- src/tests/bundles/focal-yoga.yaml | 6 ++++-- src/tests/bundles/impish-xena.yaml | 6 ++++-- src/tests/bundles/jammy-yoga.yaml | 6 ++++-- src/tests/tests.yaml | 12 ++++++------ test-requirements.txt | 6 ++++++ tox.ini | 25 +++++++++++++++++++++++++ 12 files changed, 92 insertions(+), 17 deletions(-) create mode 100644 build-requirements.txt create mode 100755 rename.sh diff --git a/build-requirements.txt b/build-requirements.txt new file mode 100644 index 0000000..b6d2452 --- /dev/null +++ b/build-requirements.txt @@ -0,0 +1,7 @@ +# NOTES(lourot): +# * We don't install charmcraft via pip anymore because it anyway spins up a +# container and scp the system's charmcraft snap inside it. So the charmcraft +# snap is necessary on the system anyway. +# * `tox -e build` successfully validated with charmcraft 1.2.1 + +cffi==1.14.6; python_version < '3.6' # cffi 1.15.0 drops support for py35. diff --git a/charmcraft.yaml b/charmcraft.yaml index a850351..4968216 100644 --- a/charmcraft.yaml +++ b/charmcraft.yaml @@ -2,9 +2,21 @@ type: charm parts: charm: - source: src/ - plugin: reactive - build-snaps: [charm] + build-packages: + - tox + - git + - python3-dev + override-build: | + apt-get install ca-certificates -y + tox -e build-reactive + override-stage: | + echo "Copying charm to staging area: $CHARMCRAFT_STAGE" + NAME=$(ls $CHARMCRAFT_PART_BUILD/build/builds) + cp -r $CHARMCRAFT_PART_BUILD/build/builds/$NAME/* $CHARMCRAFT_STAGE/ + override-prime: | + # For some reason, the normal priming chokes on the fact that there's a + # hooks directory. + cp -r $CHARMCRAFT_STAGE/* . bases: - name: ubuntu diff --git a/osci.yaml b/osci.yaml index 8bf3da4..81cf75d 100644 --- a/osci.yaml +++ b/osci.yaml @@ -7,3 +7,4 @@ vars: needs_charm_build: true charm_build_name: keystone-saml-mellon + build_type: charmcraft diff --git a/rename.sh b/rename.sh new file mode 100755 index 0000000..d0c35c9 --- /dev/null +++ b/rename.sh @@ -0,0 +1,13 @@ +#!/bin/bash +charm=$(grep "charm_build_name" osci.yaml | awk '{print $2}') +echo "renaming ${charm}_*.charm to ${charm}.charm" +echo -n "pwd: " +pwd +ls -al +echo "Removing bad downloaded charm maybe?" +if [[ -e "${charm}.charm" ]]; +then + rm "${charm}.charm" +fi +echo "Renaming charm here." +mv ${charm}_*.charm ${charm}.charm diff --git a/src/test-requirements.txt b/src/test-requirements.txt index e771023..9c7afb7 100644 --- a/src/test-requirements.txt +++ b/src/test-requirements.txt @@ -4,6 +4,9 @@ # https://github.com/openstack-charmers/release-tools # +# Need tox to be available from tox... inception yes, but its a workaround for now +tox + # Functional Test Requirements (let Zaza's dependencies solve all dependencies here!) git+https://github.com/openstack-charmers/zaza.git#egg=zaza git+https://github.com/openstack-charmers/zaza-openstack-tests.git#egg=zaza.openstack diff --git a/src/tests/bundles/focal-xena.yaml b/src/tests/bundles/focal-xena.yaml index b379133..5097c3b 100644 --- a/src/tests/bundles/focal-xena.yaml +++ b/src/tests/bundles/focal-xena.yaml @@ -1,6 +1,8 @@ variables: openstack-origin: &openstack-origin cloud:focal-xena +local_overlay_enabled: False + series: focal comment: @@ -192,7 +194,7 @@ applications: keystone-saml-mellon1: series: focal - charm: ../../../keystone-saml-mellon + charm: ../../../keystone-saml-mellon.charm num_units: 0 options: idp-name: 'test-saml-idp1' @@ -212,7 +214,7 @@ applications: keystone-saml-mellon2: series: focal - charm: ../../../keystone-saml-mellon + charm: ../../../keystone-saml-mellon.charm num_units: 0 options: idp-name: 'test-saml-idp2' diff --git a/src/tests/bundles/focal-yoga.yaml b/src/tests/bundles/focal-yoga.yaml index a86463a..c49a56f 100644 --- a/src/tests/bundles/focal-yoga.yaml +++ b/src/tests/bundles/focal-yoga.yaml @@ -1,6 +1,8 @@ variables: openstack-origin: &openstack-origin cloud:focal-yoga +local_overlay_enabled: False + series: focal comment: @@ -192,7 +194,7 @@ applications: keystone-saml-mellon1: series: focal - charm: ../../../keystone-saml-mellon + charm: ../../../keystone-saml-mellon.charm num_units: 0 options: idp-name: 'test-saml-idp1' @@ -212,7 +214,7 @@ applications: keystone-saml-mellon2: series: focal - charm: ../../../keystone-saml-mellon + charm: ../../../keystone-saml-mellon.charm num_units: 0 options: idp-name: 'test-saml-idp2' diff --git a/src/tests/bundles/impish-xena.yaml b/src/tests/bundles/impish-xena.yaml index 1b25029..35667f3 100644 --- a/src/tests/bundles/impish-xena.yaml +++ b/src/tests/bundles/impish-xena.yaml @@ -1,6 +1,8 @@ variables: openstack-origin: &openstack-origin distro +local_overlay_enabled: False + series: impish comment: @@ -193,7 +195,7 @@ applications: keystone-saml-mellon1: series: groovy - charm: ../../../keystone-saml-mellon + charm: ../../../keystone-saml-mellon.charm num_units: 0 options: idp-name: 'test-saml-idp1' @@ -214,7 +216,7 @@ applications: keystone-saml-mellon2: series: groovy - charm: ../../../keystone-saml-mellon + charm: ../../../keystone-saml-mellon.charm num_units: 0 options: idp-name: 'test-saml-idp2' diff --git a/src/tests/bundles/jammy-yoga.yaml b/src/tests/bundles/jammy-yoga.yaml index 915f294..74d9c94 100644 --- a/src/tests/bundles/jammy-yoga.yaml +++ b/src/tests/bundles/jammy-yoga.yaml @@ -1,6 +1,8 @@ variables: openstack-origin: &openstack-origin distro +local_overlay_enabled: False + series: jammy comment: @@ -193,7 +195,7 @@ applications: keystone-saml-mellon1: series: groovy - charm: ../../../keystone-saml-mellon + charm: ../../../keystone-saml-mellon.charm num_units: 0 options: idp-name: 'test-saml-idp1' @@ -214,7 +216,7 @@ applications: keystone-saml-mellon2: series: groovy - charm: ../../../keystone-saml-mellon + charm: ../../../keystone-saml-mellon.charm num_units: 0 options: idp-name: 'test-saml-idp2' diff --git a/src/tests/tests.yaml b/src/tests/tests.yaml index 17896d0..9b88f7f 100644 --- a/src/tests/tests.yaml +++ b/src/tests/tests.yaml @@ -31,10 +31,10 @@ tests: target_deploy_status: ntp: workload-status: active - workload-status-message: "chrony: Ready" + workload-status-message-prefix: "chrony: Ready" vault: workload-status: blocked - workload-status-message: Vault needs to be initialized + workload-status-message-prefix: Vault needs to be initialized keystone-saml-mellon: # NOTE(lourot): because this is the charm name, Zaza automatically # deploys this application with no unit, although we don't mention it in @@ -42,16 +42,16 @@ target_deploy_status: num-expected-units: 0 keystone-saml-mellon1: workload-status: blocked - workload-status-message: "Configuration is incomplete. idp-metadata: idp-metadata resource has not been provided,sp-signing-keyinfo: sp-signing-keyinfo resource has not been provided,sp-private-key: sp-private-key resource has not been provided" + workload-status-message-prefix: "Configuration is incomplete. idp-metadata: idp-metadata resource has not been provided,sp-signing-keyinfo: sp-signing-keyinfo resource has not been provided,sp-private-key: sp-private-key resource has not been provided" test-saml-idp1: workload-status: blocked - workload-status-message: "sp-metadata resource is not a well-formed xml file" + workload-status-message-prefix: "sp-metadata resource is not a well-formed xml file" keystone-saml-mellon2: workload-status: blocked - workload-status-message: "Configuration is incomplete. idp-metadata: idp-metadata resource has not been provided,sp-signing-keyinfo: sp-signing-keyinfo resource has not been provided,sp-private-key: sp-private-key resource has not been provided" + workload-status-message-prefix: "Configuration is incomplete. idp-metadata: idp-metadata resource has not been provided,sp-signing-keyinfo: sp-signing-keyinfo resource has not been provided,sp-private-key: sp-private-key resource has not been provided" test-saml-idp2: workload-status: blocked - workload-status-message: "sp-metadata resource is not a well-formed xml file" + workload-status-message-prefix: "sp-metadata resource is not a well-formed xml file" tests_options: force_deploy: diff --git a/test-requirements.txt b/test-requirements.txt index 208032f..a11a7d0 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -28,6 +28,11 @@ oslo.utils<=3.41.0;python_version<'3.6' requests>=2.18.4 charms.reactive +# Newer mock seems to have some syntax which is newer than python3.5 (e.g. +# f'{something}' +mock>=1.2,<4.0.0; python_version < '3.6' +mock>=1.2; python_version >= '3.6' + nose>=1.3.7 coverage>=3.6 git+https://github.com/openstack/charms.openstack.git#egg=charms.openstack @@ -46,3 +51,4 @@ pbr==5.6.0 # vault cryptography<3.4 # vault, keystone-saml-mellon lxml # keystone-saml-mellon hvac # vault, barbican-vault +psutil # cinder-lvm diff --git a/tox.ini b/tox.ini index faf6092..2d60b8a 100644 --- a/tox.ini +++ b/tox.ini @@ -37,11 +37,24 @@ setenv = VIRTUAL_ENV={envdir} passenv = http_proxy https_proxy INTERFACE_PATH LAYER_PATH JUJU_REPOSITORY install_command = {toxinidir}/pip.sh install {opts} {packages} +allowlist_externals = + charmcraft + bash + tox + rename.sh deps = -r{toxinidir}/requirements.txt [testenv:build] basepython = python3 +deps = -r{toxinidir}/build-requirements.txt +commands = + charmcraft clean + charmcraft -v build + {toxinidir}/rename.sh + +[testenv:build-reactive] +basepython = python3 commands = charm-build --log-level DEBUG --use-lock-file-branches -o {toxinidir}/build/builds src {posargs} @@ -86,6 +99,18 @@ deps = flake8==3.9.2 charm-tools==2.8.3 commands = flake8 {posargs} src unit_tests +[testenv:func-target] +# Hack to get functional tests working in the charmcraft +# world. We should fix this. +basepython = python3 +passenv = HOME TERM CS_* OS_* TEST_* +deps = -r{toxinidir}/src/test-requirements.txt +changedir = {toxinidir}/src +commands = + bash -c "if [ ! -f ../*.charm ]; then echo 'Charm does not exist. Run tox -e build'; exit 1; fi" + tox --version + tox -e func-target {posargs} + [testenv:cover] # Technique based heavily upon # https://github.com/openstack/nova/blob/master/tox.ini