Merge pull request #21 from mdb/housekeeping

NOOP: misc housekeeping and cleanup

Author: mdb

.github/workflows/main.yml

@@ -1,3 +1,4 @@
+---
 name: CI/CD
 
 on: [push, pull_request]
@@ -6,15 +7,15 @@ jobs:
   build-snapshot:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Go
-      uses: actions/setup-go@v3
-      with:
-        go-version-file: go.mod
-    - name: Build
-      run: make
-    - name: Ensure unique version
-      run: make check-tag
+      - uses: actions/checkout@v3
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version-file: go.mod
+      - name: Build
+        run: make
+      - name: Ensure unique version
+        run: make check-tag
 
   build-and-publish-release:
     if: github.ref == 'refs/heads/main'

.goreleaser.yml

@@ -1,3 +1,4 @@
+---
 project_name: terraputs
 before:
   hooks:

Makefile

@@ -1,19 +1,11 @@
-VERSION = 0.1.6
+VERSION = 0.1.7
 SOURCE = ./...
 
-.PHONY: help \
-	build \
-	vet \
-	test-fmt \
-	test \
-	testdata \
-	clean
-
 .DEFAULT_GOAL := build
 
 help:
 	# build:     build terraputs (default make target)
-	# tools: 		 install build dependencies cited in tools.go
+	# tools:     install build dependencies cited in tools.go
 	# vet:       run 'go vet' against source code
 	# test-fmt:  validate that source code is formatted correctly
 	# test:      run automated tests
@@ -22,25 +14,31 @@ help:
 	# tag:       create a $(VERSION) git tag
 	# release:   build and publish a terraputs GitHub release
 	# clean:     remove testdata fixtures and compiled artifacts
+.PHONY: help
 
 tools:
 	echo "Installing tools from tools.go"
 	cat tools.go | grep _ | awk -F'"' '{print $$2}' | xargs -tI % go install %
+.PHONY: tools
 
 build: tools
 	goreleaser release \
 		--snapshot \
 		--skip-publish \
 		--rm-dist
+.PHONY: build
 
 vet:
 	go vet $(SOURCE)
+.PHONY: vet
 
 test-fmt:
 	test -z $(shell go fmt $(SOURCE))
+.PHONY: test-fmt
 
 test: vet test-fmt
 	go test -cover $(SOURCE) -count=1
+.PHONY: test
 
 define generate-testdata
 	docker run \
@@ -62,25 +60,30 @@ testdata:
 	$(call generate-testdata,emptyconfig,1.0.5)
 	$(call generate-testdata,emptyconfig-1.1.5,1.1.5)
 	$(call generate-testdata,basic-1.1.5,1.1.5)
+.PHONY: testdata
 
 check-tag:
 	./scripts/ensure_unique_version.sh "$(VERSION)"
+.PHONY: check-tag
 
 tag: check-tag
 	@echo "creating git tag $(VERSION)"
 	@git tag $(VERSION)
 	@git push origin $(VERSION)
+.PHONY: tag
 
 release: tools
 	goreleaser release \
 		--rm-dist
+.PHONY: release
 
 demo:
 	svg-term \
 		--cast 423523 \
 		--out demo.svg \
 		--window \
 		--no-cursor
+.PHONY: demo
 
 define clean-testdata
 	rm -rf testdata/$(1)/.terraform*
@@ -93,3 +96,4 @@ clean:
 	$(call clean-testdata,nooutputs)
 	$(call clean-testdata,emptyconfig)
 	rm -rf dist
+.PHONY: clean

main.go

@@ -27,9 +27,9 @@ var (
 const (
 	stateDesc          string = "Optional; the state JSON output by 'terraform show -json'. Read from stdin if omitted"
 	stateFileDesc      string = "Optional; the path to a local file containing 'terraform show -json' output"
-	headingDesc        string = "Optional; the heading text for use in the printed output."
-	outputDesc         string = "Optional; the output format. Supported values: md, html."
-	descriptionDesc    string = "Optional; a contextual description preceding the outputs."
+	headingDesc        string = "Optional; the heading text for use in the printed output"
+	outputDesc         string = "Optional; the output format. Supported values: md, html"
+	descriptionDesc    string = "Optional; a contextual description preceding the outputs"
 	versionDesc        string = "Print the current version and exit"
 	defaultHeading     string = "Outputs"
 	defaultDescription string = "Terraform state outputs."

main_test.go

@@ -12,6 +12,7 @@ import (
 
 const (
 	testVersion         string = "test"
+	testExecutable      string = "terraputs-test"
 	expectedEmptyOutput string = `## foo
 
 Terraform state outputs.
@@ -23,8 +24,8 @@ Terraform state outputs.
 )
 
 func TestMain(m *testing.M) {
-	// compile an 'terraputs' for for use in running tests
-	exe := exec.Command("go", "build", "-ldflags", fmt.Sprintf("-X main.version=%s", testVersion), "-o", "terraputs")
+	// compile a 'terraputs' for use in running tests
+	exe := exec.Command("go", "build", "-ldflags", fmt.Sprintf("-X main.version=%s", testVersion), "-o", testExecutable)
 	err := exe.Run()
 	if err != nil {
 		os.Exit(1)
@@ -33,7 +34,7 @@ func TestMain(m *testing.M) {
 	m.Run()
 
 	// delete the compiled terraputs
-	err = os.Remove("terraputs")
+	err = os.Remove(testExecutable)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -64,7 +65,7 @@ func TestHelpFlag(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(fmt.Sprintf("when terraputs is passed '%s'", test.arg), func(t *testing.T) {
-			output, err := exec.Command("./terraputs", test.arg).CombinedOutput()
+			output, err := exec.Command(fmt.Sprintf("./%s", testExecutable), test.arg).CombinedOutput()
 
 			if err != nil {
 				t.Errorf("expected '%s' not to error; got '%v'", test.arg, err)
@@ -89,7 +90,7 @@ func TestVersionArg(t *testing.T) {
 
 	for _, arg := range args {
 		t.Run(fmt.Sprintf("when terraputs is passed '%s'", arg), func(t *testing.T) {
-			output, err := exec.Command("./terraputs", arg).CombinedOutput()
+			output, err := exec.Command(fmt.Sprintf("./%s", testExecutable), arg).CombinedOutput()
 
 			if err != nil {
 				t.Errorf("expected '%s' not to cause error; got '%v'", arg, err)
@@ -108,63 +109,67 @@ func TestVersionArg(t *testing.T) {
 //	terraputs < stateFile
 //	cat stateFile | terraputs
 func TestTerraputs(t *testing.T) {
+	command := func(cmd string) string {
+		return fmt.Sprintf("./%s ", testExecutable) + cmd
+	}
+
 	tests := []struct {
 		command        string
 		expectedError  error
 		expectedOutput string
 	}{{
-		command:        `./terraputs -state $(cat testdata/basic/show.json)`,
+		command:        command("-state $(cat testdata/basic/show.json)"),
 		expectedOutput: expectedOutput("Outputs"),
 	}, {
-		command:        `./terraputs < testdata/basic/show.json`,
+		command:        command("< testdata/basic/show.json"),
 		expectedOutput: expectedOutput("Outputs"),
 	}, {
-		command:        `cat testdata/basic/show.json | ./terraputs`,
+		command:        fmt.Sprintf("cat testdata/basic/show.json | ./%s", testExecutable),
 		expectedOutput: expectedOutput("Outputs"),
 	}, {
-		command:        `./terraputs -state $(cat testdata/basic/show.json) -heading foo`,
+		command:        command("-state $(cat testdata/basic/show.json) -heading foo"),
 		expectedOutput: expectedOutput("foo"),
 	}, {
-		command:        `./terraputs -state $(cat testdata/basic/show.json) -description "A custom description."`,
+		command:        command(`-state $(cat testdata/basic/show.json) -description "A custom description."`),
 		expectedOutput: strings.Replace(expectedOutput("Outputs"), "Terraform state outputs", "A custom description", 1),
 	}, {
-		command:        `./terraputs -state $(cat testdata/nooutputs/show.json) -heading foo`,
+		command:        command("-state $(cat testdata/nooutputs/show.json) -heading foo"),
 		expectedOutput: expectedEmptyOutput,
 	}, {
-		command:        `./terraputs -state $(cat testdata/emptyconfig/show.json) -heading foo`,
+		command:        command("-state $(cat testdata/emptyconfig/show.json) -heading foo"),
 		expectedOutput: expectedEmptyOutput,
 	}, {
-		command:        `./terraputs -state-file testdata/basic/show.json -heading foo`,
+		command:        command("-state-file testdata/basic/show.json -heading foo"),
 		expectedOutput: expectedOutput("foo"),
 	}, {
-		command:        `./terraputs -state-file testdata/basic/show.json -heading foo -output html`,
+		command:        command("-state-file testdata/basic/show.json -heading foo -output html"),
 		expectedOutput: expectedHTMLOutput("foo"),
 	}, {
-		command:        `./terraputs -state-file testdata/basic/show.json -description "A custom description." -output html`,
+		command:        command(`-state-file testdata/basic/show.json -description "A custom description." -output html`),
 		expectedOutput: strings.Replace(expectedHTMLOutput("Outputs"), "Terraform state outputs", "A custom description", 1),
 	}, {
-		command:        `./terraputs -state-file testdata/nooutputs/show.json -heading foo`,
+		command:        command("-state-file testdata/nooutputs/show.json -heading foo"),
 		expectedOutput: expectedEmptyOutput,
 	}, {
-		command:        `./terraputs -state-file testdata/emptyconfig/show.json -heading foo`,
+		command:        command("-state-file testdata/emptyconfig/show.json -heading foo"),
 		expectedOutput: expectedEmptyOutput,
 	}, {
-		command:        `./terraputs -state-file testdata/basic/i-do-not-exist.json -heading foo`,
+		command:        command("-state-file testdata/basic/i-do-not-exist.json -heading foo"),
 		expectedError:  errors.New("exit status 1"),
 		expectedOutput: "open testdata/basic/i-do-not-exist.json: no such file or directory",
 	}, {
-		command:        `./terraputs -state $(cat testdata/basic/show.json) -state-file testdata/basic/show.json -heading foo`,
+		command:        command("-state $(cat testdata/basic/show.json) -state-file testdata/basic/show.json -heading foo"),
 		expectedError:  errors.New("exit status 1"),
 		expectedOutput: "'-state' and '-state-file' are mutually exclusive; specify just one",
 	}, {
-		command:        `./terraputs -state $(cat testdata/basic/show.json) -output foo`,
+		command:        command("-state $(cat testdata/basic/show.json) -output foo"),
 		expectedError:  errors.New("exit status 1"),
 		expectedOutput: "'foo' is not a supported output format. Supported formats: 'md' (default), 'html'",
 	}, {
-		command:        `./terraputs -state-file testdata/emptyconfig-1.1.5/show.json -heading foo`,
+		command:        command("-state-file testdata/emptyconfig-1.1.5/show.json -heading foo"),
 		expectedOutput: expectedEmptyOutput,
 	}, {
-		command:        `./terraputs -state $(cat testdata/basic-1.1.5/show.json)`,
+		command:        command("-state $(cat testdata/basic-1.1.5/show.json)"),
 		expectedOutput: expectedOutput("Outputs"),
 	}}
 

scripts/ensure_unique_version.sh

@@ -6,7 +6,7 @@ repo="mdb/terraputs"
 result="$(curl \
   --header "Accept: application/vnd.github.v3+json" \
   --write "%{http_code}" \
-  --out "/dev/null" \
+  --output "/dev/null" \
   "https://api.github.com/repos/${repo}/releases/tags/${version}")"
 
 if [ "${result}" = "404" ]; then