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.

Sign up for GitHub

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

[chore] Docs/seed docs folder with some testing information #30172

Merged
merged 5 commits into from
Jan 10, 2024
Merged

[chore] Docs/seed docs folder with some testing information #30172

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
11a225e
add a docs folder similar to how upstream does so
hughesjj Dec 21, 2023
a1bb152
Merge branch 'open-telemetry:main' into docs/seed_docs_folder_with_so…
hughesjj Dec 21, 2023
38ea611
Update testing.md
hughesjj Dec 21, 2023
749d698
Update testing.md
hughesjj Dec 22, 2023
87f3f2d
Update docs/testing.md
hughesjj Jan 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

## Testing your components

- `scraperint` is a wrapper around testcontainers and the golang testing api for use with receivers only (at least, today). See docs in [`scraperinttest`](../internal/coreinternal/scraperinttest/README.md) for information on usage.
- Add the `integration` [build constraint](#constraining-build-targets) for longer-running, comprehensive tests. These will be run via github actions when submitting a PR.

## Constraining build targets

This project uses golang [build-constraints](https://pkg.go.dev/cmd/go#hdr-Build_constraints) to tag build targets. Guidance on using existing targets

- `e2e` should be used for end-to-end tests. These are currently manually configured to be run in `.github/workflows` on a per-component basis.
- `integration` should be used for integration tests (able to be run on local hardware but not require any credentials or environmental infrastructure). You can run this with `make integration-test` or `cd componentclass/yourcomponent && make mod-integration-test`
- Restrict builds for varying platforms or processor architectures with their relevant platform names. See [documentation](https://pkg.go.dev/cmd/go#hdr-Build_constraints) on `GOOS` and `GOOARCH` for how these are set.
- Add other build tags as needed, such as has been done for `tools` and `race`. Please document any needed commands here and ensure to get consensus with the otel collector working group before introducing build constraints.