These changes support arbitrary combinations of input + plain types within a schema. Handling plain types at the property level was not sufficient to support such combinations. Reifying these types required updating quite a bit of code. This is likely to have caused some temporary complications, but should eventually lead to substantial simplification in the SDK and program code generators. With the new design, input and optional types are explicit in the schema type system. Optionals will only appear at the outermost level of a type (i.e. Input<Optional<>>, Array<Optional<>>, etc. will not occur). In addition to explicit input types, each object type now has a "plain" shape and an "input" shape. The former uses only plain types; the latter uses input shapes wherever a plain type is not specified. Plain types are indicated in the schema by setting the "plain" property of a type spec to true.
93 lines
2.7 KiB
Go
93 lines
2.7 KiB
Go
// Copyright 2016-2020, Pulumi Corporation.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// nolint: lll
|
|
package dotnet
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/pulumi/pulumi/pkg/v3/codegen"
|
|
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
var testPackageSpec = schema.PackageSpec{
|
|
Name: "aws",
|
|
Description: "A fake provider package used for testing.",
|
|
Meta: &schema.MetadataSpec{
|
|
ModuleFormat: "(.*)(?:/[^/]*)",
|
|
},
|
|
Types: map[string]schema.ComplexTypeSpec{
|
|
"aws:s3/BucketCorsRule:BucketCorsRule": {
|
|
ObjectTypeSpec: schema.ObjectTypeSpec{
|
|
Description: "The resource options object.",
|
|
Type: "object",
|
|
Properties: map[string]schema.PropertySpec{
|
|
"stringProp": {
|
|
Description: "A string prop.",
|
|
TypeSpec: schema.TypeSpec{
|
|
Type: "string",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
Resources: map[string]schema.ResourceSpec{
|
|
"aws:s3/bucket:Bucket": {
|
|
InputProperties: map[string]schema.PropertySpec{
|
|
"corsRules": {
|
|
TypeSpec: schema.TypeSpec{
|
|
Ref: "#/types/aws:s3/BucketCorsRule:BucketCorsRule",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
func getTestPackage(t *testing.T) *schema.Package {
|
|
t.Helper()
|
|
|
|
pkg, err := schema.ImportSpec(testPackageSpec, nil)
|
|
assert.NoError(t, err, "could not import the test package spec")
|
|
return pkg
|
|
}
|
|
|
|
func TestGetDocLinkForResourceType(t *testing.T) {
|
|
pkg := getTestPackage(t)
|
|
|
|
d := DocLanguageHelper{}
|
|
expected := "/docs/reference/pkg/dotnet/Pulumi.Aws/Pulumi.Aws.S3.Bucket.html"
|
|
link := d.GetDocLinkForResourceType(pkg, "doesNotMatter", "Pulumi.Aws.S3.Bucket")
|
|
assert.Equal(t, expected, link)
|
|
}
|
|
|
|
func TestGetDocLinkForResourceInputOrOutputType(t *testing.T) {
|
|
pkg := getTestPackage(t)
|
|
|
|
namespaces := map[string]string{
|
|
"s3": "S3",
|
|
}
|
|
d := DocLanguageHelper{
|
|
Namespaces: namespaces,
|
|
}
|
|
expected := "/docs/reference/pkg/dotnet/Pulumi.Aws/Pulumi.Aws.S3.Inputs.BucketCorsRuleArgs.html"
|
|
// Generate the type string for the property type and use that to generate the doc link.
|
|
propertyType := codegen.UnwrapType(pkg.Resources[0].InputProperties[0].Type)
|
|
typeString := d.GetLanguageTypeString(pkg, "S3", propertyType, true)
|
|
link := d.GetDocLinkForResourceInputOrOutputType(pkg, "doesNotMatter", typeString, true)
|
|
assert.Equal(t, expected, link)
|
|
}
|