centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 04:48:33 +07:00
Code Issues Packages Projects Releases Wiki Activity
Files
4a9ffe7c33335b00d46d46b77b5058657329fdcf
terraform-docs/terraform/resource_test.go
Khosrow Moossavi 4a9ffe7c33 Move plugin-sdk to in-tree in core repository 
Moving terraform-docs/plugin-sdk standalone module to in-tree, because
maintaining both of them, specifically if anything needs to be added to
Config, or terraform will required dual effort on both repository. As
such now everything is consolidated under one repository. Example usage
for plugin developer after this move is as follow:

```go
package main

import (
	_ "embed" //nolint

	"github.com/terraform-docs/terraform-docs/plugin"
	"github.com/terraform-docs/terraform-docs/print"
	"github.com/terraform-docs/terraform-docs/template"
	"github.com/terraform-docs/terraform-docs/terraform"
)

func main() {
	plugin.Serve(&plugin.ServeOpts{
		Name:    "template",
		Version: "0.1.0",
		Printer: printer,
	})
}

//go:embed sections.tmpl
var tplCustom []byte

// Print the custom format template. You have all the flexibility to generate
// the output however you choose to.
func printer(config *print.Config, module *terraform.Module) (string, error) {
	tpl := template.New(config,
		&template.Item{Name: "custom", Text: string(tplCustom)},
	)

	rendered, err := tpl.Render("custom", module)
	if err != nil {
		return "", err
	}

	return rendered, nil
}
```

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
2021-10-05 18:54:49 -04:00

324 lines
7.3 KiB
Go
Raw Blame History

/*
Copyright 2021 The terraform-docs Authors.
Licensed under the MIT license (the "License"); you may not
use this file except in compliance with the License.
You may obtain a copy of the License at the LICENSE file in
the root directory of this source tree.
*/
package terraform
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/terraform-docs/terraform-docs/internal/types"
)
func TestResourceSpec(t *testing.T) {
assert := assert.New(t)
resource := Resource{
Type: "private_key",
Name: "baz",
ProviderName: "tls",
ProviderSource: "hashicorp/tls",
Mode: "managed",
Version: types.String("latest"),
}
assert.Equal("tls_private_key.baz", resource.Spec())
}
func TestResourceMode(t *testing.T) {
tests := map[string]struct {
resource Resource
expectValue string
}{
"Managed": {
resource: Resource{
Type: "private_key",
ProviderName: "tls",
ProviderSource: "hashicorp/tls",
Mode: "managed",
Version: types.String("latest"),
},
expectValue: "resource",
},
"Data Source": {
resource: Resource{
Type: "caller_identity",
ProviderName: "aws",
ProviderSource: "hashicorp/aws",
Mode: "data",
Version: types.String("latest"),
},
expectValue: "data source",
},
"Invalid": {
resource: Resource{
Type: "caller_identity",
ProviderName: "aws",
ProviderSource: "hashicorp/aws",
Mode: "",
Version: types.String("latest"),
},
expectValue: "invalid",
},
}
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
assert := assert.New(t)
assert.Equal(tt.expectValue, tt.resource.GetMode())
})
}
}
func TestResourceURL(t *testing.T) {
tests := map[string]struct {
resource Resource
expectValue string
}{
"Generic URL construction": {
resource: Resource{
Type: "private_key",
ProviderName: "tls",
ProviderSource: "hashicorp/tls",
Mode: "managed",
Version: types.String("latest"),
},
expectValue: "https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key",
},
"Unable to construct URL": {
resource: Resource{
Type: "custom",
ProviderName: "nih",
ProviderSource: "http://nih.tld/some/path/to/provider/source",
Mode: "managed",
Version: types.String("latest"),
},
expectValue: "",
},
}
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
assert := assert.New(t)
assert.Equal(tt.expectValue, tt.resource.URL())
})
}
}
func TestResourcesSortedByType(t *testing.T) {
assert := assert.New(t)
resources := sampleResources()
sortResourcesByType(resources)
expected := []string{"a_a.a", "a_f.f", "b_b.b", "b_d.d", "c_c.c", "c_e.c", "c_e.d", "c_e_x.c", "c_e_x.d", "z_z.z", "a_a.a", "z_z.z", "a_a.a", "z_z.z"}
actual := make([]string, len(resources))
for k, i := range resources {
actual[k] = i.Spec()
}
assert.Equal(expected, actual)
}
func TestResourcesSortedByTypeAndMode(t *testing.T) {
assert := assert.New(t)
resources := sampleResources()
sortResourcesByType(resources)
expected := []string{"a_a.a (r)", "a_f.f (r)", "b_b.b (r)", "b_d.d (r)", "c_c.c (r)", "c_e.c (r)", "c_e.d (r)", "c_e_x.c (r)", "c_e_x.d (r)", "z_z.z (r)", "a_a.a (d)", "z_z.z (d)", "a_a.a", "z_z.z"}
actual := make([]string, len(resources))
for k, i := range resources {
mode := ""
switch i.Mode {
case "managed":
mode = " (r)"
case "data":
mode = " (d)"
}
actual[k] = i.Spec() + mode
}
assert.Equal(expected, actual)
}
func TestResourceVersion(t *testing.T) {
tests := map[string]struct {
constraint []string
expected string
}{
"exact version, without operator": {
constraint: []string{"1.2.3"},
expected: "1.2.3",
},
"exact version, with operator": {
constraint: []string{"= 1.2.3"},
expected: "1.2.3",
},
"exact version, with operator, without space": {
constraint: []string{"=1.2.3"},
expected: "1.2.3",
},
"exclude exact version, with space": {
constraint: []string{"!= 1.2.3"},
expected: "latest",
},
"exclude exact version, without space": {
constraint: []string{"!=1.2.3"},
expected: "latest",
},
"comparison version, with space": {
constraint: []string{"> 1.2.3"},
expected: "latest",
},
"comparison version, without space": {
constraint: []string{">1.2.3"},
expected: "latest",
},
"range version": {
constraint: []string{"> 1.2.3, < 2.0.0"},
expected: "latest",
},
"pessimistic version, with space": {
constraint: []string{"~> 1.2.3"},
expected: "latest",
},
"pessimistic version, without space": {
constraint: []string{"~>1.2.3"},
expected: "latest",
},
}
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
assert := assert.New(t)
assert.Equal(tt.expected, resourceVersion(tt.constraint))
})
}
}
func sampleResources() []*Resource {
return []*Resource{
{
Type: "e",
Name: "d",
ProviderName: "c",
ProviderSource: "hashicorp/e",
Mode: "managed",
Version: "1.5.0",
},
{
Type: "e",
Name: "c",
ProviderName: "c",
ProviderSource: "hashicorp/e",
Mode: "managed",
Version: "1.5.0",
},
{
Type: "e_x",
Name: "d",
ProviderName: "c",
ProviderSource: "hashicorp/e",
Mode: "managed",
Version: "1.5.0",
},
{
Type: "e_x",
Name: "c",
ProviderName: "c",
ProviderSource: "hashicorp/e",
Mode: "managed",
Version: "1.5.0",
},
{
Type: "a",
Name: "a",
ProviderName: "a",
ProviderSource: "hashicorp/a",
Mode: "managed",
Version: "1.1.0",
},
{
Type: "d",
Name: "d",
ProviderName: "b",
ProviderSource: "hashicorp/d",
Mode: "managed",
Version: "1.4.0",
},
{
Type: "b",
Name: "b",
ProviderName: "b",
ProviderSource: "hashicorp/b",
Mode: "managed",
Version: "1.2.0",
},
{
Type: "c",
Name: "c",
ProviderName: "c",
ProviderSource: "hashicorp/c",
Mode: "managed",
Version: "1.3.0",
},
{
Type: "f",
Name: "f",
ProviderName: "a",
ProviderSource: "hashicorp/f",
Mode: "managed",
Version: "1.6.0",
},
{
ProviderName: "z",
Type: "z",
Name: "z",
ProviderSource: "hashicorp/a",
Mode: "managed",
Version: "1.5.0",
},
{
ProviderName: "z",
Type: "z",
Name: "z",
ProviderSource: "hashicorp/a",
Mode: "data",
Version: "1.5.0",
},
{
ProviderName: "a",
Type: "a",
Name: "a",
ProviderSource: "hashicorp/a",
Mode: "data",
Version: "1.5.0",
},
{
ProviderName: "z",
Type: "z",
Name: "z",
ProviderSource: "hashicorp/a",
Mode: "",
Version: "1.5.0",
},
{
ProviderName: "a",
Type: "a",
Name: "a",
ProviderSource: "hashicorp/a",
Mode: "",
Version: "1.5.0",
},
}
}
Reference in New Issue View Git Blame Copy Permalink