mirror of https://github.com/databricks/cli.git
b30184f8c1
## Changes
Add new option -tail to acceptance test runner. This logs output.txt in
real time with relative timestamp prefix.
## Why
When working on long running integration tests, it's useful to see what
stage they are at.
## Tests
Manually
```
~/work/cli/acceptance/selftest % testme -v -tail
+ go test .. -run ^TestAccept$/^selftest$ -v -tail
...
=== CONT TestAccept/selftest/diff
acceptance_test.go:774: 0.051 >>> diff.py out_dir_a out_dir_b
=== NAME TestAccept/selftest/basic
acceptance_test.go:774: 0.051 === Capturing STDERR
acceptance_test.go:774: 0.051 >>> python3 -c import sys; sys.stderr.write("STDERR\n")
=== NAME TestAccept/selftest/server
acceptance_test.go:774: 0.050 >>> curl -s http://127.0.0.1:55850/api/2.0/preview/scim/v2/Me
...
acceptance_test.go:774: 0.204 >>> /Users/denis.bilenko/work/cli/acceptance/build/darwin_arm64/databricks --version
=== NAME TestAccept/selftest/server
acceptance_test.go:774: 0.510 Error: Workspace path not found
...
```
|
||
|---|---|---|
| .. | ||
| auth | ||
| bin | ||
| bundle | ||
| cmd | ||
| help | ||
| panic | ||
| selftest | ||
| terraform | ||
| workspace/jobs | ||
| .gitignore | ||
| README.md | ||
| acceptance_test.go | ||
| cmd_server_test.go | ||
| config_test.go | ||
| install_terraform.py | ||
| script.cleanup | ||
| script.prepare | ||
| server_test.go | ||
| test.toml | ||
README.md
Acceptance tests are blackbox tests that are run against compiled binary.
Currently these tests are run against "fake" HTTP server pretending to be Databricks API. However, they will be extended to run against real environment as regular integration tests.
To author a test,
- Add a new directory under
acceptance. Any level of nesting is supported. - Add
databricks.ymlthere. - Add
scriptwith commands to run, e.g.$CLI bundle validate. The test case is recognized by presence ofscript.
The test runner will run script and capture output and compare it with output.txt file in the same directory.
In order to write output.txt for the first time or overwrite it with the current output pass -update flag to go test.
The scripts are run with bash -e so any errors will be propagated. They are captured in output.txt by appending Exit code: N line at the end.
For more complex tests one can also use:
errcodehelper: if the command fails with non-zero code, it appendsExit code: Nto the output but returns success to caller (bash), allowing continuation of script.tracehelper: prints the arguments before executing the command.- custom output files: redirect output to custom file (it must start with
out), e.g.$CLI bundle validate > out.txt 2> out.error.txt.
See selftest for a toy test.