Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

Docs: update integration test instructions#62679

Merged
jtibshirani merged 3 commits into
mainfrom
jtibs/readme
May 15, 2024
Merged

Docs: update integration test instructions#62679
jtibshirani merged 3 commits into
mainfrom
jtibs/readme

Conversation

@jtibshirani

@jtibshirani jtibshirani commented May 14, 2024

Copy link
Copy Markdown
Contributor

This PR updates the README for GraphQL integration tests to encourage devs to
run them in CI instead of running locally. It also update the local
instructions to use the correct target.

Test plan

Tested these instructions manually

@cla-bot cla-bot Bot added the cla-signed label May 14, 2024
@github-actions github-actions Bot added team/product-platform team/search-platform Issues owned by the search platform team labels May 14, 2024
Comment thread dev/gqltest/README.md Outdated
```
Steps:
1. Request "CI Secrets Read Access" in Entitle
2. Run `sg bazel test //testing:backend_integration_test`

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm not 100% sure this works, as I wasn't able to do this successfully (which was maybe because I'm on Mac OS??)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we actually want sg test bazel-backend-integration, which is the setup that actually uses the entitle permissions. Otherwise, the required env vars won't be set.

I haven't tested this in a while though, so YMMV 🙂

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the correction!

Comment thread dev/gqltest/README.md
- Delete new users created during the test.
- Delete external services created during the test.
- Although, sometimes you would not want to delete an entity so you could login and inspect the failure state.
- Prefix your branch name with `backend-integration/` will run integration tests in CI on your pull request.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This didn't seem helpful, as we always run integration tests on pull requests 🤔

@jtibshirani jtibshirani requested review from a team and camdencheek May 14, 2024 22:21

@camdencheek camdencheek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

@jtibshirani jtibshirani merged commit 066cb1e into main May 15, 2024
@jtibshirani jtibshirani deleted the jtibs/readme branch May 15, 2024 02:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-signed team/product-platform team/search-platform Issues owned by the search platform team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants