New pack: Hackuity

[Rogdham]

Status

• In Progress
• Ready
• In Hold - (Reason for hold)

Related Issues

None

Description

This new pack provides an integration with Hackuity, a vulnerability management solution.

Screenshots

Configuration page

hackuity-search-findings command

hackuity-search-vulndb-vulnerabilities command

Minimum version of Cortex XSOAR

• 5.5.0
• 6.0.0
• 6.1.0
• 6.2.0
• 6.5.0

Does it break backward compatibility?

• Yes
  • Further details:
• No

Must have

• Tests
• Documentation

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
9 out of 10 committers have signed the CLA.

✅ Itay4
✅ guykeller
✅ abaumgarten
✅ bakatzir
✅ evisochek
✅ yaakovi
✅ GuyAfik
✅ content-bot
✅ Rogdham
❌ David-BMS
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[content-bot]

Thank you for your contribution. Your generosity and caring are unrivaled! Make sure to register your contribution by filling the Contribution Registration form, so our content wizard @merit-maita will know he can start review the proposed changes.

[Rogdham]

MyPy lint fails due to https://github.com/demisto/demisto-sdk/issues/1831

[merit-maita]

@Rogdham Thanks for the contribution, please fill the registration form so we can go ahead with the review.

[Rogdham]

@merit-maita thank you for your reply, it should be done now!

[merit-maita]

Suggested change

	commands: Dict[str, Callable[[Client, Dict[str, str]], CommandResults]] = {
	commands = {

[Rogdham]

I have added that type otherwise MyPy thinks it is the following:

builtins.dict[builtins.str*, builtins.object*]

…and fails on a later line with this error:

/Packs/Hackuity/Integrations/Hackuity/Hackuity.py:673:28: error:
"object" not callable  [operator]
                return_results(commands[command](client, demisto.args()))

Please feel free to suggest a better solution for MyPy!

[merit-maita]

its okay you can keep it then

[merit-maita]

since you have a specific format, add an example for this date

[Rogdham]

The output date is specifically formatted with DATE_FORMAT which I thought was the way dates are represented inside Cortex XSOAR? e.g. 2021-03-03T07:56:07Z

Tell me if that's not the case, so that I can change the date formatting so that is it the one used by default inside Cortex XSOAR.

[merit-maita]

yeah its okay, just added to the description as an example, that's it

[merit-maita]

why dont you have a command example with returned data to any of the commands? it should be provided.

[Rogdham]

Done

[merit-maita]

where? the file is not updated

[merit-maita]

what about the other commands?

[Rogdham]

I've added a test for test_module.

The hackuity-dashboard-data and hackuity-dashboard-widgets commands are provided in this first version of the integration as best-effort.

The hackuity-search-provider-vulnerabilities and hackuity-search-vulndb-vulnerabilities commands are very similar so I thought it was enough to add a test for only one of them, but tell me if you want me to add a test for the other one.

[merit-maita]

there should be a test for each command even it some are similar

[merit-maita]

command examples used in building readme, should be example that would return reasonable and correct results, which i assume that example.com does not really work in that case

[Rogdham]

Done

[merit-maita]

where do you mean its done? the file is not updated

[merit-maita]

since its a new integration its preferred to be supported from 6.0.0, is there a specific reason its set to be 5.5.0?

[Rogdham]

Done

[merit-maita]

if your trying to get the json object from the response why dont you use json() method?

[Rogdham]

Because my http_request passes a resp_type of value json by default to BaseClient._http_request, the response object will already be json-decoded.

---

The None value in the path arg of json_get_value means “get the first value you find”.

The response returned by the server looks like this (some keys have been removed):

{
  "kind": "hy#widgetData",
  "payload": {
    "assetsOverview": "redacted for clarity"
  },
  "type": "ASSETS_OVERVIEW"
}

And we are only looking to return the redacted for clarity part.

[merit-maita]

cool, we'll talk about it in the demo

[merit-maita]

if you're trying to get the json object of each widget, why dont you just return it as it is from the api, or use an already existing methods.

[Rogdham]

Because my http_request passes a resp_type of value json by default to BaseClient._http_request, the response object will already be json-decoded.

---

The None value in the path arg of json_get_value means “get the first value you find”.

The response returned by the server looks like this (some extra fields have been removed):

{
  "kind": "hy#dashboard",
  "widgets": [
    {
      "id": "abc123",
      "params": {
        "overallScore": "redacted for clarity #1"
      },
      "type": "OVERALL_SCORE"
    },
    {
      "id": "def456",
      "params": {
        "scoreMeter": "redacted for clarity #2"
      },
      "type": "SCORE_METER"
    }
  ]
}

And we are only looking to return the following (note that we removed the nesting for the params keys):

[
  {
    "id": "abc123",
    "params": "redacted for clarity #1",
    "type": "OVERALL_SCORE"
  },
  {
    "id": "def456",
    "params": "redacted for clarity #2",
    "type": "SCORE_METER"
  }
]

[merit-maita]

Thanks for the hard work
please make sure to pass the checks of the pr.

[Rogdham]

Thank you for the review @merit-maita! All your points should now have been fixed or at least answers in a comment.

I think all checks that are supposed to pass on this PR should be good now.

Except that CircleCI is currently having an outage so the Run Unit Testing And Lint is failing because if it.

Edit: CircleCI is now working properly again, but the job needs to be restarted by clicking on Rerun then Rerun workflow from failed (I don't have permission to do so).

---

Sorry for the several pushes, this was me trying to fix the MyPy failing on Python 3.10 issue:

• I initially rebased on origin/master, but I see now that is was not a good idea because the base branche of this PR has been changed to contrib/Rogdham_hackuity (instead of origin/master)
• I canceled the rebase and added a commit to change version of demisto-sdk used is 1.5.8 and not 1.5.7 ▶️ this change is already on origin/master

▶️ now the commits in this branch are clearer: your last review was on 5c29226c6b0d32ab5edc0c9528d100cdc2a97a7b and I pushed two commits on top: one to address your review, and one to fix the MyPy issue.

Sorry for the noise 😞

[content-bot]

The CircleCI check from your latest pushed commit was unsuccessful. @Rogdham take a look at the build by clicking this link.

---

Failed Build Steps

• Verify Base Branch for Contribution

---

Try and address the listed CircleCI build step failures at your earliest convenience. This will greatly expedite the process of getting your proposed changes merged into master. Happy coding and may the force be with you.

[Rogdham]

Hello @merit-maita , the test were failing because they were some changes on master.

I changed the target of the PR to master and rebased my PR (fixing the conflict), but as you can see now other tests are failling because the PR is not based on contrib/Rogdham_Hackuity anymore.

So I'm confused, could you advise how to proceed?

[Rogdham]

As discussed:

• Put my contribution in a single commit on top of contrib/Rogdham_Hackuity
• Then merge master on top of that

Feel free to write back to me if you want things to be done differently.