[chore] add checkapi to tools (#12954)

Adds checkapi to the tools and a make target to run it.

Fixes #12360

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Evan Bradley <[email protected]>
Co-authored-by: Alex Boten <[email protected]>

Author: 4 people

.checkapi.yaml

@@ -0,0 +1,8 @@
+ignored_paths:
+  - confmap/doc_test.go
+excluded_files:
+  - example_*.go
+  - "*_test.go"
+unkeyed_literal_initialization:
+  enabled: true
+  limit: 6

.github/workflows/build-and-test.yml

@@ -111,6 +111,8 @@ jobs:
         run: make misspell
       - name: checkdoc
         run: make checkdoc
+      - name: checkapi
+        run: make checkapi
       - name: Check for go mod dependency changes
         run: |
           make gotidy

Makefile

@@ -315,6 +315,10 @@ certs:
 certs-dryrun:
 	@internal/buildscripts/gen-certs.sh -d
 
+.PHONY: checkapi
+checkapi: $(CHECKAPI)
+	$(CHECKAPI) -folder . -config .checkapi.yaml
+
 # Verify existence of READMEs for components specified as default components in the collector.
 .PHONY: checkdoc
 checkdoc: $(CHECKFILE)

Makefile.Common

@@ -26,6 +26,7 @@ JUNIT_OUT_DIR ?= $(TOOLS_MOD_DIR)/testresults
 
 ADDLICENSE   := $(TOOLS_BIN_DIR)/addlicense
 APIDIFF      := $(TOOLS_BIN_DIR)/apidiff
+CHECKAPI     := $(TOOLS_BIN_DIR)/checkapi
 CHECKFILE    := $(TOOLS_BIN_DIR)/checkfile
 CHLOGGEN     := $(TOOLS_BIN_DIR)/chloggen
 CROSSLINK    := $(TOOLS_BIN_DIR)/crosslink

component/build_info.go

@@ -14,6 +14,9 @@ type BuildInfo struct {
 
 	// Version string.
 	Version string
+
+	// prevent unkeyed literal initialization
+	_ struct{}
 }
 
 // NewDefaultBuildInfo returns a default BuildInfo.

config/configmiddleware/configmiddleware.go

@@ -29,6 +29,8 @@ var (
 type Config struct {
 	// ID specifies the name of the extension to use.
 	ID component.ID `mapstructure:"id,omitempty"`
+	// prevent unkeyed literal initialization
+	_ struct{}
 }
 
 // GetHTTPClientRoundTripper attempts to select the appropriate

config/configtls/tpm.go

@@ -21,6 +21,8 @@ type TPMConfig struct {
 	Path      string `mapstructure:"path"`
 	OwnerAuth string `mapstructure:"owner_auth"`
 	Auth      string `mapstructure:"auth"`
+	// prevent unkeyed literal initialization
+	_ struct{}
 }
 
 func (c TPMConfig) tpmCertificate(keyPem []byte, certPem []byte, openTPM func() (transport.TPMCloser, error)) (tls.Certificate, error) {

confmap/provider.go

@@ -98,6 +98,8 @@ type ChangeEvent struct {
 	// Error is nil if the config is changed and needs to be re-fetched.
 	// Any non-nil error indicates that there was a problem with watching the config changes.
 	Error error
+	// prevent unkeyed literal initialization
+	_ struct{}
 }
 
 // Retrieved holds the result of a call to the Retrieve method of a Provider object.

internal/tools/go.mod

@@ -12,6 +12,7 @@ require (
 	github.com/jcchavezs/porto v0.7.0
 	github.com/pavius/impi v0.0.3
 	github.com/rhysd/actionlint v1.7.7
+	go.opentelemetry.io/build-tools/checkapi v0.23.0
 	go.opentelemetry.io/build-tools/checkfile v0.23.0
 	go.opentelemetry.io/build-tools/chloggen v0.23.0
 	go.opentelemetry.io/build-tools/crosslink v0.23.0

internal/tools/go.sum

@@ -18,6 +18,7 @@ import (
 	_ "github.com/jcchavezs/porto/cmd/porto"
 	_ "github.com/pavius/impi/cmd/impi"
 	_ "github.com/rhysd/actionlint/cmd/actionlint"
+	_ "go.opentelemetry.io/build-tools/checkapi"
 	_ "go.opentelemetry.io/build-tools/checkfile"
 	_ "go.opentelemetry.io/build-tools/chloggen"
 	_ "go.opentelemetry.io/build-tools/crosslink"

internal/tools/tools.go

@@ -36,6 +36,9 @@ type Config struct {
 	Extensions map[component.ID]component.Config `mapstructure:"extensions"`
 
 	Service service.Config `mapstructure:"service"`
+
+	// prevent unkeyed literal initialization
+	_ struct{}
 }
 
 // Validate returns an error if the config is invalid.

otelcol/config.go

@@ -28,6 +28,8 @@ type ConfigProvider struct {
 type ConfigProviderSettings struct {
 	// ResolverSettings are the settings to configure the behavior of the confmap.Resolver.
 	ResolverSettings confmap.ResolverSettings
+	// prevent unkeyed literal initialization
+	_ struct{}
 }
 
 // NewConfigProvider returns a new ConfigProvider that provides the service configuration:

otelcol/configprovider.go

@@ -63,6 +63,8 @@ type CheckConsumeContractParams struct {
 	// GenerateCount specifies the number of times to call the generator.Generate()
 	// for each test scenario.
 	GenerateCount int
+	// prevent unkeyed literal initialization
+	_ struct{}
 }
 
 // CheckConsumeContract checks the contract between the receiver and its next consumer. For the contract

receiver/receivertest/contract_checker.go

@@ -19,4 +19,7 @@ type Config struct {
 
 	// Pipelines are the set of data pipelines configured for the service.
 	Pipelines pipelines.Config `mapstructure:"pipelines"`
+
+	// prevent unkeyed literal initialization
+	_ struct{}
 }