databricks-cli/acceptance
Anton Nekipelov 4e3ff2409c
Enable bind/experiment acceptance test to run locally (#2510)
## Changes
<!-- Brief summary of your changes that is easy to understand -->
1. Enable local mode and write the server mocks

## Why
<!-- Why are these changes needed? Provide the context that the reviewer
might be missing.
For example, were there any decisions behind the change that are not
reflected in the code itself? -->
Acceptance tests that can run locally can indicate a breaking change
without waiting for a cloud run

## Tests
<!-- How have you tested the changes? -->
Ran the `bundle/deployment/bind/experiment` acceptance test locally

<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->
2025-03-18 08:43:11 +00:00
..
auth acc: replace LocalOnly option with Local & Cloud (#2387) 2025-02-26 16:01:49 +00:00
bin acc: Add test for stale wheel problem (#2477) 2025-03-14 12:24:18 +00:00
bundle Enable bind/experiment acceptance test to run locally (#2510) 2025-03-18 08:43:11 +00:00
cmd Fixed "can't evaluate field Name in type interface{}" for `databricks queries list` (#2451) 2025-03-10 08:05:15 +00:00
help build(deps): bump github.com/databricks/databricks-sdk-go from 0.59.0 to 0.60.0 (#2504) 2025-03-17 15:20:36 +00:00
internal acc: Create acceptance/internal package (#2495) 2025-03-17 19:19:22 +00:00
panic Recover from panic gracefully (#2353) 2025-02-27 13:27:36 +00:00
selftest acc: Add example on how to do trap (#2475) 2025-03-12 09:40:15 +00:00
telemetry Add synchronous logger for telemetry (#2432) 2025-03-12 13:05:10 +00:00
terraform Upgrade TF provider to 1.68.0 (#2426) 2025-03-05 10:20:55 +00:00
workspace/jobs build(deps): bump github.com/databricks/databricks-sdk-go from 0.59.0 to 0.60.0 (#2504) 2025-03-17 15:20:36 +00:00
.gitignore Use real terraform in acceptance tests (#2267) 2025-01-31 13:53:13 +00:00
README.md Add acceptance/selftest, showcasing basic features (#2229) 2025-01-27 09:17:22 +01:00
acceptance_test.go acc: Create acceptance/internal package (#2495) 2025-03-17 19:19:22 +00:00
install_terraform.py Use real terraform in acceptance tests (#2267) 2025-01-31 13:53:13 +00:00
script.cleanup Add acceptance tests (#2081) 2025-01-08 12:41:08 +00:00
script.prepare Add acceptance test for binding/unbinding schemas (#2441) 2025-03-07 16:41:25 +00:00
test.toml acc: replace LocalOnly option with Local & Cloud (#2387) 2025-02-26 16:01:49 +00:00

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.yml there.
  • Add script with commands to run, e.g. $CLI bundle validate. The test case is recognized by presence of script.

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:

  • errcode helper: if the command fails with non-zero code, it appends Exit code: N to the output but returns success to caller (bash), allowing continuation of script.
  • trace helper: 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.