chore: add readme for unit tests (#392)

apigee · Feb 6, 2024 · 350c5e9 · 350c5e9
1 parent 9120163
commit 350c5e9
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/test/README.md b/test/README.md
@@ -0,0 +1,25 @@
+# Unit Tests for apigeecli
+
+## Environment Variables
+
+Set the following environment variables:
+
+* `APIGEE_ORG`
+* `APIGEE_ENV`
+* `APIGEECLI_PATH` (path to the apigeecli folder)
+
+If the org was created with DRZ options, then also set:
+
+* `APIGEE_REGION`
+
+For tests involving Apigee API Portal, set:
+
+* `APIGEE_SITEID`
+
+For tests involving Apigee API Registry, set:
+
+* `APIGEE_REGION`
+
+## Running the tests
+
+Run `go test internal/client/<package>` or Run `go test internal/client/<package> -cover` to include code coverage