Skip to content

Commit

Permalink
all: Fix various bugs related to resource type names that match the p…
Browse files Browse the repository at this point in the history
…rovider type name (i.e. no resource type suffix) (#421)

* remove launch.json file

* bug: skip static files that already exist rather than returning an error

* validate: Fixed bug where valid resource type names with the same name as the provider were flagged as invalid

* generate: Fixed bug where resource type with same name as provider overwrites all other documentation files

* added changelogs

* add note to readme
  • Loading branch information
austinvalle authored Nov 26, 2024
1 parent 4209153 commit 11fcc79
Show file tree
Hide file tree
Showing 9 changed files with 102 additions and 28 deletions.
6 changes: 6 additions & 0 deletions .changes/unreleased/BUG FIXES-20241118-125001.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: BUG FIXES
body: 'validate: Fixed a bug that caused false positive validation errors for resource
types that have the same name as the provider.'
time: 2024-11-18T12:50:01.114497-05:00
custom:
Issue: "419"
7 changes: 7 additions & 0 deletions .changes/unreleased/BUG FIXES-20241118-125100.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
kind: BUG FIXES
body: 'generate: Fixed a bug that caused all generated resource documentation to have
the same content when the provider has a resource type with the same name as the
provider.'
time: 2024-11-18T12:51:00.736136-05:00
custom:
Issue: "419"
6 changes: 6 additions & 0 deletions .changes/unreleased/BUG FIXES-20241118-125204.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: BUG FIXES
body: 'generate: Fixed a bug that would return an error when a static file exists
in both `templates` and `docs`, which will now be ignored.'
time: 2024-11-18T12:52:04.748022-05:00
custom:
Issue: "421"
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ tfproviderdocsgen
# JetBrains IDEs files
.idea/
*.iws

# VSCode files
.vscode
17 changes: 0 additions & 17 deletions .vscode/launch.json

This file was deleted.

5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,11 @@ When you run `tfplugindocs`, by default from the root directory of a provider co
* Generate function template files, if missing (Requires Terraform v1.8.0+)
* Generate ephemeral resource template files, if missing (Requires Terraform v1.10.0+)
* Copy all non-template files to the output website directory
> [!NOTE]
>
> Non-template files that already exist in the output website directory will not be overwritten.
* Process all the remaining templates to generate files for the output website directory
For inspiration, you can look at the templates and output of the
Expand Down
25 changes: 20 additions & 5 deletions internal/check/file_mismatch.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func (check *FileMismatchCheck) Run() error {
return result
}

// ResourceFileMismatchCheck checks for mismatched files, either missing or extraneous, against the resource/datasouce schema
// ResourceFileMismatchCheck checks for mismatched files, either missing or extraneous, against the resource/datasource schema
func (check *FileMismatchCheck) ResourceFileMismatchCheck(files []os.DirEntry, resourceType string, schemas map[string]*tfjson.Schema) error {
if len(files) == 0 {
log.Printf("[DEBUG] Skipping %s file mismatch checks due to missing file list", resourceType)
Expand Down Expand Up @@ -200,7 +200,11 @@ func (check *FileMismatchCheck) FunctionFileMismatchCheck(files []os.DirEntry, f

func (check *FileMismatchCheck) IgnoreFileMismatch(file string) bool {
for _, ignoreResourceName := range check.Options.IgnoreFileMismatch {
if ignoreResourceName == fileResourceName(check.Options.ProviderShortName, file) {
if ignoreResourceName == fileResourceNameWithProvider(check.Options.ProviderShortName, file) {
return true
} else if ignoreResourceName == TrimFileExtension(file) {
// While uncommon, it is valid for a resource type to be named the same as the provider itself.
// https://github.com/hashicorp/terraform-plugin-docs/issues/419
return true
}
}
Expand All @@ -219,7 +223,13 @@ func (check *FileMismatchCheck) IgnoreFileMissing(resourceName string) bool {
}

func fileHasResource(schemaResources map[string]*tfjson.Schema, providerName, file string) bool {
if _, ok := schemaResources[fileResourceName(providerName, file)]; ok {
if _, ok := schemaResources[fileResourceNameWithProvider(providerName, file)]; ok {
return true
}

// While uncommon, it is valid for a resource type to be named the same as the provider itself.
// https://github.com/hashicorp/terraform-plugin-docs/issues/419
if _, ok := schemaResources[TrimFileExtension(file)]; ok {
return true
}

Expand All @@ -234,7 +244,7 @@ func fileHasFunction(functions map[string]*tfjson.FunctionSignature, file string
return false
}

func fileResourceName(providerName, fileName string) string {
func fileResourceNameWithProvider(providerName, fileName string) string {
resourceSuffix := TrimFileExtension(fileName)

return fmt.Sprintf("%s_%s", providerName, resourceSuffix)
Expand All @@ -244,7 +254,12 @@ func resourceHasFile(files []os.DirEntry, providerName, resourceName string) boo
var found bool

for _, file := range files {
if fileResourceName(providerName, file.Name()) == resourceName {
if fileResourceNameWithProvider(providerName, file.Name()) == resourceName {
found = true
break
} else if TrimFileExtension(file.Name()) == resourceName {
// While uncommon, it is valid for a resource type to be named the same as the provider itself.
// https://github.com/hashicorp/terraform-plugin-docs/issues/419
found = true
break
}
Expand Down
47 changes: 46 additions & 1 deletion internal/check/file_mismatch_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ func TestFileResourceName(t *testing.T) {
testCase := testCase
t.Run(name, func(t *testing.T) {
t.Parallel()
got := fileResourceName("test", testCase.File)
got := fileResourceNameWithProvider("test", testCase.File)
want := testCase.Expect

if got != want {
Expand Down Expand Up @@ -115,6 +115,19 @@ func TestFileMismatchCheck(t *testing.T) {
},
},
},
"all found - resource with no suffix": {
ResourceFiles: fstest.MapFS{
"test.md": {},
},
Options: &FileMismatchOptions{
ProviderShortName: "test",
Schema: &tfjson.ProviderSchema{
ResourceSchemas: map[string]*tfjson.Schema{
"test": {},
},
},
},
},
"all found - function": {
FunctionFiles: fstest.MapFS{
"function1.md": {},
Expand Down Expand Up @@ -181,6 +194,23 @@ func TestFileMismatchCheck(t *testing.T) {
},
},
},
"ignore extra file - resource with no suffix": {
ResourceFiles: fstest.MapFS{
"resource1.md": {},
"resource2.md": {},
"test.md": {},
},
Options: &FileMismatchOptions{
IgnoreFileMismatch: []string{"test"},
ProviderShortName: "test",
Schema: &tfjson.ProviderSchema{
ResourceSchemas: map[string]*tfjson.Schema{
"test_resource1": {},
"test_resource2": {},
},
},
},
},
"ignore extra file - function": {
FunctionFiles: fstest.MapFS{
"function1.md": {},
Expand Down Expand Up @@ -214,6 +244,21 @@ func TestFileMismatchCheck(t *testing.T) {
},
ExpectError: true,
},
"missing file - resource with no suffix": {
ResourceFiles: fstest.MapFS{
"resource1.md": {},
},
Options: &FileMismatchOptions{
ProviderShortName: "test",
Schema: &tfjson.ProviderSchema{
ResourceSchemas: map[string]*tfjson.Schema{
"test_resource1": {},
"test": {},
},
},
},
ExpectError: true,
},
"missing file - function": {
FunctionFiles: fstest.MapFS{
"function1.md": {},
Expand Down
14 changes: 9 additions & 5 deletions internal/provider/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package provider

import (
"errors"
"fmt"
"io"
"log"
Expand Down Expand Up @@ -45,6 +46,10 @@ func copyFile(srcPath, dstPath string, mode os.FileMode) error {
// If the destination file already exists, we shouldn't blow it away
dstFile, err := os.OpenFile(dstPath, os.O_WRONLY|os.O_CREATE|os.O_EXCL, mode)
if err != nil {
// If the file already exists, we can skip it without returning an error.
if errors.Is(err, os.ErrExist) {
return nil
}
return err
}
defer dstFile.Close()
Expand All @@ -71,16 +76,15 @@ func removeAllExt(file string) string {
// has either the providerShortName or the providerShortName concatenated with the
// templateFileName (stripped of file extension.
func resourceSchema(schemas map[string]*tfjson.Schema, providerShortName, templateFileName string) (*tfjson.Schema, string) {
if schema, ok := schemas[providerShortName]; ok {
return schema, providerShortName
}

resName := providerShortName + "_" + removeAllExt(templateFileName)

if schema, ok := schemas[resName]; ok {
return schema, resName
}

if schema, ok := schemas[providerShortName]; ok {
return schema, providerShortName
}

return nil, resName
}

Expand Down

0 comments on commit 11fcc79

Please sign in to comment.