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

refactor : Renaming certsuite command tool #2379

Merged
merged 9 commits into from
Sep 4, 2024
Merged

refactor : Renaming certsuite command tool #2379

merged 9 commits into from
Sep 4, 2024

Conversation

bnshr
Copy link
Contributor

@bnshr bnshr commented Aug 27, 2024

Includes:

  • Claim structure change due to renaming
  • Commented out the unit tests in some subcommands which would be worked on later, mentioned in the JIRA Issue
  • Configured all scripts for the testing in QE and DCI
  • Probe image params modified to make one param "certsuite-probe-image"

Dependent Issues / PRs.

Copy link
Contributor

@greyerof greyerof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The application is now officially called "Red Hat Best Practices Test Suite for Kubernetes", and it's no longer meant to test CNFs, but any type of workload. However, as it's a too long name/text to be used everytime, to me it's ok to use "Certification Suite" or "CertSuite" instead. I believe there's no need for any CNF/TNF/Workload prefixes in most (if not all) occurrences.

cmd/certsuite/claim/compare/compare.go Outdated Show resolved Hide resolved
cmd/certsuite/claim/compare/compare.go Outdated Show resolved Hide resolved
cmd/certsuite/claim/compare/versions/versions_test.go Outdated Show resolved Hide resolved
cmd/certsuite/pkg/claim/claim.go Outdated Show resolved Hide resolved
@@ -39,8 +39,8 @@ func NewCommand() *cobra.Command {
runCmd.PersistentFlags().Bool("include-web-files", false, "Save web files in the configured output folder")
runCmd.PersistentFlags().Bool("enable-data-collection", false, "Allow sending test results to an external data collector")
runCmd.PersistentFlags().Bool("create-xml-junit-file", false, "Create a JUnit file with the test results")
runCmd.PersistentFlags().String("tnf-image-repository", "quay.io/redhat-best-practices-for-k8s", "The repository where TNF images are stored")
runCmd.PersistentFlags().String("tnf-debug-image", "certsuite-probe:v0.0.7", "Name of the certsuite-probe image")
runCmd.PersistentFlags().String("certsuite-image-repository", "quay.io/redhat-best-practices-for-k8s", "The repository where Certsuite images are stored")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is non-backward compatible change. @sebrandon1 , probably DCI, and QE will need to update to use these new flag names. Also the next certsuite release notes should reflect this changes.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please tell us what are the variables we need to change, to adapt our code to this new change. Thanks!

cmd/certsuite/run/run.go Outdated Show resolved Hide resolved
cmd/certsuite/run/run.go Outdated Show resolved Hide resolved
cmd/certsuite/run/run.go Outdated Show resolved Hide resolved
@bnshr bnshr changed the title Renaming tool Renaming certsuite command tool Aug 29, 2024
Copy link
Member

@sebrandon1 sebrandon1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some more comments

docs/test-spec-implementation.md Show resolved Hide resolved
cmd/certsuite/generate/config/const.go Show resolved Hide resolved
@dcibot
Copy link
Collaborator

dcibot commented Sep 4, 2024

@ramperher
Copy link
Collaborator

@bnshr , DCI playbooks need to be adapted to the new variables, please tell us when this change is ready for testing, then we'll integrate the update, thanks!

@bnshr
Copy link
Contributor Author

bnshr commented Sep 4, 2024

@bnshr , DCI playbooks need to be adapted to the new variables, please tell us when this change is ready for testing, then we'll integrate the update, thanks!

We are no longer using two variables - "tnf-image-repository" and "tnf-debug-image" and instead of these using a new variable "certsuite-probe-image" which refers to the image of the probe/debug pod. This PR is ready to be merged.

@sebrandon1 sebrandon1 merged commit 62f679d into main Sep 4, 2024
13 of 25 checks passed
@sebrandon1 sebrandon1 deleted the renaming-tool branch September 4, 2024 15:33
@dcibot
Copy link
Collaborator

dcibot commented Sep 4, 2024

@ramperher
Copy link
Collaborator

I'm wondering why this has been merged without having the fix for DCI before...

@sebrandon1
Copy link
Member

@ramperher Sorry about that. Can the fix for the flags be added after or should I revert?

@ramperher
Copy link
Collaborator

ramperher commented Sep 4, 2024

@ramperher Sorry about that. Can the fix for the flags be added after or should I revert?

I've added the fix here: redhatci/ansible-collection-redhatci-ocp#421, we can keep this PR without problems

@bnshr bnshr changed the title Renaming certsuite command tool refactor : Renaming certsuite command tool Sep 5, 2024
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.

5 participants