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

Add Cypress e2e to test and automatically generate the README's example GIF #24

Open
6 tasks
emibcn opened this issue Oct 10, 2020 · 0 comments
Open
6 tasks
Labels
ci/cd Issues related to continuous integration and deployment (or DevOps) devops CI/CD synonym enhancement New feature or request Hacktoberfest Simple issues suitable Hacktoberfest PRs help wanted Extra attention is needed javascript Javascript knowledge needed tests Issues related to adding or fixing tests

Comments

@emibcn
Copy link
Owner

emibcn commented Oct 10, 2020

As this is going to a fast paced project (sic), manually generating the GIF and the end-to-end testing will eventually be an stopper.

Proposal

  • Use Cypress with free tier: only 1 worker in the GitHub Workflow, no Cypress SaaS needed.
  • Add a dedicated directory to store all Cypress test files.
  • Do unit tests (some hard to test components from non e2e tests) and/or component compositions. Save as disposable artifacts.
  • Do example/tutorial/README integration test. Save as GIF into the badges branch.
  • Allow developers to execute e2e in development environment (as a package.json script?).

Note: This issue can be handled by more than one person and split into sub-issues:

  • Create Cypress environment: system and NPM dependencies (docker&docker-compose?), generate cypress config/ini files
  • Create the unit/composite tests
  • Create the tutorial test
  • Convert the tutorial test to GIF
  • Add tests and GIF creation to GitHub Workflow
  • Ease development environment execution

If you want to do just a sub-issue, create it by yourself and link it here.

@emibcn emibcn added enhancement New feature or request Hacktoberfest Simple issues suitable Hacktoberfest PRs javascript Javascript knowledge needed tests Issues related to adding or fixing tests labels Oct 10, 2020
@emibcn emibcn changed the title Add worflow job/step to automatically generate the README's example GIF Add Cypress e2e to test and automatically generate the README's example GIF Oct 10, 2020
@emibcn emibcn added ci/cd Issues related to continuous integration and deployment (or DevOps) help wanted Extra attention is needed devops CI/CD synonym labels Oct 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd Issues related to continuous integration and deployment (or DevOps) devops CI/CD synonym enhancement New feature or request Hacktoberfest Simple issues suitable Hacktoberfest PRs help wanted Extra attention is needed javascript Javascript knowledge needed tests Issues related to adding or fixing tests
Projects
None yet
Development

No branches or pull requests

1 participant