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.

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

Development: Fix and improve URLs used in Cypress tests #8161

Merged
merged 5 commits into from
Mar 15, 2024

Conversation

julian-christl
Copy link
Member

@julian-christl julian-christl commented Mar 8, 2024

Checklist

General

Motivation and Context

The URLs sometimes contain trailing slashes or multiple slashes between segments. Spring Boot 3 is way more sensitive regarding such URLs. Also, when building URLs, not the best constants get used (e.g. ${BASE_URL}/courses instead of 'COURSE_BASE_URL')

Description

The constants now consistently use no trailing slashes. Hence, I had to adapt several occurrences. I also improved the usage of string template and made sure every URL build uses the best available constant.

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

Summary by CodeRabbit

  • Refactor
    • Enhanced URL construction for improved readability and maintainability using template literals.
    • Updated base API endpoint constants to specific values for clearer API requests.
  • Tests
    • Improved accuracy in URL interception and API request construction in Cypress tests.
  • Chores
    • Standardized the use of template literals for string interpolation in test support files.

@julian-christl julian-christl self-assigned this Mar 8, 2024
@julian-christl julian-christl requested a review from a team as a code owner March 8, 2024 15:08
@artemis-bot artemis-bot added this to In progress in Artemis Development Mar 8, 2024
@github-actions github-actions bot added tests cypress Pull requests that update cypress tests. (Added Automatically!) labels Mar 8, 2024
Copy link

coderabbitai bot commented Mar 8, 2024

Walkthrough

The changes across various Cypress test files primarily focus on improving code readability and maintainability. This is achieved by updating URL constructions and API endpoint references using template literals for better string interpolation, and by refining the constants used for base API paths. These modifications ensure more robust and readable code, making it easier to manage and understand the API requests and intercepts within the Cypress testing framework.

Changes

Files Change Summary
src/test/cypress/e2e/course/CourseCommunication.cy.ts Updated import statement for constants; BASE_API replaced with COURSE_BASE in GET import.
src/test/cypress/support/commands.ts Updated URL construction in the login command to use template literals for better readability and maintainability.
src/test/cypress/support/constants.ts, src/test/cypress/support/pageobjects/... Updated API base paths and endpoint URLs to use template literals for improved string interpolation. Refined constants for base URLs.
src/test/cypress/support/pageobjects/course/... Updated API endpoint references and URL constructions in course-related classes to use refined constants and template literals.
src/test/cypress/support/pageobjects/exam/... Updated base API endpoint references for exam-related operations to use COURSE_BASE and template literals for URL constructions.
src/test/cypress/support/pageobjects/exercises/..., src/test/cypress/support/pageobjects/lecture/... Updated base API references and URL constructions in exercise and lecture-related classes to use specific constants and template literals.
src/test/cypress/support/requests/... Updated URLs in various cy.request calls by using template literals for string interpolation and ensuring correct URL formation with proper use of slashes and constants.
src/test/cypress/support/users.ts Updated URL construction in the CypressUserManagement class methods to use template literals for improved URL formation.

Related issues

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@Strohgelaender Strohgelaender left a comment

Choose a reason for hiding this comment

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

lgtm, did not spot any issues or inconsistencies

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

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

Code looks good 👍

@krusche krusche added this to the 6.9.3 milestone Mar 15, 2024
@krusche krusche merged commit 7eb5ba2 into develop Mar 15, 2024
19 of 26 checks passed
@krusche krusche deleted the tests/fix-and-improve-cypress-urls branch March 15, 2024 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cypress Pull requests that update cypress tests. (Added Automatically!) ready to merge tests
Projects
Archived in project
Artemis Development
  
In progress
Development

Successfully merging this pull request may close these issues.

None yet

5 participants