integration_test_charm_allure_beta.md

Allure Report for integration_test_charm.yaml

Usage

Warning

This feature is in beta and not part of the public interface. It is subject to breaking changes or removal on a patch version bump.

1. poetry add --group integration allure-pytest
2. Add

allure-pytest-collection-report = {git = "https://github.com/canonical/data-platform-workflows", tag = "v0.0.0", subdirectory = "python/pytest_plugins/allure_pytest_collection_report"}

to your integration test dependencies in pyproject.toml.

3. Set _beta_allure_report: true for one instance of integration_test_charm.yaml. If integration_test_charm.yaml is called with a matrix, _beta_allure_report can only be true for one combination of the matrix.
4. Add permission to integration_test_charm.yaml job and all calling workflows

    permissions:
      contents: write  # Needed for Allure Report beta

5. Create gh pages branch

   data-platform-workflows/.github/workflows/integration_test_charm.yaml

   Lines 363 to 371 in 5a2c816

   	# For first run, manually create branch with no history
   	# (e.g.
   	# git checkout --orphan gh-pages-beta
   	# git rm -rf .
   	# touch .nojekyll
   	# git add .nojekyll
   	# git commit -m "Initial commit"
   	# git push origin gh-pages-beta
   	# )

6. Enable gh pages publishing at https://github.com/canonical/mysql-router-k8s-operator/settings/pages (replace mysql-router-k8s-operator with repository name)

Example for 1, 3-4: canonical/mysql-router-k8s-operator#198

Example for 2: canonical/mysql-router-k8s-operator#252