Skip to content

chore: consistent use of bazelisk over bazel #1281

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

Merged
burkedavison merged 6 commits into from
Mar 9, 2023
Merged

chore: consistent use of bazelisk over bazel #1281

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0cfc513
chore: consistent use of bazelisk over bazel
burkedavison Jan 26, 2023
8c029d2
chore: DEVELOPMENT.md already has bazelisk
suztomo Feb 15, 2023
eb67dc3
Merge remote-tracking branch 'origin/main' into consistent-bazelisk
suztomo Feb 15, 2023
43555ca
Merge branch 'main' into consistent-bazelisk
suztomo Feb 15, 2023
466a00b
Merge branch 'main' into consistent-bazelisk
suztomo Mar 8, 2023
fccdb10
Merge branch 'main' into consistent-bazelisk
burkedavison Mar 9, 2023
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
22 changes: 14 additions & 8 deletions test/integration/goldens/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
# Goldens Files For Integration Test

This folder contains goldens files that are expected to be generated from Java Microgenerator
against different APIs. For example `redis` folder has all the Java source files in the generated
against different APIs. For example `redis` folder has all the Java source files in the generated
Redis client library. They are all actual Java files, but used as goldens.

## Purpose

When running integration test for the Java Microgenerator using the below command,
the goldens files in this folder will be used to compare with the actual generated Java source files.
When running integration test for the Java Microgenerator using the below command,
the goldens files in this folder will be used to compare with the actual generated Java source
files.
If they are not identical, then the integration test will fail.

```sh
bazel test //test/integration:redis
bazelisk test //test/integration:redis
```

## How To Update Goldens

If the actual generated Java source files are not identical with the goldens files, and we want to
update the goldens using source files. Run the command below to overwrite the goldens files in `redis` folder.
update the goldens using source files. Run the command below to overwrite the goldens files
in `redis` folder.

```sh
bazel run //test/integration:update_redis
bazelisk run //test/integration:update_redis
```

## Adding new integration tests

If you are adding a new API for integration testing, be sure to add it in the `BUILD.bazel` under the `Integration Test Rules` and add the `java_gapic_test` rules for the new API under the `API Library Rules` section.
If you are adding a new API for integration testing, be sure to add it in the `BUILD.bazel` under
the `Integration Test Rules` and add the `java_gapic_test` rules for the new API under
the `API Library Rules` section.

You need to manually create a new directory for your new API under the `test/integration/goldens` with the same name you've used for the `Integration Test Rules`. Then when you run the command to update goldens (above), it will automatically create the goldens needed.
You need to manually create a new directory for your new API under the `test/integration/goldens`
with the same name you've used for the `Integration Test Rules`. Then when you run the command to
update goldens (above), it will automatically create the goldens needed.