Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(doc): added new instructions for e2e test with different lxd versions [WD-9034] #666

Merged
merged 1 commit into from
Feb 23, 2024
Merged

chore(doc): added new instructions for e2e test with different lxd versions [WD-9034] #666

merged 1 commit into from
Feb 23, 2024

Conversation

mas-who
Copy link
Contributor

@mas-who mas-who commented Feb 22, 2024

Done

  • Added some context in ARCHITECTURE.md about multi lxd version support in the UI
  • Updated instructions in HACKING.md for running e2e tests for stable and edge lxd versions

QA

  1. Run the LXD-UI:
    • On the demo server via the link posted by @webteam-app below. This is only available for PRs created by collaborators of the repo. Ask @mas-who or @edlerd for access.
    • With a local copy of this branch, run as described here.
  2. Perform the following QA steps:
    • Check if updates in docs is clear.

@webteam-app
Copy link

Demo starting at https://lxd-ui-666.demos.haus

@mas-who mas-who changed the title chore(doc): added new instructions for e2e test with different lxd versions chore(doc): added new instructions for e2e test with different lxd versions [WD-9034] Feb 22, 2024
edlerd
edlerd reviewed Feb 22, 2024
View reviewed changes
HACKING.md Outdated

npx playwright test
snap refresh lxd --channel 5.0/stable
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe suggest to use latest/edge here, so the next command below test-e2e-edge is connected?

ARCHITECTURE.MD Outdated
@@ -12,6 +12,8 @@ For the production release, [LXD](https://github.com/canonical/lxd) is pulling t

In a clustered LXD environment the LXD-UI is available on all nodes, so you can query it from any cluster member. Authentication is shared between all nodes.

LXD maintains different release branches in parallel. This includes long term support (LTS) releases which can have older versions of LXD bundled with LXD-UI. This means that LXD-UI should be compatible with older versions of LXD (v5.0 or later). Compatibility here means graceful degradation in the UI when certian features are missing in older LXD versions.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was hoping we could describe how the test workflow is architected. Especially the matrix with channels and browsers. Also, how they are configured in pr.yaml and the connection to the projects in playwright.config.ts. Furthermore how the lxdVersion appears in the end to end tests and how it is used to enable / disable specific tests.

So instead of explaining why multiple version are there, explain how the different moving parts are working, and where they connect. Especially how they are configured, so we have a reference for future changes to the config.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aaaah sorry I misunderstood the assignment, will get that done 👍

@mas-who
Copy link
Contributor Author

mas-who commented Feb 23, 2024

I realised one thing, it is not easy to write documentation 😅 I hope the updated text makes sense

@mas-who mas-who requested a review from edlerd February 23, 2024 12:54
@mas-who mas-who force-pushed the add-docs-for-test branch 2 times, most recently from c798e89 to ef5c53e Compare February 23, 2024 14:27
edlerd
edlerd approved these changes Feb 23, 2024
View reviewed changes
Copy link
Collaborator

@edlerd edlerd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thanks! some suggestions below, address them or keep as is -- up to you :)

ARCHITECTURE.MD Outdated Show resolved Hide resolved
ARCHITECTURE.MD Outdated Show resolved Hide resolved
HACKING.md Outdated Show resolved Hide resolved
@mas-who mas-who merged commit 0468db1 into canonical:main Feb 23, 2024
8 of 9 checks passed
github-actions bot pushed a commit that referenced this pull request Feb 23, 2024
workflow: remove all reports for PR #666
d84674e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edlerd edlerd edlerd approved these changes

Assignees
No one assigned
Labels
Review: Code needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@mas-who @webteam-app @edlerd