consensys / quorum

This documentation outlines the CI/CD workflow for the ConsenSys Quorum project, detailing the steps involved, relevant code samples, and considerations needed for implementing the workflow effectively. Currently, the CI/CD has not yet been set up within the project. Below are recommended next steps to configure the CI/CD process.

Next Steps to Setup CI/CD

  1. Select a CI/CD Tool: Choose a CI/CD tool that fits the project requirements. Popular choices include GitHub Actions, GitLab CI, Jenkins, and Travis CI.

  2. Create Configuration Files: Develop configuration files for the selected CI/CD tool. This may include .github/workflows/ci.yml for GitHub Actions or .gitlab-ci.yml for GitLab CI.

  3. Define Build Pipeline: Implement the build pipeline that utilizes the existing Dockerfile and Makefile. The pipeline should:

    • Build the Docker image.
    • Run tests and linting.
    • Push the image to a container registry.

  4. Implement Testing: Create and calibrate testing scripts that invoke the Go testing tool while adhering to the build constraints (specifically, the gofuzz constraint). The tests should also be integrated into the CI/CD workflow.

  5. Monitor and Optimize: Once the CI/CD is in place, monitor the execution of build and deployment processes, looking for optimizations that can reduce build times, improve reliability, or enhance reporting.

Example CI/CD Configuration

GitHub Actions Example

Below is an example of a basic GitHub Actions configuration file that builds the Docker image and runs tests.

# .github/workflows/ci.yml
name: CI

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Docker Buildx
      uses: docker/setup-buildx-action@v1

    - name: Build and Test
      run: |
        docker build -t quorum:latest .
        docker run --rm quorum go test -tags=gofuzz ./...

Makefile Integration

The existing Makefile supports various build targets that can also be referenced within CI/CD tasks. For instance, if you add a linting task, you can execute it during the CI process.

lint:
    @golint ./...

test:
    @go test -tags=gofuzz ./...

Enhancing the Dockerfile for CI/CD

The existing Dockerfile can be optimized to work seamlessly within the CI/CD workflow by ensuring it’s structured for caching and efficiency.

# Dockerfile
FROM golang:1.22-alpine AS builder
WORKDIR /go-ethereum

COPY go.mod go.sum ./
RUN go mod download

COPY . .
RUN go run build/ci.go install -static ./cmd/geth

FROM alpine:latest
COPY --from=builder /go-ethereum/build/bin/geth /usr/local/bin/
# Add any additional commands or environment setup necessary

EXPOSE 8545
ENTRYPOINT ["geth"]

Conclusion

With the steps outlined and examples provided, the ConsenSys Quorum project can establish a robust CI/CD workflow tailored for efficient development and deployment. This foundation will facilitate automated testing, building, and deployment processes once implemented.

Source: Internal documentation of ConsenSys Quorum project.