docs: add unit test tags flag #4947
Conversation
As we use tags for the unit test files, they don't run if one does not provide the tags=unit flag to the test execution command. This change adds the description of how one is to do this when running the tests in a shell, as well as how to add it to the VS Code extension.
| @@ -258,7 +258,7 @@ httpClient.SetOptions(clientOptions) | |||
| 1. [Global function pointers](#global-function-pointers) | |||
| 1. [Test Parallelization](#test-parallelization) | |||
|
|
|||
| Unit tests are done using basic `golang` means. | |||
| Unit tests are done using basic `golang` means. As the test files are tagged add the corresponding tag to the run command, as for example `go test -run ^TestRunAbapAddonAssemblyKitCheck$ github.com/SAP/jenkins-library/cmd -tags=unit`. In VSCode this can be done by adding the flag `"-tags=unit"` to the list of `"go.testFlags"` in the `settings.json` of the go extension. | |||
There was a problem hiding this comment.
Do we need the cap(^) and $?
| Unit tests are done using basic `golang` means. As the test files are tagged add the corresponding tag to the run command, as for example `go test -run ^TestRunAbapAddonAssemblyKitCheck$ github.com/SAP/jenkins-library/cmd -tags=unit`. In VSCode this can be done by adding the flag `"-tags=unit"` to the list of `"go.testFlags"` in the `settings.json` of the go extension. | |
| Unit tests are done using basic `golang` means. As the test files are tagged add the corresponding tag to the run command, as for example `go test -run TestRunAbapAddonAssemblyKitCheck github.com/SAP/jenkins-library/cmd -tags=unit`. In VSCode this can be done by adding the flag `"-tags=unit"` to the list of `"go.testFlags"` in the `settings.json` of the go extension. |
There was a problem hiding this comment.
It is to ensure that only this test and not a test that contains this string is executed (regex start ^ and end $). VS Code does this when you click on running a specific test with their UI. It can be left out of course, but personally I would use that. What do you think?
There was a problem hiding this comment.
maybe with some example, e.g.
"go.testTags": "-tags=unit",
"go.buildFlags": [
"-tags=unit"
],
"gopls": {
"build.buildFlags": [ "-tags=unit"]
},
|
/it |
|
|
Thank you for your contribution! This pull request is stale because it has been open 60 days with no activity. In order to keep it open, please remove stale label or add a comment within the next 10 days. If you need a Piper team member to remove the stale label make sure to add |
As we use tags for the unit test files, they don't run if one does not provide the tags=unit flag to the test execution command. This change adds the description of how one is to do this when running the tests in a shell, as well as how to add it to the VS Code extension.
Changes