docs: add readme for testing suite #2085
Conversation
reachaadrika
requested review from
quetzalliwrites,
derberg,
akshatnema,
magicmatatjahu,
Mayaleeeee and
asyncapi-bot-eve
as code owners
❌ Deploy Preview for asyncapi-website failed.Built without sensitive environment variables
|
|
cc : @akshatnema @derberg @alequetzalli 🚀 |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-2085--asyncapi-website.netlify.app/ |
akshatnema
added
the
gsoc
| -It utilises [Cypress/react] to provide some additional functionalites to Cypress . | ||
|
|
||
| ## Requirements | ||
| Use the following tools to set up the project: |
There was a problem hiding this comment.
Add the command to do npm install with correct npm version and run cypress with appropriate Node version.
There was a problem hiding this comment.
@reachaadrika This comment is not addressed.
cypress/README.md
Outdated
|
|
||
| This folder contains the test code of AsyncAPI website : | ||
|
|
||
| - It 's powered by [Cypress](https://docs.cypress.io/guides/overview/why-cypress) , |
There was a problem hiding this comment.
Add a short description about Cypress, Component testing and E2E testing.
cypress/README.md
Outdated
| ├── test # Source for the entire testing suite | ||
| ├── utils # Necessary Reusable Code and components for writing tests. | ||
| file | ||
| ``` |
There was a problem hiding this comment.
Add a step on how to add tests inside the cypress folder.
| ```text | ||
| ├── downloads # Any necessary downloads for the tests | ||
| ├── fixtures # Stores all the mock data files used in various tests | ||
| ├── plugins # Used to create additional functionalities in Cypress(if required) |
There was a problem hiding this comment.
| ├── plugins # Used to create additional functionalities in Cypress(if required) | |
| ├── plugins # Used to create additional functionalities in Cypress(if required) |
| ├── downloads # Any necessary downloads for the tests | ||
| ├── fixtures # Stores all the mock data files used in various tests | ||
| ├── plugins # Used to create additional functionalities in Cypress(if required) | ||
| ├── support # Main skeleton for the Cypress tests , Custom commands can be added here |
There was a problem hiding this comment.
| ├── support # Main skeleton for the Cypress tests , Custom commands can be added here | |
| ├── support # Main skeleton for the Cypress tests. Custom commands can be added here |
cypress/README.md
Outdated
|
|
||
| This folder contains the test code of AsyncAPI website : | ||
|
|
||
| - It 's powered by [Cypress](https://docs.cypress.io/guides/overview/why-cypress) , |
There was a problem hiding this comment.
| - It 's powered by [Cypress](https://docs.cypress.io/guides/overview/why-cypress) , | |
| - It's powered by [Cypress](https://docs.cypress.io/guides/overview/why-cypress). |
cypress/README.md
Outdated
|
|
||
| - It 's powered by [Cypress](https://docs.cypress.io/guides/overview/why-cypress) , | ||
|
|
||
| -It utilises [Cypress/react] to provide some additional functionalites to Cypress . |
There was a problem hiding this comment.
| -It utilises [Cypress/react] to provide some additional functionalites to Cypress . | |
| - It utilises [Cypress/react] to provide additional functionalities to Cypress. |
cypress/README.md
Outdated
|
|
||
| ## Run tests locally | ||
|
|
||
| Assuming you have all the necessary website dependencies installed : |
There was a problem hiding this comment.
| Assuming you have all the necessary website dependencies installed : | |
| Assuming you have all the necessary website dependencies installed: |
derberg
changed the title
Co-authored-by: Animesh Kumar <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
Co-authored-by: Alejandra Quetzalli <[email protected]>
cypress/README.md
Outdated
|
|
||
| 1. Run it and check on the Cypress Graphical User Interface | ||
| ```bash | ||
| npm cypress open |
There was a problem hiding this comment.
As per the latest changes in master branch, it should be npm run cy:open.
cypress/README.md
Outdated
|
|
||
| 2. Add tests in the respective testing folder : | ||
| For eg : Include tests for "scripts" in the scripts folder . | ||
| For creating a new component , create a new folder with the same name as component is named in the code . |
There was a problem hiding this comment.
It's not necessary to create a new folder to add a test for a component. It can be a separate file. Important point here is to follow same directory inside test folder, as the same file inside the root of the project.
There was a problem hiding this comment.
will change this
There was a problem hiding this comment.
From what I am reading in this thread, it looks like @reachaadrika has yet to address this feedback from @akshatnema. This section still seems to have incorrect information suggesting one must open a new folder to add a test for a component.
… docs-tests-gsoc
…site into docs-tests-gsoc
|
@alequetzalli Ping Pong for the review 😅 |
|
This pull request has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation. There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-2085--asyncapi-website.netlify.app/ |
|
@AnimeshKumar923 @akshatnema I can't review this because the creator of the PR has not addressed all feedback; once they finish addressing all feedback, this PR can move to next stage. |
There was a problem hiding this comment.
@reachaadrika Are you still around? It looks like folks like your doc but they are waiting for you to address feedback.
|
@alequetzalli Do review the PR fully, so that I could make the changes at the once. |
Co-authored-by: Quetzalli <[email protected]>
|
This pull request has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation. There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
|
Still relevant ' |
|
/update |
|
closing this as we don't require this fix now |
Description
I have worked on creating the complete testing suite of Website using Cypress , it shall be helpful for both the contributors and maintainers to know how the tests are run and the folder structure so that if any new tests have to be added to the website or existing tests are to be changed it becomes easy for them to navigate and run the tests locally .
Related issue(s)
fixes #2084