.gitlab-ci.yml

# This file is part of Adblock Plus <https://adblockplus.org/>,
# Copyright (C) 2006-present eyeo GmbH
#
# Adblock Plus is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3 as
# published by the Free Software Foundation.
#
# Adblock Plus is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
#
# This file specifies how GitLab should run the tests, linting and other checks
# automatically when merge requests are opened. By default, this will all run
# on GitLab provided "shared runners", without further work. However, the tests
# will run more quickly on a "specific runner" if you'd like to set that up.
#
# If you'd like to provision your own specific runners for your fork of the
# repository, you can use these Ansible roles:
#
# https://gitlab.com/eyeo/devops/ansible-role-adblockplus-builder
# https://gitlab.com/eyeo/devops/ansible-role-gitlab-runner

stages:
  - prepare
  - build
  - test
  - download
  - scp

.dependencies:
  script: &dependencies
    # Since we already use the "before_script" in order to setup dependencies
    # we must also install other dependencies here, which would have already
    # been available on the specific runners. Unfortunately, YAML doesn't
    # support proper mutli-inheritance, so we need to fallback to the following
    # inline shell script.
    - "[ -z $BROWSER_SNAPSHOT_DIR ] || mkdir -p $BROWSER_SNAPSHOT_DIR"
    - |
      if [[ "$CI_RUNNER_DESCRIPTION" == *gitlab.com ]]; then
        apt-get update;
        apt-get install -y apt-transport-https python-pip libgtk-3-0 libxt6 \
          xvfb libnss3 libxss1 libgconf-2-4 libasound2 nodejs npm;
      fi
    - mkdir -p .git/info
    - pip install --user Jinja2 cryptography fonttools brotli
    # This pipeline runs on a custom runner as an unpriviliged user.
    # Therefore the pyftsubset executable of the fonttools dependency above is
    # installed to `~/.local/bin` and needs to be added to the $PATH variable
    # in order to be available.
    - export PATH=$PATH:~/.local/bin
    - "npm_config_unsafe_perm=true python ensure_dependencies.py"
    - "[ -d node_modules ] || npm install"

.pull_cache:
  cache:
    key: cache_$CI_COMMIT_SHA
    paths:
      - ./
    policy: pull

.test_template:
  extends: .pull_cache
  stage: test
  before_script: *dependencies
  variables:
    BROWSER_SNAPSHOT_DIR: "/tmp/browser-snapshots/"
  retry:
    max: 2
    when: stuck_or_timeout_failure
  except:
    - schedules

.test_screenshots_template:
  extends: .test_template
  artifacts:
    paths:
      - test/screenshots/
    when: on_failure
    expire_in: 1 mo

.build:
  extends: .pull_cache
  before_script: *dependencies
  stage: build
  only:
    - master
  except:
    - schedules
  script:
    - python build.py build -t $PLATFORM
  artifacts:
    paths:
      - adblockplusfirefox-*.xpi
      - adblockpluschrome-*.zip
      - adblockplusedge-*.appx

lint:
  extends: .test_template
  script:
    - npm run lint

build:chrome:
  extends: .build
  variables:
    PLATFORM: chrome

build:gecko:
  extends: .build
  variables:
    PLATFORM: gecko

build:edge:
  extends: .build
  variables:
    PLATFORM: edge

prepare-dependencies:
  stage: prepare
  script: *dependencies
  cache:
    key: cache_$CI_COMMIT_SHA
    paths:
      - ./
    policy: push
  except:
    - schedules

docs:
  extends: .test_template
  script:
    - npm run docs
  artifacts:
    paths:
      - docs/
    expire_in: 3 mos

test:firefox:oldest:
  extends: .test_screenshots_template
  script:
    - npm run test-only -- -g 'Firefox \(oldest\)'

test:firefox:latest:
  extends: .test_screenshots_template
  script:
    - npm run test-only -- -g 'Firefox \(latest\)'

test:chromium:oldest:
  extends: .test_screenshots_template
  script:
    - xvfb-run -a npm run test-only -- -g 'Chromium \(oldest\)'

test:chromium:latest:
  extends: .test_screenshots_template
  script:
    - xvfb-run -a npm run test-only -- -g 'Chromium \(latest\)'

.download:
  stage: download
  script:
    - npm install
    - npm run archive -- $EXTENSION_ID
  artifacts:
    paths:
      - adblockpluschrome-*.crx
  only:
    - schedules

download:release:
  extends: .download
  variables:
    EXTENSION_ID: "cfhdojbkjhnklbpkdaibdccddilifddb"

download:devbuild:
  extends: .download
  variables:
    EXTENSION_ID: "ldcecbkkoecffmfljeihcmifjjdoepkn"

.scp:
  stage: scp
  only:
    - schedules
  tags:
    - protected
  script:
    - "scp *.crx $DESTINATION"

scp:release:
  extends: .scp
  dependencies:
    - download:release
  variables:
    DESTINATION: "builds_user@eyeofiles.com:/var/adblockplus/fileserver/builds/releases/"

scp:devbuild:
  extends: .scp
  dependencies:
    - download:devbuild
  variables:
    DESTINATION: "builds_user@eyeofiles.com:/var/adblockplus/fileserver/builds/devbuilds/adblockpluschrome/"