Skip to content

Recursive test

Recursive test #62

name: Recursive test
# This file is cited from https://github.com/libprima/prima/blob/main/.github/workflows/recursive_test_matlab.yml,
# which is written by Zaikun Zhang.
on:
# Trigger the workflow on push or pull request
# push:
pull_request: # DANGEROUS! MUST be disabled for self-hosted runners!
# Trigger the workflow by cron. The default time zone of GitHub Actions is UTC.
schedule:
- cron: '0 14 1-31/5 * *'
# Trigger the workflow manually
workflow_dispatch:
inputs:
git-ref:
description: Git Ref (Optional)
required: false
random-seed:
description: Random Seed (Optional)
required: false
dimension:
description: Dimension (Optional)
required: false
depth:
description: Depth of recursion (Optional)
required: false
# Show the git ref in the workflow name if it is invoked manually.
run-name: ${{ github.event_name == 'workflow_dispatch' && format('Manual run {0} , seed {1}, dimension {2}, recursion depth {3}', inputs.git-ref, inputs.random-seed, inputs.dimension, inputs.depth) || '' }}
jobs:
test:
name: Recursive test of BDS
runs-on: ${{ matrix.os }}
continue-on-error: true
strategy:
fail-fast: false
matrix:
os: [ubuntu-20.04, ubuntu-latest, windows-2019, windows-latest, macos-11, macos-latest, macos-13]
matlab: [R2020b, R2021a, R2022a, R2023a, latest]
Algorithm: [cbds, pbds, rbds, ds, pads, scbds]
# Exclude some versions of OS and MATLAB. In addition to the latest versions, we intend to
# test the earliest version of MATLAB on each OS.
exclude:
- os: ubuntu-latest
matlab: R2020b
- os: ubuntu-latest
matlab: R2021a
- os: ubuntu-latest
matlab: R2022a
- os: ubuntu-20.04
matlab: R2021a
- os: ubuntu-20.04
matlab: R2022a
- os: ubuntu-20.04
matlab: R2023a
- os: ubuntu-20.04
matlab: latest
- os: macos-13
matlab: R2020b
- os: macos-13
matlab: R2021a
- os: macos-13
matlab: R2022a
- os: macos-latest
matlab: R2020b
- os: macos-latest
matlab: R2021a
- os: macos-latest
matlab: R2022a
- os: macos-11
matlab: R2020b
- os: macos-11
matlab: R2021a
- os: macos-11
matlab: R2023a
- os: macos-11
matlab: latest
- os: windows-latest
matlab: R2020b
- os: windows-latest
matlab: R2021a
- os: windows-latest
matlab: R2022a
- os: windows-2019
matlab: R2020b
- os: windows-2019
matlab: R2022a
- os: windows-2019
matlab: R2023a
- os: windows-2019
matlab: latest
# The following combinations are not available as of 20230928.
- os: windows-latest
matlab: latest
- os: macos-13
matlab: latest
- os: macos-latest
matlab: latest
steps:
- name: Clone Repository (Latest)
uses: actions/checkout@v4
if: github.event.inputs.git-ref == ''
with:
ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS
submodules: recursive
- name: Clone Repository (Custom Ref)
uses: actions/checkout@v4
if: github.event.inputs.git-ref != ''
with:
ref: ${{ github.event.inputs.git-ref }}
ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS
submodules: recursive
- name: Link gfortran for MATLAB on Linux
if: startsWith(matrix.os, 'ubuntu')
run: |
GFVER=12
if [[ "${{ matrix.os }}" = "ubuntu-20.04" ]] ; then
GFVER=11
fi
if [[ "${{ matrix.matlab }}" = "R2020b" || "${{ matrix.matlab }}" = "R2021a" ]] ; then
GFVER=9
fi
bash .github/scripts/link_gfortran "$GFVER"
- name: Install Intel oneAPI on macOS
if: startsWith(matrix.os, 'macos')
run: bash .github/scripts/install_oneapi_macos.sh
- name: Install Intel oneAPI on Windows
if: startsWith(matrix.os, 'windows')
run: cmd.exe "/K" '".github\scripts\install_oneapi_windows.bat"'
- name: Cache MATLAB # N.B.: Clear the cache when the `latest` version of MATLAB changes in March and September
uses: actions/cache@v4.0.1
with:
path: ${{ runner.tool_cache }}/MATLAB
key: ${{ matrix.os }}-${{ matrix.matlab }}-yes
- name: Set up MATLAB with optimization toolbox
uses: matlab-actions/setup-matlab@v2-beta
with:
release: ${{ matrix.matlab }}
products: Optimization_Toolbox
- name: Conduct the test
uses: matlab-actions/run-command@v1.2.2
with:
command: |
ver;
root_dir = pwd();
cd(fullfile(root_dir, 'tests'));
options = struct();
if ~isempty('${{ inputs.random-seed }}')
options.seed = str2num('${{ inputs.random-seed }}');
end
if ~isempty('${{ inputs.dimension }}')
options.n = str2num('${{ inputs.dimension }}');
end
if ~isempty('${{ inputs.depth }}')
options.depth = str2num('${{ inputs.depth }}');
end
options
% Conduct the test multiple times, in case some errors occur not during the first time but later.
exception = [];
try
recursive('${{ matrix.Algorithm }}', options);
options.compile = false;
% Test parallel invocation of the solvers
parfor i = 1 : 2
recursive('${{ matrix.Algorithm }}', options);
end
catch exception
end
% Copy the crash dump files to root_dir if exceptions occur.
if ~isempty(exception)
copy_crash_dump_files(root_dir)
dir(root_dir)
rethrow(exception);
end
- name: Store artifacts
uses: actions/upload-artifact@v3.1.3
if: always() # Always run even if the workflow is canceled manually or due to overtime.
with:
path: |
matlab_crash_dump*
# The following job check whether the tests were successful or cancelled due to timeout.
# N.B.: Remember to specify `continue-on-error: true` for the job of the tests.
check_success_timeout:
runs-on: ubuntu-latest
if: ${{ !cancelled() }}
needs: test
steps:
- name: Clone the GitHub actions scripts
uses: actions/checkout@v4
with:
repository: equipez/github_actions_scripts
ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS
path: scripts
- name: Check whether the tests were successful or cancelled due to timeout
run: bash scripts/check_success_timeout ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${{ github.run_id }}