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

SPIKE: Investigate replacing ginkgo with go test #2612

Open
kate-osborn opened this issue Sep 26, 2024 · 0 comments
Open

SPIKE: Investigate replacing ginkgo with go test #2612

kate-osborn opened this issue Sep 26, 2024 · 0 comments
Labels
refined Requirements are refined and the issue is ready to be implemented. spike Issue to investigate a problem or solution, but not implement. tech-debt Short-term pain, long-term benefit tests Pull requests that update tests
Milestone

Comments

@kate-osborn
Copy link
Contributor

We write our unit tests using both ginkgo and go test, and we run all the unit tests using the ginkgo binary. We believe that using ginkgo to run both types of tests makes test failures challenging to see and debug. See #2584 for more details.

We reached out to ginkgo, and they recommended that we switch to using ginkgo or go test for all our tests. Ginkgo does not support running both types, especially when run in parallel.

Most of our tests are written with go test, but some of our most important and complex tests are written with ginkgo. See change processor tests for an example. Ginkgo was initially developed 10 years ago because go test lacked a rich feature set. Since then, many features have been added to go test that may make ginkgo unnecessary.

This spike is to determine the following:

  • Which ginkgo features is NGF leveraging today?
  • Are these features available in go test? Or can we import an additional testing library that can provide these features?
  • How big of an effort would it be to rewrite our ginkgo tests as go tests?

Note: this spike only applies to our unit tests.

@kate-osborn kate-osborn added tests Pull requests that update tests tech-debt Short-term pain, long-term benefit spike Issue to investigate a problem or solution, but not implement. labels Sep 26, 2024
@mpstefan mpstefan added this to the v2.0.0 milestone Oct 8, 2024
@mpstefan mpstefan added the refined Requirements are refined and the issue is ready to be implemented. label Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refined Requirements are refined and the issue is ready to be implemented. spike Issue to investigate a problem or solution, but not implement. tech-debt Short-term pain, long-term benefit tests Pull requests that update tests
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants