internal/scaffold/olm-catalog: populate CSV customresourcedefinitions from Go type annotations

[estroz]

Description of the change: use doc and code comments on CR types to populate customresourcedefinitions.owned fields except for actionDescriptors, which will be persisted to the new CSV.

Motivation for the change: see #1132

Closes #1132

[joelanford]

@estroz I noticed that when we updated our dependencies, we had to update crd_test.go to include field descriptions that were populated by the updated CRD generator.

Not sure if that's related to this, but it sounded similar. Can any of those updates be used to simplify this PR?

[estroz]

Looks like there were changes made upstream in the CRD generator to add validation field descriptions. Unfortunately for x-descriptors and path we'd still need to partse *_types.go files using the method in this PR. If we only wanted to add a description we could use CRD manifests alone.

[lilic]

I have some concerns that users most of the time don't have detailed enough code comments to make this work all the time. Could we make this optional or warn that it's done on a best effort bases.

Agree about the logging vs overriding part, especially if the guess is not good enough for most use cases.

[estroz]

@lilic in the docs I'll address the fact that code comments will be used as descriptions. The controller-tools CRD generator uses them already.

[estroz]

@joelanford I think I'm going to switch to a parser like gengo instead of writing my own. I should still be able to get all the info I need from parsed data.

[camilamacedo86]

Fantastic! 👍
All working now. It is /lgtm /approved for me.

[openshift-bot]

/retest

Please review the full test history for this PR and help us cut down flakes.

[openshift-ci-robot]

New changes are detected. LGTM label has been removed.

[joelanford]

Does an embedded struct (that would otherwise be inlined) have a name?

For example:

type EmbeddedPublic struct {
	Public string `json:"public"`
}

type embeddedPrivate struct {
	Private string `json:"private"`
}

type Parent struct {
	EmbeddedPublic
	embeddedPrivate
}

In this case, the marshaled JSON would include both "public" and "private" fields in the output.

[estroz]

The embedded struct name will always be its type name. We should include an embedded struct's fields regardless if that's how the JSON Marshaller does it:

if member.Embedded {
	return inlinedTag, nil
}
if isNotExported(member.Name) {
	return ignoredTag, nil
}

[joelanford]

LGTM once sanity test failures are resolved.

[camilamacedo86]

Hi @estroz,

We forget to add the changelog entry over this one.