Refactor orchestration Project class

opendevstack / ods-jenkins-shared-library

Shared Jenkins library which all ODS projects & components use - provisioning, SonarQube code scanning, Nexus publishing, OpenShift template based deployments and repository orchestration

Apache License 2.0

70 stars 57 forks source link

Refactor orchestration Project class #292

Open michaelsauter opened 4 years ago

michaelsauter commented 4 years ago

The Project class is rather similar to the Context of the component and quickstarter packages. I think it would be good to rename Project to Context.

Further, once this is done, it would be nice to extract a new class (named Project) which deals with the project configuration (loading metadata etc.)

@metmajer Thoughts?

metmajer commented 4 years ago

@michaelsauter please align with @martsec on planned refactorings and both make sure the work in progress of @jorge-romero and the team does not drift into merge hell. Coordinate who does what and when, and let's get through with this quickly.

FYI @clemensutschig @hrcornejo

michaelsauter commented 4 years ago

@metmajer At this stage, that is just a thought - I made that clearer now by labelling with question. I think a refactoring here would only make sense if driven by you, @martsec or @jorge-romero. I don't have the insight nor the cycles to do that. It just sounds right to me :)

hrcornejo commented 4 years ago

So before to start coding like no tomorrow, we would must agree a small design to avoid misunderstood with the goals of the issue.

Now:

Project with several inner classes: JiraDataItem, TestType and GampTopic

Posible aproach:

New class Context substitute of Project (same package)
This class has the data structure with al the information (like formerly Project).
This class remains the util getters over data structure.
New class JiraContext (package util) with JiraDataItem, TestType and GampTopic.
This class obtains all the info to load data in Context init.

Suggestions? @metmajer, @clemensutschig, @martsec, @jorge-romero, @michaelsauter

metmajer commented 4 years ago

@hrcornejo I suggest deferring larger refactorings to a point in time where there is less pressure to deliver. We can then sort out a better design together. The associated PR is outdated and in line with my suggestion, I would close it for now.