[feature]: Automatically add test reports folder to gitignore #1798
Conversation
|
@slayerjain Kindly review this and let me know if this implementation works! |
pkg/service/record/record.go
Outdated
| //create a gitignore file to ignore the test reports folder | ||
| gitIgnorePath := filepath.Join(r.config.Path, ".gitignore") | ||
| gitIgnoreData := []byte("./reports/\n") | ||
| err = os.WriteFile(gitIgnorePath, gitIgnoreData, 0777) |
There was a problem hiding this comment.
Why is this only in the record mode? What if the user starts the test mode directly by importing the testcases from somewhere?Also we need to check if the testreport was generated successfully, and only then add it to the gitignore file
There was a problem hiding this comment.
Refactored to a util function and added it to record and test command. We are calling the util function only if there is no error in the previous insertmock call
Signed-off-by: Akash Singh <[email protected]>
Signed-off-by: Akash Singh <[email protected]>
Signed-off-by: Akash Singh <[email protected]>
pkg/util.go
Outdated
| @@ -77,6 +77,30 @@ func IsTime(stringDate string) bool { | |||
| return false | |||
| } | |||
|
|
|||
| func CreateGitIgnore(logger *zap.Logger, filePath string) error { | |||
| gitIgnoreData := []byte("./reports/\n") | |||
There was a problem hiding this comment.
The path of the reports directory is incorrect
There was a problem hiding this comment.
tree -a
.
├── .gitignore
├── reports
│ ├── test-run-0
│ │ └── test-set-0-report.yaml
│ └── test-run-1
│ └── test-set-0-report.yaml
└── test-set-0
├── mocks.yaml
└── tests
├── test-1.yaml
├── test-2.yaml
└── test-3.yaml
5 directories, 7 files
If this is the folder structure of the keploy folder, could you please explain how is the path to the reports folder incorrect?
pkg/util.go
Outdated
| func CreateGitIgnore(logger *zap.Logger, filePath string) error { | ||
| gitIgnoreData := []byte("./reports/\n") | ||
| filePath = filePath + "/.gitignore" | ||
| gitIgnoreFIle, err := os.OpenFile(filePath, os.O_CREATE|os.O_WRONLY, 0777) |
There was a problem hiding this comment.
what is the gitignore file exists already?
There was a problem hiding this comment.
Added check for when gitignore file already exists
pkg/service/record/record.go
Outdated
| @@ -178,6 +178,10 @@ func (r *Recorder) Start(ctx context.Context) error { | |||
| r.telemetry.RecordedTestCaseMock(mock.GetKind()) | |||
| } | |||
| } | |||
| err := pkg.CreateGitIgnore(r.logger, r.config.Path) | |||
There was a problem hiding this comment.
Why do you need to create the gitignore file during the record mode? We only need to create it when reports are created.
There was a problem hiding this comment.
Apologies for the confusion with your previous comment
Why is this only in the record mode? What if the user starts the test mode directly by importing the testcases from somewhere?Also we need to check if the testreport was generated successfully, and only then add it to the gitignore file
Removed it from the record command
pkg/util.go
Outdated
| @@ -77,6 +77,30 @@ func IsTime(stringDate string) bool { | |||
| return false | |||
| } | |||
|
|
|||
| func CreateGitIgnore(logger *zap.Logger, filePath string) error { | |||
There was a problem hiding this comment.
I think this is a generic function so should be added to global utils instead of pkg utils.
There was a problem hiding this comment.
Refactored to global utils
Signed-off-by: Akash Singh <[email protected]>
Signed-off-by: Akash Singh <[email protected]>
|
@PranshuSrivastava Your requested changes have been made |
Related Issue
Closes: #1775
Describe the changes you've made
Type of change
Please let us know if any test cases are added
NIL
Please describe the tests(if any). Provide instructions how its affecting the coverage.
NIL
Describe if there is any unusual behaviour of your code(Write
NAif there isn't)A clear and concise description of it.
NIL
Checklist:
Screenshots (if any)