New Sink: Webex by alikhanxgrid · Pull Request #560 · robusta-dev/robusta

alikhanxgrid · 2022-10-04T05:33:05Z

Issue

Description

This PR integrates Webex as a sink to Robusta. Main logic of sending Findings to Webex is in sender.py file. The docs/ folder contain the instructions for configuring Webex with your Robusta deployment.

Checklist

Added tests that cover your change (if possible)
Added/modified documentation as required (such as the README.md, or the docs directory)
Manually tested
Made sure the title of the PR is a good description that can go into the release notes (if applicable)
Every function, interface, class has a comment describing what it does and input/output parameters

…ebindings

* Added webex_sink * Bug fix with fileblocks, code refactoring, documentation add and minor bug fixes

Job Action Added

aantn · 2022-10-09T13:43:34Z

Hey, thanks for the PR!

We're a little behind schedule due to the holidays. Just want to say thank you and that we haven't forgotten about this.

RoiGlinik · 2022-10-11T18:19:54Z

 python-versions = ">=3.5"

 [package.extras]
-dev = ["cloudpickle", "coverage[toml] (>=5.0.2)", "furo", "hypothesis", "mypy (>=0.900,!=0.940)", "pre-commit", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "sphinx", "sphinx-notfound-page", "zope.interface"]


what command did you use to update the dependencies?

poetry lock --no-update

ok thats good 👍

RoiGlinik · 2022-10-11T18:27:07Z

+
+
+INVESTIGATE_ICON = "\U0001F50E"
+SILENCE_ICON = "\U0001F515"


You can switch these with the actual icons , 🔕🔎 just a syntactic sugar

Updated. Let me know if its ok or anything needs to be changed.

RoiGlinik · 2022-10-11T18:29:01Z

+ATTACHMENT_CONTENT_TYPE = "application/vnd.microsoft.card.adaptive"
+
+CARD_TYPES = {
+    1: "AdaptiveCard",


I think an enum could be more suitable instead of these dicts. you could use string enums as well

Updated. Let me know if its ok or anything needs to be changed.

RoiGlinik · 2022-10-11T18:52:41Z

+
+        return message_content, table_blocks, file_blocks, description
+
+    def _create_pdf(self, file_blocks: List[FileBlock]):


I tested the sink, and the PDF workaround does not seem to work (I've added an image). To be honest, while the idea is clever, it is also very fragile. Also complicates the code.

I suggest we lose that part and send all the files separately with different messages or stop at the limit. Hopefully, they will add multifile support soon.

I didn't take it lightly but I think it will be a better approach

I will update it and send the files separately.

Updated. Let me know if its ok or anything needs to be changed.

RoiGlinik · 2022-10-11T19:01:04Z

+        adaptive_card["body"] = [message_content_container]
+
+        #Parsing table blocks for adaptive card
+        if table_blocks:


The table block has an to_markdown option as well , might work here as well?
I would take that table code to a different function if not just to separate the logic

Yes I tried to send the table using markdown but the rows and columns were not aligned properly thats why used adaptive cards to send table. I will separate the logic.

Updated. Let me know if its ok or anything needs to be changed.

Thanks for reviewing

* Added webex_sink * Bug fix with fileblocks, code refactoring, documentation add and minor bug fixes * Added Enums and replaced emoji code with emoji icons

… function. (#7) * Added webex_sink * Bug fix with fileblocks, code refactoring, documentation add and minor bug fixes * Added Enums and replaced emoji code with emoji icons * Removed PDF functionality and seperated JSON creation logic from the adaptivecard function logic * Formatted using Black

RoiGlinik · 2022-10-18T19:59:03Z

+        # This function sends the files individually to webex
+        for blocks in files:
+            file_type = (
+                FileTypes.PHOTO if is_image(blocks.filename) else FileTypes.DOCUMENT


It seems this enum is reduandent here, you could just check is_image

Updated. Let me know if its ok or anything needs to be changed.

RoiGlinik · 2022-10-18T20:06:48Z

+            file_type = (
+                FileTypes.PHOTO if is_image(blocks.filename) else FileTypes.DOCUMENT
+            )
+            if file_type is FileTypes.DOCUMENT:


I just want to make sure if you tried to use the same logic in the Slack sink for the files.
there is this function which you can apply on the files to convert to png. ( which will save the image handling you do)
https://github.com/robusta-dev/robusta/blob/master/src/robusta/core/reporting/utils.py#L36

Also using the tempFile for the files you upload, such as here
https://github.com/robusta-dev/robusta/blob/master/src/robusta/integrations/slack/sender.py#L141

It seems to save the extra handle between image/nonimage

Updated. Let me know if its ok or anything needs to be changed.
I was using the logic used in telegram sink used in send_file function.
Thanks for linking the files and helping on how to improve the code. ❤️ .

RoiGlinik

Hey @alikhanxgrid Great Work.
I tested it looks good,
I forgot some minor changes regarding the files but after that, it's good to go

Thanks for the hard work 👍

* Added webex_sink * Bug fix with fileblocks, code refactoring, documentation add and minor bug fixes * Added Enums and replaced emoji code with emoji icons * Removed PDF functionality and seperated JSON creation logic from the adaptivecard function logic * Formatted using Black * Changes in _send_files and _separate_blocks function

wahajXgrid and others added 7 commits September 15, 2022 13:29

updated forwarder and runner serviceaccount permission for clusterrol…

9a1c327

…ebindings

Job Action Added

0ff3b5b

Merge branch 'robusta-dev:master' into wahaj_dev

51ebec4

Webex Sink Integration (#3)

6d3440d

* Added webex_sink * Bug fix with fileblocks, code refactoring, documentation add and minor bug fixes

Merge pull request #2 from X-CBG/wahaj_dev

1964e6c

Job Action Added

Merge branch 'robusta-dev:master' into master

5c4a57b

Delete job_restart_on_oomkilled.py

688974d

RoiGlinik reviewed Oct 11, 2022

View reviewed changes

alikhanxgrid added 2 commits October 12, 2022 00:01

Merge branch 'robusta-dev:master' into master

29616d4

Updated Webex_Sink (#6)

69ff3c5

* Added webex_sink * Bug fix with fileblocks, code refactoring, documentation add and minor bug fixes * Added Enums and replaced emoji code with emoji icons

RoiGlinik reviewed Oct 11, 2022

View reviewed changes

Comment thread src/robusta/integrations/webex/sender.py Outdated

RoiGlinik reviewed Oct 18, 2022

View reviewed changes

alikhanxgrid added 2 commits October 19, 2022 05:20

RoiGlinik approved these changes Oct 19, 2022

View reviewed changes

RoiGlinik merged commit 8d08efc into robusta-dev:master Oct 19, 2022


		return message_content, table_blocks, file_blocks, description

		def _create_pdf(self, file_blocks: List[FileBlock]):



		INVESTIGATE_ICON = "\U0001F50E"
		SILENCE_ICON = "\U0001F515"

Uh oh!

Conversation

alikhanxgrid commented Oct 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue

Description

Checklist

Uh oh!

aantn commented Oct 9, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alikhanxgrid Oct 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RoiGlinik left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alikhanxgrid commented Oct 4, 2022 •

edited

Loading

alikhanxgrid Oct 19, 2022 •

edited

Loading