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

Provisioners' class name is confusing in some cases (and the same goes for test classes as well) #56

Open
fabiobrz opened this issue May 22, 2023 · 2 comments

Comments

@fabiobrz
Copy link
Member

fabiobrz commented May 22, 2023

Some provisioners have confusing names, e.g. WildflyImageOpenShiftProvisioner - which isn't clear at all about how the image is generated.

The same goes for some of the test classes, e.g.: MysqlImageTestCase..

We should perform a minor refactoring round to give better names to such components.


  • Environment: tools + testsuite
  • Steps to reproduce: N/A
@rsearls
Copy link
Collaborator

rsearls commented Jan 15, 2024

please provide more information about what qualities or factors should be used in creating better descriptive names.

@fabiobrz
Copy link
Member Author

fabiobrz commented Feb 2, 2024

please provide more information about what qualities or factors should be used in creating better descriptive names.

Thanks for looking into this issue, @rsearls.
IMO our main factor would be to let the user get the gist of the way an image is created, and how the provisioning process happens.
Intersmash provisions images to OpenShift, so naming a provisioner after a generic image, as in the example which is mentioned in this issue description, doesn't make sense. Maybe the main question that we should keep in mind when renaming would be: what is the technology this provisioner will use to provision the service? Helm Charts? Then use the HelmChartProvisioner, similarly it would work for the operator.
According to these rules, the example in the issue description would maybe need to be renamed to something like WildFlyS2iBasedImageOpenShiftProvisioner- just my personal taste.
The same would apply to the related test classes.

WDYT?

@fabiobrz fabiobrz added this to the IM2 - WIP milestone Feb 2, 2024
@fabiobrz fabiobrz moved this to Todo in Intersmash library Feb 2, 2024
@dosubot dosubot bot added the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Sep 19, 2024
@dosubot dosubot bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 19, 2024
@dosubot dosubot bot removed the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Oct 19, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Intersmash library Oct 19, 2024
@fabiobrz fabiobrz reopened this Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants