WIP: feat(lint): add troubleshoot lint

[DexterYan]

Description, Motivation and Context

• introduce a new troubleshoot command: troubleshoot lint
• if detect a wrong format troubleshoot yaml like

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
  name: default
spec:
  collectors:
    - helm:
        releaseName: mysql-1692919203
        namespace: "default"
  analyzers:
    - distribution:
      outcomes:
        - pass:
            when: "== kurl"
            message: kurl is a supported platform
        - pass:
            when: "== gke"
            message: GKE is a supported platform

It will return a error and tips

distribution is empty
outcomes is misaligned in distribution
Error: Warning: Wrong analyzer found

Screenshot:

In a more complicated case like

apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
  name: default
spec:
  collectors:
    - helm:
        releaseName: mysql-1692919203
        namespace: "default"
  analyzers:
    - distribution:
      outcomes:
        - pass:
            when: "== kurl"
            message: kurl is a supported platform
        - pass:
            when: "== gke"
            message: GKE is a supported platform
    - textAnalyze:
      checkName: Replica Count
      fileName: config/replicas.txt
      regexGroups: '(?P<Replicas>\d+)'
      outcomes:
        - fail:
            when: "Replicas < 5"
            message: That's not enough replicas!
        - pass:
            message: You have at least 5 replicas

it will return

====================
distribution analyzer is empty
--------------------
outcomes is misaligned in distribution
====================
textAnalyze analyzer is empty
--------------------
checkName is misaligned in textAnalyze
fileName is misaligned in textAnalyze
regexGroups is misaligned in textAnalyze
outcomes is misaligned in textAnalyze
Error: Warning: Wrong analyzer found

sc-103245

Checklist

• New and existing tests pass locally with introduced changes.
• Tests for the changes have been added (for bug fixes / features)
• The commit message(s) are informative and highlight any breaking changes
• Any documentation required has been added/updated. For changes to https://troubleshoot.sh/ create a PR here

Does this PR introduce a breaking change?

• Yes
• No

[banjoh]

I assume you implemented this subcommand this way cause its a WIP PR, right?

I would have expected lint to be a cobra subcommand

[DexterYan]

Yes, it is a WIP PR for showing what lint could be like. Sure, I will put it into cmd/lint as a cobra subcommand

[banjoh]

The idea you have with validating and reporting is correct, I'm however not sure we want to implement this feature by parsing yaml and inspecting fields like this. We'll be reinventing the wheel. There are a number of libraries that already exist that utilize yaml/json/openapi spec annotations. I've listed a few in #871 issue.

[DexterYan]

great! I will have a look. In the meanwhile, I am checking the product team to see what their opinions. We can discuss the output of this command together.