keploy icon indicating copy to clipboard operation
keploy copied to clipboard

Add comments in keploy yamls to make better editable experience

Open Arpit529Srivastava opened this issue 10 months ago • 21 comments

This pull request includes significant updates to the config/config.go file, focusing on adding detailed comments to clarify the editability of various configuration fields and methods. The most important changes include adding comments to the Config struct fields, updating nested configuration structs, and enhancing helper functions with comments.

Key Changes:

Configuration Struct Enhancements:

  • Added comments to the Config struct fields to specify whether each field is editable by users or for internal use.
  • Updated nested structs such as UtGen, Templatize, Record, ReRecord, Contract, Mappings, Normalize, BypassRule, Filter, Test, and Globalnoise with similar comments indicating editability. [1] [2]

Helper Functions:

  • Added comments to helper functions like SetByPassPorts, GetByPassPorts, SetSelectedTests, SetSelectedServices, SetSelectedContractTests, and SetSelectedTestsNormalize to specify their internal use. [1] [2]

These changes aim to improve the clarity and maintainability of the configuration code by explicitly stating which fields and methods are intended for user modification and which are for internal purposes.

Closes: #2014

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 test plan followed

Please describe the tests(if any). Provide instructions how its affecting the coverage.

Checklist:

  • [ ] Have you read the Contributing Guidelines on issues?
  • [ ] My code follows the style guidelines of this project.
  • [ ] I have commented my code, particularly in hard-to-understand areas.
  • [ ] I have made corresponding changes to the documentation.
  • [ ] New and existing unit tests pass locally with my changes.

Arpit529Srivastava avatar Mar 24 '25 21:03 Arpit529Srivastava

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

github-actions[bot] avatar Mar 24 '25 21:03 github-actions[bot]

The CLA check failed. Please ensure you have:

  • Signed the CLA by commenting 'I have read the CLA Document and I hereby sign the CLA.'
  • Used the correct email address in your commits (matches the one you used to sign the CLA).

After fixing these issues, comment 'recheck' to trigger the workflow again.

github-actions[bot] avatar Mar 24 '25 21:03 github-actions[bot]

I have read the CLA Document and I hereby sign the CLA

Arpit529Srivastava avatar Mar 24 '25 21:03 Arpit529Srivastava

recheck

Arpit529Srivastava avatar Mar 24 '25 21:03 Arpit529Srivastava

Let me know if you have any issue regarding this PR.

Arpit529Srivastava avatar Mar 24 '25 21:03 Arpit529Srivastava

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 10:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 10:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 10:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 11:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 11:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 11:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 12:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 12:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 12:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 20:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 20:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 20:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 21:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 21:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy-staging[bot] avatar Apr 14 '25 21:04 keploy-staging[bot]

To generate Unit Tests for this PR, please click here

keploy[bot] avatar Apr 15 '25 15:04 keploy[bot]