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 unit testing #17

Open
ptgott opened this issue Nov 1, 2024 · 2 comments
Open

Add unit testing #17

ptgott opened this issue Nov 1, 2024 · 2 comments

Comments

@ptgott
Copy link
Contributor

ptgott commented Nov 1, 2024

The legacy docs engine includes a unit test suite, which it runs using the following command:

loadr -- uvu uvu-tests

There hasn't been any development on loadr or uvu in a few years, so we should switch to an industry standard like Jest.

I propose we:

  • Copy the test suite from gravitational/docs
  • Convert the tests to use the Jest syntax
  • Get the tests to pass
  • Add a workflow to require the tests to pass on changes to docs-website
@ptgott
Copy link
Contributor Author

ptgott commented Nov 22, 2024

We can also consider adding the Storybook tests from gravitational/docs, adapt them to the new website, and run them with Jest as part of the test workflow.

@taraspos
Copy link
Contributor

@ptgott Amplify supports running cypress tests to run before deploying changes1. Might be good to add at least some sanity check to make sure application loads as expected.

Footnotes

  1. https://docs.aws.amazon.com/amplify/latest/userguide/running-tests.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants