ci: add build, vet and test workflow (#1)

* ci: build, vet and test on every push and pull request

This repository had no CI at all. It ships a Go SDK that downstream users
build against, and nothing verified it compiled.

The steps are the ones already passing locally when this was added —
build, vet, race-enabled tests, and gofmt. The intent is a gate that
stays green and therefore stays worth reading, rather than a broad net
that goes red and gets ignored.

Go version comes from go.mod via go-version-file, so the toolchain and
the module cannot drift apart.

* style: apply gofmt

Mechanical output of `gofmt -w .` across 8 files — struct field and
comment alignment only. No semantic change is possible from gofmt, which
is why this is a separate commit from the workflow that checks it.

Without this the formatting job added in the previous commit would fail
on arrival, and a CI check that is red from day one teaches people to
ignore the whole workflow.

Author: raffaelschneider

.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+# Build, vet and test the SDK on every push and pull request.
+#
+# This repository had no CI at all: it ships a Go SDK that downstream users
+# build against, and nothing verified it compiled. The steps below are the ones
+# that were already passing locally when this was added — the intent is a gate
+# that stays green and therefore stays meaningful, not a broad net that goes
+# red and gets ignored.
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build and test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          # Tracks the version in go.mod rather than pinning separately, so
+          # the two cannot drift.
+          go-version-file: go.mod
+          cache: true
+
+      - name: Build
+        run: go build ./...
+
+      - name: Vet
+        run: go vet ./...
+
+      - name: Test
+        run: go test -race ./...
+
+  formatting:
+    name: Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Check gofmt
+        run: |
+          unformatted="$(gofmt -l .)"
+          if [ -n "$unformatted" ]; then
+            echo "These files are not gofmt-formatted:"
+            echo "$unformatted"
+            echo
+            echo "Run: gofmt -w ."
+            exit 1
+          fi

decision.go

@@ -276,17 +276,17 @@ func (d *Decision) Build() AgentResponse {
 
 // Decisions provides shorthand functions for common decisions.
 var Decisions = struct {
-	Allow       func() *Decision
-	Deny        func() *Decision
+	Allow        func() *Decision
+	Deny         func() *Decision
 	Unauthorized func() *Decision
-	RateLimited func() *Decision
-	Block       func(status int, body string) *Decision
-	Redirect    func(url string, permanent bool) *Decision
+	RateLimited  func() *Decision
+	Block        func(status int, body string) *Decision
+	Redirect     func(url string, permanent bool) *Decision
 }{
-	Allow:       Allow,
-	Deny:        Deny,
+	Allow:        Allow,
+	Deny:         Deny,
 	Unauthorized: Unauthorized,
-	RateLimited: RateLimited,
+	RateLimited:  RateLimited,
 	Block: func(status int, body string) *Decision {
 		d := Block(status)
 		if body != "" {

protocol.go

@@ -19,14 +19,14 @@ const MaxMessageSize = 10 * 1024 * 1024
 type EventType string
 
 const (
-	EventTypeRequestHeaders      EventType = "request_headers"
-	EventTypeRequestBodyChunk    EventType = "request_body_chunk"
-	EventTypeResponseHeaders     EventType = "response_headers"
-	EventTypeResponseBodyChunk   EventType = "response_body_chunk"
-	EventTypeRequestComplete     EventType = "request_complete"
-	EventTypeWebSocketFrame      EventType = "websocket_frame"
-	EventTypeConfigure           EventType = "configure"
-	EventTypeGuardrailInspect    EventType = "guardrail_inspect"
+	EventTypeRequestHeaders    EventType = "request_headers"
+	EventTypeRequestBodyChunk  EventType = "request_body_chunk"
+	EventTypeResponseHeaders   EventType = "response_headers"
+	EventTypeResponseBodyChunk EventType = "response_body_chunk"
+	EventTypeRequestComplete   EventType = "request_complete"
+	EventTypeWebSocketFrame    EventType = "websocket_frame"
+	EventTypeConfigure         EventType = "configure"
+	EventTypeGuardrailInspect  EventType = "guardrail_inspect"
 )
 
 // GuardrailInspectionType represents the type of guardrail inspection.

v2/agent_test.go

@@ -10,11 +10,11 @@ import (
 // TestAgentV2Impl is a test agent implementing AgentV2.
 type TestAgentV2Impl struct {
 	BaseAgentV2
-	onRequestCalled    bool
-	onShutdownCalled   bool
-	onDrainCalled      bool
-	onStreamClosedID   string
-	onCancelRequestID  uint64
+	onRequestCalled   bool
+	onShutdownCalled  bool
+	onDrainCalled     bool
+	onStreamClosedID  string
+	onCancelRequestID uint64
 }
 
 func (a *TestAgentV2Impl) Name() string {

v2/grpc_convert.go

@@ -10,14 +10,14 @@ import (
 // grpcProxyToAgentMessage is the JSON representation of a ProxyToAgent gRPC message.
 // This mirrors the proto oneof structure using JSON fields.
 type grpcProxyToAgentMessage struct {
-	Handshake       *grpcHandshakeRequest    `json:"handshake,omitempty"`
-	RequestHeaders  *grpcRequestHeadersEvent `json:"request_headers,omitempty"`
-	RequestBody     *grpcBodyChunkEvent      `json:"request_body_chunk,omitempty"`
+	Handshake       *grpcHandshakeRequest     `json:"handshake,omitempty"`
+	RequestHeaders  *grpcRequestHeadersEvent  `json:"request_headers,omitempty"`
+	RequestBody     *grpcBodyChunkEvent       `json:"request_body_chunk,omitempty"`
 	ResponseHeaders *grpcResponseHeadersEvent `json:"response_headers,omitempty"`
-	ResponseBody    *grpcBodyChunkEvent      `json:"response_body_chunk,omitempty"`
-	Cancel          *grpcCancelRequest       `json:"cancel,omitempty"`
-	Configure       *grpcConfigureEvent      `json:"configure,omitempty"`
-	Ping            *grpcPing                `json:"ping,omitempty"`
+	ResponseBody    *grpcBodyChunkEvent       `json:"response_body_chunk,omitempty"`
+	Cancel          *grpcCancelRequest        `json:"cancel,omitempty"`
+	Configure       *grpcConfigureEvent       `json:"configure,omitempty"`
+	Ping            *grpcPing                 `json:"ping,omitempty"`
 	RequestComplete *grpcRequestCompleteEvent `json:"request_complete,omitempty"`
 }
 
@@ -40,20 +40,20 @@ type grpcHandshakeRequest struct {
 
 // grpcHandshakeResponse maps to the proto HandshakeResponse.
 type grpcHandshakeResponse struct {
-	ProtocolVersion uint32                  `json:"protocol_version"`
-	Capabilities    *grpcAgentCapabilities  `json:"capabilities,omitempty"`
-	Success         bool                    `json:"success"`
-	Error           *string                 `json:"error,omitempty"`
+	ProtocolVersion uint32                 `json:"protocol_version"`
+	Capabilities    *grpcAgentCapabilities `json:"capabilities,omitempty"`
+	Success         bool                   `json:"success"`
+	Error           *string                `json:"error,omitempty"`
 }
 
 // grpcAgentCapabilities maps to the proto AgentCapabilities.
 type grpcAgentCapabilities struct {
-	ProtocolVersion uint32          `json:"protocol_version"`
-	AgentID         string          `json:"agent_id"`
-	Name            string          `json:"name"`
-	Version         string          `json:"version"`
-	SupportedEvents []int32         `json:"supported_events,omitempty"`
-	Features        *grpcFeatures   `json:"features,omitempty"`
+	ProtocolVersion uint32        `json:"protocol_version"`
+	AgentID         string        `json:"agent_id"`
+	Name            string        `json:"name"`
+	Version         string        `json:"version"`
+	SupportedEvents []int32       `json:"supported_events,omitempty"`
+	Features        *grpcFeatures `json:"features,omitempty"`
 }
 
 // grpcFeatures maps to the proto AgentFeatures.
@@ -160,13 +160,13 @@ type grpcRequestCompleteEvent struct {
 
 // grpcAgentResponse maps to the proto AgentResponse.
 type grpcAgentResponse struct {
-	CorrelationID   string                 `json:"correlation_id"`
-	Decision        interface{}            `json:"decision"`
-	RequestHeaders  []grpcHeaderOp         `json:"request_headers,omitempty"`
-	ResponseHeaders []grpcHeaderOp         `json:"response_headers,omitempty"`
-	Audit           map[string]interface{} `json:"audit,omitempty"`
-	ProcessingTimeMs *uint64               `json:"processing_time_ms,omitempty"`
-	NeedsMore       bool                   `json:"needs_more"`
+	CorrelationID    string                 `json:"correlation_id"`
+	Decision         interface{}            `json:"decision"`
+	RequestHeaders   []grpcHeaderOp         `json:"request_headers,omitempty"`
+	ResponseHeaders  []grpcHeaderOp         `json:"response_headers,omitempty"`
+	Audit            map[string]interface{} `json:"audit,omitempty"`
+	ProcessingTimeMs *uint64                `json:"processing_time_ms,omitempty"`
+	NeedsMore        bool                   `json:"needs_more"`
 }
 
 // grpcHeaderOp maps to the proto HeaderOp.

v2/grpc_service.go

@@ -84,14 +84,14 @@ var agentServiceDesc = grpc.ServiceDesc{
 		{
 			StreamName:    "ProcessStream",
 			Handler:       processStreamHandler,
-			ServerStreams:  true,
-			ClientStreams:  true,
+			ServerStreams: true,
+			ClientStreams: true,
 		},
 		{
 			StreamName:    "ControlStream",
 			Handler:       controlStreamHandler,
-			ServerStreams:  true,
-			ClientStreams:  true,
+			ServerStreams: true,
+			ClientStreams: true,
 		},
 	},
 	Metadata: "agent_v2.proto",
@@ -328,10 +328,10 @@ func (s *agentGRPCService) controlStream(stream grpc.ServerStream) error {
 
 		// Parse the control message
 		var controlMsg struct {
-			Health     json.RawMessage `json:"health,omitempty"`
-			Metrics    json.RawMessage `json:"metrics,omitempty"`
+			Health       json.RawMessage `json:"health,omitempty"`
+			Metrics      json.RawMessage `json:"metrics,omitempty"`
 			ConfigUpdate json.RawMessage `json:"config_update,omitempty"`
-			Log        json.RawMessage `json:"log,omitempty"`
+			Log          json.RawMessage `json:"log,omitempty"`
 		}
 		if err := json.Unmarshal(in.Data, &controlMsg); err != nil {
 			log.Error().Err(err).Str("stream_id", streamID).Msg("Failed to parse control message")

v2/handler.go

@@ -7,8 +7,8 @@ import (
 	"sync"
 	"time"
 
-	zentinel "github.com/zentinelproxy/zentinel-agent-go-sdk"
 	"github.com/rs/zerolog/log"
+	zentinel "github.com/zentinelproxy/zentinel-agent-go-sdk"
 )
 
 // AgentHandlerV2 handles v2 protocol events and routes them to the agent.

v2/health_test.go

@@ -104,9 +104,9 @@ func TestMetricsCollector_RecordRequest(t *testing.T) {
 	collector := NewMetricsCollector()
 
 	// Record some requests
-	collector.RecordRequest(true, 10.0)  // allowed
-	collector.RecordRequest(true, 20.0)  // allowed
-	collector.RecordRequest(false, 5.0)  // blocked
+	collector.RecordRequest(true, 10.0) // allowed
+	collector.RecordRequest(true, 20.0) // allowed
+	collector.RecordRequest(false, 5.0) // blocked
 	collector.RecordError()
 
 	report := collector.Report()

v2/protocol.go

@@ -12,24 +12,24 @@ const MaxMessageSizeV2 = 16 * 1024 * 1024
 
 // Message type IDs for v2 binary protocol.
 const (
-	MsgTypeHandshakeRequest   byte = 0x01
-	MsgTypeHandshakeResponse  byte = 0x02
-	MsgTypeRequestHeaders     byte = 0x10
-	MsgTypeRequestBodyChunk   byte = 0x11
-	MsgTypeResponseHeaders    byte = 0x12
-	MsgTypeResponseBodyChunk  byte = 0x13
-	MsgTypeDecision           byte = 0x20
-	MsgTypeBodyMutation       byte = 0x21
-	MsgTypeCancelRequest      byte = 0x30
-	MsgTypeCancelAll          byte = 0x31
-	MsgTypePing               byte = 0xF0
-	MsgTypePong               byte = 0xF1
-	MsgTypeHealthRequest      byte = 0xE0
-	MsgTypeHealthResponse     byte = 0xE1
-	MsgTypeMetricsRequest     byte = 0xE2
-	MsgTypeMetricsResponse    byte = 0xE3
-	MsgTypeRegistration       byte = 0x03
-	MsgTypeRegistrationAck    byte = 0x04
+	MsgTypeHandshakeRequest  byte = 0x01
+	MsgTypeHandshakeResponse byte = 0x02
+	MsgTypeRequestHeaders    byte = 0x10
+	MsgTypeRequestBodyChunk  byte = 0x11
+	MsgTypeResponseHeaders   byte = 0x12
+	MsgTypeResponseBodyChunk byte = 0x13
+	MsgTypeDecision          byte = 0x20
+	MsgTypeBodyMutation      byte = 0x21
+	MsgTypeCancelRequest     byte = 0x30
+	MsgTypeCancelAll         byte = 0x31
+	MsgTypePing              byte = 0xF0
+	MsgTypePong              byte = 0xF1
+	MsgTypeHealthRequest     byte = 0xE0
+	MsgTypeHealthResponse    byte = 0xE1
+	MsgTypeMetricsRequest    byte = 0xE2
+	MsgTypeMetricsResponse   byte = 0xE3
+	MsgTypeRegistration      byte = 0x03
+	MsgTypeRegistrationAck   byte = 0x04
 )
 
 // V2Message represents a v2 protocol message.