Skip to content

feat: add gofix Makefile target and CI check #2280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pkcll wants to merge 2 commits into
base: main
Choose a base branch
from
+88 −17
Open

feat: add gofix Makefile target and CI check #2280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fdb161c
feat: add gofix Makefile target and CI check
pkcll Jul 24, 2026
81f4909
fix: make gofix and check-gofix cover nested modules correctly
pkcll Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions .github/workflows/pkg.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,73 @@
path: |
./race.*

check-gofix:
runs-on: ubuntu-latest
# Non-required while we evaluate it; failure won't block merges.
continue-on-error: true
steps:
- name: Checkout
uses: actions/checkout@v4

Check warning on line 105 in .github/workflows/pkg.yml

View workflow job for this annotation

GitHub Actions / Validate Workflow Changes 

  1. Action is using node20. Versions older than node24 are being deprecated. Use a newer version of the action if possible. (node-version / warning)
with:
persist-credentials: false

- name: Detect changed modules
uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2

Check warning on line 110 in .github/workflows/pkg.yml

View workflow job for this annotation

GitHub Actions / Validate Workflow Changes 

  1. Action is using node20. Versions older than node24 are being deprecated. Use a newer version of the action if possible. (node-version / warning)
id: filter
with:
# "root" is the catch-all: any .go file outside the nested modules
# listed below, including locations not yet enumerated here (e.g.
# a new top-level package).
filters: |
root:
- '**/*.go'
- '!keystore/**'
- '!observability-lib/**'
- '!pkg/values/**'
- '!pkg/chipingress/**'
- '!pkg/monitoring/**'
- '!pkg/workflows/sdk/v2/pb/**'
keystore:
- 'keystore/**/*.go'
observability-lib:
- 'observability-lib/**/*.go'
pkg-values:
- 'pkg/values/**/*.go'
pkg-chipingress:
- 'pkg/chipingress/**/*.go'
pkg-monitoring:
- 'pkg/monitoring/**/*.go'
pkg-workflows-sdk-v2-pb:
- 'pkg/workflows/sdk/v2/pb/**/*.go'

- name: Set up Go
if: steps.filter.outputs.root == 'true' || steps.filter.outputs.keystore == 'true' || steps.filter.outputs.observability-lib == 'true' || steps.filter.outputs.pkg-values == 'true' || steps.filter.outputs.pkg-chipingress == 'true' || steps.filter.outputs.pkg-monitoring == 'true' || steps.filter.outputs.pkg-workflows-sdk-v2-pb == 'true'
uses: ./.github/actions/setup-go
Comment on lines +138 to +140
with:
go-version-file: "go.mod"
only-modules: "true"

- name: Ensure "go fix" has been run on changed modules
if: steps.filter.outputs.root == 'true' || steps.filter.outputs.keystore == 'true' || steps.filter.outputs.observability-lib == 'true' || steps.filter.outputs.pkg-values == 'true' || steps.filter.outputs.pkg-chipingress == 'true' || steps.filter.outputs.pkg-monitoring == 'true' || steps.filter.outputs.pkg-workflows-sdk-v2-pb == 'true'
env:
ROOT_CHANGED: ${{ steps.filter.outputs.root }}
KEYSTORE_CHANGED: ${{ steps.filter.outputs.keystore }}
OBSERVABILITY_LIB_CHANGED: ${{ steps.filter.outputs.observability-lib }}
PKG_VALUES_CHANGED: ${{ steps.filter.outputs.pkg-values }}
PKG_CHIPINGRESS_CHANGED: ${{ steps.filter.outputs.pkg-chipingress }}
PKG_MONITORING_CHANGED: ${{ steps.filter.outputs.pkg-monitoring }}
PKG_WORKFLOWS_SDK_V2_PB_CHANGED: ${{ steps.filter.outputs.pkg-workflows-sdk-v2-pb }}
run: |
[[ "$ROOT_CHANGED" == "true" ]] && { (cd . && go fix ./...) || exit 1; } || true
[[ "$KEYSTORE_CHANGED" == "true" ]] && { (cd keystore && go fix ./...) || exit 1; } || true
[[ "$OBSERVABILITY_LIB_CHANGED" == "true" ]] && { (cd observability-lib && go fix ./...) || exit 1; } || true
[[ "$PKG_VALUES_CHANGED" == "true" ]] && { (cd pkg/values && go fix ./...) || exit 1; } || true
[[ "$PKG_CHIPINGRESS_CHANGED" == "true" ]] && { (cd pkg/chipingress && go fix ./...) || exit 1; } || true
[[ "$PKG_MONITORING_CHANGED" == "true" ]] && { (cd pkg/monitoring && go fix ./...) || exit 1; } || true
[[ "$PKG_WORKFLOWS_SDK_V2_PB_CHANGED" == "true" ]] && { (cd pkg/workflows/sdk/v2/pb && go fix ./...) || exit 1; } || true
git add --all
git diff --minimal --cached --exit-code

check-tidy:

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}
runs-on: ubuntu-latest
steps:
Expand Down
4 changes: 4 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ modgraph: gomods
go install github.com/jmank88/modgraph@v0.1.0
./modgraph > go.md

.PHONY: gofix
gofix: gomods ## Run go fix across all packages
gomods -s proto_vendor -go fix ./...

.PHONY: dependabot
ifndef DEPENDABOT_SEVERITY
DEPENDABOT_SEVERITY := "critical,high"
Expand Down
31 changes: 15 additions & 16 deletions pkg/beholder/batch_emitter_service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ func TestNewChipIngressBatchEmitterService(t *testing.T) {
t.Run("happy path", func(t *testing.T) {
clientMock := mocks.NewClient(t)
clientMock.EXPECT().Close().Return(nil).Maybe()
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, newTestConfig(), newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, newTestConfig(), logger.Test(t))
require.NoError(t, err)
assert.NotNil(t, emitter)
})

t.Run("returns error when client is nil", func(t *testing.T) {
emitter, err := beholder.NewChipIngressBatchEmitterService(nil, newTestConfig(), newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(nil, newTestConfig(), logger.Test(t))
assert.Error(t, err)
assert.Nil(t, emitter)
})
Expand All @@ -65,7 +65,7 @@ func TestChipIngressBatchEmitterService_Emit(t *testing.T) {
t.Run("returns error when domain/entity missing", func(t *testing.T) {
clientMock := mocks.NewClient(t)
clientMock.EXPECT().Close().Return(nil).Maybe()
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, newTestConfig(), newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, newTestConfig(), logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))
defer emitter.Close() //nolint:errcheck
Expand Down Expand Up @@ -93,7 +93,7 @@ func TestChipIngressBatchEmitterService_Emit(t *testing.T) {
cfg := newTestConfig()
cfg.ChipIngressSendInterval = 50 * time.Millisecond

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -142,7 +142,7 @@ func TestChipIngressBatchEmitterService_CloudEventFormat(t *testing.T) {
cfg := newTestConfig()
cfg.ChipIngressSendInterval = 50 * time.Millisecond

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -188,7 +188,7 @@ func TestChipIngressBatchEmitterService_PublishBatchError(t *testing.T) {
cfg := newTestConfig()
cfg.ChipIngressSendInterval = 50 * time.Millisecond

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -221,7 +221,7 @@ func TestChipIngressBatchEmitterService_ContextCancellation(t *testing.T) {
cfg.ChipIngressBufferSize = 1
cfg.ChipIngressSendInterval = 10 * time.Second

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))
defer emitter.Close() //nolint:errcheck
Expand Down Expand Up @@ -251,7 +251,7 @@ func TestChipIngressBatchEmitterService_DefaultConfig(t *testing.T) {
}).
Return(nil, nil)

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, beholder.Config{}, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, beholder.Config{}, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -282,7 +282,7 @@ func TestChipIngressBatchEmitterService_EmitAfterClose(t *testing.T) {
Return(nil, nil).
Maybe()

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, newTestConfig(), newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, newTestConfig(), logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))
require.NoError(t, emitter.Close())
Expand All @@ -305,7 +305,7 @@ func TestChipIngressBatchEmitterService_EmitWithCallback(t *testing.T) {
cfg := newTestConfig()
cfg.ChipIngressSendInterval = 50 * time.Millisecond

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -338,7 +338,7 @@ func TestChipIngressBatchEmitterService_EmitWithCallback(t *testing.T) {
cfg := newTestConfig()
cfg.ChipIngressSendInterval = 50 * time.Millisecond

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -447,7 +447,7 @@ func TestChipIngressBatchEmitterService_EmitWithCallback(t *testing.T) {
cfg := newTestConfig()
cfg.ChipIngressSendInterval = 50 * time.Millisecond

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -542,7 +542,7 @@ func TestChipIngressBatchEmitterService_PartialDeliveryError(t *testing.T) {
cfg.ChipIngressMaxBatchSize = 1
cfg.ChipIngressSendInterval = time.Second

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -589,7 +589,7 @@ func TestChipIngressBatchEmitterService_RPCError(t *testing.T) {
cfg.ChipIngressMaxBatchSize = 1
cfg.ChipIngressSendInterval = time.Second

emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down Expand Up @@ -620,7 +620,6 @@ func TestChipIngressBatchEmitterService_RPCError(t *testing.T) {
})
}


func TestChipIngressBatchEmitterService_Metrics(t *testing.T) {
t.Run("records events_sent on successful publish", func(t *testing.T) {
reader, restore := useEmitterTestMeterProvider(t)
Expand All @@ -638,7 +637,7 @@ func TestChipIngressBatchEmitterService_Metrics(t *testing.T) {
cfg := newTestConfig()
cfg.ChipIngressMaxBatchSize = 1
cfg.ChipIngressSendInterval = time.Second
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, newTestLogger(t))
emitter, err := beholder.NewChipIngressBatchEmitterService(clientMock, cfg, logger.Test(t))
require.NoError(t, err)
require.NoError(t, emitter.Start(t.Context()))

Expand Down
3 changes: 2 additions & 1 deletion pkg/beholder/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"github.com/smartcontractkit/chainlink-common/pkg/chipingress"
chipmocks "github.com/smartcontractkit/chainlink-common/pkg/chipingress/mocks"
"github.com/smartcontractkit/chainlink-common/pkg/chipingress/pb"
"github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/smartcontractkit/chainlink-common/pkg/services"
)

Expand Down Expand Up @@ -947,7 +948,7 @@ func TestClient_batchEmitterService(t *testing.T) {
ChipIngressEmitterGRPCEndpoint: "localhost:9090",
ChipIngressInsecureConnection: true,
ChipIngressBatchEmitterEnabled: true,
ChipIngressLogger: newTestLogger(t),
ChipIngressLogger: logger.Test(t),
ChipIngressBufferSize: 10,
ChipIngressMaxBatchSize: 5,
ChipIngressSendInterval: 50 * time.Millisecond,
Expand Down
Loading