This is an overview of the Actions framework that appears in the 1.3.0 version of convert2rhel. Actions are a more modular way to write checks and revertable changes for convert2rhel. We're using them to implement a pre-conversion report. This may be interesting for those who are working on convert2rhel or anyone who is interested in writing their own plugin framework.

1. Convert2rhel Development: The Actions
Framework

2. 05/08/2023 2
Goals of this Presentation?

3. 05/08/2023 3
Goals of this Presentation?
●
Write a new Action

4. 05/08/2023 4
Goals of this Presentation?
●
Write a new Action
●
Fix bugs in the Action Framework

5. 05/08/2023 5
Writing New Actions: File Layout

6. 05/08/2023 6
Writing New Actions: File Layout
●
Python modules live in convert2rhel/actions/{stage}/{action}.py

7. 05/08/2023 7
Writing New Actions: File Layout
●
Python modules live in convert2rhel/actions/{stage}/{action}.py
●
All Actions in a stage run before the next stage

8. 05/08/2023 8
Writing New Actions: File Layout
●
Python modules live in convert2rhel/actions/{stage}/{action}.py
●
All Actions in a stage run before the next stage
●
Currently two stages:
●
system_checks
●
pre_ponr_changes

10. 05/08/2023 10
Writing New Actions: Code Structure
●
Each Action is a class in a module

11. 05/08/2023 11
Writing New Actions: Code Structure
●
Each Action is a class in a module
●
Must contain subclasses of convert2rhel.actions.Action
●
Must set a unique id
●
Must implement a run() method
●
Should call super().__init__()
●
Should log a task header with logger.task()
●
Default result is success. Specify a different result with set_result()
followed by return

17. 05/08/2023 17
Writing New Actions: Code Structure
●
Each Action is a class in a module
●
Must contain subclasses of convert2rhel.actions.Action
●
Must set a unique id
●
Must implement a run() method
●
Should call super().__init__()
●
Should log a task header with logger.task()
●
Default result is success. Specify a different result with set_result()
followed by return

18. 05/08/2023 18
Writing New Actions: Code Structure
●
Each Action is a class in a module
●
Must contain subclasses of convert2rhel.actions.Action
●
Must set a unique id
●
Must implement a run() method
●
Should call super().__init__()
●
Should log a task header with logger.task()
●
Default result is success. Specify a different result with set_result()
followed by return
●
Dependencies

21. 05/08/2023 21
Writing New Actions: Code Structure
●
Each Action is a class in a module
●
Must contain subclasses of convert2rhel.actions.Action
●
Must set a unique id
●
Must implement a run() method
●
Should call super().__init__()
●
Should log a task header with logger.task()
●
Default result is success. Specify a different result with set_result()
followed by return
●
Dependencies

22. 05/08/2023 22
The Action Framework

23. 05/08/2023 23
The Action Framework
●
Two main entry points

24. 05/08/2023 24
The Action Framework
●
Two main entry points
●
actions.run_actions()
●
actions.report.summary()

27. 05/08/2023 27
run_actions()
●
run_actions() has four tasks

28. 05/08/2023 28
run_actions()
●
run_actions() has four tasks
●
Set up the Stages
●
Check the dependencies
●
Run the actions
●
Format the results as a dictionary

34. 05/08/2023 34
A brief word on Stages

35. 05/08/2023 35
A brief word on Stages
●
Discover the Actions in this Stage
●
Figure out the dependency order of Actions
●
Run the Actions

36. 05/08/2023 36
A brief word on Stages
●
Discover the Actions in this Stage
●
Stage("system_checks", "Check whether system is ready for
conversion", pre_ponr_changes)
●
Helper function, get_actions()
●
All subclasses of convert2rhel.actions.Action...
●
… inside of a specific subdirectory of convert2rhel/actions
●
Knows about Stages that come afterwards
●
Figure out the dependency order of Actions
●
Run the Actions

37. 05/08/2023 37
A brief word on Stages
●
Discover the Actions in this Stage
●
Figure out the dependency order of Actions
●
Helper function resolve_action_order()
●
Used for both Stage.check_dependencies() and Stage.run()
●
Knows about all Stages which come afterwards
●
Run the Actions

38. 05/08/2023 38
A brief word on Stages
●
Discover the Actions in this Stage
●
Figure out the dependency order of Actions
●
Run the Actions
●
Run in order
●
Record failures
●
Skip tests whose dependencies have failed
●
Catch unhandled exceptions with a generic Error.

39. 05/08/2023 39
The Report

40. 05/08/2023 40
The Report
●
convert2rhel.actions.report.summary()

41. 05/08/2023 41
The Report
●
convert2rhel.actions.report.summary()
●
All data is in the results

42. 05/08/2023 42
The Report
●
convert2rhel.actions.report.summary()
●
All data is in the results
●
Formats the data
●
Can filter out successes
●
Colorizes
●
Indents
●
Sorts by severity

43. 05/08/2023 43
The Report
●
convert2rhel.actions.report.summary()
●
All data is in the results
●
Formats the data
●
Can filter out successes
●
Colorizes
●
Indents
●
Sorts by severity
●
Future:
●
Add Warnings and other messages to the report

44. 05/08/2023 44
The Report
●
convert2rhel.actions.report.summary()
●
All data is in the results
●
Formats the data
●
Can filter out successes
●
Colorizes
●
Indents
●
Sorts by severity
●
Future:
●
Add Warnings and other messages to the report
●
A json version of the report for other programs to consume

45. 05/08/2023 45
People and places
●
Pull Request:
●
https://github.com/oamg/convert2rhel/pull/761
●
Preston and Rodolfo: Writing Actions
●
Rodolfo: Report
●
Toshio: Dependencies, Stages, and the Framework in general