[testing] Stack context for value generation (#8108)
These changes add a context type to `resource/testing` that can be used to generate property values that are valid with respect to certain rules. The context represents a Pulumi stack, and contains a project name, stack name, and a list of resources. - URNs generated using a context will always use the context's project and stack name - Resource references generated using a context will always refer to resources in the context's resource list - Output values generated using a context will always pull dependencies from the context's resource list
This commit is contained in:
Pat Gavlin
GitHub
parent
98ef06ecb8
commit
5f9d211cae
|
|
@ -9,6 +9,105 @@ import (
|
|||
"github.com/pulumi/pulumi/sdk/v3/go/common/tokens"
|
||||
)
|
||||
|
||||
// A StackContext provides context for generating URNs and references to resources.
|
||||
type StackContext struct {
|
||||
projectName string
|
||||
stackName string
|
||||
resources []*resource.State
|
||||
}
|
||||
|
||||
// NewStackContext creates a new stack context with the given project name, stack name, and list of resources.
|
||||
func NewStackContext(projectName, stackName string, resources ...*resource.State) *StackContext {
|
||||
ctx := &StackContext{projectName: projectName, stackName: stackName}
|
||||
return ctx.Append(resources...)
|
||||
}
|
||||
|
||||
// ProjectName returns the context's project name.
|
||||
func (ctx *StackContext) ProjectName() string {
|
||||
return ctx.projectName
|
||||
}
|
||||
|
||||
// StackName returns the context's stack name.
|
||||
func (ctx *StackContext) StackName() string {
|
||||
return ctx.stackName
|
||||
}
|
||||
|
||||
// Resources returns the context's resources.
|
||||
func (ctx *StackContext) Resources() []*resource.State {
|
||||
return ctx.resources
|
||||
}
|
||||
|
||||
// Append creates a new context that contains the current context's resources and the given list of resources.
|
||||
func (ctx *StackContext) Append(r ...*resource.State) *StackContext {
|
||||
rs := make([]*resource.State, len(ctx.resources)+len(r))
|
||||
copy(rs, ctx.resources)
|
||||
copy(rs[len(ctx.resources):], r)
|
||||
return &StackContext{ctx.projectName, ctx.stackName, rs}
|
||||
}
|
||||
|
||||
// URNGenerator generates URNs that are valid within the context (i.e. the project name and stack name portions of the
|
||||
// generated URNs will always be taken from the context).
|
||||
func (ctx *StackContext) URNGenerator() *rapid.Generator {
|
||||
return urnGenerator(ctx)
|
||||
}
|
||||
|
||||
// URNSampler samples URNs from the stack's resources.
|
||||
func (ctx *StackContext) URNSampler() *rapid.Generator {
|
||||
return rapid.Custom(func(t *rapid.T) resource.URN {
|
||||
return rapid.SampledFrom(ctx.Resources()).Draw(t, "referenced resource").(*resource.State).URN
|
||||
})
|
||||
}
|
||||
|
||||
// ResourceReferenceGenerator generates resource.ResourceReference values. The referenced resource is
|
||||
func (ctx *StackContext) ResourceReferenceGenerator() *rapid.Generator {
|
||||
if len(ctx.Resources()) == 0 {
|
||||
panic("cannot generate resource references: stack context has no resources")
|
||||
}
|
||||
return resourceReferenceGenerator(ctx)
|
||||
}
|
||||
|
||||
// ResourceReferencePropertyGenerator generates resource reference resource.PropertyValues.
|
||||
func (ctx *StackContext) ResourceReferencePropertyGenerator() *rapid.Generator {
|
||||
return resourceReferencePropertyGenerator(ctx)
|
||||
}
|
||||
|
||||
// ArrayPropertyGenerator generates array resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// depth of the elements of the array.
|
||||
func (ctx *StackContext) ArrayPropertyGenerator(maxDepth int) *rapid.Generator {
|
||||
return arrayPropertyGenerator(ctx, maxDepth)
|
||||
}
|
||||
|
||||
// PropertyMapGenerator generates resource.PropertyMap values. The maxDepth parameter controls the maximum
|
||||
// depth of the elements of the map.
|
||||
func (ctx *StackContext) PropertyMapGenerator(maxDepth int) *rapid.Generator {
|
||||
return propertyMapGenerator(ctx, maxDepth)
|
||||
}
|
||||
|
||||
// ObjectPropertyGenerator generates object resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// depth of the elements of the object.
|
||||
func (ctx *StackContext) ObjectPropertyGenerator(maxDepth int) *rapid.Generator {
|
||||
return objectPropertyGenerator(ctx, maxDepth)
|
||||
}
|
||||
|
||||
// OutputPropertyGenerator generates output resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// depth of the resolved value of the output, if any. The output's dependencies will only refer to resources in
|
||||
// the context.
|
||||
func (ctx *StackContext) OutputPropertyGenerator(maxDepth int) *rapid.Generator {
|
||||
return outputPropertyGenerator(ctx, maxDepth)
|
||||
}
|
||||
|
||||
// SecretPropertyGenerator generates secret resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// depth of the plaintext value of the secret, if any.
|
||||
func (ctx *StackContext) SecretPropertyGenerator(maxDepth int) *rapid.Generator {
|
||||
return secretPropertyGenerator(ctx, maxDepth)
|
||||
}
|
||||
|
||||
// PropertyValueGenerator generates arbitrary resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// number of times the generator may recur.
|
||||
func (ctx *StackContext) PropertyValueGenerator(maxDepth int) *rapid.Generator {
|
||||
return propertyValueGenerator(ctx, maxDepth)
|
||||
}
|
||||
|
||||
// TypeGenerator generates legal tokens.Type values.
|
||||
func TypeGenerator() *rapid.Generator {
|
||||
return rapid.Custom(func(t *rapid.T) tokens.Type {
|
||||
|
|
@ -18,9 +117,22 @@ func TypeGenerator() *rapid.Generator {
|
|||
|
||||
// URNGenerator generates legal resource.URN values.
|
||||
func URNGenerator() *rapid.Generator {
|
||||
return urnGenerator(nil)
|
||||
}
|
||||
|
||||
func urnGenerator(ctx *StackContext) *rapid.Generator {
|
||||
var stackNameGenerator, projectNameGenerator *rapid.Generator
|
||||
if ctx == nil {
|
||||
stackNameGenerator = rapid.StringMatching(`^((:[^:])[^:]*)*:?$`)
|
||||
projectNameGenerator = rapid.StringMatching(`^((:[^:])[^:]*)*:?$`)
|
||||
} else {
|
||||
stackNameGenerator = rapid.Just(ctx.StackName())
|
||||
projectNameGenerator = rapid.Just(ctx.ProjectName())
|
||||
}
|
||||
|
||||
return rapid.Custom(func(t *rapid.T) resource.URN {
|
||||
stackName := tokens.QName(rapid.StringMatching(`^((:[^:])[^:]*)*:?$`).Draw(t, "stack name").(string))
|
||||
projectName := tokens.PackageName(rapid.StringMatching(`^((:[^:])[^:]*)*:?$`).Draw(t, "project name").(string))
|
||||
stackName := tokens.QName(stackNameGenerator.Draw(t, "stack name").(string))
|
||||
projectName := tokens.PackageName(projectNameGenerator.Draw(t, "project name").(string))
|
||||
parentType := TypeGenerator().Draw(t, "parent type").(tokens.Type)
|
||||
resourceType := TypeGenerator().Draw(t, "resource type").(tokens.Type)
|
||||
resourceName := tokens.QName(rapid.StringMatching(`^((:[^:])[^:]*)*:?$`).Draw(t, "resource name").(string))
|
||||
|
|
@ -125,32 +237,66 @@ func ArchivePropertyGenerator(maxDepth int) *rapid.Generator {
|
|||
|
||||
// ResourceReferenceGenerator generates resource.ResourceReference values.
|
||||
func ResourceReferenceGenerator() *rapid.Generator {
|
||||
return resourceReferenceGenerator(nil)
|
||||
}
|
||||
|
||||
func resourceReferenceGenerator(ctx *StackContext) *rapid.Generator {
|
||||
var resourceGenerator *rapid.Generator
|
||||
if ctx == nil {
|
||||
resourceGenerator = rapid.Custom(func(t *rapid.T) *resource.State {
|
||||
id := resource.ID("")
|
||||
custom := !rapid.Bool().Draw(t, "component").(bool)
|
||||
if custom {
|
||||
id = IDGenerator().Draw(t, "resource ID").(resource.ID)
|
||||
}
|
||||
|
||||
return &resource.State{
|
||||
URN: URNGenerator().Draw(t, "resource URN").(resource.URN),
|
||||
Custom: custom,
|
||||
ID: id,
|
||||
}
|
||||
})
|
||||
} else {
|
||||
resourceGenerator = rapid.SampledFrom(ctx.Resources())
|
||||
}
|
||||
|
||||
return rapid.Custom(func(t *rapid.T) resource.ResourceReference {
|
||||
id := rapid.OneOf(UnknownPropertyGenerator(), StringPropertyGenerator()).Draw(t, "referenced ID").(resource.PropertyValue)
|
||||
if id.IsString() && id.StringValue() == "" {
|
||||
id = resource.PropertyValue{}
|
||||
r := resourceGenerator.Draw(t, "referenced resource").(*resource.State)
|
||||
|
||||
// Only pull the resource's ID if it is a custom resource. Component resources do not have IDs.
|
||||
var id resource.PropertyValue
|
||||
if r.Custom {
|
||||
id = rapid.OneOf(UnknownPropertyGenerator(), rapid.Just(resource.NewStringProperty(string(r.ID)))).Draw(t, "referenced ID").(resource.PropertyValue)
|
||||
}
|
||||
|
||||
return resource.ResourceReference{
|
||||
URN: URNGenerator().Draw(t, "referenced URN").(resource.URN),
|
||||
URN: r.URN,
|
||||
ID: id,
|
||||
PackageVersion: SemverStringGenerator().Draw(t, "package version").(string),
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// ResourceReferencePropertyGenerator generates resource references resource.PropertyValues.
|
||||
// ResourceReferencePropertyGenerator generates resource reference resource.PropertyValues.
|
||||
func ResourceReferencePropertyGenerator() *rapid.Generator {
|
||||
return resourceReferencePropertyGenerator(nil)
|
||||
}
|
||||
|
||||
func resourceReferencePropertyGenerator(ctx *StackContext) *rapid.Generator {
|
||||
return rapid.Custom(func(t *rapid.T) resource.PropertyValue {
|
||||
return resource.NewResourceReferenceProperty(ResourceReferenceGenerator().Draw(t, "resource reference").(resource.ResourceReference))
|
||||
return resource.NewResourceReferenceProperty(resourceReferenceGenerator(ctx).Draw(t, "resource reference").(resource.ResourceReference))
|
||||
})
|
||||
}
|
||||
|
||||
// ArrayPropertyGenerator generates array resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// depth of the elements of the array.
|
||||
func ArrayPropertyGenerator(maxDepth int) *rapid.Generator {
|
||||
return arrayPropertyGenerator(nil, maxDepth)
|
||||
}
|
||||
|
||||
func arrayPropertyGenerator(ctx *StackContext, maxDepth int) *rapid.Generator {
|
||||
return rapid.Custom(func(t *rapid.T) resource.PropertyValue {
|
||||
return resource.NewArrayProperty(rapid.SliceOfN(PropertyValueGenerator(maxDepth-1), 0, 32).Draw(t, "array elements").([]resource.PropertyValue))
|
||||
return resource.NewArrayProperty(rapid.SliceOfN(propertyValueGenerator(ctx, maxDepth-1), 0, 32).Draw(t, "array elements").([]resource.PropertyValue))
|
||||
})
|
||||
}
|
||||
|
||||
|
|
@ -164,35 +310,60 @@ func PropertyKeyGenerator() *rapid.Generator {
|
|||
// PropertyMapGenerator generates resource.PropertyMap values. The maxDepth parameter controls the maximum
|
||||
// depth of the elements of the map.
|
||||
func PropertyMapGenerator(maxDepth int) *rapid.Generator {
|
||||
return propertyMapGenerator(nil, maxDepth)
|
||||
}
|
||||
|
||||
func propertyMapGenerator(ctx *StackContext, maxDepth int) *rapid.Generator {
|
||||
return rapid.Custom(func(t *rapid.T) resource.PropertyMap {
|
||||
return resource.PropertyMap(rapid.MapOfN(PropertyKeyGenerator(), PropertyValueGenerator(maxDepth-1), 0, 32).Draw(t, "property map").(map[resource.PropertyKey]resource.PropertyValue))
|
||||
return resource.PropertyMap(rapid.MapOfN(PropertyKeyGenerator(), propertyValueGenerator(ctx, maxDepth-1), 0, 32).Draw(t, "property map").(map[resource.PropertyKey]resource.PropertyValue))
|
||||
})
|
||||
}
|
||||
|
||||
// ObjectPropertyGenerator generates object resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// depth of the elements of the object.
|
||||
func ObjectPropertyGenerator(maxDepth int) *rapid.Generator {
|
||||
return objectPropertyGenerator(nil, maxDepth)
|
||||
}
|
||||
|
||||
func objectPropertyGenerator(ctx *StackContext, maxDepth int) *rapid.Generator {
|
||||
return rapid.Custom(func(t *rapid.T) resource.PropertyValue {
|
||||
return resource.NewObjectProperty(PropertyMapGenerator(maxDepth).Draw(t, "object contents").(resource.PropertyMap))
|
||||
return resource.NewObjectProperty(propertyMapGenerator(ctx, maxDepth).Draw(t, "object contents").(resource.PropertyMap))
|
||||
})
|
||||
}
|
||||
|
||||
// OutputPropertyGenerator generates output resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// depth of the resolved value of the output, if any.
|
||||
// depth of the resolved value of the output, if any. If a StackContext, the output's dependencies will only refer to
|
||||
// resources in the context.
|
||||
func OutputPropertyGenerator(maxDepth int) *rapid.Generator {
|
||||
return outputPropertyGenerator(nil, maxDepth)
|
||||
}
|
||||
|
||||
func outputPropertyGenerator(ctx *StackContext, maxDepth int) *rapid.Generator {
|
||||
var urnGenerator *rapid.Generator
|
||||
var dependenciesUpperBound int
|
||||
if ctx == nil {
|
||||
urnGenerator, dependenciesUpperBound = URNGenerator(), 32
|
||||
} else {
|
||||
urnGenerator = ctx.URNSampler()
|
||||
dependenciesUpperBound = len(ctx.Resources())
|
||||
if dependenciesUpperBound > 32 {
|
||||
dependenciesUpperBound = 32
|
||||
}
|
||||
}
|
||||
|
||||
return rapid.Custom(func(t *rapid.T) resource.PropertyValue {
|
||||
var element resource.PropertyValue
|
||||
|
||||
known := rapid.Bool().Draw(t, "known").(bool)
|
||||
if known {
|
||||
element = PropertyValueGenerator(maxDepth-1).Draw(t, "output element").(resource.PropertyValue)
|
||||
element = propertyValueGenerator(ctx, maxDepth-1).Draw(t, "output element").(resource.PropertyValue)
|
||||
}
|
||||
|
||||
return resource.NewOutputProperty(resource.Output{
|
||||
Element: element,
|
||||
Known: known,
|
||||
Secret: rapid.Bool().Draw(t, "secret").(bool),
|
||||
Dependencies: rapid.SliceOfN(URNGenerator(), 0, 32).Draw(t, "dependencies").([]resource.URN),
|
||||
Dependencies: rapid.SliceOfN(urnGenerator, 0, dependenciesUpperBound).Draw(t, "dependencies").([]resource.URN),
|
||||
})
|
||||
})
|
||||
}
|
||||
|
|
@ -200,9 +371,13 @@ func OutputPropertyGenerator(maxDepth int) *rapid.Generator {
|
|||
// SecretPropertyGenerator generates secret resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// depth of the plaintext value of the secret, if any.
|
||||
func SecretPropertyGenerator(maxDepth int) *rapid.Generator {
|
||||
return secretPropertyGenerator(nil, maxDepth)
|
||||
}
|
||||
|
||||
func secretPropertyGenerator(ctx *StackContext, maxDepth int) *rapid.Generator {
|
||||
return rapid.Custom(func(t *rapid.T) resource.PropertyValue {
|
||||
return resource.NewSecretProperty(&resource.Secret{
|
||||
Element: PropertyValueGenerator(maxDepth-1).Draw(t, "secret element").(resource.PropertyValue),
|
||||
Element: propertyValueGenerator(ctx, maxDepth-1).Draw(t, "secret element").(resource.PropertyValue),
|
||||
})
|
||||
})
|
||||
}
|
||||
|
|
@ -210,6 +385,10 @@ func SecretPropertyGenerator(maxDepth int) *rapid.Generator {
|
|||
// PropertyValueGenerator generates arbitrary resource.PropertyValues. The maxDepth parameter controls the maximum
|
||||
// number of times the generator may recur.
|
||||
func PropertyValueGenerator(maxDepth int) *rapid.Generator {
|
||||
return propertyValueGenerator(nil, maxDepth)
|
||||
}
|
||||
|
||||
func propertyValueGenerator(ctx *StackContext, maxDepth int) *rapid.Generator {
|
||||
choices := []*rapid.Generator{
|
||||
UnknownPropertyGenerator(),
|
||||
NullPropertyGenerator(),
|
||||
|
|
@ -217,15 +396,19 @@ func PropertyValueGenerator(maxDepth int) *rapid.Generator {
|
|||
NumberPropertyGenerator(),
|
||||
StringPropertyGenerator(),
|
||||
AssetPropertyGenerator(),
|
||||
ResourceReferencePropertyGenerator(),
|
||||
}
|
||||
|
||||
if ctx == nil || len(ctx.Resources()) > 0 {
|
||||
choices = append(choices, resourceReferencePropertyGenerator(ctx))
|
||||
}
|
||||
|
||||
if maxDepth > 0 {
|
||||
choices = append(choices,
|
||||
ArchivePropertyGenerator(maxDepth),
|
||||
ArrayPropertyGenerator(maxDepth),
|
||||
ObjectPropertyGenerator(maxDepth),
|
||||
OutputPropertyGenerator(maxDepth),
|
||||
SecretPropertyGenerator(maxDepth))
|
||||
arrayPropertyGenerator(ctx, maxDepth),
|
||||
objectPropertyGenerator(ctx, maxDepth),
|
||||
outputPropertyGenerator(ctx, maxDepth),
|
||||
secretPropertyGenerator(ctx, maxDepth))
|
||||
}
|
||||
return rapid.OneOf(choices...)
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue