pulumi/pkg/codegen/nodejs/doc_test.go
Praneet Loke bdc12b2c98
Fix csharp and nodejs doc links generated by resource docs generator (#4237)
* Decode the C# language info from the schema package and set it in the dotnet lang helper for docs. Pass the qualifier for C# property type strings based on whether it is an input or an output property.

* Don't pass a module name for Pulumi core types used in TS constructor and Function params.

* Add tests for generating doc links for nodejs types.

* Add test for confirming input doc link for C# type.

* Fix the C# type name for InvokeOptions.
2020-03-30 14:37:30 -07:00

53 lines
1.9 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.
// Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the
// goconst linter's warning.
//
// nolint: lll, goconst
package nodejs
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestDocLinkGenerationForPulumiTypes(t *testing.T) {
d := DocLanguageHelper{}
t.Run("GenerateCustomResourceOptionsLink", func(t *testing.T) {
expected := "/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions"
link := d.GetDocLinkForResourceType("pulumi", "", "CustomResourceOptions")
assert.Equal(t, expected, link)
})
t.Run("GenerateInvokeOptionsLink", func(t *testing.T) {
expected := "/docs/reference/pkg/nodejs/pulumi/pulumi/#InvokeOptions"
link := d.GetDocLinkForResourceType("pulumi", "", "InvokeOptions")
assert.Equal(t, expected, link)
})
}
func TestGetDocLinkForResourceType(t *testing.T) {
d := DocLanguageHelper{}
expected := "/docs/reference/pkg/nodejs/pulumi/aws/s3/#Bucket"
link := d.GetDocLinkForResourceType("aws", "s3", "Bucket")
assert.Equal(t, expected, link)
}
func TestGetDocLinkForResourceInputOrOutputType(t *testing.T) {
d := DocLanguageHelper{}
expected := "/docs/reference/pkg/nodejs/pulumi/aws/types/input/#BucketCorsRule"
link := d.GetDocLinkForResourceInputOrOutputType("aws", "s3", "BucketCorsRule", true)
assert.Equal(t, expected, link)
}