Skip to content

Commit

Permalink
docs: Recommends ginkgo focus decorator for e2e tests (#137)
Browse files Browse the repository at this point in the history
Signed-off-by: Sam Berning <[email protected]>

Issue #, if available: N/A

*Description of changes:*

Adds documentation to recommend use of ginkgo's Focus decorator while
developing e2e tests

*Testing done:*

N/A

- [x] I've reviewed the guidance in CONTRIBUTING.md


#### License Acceptance

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.

Signed-off-by: Sam Berning <[email protected]>
  • Loading branch information
sam-berning authored Jan 5, 2023
1 parent 5989361 commit 70b8e55
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,8 @@ implement them in common-tests repo and then import them in [`./e2e/e2e_test.go`

Otherwise, it means that the scenarios are specific to finch CLI (e.g., version, VM lifecycle, etc.), and you should implement them under `./e2e/` (e.g., `./e2e/version.go`) and import them in `./e2e/e2e_test.go`.

To save time while developing e2e tests, use the [`Focus`](https://onsi.github.io/ginkgo/#focused-specs) decorator while running tests, but be sure to remove it before PR-ing your changes.

### Go File Naming

Keep file names to one word if possible (e.g., avoid stuttering with package name: prefer `thing/factory.go` over `thing/thing_factory.go`). If there have to be more than one words, use underscores as separators. Do not use hyphens or camelCase.
Expand Down

0 comments on commit 70b8e55

Please sign in to comment.