From 994c2f15f0e074b01fa214c81b2e516d3ce33ce9 Mon Sep 17 00:00:00 2001 From: Asish Kumar Date: Mon, 30 Jun 2025 15:16:07 +0530 Subject: [PATCH 1/3] feat: add docs for metadata in config file Signed-off-by: Asish Kumar --- .../version-3.0.0/running-keploy/cli-commands.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md index 836239acd..e419300e2 100755 --- a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md @@ -25,7 +25,7 @@ Here are some examples of how to use some common flags: | Mode | Flags Available | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `record` | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug` | +| `record` | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--metadata`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug` | | `test` | `--apiTimeout`, `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--mongoPassword`, `-n, --net, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `-t, --testsets`, `--debug`, `-g, --generateTestReport`, `--removeUnusedMocks`, `--coverage`, `--goCoverage`, `--ignoreOrdering`, `--skip-preview` | | `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` | | `normailze` | `-p, --path`, `--test-run`, `--tests` | @@ -72,6 +72,16 @@ keploy record [flags] keploy record -c "node src/app.js" -d 10 ``` +- `--metadata string` - Key-value pairs to be added as metadata in the config.yaml file. If a `name` key is provided, it will be used as the test set name. + + ```bash + keploy record -c "node src/app.js" --metadata "env=development,service=gin-mongo,version=1.0.0,team=backend" + ``` + + ```bash + keploy record -c "node src/app.js" --metadata "name=user-auth-tests,env=staging,service=auth-service" + ``` + - `- n, --network-name string` - Name of the docker network in which the user application is running. ```bash From 3ba581e0cfa26405ce445f88db3b280dc6ef6309 Mon Sep 17 00:00:00 2001 From: Asish Kumar Date: Tue, 1 Jul 2025 15:30:33 +0530 Subject: [PATCH 2/3] fix: merge conflict Signed-off-by: Asish Kumar --- versioned_docs/version-3.0.0/running-keploy/cli-commands.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md index e419300e2..9171907e5 100755 --- a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md @@ -75,11 +75,11 @@ keploy record [flags] - `--metadata string` - Key-value pairs to be added as metadata in the config.yaml file. If a `name` key is provided, it will be used as the test set name. ```bash - keploy record -c "node src/app.js" --metadata "env=development,service=gin-mongo,version=1.0.0,team=backend" + keploy record -c "node src/app.js" --metadata "name=mac,env=production,service=gin-mongo,version=2.0.0,team.members[0]=alice,team.members[1]=bob,team.members[2]=carol,labels[0]=canary,labels[1]=stable,config.timeout=30s,config.timeout=60s,complex=a\\,b\\,c\\,d,database.urls[0]=db1.internal,database.urls[1]=db2.internal,database.urls[2]=db3.internal,mode=fast,mode=slow" ``` ```bash - keploy record -c "node src/app.js" --metadata "name=user-auth-tests,env=staging,service=auth-service" + keploy record -c "node src/app.js" --metadata "name=mac,env=production,service=gin-mongo,version=2.0.0,team.members[0]=alice,team.members[1]=bob,team.members[2]=carol,labels[0]=canary,labels[1]=stable,config.timeout=30s,config.timeout=60s,complex=a\\,b\\,c\\,d,database.urls[0]=db1.internal,database.urls[1]=db2.internal,database.urls[2]=db3.internal,mode=fast,mode=slow" ``` - `- n, --network-name string` - Name of the docker network in which the user application is running. From 36850f7db284ddbbd5f5cd91c6691f0fb7b2b6a6 Mon Sep 17 00:00:00 2001 From: Asish Kumar Date: Tue, 1 Jul 2025 16:09:30 +0530 Subject: [PATCH 3/3] fix: add a note for same key Signed-off-by: Asish Kumar --- versioned_docs/version-3.0.0/running-keploy/cli-commands.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md index 9171907e5..ad8e4a76d 100755 --- a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md @@ -82,6 +82,8 @@ keploy record [flags] keploy record -c "node src/app.js" --metadata "name=mac,env=production,service=gin-mongo,version=2.0.0,team.members[0]=alice,team.members[1]=bob,team.members[2]=carol,labels[0]=canary,labels[1]=stable,config.timeout=30s,config.timeout=60s,complex=a\\,b\\,c\\,d,database.urls[0]=db1.internal,database.urls[1]=db2.internal,database.urls[2]=db3.internal,mode=fast,mode=slow" ``` + > **Note:** If the same key is used multiple times, the last occurrence will be used. + - `- n, --network-name string` - Name of the docker network in which the user application is running. ```bash