feat(storybook): cypress setup for the project #282

sanketshevkar · 2021-03-05T11:05:22Z

Signed-off-by: User shevkar.sanket@gmail.com

Changes

Added cypress as a devDependency and wrote a dummy test within the cypress/intergrations folder.
You need to install cypress on your local machine so as to run tests. Instructions for installing cypress on local machine: https://docs.cypress.io/guides/getting-started/installing-cypress.html#System-requirements
To run the test you need two terminal windows, on the first one you need to run npm run storybook and once the storybook loads, on the second terminal within packages/storybook run npm run cypress:open. Cypress app would start and select the markdownEditor.spec.js file and then the test should start.

Flags

You might have to run lerna clean && lerna bootstrap && lerna run build as a new devDependency is added.

Screenshots or Video

https://www.loom.com/share/72e05a6e0c014ba6940fb36b757580a8

Related Issues

Issue User Interaction Testing #14

Author Checklist

Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
Vital features and changes captured in unit and/or integration tests
Commits messages follow AP format
Extend the documentation, if necessary
Merging to master from fork:branchname
Manual accessibility test performed
- Keyboard-only access, including forms
- Contrast at least WCAG Level A
- Appropriate labels, alt text, and instructions

Signed-off-by: User <shevkar.sanket@gmail.com>

sanketshevkar · 2021-03-09T17:26:11Z

@irmerk any updates on this?

irmerk · 2021-03-10T20:50:33Z

@mttrbrts and I are looking into this from #279

packages/storybook/package.json

sanketshevkar · 2021-03-11T06:34:59Z

@mttrbrts and I are looking into this from #279

Okay cool. Should I close this pr?

Signed-off-by: Matt Roberts <code@rbrts.uk>

mttrbrts · 2021-03-12T13:13:44Z

@mttrbrts and I are looking into this from #279

Okay cool. Should I close this pr?

No, I've added another commit which completes the basic setup. @rkotangoor @irmerk can you review, please?

mttrbrts · 2021-03-12T13:17:13Z

In theory, Cypress should now report the test results as comments in PRs, and the history will be publicly available at https://dashboard.cypress.io/projects/vrh5u7

Cronus1007 · 2021-03-12T13:20:41Z

@mttrbrts I have a question that the tests should be controlled via the main directory rather than the storybook package. Whats your opinion regarding this?

mttrbrts · 2021-03-12T13:24:01Z

@mttrbrts I have a question that the tests should be controlled via the main directory rather than the storybook package. Whats your opinion regarding this?

That's a good question. For these E2E tests, we want to test the components in context (i.e. in an app), and so storybook is a convenient tool for that. I agree that we should be able to run the tests from a package.json script at the root-level too (I'll add it to this PR).

Unit tests for example are better suited to being situated local to the module / package that they are testing.

Cronus1007 · 2021-03-12T13:26:26Z

@mttrbrts For unit tests you can have a look at this comment #14 (comment)

cypress · 2021-03-12T13:31:14Z

Test summary

1 • 0 • 0 • 0

Run details


Project	web-components
Status	Passed
Commit	`095f9f7`
Started	Mar 12, 2021 1:30 PM
Ended	Mar 12, 2021 1:31 PM
Duration	00:24 💡
OS	Mac 20.3.0
Browser	Electron 87

View run in Cypress Dashboard ➡️

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

rkotangoor · 2021-03-12T13:45:51Z

@sanketshevkar : could you add instructions to storybook Readme on how to run the cypress tests? Pretty much what you have included in this PR description?

sanketshevkar · 2021-03-12T14:01:58Z

@sanketshevkar : could you add instructions to storybook Readme on how to run the cypress tests? Pretty much what you have included in this PR description?

Sure would do that 👍.

Signed-off-by: User <shevkar.sanket@gmail.com>

sanketshevkar · 2021-03-12T18:06:30Z

@mttrbrts @rkotangoor I've updated the readme file.

DianaLease · 2021-03-13T18:04:14Z

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

This is awesome. @mttrbrts what kicks off the test run? Whenever a new PR is opened?

mttrbrts · 2021-03-13T19:11:59Z

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

This is awesome. @mttrbrts what kicks off the test run? Whenever a new PR is opened?

Thanks, yes, here's the config from cypress.io

Cronus1007 · 2021-03-15T16:52:14Z

@mttrbrts Shall we update this to Travis CI/CD pipeline plus codecov report to the repository whenever a new PR is opened.

irmerk

Needs investigation by @accordproject/maintainers-ui or @mttrbrts.

mttrbrts · 2021-03-16T13:21:41Z

@mttrbrts Shall we update this to Travis CI/CD pipeline plus codecov report to the repository whenever a new PR is opened.

This is a separate issue. Let's focus on getting this change in first.

mttrbrts

@sanketshevkar can you fix package-lock.json, please? Otherwise, we're ready to merge this.

sanketshevkar · 2021-03-16T15:22:40Z

@sanketshevkar can you fix package-lock.json, please? Otherwise, we're ready to merge this.

I'm not able to find where the merge conflict is exactly located. Can someone help me out?

Cronus1007 · 2021-03-16T15:41:21Z

@sanketshevkar First of all update your branch. This will remove the merge-conflicts .

Signed-off-by: User <shevkar.sanket@gmail.com>

Signed-off-by: Matt Roberts <code@rbrts.uk>

Signed-off-by: User <shevkar.sanket@gmail.com>

…ub.com/sanketshevkar/web-components into sanketshevkar/14/cypress-project-setup Signed-off-by: Matt Roberts <code@rbrts.uk>

Signed-off-by: User <shevkar.sanket@gmail.com>

Signed-off-by: Matt Roberts <code@rbrts.uk>

…ub.com/sanketshevkar/web-components into sanketshevkar/14/cypress-project-setup Signed-off-by: Matt Roberts <code@rbrts.uk>

sanketshevkar · 2021-03-16T16:30:01Z

@mttrbrts why is it expecting a dco of mine from some other id. I've made all my dco sign off's using shevkar.sanket@gmail.com.

mttrbrts · 2021-03-16T16:32:02Z

@mttrbrts why is it expecting a dco of mine from some other id. I've made all my dco sign off's using shevkar.sanket@gmail.com.

Apologies, I've been trying (and failing!) to fix this properly. I've now manually reviewed and approved the commits.

sanketshevkar · 2021-03-16T16:35:20Z

@mttrbrts I've updated my branch and created new package-lock.json file. Should I commit that?

sanketshevkar · 2021-03-16T16:37:09Z

@mttrbrts why is it expecting a dco of mine from some other id. I've made all my dco sign off's using shevkar.sanket@gmail.com.

Apologies, I've been trying (and failing!) to fix this properly. I've now manually reviewed and approved the commits.

No, problem. Thanks a lot for helping out.

irmerk · 2021-03-16T17:13:49Z

So, as of right now, we manually run this locally and it will produce a test result in Cypress? Next steps will be:

Set up automatic runs in the Travis (soon to be GitHub Actions) scripts to potentially run in each PR?
Continue to iterate on the Cypress test suite?

mttrbrts · 2021-03-17T08:15:46Z

So, as of right now, we manually run this locally and it will produce a test result in Cypress? Next steps will be:

Set up automatic runs in the Travis (soon to be GitHub Actions) scripts to potentially run in each PR?

Continue to iterate on the Cypress test suite?

Yes, that's right. Although the PR integration is already setup (without using Travis or GH Actions). See #282 (comment)

irmerk

👏🏻

feat(storybook): cypress setup for the project

1f751eb

Signed-off-by: User <shevkar.sanket@gmail.com>

Cronus1007 mentioned this pull request Mar 10, 2021

User Interaction Testing #14

Open

Cronus1007 reviewed Mar 10, 2021

View reviewed changes

packages/storybook/package.json Outdated Show resolved Hide resolved

mttrbrts self-requested a review March 12, 2021 10:56

feat(e2e): Add basic cypress config and cypress.io integration

095f9f7

Signed-off-by: Matt Roberts <code@rbrts.uk>

mttrbrts requested review from DianaLease and irmerk and removed request for mttrbrts March 12, 2021 13:15

mttrbrts assigned sanketshevkar Mar 12, 2021

docs(ui-markdown-editor): readme updated with cypress test

2c39db6

Signed-off-by: User <shevkar.sanket@gmail.com>

irmerk requested a review from mttrbrts March 16, 2021 12:45

irmerk added the Type: Need Investigation 🔬 label Mar 16, 2021

irmerk suggested changes Mar 16, 2021

View reviewed changes

mttrbrts removed the Type: Need Investigation 🔬 label Mar 16, 2021

mttrbrts added the Type: Chore 🧼 label Mar 16, 2021

mttrbrts requested changes Mar 16, 2021

View reviewed changes

sanketshevkar and others added 7 commits March 16, 2021 15:50

feat(storybook): cypress setup for the project

abe5b87

Signed-off-by: User <shevkar.sanket@gmail.com>

feat(e2e): Add basic cypress config and cypress.io integration

53d677b

Signed-off-by: Matt Roberts <code@rbrts.uk>

docs(ui-markdown-editor): readme updated with cypress test

a5aee66

Signed-off-by: User <shevkar.sanket@gmail.com>

Merge branch 'sanketshevkar/14/cypress-project-setup' of https://gith…

70d2696

…ub.com/sanketshevkar/web-components into sanketshevkar/14/cypress-project-setup Signed-off-by: Matt Roberts <code@rbrts.uk>

feat(storybook): cypress setup for the project

2196858

Signed-off-by: User <shevkar.sanket@gmail.com>

feat(e2e): Add basic cypress config and cypress.io integration

29fd976

Signed-off-by: Matt Roberts <code@rbrts.uk>

Merge branch 'sanketshevkar/14/cypress-project-setup' of https://gith…

2d03a3f

…ub.com/sanketshevkar/web-components into sanketshevkar/14/cypress-project-setup Signed-off-by: Matt Roberts <code@rbrts.uk>

mttrbrts approved these changes Mar 16, 2021

View reviewed changes

irmerk approved these changes Mar 17, 2021

View reviewed changes

irmerk mentioned this pull request Mar 17, 2021

Cypress Testing Integration #279

Closed

irmerk merged commit 6a6dcc8 into accordproject:master Mar 17, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(storybook): cypress setup for the project #282

feat(storybook): cypress setup for the project #282

sanketshevkar commented Mar 5, 2021 •

edited

Loading

sanketshevkar commented Mar 9, 2021

irmerk commented Mar 10, 2021

sanketshevkar commented Mar 11, 2021

mttrbrts commented Mar 12, 2021

mttrbrts commented Mar 12, 2021 •

edited

Loading

Cronus1007 commented Mar 12, 2021 •

edited

Loading

mttrbrts commented Mar 12, 2021

Cronus1007 commented Mar 12, 2021 •

edited

Loading

cypress bot commented Mar 12, 2021

rkotangoor commented Mar 12, 2021

sanketshevkar commented Mar 12, 2021

sanketshevkar commented Mar 12, 2021

DianaLease commented Mar 13, 2021

mttrbrts commented Mar 13, 2021

Cronus1007 commented Mar 15, 2021

irmerk left a comment

mttrbrts commented Mar 16, 2021

mttrbrts left a comment

sanketshevkar commented Mar 16, 2021 •

edited

Loading

Cronus1007 commented Mar 16, 2021

sanketshevkar commented Mar 16, 2021

mttrbrts commented Mar 16, 2021

sanketshevkar commented Mar 16, 2021

sanketshevkar commented Mar 16, 2021

irmerk commented Mar 16, 2021

mttrbrts commented Mar 17, 2021

irmerk left a comment

feat(storybook): cypress setup for the project #282

feat(storybook): cypress setup for the project #282

Conversation

sanketshevkar commented Mar 5, 2021 • edited Loading

Changes

Flags

Screenshots or Video

Related Issues

Author Checklist

sanketshevkar commented Mar 9, 2021

irmerk commented Mar 10, 2021

sanketshevkar commented Mar 11, 2021

mttrbrts commented Mar 12, 2021

mttrbrts commented Mar 12, 2021 • edited Loading

Cronus1007 commented Mar 12, 2021 • edited Loading

mttrbrts commented Mar 12, 2021

Cronus1007 commented Mar 12, 2021 • edited Loading

cypress bot commented Mar 12, 2021

Test summary

Run details

rkotangoor commented Mar 12, 2021

sanketshevkar commented Mar 12, 2021

sanketshevkar commented Mar 12, 2021

DianaLease commented Mar 13, 2021

mttrbrts commented Mar 13, 2021

Cronus1007 commented Mar 15, 2021

irmerk left a comment

Choose a reason for hiding this comment

mttrbrts commented Mar 16, 2021

mttrbrts left a comment

Choose a reason for hiding this comment

sanketshevkar commented Mar 16, 2021 • edited Loading

Cronus1007 commented Mar 16, 2021

sanketshevkar commented Mar 16, 2021

mttrbrts commented Mar 16, 2021

sanketshevkar commented Mar 16, 2021

sanketshevkar commented Mar 16, 2021

irmerk commented Mar 16, 2021

mttrbrts commented Mar 17, 2021

irmerk left a comment

Choose a reason for hiding this comment

sanketshevkar commented Mar 5, 2021 •

edited

Loading

mttrbrts commented Mar 12, 2021 •

edited

Loading

Cronus1007 commented Mar 12, 2021 •

edited

Loading

Cronus1007 commented Mar 12, 2021 •

edited

Loading

sanketshevkar commented Mar 16, 2021 •

edited

Loading