Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
//@ts-check

import { themes as prismThemes } from "prism-react-renderer";
import {themes as prismThemes} from "prism-react-renderer";
const path = require("path");
import { visit } from "unist-util-visit";
import {visit} from "unist-util-visit";
const FontPreloadPlugin = require("webpack-font-preload-plugin");

/** @type {import('@docusaurus/types').DocusaurusConfig} */
Expand Down Expand Up @@ -51,7 +51,7 @@ module.exports = {
content:
"API testing, Keploy docs, incident replay, network calls, code paths, test scenarios, code coverage, stubs, junit, go-test, live environment, production incidents, open source, regression tests, ai tests",
},
{ name: "twitter:card", content: "summary_large_image" },
{name: "twitter:card", content: "summary_large_image"},
],
headTags: [
// Preconnect tag
Expand Down
35 changes: 0 additions & 35 deletions versioned_docs/version-3.0.0/running-keploy/cli-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `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`, `--proto-dir`, `--proto-file`, `--proto-include` |
| `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` |
| `normalize` | `-p, --path`, `--test-run`, `--tests` |
| `rerecord` | `--test-sets`, `-t` |
| `report` | `--test-sets, -t`, `-p, --path`, `--report-path, -r`, `--body` |
Expand All @@ -58,7 +57,7 @@

In the command above, `node src/app.js` is the command which starts the user application.

- `--config-path string` - Path to the Keploy configuration file. The default is ".".

Check failure on line 60 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L60

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 60, "column": 82}}}, "severity": "ERROR"}

```bash
keploy record -c "node src/app.js" --config-path "./config-dir/"
Expand Down Expand Up @@ -125,7 +124,7 @@

## [test](#test)

The `test` mode in Keploy allows the user to run the recoded testcases from the API calls and execute assertion. A detailed report is produced after the tests are executed and it's then saved in the yaml format in `keploy/reports` directory in the current working directory.

Check failure on line 127 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L127

[Vale.Spelling] Did you really mean 'yaml'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'yaml'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 127, "column": 200}}}, "severity": "ERROR"}

<b> Usage: </b>

Expand All @@ -149,7 +148,7 @@

In the command above, `node src/app.js` is the command which starts the user application.

- `--config-path string` - Path to the Keploy configuration file. The default is ".".

Check failure on line 151 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L151

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 151, "column": 82}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --config-path "./config-dir/"
Expand All @@ -169,7 +168,7 @@
keploy test -c "node src/app.js" --delay 10
```

- `--mongo-password string` - Authentication password for mocking MongoDB connection. The default password is "default123".

Check failure on line 171 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L171

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 171, "column": 111}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --mongo-password "my-password"
Expand Down Expand Up @@ -237,60 +236,26 @@

- `--jacoco-agent-path` - Only applicable for test coverage for Java projects. You can override the jacoco agent jar by providing its path

- `--proto-dir string` - Path of the directory where all protos of a service are located. Used for GRPC test cases to enable better deterministic and proper comparison of protobuf responses.

Check failure on line 239 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L239

[Vale.Spelling] Did you really mean 'protos'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'protos'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 239, "column": 58}}}, "severity": "ERROR"}

Check failure on line 239 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L239

[Vale.Spelling] Did you really mean 'protobuf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'protobuf'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 239, "column": 172}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --proto-dir "./protos"
```

- `--proto-file string` - Path of main proto file. Used for GRPC test cases to enable better deterministic and proper comparison of protobuf responses. Either `--proto-file` or `--proto-dir` must be provided for GRPC tests.

Check failure on line 245 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L245

[Vale.Spelling] Did you really mean 'proto'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'proto'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 245, "column": 40}}}, "severity": "ERROR"}

Check failure on line 245 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L245

[Vale.Spelling] Did you really mean 'protobuf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'protobuf'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 245, "column": 133}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --proto-file "./protos/main.proto"
```

- `--proto-include stringArray` - Path of directories to be included while parsing import statements in proto files. This is optional and used for GRPC test cases when proto files have import dependencies.

Check failure on line 251 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L251

[Vale.Spelling] Did you really mean 'proto'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'proto'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 251, "column": 105}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --proto-file "./protos/main.proto" --proto-include "./protos/common,./protos/shared"
```

> **Note for GRPC Tests:** When running GRPC test cases, it's recommended to provide proto information using either `--proto-file` or `--proto-dir` flags. If proto information is not provided, Keploy will use basic canonical matching of the protoscopic textual format of GRPC response body, which may be less accurate than proto-based comparison.

Check failure on line 257 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L257

[Vale.Spelling] Did you really mean 'proto'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'proto'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 257, "column": 88}}}, "severity": "ERROR"}

Check failure on line 257 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L257

[Vale.Spelling] Did you really mean 'proto'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'proto'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 257, "column": 161}}}, "severity": "ERROR"}

Check failure on line 257 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L257

[Vale.Spelling] Did you really mean 'protoscopic'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'protoscopic'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 257, "column": 244}}}, "severity": "ERROR"}

## [gen](#gen)

The `gen` cmd in Keploy allows user to generate unit tests using LLM Models.

<b> Usage: </b>

```bash
keploy gen [flags]
```

<b> Available flags: </b>

- `sourceFilePath` - Path to the source file for which tests are to be generated.

- `testFilePath` - Path where the generated tests will be saved.

- `coverageReportPath` - Path to generate the coverage report.

- `testCommand` - Command to execute tests and generate the coverage report.

- `coverageFormat` - Type of the coverage report by default report is in "cobertura" format.

- `expectedCoverage` - Desired coverage percentage by default it is set to be at 100%.

- `maxIterations` - Maximum number of iterations for refining tests (default 5).

- `testDir` - Directory where tests will be written.

- `llmBaseUrl` - Base url of the llm.

- `model` - Specifies the AI model to use by default it uses "gpt-4o" model.

- `llmApiVersion` - API version of the llm if any.

## [normalize](#normalize)

The `normalize` cmd in Keploy allows user to change the response of the testcases according to the latest test run response that is executed by the user, this is useful when the API response of the testcases are changed due to code change or any other intentional change in the application.
Expand Down Expand Up @@ -333,7 +298,7 @@

## [rerecord](#rerecord)

The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testset(s).

Check failure on line 301 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L301

[Google.OptionalPlurals] Don't use plurals in parentheses such as in 'testset(s)'.
Raw output
{"message": "[Google.OptionalPlurals] Don't use plurals in parentheses such as in 'testset(s)'.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 301, "column": 118}}}, "severity": "ERROR"}

**Usage:**

Expand Down Expand Up @@ -375,7 +340,7 @@
keploy report -t "test-set-1"
```

- `-p, --path string` - Path to the local directory where generated testcases/mocks are stored. Default is ".".

Check failure on line 343 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L343

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 343, "column": 108}}}, "severity": "ERROR"}

```bash
keploy report -p "./keploy-tests"
Expand All @@ -393,7 +358,7 @@
keploy report -t "test-set-1" --full
```

- `--summary` - Print only a summarized view (grand totals and per–test-set table with time taken). Useful for a quick dashboard-style overview. Can be combined with `-t/--test-sets` and `--report-path`.

Check failure on line 361 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L361

[Google.EnDash] Use an em dash ('—') instead of '–'.
Raw output
{"message": "[Google.EnDash] Use an em dash ('—') instead of '–'.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 361, "column": 67}}}, "severity": "ERROR"}

```bash
keploy report --summary
Expand All @@ -409,7 +374,7 @@
>
> - By default, `report` shows only **failed** tests with a compact, human-readable diff (status, headers—including trailers/content-length where applicable—and body changes).
> - Use `--full` to see the complete expected vs actual bodies (with JSON colorization).
> - `--summary` prints just the totals and a per–test-set table, optionally restricted with `-t/--test-sets`.

Check failure on line 377 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L377

[Google.EnDash] Use an em dash ('—') instead of '–'.
Raw output
{"message": "[Google.EnDash] Use an em dash ('—') instead of '–'.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 377, "column": 49}}}, "severity": "ERROR"}
> - When `--report-path` is provided, Keploy reads that file directly. Legacy files that contain only a `tests` list are supported.

## [templatize](#templatize)
Expand Down Expand Up @@ -440,7 +405,7 @@
keploy config --generate
```

- `-p, --path string` - Path to the local directory where the Keploy Configuration File will be stored. The default is ".".

Check failure on line 408 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L408

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 408, "column": 120}}}, "severity": "ERROR"}

```bash
keploy config --generate --path "./config-dir/"
Expand Down
Loading