Skip to content

Build and Test / Client #1637

Build and Test / Client

Build and Test / Client #1637

# Copyright 2024 The Outline Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
name: Build and Test / Client
concurrency:
group: '${{ github.head_ref || github.ref }} Client'
cancel-in-progress: true
on:
pull_request:
types:
- opened
- synchronize
push:
branches:
- master
schedule:
- cron: "0 13 * * *" # Run daily at 1PM UTC.
jobs:
web_test:
name: Web Test
runs-on: ubuntu-20.04
timeout-minutes: 20
steps:
- name: Checkout
uses: actions/[email protected]
- name: Install Node
uses: actions/setup-node@v3
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: ./package-lock.json
- name: Install NPM Dependencies
run: npm set cache .npm && npm ci
- name: Build Web App
run: npm run action client/src/www/build
- name: Test Web App
run: npm run action client/src/www/test
# - uses: codecov/codecov-action@v3
# with:
# files: ./client/src/output/coverage/www/coverage-final.json
# flags: unittests, www
backend_test:
name: Go Backend Test
runs-on: ubuntu-20.04
timeout-minutes: 20
steps:
- name: Checkout
uses: actions/[email protected]
- name: Install Go
uses: actions/setup-go@v4
with:
go-version-file: '${{ github.workspace }}/go.mod'
- name: Test Go Backend
run: go test -race -bench=. -benchtime=100ms ./client/...
linux_debug_build:
name: Linux Debug Build
runs-on: ubuntu-20.04
timeout-minutes: 20
needs: [web_test, backend_test]
steps:
- name: Checkout
uses: actions/[email protected]
- name: Install Node
uses: actions/setup-node@v3
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: ./package-lock.json
- name: Install NPM Dependencies
run: npm ci
- name: Install Go
uses: actions/setup-go@v4
with:
go-version-file: '${{ github.workspace }}/go.mod'
- name: Build Linux Client
run: npm run action client/electron/build linux
windows_debug_build:
name: Windows Debug Build
runs-on: windows-2019
timeout-minutes: 20
needs: [web_test, backend_test]
steps:
- name: Support longpaths
run: git config --system core.longpaths true
- name: Checkout
uses: actions/[email protected]
- name: Install Node
uses: actions/setup-node@v3
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: ./package-lock.json
- name: Install NPM Dependencies
run: npm ci
- name: Install Go
uses: actions/setup-go@v4
with:
go-version-file: '${{ github.workspace }}/go.mod'
- name: Install zig
uses: mlugg/setup-zig@v1
with:
version: 0.13.0
- name: Build Windows Client
run: npm run action client/electron/build windows
macos_debug_build:
name: MacOS Debug Build
runs-on: macos-13
timeout-minutes: 20
needs: [web_test, backend_test]
steps:
- name: Display XCode
run: xcode-select --print-path
- name: Checkout
uses: actions/[email protected]
- name: Install Node
uses: actions/setup-node@v3
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: ./package-lock.json
- name: Install NPM Dependencies
run: npm ci
- name: Install Go
uses: actions/setup-go@v4
with:
go-version-file: '${{ github.workspace }}/go.mod'
- name: Build Tun2Socks (required for Test OutlineAppleLib)
run: npm run action client/src/tun2socks/build macos
- name: Test OutlineAppleLib
run: npm run action client/src/cordova/test macos
- name: Build MacOS Client
run: npm run action client/src/cordova/build macos
# - uses: codecov/codecov-action@v4
# with:
# file: ./client/src/output/coverage/apple/macos/TestResult.xcresult
# flags: unittests, apple, macos
ios_debug_build:
name: iOS Debug Build
runs-on: macos-13
timeout-minutes: 20
needs: [web_test, backend_test]
steps:
- name: Display XCode
run: xcode-select --print-path
- name: Checkout
uses: actions/[email protected]
- name: Install Node
uses: actions/setup-node@v3
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: ./package-lock.json
- name: Install NPM Dependencies
run: npm ci
- name: Install Go
uses: actions/setup-go@v4
with:
go-version-file: '${{ github.workspace }}/go.mod'
- name: Build Tun2Socks (required for Test OutlineAppleLib)
run: npm run action client/src/tun2socks/build ios
- name: Test OutlineAppleLib
run: npm run action client/src/cordova/test ios
- name: Build iOS Client
run: npm run action client/src/cordova/build ios
# - uses: codecov/codecov-action@v4
# with:
# file: ./client/src/output/coverage/apple/ios/TestResult.xcresult
# flags: unittests, apple, ios
maccatalyst_debug_build:
name: Mac Catalyst Debug Build
runs-on: macos-13
timeout-minutes: 20
needs: [web_test, backend_test]
steps:
- name: Display XCode
run: xcode-select --print-path
- name: Checkout
uses: actions/[email protected]
- name: Install Node
uses: actions/setup-node@v3
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: ./package-lock.json
- name: Install NPM Dependencies
run: npm ci
- name: Install Go
uses: actions/setup-go@v4
with:
go-version-file: '${{ github.workspace }}/go.mod'
- name: Build Tun2Socks (required for Test OutlineAppleLib)
run: npm run action client/src/tun2socks/build maccatalyst
- name: Test OutlineAppleLib
run: npm run action client/src/cordova/test maccatalyst
- name: Build Mac Catalyst Client
run: npm run action client/src/cordova/build maccatalyst
# - uses: codecov/codecov-action@v4
# with:
# file: ./client/src/output/coverage/apple/maccatalyst/TestResult.xcresult
# flags: unittests, apple, maccatalyst
android_debug_build:
name: Android Debug Build
runs-on: ubuntu-20.04
timeout-minutes: 20
needs: [web_test, backend_test]
steps:
- name: Checkout
uses: actions/[email protected]
- name: Install Node
uses: actions/setup-node@v3
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: ./package-lock.json
- name: Install NPM Dependencies
run: npm ci
- name: Install Go
uses: actions/setup-go@v4
with:
go-version-file: '${{ github.workspace }}/go.mod'
- name: Install Java
uses: actions/[email protected]
with:
java-version: 11
- name: Setup Android
run: bash ./.github/scripts/android_setup_ci.sh
- name: Build Android Client
run: npm run action client/src/cordova/build android -- --verbose