search

omsf-eco-infra / gha-runner

A simple GitHub Action for creating cloud-based self-hosted runners.
MIT License
0 stars 3 forks source link

User stories as gherkin feature files #1

Open dwhswenson opened 6 months ago

dwhswenson commented 6 months ago

This will document our user stories as Gherkin-formatted tests. Gherkin is easily human-readable and focuses on functionality, not implementation. Therefore, it makes a good format for specifying requirements. The tests can also be translated to code using tools like pytest-bdd, making our requirements document directly testable.

Another advantage of Gherkin tests is that they are also relatively straightforward to perform manually. I suspect that we will start by doing the manual tests, and get to automating them much later.

ethanholz commented 6 months ago

I have added three new scenarios around ML/AI workloads and ROCm. Please take a look whenever you get the chance!

dwhswenson commented 6 months ago

I commented out the ROCM scenario, since it isn't in the MVP. The main goal here is to capture the MVP as features/scenarios. I'm happy to put future plans in comments, but this makes it more clear that it will not be tested now.

Others looked good, though! Thanks!

ethanholz commented 4 months ago

I think we are good to start moving forward on getting this merged. A couple things that could be nice to see:

  1. Rebase/merge this with the current main and determine where the tests should live so they work best with pytest-bdd
  2. Add pytest-bdd to our pyproject.toml file to ensure that we include this in the testing toolchain