databricks-cli/acceptance
shreyas-goenka 24ac8d8d59
Add acceptance tests for auth resolution (#2285)
## Changes

This PR adds acceptance tests for native Databricks auth methods: basic,
oauth, and pat.

In the future we could compare this with auth credentials used by
downstream tools like TF or the telemetry process to ensure consistent
auth credentials are picked up and used.

Note: 
We do not add acceptance tests for other auth methods like Azure because
they communicate with external endpoints. To test them locally, we would
need to set up a reverse proxy server, which is out of scope for this
change.

## Tests
N/A
2025-02-11 15:50:03 +00:00
..
auth Add acceptance tests for auth resolution (#2285) 2025-02-11 15:50:03 +00:00
bin Always print warnings and errors; clean up format (#2213) 2025-02-07 11:29:40 +00:00
bundle Append newline to "-o json" for validate/summary/run (#2326) 2025-02-10 14:00:49 +01:00
help Fix duplicate "apps" entry in help output (#2191) 2025-01-20 16:02:29 +00:00
selftest acc: Allow mixing custom stubs with default server impl (#2334) 2025-02-11 15:03:41 +00:00
terraform Upgrade to TF provider 1.65.1 (#2328) 2025-02-10 14:06:02 +00:00
workspace/jobs Serialize recorded requests with indentation in acceptance tests (#2329) 2025-02-10 19:03:27 +05:30
.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: Allow mixing custom stubs with default server impl (#2334) 2025-02-11 15:03:41 +00:00
cmd_server_test.go acc: Allow mixing custom stubs with default server impl (#2334) 2025-02-11 15:03:41 +00:00
config_test.go acc: Implement config merge (#2294) 2025-02-07 17:38:27 +01: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 acc: Disable git hooks (#2249) 2025-01-28 14:00:41 +00:00
server_test.go Add acceptance tests for auth resolution (#2285) 2025-02-11 15:50:03 +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.