`Development`: Add e2e playwright tests for exam announcement #8630

muradium · 2024-05-18T22:35:07Z

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

We want to test exam announcement dialogs popping up by actions such as instructor sending a message or exam working time change.

Description

Adds E2E tests in Playwright about exam announcements.

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:

Navigate to src/tests/playwright
Configure Playwright using playwright.env file based on your local setup. Current configuration should work for default Artemis setup.
Run npm install && npm run playwright:setup && npx playwright test e2e/exam/ExamParticipation.spec.ts
Confirm that "Exam announcement" 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

This reverts commit 08e7d09.

…rticipation actions into a separate fixture

coderabbitai · 2024-05-18T22:35:23Z

Walkthrough

The recent updates primarily focus on enhancing the Playwright test suite for exam-related functionalities. Key changes include renaming the ExamParticipation class to ExamParticipationPage for consistency, adding unique IDs to button elements in HTML files, and introducing new classes and methods to manage exam announcements, working times, and modal dialog interactions. These improvements aim to streamline test scripts and enhance the clarity and maintainability of the codebase.

Changes

File Path	Change Summary
`src/main/webapp/.../exam-live-announcement-create-button.component.html`	Added `id="announcement-create-button"` to the button element.
`src/main/webapp/.../exam-edit-working-time.component.html`	Added unique `id` attribute `edit-working-time-button` to the button element.
`src/test/playwright/.../ExamAssessment.spec.ts`	Renamed `ExamParticipation` to `ExamParticipationPage` for consistency.
`src/test/playwright/.../ExamParticipation.spec.ts`	Added `ExamStartEndPage`, `Commands`, `ExamAPIRequests`, `ModalDialogBox`, `ExamParticipationActions`, and `createExam` function.
`src/test/playwright/.../ExamResults.spec.ts`	Renamed `ExamParticipation` to `ExamParticipationPage` for consistency.
`src/test/playwright/.../TestExamStudentExams.spec.ts`	Renamed `ExamParticipation` to `ExamParticipationPage` for consistency.
`src/test/playwright/support/fixtures.ts`	Renamed `ExamParticipation` to `ExamParticipationPage`, added `ModalDialogBox` and `ExamParticipationActions` imports, and updated references.
`src/test/playwright/.../ExamManagementPage.ts`	Added imports for `Dayjs` and methods for managing announcements and working times.
`src/test/playwright/.../ExamParticipationActions.ts`	Introduced `ExamParticipationActions` class with methods for interacting with exam participation actions.
`src/test/playwright/.../ExamParticipationPage.ts`	Refactored `ExamParticipation` to extend `ExamParticipationActions` and removed unused methods.
`src/test/playwright/.../ModalDialogBox.ts`	Added `ModalDialogBox` class for interacting with modal dialog boxes in tests.

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

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: 2

src/test/playwright/e2e/exam/ExamParticipation.spec.ts

rstief

Demonstrated in testing session, Code also LGTM

rstief · 2024-05-23T12:54:45Z

src/test/playwright/support/pageobjects/exam/ExamParticipationActions.ts

+    async checkExamFinishedTitle(title: string) {
+        await expect(this.page.locator('#exam-finished-title')).toContainText(title, { timeout: 40000 });
+    }
+
+    async checkExamFullnameInputExists() {
+        await expect(this.page.locator('#fullname')).toBeVisible({ timeout: 30000 });
+    }
+
+    async checkYourFullname(name: string) {
+        await expect(this.page.locator('#your-name')).toContainText(name, { timeout: 30000 });
+    }


Why are the timeouts so long? This would be 40/30 seconds, right?

I checked and turns out these are timeouts for waiting for an exam to finish, delegated to POM functions. Would be better to wait for exam finish explicitly in the test if needed, not in an assertion coming after.

But these functions are not relevant to current PR, I just moved them to different POM. Maybe I should fix that in another PR?

yes, please fix it in another PR

BBesrour

Demonstrated in a testing session.

…he exam

BBesrour

re-approve

BBesrour

re-approve
(last one was a misclick :'))

coolchock

demonstrated in the testing session, looks good. I think you could also add another e2e test for problem statement updates in a follow-up PR.

muradium added 7 commits May 9, 2024 20:18

Instructor makes an exam announcement and all participants receive it

556b6d6

Adds exam working time POM functions

08e7d09

Revert "Adds exam working time POM functions"

b56ab72

This reverts commit 08e7d09.

Extract function for exam creation

5e1c72c

Adds exam working time change test

7351517

Change TODO

957151e

Merges announcement tests into one test suite, extracts small exam pa…

2b43ec1

…rticipation actions into a separate fixture

muradium requested a review from a team as a code owner May 18, 2024 22:35

github-actions bot added tests client Pull requests that update TypeScript code. (Added Automatically!) labels May 18, 2024

github-actions bot assigned muradium May 18, 2024

coderabbitai bot requested changes May 18, 2024

View reviewed changes

src/test/playwright/e2e/exam/ExamParticipation.spec.ts Show resolved Hide resolved

src/test/playwright/e2e/exam/ExamParticipation.spec.ts Show resolved Hide resolved

coderabbitai bot previously approved these changes May 18, 2024

View reviewed changes

Merge branch 'develop' into feature/playwright/exam-working-time-change

28de170

muradium added the ready for review label May 19, 2024

Merge branch 'develop' into feature/playwright/exam-working-time-change

371f71f

rstief previously approved these changes May 23, 2024

View reviewed changes

BBesrour previously approved these changes May 23, 2024

View reviewed changes

Avoids 2 announcements appearing on top of each other by not ending t…

ffcdb3a

…he exam

muradium dismissed stale reviews from BBesrour, rstief, and coderabbitai[bot] via ffcdb3a May 23, 2024 13:25

rstief approved these changes May 23, 2024

View reviewed changes

BBesrour requested changes May 23, 2024

View reviewed changes

BBesrour approved these changes May 23, 2024

View reviewed changes

coolchock approved these changes May 23, 2024

View reviewed changes

muradium added ready to merge and removed ready for review labels May 24, 2024

dmytropolityka approved these changes May 24, 2024

View reviewed changes

krusche changed the title ~~Development: Exam announcement e2e tests~~ Development: Add e2e playwright tests for exam announcement May 25, 2024

krusche added this to the 7.1.0 milestone May 25, 2024

krusche merged commit 5cb587e into develop May 25, 2024
35 of 36 checks passed

krusche deleted the feature/playwright/exam-working-time-change branch May 25, 2024 20:18

coderabbitai bot mentioned this pull request Sep 29, 2024

Development: Fix flaky e2e tests #9326

Merged

8 tasks

This was referenced Oct 11, 2024

Development: Fix wrong result subscription for exam exercises #9453

Merged

Development: Fix exam assessment e2e tests failing #9462

Merged

Development: Fix exam results overview e2e test #9472

Merged

coderabbitai bot mentioned this pull request Oct 27, 2024

Development: Fix e2e tests for modeling exercises #9613

Merged

8 tasks

coderabbitai bot mentioned this pull request Nov 5, 2024

Development: Run Playwright tests with submission builds sequentially #9623

Merged

10 tasks

coderabbitai bot mentioned this pull request Nov 18, 2024

Development: Improve execution speed of Playwright tests #9817

Merged

10 tasks

coderabbitai bot mentioned this pull request Nov 26, 2024

Development: Add e2e tests for instructors assessing exams in the second round #9863

Merged

8 tasks

This was referenced Dec 18, 2024

Development: Remove redundant e2e test #10046

Merged

Development: Add playwright exam checklist e2e tests #10050

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Development`: Add e2e playwright tests for exam announcement #8630

`Development`: Add e2e playwright tests for exam announcement #8630

muradium commented May 18, 2024 •

edited by rstief

Loading

coderabbitai bot commented May 18, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

rstief left a comment

rstief May 23, 2024

muradium May 24, 2024

krusche May 25, 2024

BBesrour left a comment

BBesrour left a comment

BBesrour left a comment

coolchock left a comment

Development: Add e2e playwright tests for exam announcement #8630

Development: Add e2e playwright tests for exam announcement #8630

Conversation

muradium commented May 18, 2024 • edited by rstief Loading

Checklist

General

Client

Motivation and Context

Description

Steps for Testing

Testserver States

Review Progress

Code Review

Manual Tests

coderabbitai bot commented May 18, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

rstief left a comment

Choose a reason for hiding this comment

rstief May 23, 2024

Choose a reason for hiding this comment

muradium May 24, 2024

Choose a reason for hiding this comment

krusche May 25, 2024

Choose a reason for hiding this comment

BBesrour left a comment

Choose a reason for hiding this comment

BBesrour left a comment

Choose a reason for hiding this comment

BBesrour left a comment

Choose a reason for hiding this comment

coolchock left a comment

Choose a reason for hiding this comment

`Development`: Add e2e playwright tests for exam announcement #8630

`Development`: Add e2e playwright tests for exam announcement #8630

muradium commented May 18, 2024 •

edited by rstief

Loading

coderabbitai bot commented May 18, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)