refactor: Refactored the code to make it more modular #1078

PranshuSrivastava · 2023-11-05T22:41:22Z

Related Issue

The code did not have many modules so it became difficult to use certain parts of it, and the same work needed to be repeated again and again.

Describe the changes you've made

Made the code more modular by dividing the code into two parts, the code which is supposed the same everywhere, and the code which is supposed to be different.

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Code style update (formatting, local variables)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Checklist:

My code follows the style guidelines of this project.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.
I have added tests that prove my fix is effective or that my feature works.
New and existing unit tests pass locally with my changes.

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

sweep-ai · 2023-11-05T22:42:25Z

Apply Sweep Rules to your PR?

Apply: All new business logic should have corresponding unit tests.
Apply: Refactor large functions to be more modular.

re-Tick · 2023-11-07T09:41:30Z

pkg/service/record/record.go

@@ -19,38 +19,37 @@ import (
 var Emoji = "\U0001F430" + " Keploy:"

 type recorder struct {
-	logger *zap.Logger
+	Logger *zap.Logger


Why do we need to export logger, since it is called internally by the exported functions.

re-Tick · 2023-11-07T09:52:15Z

pkg/service/test/util.go

@@ -271,6 +298,11 @@ func filterTcsMocks(tc *models.TestCase, m []*models.Mock, logger *zap.Logger) [
 	}

 	for _, mock := range m {
+		if mock.Version == "api.keploy-enterprise.io/v1beta1" {
+			logger.Info("This mock was recorded using the the enterprise version, may not work properly with the open source version", zap.String("mock kind:", string(mock.Kind)))


Please remove the typo here, and can the info be logged once for a test-set.

re-Tick · 2023-11-07T10:07:45Z

pkg/service/test/service.go

@@ -11,5 +11,9 @@ import (

 type Tester interface {
 	Test(path string, proxyPort uint32, testReportPath string, appCmd string, testsets []string, appContainer, networkName string, Delay uint64, passThorughPorts []uint, apiTimeout uint64, noiseConfig map[string]interface{}) bool
-	RunTestSet(testSet, path, testReportPath, appCmd, appContainer, appNetwork string, delay uint64, pid uint32, ys platform.TestCaseDB, loadedHook *hooks.Hook, testReportfs yaml.TestReportFS, testRunChan chan string, apiTimeout uint64, ctx context.Context, noiseConfig map[string]interface{}) models.TestRunStatus
+	RunTestSet(testSet, path, testReportPath, appCmd, appContainer, appNetwork string, delay uint64, pid uint32, ys platform.TestCaseDB, loadedHook *hooks.Hook, testReportfs yaml.TestReportFS, testRunChan chan string, apiTimeout uint64, ctx context.Context, noiseConfig map[string]interface{})models.TestRunStatus


Here, since the parameters of this functions are long. You can add an option struct for this functions. And for the required fields can use a check for null values.

re-Tick · 2023-11-07T10:17:35Z

pkg/service/test/util.go

+	Ys                       platform.TestCaseDB
+	LoadedHooks              *hooks.Hook
+	AbortStopHooksInterrupt  chan bool
+	Ok                       bool


In the changes ok is used for returning false for errors in starting app or loading hooks so, instead of boolean we can just return the error along with InitialiseTestReturn for the InitialiseTestReturn.

re-Tick · 2023-11-07T10:19:39Z

pkg/service/test/util.go

+	AbortStopHooksForcefully bool
+	Ps                       *proxy.ProxySet
+	ExitCmd                  chan bool
+	Ys                       platform.TestCaseDB


Here since the fields are exported, you can use descriptive name or add comment for the field

Change ps, ys and dIDE

re-Tick · 2023-11-07T10:50:07Z

pkg/service/mocktest/mocktest.go

@@ -21,13 +21,13 @@ import (
 var Emoji = "\U0001F430" + " Keploy:"

 type mockTester struct {
-	logger *zap.Logger
+	Logger *zap.Logger


If logger is not used externally, it could be unexported.

re-Tick · 2023-11-07T10:50:59Z

pkg/service/mockrecord/mockrecord.go

@@ -21,13 +21,13 @@ import (
 var Emoji = "\U0001F430" + " Keploy:"

 type mockRecorder struct {
-	logger *zap.Logger
+	Logger *zap.Logger


If it is not used by the external packages, this can be unexported.

re-Tick · 2023-11-07T10:58:57Z

pkg/proxy/proxy.go

@@ -55,6 +54,13 @@ func getNextID() int64 {
 	return atomic.AddInt64(&idCounter, 1)
 }

+type DepInterface interface {


Remove interface from the name of the type

re-Tick · 2023-11-07T11:02:52Z

cmd/record.go

@@ -19,7 +19,7 @@ func NewCmdRecord(logger *zap.Logger) *Record {
 	recorder := record.NewRecorder(logger)
 	return &Record{
 		recorder: recorder,
-		logger:   logger,
+		Logger:   logger,


If this is not used by the external packages, then it can be unexported.

re-Tick · 2023-11-07T11:04:12Z

pkg/hooks/connection/factory.go

@@ -98,6 +98,7 @@ func (factory *Factory) GetOrCreate(connectionID structs.ConnID) *Tracker {
 }

 func capture(db platform.TestCaseDB, req *http.Request, resp *http.Response, logger *zap.Logger, ctx context.Context, reqTimeTest time.Time, resTimeTest time.Time) {
+	V1Beta1 := models.GetVersion()


Here, you can use version as the variable name

re-Tick · 2023-11-07T11:07:01Z

pkg/models/testcase.go

-	V1Beta1 Version = Version("api.keploy.io/v1beta1")
-	V1Beta2 Version = Version("api.keploy.io/v1beta2")
+var (
+	V1Beta1 = Version("api.keploy.io/v1beta1")


This should be a constant and to store the current version, an un-exported global scoped variable.

re-Tick · 2023-11-07T11:16:02Z

pkg/proxy/integrations/mysqlparser/mysqlparser.go

@@ -643,7 +643,7 @@ func recordMySQLMessage(h *hooks.Hook, mysqlRequests []models.MySQLRequest, mysq
 			"responseOperation": responseOperation,
 		}
 		mysqlMock := &models.Mock{
-			Version: models.V1Beta2,
+			Version: models.V1Beta1,


Handle for the mysql server to register it as a dependency in the proxy.

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

re-Tick

LGTM

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

PranshuSrivastava added 14 commits October 4, 2023 18:19

feat: adding register for dependencies

143dbfd

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: Keploy side interface integration complete

8758ab8

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: updated the scope of the map

eacec28

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: made logger exportable and fixed the register function

cdcaae8

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: made seperate hooks for enterprise

5e8e9d5

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: refactoring some code for testing

341bdb6

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: created getter and setter methods for Keploy-version

6cb7fa3

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: fixed mockrecord flag parsing error

baee2ed

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: exported logger

8884b78

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: made the test function modular, working on runtestset

bdd8b85

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: divided test and runtestset function into modules

809bfb9

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: removed v1beta2 and added the test return values into a struct

295e3c2

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

feat: merged main and finalised the changes for enterprise server

e85bca2

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: fixed unexpected log and exported the sorting function

455420d

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

re-Tick reviewed Nov 7, 2023

View reviewed changes

PranshuSrivastava added 4 commits November 9, 2023 08:22

fix: made changes according to the comments

1f73577

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

docs: added comment to mysql parser

09c9eab

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: fixed merge conflicts

81209cd

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: fixed merge conflicts

a7de35b

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: fixed merge conflicts

d44804d

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

re-Tick approved these changes Nov 13, 2023

View reviewed changes

PranshuSrivastava added 3 commits November 13, 2023 10:43

fix: made changes accorrding to the requirements

1127955

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: fixed merge conflicts

fcf8345

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

fix: removed keploy-config file

6bbd105

Signed-off-by: Pranshu Srivastava <iampranshu24@gmail.com>

PranshuSrivastava merged commit cf7bb6c into keploy:main Nov 14, 2023
6 checks passed

github-actions bot locked and limited conversation to collaborators Nov 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Refactored the code to make it more modular #1078

refactor: Refactored the code to make it more modular #1078

PranshuSrivastava commented Nov 5, 2023 •

edited

Loading

sweep-ai bot commented Nov 5, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 8, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023 •

edited

Loading

PranshuSrivastava Nov 9, 2023 •

edited

Loading

re-Tick Nov 7, 2023 •

edited

Loading

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023

PranshuSrivastava Nov 9, 2023

re-Tick Nov 7, 2023

re-Tick left a comment

refactor: Refactored the code to make it more modular #1078

refactor: Refactored the code to make it more modular #1078

Conversation

PranshuSrivastava commented Nov 5, 2023 • edited Loading

Related Issue

Describe the changes you've made

Type of change

Checklist:

sweep-ai bot commented Nov 5, 2023

Apply Sweep Rules to your PR?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

re-Tick Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

PranshuSrivastava Nov 9, 2023 • edited Loading

Choose a reason for hiding this comment

re-Tick Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

re-Tick left a comment

Choose a reason for hiding this comment

PranshuSrivastava commented Nov 5, 2023 •

edited

Loading

re-Tick Nov 7, 2023 •

edited

Loading

PranshuSrivastava Nov 9, 2023 •

edited

Loading

re-Tick Nov 7, 2023 •

edited

Loading