-
Notifications
You must be signed in to change notification settings - Fork 227
feat: add docs for dedup #652
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.
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
Conversation
9b3dc48
to
17bae88
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
``` | ||
|
||
### For Node Applications | ||
### For Golang Applications | ||
|
||
**1. Pre-requsite** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a spelling error in 'Pre-requsite'. It should be 'Pre-requisite'.
**1. Pre-requsite** | |
**1. Pre-requisite** |
Copilot uses AI. Check for mistakes.
``` | ||
|
||
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 : - |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a duplicate word 'the the' which should be 'the following'.
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.
**1. Pre-requsite** | ||
|
||
Put the latest keploy-sdk in your file : - | ||
After this Run |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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.
Signed-off-by: Asish Kumar <[email protected]>
17bae88
to
e55c4b3
Compare
e55c4b3
to
c1e8488
Compare
c1e8488
to
e55c4b3
Compare
e55c4b3
to
08cd8a4
Compare
#### 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(this is not required for native)
It is required, that's why you mentioned below,
### 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 .` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is confusing. Club this with the above, like for native and for docker.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
@officialasishkumar Please update the docs. |
08cd8a4
to
8b8ed5b
Compare
Signed-off-by: Asish Kumar <[email protected]>
8b8ed5b
to
389d03c
Compare
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.
How Has This Been Tested?
tested on: https://github.com/officialasishkumar/sample-go
Checklist: