Development: Add playwright e2e tests for system health

[muradium]

Checklist

General

• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Client

• I strictly followed the client coding and design guidelines.
• I documented the TypeScript code using JSDoc style.

Motivation and Context

System health tests are missing in Playwright. As a part of migration to Playwright, they need to be migrated from Cypress.

Description

Adds system health tests to Playwright and disables them in Cypress.

Steps for Testing

• Code Review: Ensure that tests pass for valid reasons, functionality is adequately tested and check the code quality.
• Run the tests (optional): Tests are checked by automatic run in CI environment. You can optionally run them locally and check if they pass.

Steps for running the tests:

1. Navigate to src/tests/playwright
2. Configure Playwright using playwright.env file based on your local setup. Current configuration should work for default Artemis setup.
3. Run npm install && npm run playwright:setup && npx playwright test e2e/SystemHealth.spec.ts
4. Confirm that "System health" tests pass

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

Summary by CodeRabbit

• Tests
  • Introduced tests for checking the health status of system components using Playwright.
  • Temporarily skipped system health check tests in Cypress.
  • Added a new test script SystemHealth.spec.ts for checking system health indicators on a web page.

[coderabbitai]

Walkthrough

The recent updates involve a shift in the approach to system health checks in end-to-end testing. The Cypress test for Artemis system health is now skipped, indicating a change in testing focus. On the other hand, a new Playwright test script, SystemHealth.spec.ts, has been introduced to evaluate various system health indicators on a web page, showcasing an expanded testing scope leveraging Playwright.

Changes

File Path	Change Summary
src/test/cypress/e2e/SystemHealth.cy.ts	Skipped the Artemis system health check test.
src/test/playwright/e2e/SystemHealth.spec.ts	Added tests to assess system component health using Playwright.

Possibly related issues

• Issue Database: github
  • Issue Key: Development: Refactor LinkPreviewIntegrationTest #8054
    • Reasoning: The changes in this PR align with the objective of enhancing testing reliability and effectiveness by focusing on controlled tests and stability, similar to the goals outlined in this issue.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Out of diff range and nitpick comments (1)

src/test/playwright/e2e/SystemHealth.spec.ts (1)

28-32: Consider the performance impact of running these checks as separate tests. Grouping them or using a parametrized test approach could improve performance.

[julian-christl]

Thanks for the changes, @muradium, but the build plan doesn't seem to exist for this branch, so we can't see the impact of the test here. Could you please ensure that the branch gets activated so we can get the results of the playwright tests?

[julian-christl]

Tests running through now, lgtm

[pzdr7]

Code LGTM and tests pass locally 👍