Added support for webhook_url dynamic overriding using annotations (issue 1083) #1476
Conversation
This file contains 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
* Created MsTeamsWebhookUrlTransformer to enable overriding the webhook_url using annotations from yaml files * Enhanced MsTeamsSender.send_finding_to_ms_teams to support overriding the webhook_url * Moved shared methods and logic from ChannelTransformer to BaseChannelTransformer
…rom test_channel_transformer.py
|
|
…-dev/robusta into issue-1083-dynamic-ms-teams-sink
…rom additional_env_vars * Added additional pytests for MsTeamsWebhookUrlTransformer to test_ms_teams_transformer.py file
itisallgood
requested review from
pavangudiwada
and removed request for
pavangudiwada
RoiGlinik
reviewed
Jul 4, 2024
| def validate_url_or_get_env(cls, webhook_url: str, default_webhook_url: str) -> str: | ||
| if URL_PATTERN.match(webhook_url): | ||
| return webhook_url | ||
| env_value = os.getenv(webhook_url) |
There was a problem hiding this comment.
Can you add info logs here, in case the url matching is failed?
Also is there any reference to this url pattern ?
There was a problem hiding this comment.
@RoiGlinik There is no reference to this url pattern as I composed it from different resources, but I added pytests with different valid and invalid urls.
RoiGlinik
approved these changes
Jul 7, 2024
RoiGlinik
approved these changes
Jul 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Introduced the
webhook_overrideattribute for ms_teams_sink, enabling the use of annotations from YAML files to dynamically override thewebhook_url.Issue #1083.
If no such annotation exists, the default webhook will be used. If the annotation is found but its value
does not contain a valid URL, the system will search for an environmental variable with the name of the value in the
additional_env_varssection of yourgenerated_values.yamlfile.Reason for using annotations instead of labels:
Annotations are used instead of labels because URLs can't be passed to labels (see comment for
MsTeamsWebhookUrlTransformerinsrc/robusta/core/sinks/msteams/msteams_webhook_tranformer.py)