Add acceptance tests and ignore no such file or directory errors in cleaning rendered website dir

.changes/unreleased/BUG FIXES-20231108-172558.yaml

@@ -0,0 +1,6 @@
+kind: BUG FIXES
+body: 'generate: fix `no such file or directory` error when running `generate` with
+  no existing rendered website directory.'
+time: 2023-11-08T17:25:58.561956-05:00
+custom:
+  Issue: "296"

.copywrite.hcl

@@ -9,6 +9,9 @@ project {
     ".changes/unreleased/*.yaml",
     ".changie.yaml",
 
+    # examples used within documentation (prose)
+    "internal/provider/testdata/**",
+
     # GitHub issue template configuration
     ".github/ISSUE_TEMPLATE/*.yml",
 

.github/workflows/test.yml

@@ -33,5 +33,5 @@ jobs:
           args: --timeout=3m
       - name: go vet
         run: go vet ./...
-      - name: Run tests
-        run: go test -v -cover -race ./...
+      - name: Run acceptance tests
+        run: make testacc

GNUmakefile

@@ -1,14 +1,12 @@
-TEST?=./...
-
 default: build
 
-.PHONY: build test
+.PHONY: build testacc
 
 build:
 	go install ./cmd/tfplugindocs
 
-test:
-	go test $(TEST) $(TESTARGS) -timeout=5m
+testacc:
+	ACCTEST=1 go test -v -cover -race -timeout 120m ./...
 
 # Generate copywrite headers
 generate:

cmd/build/version.go

@@ -0,0 +1,18 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package build
+
+var (
+	// These vars will be set by goreleaser.
+	version string = `dev`
+	commit  string = ``
+)
+
+func GetVersion() string {
+	version := "tfplugindocs" + " Version " + version
+	if commit != "" {
+		version += " from commit " + commit
+	}
+	return version
+}

cmd/tfplugindocs/main.go

@@ -6,24 +6,9 @@ package main
 import (
 	"os"
 
-	"github.com/mattn/go-colorable"
-
 	"github.com/hashicorp/terraform-plugin-docs/internal/cmd"
 )
 
 func main() {
-	name := "tfplugindocs"
-	version := name + " Version " + version
-	if commit != "" {
-		version += " from commit " + commit
-	}
-
-	os.Exit(cmd.Run(
-		name,
-		version,
-		os.Args[1:],
-		os.Stdin,
-		colorable.NewColorableStdout(),
-		colorable.NewColorableStderr(),
-	))
+	os.Exit(cmd.Main())
 }

cmd/tfplugindocs/main_test.go

@@ -0,0 +1,40 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package main
+
+import (
+	"os"
+	"testing"
+
+	"github.com/rogpeppe/go-internal/testscript"
+
+	"github.com/hashicorp/terraform-plugin-docs/internal/cmd"
+)
+
+func TestMain(m *testing.M) {
+	os.Exit(testscript.RunMain(m, map[string]func() int{
+		"tfplugindocs": cmd.Main,
+	}))
+}
+
+func Test_GenerateAcceptanceTests(t *testing.T) {
+	t.Parallel()
+	if os.Getenv("ACCTEST") == "" {
+		t.Skip("ACCTEST env var not set; skipping acceptance tests.")
+	}
+	// Setting a custom temp dir instead of relying on os.TempDir()
+	// because Terraform providers fail to start up when $TMPDIR
+	// length is too long: https://github.com/hashicorp/terraform/issues/32787
+	tmpDir := "/tmp/tftmp"
+	err := os.MkdirAll(tmpDir, 0755)
+	if err != nil {
+		t.Errorf("Error creating temp dir for testing: %s", err.Error())
+	}
+	defer os.RemoveAll(tmpDir)
+
+	testscript.Run(t, testscript.Params{
+		Dir:         "testdata/scripts/generate",
+		WorkdirRoot: tmpDir,
+	})
+}