[IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction #694

tsebastiani · 2024-09-12T16:03:01Z

main goals:

Introduce an API for the Krkn Scenario Plugins
Introduce a dynamic plugin loader for all the classes implementing the API
Convert all the existing scenarios in classes that implement the API
Define a strict naming convention for Scenario Plugins validated by the loader to give to the comunity a clear guideline on how to implement new scenarios (MVC Frameworks approach)
reduce the run_krkn.py line numbers and complexity
minimize the code changes in the run_krkn.py to introduce a new scenario (plugins are loaded dynamically)
Produce a clear documentation on how to develop new Krkn scenarios
Unit test the scenarios

main benefits:

speed up the on-boarding on scenario development (community and new team members)
create more traction around the project
increase the test coverage
streamline the codebase to increase readability

docs/scenario_plugin_api.md

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com> scenarios post_actions Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com> fix Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

chaitanyaenr

Minor nits

chaitanyaenr · 2024-10-01T13:12:44Z

config/config.yaml

-    distribution: kubernetes                                # Distribution can be kubernetes or openshift
-    kubeconfig_path: ~/.kube/config                        # Path to kubeconfig
+    distribution: openshift                                # Distribution can be kubernetes or openshift
+    kubeconfig_path: /home/tsebasti/Scrap/ocp/auth/kubeconfig                     # Path to kubeconfig


We need to switch it back to default location under $HOME

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

chaitanyaenr · 2024-10-01T13:23:57Z

config/config.yaml

        - application_outages:
            - scenarios/openshift/app_outage.yaml
        - container_scenarios:                             # List of chaos pod scenarios to load
-            - - scenarios/openshift/container_etcd.yml
+            - scenarios/openshift/container_etcd.yml
        - plugin_scenarios:


The suggested change is out of scope of this PR but would be good to add as part of the refactoring:

It would be easy for the users to understand if we rename plugin_scenarios to a appropriate name describing the scenario instead - pod_disruptions, hog_scenarios for instance. Also might be better to have the configs under scenarios/openshift and scenarios/kubernetes instead of scenarios/arcaflow to have everything under similar dir structure and avoid any confusion for the end users.

Thoughts?

chaitanyaenr

Nice work as always @tsebastiani! Minor nits, other than that it's good for merge!

chaitanyaenr · 2024-10-01T21:24:28Z

config/config.yaml

+        - vmware_node_scenarios:
+            - scenarios/openshift/vmware_node_scenarios.yml
+        - ibmcloud_node_scenarios:
+            - scenarios/openshift/ibmcloud_node_scenarios.yml
        - node_scenarios:                                  # List of chaos node scenarios to load
            - scenarios/openshift/aws_node_scenarios.yml
        - plugin_scenarios:


We might want to delete this section as it's a duplicate.

chaitanyaenr · 2024-10-01T21:24:59Z

config/config.yaml

-    distribution: kubernetes                                # Distribution can be kubernetes or openshift
-    kubeconfig_path: ~/.kube/config                        # Path to kubeconfig
+    distribution: openshift                                # Distribution can be kubernetes or openshift
+    kubeconfig_path: /home/tsebasti/.kube/config                     # Path to kubeconfig


Need to switch it back to ~/.kube/config

chaitanyaenr · 2024-10-01T21:26:31Z

@tsebastiani funtional tests are failing

Error: -01 16:49:36,210 [ERROR] impossible to find scenario application_outages, plugin not found. Exiting

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com> test fix Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com> test fix Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

tsebastiani requested review from chaitanyaenr, paigerube14, psuriset, jaredoconnell, shahsahil264 and jtydlack September 12, 2024 16:03

tsebastiani changed the title ~~Codebase refactoring, Krkn Scenario Plugin API introduction~~ [IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction Sep 12, 2024

tsebastiani force-pushed the plugin_api branch 2 times, most recently from 14879d1 to 47edcf8 Compare September 13, 2024 08:51

tsebastiani mentioned this pull request Sep 13, 2024

[IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction krkn-chaos/krkn-lib#123

Open

tsebastiani force-pushed the plugin_api branch 3 times, most recently from a8e5a87 to d04d35f Compare September 13, 2024 14:59

tsebastiani marked this pull request as ready for review September 17, 2024 11:19

tsebastiani force-pushed the plugin_api branch 6 times, most recently from 388197f to 9719473 Compare September 19, 2024 08:15

paigerube14 reviewed Sep 19, 2024

View reviewed changes

docs/scenario_plugin_api.md Outdated Show resolved Hide resolved

tsebastiani force-pushed the plugin_api branch from a07945e to 71b14ac Compare September 25, 2024 15:25

tsebastiani added 8 commits September 26, 2024 14:02

relocated shared libraries from kraken to krkn folder

d4fed8b

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

AbstractScenarioPlugin and ScenarioPluginFactory

ee91c22

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

application_outage porting

b53940a

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

arcaflow_scenarios porting

22cd681

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

managedcluster_scenarios porting

6c0f1d8

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

network_chaos porting

2a0b899

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

node_actions porting

c111c52

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

plugin_scenarios porting

651165d

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

tsebastiani added 15 commits September 26, 2024 14:03

pvc_scenarios porting

f208d78

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

service_disruption porting

b6e1b4d

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

service_hijacking porting

0f77b91

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

cluster_shut_down_scenarios porting

70408ae

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

syn_flood porting

5b1c442

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

time_scenarios porting

4c323b1

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

zone_outages porting

d455adb

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

ScenarioPluginFactory tests

d992b0e

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

unit tests update

bdf1129

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

pod_scenarios and post actions deprecated

af2810f

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com> scenarios post_actions Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

funtests and config update

64fbbfd

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

run_krkn.py update

81a7d05

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

utils porting

b879a99

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

API Documentation

19e0da7

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

requirements

ff3b097

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

tsebastiani force-pushed the plugin_api branch from 71b14ac to ff3b097 Compare September 26, 2024 12:04

tsebastiani added 2 commits September 26, 2024 15:34

container_scenarios porting

0ecef34

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com> fix Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

funtest fix

d1ea877

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

tsebastiani force-pushed the plugin_api branch from 6694b13 to d1ea877 Compare September 26, 2024 13:34

tsebastiani added 2 commits September 26, 2024 16:14

document gif update

6e577d6

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

Documentation + tests update

e014c2b

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

chaitanyaenr reviewed Oct 1, 2024

View reviewed changes

removed example plugin

b989ed8

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

chaitanyaenr reviewed Oct 1, 2024

View reviewed changes

tsebastiani force-pushed the plugin_api branch from 504e36a to dd5b5cb Compare October 1, 2024 16:38

chaitanyaenr approved these changes Oct 1, 2024

View reviewed changes

tsebastiani force-pushed the plugin_api branch from dd5b5cb to c65f8f2 Compare October 2, 2024 07:24

global renaming

378925e

Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com> test fix Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com> test fix Signed-off-by: Tullio Sebastiani <tsebasti@redhat.com>

tsebastiani force-pushed the plugin_api branch from c65f8f2 to 378925e Compare October 2, 2024 07:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction #694

[IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction #694

tsebastiani commented Sep 12, 2024 •

edited

Loading

chaitanyaenr left a comment

chaitanyaenr Oct 1, 2024

chaitanyaenr Oct 1, 2024

chaitanyaenr left a comment

chaitanyaenr Oct 1, 2024

chaitanyaenr Oct 1, 2024

chaitanyaenr commented Oct 1, 2024

[IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction #694

Are you sure you want to change the base?

[IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction #694

Conversation

tsebastiani commented Sep 12, 2024 • edited Loading

main goals:

main benefits:

chaitanyaenr left a comment

Choose a reason for hiding this comment

chaitanyaenr Oct 1, 2024

Choose a reason for hiding this comment

chaitanyaenr Oct 1, 2024

Choose a reason for hiding this comment

chaitanyaenr left a comment

Choose a reason for hiding this comment

chaitanyaenr Oct 1, 2024

Choose a reason for hiding this comment

chaitanyaenr Oct 1, 2024

Choose a reason for hiding this comment

chaitanyaenr commented Oct 1, 2024

tsebastiani commented Sep 12, 2024 •

edited

Loading