Merge branch 'ci/test-macos' into 'master'

CI: run off-screen tests on macos

See merge request fsl/fsleyes/fsleyes!321

.ci/test_template.sh

@@ -2,35 +2,37 @@
 
 set -e
 
-apt-get install -y bc
-
-# Temporary: this should be done
-# in docker image definitions
-apt install -y locales
-locale-gen en_US.UTF-8
-locale-gen en_GB.UTF-8
-update-locale
-export LANG=en_GB.UTF-8
-
-# If running on a fork repository, we merge in the
-# upstream/master branch. This is done so that merge
-# requests from fork to the parent repository will
-# have unit tests run on the merged code, something
-# which gitlab CE does not currently do for us.
-if [[ "$CI_PROJECT_PATH" != "$UPSTREAM_PROJECT" ]]; then
-  git fetch upstream;
-  git merge --no-commit --no-ff upstream/master;
-fi;
-
-# We need the FSL atlases for the atlas
-# tests, and need $FSLDIR to be defined
-export FSLDIR=/fsl/
-mkdir -p $FSLDIR/data/
-rsync -rv "fsldownload:$FSL_ATLAS_DIR"    "$FSLDIR/data/atlases/"
-rsync -rv "fsldownload:$FSL_STANDARD_DIR" "$FSLDIR/data/standard/"
-
-source /test.venv/bin/activate
-pip install --upgrade pip
+# offscreen tests on macos. We use mesalib,
+# as it is not possible to use opengl hw
+# accelerated GL on headless macOS
+if [[ "$MACOS_OVERLAY_TEST" == "1" ]]; then
+  export FSLDIR=~/fsl/fsl-6.0.5/
+  ~/miniconda3/bin/conda create -y -c conda-forge -p ./test.env python=3.8 mesalib wget
+  source ~/miniconda3/bin/activate ./test.env
+  pip install --upgrade pip
+else
+
+  apt-get install -y bc
+
+  # Temporary: this should be done
+  # in docker image definitions
+  apt install -y locales
+  locale-gen en_US.UTF-8
+  locale-gen en_GB.UTF-8
+  update-locale
+  export LANG=en_GB.UTF-8
+
+  # We need the FSL atlases for the atlas
+  # tests, and need $FSLDIR to be defined
+  export FSLDIR=/fsl/
+  mkdir -p $FSLDIR/data/
+  rsync -rv "fsldownload:$FSL_ATLAS_DIR"    "$FSLDIR/data/atlases/"
+  rsync -rv "fsldownload:$FSL_STANDARD_DIR" "$FSLDIR/data/standard/"
+
+  source /test.venv/bin/activate
+  pip install --upgrade pip
+fi
+
 
 PIPARGS="--retries 10 --timeout 30"
 
@@ -68,42 +70,43 @@ tar xf widgets-master.tar.bz2 && pushd widgets-master && pip install $PIPARGS .
 # print environment
 pip freeze
 
-# style stage
-if [ "$TEST_STYLE"x != "x" ]; then pip install $PIPARGS pylint flake8; fi;
-if [ "$TEST_STYLE"x != "x" ]; then flake8                           fsleyes || true; fi;
-if [ "$TEST_STYLE"x != "x" ]; then pylint --output-format=colorized fsleyes || true; fi;
-if [ "$TEST_STYLE"x != "x" ]; then exit 0; fi
+if [[ "$MACOS_OVERLAY_TEST" == "" ]]; then
 
-# Run the tests. First batch requires
-# a GUI, so we run via xvfb-run
-((xvfb-run -a -s "-screen 0 1920x1200x24" pytest --cov-report= --cov-append -m "not (clitest or overlayclitest)" && echo "0" > status) || echo "1" > status) || true
-status=`cat status`
-failed=$status
-sleep 5
+  # style stage
+  if [ "$TEST_STYLE"x != "x" ]; then pip install $PIPARGS pylint flake8; fi;
+  if [ "$TEST_STYLE"x != "x" ]; then flake8                           fsleyes || true; fi;
+  if [ "$TEST_STYLE"x != "x" ]; then pylint --output-format=colorized fsleyes || true; fi;
+  if [ "$TEST_STYLE"x != "x" ]; then exit 0; fi
+
+  # Run the tests. First batch requires
+  # a GUI, so we run via xvfb-run
+  ((xvfb-run -a -s "-screen 0 1920x1200x24" pytest --cov-report= --cov-append -m "not (clitest or overlayclitest)" && echo "0" > status) || echo "1" > status) || true
+  status=`cat status`
+  failed=$status
+  sleep 5
+else
+  failed=0
+fi
 
 # Remaining tests are all off-screen,
-# so we can use osmesa
+# so we don't need xvfb
 ((pytest --cov-report= --cov-append -m "clitest" && echo "0" > status) || echo "1" > status) || true
 status=`cat status`
 failed=`echo "$status + $failed" | bc`
-sleep 5
 
-# test overlay types for different GL profiles
+# test overlay types for different GL profiles - gl14 first
 export FSLEYES_TEST_GL=1.4
 ((pytest --cov-report= --cov-append -m "overlayclitest" && echo "0" > status) || echo "1" > status) || true
 status=`cat status`
 failed=`echo "$status + $failed" | bc`
-sleep 5
 
+# gl21 compatibility
 export FSLEYES_TEST_GL=2.1
 ((pytest --cov-report= --cov-append -m "overlayclitest" && echo "0" > status) || echo "1" > status) || true
 status=`cat status`
 failed=`echo "$status + $failed" | bc`
-sleep 5
 
-# GL33-specific tests - only a
-# couple of these at the moment
-# (overlays/test_overlay_tractogram.py)
+# GL33-specific tests
 export MESA_GL_VERSION_OVERRIDE=3.3
 export FSLEYES_TEST_GL=3.3
 export LOCAL_TEST_FSLEYES=1

.gitlab-ci.yml

@@ -177,10 +177,7 @@ build-docker-image-fsleyes-py310-wxpy4-gtk3:
 # Test stage
 ############
 
-
-.test: &test_template
-  <<: *setup_ssh
-
+.test_rules: &test_rules
   rules:
     # Releases are just tags on a release
     # branch, so we don't need to test them.
@@ -193,6 +190,10 @@ build-docker-image-fsleyes-py310-wxpy4-gtk3:
     - if:   '$CI_PIPELINE_SOURCE == "push"'
       when: on_success
 
+.test: &test_template
+  <<: *setup_ssh
+  <<: *test_rules
+
   tags:
     - docker
 
@@ -200,6 +201,18 @@ build-docker-image-fsleyes-py310-wxpy4-gtk3:
     - bash ./.ci/test_template.sh
 
 
+# offscreen tests only on macos
+test:macos:
+  <<: *test_rules
+  stage: test
+  tags:
+    - macOS
+    - shell
+  variables:
+    MACOS_OVERLAY_TEST: 1
+  script:
+    - bash ./.ci/test_template.sh
+
 test:3.7:
   stage: test
   image: pauldmccarthy/fsleyes-py37-wxpy4-gtk3