databricks-cli/acceptance
Denis Bilenko 211ec62a70
acc: add Ignore setting to config (#2405)
Ignore output files using gitignore syntax.

## Changes
New Ignore setting in test.toml that will ignore specified files (syntax
is gitignore).

## Why

I'm using it in #2396 to ignore virtual env. It includes a lot of files.
The regular 'rm -fr .venv' approach only works if script get to that
point, but due to errors it might abort early. In that cases test runner
prints all unexpected files, polluting output. Ignoring those files at
test runner level ensure you never see them.

## Tests
Updated selftest/basic.
2025-02-28 14:23:50 +00:00
..
auth acc: replace LocalOnly option with Local & Cloud (#2387) 2025-02-26 16:01:49 +00:00
bin acc: Support multiline patterns in diff.py (#2384) 2025-02-26 14:25:39 +01:00
bundle Raise an error when there are multiple local libraries with the same basename used (#2382) 2025-02-27 16:32:50 +00:00
cmd/workspace/apps acc: replace LocalOnly option with Local & Cloud (#2387) 2025-02-26 16:01:49 +00:00
help Fix duplicate "apps" entry in help output (#2191) 2025-01-20 16:02:29 +00:00
panic Recover from panic gracefully (#2353) 2025-02-27 13:27:36 +00:00
selftest acc: add Ignore setting to config (#2405) 2025-02-28 14:23:50 +00:00
terraform acc: replace LocalOnly option with Local & Cloud (#2387) 2025-02-26 16:01:49 +00:00
workspace/jobs acc: replace LocalOnly option with Local & Cloud (#2387) 2025-02-26 16:01:49 +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: add Ignore setting to config (#2405) 2025-02-28 14:23:50 +00:00
cmd_server_test.go acc: Simplify writing handlers; support headers in responses (#2338) 2025-02-12 13:00:57 +00:00
config_test.go acc: add Ignore setting to config (#2405) 2025-02-28 14:23:50 +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 acc: Disable git hooks (#2249) 2025-01-28 14:00:41 +00:00
server_test.go Support serverless mode in default-python template (explicit prompt) (#2377) 2025-02-26 14:07:30 +01: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.