.gitlab-ci.yml

---

variables:
  DEFAULT_LOCALE: en

.staging:
  variables: &staging
    FIREBASE_DOMAIN: https://staging.adblockplus.dev/
    PREVIEW_CHANNEL_EXPIRATION: 30d

.production:
  variables: &production
    DOMAIN: adblockplus.org
    FIREBASE_DOMAIN: https://www.adblockplus.dev/

.images:
  node: &NODE_IMAGE node:16-alpine
  cloud_sdk: &GOOGLE_CLOUD_SDK_IMAGE google/cloud-sdk:409.0.0
  build: &BUILD_IMAGE registry.gitlab.com/eyeo/websites/docker/adblockinc-cms-202208.1:latest

default:
  tags:
    - "eyeo-small-runner"

stages:
  - prebuild_firebase
  - build_firebase
  - deploy_cloud_run
  - deploy_firebase
  - test

pre_review_build:
  stage: prebuild_firebase
  except:
    - master
    - schedules
  image: *NODE_IMAGE
  before_script:
    - npm install -g firebase-tools@11.13.0
    - cp $GCP_SERVICE_ACCOUNT_CREDENTIALS ~/gcp.json
    - export GOOGLE_APPLICATION_CREDENTIALS=~/gcp.json
  script:
    - cd services/firebase
    - firebase use staging
    - node ./prebuild_staging.mjs
  after_script:
    - rm -rf ~/gcp.json
  artifacts:
    reports:
      dotenv: services/firebase/build.env
  environment:
    name: review/$CI_COMMIT_REF_SLUG

build:review:
  stage: build_firebase
  except:
    - master
    - schedules
  variables:
    <<: *staging
  image: *BUILD_IMAGE
  dependencies:
    - pre_review_build
  before_script:
    - python3 -m pip install -q crudini
  script:
    - crudini --set settings.ini general siteurl "$REVIEW_URL"
    - python3 -m cms.bin.generate_static_pages $PWD services/firebase/public
    - python services/firebase/utils/html_extender.py services/firebase/public
    # copy contents of default locale to base of public root (for firebase),
    # this addresses getting canonical page if no language translation available
    - cp -a services/firebase/public/$DEFAULT_LOCALE/. services/firebase/public/.
  artifacts:
    name: $CI_COMMIT_REF_SLUG
    paths:
      - services/firebase/public

build:review:staging:
  stage: build_firebase
  except:
    - schedules
  variables:
    <<: *staging
  image: *BUILD_IMAGE
  before_script:
    - python3 -m pip install -q crudini
  script:
    - crudini --set settings.ini general siteurl "$FIREBASE_DOMAIN"
    - python3 -m cms.bin.generate_static_pages $PWD services/firebase/public
    - python services/firebase/utils/html_extender.py services/firebase/public
    # copy contents of default locale to base of public root (for firebase),
    # this addresses getting canonical page if no language translation available
    - cp -a services/firebase/public/$DEFAULT_LOCALE/. services/firebase/public/.
  artifacts:
    name: $CI_COMMIT_REF_SLUG
    paths:
      - services/firebase/public
  only:
    - master

build:production:
  stage: build_firebase
  except:
    - schedules
  variables:
    <<: *production
  image: *BUILD_IMAGE
  before_script:
    - python3 -m pip install -q crudini
  script:
    - crudini --set settings.ini general siteurl https://$DOMAIN
    - python3 -m cms.bin.generate_static_pages $PWD services/firebase/public
    - python services/firebase/utils/html_extender.py services/firebase/public
    # copy contents of default locale to base of public root (for firebase),
    # this addresses getting canonical page if no language translation available
    - cp -a services/firebase/public/$DEFAULT_LOCALE/. services/firebase/public/.
  artifacts:
    name: $CI_COMMIT_REF_SLUG
    paths:
      - services/firebase/public
  only:
    - master

deploy_cloud_run:review:
  stage: deploy_cloud_run
  except:
    - master
    - schedules
  image: *GOOGLE_CLOUD_SDK_IMAGE
  before_script:
    - gcloud auth activate-service-account --key-file $GCP_SERVICE_ACCOUNT_CREDENTIALS
    - gcloud config set project $GCP_PROJECT_ID
  script:
    - cd services/cloudrun
    - gcloud builds submit --tag europe-west1-docker.pkg.dev/$GCP_PROJECT_ID/$GCP_PROJECT_ID/$CI_COMMIT_REF_SLUG
    - gcloud run deploy b-$CI_COMMIT_REF_SLUG --image europe-west1-docker.pkg.dev/$GCP_PROJECT_ID/$GCP_PROJECT_ID/$CI_COMMIT_REF_SLUG:latest --region europe-west1 --allow-unauthenticated
  environment:
    name: review/$CI_COMMIT_REF_SLUG
    on_stop: teardown_cloud_run:review
    auto_stop_in: 30d

teardown_cloud_run:review:
  stage: deploy_cloud_run
  except:
    - master
    - schedules
  image: *GOOGLE_CLOUD_SDK_IMAGE
  dependencies: []
  before_script:
    - gcloud auth activate-service-account --key-file $GCP_SERVICE_ACCOUNT_CREDENTIALS
    - gcloud config set project $GCP_PROJECT_ID
  script:
    - gcloud run services delete b-$CI_COMMIT_REF_SLUG --region europe-west1 --quiet
  environment:
    name: review/$CI_COMMIT_REF_SLUG
    action: stop
  when: manual

deploy_cloud_run:review:staging:
  stage: deploy_cloud_run
  except:
    - schedules
  image: *GOOGLE_CLOUD_SDK_IMAGE
  before_script:
    - gcloud auth activate-service-account --key-file $GCP_SERVICE_ACCOUNT_CREDENTIALS
    - gcloud config set project $GCP_PROJECT_ID
  script:
    - cd services/cloudrun
    - gcloud builds submit --tag europe-west1-docker.pkg.dev/$GCP_PROJECT_ID/$GCP_PROJECT_ID/$CI_COMMIT_REF_SLUG
    - gcloud run deploy $CI_COMMIT_REF_SLUG --image europe-west1-docker.pkg.dev/$GCP_PROJECT_ID/$GCP_PROJECT_ID/$CI_COMMIT_REF_SLUG:latest --region europe-west1 --allow-unauthenticated
  environment:
    name: review/staging/$CI_COMMIT_REF_SLUG
  only:
    - master

deploy_cloud_run:production:
  stage: deploy_cloud_run
  except:
    - schedules
  image: *GOOGLE_CLOUD_SDK_IMAGE
  before_script:
    - gcloud auth activate-service-account --key-file $GCP_SERVICE_ACCOUNT_CREDENTIALS
    - gcloud config set project $GCP_PROJECT_ID
  script:
    - cd services/cloudrun
    - gcloud builds submit --tag europe-west1-docker.pkg.dev/$GCP_PROJECT_ID/$GCP_PROJECT_ID/$CI_COMMIT_REF_SLUG
    - gcloud run deploy $CI_COMMIT_REF_SLUG --image europe-west1-docker.pkg.dev/$GCP_PROJECT_ID/$GCP_PROJECT_ID/$CI_COMMIT_REF_SLUG:latest --region europe-west1 --allow-unauthenticated
  environment:
    name: production/$CI_COMMIT_REF_SLUG
  only:
    - master

deploy_firebase_hosting:review:
  stage: deploy_firebase
  except:
    - master
    - schedules
  image: *NODE_IMAGE
  variables:
    <<: *staging
  dependencies:
    - pre_review_build
    - build:review
  before_script:
    - npm install -g firebase-tools@11.13.0
    - npm install commander@"~9.4.0"
    - npm install json5@"~2.2.1"
    - cp $GCP_SERVICE_ACCOUNT_CREDENTIALS ~/gcp.json
    - export GOOGLE_APPLICATION_CREDENTIALS=~/gcp.json
  script:
    - npm run rename-service-ids -- --input ./services/firebase/firebase.json --name b-$CI_COMMIT_REF_SLUG
    - cd services/firebase
    - firebase use staging
    - firebase hosting:channel:deploy $CI_COMMIT_REF_SLUG --expires $PREVIEW_CHANNEL_EXPIRATION
  after_script:
    - rm -rf ~/gcp.json
  environment:
    name: review/$CI_COMMIT_REF_SLUG
    url: $REVIEW_URL
    on_stop: teardown_firebase_hosting:review

teardown_firebase_hosting:review:
  stage: deploy_firebase
  except:
    - master
    - schedules
  image: *NODE_IMAGE
  before_script:
    - npm install -g firebase-tools@11.13.0
    - cp $GCP_SERVICE_ACCOUNT_CREDENTIALS ~/gcp.json
    - export GOOGLE_APPLICATION_CREDENTIALS=~/gcp.json
  script:
    - cd services/firebase
    - firebase use staging
    - firebase hosting:channel:delete $CI_COMMIT_REF_SLUG -f
  environment:
    name: review/$CI_COMMIT_REF_SLUG
    action: stop
  when: manual

deploy_firebase_hosting:review:staging:
  stage: deploy_firebase
  except:
    - schedules
  image:
    *NODE_IMAGE
  variables:
    <<: *staging
  dependencies:
    - build:review:staging
  before_script:
    - npm install -g firebase-tools@11.13.0
    - npm install commander@"~9.4.0"
    - npm install json5@"~2.2.1"
    - cp $GCP_SERVICE_ACCOUNT_CREDENTIALS ~/gcp.json
    - export GOOGLE_APPLICATION_CREDENTIALS=~/gcp.json
  script:
    - npm run rename-service-ids -- --input ./services/firebase/firebase.json --name $CI_COMMIT_REF_SLUG
    - cd services/firebase
    - firebase use staging
    - firebase deploy --only hosting
  after_script:
    - rm -rf ~/gcp.json
  environment:
    name: review/staging/$CI_COMMIT_REF_SLUG
    url: $FIREBASE_DOMAIN
  only:
    - master

deploy_firebase_hosting:production:
  stage: deploy_firebase
  except:
    - schedules
  image: *NODE_IMAGE
  variables:
    <<: *production
  dependencies:
    - build:production
  before_script:
    - npm install -g firebase-tools@11.13.0
    - npm install commander@"~9.4.0"
    - npm install json5@"~2.2.1"
    - cp $GCP_SERVICE_ACCOUNT_CREDENTIALS ~/gcp.json
    - export GOOGLE_APPLICATION_CREDENTIALS=~/gcp.json
  script:
    - npm run rename-service-ids -- --input ./services/firebase/firebase.json --name $CI_COMMIT_REF_SLUG
    - cd services/firebase
    - firebase use production
    - firebase deploy --only hosting
  after_script:
    - rm -rf ~/gcp.json
  environment:
    name: production/$CI_COMMIT_REF_SLUG
    url: $FIREBASE_DOMAIN
  only:
    - master

# ============================================================================
# TEST JOBS
# ============================================================================

.playwright-artifacts: &playwright-artifacts
  artifacts:
    when: always
    paths:
     - test-results/
     - playwright-report/
    expire_in: 1 week

.playwright-base: &playwright-base
  stage: test
  image: mcr.microsoft.com/playwright:v1.53.2-jammy
  before_script:
    - npm ci
    - export CI_RUN=1
  <<: *playwright-artifacts

# This only works with TEST_ARGS that do not contain quotes
.playwright-test-script: &playwright-test-script
  |-
    if [ -z "${REVIEW_URL}" ]; then
      echo "${CI_JOB_NAME} will run on getadblock.com"
      npx playwright test ${TEST_ARGS} --retries=0
    else
      echo "${CI_JOB_NAME} will run on ${REVIEW_URL}"
      STAGING=1 STAGING_URL=${REVIEW_URL} npx playwright test ${TEST_ARGS} --retries=0
    fi

chromium_tests:
  <<: *playwright-base
  tags:
    - eyeo-medium-runner
  except:
    - schedules
  script:
    - npx playwright install --with-deps
    - |-
      if [ -z "${REVIEW_URL}" ]; then
        echo "The tests will run on Chromium on adblockplus.org"
        npx playwright test --project chromium --grep-invert "@third_party_link|@all_browsers|@visual_regression" --retries=0
      else
        echo "The tests will run on Chromium using ${REVIEW_URL}"
        STAGING=1 STAGING_URL=${REVIEW_URL} npx playwright test --project chromium --grep-invert "@third_party_link|@all_browsers|@visual_regression" --retries=0
      fi

browser_tests:
  <<: *playwright-base
  except:
    - schedules
  variables:
    TEST_ARGS: '--grep @all_browsers'
  script:
    - npx playwright install chrome msedge --with-deps
    - *playwright-test-script

visual_regression_tests:
  <<: *playwright-base
  variables:
    TEST_ARGS: '--project chromium --grep @visual_regression'
  when: manual
  allow_failure: true
  script:
    - npx playwright install --with-deps
    - *playwright-test-script

all_website_tests:
  <<: *playwright-base
  only:
    - schedules
  tags:
    - eyeo-medium-runner
  script:
    - npx playwright install chrome msedge --with-deps
    - npx playwright test