-
Notifications
You must be signed in to change notification settings - Fork 28
Add configurable fault injection for negative testing #591
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| fault_config { | ||
| gnoi_faults { | ||
| rpc_method: "/gnoi.system.System/Reboot" | ||
| faults { | ||
| msg_id: "reboot_fault_1" | ||
| status { | ||
| code: 10 | ||
| message: "Simulated reboot failure - system maintenance mode" | ||
| } | ||
| } | ||
| faults { | ||
| msg_id: "reboot_fault_2" | ||
| status { | ||
| code: 14 | ||
| message: "Simulated reboot failure - resource temporarily unavailable" | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # Config-Based Fault Injection | ||
|
|
||
| ## Overview | ||
|
|
||
| Config-based fault injection allows you to pre-configure fault responses for specific gNOI RPC methods directly in the Lemming configuration file. This provides deterministic, reproducible fault scenarios for integration testing without requiring external fault injection clients. | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Basic Structure | ||
|
|
||
| ```protobuf | ||
| fault_config { | ||
| gnoi_faults { | ||
| rpc_method: "/gnoi.system.System/Reboot" | ||
| faults { | ||
| msg_id: "reboot_fault_1" | ||
| status { | ||
| code: 3 # INVALID_ARGUMENT | ||
| message: "Simulated reboot failure" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Configuration Fields | ||
|
|
||
| - **`rpc_method`**: Full gRPC method name (e.g., `/gnoi.system.System/Reboot`) | ||
| - **`faults`**: Array of fault messages to inject | ||
| - **`msg_id`**: Unique identifier for the fault | ||
| - **`msg`**: Optional modified request/response message | ||
| - **`status`**: gRPC status to return (code and message) | ||
|
|
||
| ## Fault Behavior | ||
|
|
||
| ### Exhaustible Application | ||
|
|
||
| When multiple faults are configured for an RPC method, they are applied sequentially and then exhausted: | ||
|
|
||
| ```protobuf | ||
| gnoi_faults { | ||
| rpc_method: "/gnoi.system.System/Reboot" | ||
| faults { | ||
| msg_id: "fault_1" | ||
| status { code: 3 message: "First fault" } | ||
| } | ||
| faults { | ||
| msg_id: "fault_2" | ||
| status { code: 14 message: "Second fault" } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| - 1st call → fault_1 (INVALID_ARGUMENT) | ||
| - 2nd call → fault_2 (UNAVAILABLE) | ||
| - 3rd call → **normal behavior** (continues normally) | ||
|
|
||
| ### Fault Types | ||
|
|
||
| #### Status-Only Faults | ||
| Return an error without executing the RPC: | ||
|
|
||
| ```protobuf | ||
| faults { | ||
| msg_id: "permission_denied" | ||
| status { | ||
| code: 7 # PERMISSION_DENIED | ||
| message: "Access denied in maintenance mode" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| #### Message Modification Faults | ||
| Modify the request before processing: | ||
|
|
||
| ```protobuf | ||
| faults { | ||
| msg_id: "modify_request" | ||
| msg { | ||
| # Encoded modified request message | ||
| type_url: "type.googleapis.com/gnoi.system.RebootRequest" | ||
| value: "..." # Modified request proto bytes | ||
| } | ||
| status { | ||
| code: 0 # OK - process with modified request | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Running Lemming with Fault Config | ||
|
|
||
| ```bash | ||
| # Start lemming with fault configuration | ||
| ./lemming \ | ||
| --config_file=path_to_fault_config | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.