[chore] update makefile to include test/tidy (aws-observability#402)

* [chore] update makefile to include test/tidy

This updates the build command to also run tests and tidy.

Signed-off-by: Alex Boten <[email protected]>

* separate test/tidy into their own gh jobs

* Apply suggestions from code review

Co-authored-by: Anthony Mirabella <[email protected]>

Signed-off-by: Alex Boten <[email protected]>
Co-authored-by: Anthony Mirabella <[email protected]>

Author: Alex Boten

.github/workflows/ci-collector.yml

@@ -15,8 +15,41 @@ on:
       - main
 
 jobs:
+  tidy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '^1.19.4'
+      - uses: actions/cache@v3
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Tidy
+        run: make gotidy
+        working-directory: collector
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '^1.19.4'
+      - uses: actions/cache@v3
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Run tests
+        run: make gotest
+        working-directory: collector
   build:
     runs-on: ubuntu-latest
+    needs: [test, tidy]
     strategy:
       matrix:
         architecture: [ amd64, arm64 ]

collector/Makefile

@@ -1,3 +1,5 @@
+include ./Makefile.Common
+
 BASE_SPACE:=$(shell pwd)
 BUILD_SPACE:=$(BASE_SPACE)/build
 BUCKET_NAME:=lambda-artifacts-$(shell dd if=/dev/random bs=8 count=1 2>/dev/null | od -An -tx1 | tr -d ' \t\n')
@@ -12,6 +14,20 @@ BUILD_INFO_IMPORT_PATH=main
 LDFLAGS=-ldflags "-s -w -X $(BUILD_INFO_IMPORT_PATH).GitHash=$(GIT_SHA) -X $(BUILD_INFO_IMPORT_PATH).Version=$(VERSION) \
 -X github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awsxrayexporter.collectorDistribution=opentelemetry-collector-lambda"
 
+ALL_MODULES := $(shell find . -type f -name "go.mod" -exec dirname {} \; | sort | egrep  '^./' )
+
+GOMODULES = $(ALL_MODULES) $(PWD)
+
+# Define a delegation target for each module
+.PHONY: $(GOMODULES)
+$(GOMODULES):
+	@echo "Running target '$(TARGET)' in module '$@'"
+	$(MAKE) -C $@ $(TARGET)
+
+# Triggers each module's delegation target
+.PHONY: for-all-target
+for-all-target: $(GOMODULES)
+
 clean:
 	rm -rf build/
 
@@ -35,3 +51,11 @@ publish-layer: package
 	aws s3 rm s3://$(BUCKET_NAME)/collector-extension.zip
 	aws s3 rb s3://$(BUCKET_NAME)
 	@echo OpenTelemetry Collector layer published.
+
+.PHONY: gotidy
+gotidy:
+	@$(MAKE) for-all-target TARGET="tidy"
+
+.PHONY: gotest
+gotest:
+	@$(MAKE) for-all-target TARGET="test"

collector/Makefile.Common

@@ -0,0 +1,55 @@
+# ALL_PKGS is the list of all packages where ALL_SRC files reside.
+ALL_PKGS := $(sort $(shell go list ./...))
+
+GOTEST_OPT?= -race -timeout 120s
+GOCMD?= go
+GOTEST=$(GOCMD) test
+GO_ACC=go-acc
+LINT=golangci-lint
+IMPI=impi
+
+GOOS := $(shell $(GOCMD) env GOOS)
+GOARCH := $(shell $(GOCMD) env GOARCH)
+GH := $(shell which gh)
+
+.PHONY: test
+test:
+	$(GOTEST) $(GOTEST_OPT) ./...
+
+.PHONY: test-with-cover
+test-with-cover:
+	$(GO_ACC) --output=coverage.out ./...
+
+.PHONY: benchmark
+benchmark:
+	$(GOTEST) -bench=. -benchtime=5s -count 5 -benchmem -cpuprofile=cpu.out -memprofile=mem.out -run=notests ./
+
+.PHONY: fmt
+fmt:
+	gofmt -w -s ./
+	goimports -w  -local github.com/open-telemetry/opentelemetry-lambda/collector ./
+
+.PHONY: tidy
+tidy:
+	rm -fr go.sum
+	$(GOCMD) mod tidy -compat=1.18
+
+.PHONY: lint
+lint:
+	$(LINT) run
+
+.PHONY: generate
+generate:
+	$(GOCMD) generate ./...
+
+.PHONY: impi
+impi:
+	@$(IMPI) --local github.com/open-telemetry/opentelemetry-lambda/collector --scheme stdThirdPartyLocal ./...
+
+.PHONY: moddownload
+moddownload:
+	$(GOCMD) mod download
+
+.PHONY: align
+align:
+	-fieldalignment -fix .

collector/lambdacomponents/Makefile

@@ -0,0 +1 @@
+include ../Makefile.Common

collector/lambdacomponents/go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/processor/probabilisticsamplerprocessor v0.68.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/processor/resourceprocessor v0.68.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/processor/spanprocessor v0.68.0
+	go.opentelemetry.io/collector v0.68.0
 	go.opentelemetry.io/collector/component v0.68.0
 	go.opentelemetry.io/collector/exporter/loggingexporter v0.68.0
 	go.opentelemetry.io/collector/exporter/otlpexporter v0.68.0
@@ -74,7 +75,6 @@ require (
 	github.com/tidwall/wal v1.1.7 // indirect
 	github.com/yusufpapurcu/wmi v1.2.2 // indirect
 	go.opencensus.io v0.24.0 // indirect
-	go.opentelemetry.io/collector v0.68.0 // indirect
 	go.opentelemetry.io/collector/confmap v0.68.0 // indirect
 	go.opentelemetry.io/collector/consumer v0.68.0 // indirect
 	go.opentelemetry.io/collector/featuregate v0.68.0 // indirect