build_test.yml

name: test

on:
  push:
    branches:    
      - master
      - 'release-**'
  pull_request:
    branches:    
      - master
      - 'release-**'

jobs:
  unit_test:
    name: unit tests
    runs-on: ubuntu-latest

    services:
      mysql:
        image: mysql:8.0
        ports:
          - 3306
        env:
          MYSQL_ROOT_PASSWORD: password
        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3

      postgres:
        image: postgres:10.0
        ports:
          - 5432
        env:
          POSTGRES_USER: gorse
          POSTGRES_PASSWORD: gorse_pass
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

      mongo:
        image: mongo:4.0
        ports:
          - 27017
        env:
          MONGO_INITDB_ROOT_USERNAME: root
          MONGO_INITDB_ROOT_PASSWORD: password
        options: >-
          --health-cmd mongo
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

      clickhouse:
        image: clickhouse/clickhouse-server:22
        ports:
          - 8123
        options: >-
          --health-cmd="clickhouse-client --query 'SELECT 1'" 
          --health-interval=10s 
          --health-timeout=5s 
          --health-retries=5

      redis:
        image: redis/redis-stack:6.2.6-v9
        ports:
          - 6379

    steps:
    - name: Set up dataset
      run: |
        mkdir -p ~/.gorse/dataset
        mkdir -p ~/.gorse/download
        wget https://cdn.gorse.io/datasets/ml-100k.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/ml-1m.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/pinterest-20.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/frappe.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/ml-tag.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/criteo.zip -P ~/.gorse/download
        wget https://pub-64226d9f34c64d6f829f5b63a5540d27.r2.dev/datasets/mnist.zip -P ~/.gorse/download
        unzip ~/.gorse/download/ml-100k.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/ml-1m.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/pinterest-20.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/frappe.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/ml-tag.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/criteo.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/mnist.zip -d ~/.gorse/dataset

    - uses: actions/checkout@v2
    - uses: actions/setup-go@v5
      with:
        go-version-file: ./go.mod

    - name: Test
      run: go test -timeout 30m -v ./... -coverprofile=coverage.txt -covermode=atomic -coverpkg=./...
      env:
        # MySQL
        MYSQL_URI: mysql://root:password@tcp(localhost:${{ job.services.mysql.ports[3306] }})/
        # Postgres
        POSTGRES_URI: postgres://gorse:gorse_pass@localhost:${{ job.services.postgres.ports[5432] }}/
        # MongoDB
        MONGO_URI: mongodb://root:password@localhost:${{ job.services.mongo.ports[27017] }}/
        # ClickHouse
        CLICKHOUSE_URI: clickhouse://localhost:${{ job.services.clickhouse.ports[8123] }}/
        # Redis
        REDIS_URI: redis://localhost:${{ job.services.redis.ports[6379] }}/

    - name: Upload 
      run: bash <(curl -s https://codecov.io/bash)

  unit_test_macos:
    name: unit tests (macOS)
    runs-on: macos-latest
    steps:
    - name: Set up dataset
      run: |
        mkdir -p ~/.gorse/dataset
        mkdir -p ~/.gorse/download
        wget https://cdn.gorse.io/datasets/ml-100k.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/ml-1m.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/pinterest-20.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/frappe.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/ml-tag.zip -P ~/.gorse/download
        wget https://cdn.gorse.io/datasets/criteo.zip -P ~/.gorse/download
        wget https://pub-64226d9f34c64d6f829f5b63a5540d27.r2.dev/datasets/mnist.zip -P ~/.gorse/download
        unzip ~/.gorse/download/ml-100k.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/ml-1m.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/pinterest-20.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/frappe.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/ml-tag.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/criteo.zip -d ~/.gorse/dataset
        unzip ~/.gorse/download/mnist.zip -d ~/.gorse/dataset

    - uses: actions/checkout@v2
    - uses: actions/setup-go@v5
      with:
        go-version-file: ./go.mod

    - name: Test
      run: go test -timeout 20m -v ./... -skip "TestPostgres|TestMySQL|TestMongo|TestRedis|TestClickHouse"

  unit_test_windows:
    name: unit tests (Windows)
    runs-on: windows-latest
    steps:
    - name: Set up dataset
      run: |
        New-Item -Type Directory -Path ~/.gorse/dataset
        New-Item -Type Directory -Path ~/.gorse/download
        Invoke-WebRequest https://cdn.gorse.io/datasets/ml-100k.zip -OutFile ~/.gorse/download/ml-100k.zip
        Invoke-WebRequest https://cdn.gorse.io/datasets/ml-1m.zip -OutFile ~/.gorse/download/ml-1m.zip
        Invoke-WebRequest https://cdn.gorse.io/datasets/pinterest-20.zip -OutFile ~/.gorse/download/pinterest-20.zip
        Invoke-WebRequest https://cdn.gorse.io/datasets/frappe.zip -OutFile ~/.gorse/download/frappe.zip
        Invoke-WebRequest https://cdn.gorse.io/datasets/ml-tag.zip -OutFile ~/.gorse/download/ml-tag.zip
        Invoke-WebRequest https://cdn.gorse.io/datasets/criteo.zip -OutFile ~/.gorse/download/criteo.zip
        Invoke-WebRequest https://pub-64226d9f34c64d6f829f5b63a5540d27.r2.dev/datasets/mnist.zip -OutFile ~/.gorse/download/mnist.zip
        Expand-Archive ~/.gorse/download/ml-100k.zip -DestinationPath ~/.gorse/dataset
        Expand-Archive ~/.gorse/download/ml-1m.zip -DestinationPath ~/.gorse/dataset
        Expand-Archive ~/.gorse/download/pinterest-20.zip -DestinationPath ~/.gorse/dataset
        Expand-Archive ~/.gorse/download/frappe.zip -DestinationPath ~/.gorse/dataset
        Expand-Archive ~/.gorse/download/ml-tag.zip -DestinationPath ~/.gorse/dataset
        Expand-Archive ~/.gorse/download/criteo.zip -DestinationPath ~/.gorse/dataset
        Expand-Archive ~/.gorse/download/mnist.zip -DestinationPath ~/.gorse/dataset

    - uses: actions/checkout@v2
    - uses: actions/setup-go@v5
      with:
        go-version-file: ./go.mod

    - name: Test
      run: go test -timeout 20m -v ./... -skip "TestPostgres|TestMySQL|TestMongo|TestRedis|TestClickHouse"

  integrate_test:
    name: integrate tests
    runs-on: ubuntu-latest
    strategy:
      matrix:
        database: [mysql, postgres, mongo, clickhouse]
    steps:
    - uses: actions/checkout@v1

    - uses: cuchi/jinja2-action@v1.2.0
      with:
        template: client/docker-compose.yml.j2
        output_file: client/docker-compose.yml
        strict: true
        variables: |
          database=${{ matrix.database }}

    - name: Build the stack
      run: docker compose -f client/docker-compose.yml --project-directory . up -d
      env:
        DOCKER_BUILDKIT: 1

    - name: Check the deployed service URL
      uses: jtalk/url-health-check-action@v2
      with:
        # Check the following URLs one by one sequentially
        url: http://127.0.0.1:8088/metrics|http://127.0.0.1:8087/metrics|http://127.0.0.1:8089/metrics
        # Fail this action after this many failed attempts
        max-attempts: 5
        # Delay between retries
        retry-delay: 5s
        # Retry all errors, including 404. This option might trigger curl upgrade.
        retry-all: true

    - uses: actions/setup-go@v5
      with:
        go-version-file: ./go.mod

    - name: Test
      run: go test -tags='integrate_test' ./client/

    - name: Download dataset
      if: ${{ matrix.database == 'mysql' }}
      run: wget https://cdn.gorse.io/example/github.sql

    - name: Import dataset
      if: ${{ matrix.database == 'mysql' }}
      run: mysql -h 127.0.0.1 -u gorse -pgorse_pass gorse < github.sql

  compat_test:
    name: compatibility tests
    runs-on: ubuntu-latest

    services:
      mariadb:
        image: mariadb:10.2
        ports:
          - 3306
        env:
          MYSQL_ROOT_PASSWORD: password

    steps:
      - name: Install pre-requisites
        uses: awalsh128/cache-apt-pkgs-action@latest
        with:
          packages: redis-tools

      - name: Setup Redis cluster
        run: |
          git clone https://github.com/gorse-cloud/redis-stack.git
          docker compose -f redis-stack/docker-compose.yml --project-directory redis-stack up -d
          for i in {1..5}; do
            redis-cli -p 7005 ping | grep PONG && break
            sleep 10
          done

      - uses: actions/checkout@v2
      - uses: actions/setup-go@v5
        with:
          go-version-file: ./go.mod

      - name: Test MariaDB
        run: go test ./storage/data -run TestMySQL
        env:
          MYSQL_URI: mysql://root:password@tcp(localhost:${{ job.services.mariadb.ports[3306] }})/

      - name: Test Redis cluster (1 address)
        run: go test ./storage/cache -run ^TestRedis
        env:
          REDIS_URI: redis+cluster://localhost:7000
      
      - name: Test Redis cluster (6 addresses)
        run: go test ./storage/cache -run ^TestRedis
        env:
          REDIS_URI: redis+cluster://localhost:7000?addr=localhost:7001&addr=localhost:7002&addr=localhost:7003&addr=localhost:7004&addr=localhost:7005

  golangci:
    name: lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-go@v5
        with:
          go-version-file: ./go.mod
      - name: golangci-lint
        uses: golangci/golangci-lint-action@v2
        with:
          args: --timeout 20m