summaryrefslogtreecommitdiff
path: root/doc/development/agent
diff options
context:
space:
mode:
Diffstat (limited to 'doc/development/agent')
-rw-r--r--doc/development/agent/identity.md4
-rw-r--r--doc/development/agent/local.md44
2 files changed, 45 insertions, 3 deletions
diff --git a/doc/development/agent/identity.md b/doc/development/agent/identity.md
index 65de1a6f0c8..884ce015a02 100644
--- a/doc/development/agent/identity.md
+++ b/doc/development/agent/identity.md
@@ -37,9 +37,9 @@ has a different configuration. Some may enable features A and B, and some may
enable features B and C. This flexibility enables different groups of people to
use different features of the agent in the same cluster.
-For example, [Priyanka (Platform Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#priyanka-platform-engineer)
+For example, [Priyanka (Platform Engineer)](https://about.gitlab.com/handbook/marketing/strategic-marketing/roles-personas/#priyanka-platform-engineer)
may want to use cluster-wide features of the agent, while
-[Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer)
+[Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/strategic-marketing/roles-personas/#sasha-software-developer)
uses the agent that only has access to a particular namespace.
Each agent is likely running using a
diff --git a/doc/development/agent/local.md b/doc/development/agent/local.md
index 75d45366238..47246a6a6d3 100644
--- a/doc/development/agent/local.md
+++ b/doc/development/agent/local.md
@@ -38,7 +38,7 @@ You can run `kas` and `agentk` locally to test the [Kubernetes Agent](index.md)
gdk start
# Stop GDK's version of kas
gdk stop gitlab-k8s-agent
-
+
# Start kas
bazel run //cmd/kas -- --configuration-file="$(pwd)/cfg.yaml"
```
@@ -56,3 +56,45 @@ for more targets.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
To learn more about how the repository is structured, see
[GitLab Kubernetes Agent repository overview](https://www.youtube.com/watch?v=j8CyaCWroUY).
+
+## Run tests locally
+
+You can run all tests, or a subset of tests, locally.
+
+- **To run all tests**: Run the command `make test`.
+- **To run all test targets in the directory**: Run the command
+ `bazel test //internal/module/gitops/server:all`.
+
+ You can use `*` in the command, instead of `all`, but it must be quoted to
+ avoid shell expansion: `bazel test '//internal/module/gitops/server:*'`.
+- **To run all tests in a directory and its subdirectories**: Run the command
+ `bazel test //internal/module/gitops/server/...`.
+
+### Run specific test scenarios
+
+To run only a specific test scenario, you need the directory name and the target
+name of the test. For example, to run the tests at
+`internal/module/gitops/server/module_test.go`, the `BUILD.bazel` file that
+defines the test's target name lives at `internal/module/gitops/server/BUILD.bazel`.
+In the latter, the target name is defined like:
+
+```bazel
+go_test(
+ name = "server_test",
+ size = "small",
+ srcs = [
+ "module_test.go",
+```
+
+The target name is `server_test` and the directory is `internal/module/gitops/server/`.
+Run the test scenario with this command:
+
+```shell
+bazel test //internal/module/gitops/server:server_test
+```
+
+### Additional resources
+
+- Bazel documentation about [specifying targets to build](https://docs.bazel.build/versions/master/guide.html#specifying-targets-to-build).
+- [The Bazel query](https://docs.bazel.build/versions/master/query.html)
+- [Bazel query how to](https://docs.bazel.build/versions/master/query-how-to.html)