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>.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

@@ -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.

charmcraft.yaml

@@ -2,9 +2,21 @@ type: charm
 
 parts:
   charm:
-    source: src/
+    build-packages:
-    plugin: reactive
+      - tox
-    build-snaps: [charm]
+      - 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

osci.yaml

@@ -7,3 +7,4 @@
     vars:
       needs_charm_build: true
       charm_build_name: keystone-saml-mellon
+      build_type: charmcraft

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

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

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'

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'

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'

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'

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:

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

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