feat: add docs for dedup#652

Merged

Sarthak160 merged 2 commits intomainfrom

Sep 7, 2025

Member

officialasishkumar commented Sep 5, 2025 •

edited

Loading

What has changed?

Please include a summary of the change.

Adds docs for dedup

This PR Resolves https://github.com/keploy/enterprise/issues/1398

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue).
New feature (non-breaking change which adds functionality).
Breaking change (fix or feature that would cause existing functionality to not work as expected).
Documentation update (if none of the other choices apply).

How Has This Been Tested?

tested on: https://github.com/officialasishkumar/sample-go

how i test it was i created a sample application with 30 simple endpoints and created a script which picks randomly from all those 30 endpoints and the entire thing runs for 5000 curls. so in the end i just. checked whether only 30 are found unique or not

Checklist:

My code follows the style guidelines of this project.
I have performed a self-review of my own code.

Copilot AI review requested due to automatic review settings

September 5, 2025 13:34

github-actions bot force-pushed the feat/dedup branch from 9b3dc48 to 17bae88 Compare

September 5, 2025 13:35

Copilot AI reviewed

View reviewed changes

Copilot AI left a comment

Pull Request Overview

This PR adds documentation for the dedup feature specifically for Golang applications, replacing the previous multi-language documentation. The documentation has been streamlined to focus on Go-specific implementation and usage patterns.

Key changes:

Replaces Node.js, Java, and Python dedup documentation with Golang-specific instructions
Updates command examples to use the newer keploy test command with --dedup flag
Simplifies the workflow by removing language-specific middleware setup in favor of Go SDK import

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

versioned_docs/version-3.0.0/keploy-cloud/deduplication.md Outdated

-              ### For Node Applications
+              ### For Golang Applications
               **1. Pre-requsite**

Copilot AI Sep 5, 2025

There's a spelling error in 'Pre-requsite'. It should be 'Pre-requisite'.

Suggested change

      
            **1. Pre-requsite**
          
            **1. Pre-requisite**

Copilot uses AI. Check for mistakes.

versioned_docs/version-3.0.0/keploy-cloud/deduplication.md Outdated

               ```
-              Add the the following on top of your main application js file (index.js/server.js/app.js/main.js) : -
+              Add the the following on top of your main application file : -

Copilot AI Sep 5, 2025

There's a duplicate word 'the the' which should be 'the following'.

Suggested change

      
            Add the the following on top of your main application file : -
          
            Add the following on top of your main application file : -

Copilot uses AI. Check for mistakes.

versioned_docs/version-3.0.0/keploy-cloud/deduplication.md

-              **1. Pre-requsite**
-              Put the latest keploy-sdk in your file : -
+              After this Run

Copilot AI Sep 5, 2025

The sentence is incomplete and lacks proper punctuation. It should end with a period and could benefit from more context about what the dedupData.yaml file contains or its purpose.

Suggested change

      
            After this Run
          
            This will generate a dedupData.yaml file, which contains metadata and coverage information for each test case. This file is used in the next step to identify and remove duplicate tests.

Copilot uses AI. Check for mistakes.


          feat: add docs for dedup

e55c4b3

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>

officialasishkumar force-pushed the feat/dedup branch from 17bae88 to e55c4b3 Compare

September 5, 2025 13:54

github-actions bot force-pushed the feat/dedup branch from e55c4b3 to c1e8488 Compare

September 5, 2025 13:55

officialasishkumar force-pushed the feat/dedup branch from c1e8488 to e55c4b3 Compare

September 5, 2025 14:10

github-actions bot force-pushed the feat/dedup branch from e55c4b3 to 08cd8a4 Compare

September 5, 2025 14:10

gouravkrosx reviewed

View reviewed changes

versioned_docs/version-3.0.0/keploy-cloud/deduplication.md Outdated

-              #### Example
-              Let's use the [expresss-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) application to test dedup feature. In our `src/app.js` file we need to have imported and initialized `@keploy/sdk` package, so now let's run the de-duplication command to check : -
+              Update the go build command in Dockerfile to add new flags which is required for deduplication (this is not required for native)

Member

gouravkrosx Sep 5, 2025 •

edited

Loading

(this is not required for native)

It is required, that's why you mentioned below,

gouravkrosx reviewed

View reviewed changes

versioned_docs/version-3.0.0/keploy-cloud/deduplication.md Outdated

-              ### For Python Applications
-              Deduplication works only on test mode there are no special instructions to record your tests.
+              where `./main` is the binary produced by doing `go build -cover -covermode=atomic -coverpkg=./... -o ./main .`

Member

gouravkrosx Sep 5, 2025

This is confusing. Club this with the above, like for native and for docker.

Member Author

officialasishkumar Sep 7, 2025

done

Member

gouravkrosx commented Sep 6, 2025

@officialasishkumar Please update the docs.

officialasishkumar force-pushed the feat/dedup branch from 08cd8a4 to 8b8ed5b Compare

September 7, 2025 17:23


          feat: update native docs

389d03c

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>

github-actions bot force-pushed the feat/dedup branch from 8b8ed5b to 389d03c Compare

September 7, 2025 17:24

Sarthak160 approved these changes

View reviewed changes

Sarthak160 merged commit 20bdb9b into main

1 check passed

Sarthak160 deleted the feat/dedup branch

September 7, 2025 19:16

Achanandhi-M pushed a commit that referenced this pull request


          feat: add docs for dedup (#652)

f181db6

* feat: add docs for dedup

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>

* feat: update native docs

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>

---------

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet