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

Extend test guidelines with implementation notes for unit/regression tests #186

Merged
merged 13 commits into from
May 23, 2024

Conversation

martinmo
Copy link
Member

@martinmo martinmo commented Apr 29, 2024

I extended the test guidelines with information on how to write unit/regression tests. Furthermore, I added hints/links to other important information for tests authors, most importantly: the existing RFC keywords guide and the assumption about privileges.

Resolves: #185

Signed-off-by: Martin Morgenstern <[email protected]>
@martinmo martinmo added documentation Improvements or additions to documentation SCS is continuously built and tested SCS is continuously built and tested in order to raise velocity and quality SCS is standardized SCS is standardized SCS-VP10 Related to tender lot SCS-VP10 labels Apr 29, 2024
@martinmo martinmo self-assigned this Apr 29, 2024
Signed-off-by: Martin Morgenstern <[email protected]>
Signed-off-by: Martin Morgenstern <[email protected]>
* renamed file
* conventions for naming
* best practices for testable conformance tests
* added examples

Signed-off-by: Martin Morgenstern <[email protected]>
Signed-off-by: Martin Morgenstern <[email protected]>
@martinmo martinmo marked this pull request as ready for review April 30, 2024 10:46
@martinmo martinmo requested a review from mbuechse April 30, 2024 10:46
Copy link
Contributor

@mbuechse mbuechse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from a few little nit picks, I really like this. I'm only wondering why we now have two documents, and how developers will know what document to read for which purpose. I have the feeling that they need to read both documents anyway in order to do meaningful work. Can they be merged in a reasonable way?

@martinmo
Copy link
Member Author

martinmo commented May 6, 2024

I'm only wondering why we now have two documents, and how developers will know what document to read for which purpose. I have the feeling that they need to read both documents anyway in order to do meaningful work. Can they be merged in a reasonable way?

The other document specializes on the RFC keywords and without a complete restructuring I didn't see how I could fit my topics in there. For this reason, I decided to create a separate document. The new document can be seen as the more general entrypoint which a newcomer should read first.

I agree with you that this isn't obvious at the moment. One more thing which isn't obvious: the testing related contributor documents are currently placed below the "operations" hierarchy:

contributor-docs/
├── index.md
└── operations/
    ├── iam/
    │   ├── identity-federation-in-scs.md
    │   └── openstack-federation-via-oidc.md
    ├── operations/
    │   └── zuul-ci-cd-quickstart-user-guide.md
    └── tests/
        ├── rfc2119-keyword-test-guide.md
        └── test-implementation-guide.md

My suggestion: create a new "development" hierarchy and move "tests" there. Furthermore, solve the "which document to read first?" question by putting an index.md with an appropriate overview in there. So it will look like this:

contributor-docs/
├── development/
│   ├── index.md
│   └── tests/
│       ├── rfc2119-keyword-test-guide.md
│       └── test-implementation-guide.md
├── index.md
└── operations/
    ├── iam/
    │   ├── identity-federation-in-scs.md
    │   └── openstack-federation-via-oidc.md
    └── operations/
        └── zuul-ci-cd-quickstart-user-guide.md

@mbuechse what do you think about this proposal?

@martinmo
Copy link
Member Author

We (@cah-patrickthiem, @mbuechse and me) just had a discussion about the above proposal and it was agreed to proceed with it.

@martinmo martinmo marked this pull request as draft May 13, 2024 16:47
@martinmo martinmo force-pushed the feat/185-extend-test-guidelines branch from 9e77452 to 15c8763 Compare May 17, 2024 11:22
@martinmo martinmo marked this pull request as ready for review May 17, 2024 11:53
@martinmo martinmo requested a review from mbuechse May 17, 2024 11:53
@martinmo martinmo merged commit ce7d4c6 into main May 23, 2024
4 checks passed
@martinmo martinmo deleted the feat/185-extend-test-guidelines branch May 23, 2024 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation SCS is continuously built and tested SCS is continuously built and tested in order to raise velocity and quality SCS is standardized SCS is standardized SCS-VP10 Related to tender lot SCS-VP10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend general guidelines of conformance tests wrt to regression/unit tests
2 participants