feat: Add report package, print reports to stdout

[viccuad]

Description

Partial implementation of #36.

feat: Add report package, print reports to stdout

Test

Manual for now.

Example:

output

$ ./bin/audit-scanner -k kubewarden --namespace default -l error | jq .
{
  "metadata": {
    "name": "polr-clusterwide",
    "creationTimestamp": null
  },
  "summary": {
    "pass": 0,
    "fail": 0,
    "warn": 0,
    "error": 0,
    "skip": 0
  }
}
{
  "metadata": {
    "name": "polr-ns-default",
    "namespace": "default",
    "creationTimestamp": "2023-05-25T14:27:40Z"
  },
  "scope": {},
  "summary": {
    "pass": 5,
    "fail": 1,
    "warn": 0,
    "error": 0,
    "skip": 0
  },
  "results": [
    {
      "source": "kubewarden",
      "policy": "cap-drop-capabilities",
      "timestamp": {
        "seconds": 1685024860,
        "nanos": 0
      },
      "result": "pass"
    },
    {
      "source": "kubewarden",
      "policy": "cap-no-privilege-escalation",
      "timestamp": {
        "seconds": 1685024860,
        "nanos": 0
      },
      "result": "pass"
    },
    {
      "source": "kubewarden",
      "policy": "cap-no-privileged-pod",
      "timestamp": {
        "seconds": 1685024860,
        "nanos": 0
      },
      "result": "fail",
      "message": "Privileged container is not allowed"
    },
    {
      "source": "kubewarden",
      "policy": "cap-do-not-run-as-root",
      "timestamp": {
        "seconds": 1685024860,
        "nanos": 0
      },
      "result": "pass"
    },
    {
      "source": "kubewarden",
      "policy": "cap-no-host-namespace-sharing",
      "timestamp": {
        "seconds": 1685024860,
        "nanos": 0
      },
      "result": "pass"
    },
    {
      "source": "kubewarden",
      "policy": "cap-do-not-share-host-paths",
      "timestamp": {
        "seconds": 1685024860,
        "nanos": 0
      },
      "result": "pass"
    }
  ]
}

Additional Information

Tradeoff

Potential improvement

Missing:

• Add tests for report.Save().

[jvanz]

Overall, it looks good to me. I think we will need to change how we do some things. But I think we will notice what needs to be improved in future steps on the scanner. Therefore, I think we can merge it and iterate over it during the next steps.

[viccuad]

Force-pushed a new version (sorry), with partial history, since I refactored heavily everything.

Took the liberty to resolve conversations from the previous review, to try and short the thread.

[flavio]

nice refactoring, I left some comments 👏 👍

[viccuad]

I don't get why the unit tests are failing on CI, they pass locally. Will have a look at that next day.

[flavio]

I left some minor comments

[viccuad]

I'm still puzzled on why the unit-tests fail without any error for the report package. They pass locally, and I'm running the same go version. The go env vars also look fine.

[flavio]

thanks for all the changes, LGTM

[jvanz]

Thanks for this docs! Pretty useful!

[jvanz]

LGTM! Thanks for the patience! :)