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

docs(engx): clean up dev docs, add convenience commands [ggj] #820

Merged
merged 1 commit into from
Aug 6, 2021
Merged
Changes from all commits
Commits
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
25 changes: 14 additions & 11 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,6 @@
bazel run //src/test/java/com/google/api/generator/engine:JavaCodeGeneratorTest
```

- Update goldens files based on code generation in unit test, for example
`JavaCodeGeneratorTest.java`

```sh
bazel run //src/test/java/com/google/api/generator/engine:JavaCodeGeneratorTest_update
```

- Run a single integration test for API like `Redis`, it generates Java source
code using the Java microgenerator and compares them with the goldens files
in `test/integration/goldens/redis`.
Expand All @@ -112,10 +105,20 @@
bazel test //test/integration:redis
```

- Update goldens files based on code generation in integration test, for
example `Redis`. It generates Java source code using the Java microgenerator
and overwrites the goldens files in `test/integration/goldens/redis` based
on code generation.
- Run all unit and integration tests.

```sh
bazel test $(bazel query "src/test/..." | grep "Test$") //test/integration/...
```

- Update unit test golden files, for example `JavaCodeGeneratorTest.java`:

```sh
bazel run //src/test/java/com/google/api/generator/engine:JavaCodeGeneratorTest_update
```

- Update integration test golden files, for example `Redis`. This clobbers all the
files in `test/integration/goldens/redis`.

```sh
bazel run //test/integration:redis_update
Expand Down