.gitlab-ci.yml

include:
  - local: ".gitlab-ci.d/i18n.yml"

  - project: 'proton/devops/atlas-deploy'
    file: '/scenarios/pipeline-env.yml'

  - project: "tpe/testmo-reporter"
    file: '/scenarios/testmo-script.yml'

  - project: 'apple/inbox/security-scanners'
    file:
      - 'jobs/gitleaks.yaml'

variables:
  LANG: "en_US.UTF-8"
  MINT_PATH: "$CI_PROJECT_DIR/ci-cache/mint"
  ATLAS_DEPLOY_LIST: ""
  ATLAS_LINK_APP: mail
  ATLAS_DEPLOY_ENV: "true"
  GIT_SUBMODULE_STRATEGY: recursive

# See https://confluence.protontech.ch/pages/viewpage.action?pageId=121918293
stages:
  - i18n
  - scan
  - build
  - deploy
  - test
  - report
  - cleanup
  - distribute
  - bot

.setup_project: &setup_project
  - mint bootstrap
  - cd ProtonMail
  - bundle install
  - ./xcodeGenHelper.sh
  - cd ..

.macos_job:
  image: team-mail:1
  cache:
    - key:
        files:
          - Mintfile
      paths:
        - ci-cache/mint
      when: always
    - key:
        files:
          - ProtonMail/Gemfile.lock
      paths:
        - bundler-cache
      when: always
    - key:
        files:
          - ProtonMail/ProtonMail.xcworkspace/xcshareddata/swiftpm/Package.resolve
      paths:
        - ci-cache/spm
      when: always
  before_script:
    - *setup_project
  tags:
    - mail-tart

workflow:
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
    - if: $CI_COMMIT_BRANCH == "develop"

build:debug:for-testing:
  extends: .macos_job
  stage: build
  allow_failure: false
  interruptible: true
  artifacts:
    when: on_success
    paths:
      - test_output/Build/Products/Debug-iphonesimulator/ProtonMail.app
      - test_output/Build/Products/Debug-iphonesimulator/ProtonMailUITests-Runner.app
      - build_job_pwd.txt
    expire_in: 1 day
  script:
    - cd ProtonMail
    - bundle exec fastlane build_for_testing
    # record the current directory so that it can be used by the test jobs to calculate code coverage if they run on a different runner
    - echo ${PWD#/private} >> ../build_job_pwd.txt

test:unit:
  extends: .macos_job
  stage: test
  coverage: '/Test Coverage: \d*.\d*%/'
  only:
    - master
    - main
    - develop
    - /^release\/.*$/
    - merge_requests
  except:
    - schedules
  artifacts:
    reports:
      coverage_report:
        coverage_format: cobertura
        path: test_output/slatherOutput/cobertura.xml
    paths:
      - test_output/slatherOutput/
  script:
    - brew bundle --force
    - cd ProtonMail
    - bundle exec fastlane unit_test
    - ../Scripts/generate_code_coverage_report.sh
  tags:
    - iOS_GENERAL

.test:ui:
  extends: .macos_job
  dependencies:
    - deploy:review
    - build:debug:for-testing
  stage: test
  artifacts:
    when: always
    name: "test-report"
    paths:
      - test_output/TestResults
    expire_in: 10 days
    reports:
      junit:
        - test_output/TestResults/report.xml
  before_script:
    - defaults write com.apple.iphonesimulator ConnectHardwareKeyboard 0 # Fixed UI tests failing on secure field
    - brew bundle --force
    - *setup_project
  tags:
    - iOS_UITEST

test:ui:smoke:
  extends: .test:ui
  except:
    - schedules
  only:
    refs:
      - master
      - main
      - develop
      - /^release\/.*$/
      - merge_requests
  artifacts:
    reports:
      coverage_report:
        coverage_format: cobertura
        path: test_output/slatherOutput/cobertura.xml
  script:
    - echo DYNAMIC_DOMAIN="${DYNAMIC_DOMAIN}"
    - cd ProtonMail
    - bundle exec fastlane ui_test testplan:"SmokeTests" concurrent_workers:"2"
    - ../Scripts/generate_code_coverage_report.sh
  tags:
    - iOS_GENERAL

test:ui:sanity:
  extends: .test:ui
  rules:
      # Allow job to run automatically on each scheduled job with sanity test type
    - if: '$CI_PIPELINE_SOURCE == "schedule" && $TEST_TYPE == "sanity"'
      when: always
    - when: manual
  script:
    - echo DYNAMIC_DOMAIN="${DYNAMIC_DOMAIN}"
    - cd ProtonMail
    - bundle exec fastlane ui_test testplan:"SanityTests" concurrent_workers:"4"
  artifacts:
    reports:
      coverage_report:
        coverage_format: cobertura
        path: test_output/slatherOutput/cobertura.xml
  allow_failure: true

test:ui:feature:
  extends: .test:ui
  rules:
    - if: '$TEST_TYPE == "feature"'
      when: always
  script:
    - cd ProtonMail
    - bundle exec fastlane ui_test testplan:$TEST_PLAN concurrent_workers:$NUMBER_OF_DEVICES

test:ui:regression:
  extends: .test:ui
  timeout: 4 hours
  rules:
      # Allow job to run automatically on each scheduled job with regression test type
    - if: '$CI_PIPELINE_SOURCE == "schedule" && $TEST_TYPE == "regression"'
      when: always
    - when: manual
  script:
    - cd ProtonMail
    - bundle exec fastlane ui_test testplan:RegressionTests concurrent_workers:$NUMBER_OF_DEVICES
  allow_failure: true

test:ui:monkey:
  extends: .test:ui
  timeout: 2 hours
  rules:
    - if: '$TEST_TYPE == "monkey"'
  artifacts:
    name: "monkey-report"
  script:
    - cd ProtonMail
    - bundle exec fastlane ui_test testplan:MonkeyTests concurrent_workers:1

.report:slack:
  stage: report
  image: $CI_REGISTRY/tpe/test-scripts
  allow_failure: true
  tags:
    - shared-small

report:slack:feature:
  dependencies:
    - test:ui:feature
    - test:ui:regression
  extends: .report:slack
  rules:
    - if: '$TEST_TYPE == "regression" || $TEST_TYPE == "feature"'
      when: always
  script:
    - test_reporter.py
      --path test_output/TestResults/
      --platform ios
      --job-name $TEST_PLAN
      --slack-channel "$SLACK_CHANNEL"

report:slack:monkey:
  dependencies:
    - test:ui:monkey
  extends: .report:slack
  rules:
    - if: '$TEST_TYPE == "monkey"'
      when: always
  script:
    - test_reporter.py
      --path test_output/TestResults/
      --platform ios
      --job-name Mail-iOS-Monkey-tests
      --slack-channel mail-ios-uitests

.report:testmo:
  extends: .testmo-upload
  stage: report
  rules:
    - when: manual
  before_script:
    - echo "$MILESTONE"
    - 'if [ -z $MILESTONE ]; then echo "Testmo MILESTONE is not provided. Failing the job."; exit 1; fi'
  variables:
    PROJECT_ID: "7"
    MILESTONE: "$MILESTONE"
    TAGS: "$CI_COMMIT_REF_SLUG"
    SOURCE: "ios"
    RESULT_FOLDER: "./test_output/TestResults/*.xml"
  allow_failure: true
  tags:
    - shared-small

report:testmo:regression:
  dependencies:
    - test:ui:regression
  extends: .report:testmo
  variables:
    NAME: "$TEST_PLAN"

report:testmo:sanity:
  needs:
    - test:ui:sanity
  extends: .report:testmo
  variables:
    NAME: "SanityTests"

.distribute:
  extends: .macos_job
  dependencies: []
  needs: []
  stage: distribute
  rules:
    - if: '$CI_PIPELINE_SOURCE != "schedule"'
      when: manual
      allow_failure: true
  artifacts:
    paths:
      - ./ProtonMail/outputs/ProtonMail.app.dSYM.zip
    name: "iOS mail app builds"
    expire_in: 90 days
  script:
    - brew bundle --force
    - cd ProtonMail
    - base64 -D -o Certificates.p12 <<< $DISTRIBUTION_CERTIFICATE
    - |
        if [ "$IS_QA_BUILD" = "true" ] ; then
          bundle exec fastlane ios adhoc
        else
          bundle exec fastlane ios build
          ./fastlane/add_git_tag.sh
        fi
  tags:
    - iOS_RELEASE_BUILD

testflight:alpha:
  extends: .distribute
  variables:
    GIT_STRATEGY: clone
    GIT_DEPTH: "0"
    IS_QA_BUILD: "false"

firebase:adhoc:qa:
  extends: .distribute
  variables:
    IS_QA_BUILD: "true"

gitleaks-scan-repository:
  variables:
    GIT_STRATEGY: clone
    GIT_SUBMODULE_STRATEGY: none