Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating test instructions in TESTING.md #155

Merged
merged 9 commits into from
Aug 15, 2024

Conversation

lukeatdell
Copy link
Contributor

Description

Updating test instructions in TESTING.md to clarify instructions and renaming unit-test make recipe to be more descriptive and consistent with other CSM repos.

  • Renaming "gen-coverage" target to "unit-test".
  • Updating github actions for running unit tests.
  • Clarifying test execution instructions and adding instructions to test repctl in TESTING.md.
  • Addressing areas that would require a user to have root or superuser permissions.

GitHub Issues

List the GitHub issues impacted by this PR:

GitHub Issue #
dell/csm#1422

Checklist:

  • I have performed a self-review of my own code to ensure there are no formatting, vetting, linting, or security issues
  • I have verified that new and existing unit tests pass locally with my changes
  • I have not allowed coverage numbers to degenerate
  • I have maintained at least 90% code coverage
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have maintained backward compatibility

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Executing new make recipes
    image
    image
    image

- install controller-gen and kustomize tools using "go install".
- remove tools.go in favor of install method above.
- remove module dependency from go.mod for controller-gen and kustomize.
- compilation recipes have "build" prefix.
- added "build" recipe to compile all binaries for replication.
- updated readme to reflect above changes.
- renaming "gen-coverage" target to "unit-test".
- updating testing README for clearer instructions and to add instructions for repctl tests.
- updating github actions for running unit tests.
Makefile Outdated Show resolved Hide resolved
TESTING.md Outdated Show resolved Hide resolved
santhoshatdell
santhoshatdell previously approved these changes Aug 14, 2024
mbasha-dell
mbasha-dell previously approved these changes Aug 15, 2024
Base automatically changed from usr/luke-lau/krv-26950-readme-update to main August 15, 2024 13:20
@lukeatdell lukeatdell dismissed stale reviews from mbasha-dell and santhoshatdell August 15, 2024 13:20

The base branch was changed.

@lukeatdell lukeatdell merged commit d25d148 into main Aug 15, 2024
8 checks passed
@lukeatdell lukeatdell deleted the usr/luke-lau/update-test-readme branch August 15, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants