Skip to content

Commit 4f928c3

Browse files
rishabhverma17rishabhverma17
committed
feat: Add comprehensive CI/CD pipeline with GitHub Actions
- Automated testing with unit tests, integration tests, and benchmarks - Security scanning with Gosec and dependency vulnerability checks - Multi-platform binary builds (Linux, macOS, Windows - AMD64/ARM64) - Docker image building and publishing to GitHub Container Registry - Automated release workflow with binary and Helm chart generation - Code quality enforcement with golangci-lint - Automated dependency updates with weekly schedule - Redis compatibility testing and Elasticsearch integration tests - Build artifacts and coverage reporting
1 parent 78fe4b9 commit 4f928c3

4 files changed

Lines changed: 805 additions & 0 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 367 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,367 @@
1+
name: HyperCache CI
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
env:
10+
GO_VERSION: '1.23.2'
11+
12+
jobs:
13+
test:
14+
name: Test
15+
runs-on: ubuntu-latest
16+
17+
services:
18+
# Redis for compatibility testing
19+
redis:
20+
image: redis:7-alpine
21+
ports:
22+
- 6379:6379
23+
options: >-
24+
--health-cmd "redis-cli ping"
25+
--health-interval 10s
26+
--health-timeout 5s
27+
--health-retries 5
28+
29+
steps:
30+
- name: Checkout code
31+
uses: actions/checkout@v4
32+
33+
- name: Set up Go
34+
uses: actions/setup-go@v4
35+
with:
36+
go-version: ${{ env.GO_VERSION }}
37+
38+
- name: Cache Go modules
39+
uses: actions/cache@v3
40+
with:
41+
path: |
42+
~/go/pkg/mod
43+
~/.cache/go-build
44+
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
45+
restore-keys: |
46+
${{ runner.os }}-go-
47+
48+
- name: Download dependencies
49+
run: go mod download
50+
51+
- name: Verify dependencies
52+
run: go mod verify
53+
54+
- name: Run go vet
55+
run: go vet ./...
56+
57+
- name: Run go fmt check
58+
run: |
59+
if [ "$(gofmt -s -l . | wc -l)" -gt 0 ]; then
60+
echo "The following files are not formatted properly:"
61+
gofmt -s -l .
62+
exit 1
63+
fi
64+
65+
- name: Run unit tests
66+
run: go test -race -coverprofile=coverage.out -covermode=atomic ./...
67+
68+
- name: Run benchmarks
69+
run: go test -bench=. -benchmem ./internal/...
70+
71+
- name: Upload coverage to Codecov
72+
uses: codecov/codecov-action@v3
73+
with:
74+
file: ./coverage.out
75+
flags: unittests
76+
name: codecov-umbrella
77+
78+
build:
79+
name: Build
80+
runs-on: ubuntu-latest
81+
needs: test
82+
83+
steps:
84+
- name: Checkout code
85+
uses: actions/checkout@v4
86+
87+
- name: Set up Go
88+
uses: actions/setup-go@v4
89+
with:
90+
go-version: ${{ env.GO_VERSION }}
91+
92+
- name: Cache Go modules
93+
uses: actions/cache@v3
94+
with:
95+
path: |
96+
~/go/pkg/mod
97+
~/.cache/go-build
98+
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
99+
restore-keys: |
100+
${{ runner.os }}-go-
101+
102+
- name: Build binary
103+
run: |
104+
mkdir -p bin
105+
go build -v -o bin/hypercache cmd/hypercache/main.go
106+
107+
- name: Test binary execution
108+
run: |
109+
chmod +x bin/hypercache
110+
timeout 10s ./bin/hypercache --help || true
111+
112+
- name: Upload build artifacts
113+
uses: actions/upload-artifact@v3
114+
with:
115+
name: hypercache-binary
116+
path: bin/hypercache
117+
118+
integration-test:
119+
name: Integration Tests
120+
runs-on: ubuntu-latest
121+
needs: build
122+
123+
services:
124+
elasticsearch:
125+
image: docker.elastic.co/elasticsearch/elasticsearch:8.11.0
126+
env:
127+
discovery.type: single-node
128+
ES_JAVA_OPTS: "-Xms512m -Xmx512m"
129+
xpack.security.enabled: false
130+
ports:
131+
- 9200:9200
132+
options: >-
133+
--health-cmd "curl -f http://localhost:9200/_cluster/health || exit 1"
134+
--health-interval 30s
135+
--health-timeout 10s
136+
--health-retries 5
137+
138+
steps:
139+
- name: Checkout code
140+
uses: actions/checkout@v4
141+
142+
- name: Set up Go
143+
uses: actions/setup-go@v4
144+
with:
145+
go-version: ${{ env.GO_VERSION }}
146+
147+
- name: Download build artifact
148+
uses: actions/download-artifact@v3
149+
with:
150+
name: hypercache-binary
151+
path: bin/
152+
153+
- name: Make binary executable
154+
run: chmod +x bin/hypercache
155+
156+
- name: Wait for Elasticsearch
157+
run: |
158+
for i in {1..30}; do
159+
if curl -s http://localhost:9200/_cluster/health; then
160+
echo "Elasticsearch is ready"
161+
break
162+
fi
163+
echo "Waiting for Elasticsearch... ($i/30)"
164+
sleep 10
165+
done
166+
167+
- name: Start HyperCache node
168+
run: |
169+
./bin/hypercache -node-id test-node -protocol resp -port 6380 &
170+
echo $! > hypercache.pid
171+
sleep 5
172+
173+
- name: Test RESP protocol
174+
run: |
175+
# Install redis-tools for redis-cli
176+
sudo apt-get update
177+
sudo apt-get install -y redis-tools
178+
179+
# Test basic operations
180+
echo "Testing RESP protocol..."
181+
redis-cli -h localhost -p 6380 ping
182+
redis-cli -h localhost -p 6380 set testkey "hello world"
183+
redis-cli -h localhost -p 6380 get testkey
184+
redis-cli -h localhost -p 6380 del testkey
185+
186+
- name: Test HTTP API
187+
run: |
188+
echo "Testing HTTP API..."
189+
# Test health endpoint
190+
curl -f http://localhost:9080/health || echo "HTTP API not available (expected for single node)"
191+
192+
- name: Run persistence tests
193+
run: go test -v ./internal/storage/ -tags=integration
194+
195+
- name: Cleanup
196+
run: |
197+
if [ -f hypercache.pid ]; then
198+
kill $(cat hypercache.pid) || true
199+
fi
200+
201+
security-scan:
202+
name: Security Scan
203+
runs-on: ubuntu-latest
204+
needs: test
205+
206+
steps:
207+
- name: Checkout code
208+
uses: actions/checkout@v4
209+
210+
- name: Set up Go
211+
uses: actions/setup-go@v4
212+
with:
213+
go-version: ${{ env.GO_VERSION }}
214+
215+
- name: Run Gosec Security Scanner
216+
uses: securecodewarrior/github-action-gosec@master
217+
with:
218+
args: '-no-fail -fmt sarif -out gosec.sarif ./...'
219+
220+
- name: Upload SARIF file
221+
uses: github/codeql-action/upload-sarif@v2
222+
with:
223+
sarif_file: gosec.sarif
224+
225+
docker-build:
226+
name: Docker Build
227+
runs-on: ubuntu-latest
228+
needs: [test, build]
229+
230+
steps:
231+
- name: Checkout code
232+
uses: actions/checkout@v4
233+
234+
- name: Set up Docker Buildx
235+
uses: docker/setup-buildx-action@v3
236+
237+
- name: Create Dockerfile
238+
run: |
239+
cat > Dockerfile << 'EOF'
240+
FROM golang:1.23.2-alpine AS builder
241+
242+
WORKDIR /app
243+
COPY go.mod go.sum ./
244+
RUN go mod download
245+
246+
COPY . .
247+
RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o hypercache cmd/hypercache/main.go
248+
249+
FROM alpine:latest
250+
RUN apk --no-cache add ca-certificates
251+
WORKDIR /root/
252+
253+
COPY --from=builder /app/hypercache .
254+
COPY --from=builder /app/configs configs/
255+
256+
EXPOSE 8080 9080 7946
257+
258+
CMD ["./hypercache", "-protocol", "resp", "-node-id", "docker-node"]
259+
EOF
260+
261+
- name: Build Docker image
262+
uses: docker/build-push-action@v5
263+
with:
264+
context: .
265+
push: false
266+
tags: hypercache:latest
267+
cache-from: type=gha
268+
cache-to: type=gha,mode=max
269+
270+
- name: Test Docker image
271+
run: |
272+
docker run --rm -d --name hypercache-test -p 8081:8080 hypercache:latest
273+
sleep 10
274+
# Test if container is running
275+
docker ps | grep hypercache-test
276+
docker stop hypercache-test
277+
278+
lint:
279+
name: Lint
280+
runs-on: ubuntu-latest
281+
282+
steps:
283+
- name: Checkout code
284+
uses: actions/checkout@v4
285+
286+
- name: Set up Go
287+
uses: actions/setup-go@v4
288+
with:
289+
go-version: ${{ env.GO_VERSION }}
290+
291+
- name: golangci-lint
292+
uses: golangci/golangci-lint-action@v3
293+
with:
294+
version: latest
295+
args: --timeout=5m
296+
297+
documentation:
298+
name: Documentation Check
299+
runs-on: ubuntu-latest
300+
301+
steps:
302+
- name: Checkout code
303+
uses: actions/checkout@v4
304+
305+
- name: Check README links
306+
run: |
307+
# Check if all referenced files exist
308+
echo "Checking documentation links..."
309+
310+
# Check if API documentation exists
311+
if [ ! -f "docs/markdown/api/http-api-documentation.md" ]; then
312+
echo "❌ API documentation missing"
313+
exit 1
314+
fi
315+
316+
# Check if key configuration files exist
317+
for config in configs/node1-config.yaml configs/node2-config.yaml configs/node3-config.yaml; do
318+
if [ ! -f "$config" ]; then
319+
echo "❌ Configuration file missing: $config"
320+
exit 1
321+
fi
322+
done
323+
324+
# Check if scripts exist
325+
for script in scripts/start-system.sh scripts/build-and-run.sh; do
326+
if [ ! -f "$script" ]; then
327+
echo "❌ Script missing: $script"
328+
exit 1
329+
fi
330+
done
331+
332+
echo "✅ All documentation links verified"
333+
334+
- name: Validate Docker Compose
335+
run: |
336+
if [ -f "docker-compose.logging.yml" ]; then
337+
echo "✅ Docker compose file exists"
338+
else
339+
echo "❌ Docker compose file missing"
340+
exit 1
341+
fi
342+
343+
notify:
344+
name: Notify
345+
runs-on: ubuntu-latest
346+
needs: [test, build, integration-test, security-scan, docker-build, lint, documentation]
347+
if: always()
348+
349+
steps:
350+
- name: Notify success
351+
if: ${{ needs.test.result == 'success' && needs.build.result == 'success' }}
352+
run: |
353+
echo "🎉 HyperCache CI pipeline completed successfully!"
354+
echo "✅ All tests passed"
355+
echo "✅ Build successful"
356+
echo "✅ Integration tests passed"
357+
echo "✅ Security scan completed"
358+
echo "✅ Docker build successful"
359+
echo "✅ Linting passed"
360+
echo "✅ Documentation validated"
361+
362+
- name: Notify failure
363+
if: ${{ needs.test.result == 'failure' || needs.build.result == 'failure' }}
364+
run: |
365+
echo "❌ HyperCache CI pipeline failed!"
366+
echo "Please check the logs for details."
367+
exit 1

0 commit comments

Comments
 (0)