Feat: Added --disableANSI Flag to CLI to enable/disable ANSI Color Codes #1526

Akash-Singh04 · 2024-02-07T19:05:28Z

Related Issue

Added --enableANSI CLI Flag to enable/disable colour encoding.

Closes: #1520

Describe the changes you've made

Added --enableANSIColor PersistantFlag to CLI to enable/disable ASNI Color Codes
Example of enabled ANSI Colors in Log files:
Added it to testCmd inorder to prevent ASNI Color Codes being rendered in this part of report:

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)

NIL

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)

Usage:

Original	Updated
**

**


**

** |

|

Below is an attached video of the implementation in action:

bandicam.2024-02-09.03-38-03-218.2.1.mp4

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

Akash-Singh04 · 2024-02-07T19:07:26Z

@slayerjain Kindly review the PR and let me know if any changes are required.

cmd/test.go

pkg/service/test/test.go

cmd/root.go

PranshuSrivastava · 2024-02-08T18:25:27Z

Also fix the merge conflicts please

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

…eflag

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

Akash-Singh04 · 2024-02-09T08:58:50Z

@PranshuSrivastava Kindly review this PR and have a look at the attached video to better understand the implementation, Thank You!

cmd/root.go

pkg/service/test/test.go

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

…eflag

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

pkg/service/test/test.go

cmd/root.go

pkg/service/test/test.go

utils/utils.go

…eflag

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

… into colorcodeflag

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

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

PranshuSrivastava · 2024-04-11T01:59:30Z

Ok, the first log can be left colored as we haven't fully read the flags by that time, but the second log is being printed by you right? So why can't you just print it after changing the colors instead of before it?

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

… into colorcodeflag

…eflag

Akash-Singh04 · 2024-04-11T17:02:45Z

@PranshuSrivastava Your requested changes have been made

PranshuSrivastava · 2024-04-15T07:45:57Z

cli/provider/cmd.go

@@ -219,6 +219,7 @@ func (c *CmdConfigurator) AddFlags(cmd *cobra.Command) error {
 	case "keploy":
 		cmd.PersistentFlags().Bool("debug", c.cfg.Debug, "Run in debug mode")
 		cmd.PersistentFlags().Bool("disableTele", c.cfg.DisableTele, "Run in telemetry mode")
+		cmd.PersistentFlags().Bool("enableANSIColor", c.cfg.EnableANSIColor, "Enable ANSI color in logs")


The changes are working correctly, just change the name of this flag to "enableANSI". Currently the name feels too long to type for a flag.

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

…eflag

… into colorcodeflag

Akash-Singh04 · 2024-04-15T08:25:11Z

@PranshuSrivastava Your requested changes have been made

re-Tick · 2024-04-18T12:43:53Z

Hey @Akash-Singh04, I think the flag should be disableANSIColor since, the value for the enableANSIColor is true by default. Instead the value can be false and flag can be --disableANSIColor. @PranshuSrivastava would that be ok right?

PranshuSrivastava · 2024-04-18T13:22:58Z

@re-Tick Yes thats good. I just want the name to be short

…eflag

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

Akash-Singh04 · 2024-04-18T13:56:37Z

@re-Tick @PranshuSrivastava Your requested changes have been made

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

PranshuSrivastava

LGTM

Feat: Added --enableColor Flag to CLI to enable/disable ASNI Color Codes

627b49b

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

Merge branch 'main' into colorcodeflag

8434b5c

PranshuSrivastava requested changes Feb 8, 2024

View reviewed changes

cmd/test.go Outdated Show resolved Hide resolved

cmd/test.go Outdated Show resolved Hide resolved

pkg/service/test/test.go Outdated Show resolved Hide resolved

cmd/root.go Outdated Show resolved Hide resolved

Akash-Singh04 added 3 commits February 9, 2024 02:14

Fixed enableASNIColor flag for test command

965fe96

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

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

1b18814

…eflag

Fixed RootCmd ASNI Color code generation

b855220

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

Akash-Singh04 requested a review from PranshuSrivastava February 9, 2024 08:57

PranshuSrivastava requested changes Feb 9, 2024

View reviewed changes

cmd/root.go Outdated Show resolved Hide resolved

pkg/service/test/test.go Outdated Show resolved Hide resolved

pkg/service/test/test.go Outdated Show resolved Hide resolved

Akash-Singh04 changed the title ~~Feat: Added --enableColor Flag to CLI to enable/disable ASNI Color Codes~~ Feat: Added --enableColor Flag to CLI to enable/disable ANSIColor Codes Feb 12, 2024

Akash-Singh04 changed the title ~~Feat: Added --enableColor Flag to CLI to enable/disable ANSIColor Codes~~ Feat: Added --enableColor Flag to CLI to enable/disable ANSI Color Codes Feb 12, 2024

Akash-Singh04 added 3 commits February 12, 2024 17:19

Refactored pp package and chanegd flag name

35f56c1

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

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

c3d485f

…eflag

Fixed Merge CONFLICTS

1f50d43

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

Akash-Singh04 requested a review from PranshuSrivastava February 12, 2024 12:01

Akash-Singh04 changed the title ~~Feat: Added --enableColor Flag to CLI to enable/disable ANSI Color Codes~~ Feat: Added --enableANSIColor Flag to CLI to enable/disable ANSI Color Codes Feb 12, 2024

Akash-Singh04 and others added 3 commits February 13, 2024 17:48

Merge branch 'main' into colorcodeflag

a13b36f

Merge branch 'main' into colorcodeflag

24929b1

Merge branch 'main' into colorcodeflag

6b6611c

PranshuSrivastava requested changes Feb 15, 2024

View reviewed changes

pkg/service/test/test.go Outdated Show resolved Hide resolved

cmd/root.go Outdated Show resolved Hide resolved

pkg/service/test/test.go Outdated Show resolved Hide resolved

pkg/service/test/test.go Outdated Show resolved Hide resolved

utils/utils.go Outdated Show resolved Hide resolved

Akash-Singh04 and others added 5 commits February 16, 2024 15:51

Merge branch 'main' into colorcodeflag

d999aa9

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

7b7cb91

…eflag

Addressed review comments

7ef0211

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

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

4295b76

… into colorcodeflag

Removed logs.txt

4015df2

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

Akash-Singh04 requested a review from PranshuSrivastava February 17, 2024 00:54

Akash-Singh04 added 2 commits February 17, 2024 16:55

Merge branch 'main' into colorcodeflag

2db9643

Merge branch 'main' into colorcodeflag

b979e2c

Akash-Singh04 and others added 4 commits April 9, 2024 17:01

Fixed merge conflicts

04c18b5

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

Fixed merge conflicts

1a5984e

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

Fixed Lint

2659458

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

Merge branch 'main' into colorcodeflag

ab3942b

Akash-Singh04 added 3 commits April 11, 2024 22:30

Added log after color encoding is disabled

80d5821

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

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

64fb934

… into colorcodeflag

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

9033c3e

…eflag

Merge branch 'main' into colorcodeflag

e773ecc

PranshuSrivastava requested changes Apr 15, 2024

View reviewed changes

Akash-Singh04 added 3 commits April 15, 2024 13:53

Changed flag name to enableANSI

c3274e1

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

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

21bd6c7

…eflag

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

50bb8b3

… into colorcodeflag

Akash-Singh04 requested a review from PranshuSrivastava April 15, 2024 08:24

Merge branch 'main' into colorcodeflag

b05bc16

Akash-Singh04 changed the title ~~Feat: Added --enableANSIColor Flag to CLI to enable/disable ANSI Color Codes~~ Feat: Added --enableANSI Flag to CLI to enable/disable ANSI Color Codes Apr 15, 2024

Merge branch 'main' into colorcodeflag

53c6fb9

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

bb438b7

…eflag

Akash-Singh04 changed the title ~~Feat: Added --enableANSI Flag to CLI to enable/disable ANSI Color Codes~~ Feat: Added --disableANSI Flag to CLI to enable/disable ANSI Color Codes Apr 18, 2024

Replaced flag to --disableANSI

32140be

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

Fixed lint

7defb8b

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

PranshuSrivastava approved these changes Apr 19, 2024

View reviewed changes

re-Tick merged commit 5645ab5 into keploy:main Apr 19, 2024
13 of 14 checks passed

github-actions bot locked and limited conversation to collaborators Apr 19, 2024

Akash-Singh04 deleted the colorcodeflag branch April 24, 2024 15:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Added --disableANSI Flag to CLI to enable/disable ANSI Color Codes #1526

Feat: Added --disableANSI Flag to CLI to enable/disable ANSI Color Codes #1526

Akash-Singh04 commented Feb 7, 2024 •

edited

Loading

Akash-Singh04 commented Feb 7, 2024

PranshuSrivastava commented Feb 8, 2024

Akash-Singh04 commented Feb 9, 2024

PranshuSrivastava commented Apr 11, 2024

Akash-Singh04 commented Apr 11, 2024

PranshuSrivastava Apr 15, 2024

Akash-Singh04 Apr 15, 2024

Akash-Singh04 commented Apr 15, 2024

re-Tick commented Apr 18, 2024

PranshuSrivastava commented Apr 18, 2024

Akash-Singh04 commented Apr 18, 2024

PranshuSrivastava left a comment

Feat: Added --disableANSI Flag to CLI to enable/disable ANSI Color Codes #1526

Feat: Added --disableANSI Flag to CLI to enable/disable ANSI Color Codes #1526

Conversation

Akash-Singh04 commented Feb 7, 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)

Usage:

Akash-Singh04 commented Feb 7, 2024

PranshuSrivastava commented Feb 8, 2024

Akash-Singh04 commented Feb 9, 2024

PranshuSrivastava commented Apr 11, 2024

Akash-Singh04 commented Apr 11, 2024

PranshuSrivastava Apr 15, 2024

Choose a reason for hiding this comment

Akash-Singh04 Apr 15, 2024

Choose a reason for hiding this comment

Akash-Singh04 commented Apr 15, 2024

re-Tick commented Apr 18, 2024

PranshuSrivastava commented Apr 18, 2024

Akash-Singh04 commented Apr 18, 2024

PranshuSrivastava left a comment

Choose a reason for hiding this comment

Akash-Singh04 commented Feb 7, 2024 •

edited

Loading

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