{}USER STORY:{}

• As OCP developer, I would like to easy find the test details shipped by openshift-tests utility, so I can decrease the total time looking on the code.
• As Partner exploring the results provided by OPCT, I would like to find more information about the tests to decrease the time of troubleshooting the errors of e2e faiulres in my environment, so I can proactively apply fixes prior my first contact with Red Hat while running the VCSP certification.

{}DESCRIPTION:{}

The idea of this card is to enrich the documentation of OpenShift e2e tests by automatically parse the comments from the Code Base, without needing to edit markdowns to update tests documentation.

The kubernetes community documents e2e tests using the following format:

    /*
        Release: v1.16
        Testname: Admission webhook, discovery document
        Description: The admissionregistration.k8s.io API group MUST exists in the /apis discovery document.
        The admissionregistration.k8s.io/v1 API group/version MUST exists in the /apis discovery document.
        The mutatingwebhookconfigurations and validatingwebhookconfigurations resources MUST exist in the
        /apis/admissionregistration.k8s.io/v1 discovery document.
    */ 

• https://github.com/kubernetes/kubernetes/blob/master/test/e2e/apimachinery/webhook.go#L108-L116
• https://github.com/cncf/k8s-conformance/blob/master/docs/KubeConformance-1.21.md#admission-webhook-discovery-document
•  

The they run the parser to collect all the "Conformance" tag creating markdown files for each release:

• https://github.com/cncf/k8s-conformance#generating-release-documents 

The `openshift/tests` is used by OPCT, and it would be nice to have a minimal document for e2e tests used on the certification to provide to the partners, helping them to proactively troubleshooting their installations without contacting Red Hat. It also can be used by the Community who would like to install their own OKD/OCP clusters and it's failing the conformance tests.

{}Required:{}

• Create a PoC with the parser of comments strings
• Create a document proposing this change describing in details when it will run, the format, the frequency, etc
•  

{}Nice to have:{}

• PR with initial proposal
•  

{}ACCEPTANCE CRITERIA:{}

TBD

{}ENGINEERING DETAILS:{}

• Slack conversation about that theme: https://coreos.slack.com/archives/C02DSMAP4LA/p1669134489097869