mirror of https://github.com/databricks/cli.git
e2db0cd0e2
## Changes - Instead of constructing chains of mutators and then executing them, execute them directly. - Remove functionality related to chain-building: Seq, If, Defer, newPhase, logString. - Phases become functions that apply the changes directly rather than construct mutator chains that will be called later. - Add a helper ApplySeq to call multiple mutators, use it where Apply+Seq were used before. This is intended to be a refactoring without functional changes, but there are a few behaviour changes: - Since defer() is used to call unlock instead of bundle.Defer() unlocking will now happen even in case of panics. - In --debug, the phase names are are still logged once before start of the phase but each entry no longer has 'seq' or phase name in it. - The message "Deployment complete!" was printed even if terraform.Apply() mutator had an error. It no longer does that. ## Motivation The use of the chains was necessary when mutators were returning a list of other mutators instead of calling them directly. But that has since been removed, so now the chain machinery have no purpose anymore. Use of direct functions simplifies the logic and makes bugs more apparent and easy to fix. Other improvements that this unlocks: - Simpler stacktraces/debugging (breakpoints). - Use of functions with narrowly scoped API: instead of mutators that receive full bundle config, we can use focused functions that only deal with sections they care about prepareGitSettings(currentGitSection) -> updatedGitSection. This makes the data flow more apparent. - Parallel computations across mutators (within phase): launch goroutines fetching data from APIs at the beggining, process them once they are ready. ## Tests Existing tests. |
||
|---|---|---|
| .. | ||
| auth | ||
| bin | ||
| bundle | ||
| cmd/workspace/apps | ||
| help | ||
| 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.