config.yml

version: 2.1

orbs:
  aws-cli: circleci/aws-cli@3.1
  codecov: codecov/codecov@1.1.3

aws_cli_setup: &aws_cli_setup
  role-arn: $AWS_ROLE_ARN

xcode_version: &xcode_version 13.3.1
iphone_name: &iphone_name iPhone 8
preload_simulator: &preload_simulator xcrun instruments -w "iPhone 8 (15.4) [" || true

# Works around an issue in xcodebuild where it requires GitHub to have been added to the known_hosts in order for it to clone dependencies.
spm_ssh_workaround: &spm_ssh_workaround for ip in $(dig @1.1.1.1 github.com +short); do ssh-keyscan github.com,$ip; ssh-keyscan $ip; done 2>/dev/null >> ~/.ssh/known_hosts

# Templates

default_environment: &default_environment
  CIRCLE_ARTIFACTS: /tmp
  BUNDLE_PATH: vendor/bundle
  FL_OUTPUT_DIR: output
  LC_ALL: en_US.UTF-8
  LANG: en_US.UTF-8
  IPHONE_NAME: *iphone_name
  XCODE_VERSION: *xcode_version
  PLATFORM: iOS

base_job: &base_job
  macos:
    xcode: *xcode_version
  working_directory: ~/kickstarter

test_job: &test_job
  steps:
    - checkout
    - run:
        name: SPM SSH Workaround
        command: *spm_ssh_workaround
    - run:
        name: Store Xcode Version
        command: xcodebuild -version > xcode_version.txt
    - restore_cache:
        name: Restore SPM Cache
        keys:
          - spm-cache-v1-{{ checksum "./Kickstarter.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved" }}-{{ checksum "xcode_version.txt" }}
    - run:
        name: Bootstrap SPM
        command: xcodebuild -resolvePackageDependencies -clonedSourcePackagesDirPath SourcePackages
    - run:
        name: Bootstrap
        command: make bootstrap
    - run:
        name: Download GraphQL Schema
        command: bin/apollo-schema-download.sh
    - run:
        name: Pre-load simulator
        command: *preload_simulator
    - run:
        name: Run tests
        command: make test
        no_output_timeout: "20m" # 20 minutes
    - restore_cache:
        name: Restore Bundler
        keys:
          - v1-gems-{{ checksum "Gemfile.lock" }}
    - run:
        name: Install Bundler
        command: bundle check || bundle install
        environment:
          BUNDLE_JOBS: 4
          BUNDLE_RETRY: 3
    - run:
        name: Generate Slather coverage report
        command: bundle exec slather coverage -x --scheme $SCHEME ./Kickstarter.xcodeproj
    - codecov/upload:
        file: cobertura.xml

distribute_job: &distribute_job
  steps:
    - checkout
    - aws-cli/setup:
        <<: *aws_cli_setup
    - run:
        name: SPM SSH Workaround
        command: *spm_ssh_workaround
    - run:
        name: Store Xcode Version
        command: xcodebuild -version > xcode_version.txt
    - restore_cache:
        name: Restore SPM Cache
        keys:
          - spm-cache-v1-{{ checksum "./Kickstarter.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved" }}-{{ checksum "xcode_version.txt" }}
    - run:
        name: Bootstrap SPM
        command: xcodebuild -resolvePackageDependencies -clonedSourcePackagesDirPath SourcePackages
    - run:
        name: Bootstrap
        command: make bootstrap
    - restore_cache:
        keys:
          - v1-gems-{{ checksum "Gemfile.lock" }}
    - run:
        name: Bundle install
        command: bundle check || bundle install
        environment:
          BUNDLE_JOBS: 4
          BUNDLE_RETRY: 3
    - save_cache:
        key: v1-gems-{{ checksum "Gemfile.lock" }}
        paths:
          - vendor/bundle
    - run:
        name: Increment build number
        command: agvtool new-version -all $(($(date +%s)/100))
    - run:
        name: Fastlane
        command: bundle exec fastlane $LANE --verbose
        no_output_timeout: "30m" # 30 minutes
        environment:
          FASTLANE_XCODEBUILD_SETTINGS_TIMEOUT: 180
    - run:
        name: Upload dSYMs
        command: bin/upload-dysms-firebase.sh $FIREBASE_DIR $DSYMS_FILE
    - run:
        name: Cleanup Temp Branch
        command: make cleanup
    - store_artifacts:
        path: output

all_jobs: &all_jobs
  - build-and-cache
  - kickstarter-tests
  - library-tests
  - ksapi-tests

# Jobs

jobs:
  build-and-cache:
    <<: *base_job
    environment:
      - *default_environment
    steps:
      - checkout
      - run:
          name: SPM SSH Workaround
          command: *spm_ssh_workaround
      - run:
          name: Store Xcode Version
          command: xcodebuild -version > xcode_version.txt
      - restore_cache:
          name: Restore SPM Cache
          keys:
            - spm-cache-v1-{{ checksum "./Kickstarter.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved" }}-{{ checksum "xcode_version.txt" }}
      - run:
          name: Bootstrap SPM
          command: xcodebuild -resolvePackageDependencies -clonedSourcePackagesDirPath SourcePackages
      - run:
          name: Bootstrap
          command: make bootstrap
      - save_cache:
          name: Cache SPM
          key: spm-cache-v1-{{ checksum "./Kickstarter.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved" }}-{{ checksum "xcode_version.txt" }}
          paths:
            - SourcePackages
      - restore_cache:
          name: Restore Bundler
          keys:
            - v1-gems-{{ checksum "Gemfile.lock" }}
      - run:
          name: Install Bundler
          command: bundle check || bundle install
          environment:
            BUNDLE_JOBS: 4
            BUNDLE_RETRY: 3
      - save_cache:
          name: Cache Bundler
          key: v1-gems-{{ checksum "Gemfile.lock" }}
          paths:
            - vendor/bundle
      - run:
          name: Danger
          command: bin/danger.sh

  # Kickstarter tests
  kickstarter-tests:
    <<: *base_job
    <<: *test_job
    environment:
      - *default_environment
      - SCHEME=Kickstarter-Framework-iOS

  # Library tests
  library-tests:
    <<: *base_job
    <<: *test_job
    environment:
      - *default_environment
      - TARGET=Library
      - SCHEME=Library-iOS

  # KsApi tests
  ksapi-tests:
    <<: *base_job
    <<: *test_job
    environment:
      - *default_environment
      - SCHEME=KsApi

  deploy_alpha:
    <<: *base_job
    environment:
      - *default_environment
    steps:
      - checkout
      - aws-cli/setup:
          <<: *aws_cli_setup
      - run:
          name: Deploy Alpha
          command: make alpha

  deploy_beta:
    <<: *base_job
    environment:
      - *default_environment
    steps:
      - checkout
      - aws-cli/setup:
          <<: *aws_cli_setup
      - run:
          name: Deploy Beta
          command: make beta

  # AppCenter and S3 bucket beta
  beta:
    <<: *base_job
    <<: *distribute_job
    environment:
      - *default_environment
      - LANE=beta_match_gym_appcenter_s3
      - FIREBASE_DIR=Firebase-Beta
      - DSYMS_FILE=KickBeta.app.dSYM.zip

  # AppCenter Alpha
  alpha:
    <<: *base_job
    <<: *distribute_job
    environment:
      - *default_environment
      - LANE=alpha_match_gym_appcenter
      - FIREBASE_DIR=Firebase-Alpha
      - DSYMS_FILE=KickAlpha.app.dSYM.zip

  refresh_app_store_dsyms:
    <<: *base_job
    environment:
      - *default_environment
    steps:
      - checkout
      - run:
          name: Secrets
          command: make secrets
      - restore_cache:
          keys:
            - v1-gems-{{ checksum "Gemfile.lock" }}
      - run:
          name: Bundle install
          command: bundle check || bundle install
          environment:
            BUNDLE_JOBS: 4
            BUNDLE_RETRY: 3
      - save_cache:
          key: v1-gems-{{ checksum "Gemfile.lock" }}
          paths:
            - vendor/bundle
      - run:
          name: Download dSYMs and upload to Crashlytics
          command: bundle exec fastlane refresh_dsyms

  # iTunes
  itunes:
    <<: *base_job
    <<: *distribute_job
    environment:
      - *default_environment
      - LANE=itunes_match_gym_deliver
      - FIREBASE_DIR=Firebase-Production
      - DSYMS_FILE=Kickstarter.app.dSYM.zip

# Workflows
workflows:
  version: 2
  build:
    # Matches all_jobs
    jobs:
      - build-and-cache
      - kickstarter-tests
      - library-tests
      - ksapi-tests
# ** Refreshing dSYMs disabled until a suitable workaround is found for App Store Connect 2FA authentication
# or Fastlane implements API key support in this Fastlane action. Uncomment below to re-enable.
# See: https://docs.fastlane.tools/app-store-connect-api/
# https://docs.fastlane.tools/best-practices/continuous-integration/
#      - refresh_app_store_dsyms:
#          filters:
#            branches:
#              # matches all branches that begin with 'beta-dist'
#              only: /beta-dist-.*/
      - deploy_alpha:
          context: aws
          filters:
            branches:
              # matches all branches that contain 'feature' but do not contain 'alpha-dist'
              only: /^((?!alpha\-dist).*feature.*)*$/
          requires: *all_jobs
      - deploy_beta:
          context: aws
          filters:
            branches:
              only: main
          requires: *all_jobs
      - beta:
          filters:
            branches:
              # matches all branches that begin with 'beta-dist'
              only: /beta-dist-.*/
          requires: *all_jobs
      - alpha:
          filters:
            branches:
              # matches all branches that begin with 'alpha-dist'
              only: /alpha-dist.*/
          requires: *all_jobs
      - itunes:
          context: aws
          filters:
            branches:
              # matches branch named exactly `itunes-dist`
              only: itunes-dist
          requires: *all_jobs

experimental:
  notify:
    branches:
      only:
        # matches branch named exactly `main`
        - main
        # matches all branches that begin with 'alpha-dist'
        - /alpha-dist.*/
        # matches all branches that begin with 'beta-dist'
        - /beta-dist-.*/
        # matches branch named exactly `itunes-dist`
        - itunes-dist