Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add marketplace annotation to generated example manifests #75

Merged
merged 3 commits into from
Aug 29, 2022
Merged

Add marketplace annotation to generated example manifests #75

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ade0642
Add "meta.upbound.io/example-group" annotation to generated example m…
ezgidemirel Aug 22, 2022
9fc6bcd
Change annotation value to "group-kind" format
ezgidemirel Aug 23, 2022
126e856
Merge remote-tracking branch 'upstream/main' into example-group-annot…
ezgidemirel Aug 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions pkg/examples/example.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,10 @@ var (
)

const (
labelExampleName = "testing.upbound.io/example-name"
defaultExampleName = "example"
defaultNamespace = "upbound-system"
labelExampleName = "testing.upbound.io/example-name"
annotationExampleGroup = "meta.upbound.io/example-id"
defaultExampleName = "example"
defaultNamespace = "upbound-system"
)

// Generator represents a pipeline for generating example manifests.
Expand Down Expand Up @@ -95,8 +96,10 @@ func (eg *Generator) StoreExamples() error { // nolint:gocyclo
if err := json.TFParser.Unmarshal([]byte(re.Dependencies[dn]), &exampleParams); err != nil {
return errors.Wrapf(err, "cannot unmarshal example manifest for resource: %s", dr.Config.Name)
}
// e.g. meta.upbound.io/example-id: ec2/v1beta1/instance
eGroup := fmt.Sprintf("%s/%s/%s", strings.ToLower(r.ShortGroup), r.Version, strings.ToLower(r.Kind))
pmd := paveCRManifest(exampleParams, dr.Config,
reference.NewRefPartsFromResourceName(dn).ExampleName, dr.Group, dr.Version)
reference.NewRefPartsFromResourceName(dn).ExampleName, dr.Group, dr.Version, eGroup)
if err := eg.writeManifest(&buff, pmd, context); err != nil {
return errors.Wrapf(err, "cannot store example manifest for %s dependency: %s", rn, dn)
}
Expand All @@ -110,14 +113,17 @@ func (eg *Generator) StoreExamples() error { // nolint:gocyclo
return nil
}

func paveCRManifest(exampleParams map[string]any, r *config.Resource, eName, group, version string) *reference.PavedWithManifest {
func paveCRManifest(exampleParams map[string]any, r *config.Resource, eName, group, version, eGroup string) *reference.PavedWithManifest {
delete(exampleParams, "depends_on")
delete(exampleParams, "lifecycle")
transformFields(r, exampleParams, r.ExternalName.OmittedFields, "")
metadata := map[string]any{
"labels": map[string]string{
labelExampleName: eName,
},
"annotations": map[string]string{
annotationExampleGroup: eGroup,
},
}
example := map[string]any{
"apiVersion": fmt.Sprintf("%s/%s", group, version),
Expand Down Expand Up @@ -175,8 +181,11 @@ func (eg *Generator) Generate(group, version string, r *config.Resource) error {
if rm == nil || len(rm.Examples) == 0 {
return nil
}
pm := paveCRManifest(rm.Examples[0].Paved.UnstructuredContent(), r, rm.Examples[0].Name, group, version)
manifestDir := filepath.Join(eg.rootDir, "examples-generated", strings.ToLower(strings.Split(group, ".")[0]))
groupPrefix := strings.ToLower(strings.Split(group, ".")[0])
// e.g. gvk = ec2/v1beta1/instance
gvk := fmt.Sprintf("%s/%s/%s", groupPrefix, version, strings.ToLower(r.Kind))
pm := paveCRManifest(rm.Examples[0].Paved.UnstructuredContent(), r, rm.Examples[0].Name, group, version, gvk)
manifestDir := filepath.Join(eg.rootDir, "examples-generated", groupPrefix)
pm.ManifestPath = filepath.Join(manifestDir, fmt.Sprintf("%s.yaml", strings.ToLower(r.Kind)))
eg.resources[fmt.Sprintf("%s.%s", r.Name, reference.Wildcard)] = pm
return nil
Expand Down