diff options
| author | Paul Okstad <pokstad@gitlab.com> | 2020-11-20 23:33:37 +0300 |
|---|---|---|
| committer | Paul Okstad <pokstad@gitlab.com> | 2020-11-20 23:33:37 +0300 |
| commit | 42a9312e7506851663c585c8be1059f10a414516 (patch) | |
| tree | 413cd8a6b92b62d51bb192cd8d090ce09a88b4be | |
| parent | 5e10c3f8935996730e00269a307a5d6909ee301e (diff) | |
| parent | 7b6382e801a2459fbd62495bf3fdfe329d7c27e4 (diff) | |
Merge branch 'rs-doc-asdf' into 'master'
Document the ASDF_DATA_DIR workaround
See merge request gitlab-org/gitaly!2828
| -rw-r--r-- | doc/beginners_guide.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/beginners_guide.md b/doc/beginners_guide.md index 97e4cfaf0..dce8ab7f0 100644 --- a/doc/beginners_guide.md +++ b/doc/beginners_guide.md @@ -219,6 +219,28 @@ called on `testing.T`. [require]: https://github.com/stretchr/testify/tree/master/require [assert]: https://github.com/stretchr/testify/tree/master/assert +##### Troubleshooting + +There is a [known issue][] running Go tests while using the [asdf version +manager][asdf]. + +In order to avoid polluting local configurations during testing, a test may +redefine the location of `$HOME`, which interferes with asdf's `$ASDF_DATA_DIR` +definition of `$HOME/.asdf`. You may see errors like this: + +``` +unknown command: bundle. Perhaps you have to reshim? +``` + +As a workaround, explicitly define the variable prior to executing tests: + +```sh +$ ASDF_DATA_DIR=~/.asdf go test ... +``` + +[known issue]: https://gitlab.com/gitlab-org/gitaly/-/issues/2646 +[asdf]: https://asdf-vm.com/ + #### RSpec tests It is possible to write end-to-end RSpec tests that run against a full |