feat: add support for .report root field in CRD plugin

[JZacharie]

This PR introduces support for the .report root field in the CRD plugin for Steampipe.

Changes:
Implemented parsing and handling of the .report root field in custom resource definitions.

Added logic to expose this data in the table schema.

Performed manual testing to validate expected behavior on sample CRDs.

This addition helps expose more structured insights from CRDs with .report fields, improving visibility for policy and compliance checks.

[Copilot]

Pull Request Overview

This PR adds support for parsing and exposing .report root fields from Kubernetes Custom Resource Definitions (CRDs) in the Steampipe plugin, enabling better visibility for policy and compliance checks.

• Extends the CRD plugin to parse and handle .report fields from custom resources
• Adds dynamic column generation for report properties with proper naming conventions
• Updates the data extraction logic to include report data from both manifest files and deployed resources

[ParthaI]

Hello @JZacharie, Great to see the PR! Could you please address the review comments provided by Copilot?

[ParthaI]

Hi @JZacharie,

I’ve been reviewing the recent code changes — they look great overall, thank you for the work!

However, while testing, I encountered the following issue:

Warning: failed to start plugin instance 'hub.steampipe.io/plugins/turbot/kubernetes@latest': failed to plugin initialise plugin 'steampipe-plugin-kubernetes': TableMapFunc 'pluginTableDefinitions' had unhandled error: interface conversion: interface {} is nil, not v1.JSONSchemaProps.

This seems to occur when the report property is not defined in the CRD. Additionally, during plugin load time, we're not setting a default value or handling the absence of report, which appears to be the root cause of the interface conversion error.

Would you mind taking a look when you get a chance?

Attaching the sample CRD files below.
crd.yaml:

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: widgets.example.com  # Fully qualified name of the CRD
spec:
  group: example.com         # API group
  names:
    plural: widgets          # Plural name for the resource
    singular: widget         # Singular name
    kind: Widget             # PascalCase name used in YAML
    shortNames:
    - wdg                    # Optional shorthand
  scope: Namespaced          # Namespaced or Cluster-wide
  versions:
  - name: v1                 # API version
    served: true             # Can be served by the API server
    storage: true            # Stored in etcd
    schema:
      openAPIV3Schema:
        type: object
        properties:
          spec:
            type: object
            properties:
              size:
                type: string
                enum:
                - small
                - medium
                - large

widget.yaml:

apiVersion: example.com/v1
kind: Widget
metadata:
  name: my-widget
spec:
  size: medium

Thanks Again!

[JZacharie]

looks ok for me;

[JZacharie]

I reused your previous code for status, since it has the same constraint as report. This means the AI's purpose could be improved, but I didn’t fully focus on that part.

[ParthaI]

Hello @JZacharie, when you have a moment, could you please apply the workaround and update this PR according to the issue I mentioned above?

[ParthaI]

Hi @JZacharie, have you had a chance to review the code changes again?

[github-actions]

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 30 days.