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.

Sign up for GitHub

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

Jump to bottom

Core Refactoring, Krkn Scenario Plugin API #694

Merged
merged 33 commits into from
Oct 3, 2024
Merged

Core Refactoring, Krkn Scenario Plugin API #694

merged 33 commits into from
Oct 3, 2024

Conversation

tsebastiani
Copy link
Collaborator

@tsebastiani tsebastiani commented Sep 12, 2024 •
edited
Loading

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

@tsebastiani tsebastiani changed the title Codebase refactoring, Krkn Scenario Plugin API introduction [IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction Sep 12, 2024
@tsebastiani tsebastiani force-pushed the plugin_api branch 2 times, most recently from 14879d1 to 47edcf8 Compare September 13, 2024 08:51
@tsebastiani tsebastiani mentioned this pull request Sep 13, 2024
Merged
@tsebastiani tsebastiani force-pushed the plugin_api branch 3 times, most recently from a8e5a87 to d04d35f Compare September 13, 2024 14:59
@tsebastiani tsebastiani marked this pull request as ready for review September 17, 2024 11:19
@tsebastiani tsebastiani force-pushed the plugin_api branch 6 times, most recently from 388197f to 9719473 Compare September 19, 2024 08:15
@tsebastiani tsebastiani force-pushed the plugin_api branch 3 times, most recently from 6694b13 to d1ea877 Compare September 26, 2024 13:34
chaitanyaenr
chaitanyaenr reviewed Oct 1, 2024
View reviewed changes
Copy link
Collaborator

@chaitanyaenr chaitanyaenr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nits

config/config.yaml Outdated Show resolved Hide resolved
chaitanyaenr
chaitanyaenr reviewed Oct 1, 2024
View reviewed changes
config/config.yaml Outdated Show resolved Hide resolved
chaitanyaenr
chaitanyaenr approved these changes Oct 1, 2024
View reviewed changes
Copy link
Collaborator

@chaitanyaenr chaitanyaenr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

config/config.yaml Outdated Show resolved Hide resolved
config/config.yaml Outdated Show resolved Hide resolved
@chaitanyaenr
Copy link
Collaborator

@tsebastiani funtional tests are failing

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

@tsebastiani
pvc_scenarios porting
fcdc4cf 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
service_disruption porting
fa45198 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
service_hijacking porting
7d06766 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
cluster_shut_down_scenarios porting
c14408e 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
syn_flood porting
4b540b1 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
time_scenarios porting
680536c 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
zone_outages porting
0059c25 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
ScenarioPluginFactory tests
f1d2e5e 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
unit tests update
d7ba0ee 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
pod_scenarios and post actions deprecated
e1b4c8e 
Signed-off-by: Tullio Sebastiani <[email protected]>

scenarios post_actions

Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
funtests and config update
fd633f4 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
run_krkn.py update
d3154cb 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
utils porting
168691f 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
API Documentation
434908c 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
container_scenarios porting
c27b644 
Signed-off-by: Tullio Sebastiani <[email protected]>

fix

Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
funtest fix
8d42392 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
document gif update
4f714fb 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
Documentation + tests update
fbf2d8e 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
removed example plugin
ea08b9b 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
global renaming
967bfe1 
Signed-off-by: Tullio Sebastiani <[email protected]>

test fix

Signed-off-by: Tullio Sebastiani <[email protected]>

test fix

Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
config.yaml typos
42eefdf 
Signed-off-by: Tullio Sebastiani <[email protected]>

typos

Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
removed plugin_scenarios from NativScenarioPlugin class
8b36550 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
pod_network_scenarios type added
d786abc 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
documentation update
cccd7b6 
Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani
krkn-lib update
3827b1f 
Signed-off-by: Tullio Sebastiani <[email protected]>

typo

Signed-off-by: Tullio Sebastiani <[email protected]>
@tsebastiani tsebastiani changed the title [IMPORTANT] Refactoring, Krkn Scenario Plugin API introduction Core Refactoring, Krkn Scenario Plugin API Oct 3, 2024
@tsebastiani tsebastiani merged commit d91172d into krkn-chaos:main Oct 3, 2024
5 of 7 checks passed
@tsebastiani tsebastiani deleted the plugin_api branch October 3, 2024 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@paigerube14 paigerube14 paigerube14 left review comments

@chaitanyaenr chaitanyaenr chaitanyaenr approved these changes

@psuriset psuriset Awaiting requested review from psuriset

@jaredoconnell jaredoconnell Awaiting requested review from jaredoconnell

@shahsahil264 shahsahil264 Awaiting requested review from shahsahil264

@jtydlack jtydlack Awaiting requested review from jtydlack

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tsebastiani @chaitanyaenr @paigerube14