feat: Coverage-Based Deduplication Support via runtime/coverage Package by officialasishkumar · Pull Request #202 · keploy/go-sdk

officialasishkumar · 2025-07-14T06:29:27Z

This adds a Go package that—when imported and built with -cover -covermode=atomic—automatically:

Listens for START/END <testID> commands over a Unix socket
Clears and dumps atomic coverage counters
Runs go tool covdata textfmt, parses profiles, and maps executed lines per file
Sends JSON payloads (testID + coverage) back via a data socket

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

keploy · 2025-07-14T06:29:31Z

Keploy failed to create test cases for this PR. For retrying, please click here

Copilot

Pull Request Overview

Adds a new Go package to collect and report coverage data via atomic counters and Unix sockets, replacing legacy mock and mode functionality.

Removed legacy mode.go and mock.go implementations.
Introduced keploy.go which starts a control server, clears/dumps coverage, processes profiles via covdata, and sends JSON results.
Updated go.mod to remove unused dependencies and require golang.org/x/tools for coverage parsing.

Reviewed Changes

Copilot reviewed 4 out of 108 changed files in this pull request and generated 2 comments.

File	Description
keploy/mode.go	Removed old mode enumeration and validation logic
keploy/mock.go	Removed legacy mock runner that directly invoked Keploy CLI
keploy/keploy.go	New control server and coverage reporting using `runtime/coverage`
go.mod	Cleaned out unused requires and added `golang.org/x/tools`

Comments suppressed due to low confidence (4)

go.mod:3

The module's Go version is set to 1.16 but the code imports runtime/coverage which requires Go 1.25 or later; please bump the Go version accordingly.

go 1.16

go.mod:5

The commented replace directive appears outdated and can confuse maintainers; consider removing or updating it.

//replace go.keploy.io/server => ../keploy

keploy/keploy.go:1

This new package implements significant functionality but currently lacks any unit or integration tests; consider adding tests for the control server, command handling, and coverage processing.

// To activate, simply import this package for its side effects:

keploy/keploy.go:8

[nitpick] The keploy.go file is quite large and combines server setup, command handling, and coverage processing; consider refactoring into smaller, focused packages or files to improve maintainability.

package keploy

Copilot · 2025-07-14T06:31:14Z

+const (
+	// controlSocketPath is used by Keploy to send commands (START/END) to the app.
+	controlSocketPath = "/tmp/coverage_control.sock"
+	// dataSocketPath is used by the app to send coverage data back to Keploy.
+	dataSocketPath = "/tmp/keploy-coverage.sock"


Using fixed Unix socket paths under /tmp can lead to symlink or permission vulnerabilities; consider using a secure temporary directory or making the path configurable with proper permissions.

Suggested change

const (

// controlSocketPath is used by Keploy to send commands (START/END) to the app.

controlSocketPath = "/tmp/coverage_control.sock"

// dataSocketPath is used by the app to send coverage data back to Keploy.

dataSocketPath = "/tmp/keploy-coverage.sock"

var (

// controlSocketPath is used by Keploy to send commands (START/END) to the app.

controlSocketPath string

// dataSocketPath is used by the app to send coverage data back to Keploy.

dataSocketPath string

// tempDir is the temporary directory for socket files.

tempDir string

Copilot · 2025-07-14T06:31:15Z

+		}
+		err := reportCoverage(id);


On receiving an END command with a mismatched test ID, the code logs a warning but still proceeds to report coverage for the provided ID; you may want to skip reporting in this case to avoid inconsistent state.

Suggested change

}

err := reportCoverage(id);

// Reset the currentTestID to an empty string to indicate that no test is currently being recorded.

currentTestID = ""

return

}

err := reportCoverage(id)

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

gouravkrosx · 2025-07-28T13:16:13Z

+	for {
+		conn, err := ln.Accept()
+		if err != nil {
+			if strings.Contains(err.Error(), "use of closed network connection") {


Were we really getting this error here? "use of closed network connection", Because here you have just accepted the connection.

no i did not get this error. this error can only happen when it gets closed manually.

gouravkrosx · 2025-07-28T13:27:19Z

+			log.Printf("[Agent] Error clearing coverage counters: %v", err)
+		}
+	case "END":
+		if currentTestID != id {


You can use early return here. And then there is no need of else block.

@officialasishkumar please address this comment.

gouravkrosx · 2025-07-28T13:28:14Z

+// reportCoverage dumps, processes, and sends the coverage data.
+func reportCoverage(testID string) error {
+	// Create a temporary directory to store the coverage data.
+	tempDir, err := os.MkdirTemp("", "keploy-coverage-")


We can name the temp folder as keploy-coverage-<testID>

@officialasishkumar please address this comment.

gouravkrosx · 2025-07-28T13:36:02Z

+
+		// For each block in the profile, if the count is greater than 0, add the lines to the map.
+		for _, block := range profile.Blocks {
+			if block.Count > 0 {


you can write this condition like

if block.Count<=0{ continue }

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

gouravkrosx · 2025-07-28T15:47:02Z

@@ -1,14 +1,7 @@
 module github.com/keploy/go-sdk/v2


Make the module v3

gouravkrosx · 2025-07-28T16:32:41Z

@@ -1,22 +1,261 @@
+// To activate, simply import this package for its side effects:
+//
+//	import _ "github.com/keploy/go-sdk/v2/keploy"


add /v3 here as well

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

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

officialasishkumar added 10 commits July 11, 2025 18:25

feat: coverage initial set up

72a98a3

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

feat: update comments

82ad3f8

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

feat: update dedupData.yaml with correct values

97c399b

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

refactor: remove the old vendor

bb44533

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

feat: add vendor

70ce9c9

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

fix: update comments

f127770

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

feat: add clear counters after every test case run

6c9c869

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

feat: update comments

2b0838a

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

refactor: better comments

7535b0d

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

feat: update go mod file

0f4aa64

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

Copilot AI review requested due to automatic review settings July 14, 2025 06:29

Copilot AI reviewed Jul 14, 2025

View reviewed changes

officialasishkumar added 6 commits July 14, 2025 12:04

feat: skip reporting in case of mismatched test id

bf077d9

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

fix: bump go version

507a7ae

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

fix: bump go version

0e5164e

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

fix: bump go version

e336519

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

fix: add install command in workflow

02871c3

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

fix: bump go version

1361064

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

Sarthak160 force-pushed the v3 branch from 0a0eae6 to 1361064 Compare July 14, 2025 08:18

fix: bump go version in workflow

016e97a

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

gouravkrosx reviewed Jul 28, 2025

View reviewed changes

officialasishkumar added 2 commits July 28, 2025 21:06

feat: add an ack in end command

b1f7d07

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

fix: block.count continue

fb5e49c

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

gouravkrosx reviewed Jul 28, 2025

View reviewed changes

Comment thread go.mod Outdated

@@ -1,14 +1,7 @@

module github.com/keploy/go-sdk/v2

Copy link
Copy Markdown

Member

gouravkrosx Jul 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make the module v3

gouravkrosx reviewed Jul 28, 2025

View reviewed changes

feat: bump sdk version

87a23a7

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

Sarthak160 force-pushed the v3 branch from 7e278d9 to 87a23a7 Compare July 28, 2025 17:12

officialasishkumar added 5 commits July 28, 2025 22:59

refactor: better file name for sock

b4c5457

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

fix: early return and new coverage folder name

bc82e36

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

feat: change socket name

3243cb1

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

fix: dir creation error

99c1c6a

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

feat: add more instruction for coverage

67dc6bf

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

gouravkrosx approved these changes Jul 31, 2025

View reviewed changes

officialasishkumar added 4 commits July 31, 2025 14:54

feat: add golang ci lint

7673905

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

feat: add golang ci lint

333499d

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

feat: add golang ci lint

108b37c

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

feat: add golang ci lint

6c6c3f0

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

slayerjain merged commit 78d4555 into main Jul 31, 2025
3 checks passed

Conversation

officialasishkumar commented Jul 14, 2025

Uh oh!

keploy Bot commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

keploy Bot commented Jul 14, 2025 •

edited

Loading