Add workflow to run e2e tests from lxd-ui

[edlerd]

Added a step to the GitHub test workflow, executing the e2e test suite from lxd-ui with a lxd backend built from the current branch from a PR or main branch.

We might extend this on the stable-5.21 and stable-5.0 branches, as we have dedicated test suites in lxd-ui for those. For older versions, we should continue skipping the e2e tests. I'd keep this as a second step in a followup PR.

This was successful on a fork, i.e. see this run.

[tomponline]

Hi @edlerd please can you work with @simondeziel to update this to use the pre-built LXD binaries we now have (that are compiled during the Code Tests phase) and to use the re-usable workflows for performance tuning and dependency installation.

Also i'd like to avoid building the docs twice, but they are built into the tarball i believe during the Code Tests phase so may be available already now.

[edlerd]

@simondeziel @tomponline Updated the workflow to consume the build artefacts from previous steps. Please give it another review.

[edlerd]

Also using the docs artefact by depending and downloading on that build step.

[tomponline]

Please can this be rebased and squashed into fewer commits (perhaps only 1, depending on what you see as the logical changes in this PR), rather than each commit showing the evolution of the PR over the review. Thanks

[edlerd]

Please can this be rebased and squashed into fewer commits (perhaps only 1, depending on what you see as the logical changes in this PR), rather than each commit showing the evolution of the PR over the review. Thanks

Will do this after testing this on a fork shows a successful run.

[tomponline]

We should probably have a step here to cleanly stop LXD via lxd shutdown so we can be sure all coverage data is written before sending it up.

[edlerd]

I added the lxd shutdown, but the coverage data for the ui is empty on this run on my fork. I set up the secrets over there and the e2e test suite completed just fine. Any idea what could be missing is welcome.

[edlerd]

Here is an updated run on my fork. It still reports no coverage though.

[tomponline]

I wonder if the GOCOVERDIR env var isn't being set in your fork's run because of this line

lxd/.github/workflows/tests.yml

Line 15 in 5fdd983

GOCOVERDIR: ${{ ( github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' ) && '/home/runner/work/lxd/lxd/coverage' || '' }}

Because its that env var that indicates to the lxd binary where to store the coverage files.

[edlerd]

I wonder if the GOCOVERDIR env var isn't being set in your fork's run because of this line

Yeah, I saw that and explicitly set GOCOVERDIR for the ui step in recent versions of the workflow.

[tomponline]

ah, ok, but was that env var present in the lxd build step too, as that is used by LXD's makefile to build lxd with go coverage support.

[tomponline]

lxd/.github/workflows/tests.yml

Line 122 in 5fdd983

make

then relies on that env var being set here:

https://github.com/canonical/lxd/blob/main/Makefile#L43