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

Document the testbed/probe architecture #2137

Closed
freakboy3742 opened this issue Sep 26, 2023 · 3 comments
Closed

Document the testbed/probe architecture #2137

freakboy3742 opened this issue Sep 26, 2023 · 3 comments
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features.

Comments

@freakboy3742
Copy link
Member

What is the problem or limitation you are having?

We now have a test suite that is nearing 100% code coverage of the platform backends. However, the architecture of this testbed isn't obvious until you know what is going on. This is an impediment to contributors adding new features.

Describe the solution you'd like

We should add an architectural explainer about the test backend. This would be a background document, similar to the one explaining the "three layers" architecture.

Describe alternatives you've considered

No real alternative here, other than hoping contributors work out what is going on by osmosis.

Additional context

I recently wrote up a 10c version of this in response to someone asking how to test a new feature, and the very next ticket I responded to needed a link to that description. If that isn't a cry for documentation, I don't know what is.

@freakboy3742 freakboy3742 added enhancement New features, or improvements to existing features. documentation An improvement required in the project's documentation. labels Sep 26, 2023
@freakboy3742
Copy link
Member Author

This probably doesn't need to be a completely separate document - it could be another section on the existing architecture guide. This should probably also cover what the core tests cover in comparison to what the testbed tests cover.

@mhsmith
Copy link
Member

mhsmith commented Sep 27, 2023

@freakboy3742
Copy link
Member Author

🤦

Thanks past Russell, you've saved me some work :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features.
Projects
None yet
Development

No branches or pull requests

2 participants