Adds vanity import check (#4180)

* chore: adds porto and fixes vanity imports.

* chore: fixes target overriding.

* chore: fixes install of porto.

* chore: includes porto as a tool.

* chore: upgrades porto to check internals.

* chore: rebase and update vanity import.

* chore: removes unnecessary space.

* chore: rollsback vanity import in generated files.

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

@@ -1,9 +1,9 @@
 name: build-and-test
 on:
   push:
-    branches: [ main ]
+    branches: [main]
     tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+*'
+      - "v[0-9]+.[0-9]+.[0-9]+*"
   pull_request:
 
 jobs:
@@ -77,7 +77,7 @@ jobs:
           path: /home/runner/go/bin
           key: tools-${{ runner.os }}-${{ hashFiles('./internal/tools/go.mod', './cmd/mdatagen/go.mod', './cmd/mdatagen/*.go') }}
       - name: Lint
-        run: make -j5 checklicense misspell checkdoc goimpi golint
+        run: make -j5 checklicense misspell checkdoc goimpi golint goporto
       - name: Gen Metadata
         run: |
           make genmdata
@@ -206,4 +206,3 @@ jobs:
         with:
           name: collector-binaries-unstable
           path: ./bin-unstable.tar
-

Makefile

@@ -71,6 +71,10 @@ gotest-with-cover:
 	@$(MAKE) for-all CMD="make test-with-cover"
 	$(GOCOVMERGE) $$(find . -name coverage.out) > coverage.txt
 
+.PHONY: goporto
+goporto:
+	@$(MAKE) for-all CMD="make porto"
+
 .PHONY: golint
 golint:
 	@$(MAKE) for-all CMD="make lint lint-unstable"
@@ -134,6 +138,7 @@ install-tools:
 	cd $(TOOLS_MOD_DIR) && go install go.opentelemetry.io/build-tools/semconvgen
 	cd $(TOOLS_MOD_DIR) && go install golang.org/x/exp/cmd/apidiff
 	cd $(TOOLS_MOD_DIR) && go install golang.org/x/tools/cmd/goimports
+	cd $(TOOLS_MOD_DIR) && go install github.com/jcchavezs/porto/cmd/porto
 
 .PHONY: otelcol
 otelcol:

Makefile.Common

@@ -38,6 +38,10 @@ lint:
 lint-unstable:
 	$(LINT) run --allow-parallel-runners --build-tags enable_unstable
 
+.PHONY: porto
+porto:
+	porto -w --include-internal  ./
+
 .PHONY: impi
 impi:
 	@$(IMPI) --local go.opentelemetry.io/collector --scheme stdThirdPartyLocal ./...

client/client.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Package client contains generic representations of clients connecting to different receivers
-package client
+package client // import "go.opentelemetry.io/collector/client"
 
 import (
 	"context"

cmd/pdatagen/internal/base_fields.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/collector/cmd/pdatagen/internal"
 
 import (
 	"os"

cmd/pdatagen/internal/base_slices.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/collector/cmd/pdatagen/internal"
 
 import (
 	"os"

cmd/pdatagen/internal/base_structs.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/collector/cmd/pdatagen/internal"
 
 import (
 	"os"

cmd/pdatagen/internal/common_structs.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/collector/cmd/pdatagen/internal"
 
 var commonFile = &File{
 	Name: "common",

cmd/pdatagen/internal/log_structs.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/collector/cmd/pdatagen/internal"
 
 var logFile = &File{
 	Name: "log",

cmd/pdatagen/internal/metrics_structs.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/collector/cmd/pdatagen/internal"
 
 var metricsFile = &File{
 	Name: "metrics",

cmd/pdatagen/internal/resource_structs.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/collector/cmd/pdatagen/internal"
 
 var resourceFile = &File{
 	Name: "resource",

cmd/pdatagen/internal/trace_structs.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package internal
+package internal // import "go.opentelemetry.io/collector/cmd/pdatagen/internal"
 
 var traceFile = &File{
 	Name: "trace",

component/build_info.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 // BuildInfo is the information that is logged at the application start and
 // passed into each component. This information can be overridden in custom builds.

component/component.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 import (
 	"context"

component/componenterror/doc.go

@@ -14,4 +14,4 @@
 
 // Package componenterror provides helper functions to create and process
 // OpenTelemetry component errors.
-package componenterror
+package componenterror // import "go.opentelemetry.io/collector/component/componenterror"

component/componenterror/errors.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenterror
+package componenterror // import "go.opentelemetry.io/collector/component/componenterror"
 
 import (
 	"errors"

component/componenthelper/component.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenthelper
+package componenthelper // import "go.opentelemetry.io/collector/component/componenthelper"
 
 import (
 	"context"

component/componenthelper/doc.go

@@ -13,4 +13,4 @@
 // limitations under the License.
 
 // Package componenthelper assists with the creation of a new component.Component.
-package componenthelper
+package componenthelper // import "go.opentelemetry.io/collector/component/componenthelper"

component/componenttest/doc.go

@@ -14,4 +14,4 @@
 
 // Package componenttest define types and functions used to help test packages
 // implementing the component package interfaces.
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"

component/componenttest/nop_exporter.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"
 
 import (
 	"context"

component/componenttest/nop_extension.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"
 
 import (
 	"context"

component/componenttest/nop_factories.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"
 
 import (
 	"go.opentelemetry.io/collector/component"

component/componenttest/nop_host.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"
 
 import (
 	"go.opentelemetry.io/collector/component"

component/componenttest/nop_processor.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"
 
 import (
 	"context"

component/componenttest/nop_receiver.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"
 
 import (
 	"context"

component/componenttest/nop_telemetry.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"
 
 import (
 	"go.opentelemetry.io/otel/metric"

component/componenttest/shutdown_verifier.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package componenttest
+package componenttest // import "go.opentelemetry.io/collector/component/componenttest"
 
 import (
 	"context"

component/doc.go

@@ -16,4 +16,4 @@
 // and provides a foundation for the component’s creation and
 // termination process. A component can be either a receiver, exporter,
 // processor, or an extension.
-package component
+package component // import "go.opentelemetry.io/collector/component"

component/experimental/component/doc.go

@@ -16,4 +16,4 @@
 // that typically live under the "go.opentelemetry.io/collector/component"
 // package but aren't stable yet to be published there.
 // ATTENTION: the package is still experimental and subject to changes without advanced notice.
-package component
+package component // import "go.opentelemetry.io/collector/component/experimental/component"

component/experimental/component/factory.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component/experimental/component"
 
 import (
 	"context"

component/exporter.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 import (
 	"context"

component/extension.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 import (
 	"context"

component/factories.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 import (
 	"fmt"

component/host.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 import (
 	"go.opentelemetry.io/collector/config"

component/processor.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 import (
 	"context"

component/receiver.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 import (
 	"context"

component/telemetry.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package component
+package component // import "go.opentelemetry.io/collector/component"
 
 import (
 	"go.opentelemetry.io/otel/metric"

config/config.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package config
+package config // import "go.opentelemetry.io/collector/config"
 
 import (
 	"errors"

config/configauth/clientauth.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package configauth
+package configauth // import "go.opentelemetry.io/collector/config/configauth"
 
 import (
 	"fmt"

config/configauth/configauth.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package configauth
+package configauth // import "go.opentelemetry.io/collector/config/configauth"
 
 import (
 	"errors"

config/configauth/doc.go

@@ -15,4 +15,4 @@
 // Package configauth implements the configuration settings to
 // ensure authentication on incoming requests, and allows
 // exporters to add authentication on outgoing requests.
-package configauth
+package configauth // import "go.opentelemetry.io/collector/config/configauth"

config/configauth/mock_clientauth.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package configauth
+package configauth // import "go.opentelemetry.io/collector/config/configauth"
 
 import (
 	"context"