CI: failed to run katib-controller integration tests

[NohaIhab]

logs:

Run sg microk8s -c "tox -e controller-integration"
  sg microk8s -c "tox -e controller-integration"
  shell: /usr/bin/bash -e {0}
  env:
    CONTROLLER_NAME: github-pr-e977c-microk8s
ROOT: HandledError| provided environments not found in configuration file: ['controller-integration']

came up in this run

[phoevos]

So it looks like this run uses the latest tox 4.9.0 released yesterday. The release introduces the following change:

Disallow command line environments which are not explicitly specified in the config file

This breaks our CI, which attempts to use the controller-integration testenv:

katib-operators/.github/workflows/integrate.yaml

Line 82 in a9c7609

sg microk8s -c "tox -e ${{ matrix.charm }}-integration"

controller-integration is not included in the envlist, however, but rather katib-controller-integration is:

katib-operators/tox.ini

Line 10 in a9c7609

envlist = fmt, lint, unit, integration, {katib-controller,katib-db-manager}-{lint,unit,integration}

Previously, this would not matter, since explicitly specifying the environment would bypass the envlist and the proper command would be set here (pattern matching works properly because both "controller" and "integration" are in the provided environment name):

katib-operators/tox.ini

Lines 19 to 26 in a9c7609

	controller: CHARM = controller
	db-manager: CHARM = db-manager
	ui: CHARM = ui
	unit: TYPE = unit
	lint: TYPE = lint
	integration: TYPE = integration
	commands =
	tox -c charms/katib-{env:CHARM} -e {env:TYPE}

Solution

Following the latest tox release we will have to provide the correct environment name (i.e. katib-controller-integration) in the charm matrix (this should have always been the case, really):

katib-operators/.github/workflows/integrate.yaml

Lines 63 to 65 in a9c7609

	matrix:
	charm:
	- controller

[phoevos]

Note, we will have to check whether other parts of this or other repositories are potentially affected by this change.

---

EDIT: Following a quick search around Github, it doesn't look like any of our other repos are affected, since we usually don't include the app prefix (e.g. katib) in the tox envlist.