-
Task
-
Resolution: Done-Errata
-
Major
-
None
Messages need to be usable by third party tools, not just convert2rhel. Specifically, insights for the Q3 mvp and satellite will need the ability to construct messages from what convert2rhel returns. To do that, we need convert2rhel to provide four message fields in the assessment json.
Doing this means that we need to construct a complete message from the four fields inside of convert2rhel as well.
Acceptance Criteria
- In the action framework:
- In ActionMessageBase split the message parameter into four new attributes, title, description, diagnosis, and remediation which are set from new parameters to {}init{}. These variables are strings holding those four parts of any message that we return.
- These attributes are included in the dictionary representation of ActionMessage and ActionResult.
- The Action.set_result() and Action.add_message() methods each take new parameters to set these instead of the current single message parameter..
- In convert2rhel.action.report.summary()
- construct the message from those values.
-
-
- We will combine the four strings to make a message in the report similar to what is currently displayed.
- the string should be valid markdown but we will just display the plain text. It's insights and other external tools that should be able to rely on it being markdown.
-
- In the action plugins:
- For each result and message that the Actions currently emit, we need to split the message element into four parts for title, description, diagnosis, and remediation.
- title and description should be static data (nothing determined at runtime). diagnosis and remediation can use variables determined at runtime to complete their message.
- Deprecate and remove (when we can) the message field from the Action return data. Ask at cabal, we may be able to remove this for the upcoming release (since we did not have json output before AND assessment as a whole is considered experimental)
- is cloned by
-
RHELC-1106 Construct convert2rhel assessment messages from templates and return them in json
- To Do
- is depended on by
-
RHELC-1093 Sync messages from insights to convert2rhel
- To Do
-
RHELC-1106 Construct convert2rhel assessment messages from templates and return them in json
- To Do
-
RHELC-1107 Write a schema for the json return data and use it to integration test the output
- Closed
- is triggered by
-
RHELC-1032 Adapting pre-conversion analysis to Insights needs for MVP
- Closed
- links to
-
RHEA-2023:120152 convert2rhel bug fix and enhancement update
-
RHEA-2023:120153 convert2rhel bug fix and enhancement update