1cc084dc0e
See #6200 for a complete description of the issue. In short, we generate inconsistent names for object types depending on whether or not they are transitively reachable from resources or functions, which risks unintentional breaking changes due to schema updates. 1. Name "input" types differently: `TArgs` for a type that is used in resource inputs, having `Input<T>` properties, and `T` for a type that is used in invoke inputs. The same schema type can produce both. 2. Always keep the name `T` for output types, avoid appending `Result` to the name. 3. As needed, introduce a flag in the existing providers' schemas to avoid breaking changes. Consider removing it on a major version bump. Fixes #6200.
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/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 := pkg.Resources[0].InputProperties[0].Type
|
|
typeString := d.GetLanguageTypeString(pkg, "S3", propertyType, true, true, true)
|
|
link := d.GetDocLinkForResourceInputOrOutputType(pkg, "doesNotMatter", typeString, true)
|
|
assert.Equal(t, expected, link)
|
|
}
|