Continuous integration process configuration

Continuous Integration Process Configuration

Continuous Integration (CI) is an indispensable part of modern software development. It automates code building, testing, and deployment, ensuring team collaboration efficiency and code quality. Configuring a continuous integration process in a Koa2 project can significantly improve development efficiency and project stability.

Basic Environment Preparation

Before configuring continuous integration, ensure the project has the following basic environment:

1. Version control system (e.g., GitHub, GitLab, etc.)
2. Continuous integration service (e.g., Travis CI, CircleCI, GitHub Actions, etc.)
3. Node.js environment (recommended to use the LTS version)

// package.json example
{
  "name": "koa2-ci-demo",
  "version": "1.0.0",
  "scripts": {
    "test": "jest",
    "lint": "eslint .",
    "start": "node app.js"
  },
  "dependencies": {
    "koa": "^2.13.4",
    "koa-router": "^10.1.1"
  },
  "devDependencies": {
    "jest": "^27.5.1",
    "eslint": "^8.15.0",
    "supertest": "^6.2.3"
  }
}

GitHub Actions Configuration

GitHub Actions is a CI/CD service provided by GitHub, featuring simple configuration and deep integration with GitHub repositories. Below is a typical configuration for a Koa2 project:

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

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    
    strategy:
      matrix:
        node-version: [14.x, 16.x, 18.x]
    
    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v3
      with:
        node-version: ${{ matrix.node-version }}
    - run: npm ci
    - run: npm run lint
    - run: npm test

Test Configuration

Comprehensive testing is the core of continuous integration. A Koa2 project typically requires unit tests and API tests:

// test/app.test.js
const request = require('supertest');
const app = require('../app');

describe('GET /', () => {
  it('should return 200 OK', async () => {
    const res = await request(app.callback())
      .get('/');
    expect(res.status).toBe(200);
  });
});

// Unit test example
describe('Utility functions', () => {
  test('adds 1 + 2 to equal 3', () => {
    expect(1 + 2).toBe(3);
  });
});

Code Quality Check

ESLint helps maintain code style consistency and prevents common errors:

// .eslintrc.js
module.exports = {
  env: {
    node: true,
    es2021: true,
    jest: true
  },
  extends: ['eslint:recommended'],
  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module'
  },
  rules: {
    'indent': ['error', 2],
    'linebreak-style': ['error', 'unix'],
    'quotes': ['error', 'single'],
    'semi': ['error', 'always']
  }
};

Deployment Automation

After continuous integration is completed, you can configure automatic deployment to a server or cloud platform:

# Add deployment steps in ci.yml
deploy:
  needs: build
  runs-on: ubuntu-latest
  if: github.ref == 'refs/heads/main'
  
  steps:
    - uses: actions/checkout@v3
    - name: Install dependencies
      run: npm ci
    - name: Deploy to server
      uses: appleboy/ssh-action@v0.1.10
      with:
        host: ${{ secrets.SSH_HOST }}
        username: ${{ secrets.SSH_USERNAME }}
        key: ${{ secrets.SSH_KEY }}
        script: |
          cd /var/www/koa2-app
          git pull origin main
          npm install --production
          pm2 restart koa2-app

Multi-Environment Configuration

For projects that require separate development, testing, and production environments, configure as follows:

// config.js
const env = process.env.NODE_ENV || 'development';

const configs = {
  development: {
    port: 3000,
    db: 'mongodb://localhost:27017/dev'
  },
  test: {
    port: 4000,
    db: 'mongodb://localhost:27017/test'
  },
  production: {
    port: process.env.PORT || 80,
    db: process.env.MONGO_URI
  }
};

module.exports = configs[env];

Cache Optimization

Proper use of caching can significantly speed up the CI process:

# Optimized ci.yml
steps:
  - uses: actions/checkout@v3
  - name: Cache node modules
    uses: actions/cache@v3
    with:
      path: ~/.npm
      key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
      restore-keys: |
        ${{ runner.os }}-node-
  - run: npm ci

Notification Configuration

After the CI process is completed, notify team members through various channels:

# Add notification step
- name: Notify Slack
  uses: rtCamp/action-slack-notify@v2
  env:
    SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
    SLACK_COLOR: ${{ job.status }} # good, danger, or warning
    SLACK_TITLE: 'Koa2 CI/CD Status'
    SLACK_MESSAGE: 'Build ${{ job.status }} for ${{ github.repository }}'

Database Migration

If the project involves a database, add migration steps to the CI:

- name: Run migrations
  run: |
    npm install -g db-migrate
    db-migrate up --env test
  env:
    DATABASE_URL: ${{ secrets.TEST_DATABASE_URL }}

Security Scanning

Integrate security scanning tools to identify potential vulnerabilities early:

- name: Run security audit
  run: npm audit
  continue-on-error: true # Allow audit failures without affecting the overall process

- name: Dependency check
  uses: dependency-review-action@v2

Performance Testing

Add simple performance tests to the CI:

// test/performance.test.js
const loadTest = require('loadtest');

describe('Performance', () => {
  test('Homepage should handle 50 requests per second', (done) => {
    const options = {
      url: 'http://localhost:3000',
      maxRequests: 500,
      concurrency: 50,
      statusCallback: (error, result, latency) => {
        if (error) return done(error);
        if (result.statusCode !== 200) {
          return done(new Error(`Status code ${result.statusCode}`));
        }
      }
    };
    
    loadTest.loadTest(options, (error) => {
      if (error) return done(error);
      done();
    });
  });
});

Containerized Integration

For projects using Docker, build and test containers in the CI:

- name: Build Docker image
  run: docker build -t koa2-app .
  
- name: Run tests in container
  run: |
    docker run -e NODE_ENV=test koa2-app npm test

Multi-Platform Testing

Ensure the application runs correctly on different operating systems:

jobs:
  build:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        node-version: [16.x]
    runs-on: ${{ matrix.os }}

Automated Version Release

Configure automated version releases and npm publishing:

- name: Release
  if: startsWith(github.ref, 'refs/tags/')
  run: |
    npm publish
  env:
    NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}