[Feature]: Create a normalisation command in keploy CLI #1589

Akash-Singh04 · 2024-02-17T07:49:09Z

Related Issue

New CLI Command Feature

Closes: #1538

Describe the changes you've made

Added keploy normalise command to the Keploy CLI to allow users to normalise their test cases. The Function of the command is as follows:

The command checks for test-sets , test-cases and test-run flags from the CLI
The command reads YAML files containing test data and unmarshals it..
The command iterates over each failed test case in the test data and retrieves the corresponding test data from the struct.
The command then updates the expected response in the test case file with the actual response obtained
Finally, the program writes the updated YAML data back to the original testcase files.

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

Please let us know if any test cases are added

NIL

Describe if there is any unusual behaviour of your code(Write `NA` if there isn't)

NA

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.

Screenshots (if any)

Signed-off-by: Akash <akashsingh2210670@gmail.com>

…e doesnt match yaml file Signed-off-by: Akash <akashsingh2210670@gmail.com>

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Akash-Singh04 · 2024-02-17T07:54:49Z

@charankamarapu Kindly review this PR and let me know if this implementation works!

charankamarapu · 2024-02-19T18:03:38Z

From the screenshot I can say there is a bit of feature missing. User should give the testcases and testSet name which user want to normalise.

charankamarapu

Please address the comment

Akash-Singh04 · 2024-02-19T18:11:24Z

From the screenshot I can say there is a bit of feature missing. User should give the testcases and testSet name which user want to normalise.

Alright, if that is how we would want to implement this feature it should not be a problem at all. Will update asap and revert!

…nto normalise

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Akash-Singh04 · 2024-02-20T01:14:19Z

@charankamarapu Let me know if this implementation is ready to go or there is a need to further include more features in this!

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Akash-Singh04 · 2024-03-18T06:09:53Z

@charankamarapu If the CI pipeline will require time to fix, this PR is ready to be merged

charankamarapu · 2024-03-18T06:11:34Z

cool will do a review and let you know.

…nto normalise

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Akash-Singh04 · 2024-03-25T13:09:46Z

@charankamarapu I have addressed the review comments. Looking forward to your review on them

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

charankamarapu

please address the comments

cli/normalise.go

charankamarapu · 2024-04-04T06:19:19Z

cli/provider/cmd.go

@@ -155,6 +155,10 @@ func (c *CmdConfigurator) AddFlags(cmd *cobra.Command, cfg *config.Config) error
 	switch cmd.Name() {
 	case "update":
 		return nil
+	case "normalise":


Actually we should give option to the user to provide the test-run also so the flags would test-run, test-set, test-case. regarding path flag it should be normal path flag which we get in record and replay commands. It shouldn't be specific to reports. We have a config file which will be used for provided info like path etc without flags. There is a package for it named config.

charankamarapu · 2024-04-04T06:20:03Z

cli/provider/cmd.go

@@ -377,6 +381,35 @@ func (c CmdConfigurator) ValidateFlags(ctx context.Context, cmd *cobra.Command)
 				}
 			}
 		}
+	case "Normalise":
+		path := viper.GetString("path")


You need not do this if add things in config please go through test and record command

charankamarapu · 2024-04-04T06:21:07Z

pkg/service/tools/tools.go

@@ -283,3 +287,113 @@ func (t *Tools) CreateConfig(_ context.Context, filePath string, configData stri
 	t.logger.Info("Config file generated successfully")
 	return nil
 }
+
+// Normalise initiates the normalise process for normalising the test cases.
+func (t *Tools) Normalise(_ context.Context) error {


You should use yaml functions to edit the test-cases. You should how it is done in record and replay via interfaces of DBs . you can add this function in record or replay service.

Added it to replay service

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

charankamarapu

Please address the comments

charankamarapu · 2024-04-15T03:24:37Z

pkg/service/replay/replay.go

+// Normalise initiates the normalise process for normalising the test cases.
+func (r *Replayer) Normalise(_ context.Context, cfg *config.Config) error {
+	path := cfg.Path
+	testSets := viper.GetString("test-sets")


These are not needed use config struct instead of getting them like this. Please refer to how test or record command are accessing these kind of flags

Will look into this

charankamarapu · 2024-04-15T03:25:17Z

pkg/service/replay/replay.go

+		if strings.HasSuffix(file.Name(), ".yaml") {
+			filePath := filepath.Join(testRunPath, file.Name())
+			// Read the YAML file
+			yamlData, err := os.ReadFile(filePath)


why are you not using the test or report dbs..?

Will look into this

shivamsouravjha · 2024-04-29T11:24:15Z

@Akash-Singh04 if the comments are resolved feel free to resolve them, @charankamarapu would review the updated PR

Akash-Singh04 · 2024-04-29T19:25:06Z

@shivamsouravjha Need some time to properly look into the refactored codebase to resolve the comments,

shivamsouravjha · 2024-04-30T06:01:09Z

Sure thing @Akash-Singh04 in the meanwhile you can move it as a draft,

Akash-Singh04 and others added 6 commits February 16, 2024 20:47

Initialised Normalise Command

1e128fb

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Path init

b7a5a0d

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Successfully found the expected and actual responses for failing tests

d3fc082

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Files are being updated but structs are not proper: func WriteTestcas…

8801fd2

…e doesnt match yaml file Signed-off-by: Akash <akashsingh2210670@gmail.com>

Updating testcase files successfully

f44636a

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Merge branch 'main' into normalise

d38c508

nehagup requested a review from charankamarapu February 17, 2024 14:37

charankamarapu reviewed Feb 19, 2024

View reviewed changes

Akash-Singh04 added 3 commits February 20, 2024 05:56

Merge branch 'main' of https://github.com/keploy/keploy into normalise

296096d

Merge branch 'normalise' of https://github.com/Akash-Singh04/keploy i…

1c408cc

…nto normalise

Added flags to collect test-set and test-cases from user

af05022

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Akash-Singh04 requested a review from charankamarapu February 20, 2024 01:10

Akash-Singh04 and others added 12 commits February 21, 2024 00:01

Merge branch 'main' into normalise

9285a2c

Fixed lint errors

c945ad3

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Fixed lint errors

d74c430

Signed-off-by: Akash <akashsingh2210670@gmail.com>

Merge branch 'main' into normalise

26338c0

Merge branch 'main' of https://github.com/keploy/keploy into normalise

3306aa2

Merge branch 'main' into normalise

bbd2597

Merge branch 'main' into normalise

8ebd66f

Merge branch 'main' into normalise

a7b09f2

Merge branch 'main' of https://github.com/keploy/keploy into normalise

8467d68

Refactored PR for Keploy v2 and fixed merge conflicts

cffff23

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Merge branch 'main' into normalise

704e6f0

Merge branch 'main' into normalise

3992426

Akash-Singh04 and others added 4 commits March 25, 2024 17:56

Merge branch 'main' into normalise

d0fc8bb

Merge branch 'main' of https://github.com/keploy/keploy into normalise

5586ab0

Merge branch 'normalise' of https://github.com/Akash-Singh04/keploy i…

c2f0af0

…nto normalise

Addressed comments and refactored changes

f9c61b3

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Akash-Singh04 and others added 5 commits March 29, 2024 19:13

Merge branch 'main' into normalise

0f331a0

Fixed Lint

c5fb95b

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Merge branch 'main' of https://github.com/keploy/keploy into normalise

c8c9316

Fixed Lint

5c292be

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Merge branch 'main' into normalise

50cd492

Akash-Singh04 requested a review from charankamarapu April 3, 2024 17:35

charankamarapu reviewed Apr 4, 2024

View reviewed changes

Akash-Singh04 and others added 4 commits April 6, 2024 23:03

Merge branch 'main' of https://github.com/keploy/keploy into normalise

f3f756e

Refactoring and Adding Additional Flags

6fcc08d

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Added Normalise to replay service

4c00f09

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Merge branch 'main' into normalise

77c419e

Akash-Singh04 requested a review from charankamarapu April 7, 2024 21:37

Akash-Singh04 and others added 3 commits April 8, 2024 03:10

Fixed lint

efde0ce

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>

Merge branch 'main' into normalise

cfdaaec

Merge branch 'main' into normalise

0a4d394

charankamarapu reviewed Apr 15, 2024

View reviewed changes

Akash-Singh04 added 2 commits April 20, 2024 18:10

Merge branch 'main' into normalise

b8612ac

Merge branch 'main' into normalise

7a2f7a2

Merge branch 'main' into normalise

5eb6d6d

charankamarapu changed the base branch from main to normalise May 2, 2024 11:21

charankamarapu merged commit cbaee01 into keploy:normalise May 2, 2024
13 of 14 checks passed

github-actions bot locked and limited conversation to collaborators May 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature]: Create a normalisation command in keploy CLI #1589

[Feature]: Create a normalisation command in keploy CLI #1589

Akash-Singh04 commented Feb 17, 2024 •

edited

Loading

Akash-Singh04 commented Feb 17, 2024

charankamarapu commented Feb 19, 2024

charankamarapu left a comment

Akash-Singh04 commented Feb 19, 2024

Akash-Singh04 commented Feb 20, 2024

Akash-Singh04 commented Mar 18, 2024

charankamarapu commented Mar 18, 2024

Akash-Singh04 commented Mar 25, 2024

charankamarapu left a comment

charankamarapu Apr 4, 2024

charankamarapu Apr 4, 2024

Akash-Singh04 Apr 6, 2024

charankamarapu Apr 4, 2024

Akash-Singh04 Apr 7, 2024

charankamarapu left a comment

charankamarapu Apr 15, 2024

Akash-Singh04 Apr 20, 2024

charankamarapu Apr 15, 2024

Akash-Singh04 Apr 20, 2024

shivamsouravjha commented Apr 29, 2024 •

edited

Loading

Akash-Singh04 commented Apr 29, 2024

shivamsouravjha commented Apr 30, 2024

[Feature]: Create a normalisation command in keploy CLI #1589

[Feature]: Create a normalisation command in keploy CLI #1589

Conversation

Akash-Singh04 commented Feb 17, 2024 • edited Loading

Related Issue

Describe the changes you've made

Type of change

Please let us know if any test cases are added

Describe if there is any unusual behaviour of your code(Write NA if there isn't)

Checklist:

Screenshots (if any)

Akash-Singh04 commented Feb 17, 2024

charankamarapu commented Feb 19, 2024

charankamarapu left a comment

Choose a reason for hiding this comment

Akash-Singh04 commented Feb 19, 2024

Akash-Singh04 commented Feb 20, 2024

Akash-Singh04 commented Mar 18, 2024

charankamarapu commented Mar 18, 2024

Akash-Singh04 commented Mar 25, 2024

charankamarapu left a 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

charankamarapu left a 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

shivamsouravjha commented Apr 29, 2024 • edited Loading

Akash-Singh04 commented Apr 29, 2024

shivamsouravjha commented Apr 30, 2024

Akash-Singh04 commented Feb 17, 2024 •

edited

Loading

Describe if there is any unusual behaviour of your code(Write `NA` if there isn't)

shivamsouravjha commented Apr 29, 2024 •

edited

Loading