chore: adds vanity import check. (#2255)

* chore: adds vanity import check.

* chore: runs vanity import check on ci.

* fix: set right target on CI.

* fix: fixes install for porto.

* fix: install right proto bin.

* chore: list all files insides the tools directory.

* fix: fixes vanity import target

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

* chore(vanity-imports): adds vanity import support.

* fix: fixes internal generation.

* chore: runs go mod tidy in tools.

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
Co-authored-by: Anthony Mirabella <a9@aneurysm9.com>

.github/workflows/ci.yml

@@ -13,96 +13,96 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - name: Install Go
-      uses: actions/setup-go@v2.1.4
-      with:
-        go-version: ${{ env.DEFAULT_GO_VERSION }}
-    - name: Checkout Repo
-      uses: actions/checkout@v2
-    - name: Setup Environment
-      run: |
-        echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
-        echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
-    - name: Module cache
-      uses: actions/cache@v2.1.6
-      env:
-        cache-name: go-mod-cache
-      with:
-        path: ~/go/pkg/mod
-        key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
-    - name: Tools cache
-      uses: actions/cache@v2.1.6
-      env:
-        cache-name: go-tools-cache
-      with:
-        path: ~/.tools
-        key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('./internal/tools/**') }}
-    - name: Run linters
-      run: make dependabot-check license-check lint
-    - name: Build
-      run: make examples build
-    - name: Check clean repository
-      run: make check-clean-work-tree
+      - name: Install Go
+        uses: actions/setup-go@v2.1.4
+        with:
+          go-version: ${{ env.DEFAULT_GO_VERSION }}
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+      - name: Setup Environment
+        run: |
+          echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
+          echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+      - name: Module cache
+        uses: actions/cache@v2.1.6
+        env:
+          cache-name: go-mod-cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
+      - name: Tools cache
+        uses: actions/cache@v2.1.6
+        env:
+          cache-name: go-tools-cache
+        with:
+          path: ~/.tools
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('./internal/tools/**') }}
+      - name: Run linters
+        run: make dependabot-check license-check lint vanity-import-check
+      - name: Build
+        run: make examples build
+      - name: Check clean repository
+        run: make check-clean-work-tree
 
   test-race:
     runs-on: ubuntu-latest
     steps:
-    - name: Install Go
-      uses: actions/setup-go@v2.1.4
-      with:
-        go-version: ${{ env.DEFAULT_GO_VERSION }}
-    - name: Checkout Repo
-      uses: actions/checkout@v2
-    - name: Setup Environment
-      run: |
-        echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
-        echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
-    - name: Module cache
-      uses: actions/cache@v2.1.6
-      env:
-        cache-name: go-mod-cache
-      with:
-        path: ~/go/pkg/mod
-        key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
-    - name: Run tests with race detector
-      run: make test-race
+      - name: Install Go
+        uses: actions/setup-go@v2.1.4
+        with:
+          go-version: ${{ env.DEFAULT_GO_VERSION }}
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+      - name: Setup Environment
+        run: |
+          echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
+          echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+      - name: Module cache
+        uses: actions/cache@v2.1.6
+        env:
+          cache-name: go-mod-cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
+      - name: Run tests with race detector
+        run: make test-race
 
   test-coverage:
     runs-on: ubuntu-latest
     steps:
-    - name: Install Go
-      uses: actions/setup-go@v2.1.4
-      with:
-        go-version: ${{ env.DEFAULT_GO_VERSION }}
-    - name: Checkout Repo
-      uses: actions/checkout@v2
-    - name: Setup Environment
-      run: |
-        echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
-        echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
-    - name: Module cache
-      uses: actions/cache@v2.1.6
-      env:
-        cache-name: go-mod-cache
-      with:
-        path: ~/go/pkg/mod
-        key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
-    - name: Run coverage tests
-      run: |
-        make test-coverage
-        mkdir $TEST_RESULTS
-        cp coverage.out $TEST_RESULTS
-        cp coverage.txt $TEST_RESULTS
-        cp coverage.html $TEST_RESULTS
-    - name: Upload coverage report
-      uses: codecov/codecov-action@v2.0.3
-      with:
-        file: ./coverage.txt
-        fail_ci_if_error: true
-        verbose: true
-    - name: Store coverage test output
-      uses: actions/upload-artifact@v2
-      with:
+      - name: Install Go
+        uses: actions/setup-go@v2.1.4
+        with:
+          go-version: ${{ env.DEFAULT_GO_VERSION }}
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+      - name: Setup Environment
+        run: |
+          echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
+          echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+      - name: Module cache
+        uses: actions/cache@v2.1.6
+        env:
+          cache-name: go-mod-cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
+      - name: Run coverage tests
+        run: |
+          make test-coverage
+          mkdir $TEST_RESULTS
+          cp coverage.out $TEST_RESULTS
+          cp coverage.txt $TEST_RESULTS
+          cp coverage.html $TEST_RESULTS
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v2.0.3
+        with:
+          file: ./coverage.txt
+          fail_ci_if_error: true
+          verbose: true
+      - name: Store coverage test output
+        uses: actions/upload-artifact@v2
+        with:
           name: opentelemetry-go-test-output
           path: ${{ env.TEST_RESULTS }}
 
@@ -117,30 +117,30 @@ jobs:
         # https://docs.github.com/en/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow
         arch: ["386", amd64]
         exclude:
-        # Not a supported Go OS/architecture.
-        - os: macos-latest
-          arch: "386"
+          # Not a supported Go OS/architecture.
+          - os: macos-latest
+            arch: "386"
     runs-on: ${{ matrix.os }}
     steps:
-    - name: Install Go
-      uses: actions/setup-go@v2.1.4
-      with:
-        go-version: ${{ matrix.go-version }}
-    - name: Checkout code
-      uses: actions/checkout@v2
-    - name: Setup Environment
-      run: |
-        echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
-        echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
-      shell: bash
-    - name: Module cache
-      uses: actions/cache@v2.1.6
-      env:
-        cache-name: go-mod-cache
-      with:
-        path: ~/go/pkg/mod
-        key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
-    - name: Run tests
-      env:
-        GOARCH: ${{ matrix.arch }}
-      run: make test-short
+      - name: Install Go
+        uses: actions/setup-go@v2.1.4
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup Environment
+        run: |
+          echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV
+          echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+        shell: bash
+      - name: Module cache
+        uses: actions/cache@v2.1.6
+        env:
+          cache-name: go-mod-cache
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/go.sum') }}
+      - name: Run tests
+        env:
+          GOARCH: ${{ matrix.arch }}
+        run: make test-short

Makefile

@@ -50,19 +50,21 @@ GOLANGCI_LINT = $(TOOLS)/golangci-lint
 $(TOOLS)/golangci-lint: PACKAGE=github.com/golangci/golangci-lint/cmd/golangci-lint
 
 MISSPELL = $(TOOLS)/misspell
-$(TOOLS)/misspell: PACKAGE= github.com/client9/misspell/cmd/misspell
+$(TOOLS)/misspell: PACKAGE=github.com/client9/misspell/cmd/misspell
 
 GOCOVMERGE = $(TOOLS)/gocovmerge
-$(TOOLS)/gocovmerge: PACKAGE= github.com/wadey/gocovmerge
+$(TOOLS)/gocovmerge: PACKAGE=github.com/wadey/gocovmerge
 
 STRINGER = $(TOOLS)/stringer
 $(TOOLS)/stringer: PACKAGE=golang.org/x/tools/cmd/stringer
 
+PORTO = $(TOOLS)/porto
+$(TOOLS)/porto: PACKAGE=github.com/jcchavezs/porto/cmd/porto
+
 $(TOOLS)/gojq: PACKAGE=github.com/itchyny/gojq/cmd/gojq
 
 .PHONY: tools
-tools: $(CROSSLINK) $(GOLANGCI_LINT) $(MISSPELL) $(GOCOVMERGE) $(STRINGER) $(TOOLS)/gojq $(SEMCONVGEN)
-
+tools: $(CROSSLINK) $(GOLANGCI_LINT) $(MISSPELL) $(GOCOVMERGE) $(STRINGER) $(PORTO) $(TOOLS)/gojq $(SEMCONVGEN)
 
 # Build
 
@@ -78,7 +80,8 @@ generate: $(STRINGER)
 	set -e; for dir in $(ALL_GO_MOD_DIRS); do \
 	  echo "$(GO) generate $${dir}/..."; \
 	  (cd "$${dir}" && \
-	    PATH="$(TOOLS):$${PATH}" $(GO) generate ./...); \
+	    PATH="$(TOOLS):$${PATH}" $(GO) generate ./... && \
+		$(PORTO) -w .); \
 	done
 
 build: generate
@@ -136,6 +139,10 @@ lint: misspell lint-modules | $(GOLANGCI_LINT)
 	    $(GOLANGCI_LINT) run); \
 	done
 
+.PHONY: vanity-import-check
+vanity-import-check: | $(PORTO)
+	$(PORTO) -l .
+
 .PHONY: misspell
 misspell: | $(MISSPELL)
 	$(MISSPELL) -w $(ALL_DOCS)

baggage/baggage.go

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

bridge/opencensus/aggregation.go

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

bridge/opencensus/bridge.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package opencensus
+package opencensus // import "go.opentelemetry.io/otel/bridge/opencensus"
 
 import (
 	octrace "go.opencensus.io/trace"

bridge/opencensus/exporter.go

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

example/passthrough/handler/handler.go

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

exporters/otlp/otlpmetric/exporter.go

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

exporters/otlp/otlpmetric/options.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpmetric
+package otlpmetric // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric"
 
 import metricsdk "go.opentelemetry.io/otel/sdk/export/metric"
 

exporters/otlp/otlpmetric/otlpmetricgrpc/options.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpmetricgrpc
+package otlpmetricgrpc // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"
 
 import (
 	"fmt"

exporters/otlp/otlpmetric/otlpmetrichttp/client.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpmetrichttp
+package otlpmetrichttp // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp"
 
 import (
 	"bytes"

exporters/otlp/otlpmetric/otlpmetrichttp/options.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlpmetrichttp
+package otlpmetrichttp // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp"
 
 import (
 	"crypto/tls"

exporters/otlp/otlptrace/otlptracehttp/client.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlptracehttp
+package otlptracehttp // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp"
 
 import (
 	"bytes"

exporters/otlp/otlptrace/otlptracehttp/options.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package otlptracehttp
+package otlptracehttp // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp"
 
 import (
 	"crypto/tls"