databricks-cli/acceptance
Denis Bilenko 11436faafe
acc: Avoid reading and applying replacements on large files; validate utf8 (#2244)
## Changes
- Do not start replacement / comparison if file is too large or not
valid utf-8.
- This helps to prevent replacements if there is accidentally a large
binary (e.g. terraform).

## Tests
Found this problem when working on
https://github.com/databricks/cli/pull/2242 -- the tests tried to
applied replacements on terraform binary and crashed. With this change,
an error is reported instead.
2025-01-28 10:22:29 +00:00
..
bin Add -inprocess mode for acceptance tests (#2184) 2025-01-21 21:21:12 +00:00
build Add acceptance tests (#2081) 2025-01-08 12:41:08 +00:00
bundle acc: Restore unexpected output error (#2243) 2025-01-28 10:15:32 +00:00
help Fix duplicate "apps" entry in help output (#2191) 2025-01-20 16:02:29 +00:00
selftest Add default regex for DEV_VERSION (#2241) 2025-01-27 15:34:53 +01:00
README.md Add acceptance/selftest, showcasing basic features (#2229) 2025-01-27 09:17:22 +01:00
acceptance_test.go acc: Avoid reading and applying replacements on large files; validate utf8 (#2244) 2025-01-28 10:22:29 +00:00
cmd_server_test.go Add -inprocess mode for acceptance tests (#2184) 2025-01-21 21:21:12 +00:00
config_test.go acc: Support custom replacements (#2231) 2025-01-27 09:11:06 +00:00
script.cleanup Add acceptance tests (#2081) 2025-01-08 12:41:08 +00:00
script.prepare Add an acc test covering failures when reading .git (#2223) 2025-01-24 15:53:06 +00:00
server_test.go Add acceptance test for 'experimental.scripts' (#2240) 2025-01-27 15:28:33 +00:00
test.toml acc: Support per-test configuration; GOOS option to disable OS (#2227) 2025-01-24 14:28:23 +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.