From e300b0dffbf8fd26696c282f6897760aba053472 Mon Sep 17 00:00:00 2001 From: David Allen Date: Mon, 15 Jul 2024 11:28:56 -0600 Subject: [PATCH] Updated README.md adding a test section --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 54b511a..298aad4 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,17 @@ targets: # targets to call with --target flag The `server` section sets the properties for running the `configurator` tool as a service and is not required if you're only using the CLI. Also note that the `jwks-uri` parameter is only needs for protecting endpoints. If it is not set, then the API is entirely public. The `smd` section tells the `configurator` tool where to find SMD to pull state management data used by the internal client. The `templates` section is where the paths are mapped to each generator plugin by its name (see the [`Creating Generator Plugins`](#creating-generator-plugins) section for details). The `plugins` is a list of paths to load generator plugins. +## Running the Tests + +The `configurator` project includes a collection of tests focused on verifying plugin behavior and generating files. The tests do not currently test fetching information from SMD (or whatever remote source). The tests can be ran with either of the following commands: + +```bash +go test ./tests/generate_test.go --tags=all +# ...or alternatively with GNU make... +make tests +``` + + ## Known Issues - Adds a new `OAuthClient` with every token request