Tools apicovered and apiunused

Checks for coverage/usage of the go-gitlab package

Author: armsnyder

GNUmakefile

@@ -50,6 +50,12 @@ lint-generated: generate ## Check that "make generate" was called. Note this onl
 		exit 1; \
 	}
 
+apicovered: tool-apicovered ## Run an analysis tool to estimate the GitLab API coverage.
+	@$(GOBIN)/apicovered ./gitlab
+
+apiunused: tool-apiunused ## Run an analysis tool to output unused parts of the go-gitlab package.
+	@$(GOBIN)/apiunused ./gitlab
+
 SERVICE ?= gitlab-ce
 GITLAB_TOKEN ?= ACCTEST1234567890123
 GITLAB_BASE_URL ?= http://127.0.0.1:8080/api/v4
@@ -79,6 +85,12 @@ tool-tfplugindocs:
 tool-shfmt:
 	@$(call install-tool, mvdan.cc/sh/v3/cmd/shfmt)
 
+tool-apicovered:
+	@$(call install-tool, ./cmd/apicovered)
+
+tool-apiunused:
+	@$(call install-tool, ./cmd/apiunused)
+
 define install-tool
 	cd tools && GOBIN=$(GOBIN) go install $(1)
 endef

tools/cmd/apicovered/main.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"os"
+
+	"github.com/gitlabhq/terraform-provider-gitlab/tools/passes/apicovered"
+	"golang.org/x/tools/go/analysis/singlechecker"
+)
+
+func main() {
+	apicovered.Output = os.Stdout
+	singlechecker.Main(apicovered.Analyzer)
+}

tools/cmd/apiunused/main.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"os"
+
+	"github.com/gitlabhq/terraform-provider-gitlab/tools/passes/apiunused"
+	"golang.org/x/tools/go/analysis/singlechecker"
+)
+
+func main() {
+	apiunused.Output = os.Stdout
+	singlechecker.Main(apiunused.Analyzer)
+}

tools/go.mod

@@ -6,5 +6,6 @@ require (
 	github.com/bflad/tfproviderlint v0.27.1
 	github.com/golangci/golangci-lint v1.44.0
 	github.com/hashicorp/terraform-plugin-docs v0.5.1
+	golang.org/x/tools v0.1.9-0.20211228192929-ee1ca4ffc4da
 	mvdan.cc/sh/v3 v3.4.2
 )

tools/go.sum

@@ -135,12 +135,8 @@ github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
 github.com/bflad/gopaniccheck v0.1.0 h1:tJftp+bv42ouERmUMWLoUn/5bi/iQZjHPznM00cP/bU=
 github.com/bflad/gopaniccheck v0.1.0/go.mod h1:ZCj2vSr7EqVeDaqVsWN4n2MwdROx1YL+LFo47TSWtsA=
-github.com/bflad/tfproviderlint v0.27.0 h1:KXF+dYaWJ/OSVyWIrk2NIYgQBMDDSOC4VQB/P+P5nhI=
-github.com/bflad/tfproviderlint v0.27.0/go.mod h1:7Z9Pyl1Z1UWJcPBuyjN89D2NaJGpjReQb5NoaaQCthQ=
 github.com/bflad/tfproviderlint v0.27.1 h1:sYlc6R8cQ0NtaCCA7Oh1ld8xfn0oiwn6mm4unooi2fo=
 github.com/bflad/tfproviderlint v0.27.1/go.mod h1:7Z9Pyl1Z1UWJcPBuyjN89D2NaJGpjReQb5NoaaQCthQ=
-github.com/bflad/tfproviderlint v0.28.0 h1:1JA8ys764WisN81Bx54L9ba85Dews8dU1VU2dZ3ByHk=
-github.com/bflad/tfproviderlint v0.28.0/go.mod h1:7Z9Pyl1Z1UWJcPBuyjN89D2NaJGpjReQb5NoaaQCthQ=
 github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d h1:xDfNPAt8lFiC1UJrqV3uuy861HCTo708pDMbjHHdCas=
 github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d/go.mod h1:6QX/PXZ00z/TKoufEY6K/a0k6AhaJrQKdFe6OfVXsa4=
 github.com/bgentry/speakeasy v0.1.0 h1:ByYyxL9InA1OWqxJqqp2A5pYHUrCiAL6K3J+LKSsQkY=

tools/passes/apicovered/apicovered.go

@@ -0,0 +1,137 @@
+package apicovered
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"reflect"
+	"sort"
+	"text/tabwriter"
+
+	"github.com/gitlabhq/terraform-provider-gitlab/tools/passes"
+	"github.com/gitlabhq/terraform-provider-gitlab/tools/passes/gogitlab"
+	"github.com/gitlabhq/terraform-provider-gitlab/tools/passes/usage"
+	"golang.org/x/tools/go/analysis"
+)
+
+var Output io.Writer = io.Discard
+
+var Analyzer = &analysis.Analyzer{
+	Doc:        "Estimate usage of the go-gitlab package",
+	Name:       "apicovered",
+	ResultType: reflect.TypeOf((*Result)(nil)),
+	Requires:   []*analysis.Analyzer{gogitlab.Analyzer, usage.Analyzer},
+	Run:        run,
+}
+
+type Result struct {
+	CoverageByFile map[string]Fraction
+}
+
+type Fraction struct {
+	Count int
+	Total int
+}
+
+func run(pass *analysis.Pass) (interface{}, error) {
+	goGitLab := pass.ResultOf[gogitlab.Analyzer].(*gogitlab.Result)
+	usage := pass.ResultOf[usage.Analyzer].(*usage.Result)
+
+	result := &Result{
+		CoverageByFile: make(map[string]Fraction),
+	}
+
+	process(result, goGitLab.TypeToFilenames, usage.Types)
+	process(result, goGitLab.MethodToFilenames, usage.Methods)
+	process(result, goGitLab.FieldToFilenames, usage.Fields)
+
+	if !passes.IsTestPackage(pass) {
+		writeOutput(result)
+	}
+
+	return result, nil
+}
+
+func process(result *Result, nameToFilenames gogitlab.MultiMap, seen usage.Set) {
+	for _, filenames := range nameToFilenames {
+		for _, filename := range filenames {
+			coverage := result.CoverageByFile[filename]
+			coverage.Total++
+			result.CoverageByFile[filename] = coverage
+		}
+	}
+
+	for name := range seen {
+		for _, filename := range nameToFilenames[name] {
+			coverage := result.CoverageByFile[filename]
+			coverage.Count++
+			result.CoverageByFile[filename] = coverage
+		}
+	}
+}
+
+func writeOutput(result *Result) {
+	type row struct {
+		filename        string
+		coverageString  string
+		coveragePercent int
+	}
+
+	newRow := func(filename string, fraction Fraction) row {
+		return row{
+			filename:        filename,
+			coverageString:  fmt.Sprintf("%d/%d", fraction.Count, fraction.Total),
+			coveragePercent: makePercent(fraction.Count, fraction.Total),
+		}
+	}
+
+	var rows []row
+
+	for filename, coverage := range result.CoverageByFile {
+		rows = append(rows, newRow(filename, coverage))
+	}
+
+	sort.Slice(rows, func(i, j int) bool {
+		if rows[i].coveragePercent == rows[j].coveragePercent {
+			return rows[i].filename < rows[j].filename
+		}
+		return rows[i].coveragePercent < rows[j].coveragePercent
+	})
+
+	totalRow := func() row {
+		var totalCoverage Fraction
+		for _, coverage := range result.CoverageByFile {
+			totalCoverage.Count += coverage.Count
+			totalCoverage.Total += coverage.Total
+		}
+		return newRow("Total", totalCoverage)
+	}()
+
+	w := tabwriter.NewWriter(os.Stdout, 0, 0, 3, ' ', 0)
+
+	writeRow := func(row row) {
+		fmt.Fprintf(w, "%s\t%d%%\t%s\n", row.filename, row.coveragePercent, row.coverageString)
+	}
+
+	fmt.Fprintf(w, "Filename\tCoverage\tLines\n")
+	fmt.Fprintln(w, "--------\t--------\t-----")
+
+	for _, row := range rows {
+		writeRow(row)
+	}
+
+	fmt.Fprintln(w, "---\t---\t---")
+	writeRow(totalRow)
+
+	w.Flush()
+}
+
+func makePercent(n, d int) int {
+	if d == 0 {
+		if n == 0 {
+			return 100
+		}
+		return 0
+	}
+	return 100 * n / d
+}

tools/passes/apiunused/apiunused.go

@@ -0,0 +1,90 @@
+package apiunused
+
+import (
+	"encoding/json"
+	"io"
+	"os"
+	"reflect"
+
+	"github.com/gitlabhq/terraform-provider-gitlab/tools/passes"
+	"github.com/gitlabhq/terraform-provider-gitlab/tools/passes/gogitlab"
+	"github.com/gitlabhq/terraform-provider-gitlab/tools/passes/usage"
+	"golang.org/x/tools/go/analysis"
+)
+
+var Output io.Writer = io.Discard
+
+var Analyzer = &analysis.Analyzer{
+	Doc:        "Estimate the unused pieces of the go-gitlab package",
+	Name:       "apiunused",
+	ResultType: reflect.TypeOf((*Result)(nil)),
+	Requires:   []*analysis.Analyzer{gogitlab.Analyzer, usage.Analyzer},
+	Run:        run,
+}
+
+type Result struct {
+	UnusedByFile map[string]Unused
+}
+
+type Unused struct {
+	Types   []string `json:"types,omitempty"`
+	Funcs   []string `json:"funcs,omitempty"`
+	Methods []string `json:"methods,omitempty"`
+	Fields  []string `json:"fields,omitempty"`
+}
+
+func run(pass *analysis.Pass) (interface{}, error) {
+	goGitLab := pass.ResultOf[gogitlab.Analyzer].(*gogitlab.Result)
+	usage := pass.ResultOf[usage.Analyzer].(*usage.Result)
+
+	result := &Result{
+		UnusedByFile: make(map[string]Unused),
+	}
+
+	processUnused(result, goGitLab.TypeToFilenames, usage.Types,
+		func(item Unused, name string) Unused {
+			item.Types = append(item.Types, name)
+			return item
+		})
+
+	processUnused(result, goGitLab.FuncToFilenames, usage.Funcs,
+		func(item Unused, name string) Unused {
+			item.Funcs = append(item.Funcs, name)
+			return item
+		})
+
+	processUnused(result, goGitLab.MethodToFilenames, usage.Methods,
+		func(item Unused, name string) Unused {
+			item.Methods = append(item.Methods, name)
+			return item
+		})
+
+	processUnused(result, goGitLab.FieldToFilenames, usage.Fields,
+		func(item Unused, name string) Unused {
+			item.Fields = append(item.Fields, name)
+			return item
+		})
+
+	if !passes.IsTestPackage(pass) {
+		writeOutput(result)
+	}
+
+	return result, nil
+}
+
+func processUnused(result *Result, nameToFilenames gogitlab.MultiMap, seen usage.Set, mutFn func(Unused, string) Unused) {
+	for name, filenames := range nameToFilenames {
+		if !seen[name] {
+			for _, filename := range filenames {
+				result.UnusedByFile[filename] = mutFn(result.UnusedByFile[filename], name)
+			}
+		}
+	}
+}
+
+func writeOutput(result *Result) {
+	e := json.NewEncoder(os.Stdout)
+	e.SetIndent("", "  ")
+
+	_ = e.Encode(result.UnusedByFile)
+}

tools/passes/gen_util.go

@@ -0,0 +1,21 @@
+package passes
+
+import (
+	"strings"
+
+	"golang.org/x/tools/go/analysis"
+)
+
+func IsTestPackage(pass *analysis.Pass) bool {
+	if strings.HasSuffix(pass.Pkg.Path(), ".test") {
+		return true
+	}
+
+	for _, f := range pass.Files {
+		if strings.HasSuffix(pass.Fset.File(f.Pos()).Name(), "_test.go") {
+			return true
+		}
+	}
+
+	return false
+}