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

snapshot -- fully qualified resource names #189

Closed
wants to merge 11 commits into from
Closed

snapshot -- fully qualified resource names #189

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1e125eb
nearrly compiling in gm
joekelley Dec 31, 2020
12810ca
create one reconciler per group to handle kind collisions
joekelley Dec 31, 2020
c56ae0f
cl
joekelley Jan 4, 2021
0d35610
try the output snap
joekelley Jan 25, 2021
3c369e4
Merge remote-tracking branch 'origin' into alias
joekelley Jan 25, 2021
8358778
cl
joekelley Jan 25, 2021
2c59fc9
no errs
joekelley Jan 26, 2021
b1bedc0
install-go-tools
joekelley Jan 26, 2021
b3c702f
Merge remote-tracking branch 'origin' into alias
joekelley Feb 2, 2021
089386a
snake the group version kind
joekelley Feb 2, 2021
cff8fc5
rename func
joekelley Feb 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelog/v0.18.0/disambiguate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
changelog:
- type: BREAKING_CHANGE
issueLink: https://github.com/solo-io/skv2/issues/151
description: Fully qualify resources from Kind to Group Version Kind to disambiguate types in snapshots.
8 changes: 8 additions & 0 deletions contrib/codegen/funcs/funcs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
package funcs

import (
"fmt"
"path/filepath"
"sort"
"strings"
"text/template"

"github.com/iancoleman/strcase"
"github.com/rotisserie/eris"

"github.com/solo-io/skv2/codegen/model"
Expand Down Expand Up @@ -57,6 +59,7 @@ func MakeHomogenousSnapshotFuncs(
}
return clientImportPath(grp) + "/controller"
},
"gvk": gvk,
}
}

Expand Down Expand Up @@ -133,9 +136,14 @@ func MakeHybridSnapshotFuncs(
}
return clientImportPath(grp) + "/controller"
},
"gvk": gvk,
}
}

func gvk(resource model.Resource) string {
return strcase.ToCamel(fmt.Sprintf("%s-%s", resource.GroupVersion.String(), resource.Kind))
}

// gets the go package for an imported group's clients
func clientImportPath(grp importedGroup) string {

Expand Down
88 changes: 44 additions & 44 deletions contrib/codegen/templates/input/hybrid_input_reconciler.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ import (
{{- if gt (len $remoteGroups) 0 }}
{{- range $group := $remoteGroups }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
// * {{ $kindPlural }}
{{- $gvkPlural := pluralize (gvk $resource) }}
// * {{ $gvkPlural }}
{{- end }}
{{- end }}
// from a remote cluster.
{{- end }}
{{- if gt (len $localGroups) 0 }}
{{- range $group := $localGroups }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
// * {{ $kindPlural }}
{{- $gvkPlural := pluralize (gvk $resource) }}
// * {{ $gvkPlural }}
{{- end }}
{{- end }}
// from the local cluster.
Expand Down Expand Up @@ -82,8 +82,6 @@ func Register{{ $snapshotName }}InputReconciler(
{{- end }}
options {{ $snapshotName }}ReconcileOptions,
) (input.InputReconciler, error) {
// {{$remoteGroups}} {{gt 0 (len $remoteGroups)}} {{ len $remoteGroups }}
// {{$localGroups}}
{{- if eq 0 (len $remoteGroups) }}
multiClusterReconcileFunc := input.MultiClusterReconcileFunc(nil)
{{- end }}
Expand All @@ -102,23 +100,23 @@ func Register{{ $snapshotName }}InputReconciler(
{{- range $group := $remoteGroups }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
// initialize {{ $kindPlural }} reconcile loop for remote clusters
{{ $controller_import_prefix }}.NewMulticluster{{ $resource.Kind }}ReconcileLoop("{{ $resource.Kind }}", clusters, options.Remote.{{ $kindPlural }}).AddMulticluster{{ $resource.Kind }}Reconciler(ctx, &remoteInputReconciler{base: base}, options.Remote.Predicates...)
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}
// initialize {{ $gvkPlural }} reconcile loop for remote clusters
{{ $controller_import_prefix }}.NewMulticluster{{ $resource.Kind }}ReconcileLoop("{{ $resource.Kind }}", clusters, options.Remote.{{ $gvkPlural }}).AddMulticluster{{ $resource.Kind }}Reconciler(ctx, &remote{{ upper_camel $group.Group }}InputReconciler{base: base}, options.Remote.Predicates...)

{{- end }}
{{- end }}

{{- range $group := $localGroups }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
// initialize {{ $kindPlural }} reconcile loop for local cluster
if err := {{ $controller_import_prefix }}.New{{ $resource.Kind }}ReconcileLoop("{{ $resource.Kind }}", mgr, options.Local.{{ $kindPlural }}).Run{{ $resource.Kind }}Reconciler(ctx, &localInputReconciler{base: base}, options.Local.Predicates...); err != nil {
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}
// initialize {{ $gvkPlural }} reconcile loop for local cluster
if err := {{ $controller_import_prefix }}.New{{ $resource.Kind }}ReconcileLoop("{{ $resource.Kind }}", mgr, options.Local.{{ $gvkPlural }}).Run{{ $resource.Kind }}Reconciler(ctx, &local{{ upper_camel $group.Group }}InputReconciler{base: base}, options.Local.Predicates...); err != nil {
return nil, err
}
{{- end }}
Expand All @@ -134,36 +132,37 @@ type Remote{{ $snapshotName }}ReconcileOptions struct {
{{- range $group := $remoteGroups }}
{{ $client_import_prefix := group_import_name $group }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
// Options for reconciling {{ $kindPlural }}
{{ $kindPlural }} reconcile.Options
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}
// Options for reconciling {{ $gvkPlural }}
{{ $gvkPlural }} reconcile.Options
{{- end }}
{{- end }}

// optional predicates for filtering remote events
Predicates []predicate.Predicate
}

type remote{{ $snapshotName }}InputReconciler struct {
base input.InputReconciler
}

{{- range $group := $remoteGroups }}
{{ $type_import_prefix := group_import_name $group }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}

type remote{{ upper_camel $group.Group }}{{ $snapshotName }}InputReconciler struct {
base input.InputReconciler
}

{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}

func (r *remote{{ $snapshotName }}InputReconciler) Reconcile{{ $resource.Kind }}(clusterName string, obj *{{ $type_import_prefix }}.{{ $resource.Kind }}) (reconcile.Result, error) {
func (r *remote{{ upper_camel $group.Group }}{{ $snapshotName }}InputReconciler) Reconcile{{ $resource.Kind }}(clusterName string, obj *{{ $type_import_prefix }}.{{ $resource.Kind }}) (reconcile.Result, error) {
obj.ClusterName = clusterName
return r.base.ReconcileRemoteGeneric(obj)
}

func (r *remote{{ $snapshotName }}InputReconciler) Reconcile{{ $resource.Kind }}Deletion(clusterName string, obj reconcile.Request) error {
func (r *remote{{ upper_camel $group.Group }}{{ $snapshotName }}InputReconciler) Reconcile{{ $resource.Kind }}Deletion(clusterName string, obj reconcile.Request) error {
ref := &sk_core_v1.ClusterObjectRef{
Name: obj.Name,
Namespace: obj.Namespace,
Expand All @@ -183,35 +182,36 @@ type Local{{ $snapshotName }}ReconcileOptions struct {
{{- range $group := $localGroups }}
{{ $client_import_prefix := group_import_name $group }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
// Options for reconciling {{ $kindPlural }}
{{ $kindPlural }} reconcile.Options
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}
// Options for reconciling {{ $gvkPlural }}
{{ $gvkPlural }} reconcile.Options
{{- end }}
{{- end }}

// optional predicates for filtering local events
Predicates []predicate.Predicate
}

type local{{ $snapshotName }}InputReconciler struct {
base input.InputReconciler
}

{{- range $group := $localGroups }}
{{ $type_import_prefix := group_import_name $group }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}

type local{{ upper_camel $group.Group }}{{ $snapshotName }}InputReconciler struct {
base input.InputReconciler
}

{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}

func (r *local{{ $snapshotName }}InputReconciler) Reconcile{{ $resource.Kind }}(obj *{{ $type_import_prefix }}.{{ $resource.Kind }}) (reconcile.Result, error) {
func (r *local{{ upper_camel $group.Group }}{{ $snapshotName }}InputReconciler) Reconcile{{ $resource.Kind }}(obj *{{ $type_import_prefix }}.{{ $resource.Kind }}) (reconcile.Result, error) {
return r.base.ReconcileLocalGeneric(obj)
}

func (r *local{{ $snapshotName }}InputReconciler) Reconcile{{ $resource.Kind }}Deletion(obj reconcile.Request) error {
func (r *local{{ upper_camel $group.Group }}{{ $snapshotName }}InputReconciler) Reconcile{{ $resource.Kind }}Deletion(obj reconcile.Request) error {
ref := &sk_core_v1.ObjectRef{
Name: obj.Name,
Namespace: obj.Namespace,
Expand Down
52 changes: 26 additions & 26 deletions contrib/codegen/templates/input/input_reconciler.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
// storage event is received for any of:
{{- range $group := $groups }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
// * {{ $kindPlural }}
{{- $gvkPlural := pluralize (gvk $resource) }}
// * {{ $gvkPlural }}
{{- end }}
{{- end }}
// for a given cluster or set of clusters.
Expand Down Expand Up @@ -42,9 +42,9 @@ type multiCluster{{ $snapshotName }}Reconciler interface {
{{- range $group := $groups }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}
{{ $controller_import_prefix }}.Multicluster{{ $resource.Kind }}Reconciler
{{- end }}
{{- end }}
Expand All @@ -62,11 +62,11 @@ type {{ $snapshotName }}ReconcileOptions struct {
{{- range $group := $groups }}
{{ $client_import_prefix := group_import_name $group }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
// Options for reconciling {{ $kindPlural }}
{{ $kindPlural }} reconcile.Options
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}
// Options for reconciling {{ $gvkPlural }}
{{ $gvkPlural }} reconcile.Options
{{- end }}
{{- end }}
}
Expand Down Expand Up @@ -98,11 +98,11 @@ func RegisterMultiCluster{{ $snapshotName }}Reconciler(
{{- range $group := $groups }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}

{{ $controller_import_prefix }}.NewMulticluster{{ $resource.Kind }}ReconcileLoop("{{ $resource.Kind }}", clusters, options.{{ $kindPlural }}).AddMulticluster{{ $resource.Kind }}Reconciler(ctx, r, predicates...)
{{ $controller_import_prefix }}.NewMulticluster{{ $resource.Kind }}ReconcileLoop("{{ $resource.Kind }}", clusters, options.{{ $gvkPlural }}).AddMulticluster{{ $resource.Kind }}Reconciler(ctx, r, predicates...)


{{- end }}
Expand All @@ -114,9 +114,9 @@ func RegisterMultiCluster{{ $snapshotName }}Reconciler(
{{ $type_import_prefix := group_import_name $group }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}

func (r *multiCluster{{ $snapshotName }}ReconcilerImpl) Reconcile{{ $resource.Kind }}(clusterName string, obj *{{ $type_import_prefix }}.{{ $resource.Kind }}) (reconcile.Result, error) {
obj.ClusterName = clusterName
Expand All @@ -143,9 +143,9 @@ type singleCluster{{ $snapshotName }}Reconciler interface {
{{- range $group := $groups }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}
{{ $controller_import_prefix }}.{{ $resource.Kind }}Reconciler
{{- end }}
{{- end }}
Expand Down Expand Up @@ -183,9 +183,9 @@ func RegisterSingleCluster{{ $snapshotName }}Reconciler(
{{- range $group := $groups }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}
if err := {{ $controller_import_prefix }}.New{{ $resource.Kind }}ReconcileLoop("{{ $resource.Kind }}", mgr, options).Run{{ $resource.Kind }}Reconciler(ctx, r, predicates...); err != nil {
return nil, err
}
Expand All @@ -199,9 +199,9 @@ func RegisterSingleCluster{{ $snapshotName }}Reconciler(
{{ $type_import_prefix := group_import_name $group }}
{{ $controller_import_prefix := (printf "%v_controllers" (group_import_name $group)) }}
{{- range $resource := $group.Resources }}
{{- $kindPlural := pluralize $resource.Kind }}
{{- $kindLowerCamel := lower_camel $resource.Kind }}
{{- $kindLowerCamelPlural := pluralize $kindLowerCamel }}
{{- $gvkPlural := pluralize (gvk $resource) }}
{{- $gvkLowerCamel := lower_camel (gvk $resource) }}
{{- $gvkLowerCamelPlural := pluralize $gvkLowerCamel }}

func (r *singleCluster{{ $snapshotName }}ReconcilerImpl) Reconcile{{ $resource.Kind }}(obj *{{ $type_import_prefix }}.{{ $resource.Kind }}) (reconcile.Result, error) {
return r.base.ReconcileLocalGeneric(obj)
Expand Down