crossplane
/
crossplane-tools
mirror of https://github.com/crossplane/crossplane-tools.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #111 from erhancagirici/ec-crossplane-v2 

angryjet: generate Crossplane V2 interface methods
This commit is contained in:
Sergen Yalçın 2025-07-22 17:46:08 +03:00 committed by GitHub
parent 9102d33d29 ad96b640a6
commit 1b4428a044
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 647 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
cmd/angryjet/main.go
View File

@ -90,17 +90,22 @@ func main() {
for _, err := range p.Errors {
kingpin.FatalIfError(err, "error loading packages using pattern %s", *pattern)
}
kingpin.FatalIfError(GenerateManaged(*filenameManaged, header, p), "cannot write managed resource method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateManagedList(*filenameManagedList, header, p), "cannot write managed resource list method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateManagedLegacy(*filenameManaged, header, p), "cannot write managed resource method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateManagedModern(*filenameManaged, header, p), "cannot write managed resource method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateManagedListLegacy(*filenameManagedList, header, p), "cannot write managed resource list method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateManagedListModern(*filenameManagedList, header, p), "cannot write managed resource list method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateProviderConfig(*filenamePC, header, p), "cannot write provider config method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateProviderConfigUsage(*filenamePCU, header, p), "cannot write provider config usage method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateProviderConfigUsageList(*filenamePCUList, header, p), "cannot write provider config usage list method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateReferences(*filenameResolvers, header, p), "cannot write reference resolvers for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateProviderConfigUsageLegacy(*filenamePCU, header, p), "cannot write provider config usage method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateProviderConfigUsageModern(*filenamePCU, header, p), "cannot write provider config usage method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateProviderConfigUsageListLegacy(*filenamePCUList, header, p), "cannot write provider config usage list method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateProviderConfigUsageListModern(*filenamePCUList, header, p), "cannot write provider config usage list method set for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateReferencesLegacy(*filenameResolvers, header, p), "cannot write reference resolvers for package %s", p.PkgPath)
kingpin.FatalIfError(GenerateReferencesModern(*filenameResolvers, header, p), "cannot write reference resolvers for package %s", p.PkgPath)
}
}
// GenerateManaged generates the resource.Managed method set.
func GenerateManaged(filename, header string, p *packages.Package) error {
// GenerateManagedLegacy generates the resource.Managed method set.
func GenerateManagedLegacy(filename, header string, p *packages.Package) error {
receiver := "mg"
methods := method.Set{
@ -110,8 +115,6 @@ func GenerateManaged(filename, header string, p *packages.Package) error {
"SetProviderConfigReference": method.NewSetProviderConfigReference(receiver, RuntimeImport),
"SetWriteConnectionSecretToReference": method.NewSetWriteConnectionSecretToReference(receiver, RuntimeImport),
"GetWriteConnectionSecretToReference": method.NewGetWriteConnectionSecretToReference(receiver, RuntimeImport),
"SetPublishConnectionDetailsTo": method.NewSetPublishConnectionDetailsTo(receiver, RuntimeImport),
"GetPublishConnectionDetailsTo": method.NewGetPublishConnectionDetailsTo(receiver, RuntimeImport),
"SetManagementPolicies": method.NewSetManagementPolicies(receiver, RuntimeImport),
"GetManagementPolicies": method.NewGetManagementPolicies(receiver, RuntimeImport),
"SetDeletionPolicy": method.NewSetDeletionPolicy(receiver, RuntimeImport),
@ -133,8 +136,38 @@ func GenerateManaged(filename, header string, p *packages.Package) error {
return errors.Wrap(err, "cannot write managed resource methods")
}
// GenerateManagedList generates the resource.ManagedList method set.
func GenerateManagedList(filename, header string, p *packages.Package) error {
// GenerateManagedModern generates the resource.Managed method set for v2-style namespaced MRs.
func GenerateManagedModern(filename, header string, p *packages.Package) error {
receiver := "mg"
methods := method.Set{
"SetConditions": method.NewSetConditions(receiver, RuntimeImport),
"GetCondition": method.NewGetCondition(receiver, RuntimeImport),
"GetProviderConfigReference": method.NewGetTypedProviderConfigReference(receiver, RuntimeImport),
"SetProviderConfigReference": method.NewSetTypedProviderConfigReference(receiver, RuntimeImport),
"SetWriteConnectionSecretToReference": method.NewLocalSetWriteConnectionSecretToReference(receiver, RuntimeImport),
"GetWriteConnectionSecretToReference": method.NewLocalGetWriteConnectionSecretToReference(receiver, RuntimeImport),
"SetManagementPolicies": method.NewSetManagementPolicies(receiver, RuntimeImport),
"GetManagementPolicies": method.NewGetManagementPolicies(receiver, RuntimeImport),
}
err := generate.WriteMethods(p, methods, filepath.Join(filepath.Dir(p.GoFiles[0]), filename),
generate.WithHeaders(header),
generate.WithImportAliases(map[string]string{
CoreImport: CoreAlias,
RuntimeImport: RuntimeAlias,
}),
generate.WithMatcher(match.AllOf(
match.ManagedV2(),
match.DoesNotHaveMarker(comments.In(p), DisableMarker, "false")),
),
)
return errors.Wrap(err, "cannot write V2 managed resource methods")
}
// GenerateManagedListLegacy generates the resource.ManagedList method set.
func GenerateManagedListLegacy(filename, header string, p *packages.Package) error {
receiver := "l"
methods := method.Set{
@ -155,6 +188,28 @@ func GenerateManagedList(filename, header string, p *packages.Package) error {
return errors.Wrap(err, "cannot write managed resource list methods")
}
// GenerateManagedListModern generates the resource.ManagedList method set for v2-style namespaced MRs.
func GenerateManagedListModern(filename, header string, p *packages.Package) error {
receiver := "l"
methods := method.Set{
"GetItems": method.NewManagedGetItems(receiver, ResourceImport),
}
err := generate.WriteMethods(p, methods, filepath.Join(filepath.Dir(p.GoFiles[0]), filename),
generate.WithHeaders(header),
generate.WithImportAliases(map[string]string{
ResourceImport: ResourceAlias,
}),
generate.WithMatcher(match.AllOf(
match.ManagedListV2(),
match.DoesNotHaveMarker(comments.In(p), DisableMarker, "false")),
),
)
return errors.Wrap(err, "cannot write V2 managed resource list methods")
}
// GenerateProviderConfig generates the resource.ProviderConfig method set.
func GenerateProviderConfig(filename, header string, p *packages.Package) error {
receiver := "p"
@ -178,8 +233,8 @@ func GenerateProviderConfig(filename, header string, p *packages.Package) error
return errors.Wrap(err, "cannot write provider config methods")
}
// GenerateProviderConfigUsage generates the resource.ProviderConfigUsage method set.
func GenerateProviderConfigUsage(filename, header string, p *packages.Package) error {
// GenerateProviderConfigUsageLegacy generates the resource.ProviderConfigUsage method set.
func GenerateProviderConfigUsageLegacy(filename, header string, p *packages.Package) error {
receiver := "p"
methods := method.Set{
@ -201,9 +256,32 @@ func GenerateProviderConfigUsage(filename, header string, p *packages.Package) e
return errors.Wrap(err, "cannot write provider config usage methods")
}
// GenerateProviderConfigUsageList generates the
// GenerateProviderConfigUsageModern generates the v2.ProviderConfigUsage method set.
func GenerateProviderConfigUsageModern(filename, header string, p *packages.Package) error {
receiver := "p"
methods := method.Set{
"SetProviderConfigReference": method.NewSetRootProviderConfigTypedReference(receiver, RuntimeImport),
"GetProviderConfigReference": method.NewGetRootProviderConfigTypedReference(receiver, RuntimeImport),
"SetResourceReference": method.NewSetRootResourceReference(receiver, RuntimeImport),
"GetResourceReference": method.NewGetRootResourceReference(receiver, RuntimeImport),
}
err := generate.WriteMethods(p, methods, filepath.Join(filepath.Dir(p.GoFiles[0]), filename),
generate.WithHeaders(header),
generate.WithImportAliases(map[string]string{RuntimeImport: RuntimeAlias}),
generate.WithMatcher(match.AllOf(
match.ProviderConfigUsageV2(),
match.DoesNotHaveMarker(comments.In(p), DisableMarker, "false")),
),
)
return errors.Wrap(err, "cannot write provider config usage methods")
}
// GenerateProviderConfigUsageListLegacy generates the
// resource.ProviderConfigUsageList method set.
func GenerateProviderConfigUsageList(filename, header string, p *packages.Package) error {
func GenerateProviderConfigUsageListLegacy(filename, header string, p *packages.Package) error {
receiver := "p"
methods := method.Set{
@ -222,8 +300,30 @@ func GenerateProviderConfigUsageList(filename, header string, p *packages.Packag
return errors.Wrap(err, "cannot write provider config usage list methods")
}
// GenerateReferences generates reference resolver calls.
func GenerateReferences(filename, header string, p *packages.Package) error {
// GenerateProviderConfigUsageListModern generates the
// resource.ProviderConfigUsageList method set
// for XPv2 namespaced MRs.
func GenerateProviderConfigUsageListModern(filename, header string, p *packages.Package) error {
receiver := "p"
methods := method.Set{
"GetItems": method.NewProviderConfigUsageGetItems(receiver, ResourceImport),
}
err := generate.WriteMethods(p, methods, filepath.Join(filepath.Dir(p.GoFiles[0]), filename),
generate.WithHeaders(header),
generate.WithImportAliases(map[string]string{RuntimeImport: RuntimeAlias, ResourceImport: ResourceAlias}),
generate.WithMatcher(match.AllOf(
match.ProviderConfigUsageListV2(),
match.DoesNotHaveMarker(comments.In(p), DisableMarker, "false")),
),
)
return errors.Wrap(err, "cannot write V2 provider config usage list methods")
}
// GenerateReferencesLegacy generates reference resolver calls.
func GenerateReferencesLegacy(filename, header string, p *packages.Package) error {
receiver := "mg"
comm := comments.In(p)
@ -245,3 +345,27 @@ func GenerateReferences(filename, header string, p *packages.Package) error {
return errors.Wrap(err, "cannot write reference resolver methods")
}
// GenerateReferencesModern generates reference resolver calls for XPv2 namespaced MRs.
func GenerateReferencesModern(filename, header string, p *packages.Package) error {
receiver := "mg"
comm := comments.In(p)
methods := method.Set{
"ResolveReferences": method.NewResolveReferencesV2(types.NewTraverser(comm), receiver, ClientImport, ReferenceImport),
}
err := generate.WriteMethods(p, methods, filepath.Join(filepath.Dir(p.GoFiles[0]), filename),
generate.WithHeaders(header),
generate.WithImportAliases(map[string]string{
ClientImport: ClientAlias,
ReferenceImport: ReferenceAlias,
}),
generate.WithMatcher(match.AllOf(
match.ManagedV2(),
match.DoesNotHaveMarker(comm, DisableMarker, "false")),
),
)
return errors.Wrap(err, "cannot write V2 reference resolver methods")
}

16
internal/fields/fields.go
View File

@ -36,6 +36,9 @@ const (
NameProviderConfigStatus = "ProviderConfigStatus"
NameProviderConfigUsage = "ProviderConfigUsage"
NameItems = "Items"
NameTypedProviderConfigUsage = "TypedProviderConfigUsage"
NameResourceV2Spec = "ManagedResourceSpec"
)
// Field type suffixes.
@ -51,6 +54,9 @@ const (
TypeSuffixProviderConfigSpec = "github.com/crossplane/crossplane-runtime/apis/common/v1.ProviderConfigSpec"
TypeSuffixProviderConfigStatus = "github.com/crossplane/crossplane-runtime/apis/common/v1.ProviderConfigStatus"
TypeSuffixProviderConfigUsage = "github.com/crossplane/crossplane-runtime/apis/common/v1.ProviderConfigUsage"
TypeSuffixProviderConfigUsageV2 = "github.com/crossplane/crossplane-runtime/apis/common/v2.TypedProviderConfigUsage"
TypeSuffixResourceV2Spec = "github.com/crossplane/crossplane-runtime/apis/common/v2.ManagedResourceSpec"
)
func matches(s *types.Struct, m Matcher) bool {
@ -182,6 +188,10 @@ func IsStatus() Matcher { return IsTypeNamed(NameStatus, TypeSuffixStatus) }
// appears to be a Crossplane managed resource spec.
func IsResourceSpec() Matcher { return IsTypeNamed(TypeSuffixResourceSpec, NameResourceSpec) }
// IsResourceV2Spec returns a Matcher that returns true if the supplied field
// appears to be a Crossplane managed resource spec.
func IsResourceV2Spec() Matcher { return IsTypeNamed(TypeSuffixResourceV2Spec, NameResourceV2Spec) }
// IsResourceStatus returns a Matcher that returns true if the supplied field
// appears to be a Crossplane managed resource status.
func IsResourceStatus() Matcher { return IsTypeNamed(TypeSuffixResourceStatus, NameResourceStatus) }
@ -204,6 +214,12 @@ func IsProviderConfigUsage() Matcher {
return IsTypeNamed(TypeSuffixProviderConfigUsage, NameProviderConfigUsage)
}
// IsTypedProviderConfigUsage returns a Matcher that returns true if the supplied
// field appears to be a Crossplane provider config usage with typed ref.
func IsTypedProviderConfigUsage() Matcher {
return IsTypeNamed(TypeSuffixProviderConfigUsageV2, NameTypedProviderConfigUsage)
}
// IsItems returns a Matcher that returns true if the supplied field appears to
// be the Items of a Kubernetes list.
func IsItems() Matcher {

64
internal/match/match.go
View File

@ -45,6 +45,23 @@ func Managed() Object {
}
}
// ManagedV2 returns an Object matcher that returns true if the supplied Object is
// a v2-style Crossplane managed resource.
func ManagedV2() Object {
return func(o types.Object) bool {
return fields.Has(o,
fields.IsTypeMeta().And(fields.IsEmbedded()),
fields.IsObjectMeta().And(fields.IsEmbedded()),
fields.IsSpec().And(fields.HasFieldThat(
fields.IsResourceV2Spec().And(fields.IsEmbedded()),
)),
fields.IsStatus().And(fields.HasFieldThat(
fields.IsResourceStatus().And(fields.IsEmbedded()),
)),
)
}
}
// ManagedList returns an Object matcher that returns true if the supplied
// Object is a list of Crossplane managed resource.
func ManagedList() Object {
@ -65,6 +82,26 @@ func ManagedList() Object {
}
}
// ManagedListV2 returns an Object matcher that returns true if the supplied
// Object is a list of Crossplane managed resource.
func ManagedListV2() Object {
return func(o types.Object) bool {
return fields.Has(o,
fields.IsTypeMeta().And(fields.IsEmbedded()),
fields.IsItems().And(fields.IsSlice()).And(fields.HasFieldThat(
fields.IsTypeMeta().And(fields.IsEmbedded()),
fields.IsObjectMeta().And(fields.IsEmbedded()),
fields.IsSpec().And(fields.HasFieldThat(
fields.IsResourceV2Spec().And(fields.IsEmbedded()),
)),
fields.IsStatus().And(fields.HasFieldThat(
fields.IsResourceStatus().And(fields.IsEmbedded()),
)),
)),
)
}
}
// ProviderConfig returns an Object matcher that returns true if the supplied
// Object is a Crossplane ProviderConfig.
func ProviderConfig() Object {
@ -92,6 +129,18 @@ func ProviderConfigUsage() Object {
}
}
// ProviderConfigUsageV2 returns an Object matcher that returns true if the supplied
// Object is a Crossplane v2 style ProviderConfigUsage.
func ProviderConfigUsageV2() Object {
return func(o types.Object) bool {
return fields.Has(o,
fields.IsTypeMeta().And(fields.IsEmbedded()),
fields.IsObjectMeta().And(fields.IsEmbedded()),
fields.IsTypedProviderConfigUsage().And(fields.IsEmbedded()),
)
}
}
// ProviderConfigUsageList returns an Object matcher that returns true if the
// supplied Object is a list of Crossplane provider config usages.
func ProviderConfigUsageList() Object {
@ -107,6 +156,21 @@ func ProviderConfigUsageList() Object {
}
}
// ProviderConfigUsageListV2 returns an Object matcher that returns true if the
// supplied Object is a list of Crossplane v2 style provider config usages.
func ProviderConfigUsageListV2() Object {
return func(o types.Object) bool {
return fields.Has(o,
fields.IsTypeMeta().And(fields.IsEmbedded()),
fields.IsItems().And(fields.IsSlice()).And(fields.HasFieldThat(
fields.IsTypeMeta().And(fields.IsEmbedded()),
fields.IsObjectMeta().And(fields.IsEmbedded()),
fields.IsTypedProviderConfigUsage().And(fields.IsEmbedded()),
)),
)
}
}
// HasMarker returns an Object matcher that returns true if the supplied Object
// has a comment marker k with the value v. Comment markers are read from the
// supplied Comments.

50
internal/method/method.go
View File

@ -142,6 +142,28 @@ func NewGetProviderConfigReference(receiver, runtime string) New {
}
}
// NewSetTypedProviderConfigReference returns a NewMethod that writes a SetProviderConfigReference
// method for the supplied Object to the supplied file.
func NewSetTypedProviderConfigReference(receiver, runtime string) New {
return func(f *jen.File, o types.Object) {
f.Commentf("SetProviderConfigReference of this %s.", o.Name())
f.Func().Params(jen.Id(receiver).Op("*").Id(o.Name())).Id("SetProviderConfigReference").Params(jen.Id("r").Op("*").Qual(runtime, "ProviderConfigReference")).Block(
jen.Id(receiver).Dot(fields.NameSpec).Dot("ProviderConfigReference").Op("=").Id("r"),
)
}
}
// NewGetTypedProviderConfigReference returns a NewMethod that writes a GetProviderConfigReference
// method for the supplied Object to the supplied file.
func NewGetTypedProviderConfigReference(receiver, runtime string) New {
return func(f *jen.File, o types.Object) {
f.Commentf("GetProviderConfigReference of this %s.", o.Name())
f.Func().Params(jen.Id(receiver).Op("*").Id(o.Name())).Id("GetProviderConfigReference").Params().Op("*").Qual(runtime, "ProviderConfigReference").Block(
jen.Return(jen.Id(receiver).Dot(fields.NameSpec).Dot("ProviderConfigReference")),
)
}
}
// NewSetWriteConnectionSecretToReference returns a NewMethod that writes a
// SetWriteConnectionSecretToReference method for the supplied Object to the
// supplied file.
@ -359,3 +381,31 @@ func NewProviderConfigUsageGetItems(receiver, resource string) New {
)
}
}
// NewSetRootProviderConfigTypedReference returns a NewMethod that writes a
// SetProviderConfigTypedReference method for the supplied Object to the supplied
// file. Note that unlike NewSetProviderConfigTypedReference the generated method
// expects the ProviderConfigReference to be at the root of the struct, not
// under its Spec field.
func NewSetRootProviderConfigTypedReference(receiver, runtime string) New {
return func(f *jen.File, o types.Object) {
f.Commentf("SetProviderConfigReference of this %s.", o.Name())
f.Func().Params(jen.Id(receiver).Op("*").Id(o.Name())).Id("SetProviderConfigReference").Params(jen.Id("r").Qual(runtime, "ProviderConfigReference")).Block(
jen.Id(receiver).Dot("ProviderConfigReference").Op("=").Id("r"),
)
}
}
// NewGetRootProviderConfigTypedReference returns a NewMethod that writes a
// GetProviderConfigTypedReference method for the supplied Object to the supplied
// file. Note that unlike NewGetProviderConfigTypedReference the generated
// method expects the ProviderConfigReference to be at the root of the struct,
// not under its Spec field.
func NewGetRootProviderConfigTypedReference(receiver, runtime string) New {
return func(f *jen.File, o types.Object) {
f.Commentf("GetProviderConfigReference of this %s.", o.Name())
f.Func().Params(jen.Id(receiver).Op("*").Id(o.Name())).Id("GetProviderConfigReference").Params().Qual(runtime, "ProviderConfigReference").Block(
jen.Return(jen.Id(receiver).Dot("ProviderConfigReference")),
)
}
}

68
internal/method/method_test.go
View File

@ -446,3 +446,71 @@ func (t *Type) GetItems() []resource.ProviderConfigUsage {
t.Errorf("NewProviderConfigUsageGetItems(): -want, +got\n%s", diff)
}
}
func TestNewSetTypedProviderConfigReference(t *testing.T) {
want := `package pkg
import runtime "example.org/runtime"
// SetProviderConfigReference of this Type.
func (t *Type) SetProviderConfigReference(r *runtime.ProviderConfigReference) {
t.Spec.ProviderConfigReference = r
}
`
f := jen.NewFilePath("pkg")
NewSetTypedProviderConfigReference("t", "example.org/runtime")(f, MockObject{Named: "Type"})
if diff := cmp.Diff(want, fmt.Sprintf("%#v", f)); diff != "" {
t.Errorf("NewSetProviderConfigReference(): -want, +got\n%s", diff)
}
}
func TestNewGetTypedProviderConfigReference(t *testing.T) {
want := `package pkg
import runtime "example.org/runtime"
// GetProviderConfigReference of this Type.
func (t *Type) GetProviderConfigReference() *runtime.ProviderConfigReference {
return t.Spec.ProviderConfigReference
}
`
f := jen.NewFilePath("pkg")
NewGetTypedProviderConfigReference("t", "example.org/runtime")(f, MockObject{Named: "Type"})
if diff := cmp.Diff(want, fmt.Sprintf("%#v", f)); diff != "" {
t.Errorf("NewGetProviderConfigReference(): -want, +got\n%s", diff)
}
}
func TestNewSetRootProviderConfigTypedReference(t *testing.T) {
want := `package pkg
import runtime "example.org/runtime"
// SetProviderConfigReference of this Type.
func (t *Type) SetProviderConfigReference(r runtime.ProviderConfigReference) {
t.ProviderConfigReference = r
}
`
f := jen.NewFilePath("pkg")
NewSetRootProviderConfigTypedReference("t", "example.org/runtime")(f, MockObject{Named: "Type"})
if diff := cmp.Diff(want, fmt.Sprintf("%#v", f)); diff != "" {
t.Errorf("NewSetRootProviderConfigReference(): -want, +got\n%s", diff)
}
}
func TestNewGetRootProviderConfigTypedReference(t *testing.T) {
want := `package pkg
import runtime "example.org/runtime"
// GetProviderConfigReference of this Type.
func (t *Type) GetProviderConfigReference() runtime.ProviderConfigReference {
return t.ProviderConfigReference
}
`
f := jen.NewFilePath("pkg")
NewGetRootProviderConfigTypedReference("t", "example.org/runtime")(f, MockObject{Named: "Type"})
if diff := cmp.Diff(want, fmt.Sprintf("%#v", f)); diff != "" {
t.Errorf("NewGetRootProviderConfigReference(): -want, +got\n%s", diff)
}
}

66
internal/method/resolver.go
View File

@ -27,9 +27,57 @@ import (
xptypes "github.com/crossplane/crossplane-tools/internal/types"
)
const (
funcnameNewAPINamespacedResolver = "NewAPINamespacedResolver"
typenameNamespacedResolutionRequest = "NamespacedResolutionRequest"
typenameNamespacedResolutionResponse = "NamespacedResolutionResponse"
typenameMultiNamespacedResolutionRequest = "MultiNamespacedResolutionRequest"
typenameMultiNamespacedResolutionResponse = "MultiNamespacedResolutionResponse"
)
const (
funcnameNewAPIResolver = "NewAPIResolver"
typenameResolutionRequest = "ResolutionRequest"
typenameResolutionResponse = "ResolutionResponse"
typenameMultiResolutionRequest = "MultiResolutionRequest"
typenameMultiResolutionResponse = "MultiResolutionResponse"
)
type names struct {
APIResolverFunctionName string
ResolutionRequestTypeName string
ResolutionResponseTypeName string
MultiResolutionRequestTypeName string
MultiResolutionResponseTypeName string
}
// NewResolveReferences returns a NewMethod that writes a ResolveReferences for
// given managed resource, if needed.
func NewResolveReferences(traverser *xptypes.Traverser, receiver, clientPath, referencePkgPath string) New {
return NewResolveReferencesCommon(traverser, receiver, clientPath, referencePkgPath, names{
APIResolverFunctionName: funcnameNewAPIResolver,
ResolutionRequestTypeName: typenameResolutionRequest,
ResolutionResponseTypeName: typenameResolutionResponse,
MultiResolutionRequestTypeName: typenameMultiResolutionRequest,
MultiResolutionResponseTypeName: typenameMultiResolutionResponse,
})
}
// NewResolveReferencesV2 returns a NewMethod that writes a ResolveReferences for
// given managed resource, if needed.
func NewResolveReferencesV2(traverser *xptypes.Traverser, receiver, clientPath, referencePkgPath string) New {
return NewResolveReferencesCommon(traverser, receiver, clientPath, referencePkgPath, names{
APIResolverFunctionName: funcnameNewAPINamespacedResolver,
ResolutionRequestTypeName: typenameNamespacedResolutionRequest,
ResolutionResponseTypeName: typenameNamespacedResolutionResponse,
MultiResolutionRequestTypeName: typenameMultiNamespacedResolutionRequest,
MultiResolutionResponseTypeName: typenameMultiNamespacedResolutionResponse,
})
}
// NewResolveReferencesCommon returns a NewMethod that writes a ResolveReferences for
// given managed resource, if needed.
func NewResolveReferencesCommon(traverser *xptypes.Traverser, receiver, clientPath, referencePkgPath string, names names) New {
return func(f *jen.File, o types.Object) {
n, ok := o.Type().(*types.Named)
if !ok {
@ -55,23 +103,23 @@ func NewResolveReferences(traverser *xptypes.Traverser, receiver, clientPath, re
for i, ref := range refs {
if ref.IsSlice {
hasMultiResolution = true
resolverCalls[i] = encapsulate(0, multiResolutionCall(ref, referencePkgPath), ref.GoValueFieldPath...).Line()
resolverCalls[i] = encapsulate(0, multiResolutionCall(ref, referencePkgPath, names.MultiResolutionRequestTypeName), ref.GoValueFieldPath...).Line()
} else {
hasSingleResolution = true
resolverCalls[i] = encapsulate(0, singleResolutionCall(ref, referencePkgPath), ref.GoValueFieldPath...).Line()
resolverCalls[i] = encapsulate(0, singleResolutionCall(ref, referencePkgPath, names.ResolutionRequestTypeName), ref.GoValueFieldPath...).Line()
}
}
var initStatements jen.Statement
if hasSingleResolution {
initStatements = append(initStatements, jen.Var().Id("rsp").Qual(referencePkgPath, "ResolutionResponse"))
initStatements = append(initStatements, jen.Var().Id("rsp").Qual(referencePkgPath, names.ResolutionResponseTypeName))
}
if hasMultiResolution {
initStatements = append(initStatements, jen.Line().Var().Id("mrsp").Qual(referencePkgPath, "MultiResolutionResponse"))
initStatements = append(initStatements, jen.Line().Var().Id("mrsp").Qual(referencePkgPath, names.MultiResolutionResponseTypeName))
}
f.Commentf("ResolveReferences of this %s.", o.Name())
f.Func().Params(jen.Id(receiver).Op("*").Id(o.Name())).Id("ResolveReferences").Params(jen.Id("ctx").Qual("context", "Context"), jen.Id("c").Qual(clientPath, "Reader")).Error().Block(
jen.Id("r").Op(":=").Qual(referencePkgPath, "NewAPIResolver").Call(jen.Id("c"), jen.Id(receiver)),
jen.Id("r").Op(":=").Qual(referencePkgPath, names.APIResolverFunctionName).Call(jen.Id("c"), jen.Id(receiver)),
jen.Line(),
&initStatements,
jen.Var().Err().Error(),
@ -113,7 +161,7 @@ func encapsulate(index int, callFn resolutionCallFn, fields ...string) *jen.Stat
}
}
func singleResolutionCall(ref Reference, referencePkgPath string) resolutionCallFn {
func singleResolutionCall(ref Reference, referencePkgPath, resolutionRequestTypeName string) resolutionCallFn {
return func(fields ...string) *jen.Statement {
prefixPath := jen.Id(fields[0])
for i := 1; i < len(fields)-1; i++ {
@ -137,7 +185,7 @@ func singleResolutionCall(ref Reference, referencePkgPath string) resolutionCall
return &jen.Statement{
jen.List(jen.Id("rsp"), jen.Err()).Op("=").Id("r").Dot("Resolve").Call(
jen.Id("ctx"),
jen.Qual(referencePkgPath, "ResolutionRequest").Values(jen.Dict{
jen.Qual(referencePkgPath, resolutionRequestTypeName).Values(jen.Dict{
jen.Id("CurrentValue"): currentValuePath,
jen.Id("Reference"): referenceFieldPath,
jen.Id("Selector"): selectorFieldPath,
@ -163,7 +211,7 @@ func singleResolutionCall(ref Reference, referencePkgPath string) resolutionCall
}
}
func multiResolutionCall(ref Reference, referencePkgPath string) resolutionCallFn {
func multiResolutionCall(ref Reference, referencePkgPath, multiResolutionRequestTypeName string) resolutionCallFn {
return func(fields ...string) *jen.Statement {
prefixPath := jen.Id(fields[0])
for i := 1; i < len(fields)-1; i++ {
@ -189,7 +237,7 @@ func multiResolutionCall(ref Reference, referencePkgPath string) resolutionCallF
return &jen.Statement{
jen.List(jen.Id("mrsp"), jen.Err()).Op("=").Id("r").Dot("ResolveMultiple").Call(
jen.Id("ctx"),
jen.Qual(referencePkgPath, "MultiResolutionRequest").Values(jen.Dict{
jen.Qual(referencePkgPath, multiResolutionRequestTypeName).Values(jen.Dict{
jen.Id("CurrentValues"): currentValuePath,
jen.Id("References"): referenceFieldPath,
jen.Id("Selector"): selectorFieldPath,

251
internal/method/resolver_test.go
View File

@ -333,6 +333,237 @@ func (mg *Model) ResolveReferences(ctx context.Context, c client.Reader) error {
return nil
}
`
generatedNamespaced = `package v1alpha1
import (
"context"
client "example.org/client"
reference "example.org/reference"
v1beta11 "github.com/crossplane/provider-aws/apis/ec2/v1beta1"
v1beta1 "github.com/crossplane/provider-aws/apis/identity/v1beta1"
errors "github.com/pkg/errors"
)
// ResolveReferences of this Model.
func (mg *Model) ResolveReferences(ctx context.Context, c client.Reader) error {
r := reference.NewAPINamespacedResolver(c, mg)
var rsp reference.NamespacedResolutionResponse
var mrsp reference.MultiNamespacedResolutionResponse
var err error
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: mg.Spec.ForProvider.APIID,
Extract: reference.ExternalName(),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.APIIDRef,
Selector: mg.Spec.ForProvider.APIIDSelector,
To: reference.To{
List: &Apigatewayv2ApiList{},
Managed: &Apigatewayv2Api{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.APIID")
}
mg.Spec.ForProvider.APIID = rsp.ResolvedValue
mg.Spec.ForProvider.APIIDRef = rsp.ResolvedReference
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: reference.FromPtrValue(mg.Spec.ForProvider.SecurityGroupID),
Extract: reference.ExternalName(),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.SecurityGroupIDRef,
Selector: mg.Spec.ForProvider.SecurityGroupIDSelector,
To: reference.To{
List: &SecurityGroupList{},
Managed: &SecurityGroup{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.SecurityGroupID")
}
mg.Spec.ForProvider.SecurityGroupID = reference.ToPtrValue(rsp.ResolvedValue)
mg.Spec.ForProvider.SecurityGroupIDRef = rsp.ResolvedReference
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: reference.FromPtrValue(mg.Spec.ForProvider.IAMRoleARN),
Extract: v1beta1.IAMRoleARN(),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.IAMRoleARNRef,
Selector: mg.Spec.ForProvider.IAMRoleARNSelector,
To: reference.To{
List: &v1beta1.IAMList{},
Managed: &v1beta1.IAM{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.IAMRoleARN")
}
mg.Spec.ForProvider.IAMRoleARN = reference.ToPtrValue(rsp.ResolvedValue)
mg.Spec.ForProvider.IAMRoleARNRef = rsp.ResolvedReference
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: reference.FromPtrValue(mg.Spec.ForProvider.NestedTargetWithPath),
Extract: v1beta1.IAMRoleARN("a.b.c"),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.NestedTargetWithPathRef,
Selector: mg.Spec.ForProvider.NestedTargetWithPathSelector,
To: reference.To{
List: &v1beta1.IAMList{},
Managed: &v1beta1.IAM{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.NestedTargetWithPath")
}
mg.Spec.ForProvider.NestedTargetWithPath = reference.ToPtrValue(rsp.ResolvedValue)
mg.Spec.ForProvider.NestedTargetWithPathRef = rsp.ResolvedReference
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: reference.FromPtrValue(mg.Spec.ForProvider.NestedTargetNoPath),
Extract: IAMRoleARN("a.b.c"),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.NestedTargetNoPathRef,
Selector: mg.Spec.ForProvider.NestedTargetNoPathSelector,
To: reference.To{
List: &v1beta1.IAMList{},
Managed: &v1beta1.IAM{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.NestedTargetNoPath")
}
mg.Spec.ForProvider.NestedTargetNoPath = reference.ToPtrValue(rsp.ResolvedValue)
mg.Spec.ForProvider.NestedTargetNoPathRef = rsp.ResolvedReference
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: reference.FromPtrValue(mg.Spec.ForProvider.NoArgNoPath),
Extract: IAMRoleARN(),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.NoArgNoPathRef,
Selector: mg.Spec.ForProvider.NoArgNoPathSelector,
To: reference.To{
List: &v1beta1.IAMList{},
Managed: &v1beta1.IAM{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.NoArgNoPath")
}
mg.Spec.ForProvider.NoArgNoPath = reference.ToPtrValue(rsp.ResolvedValue)
mg.Spec.ForProvider.NoArgNoPathRef = rsp.ResolvedReference
if mg.Spec.ForProvider.Network != nil {
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: mg.Spec.ForProvider.Network.VPCID,
Extract: reference.ExternalName(),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.Network.VPCIDRef,
Selector: mg.Spec.ForProvider.Network.VPCIDSelector,
To: reference.To{
List: &v1beta11.VPCList{},
Managed: &v1beta11.VPC{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.Network.VPCID")
}
mg.Spec.ForProvider.Network.VPCID = rsp.ResolvedValue
mg.Spec.ForProvider.Network.VPCIDRef = rsp.ResolvedReference
}
for i3 := 0; i3 < len(mg.Spec.ForProvider.OtherSetting); i3++ {
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: mg.Spec.ForProvider.OtherSetting[i3].OtherID,
Extract: reference.ExternalName(),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.OtherSetting[i3].OtherIDRef,
Selector: mg.Spec.ForProvider.OtherSetting[i3].OtherIDSelector,
To: reference.To{
List: &ClusterList{},
Managed: &Cluster{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.OtherSetting[i3].OtherID")
}
mg.Spec.ForProvider.OtherSetting[i3].OtherID = rsp.ResolvedValue
mg.Spec.ForProvider.OtherSetting[i3].OtherIDRef = rsp.ResolvedReference
}
mrsp, err = r.ResolveMultiple(ctx, reference.MultiNamespacedResolutionRequest{
CurrentValues: mg.Spec.ForProvider.SubnetIDs,
Extract: reference.ExternalName(),
Namespace: mg.GetNamespace(),
References: mg.Spec.ForProvider.SubnetIDRefs,
Selector: mg.Spec.ForProvider.SubnetIDSelector,
To: reference.To{
List: &SubnetList{},
Managed: &Subnet{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.SubnetIDs")
}
mg.Spec.ForProvider.SubnetIDs = mrsp.ResolvedValues
mg.Spec.ForProvider.SubnetIDRefs = mrsp.ResolvedReferences
mrsp, err = r.ResolveMultiple(ctx, reference.MultiNamespacedResolutionRequest{
CurrentValues: reference.FromPtrValues(mg.Spec.ForProvider.RouteTableIDs),
Extract: reference.ExternalName(),
Namespace: mg.GetNamespace(),
References: mg.Spec.ForProvider.RouteTableIDsRefs,
Selector: mg.Spec.ForProvider.RouteTableIDsSelector,
To: reference.To{
List: &RouteTableList{},
Managed: &RouteTable{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.RouteTableIDs")
}
mg.Spec.ForProvider.RouteTableIDs = reference.ToPtrValues(mrsp.ResolvedValues)
mg.Spec.ForProvider.RouteTableIDsRefs = mrsp.ResolvedReferences
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: reference.FromPtrValue(mg.Spec.ForProvider.CustomConfiguration),
Extract: Configuration(),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.CustomConfigurationRef,
Selector: mg.Spec.ForProvider.CustomConfigurationSelector,
To: reference.To{
List: &ConfigurationList{},
Managed: &Configuration{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.CustomConfiguration")
}
mg.Spec.ForProvider.CustomConfiguration = reference.ToPtrValue(rsp.ResolvedValue)
mg.Spec.ForProvider.CustomConfigurationRef = rsp.ResolvedReference
rsp, err = r.Resolve(ctx, reference.NamespacedResolutionRequest{
CurrentValue: reference.FromFloatPtrValue(mg.Spec.ForProvider.Count),
Extract: Count(),
Namespace: mg.GetNamespace(),
Reference: mg.Spec.ForProvider.CountRef,
Selector: mg.Spec.ForProvider.CountSelector,
To: reference.To{
List: &v1beta1.IAMList{},
Managed: &v1beta1.IAM{},
},
})
if err != nil {
return errors.Wrap(err, "mg.Spec.ForProvider.Count")
}
mg.Spec.ForProvider.Count = reference.ToFloatPtrValue(rsp.ResolvedValue)
mg.Spec.ForProvider.CountRef = rsp.ResolvedReference
return nil
}
`
)
@ -355,3 +586,23 @@ func TestNewResolveReferences(t *testing.T) {
t.Errorf("NewResolveReferences(): -want, +got\n%s", diff)
}
}
func TestNewResolveReferencesV2(t *testing.T) {
exported := packagestest.Export(t, packagestest.Modules, []packagestest.Module{{
Name: "golang.org/fake",
Files: map[string]any{
"v1alpha1/model.go": source,
},
}})
defer exported.Cleanup()
exported.Config.Mode = packages.NeedName | packages.NeedFiles | packages.NeedImports | packages.NeedDeps | packages.NeedTypes | packages.NeedSyntax
pkgs, err := packages.Load(exported.Config, fmt.Sprintf("file=%s", exported.File("golang.org/fake", "v1alpha1/model.go")))
if err != nil {
t.Error(err)
}
f := jen.NewFilePath("golang.org/fake/v1alpha1")
NewResolveReferencesV2(xptypes.NewTraverser(comments.In(pkgs[0])), "mg", "example.org/client", "example.org/reference")(f, pkgs[0].Types.Scope().Lookup("Model"))
if diff := cmp.Diff(generatedNamespaced, fmt.Sprintf("%#v", f)); diff != "" {
t.Errorf("NewResolveReferences(): -want, +got\n%s", diff)
}
}