Skip to content

fix: rm an invalid reference in 'Running the setup in CI' section #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 27, 2025
+0 −2
Merged

fix: rm an invalid reference in 'Running the setup in CI' section #503

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f3a6515
chore: rm an invalid reference in 'Running the setup in CI' section
Konippi Mar 26, 2025
0a8fddb
Merge branch 'main' into rm-invalid-reference-in-setup-ci
Sonichigo Apr 4, 2025
1b3f3c1
Merge branch 'main' into rm-invalid-reference-in-setup-ci
khareyash05 Apr 24, 2025
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
2 changes: 0 additions & 2 deletions versioned_docs/version-2.0.0/keploy-explained/testing-guide.md
View file
Original file line number Diff line number Diff line change
@@ -131,8 +131,6 @@ If both scenarios yield a "passed" result, it signifies that this approach mirro

- To achieve this, you'll need to add two workflows for each sample application, covering both recording and testing scenarios.

- You can refer to this [setup](https://github.com/keploy/keploy/blob/main/.github/workflows/build_stage.yml) for guidance.

## Limitations ⚠️

- Port Configuration: The ports for Keploy Record (`keployR`) and Keploy Test (`keployT`) need to be hardcoded. You can't change the ports and run this entire setup properly.

Unchanged files with check annotations Beta

View file
versioned_docs/version-2.0.0/running-keploy/rename-testcases.md
sudo -E keploy record -c "./test-app-url-shortener"
```
3. Make an api call and add a header field with key set to `Keploy-Test-Name` and value set to the name you want for your testcase, let's say 'renametest'.

Check failure on line 37 in versioned_docs/version-2.0.0/running-keploy/rename-testcases.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'renametest'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'renametest'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/rename-testcases.md", "range": {"start": {"line": 37, "column": 144}}}, "severity": "ERROR"}
```bash
curl --request POST \
View file
versioned_docs/version-2.0.0/running-keploy/keploy-templatize.md
Sometimes keploy test and keploy rerecord fail because there are fields which are noisy but they are used in requests so when their values change, the subsequent requests also fail.
eg: If an application is returning a JWT token in the response of a testcase and that token is being used in the request of another testcase, then that testcase will also fail when a new token is issued and the test is still using the old one that has been expired.

Check failure on line 17 in versioned_docs/version-2.0.0/running-keploy/keploy-templatize.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'eg'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'eg'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-templatize.md", "range": {"start": {"line": 17, "column": 1}}}, "severity": "ERROR"}
Templatize, as its name suggests, templatizes the testcases, so now the JWT token's original value will be replaced by a template in both the response of one testcase and the request of the other testcase and a config file will be created which will contain a map of the template key mapped to its value. Now in the test mode or rerecord mode, whenever a new token is issued where the template is placed, it will update the template value in the map and use that value in the subequent testcases where the template is placed.

Check failure on line 19 in versioned_docs/version-2.0.0/running-keploy/keploy-templatize.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'subequent'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'subequent'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-templatize.md", "range": {"start": {"line": 19, "column": 477}}}, "severity": "ERROR"}
## Keploy Templatize Example
sudo -E env 'PATH=$PATH' keploy templatize
```
By default, it templatizes all the testsets in the keploy folder. If you want to templatize a particular testset, you can pass the testset flag like

Check failure on line 29 in versioned_docs/version-2.0.0/running-keploy/keploy-templatize.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'testset'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'testset'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-templatize.md", "range": {"start": {"line": 29, "column": 106}}}, "severity": "ERROR"}
```zsh
sudo -E env 'PATH=$PATH' keploy templatize -t="test-set-1"
View file
versioned_docs/version-2.0.0/running-keploy/docker-tls.md
Perform API calls using tools like [Hoppscotch](https://hoppscotch.io/), [Postman](https://www.postman.com/), or cURL commands.
Keploy will capture the API calls you've conducted, generating test suites comprising **test cases (KTests) and data mocks (KMocks)** in `YAML` format.

Check failure on line 49 in versioned_docs/version-2.0.0/running-keploy/docker-tls.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'KTests'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'KTests'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/docker-tls.md", "range": {"start": {"line": 49, "column": 101}}}, "severity": "ERROR"}
### Running Testcases
View file
versioned_docs/version-2.0.0/running-keploy/keploy-passthrough.md
This is why, user can provide the server port to pass the external requests without mocking them.
## Keploy Passthrough Example

Check failure on line 19 in versioned_docs/version-2.0.0/running-keploy/keploy-passthrough.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Passthrough'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Passthrough'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-passthrough.md", "range": {"start": {"line": 19, "column": 11}}}, "severity": "ERROR"}
You can add `--passThroughPorts` flag to pass the outgoing calls at the given ports and pass them in the keploy proxy without mocking.
View file
versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md
- **Fedora 40+**
- **Ubuntu 22.04+**
- **Debian 12+**
- Tested with JDK 1.8 to 17 and [Karaf 4.3.x](https://karaf.apache.org/download.html)

Check failure on line 24 in versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Karaf'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Karaf'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md", "range": {"start": {"line": 24, "column": 34}}}, "severity": "ERROR"}
### Install Keploy Binary
wget https://keploy-enterprise.s3.us-west-2.amazonaws.com/agent-jars/org.jacoco.agent-0.8.12-runtime.jar
```
## Step 2: Configure Apache Karaf

Check failure on line 48 in versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Karaf'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Karaf'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md", "range": {"start": {"line": 48, "column": 29}}}, "severity": "ERROR"}
### Update `JAVA_OPTS` for Linux in `setenv` File:
1. Navigate to the `bin` directory of your Apache Karaf installation.

Check failure on line 52 in versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

GitHub Actions / Vale doc linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Karaf'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Karaf'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md", "range": {"start": {"line": 52, "column": 51}}}, "severity": "ERROR"}
2. Open the `setenv` file for editing.
3. Add the paths of the downloaded agents under the `JAVA_OPTS` section. For example: