react-native/.circleci/config.yml

aliases:
  # Cache Management
  - &restore-yarn-cache
    keys:
      - v1-yarn-{{ arch }}-{{ checksum "package.json" }}
      # Fallback in case checksum fails
      - v1-yarn-{{ arch }}-
  - &save-yarn-cache
    paths:
      - node_modules
      - ~/.cache/yarn
    key: v1-yarn-{{ arch }}-{{ checksum "package.json" }}

  - &restore-cache-analysis
    keys:
      - v1-analysis-dependencies-{{ arch }}-{{ checksum "package.json" }}{{ checksum "bots/package.json" }}
      # Fallback in case checksum fails
      - v1-analysis-dependencies-{{ arch }}-
  - &save-cache-analysis
    paths:
      - bots/node_modules
      - node_modules
    key: v1-analysis-dependencies-{{ arch }}-{{ checksum "package.json" }}{{ checksum "bots/package.json" }}

  - &restore-cache-android-packages
    keys:
      - v1-android-sdkmanager-packages-{{ arch }}-api-26-alpha-{{ checksum "scripts/circle-ci-android-setup.sh" }}
      # Fallback in case checksum fails
      - v1-android-sdkmanager-packages-{{ arch }}-api-26-alpha-
  - &save-cache-android-packages
    paths:
      - /opt/android/sdk
    key: v1-android-sdkmanager-packages-{{ arch }}-api-26-alpha-{{ checksum "scripts/circle-ci-android-setup.sh" }}

  - &restore-cache-ndk
    keys:
      - v2-android-ndk-{{ arch }}-r10e-32-64
  - &save-cache-ndk
    paths:
      - /opt/ndk
    key: v2-android-ndk-{{ arch }}-r10e-32-64

  - &restore-cache-buck
    keys:
      - v2-buck-{{ arch }}-v2018.02.16.01
  - &save-cache-buck
    paths:
      - ~/buck
    key: v2-buck-{{ arch }}-v2018.02.16.01

  - &restore-cache-watchman
    keys:
      - v1-watchman-{{ arch }}-v4.9.0
  - &save-cache-watchman
    paths:
      - ~/watchman
    key: v1-watchman-{{ arch }}-v4.9.0

  # Branch Filtering
  - &filter-only-master-stable
    branches:
      only:
        - /.*-stable/
        - master

  - &filter-only-stable
    branches:
      only:
        - /.*-stable/

  - &filter-ignore-gh-pages
    branches:
      ignore: gh-pages

  - &filter-ignore-master-stable
    branches:
      ignore:
        - master
        - /.*-stable/
        - gh-pages

  # Dependency Management
  - &install-ndk
    |
      source scripts/circle-ci-android-setup.sh && getAndroidNDK

  - &yarn
    |
      yarn install --non-interactive --cache-folder ~/.cache/yarn

  - &install-yarn
    |
      curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
      echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
      sudo apt-get update && sudo apt-get install yarn

  - &install-node-dependencies
    |
      npm install --no-package-lock --no-spin --no-progress

  - &install-buck
    |
      if [[ ! -e ~/buck ]]; then
        git clone https://github.com/facebook/buck.git ~/buck --branch v2018.02.16.01 --depth=1
      fi
      cd ~/buck && ant
      buck --version

  - &install-node
    |
      curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
      sudo apt-get install -y nodejs

  - &create-ndk-directory
    name: Create Android NDK Directory
    command: |
      if [[ ! -e /opt/ndk ]]; then
        sudo mkdir /opt/ndk
      fi
      sudo chown ${USER:=$(/usr/bin/id -run)}:$USER /opt/ndk

  # CircleCI does not support interpolating env variables in the environment
  #  https://circleci.com/docs/2.0/env-vars/#interpolating-environment-variables-to-set-other-environment-variables
  - &configure-android-path
    name: Configure Environment Variables
    command: |
      echo 'export PATH=${ANDROID_NDK}:~/react-native/gradle-2.9/bin:~/buck/bin:$PATH' >> $BASH_ENV
      source $BASH_ENV

  - &install-android-packages
    | 
      source scripts/circle-ci-android-setup.sh && getAndroidSDK

  - &install-android-build-dependencies
    name: Install Android Build Dependencies
    command: |
      sudo apt-get update -y
      sudo apt-get install ant autoconf automake g++ gcc libqt5widgets5 lib32z1 lib32stdc++6  make maven python-dev python3-dev qml-module-qtquick-controls qtdeclarative5-dev file -y

  # Test Definitions
  - &run-js-tests
    name: JavaScript Test Suite
    command: yarn test-ci
    
  - &run-lint-checks
    name: Lint code
    command: yarn lint --format junit -o ~/react-native/reports/junit/js-lint-results.xml
    when: always

  - &run-flow-checks
    name: Check for errors in code using Flow
    command: yarn flow check
    when: always

  - &build-android-app
    name: Build Android App
    command: |
      buck build ReactAndroid/src/main/java/com/facebook/react
      buck build ReactAndroid/src/main/java/com/facebook/react/shell

  - &create-avd
    name: Create Android Virtual Device
    command: source scripts/circle-ci-android-setup.sh && createAVD
 
  - &launch-avd
    name: Launch Android Virtual Device in Background
    command: source scripts/circle-ci-android-setup.sh && launchAVD
    background: true

  - &wait-for-avd
    name: Wait for Android Virtual Device
    command: source scripts/circle-ci-android-setup.sh && waitForAVD

  - &build-js-bundle
    name: Build JavaScript Bundle
    command: node local-cli/cli.js bundle --max-workers 2 --platform android --dev true --entry-file ReactAndroid/src/androidTest/js/TestBundle.js --bundle-output ReactAndroid/src/androidTest/assets/AndroidTestBundle.js

  - &compile-native-libs
    name: Compile Native Libs for Unit and Integration Tests
    command: ./gradlew :ReactAndroid:packageReactNdkLibsForBuck -Pjobs=$BUILD_THREADS -Pcom.android.build.threadPoolSize=1
    no_output_timeout: 6m

  - &run-android-unit-tests
    name: Run Unit Tests
    command: buck test ReactAndroid/src/test/... --config build.threads=$BUILD_THREADS

  - &run-android-instrumentation-tests
    name: Run Instrumentation Tests
    command: |
      if [[ ! -e ReactAndroid/src/androidTest/assets/AndroidTestBundle.js ]]; then	
        echo "JavaScript bundle missing, cannot run instrumentation tests. Verify build-js-bundle step completed successfully."; exit 1;
      fi
      source scripts/circle-ci-android-setup.sh && NO_BUCKD=1 retry3 timeout 300 buck install ReactAndroid/src/androidTest/buck-runner:instrumentation-tests --config build.threads=$BUILD_THREADS
  
  - &collect-android-test-results
    name: Collect Test Results
    command: |
      find . -type f -regex ".*/build/test-results/debug/.*xml" -exec cp {} ~/react-native/reports/junit/ \;
      find . -type f -regex ".*/outputs/androidTest-results/connected/.*xml" -exec cp {} ~/react-native/reports/junit/ \;
      find . -type f -regex ".*/buck-out/gen/ReactAndroid/src/test/.*/.*xml" -exec cp {} ~/react-native/reports/junit/ \;
    when: always

  - &setup-artifacts
    name: Initial Setup
    command: | 
      mkdir -p ~/react-native/reports/junit/

  - &build-objc-ios-test-app
    name: Build Objective-C iOS Test App
    command: ./scripts/objc-test-ios.sh
  
  - &run-objc-ios-tests
    name: Objective-C iOS Test Suite
    command: ./scripts/objc-test-ios.sh test

  - &build-objc-tvos-test-app
    name: Build Objective-C tvOS Test App
    command: ./scripts/objc-test-tvos.sh

  - &run-objc-tvos-tests
    name: Objective-C tvOS Test Suite
    command: ./scripts/objc-test-tvos.sh test

  - &run-objc-ios-e2e-tests
    name: Objective-C iOS End-to-End Test Suite
    command: node ./scripts/run-ci-e2e-tests.js --ios --js --retries 3;

  - &run-objc-tvos-e2e-tests
    name: Objective-C tvOS End-to-End Test Suite
    command: node ./scripts/run-ci-e2e-tests.js --tvos --js --retries 3;

defaults: &defaults
  working_directory: ~/react-native

js_defaults: &js_defaults
  <<: *defaults
  docker:
    - image: circleci/node:8

android_defaults: &android_defaults
  <<: *defaults
  docker:
    - image: circleci/android:api-26-alpha
  resource_class: "large"
  environment:
    - TERM: "dumb"
    - ADB_INSTALL_TIMEOUT: 10
    - _JAVA_OPTIONS: "-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap"
    - GRADLE_OPTS: '-Dorg.gradle.daemon=false -Dorg.gradle.jvmargs="-XX:+HeapDumpOnOutOfMemoryError"'
    - ANDROID_NDK: '/opt/ndk/android-ndk-r10e'
    - BUILD_THREADS: 2

macos_defaults: &macos_defaults
  <<: *defaults
  macos:
    xcode: "9.2.0"

version: 2
jobs:

  # Set up a Node environment for downstream jobs
  checkout_code:
    <<: *js_defaults
    steps:
      - checkout
      - run: *setup-artifacts

      - restore-cache: *restore-yarn-cache
      - run: *yarn
      - save-cache: *save-yarn-cache

      - persist_to_workspace:
          root: .
          paths: .

  # Runs JavaScript lint and flow checks.
  # Currently will fail a PR if lint/flow raises issues.
  js_checks:
    <<: *js_defaults
    steps:
      - attach_workspace:
          at: ~/react-native

      - run: *run-lint-checks
      - run: *run-flow-checks

      - store_test_results:
          path: ~/react-native/reports/junit
      - store_artifacts:
          path: ~/react-native/reports/junit
      - store_artifacts:
          path: ~/react-native/yarn.lock

  # Runs JavaScript tests on Node 8
  test_javascript:
    <<: *js_defaults
    steps:
      - attach_workspace:
          at: ~/react-native

      - run: *run-js-tests

      - store_test_results:
          path: ~/react-native/reports/junit
      - store_artifacts:
          path: ~/react-native/reports/junit

  # Runs JavaScript tests on Node 6
  test_javascript_node6_compatibility:
    <<: *defaults
    docker:
      - image: circleci/node:6
    steps:
      - checkout
      - run: *setup-artifacts

      - restore-cache: *restore-yarn-cache
      - run: *yarn
      - save-cache: *save-yarn-cache

      - run: *run-js-tests

      - store_test_results:
          path: ~/react-native/reports/junit
      - store_artifacts:
          path: ~/react-native/reports/junit

  # Builds iOS test app
  build_objc_ios_test_app:
    <<: *macos_defaults
    dependencies:
      pre:
        - xcrun instruments -w "iPhone 5s (11.1)" || true
    steps:
      - attach_workspace:
          at: ~/react-native

      - run: *build-objc-ios-test-app

  # Runs unit tests on iOS devices
  test_objc_ios:
    <<: *macos_defaults
    dependencies:
      pre:
        - xcrun instruments -w "iPhone 5s (11.1)" || true
    steps:
      - attach_workspace:
          at: ~/react-native

      - run: *run-objc-ios-tests

      - store_test_results:
          path: ~/react-native/reports/junit
      - store_artifacts:
          path: ~/react-native/reports/junit

  # Builds tvOS test app
  build_objc_tvos_test_app:
    <<: *macos_defaults
    dependencies:
      pre:
        - xcrun instruments -w "Apple TV 1080p (11.1)" || true
    steps:
      - attach_workspace:
          at: ~/react-native

      - run: *build-objc-tvos-test-app

  # Runs unit tests on tvOS devices
  test_objc_tvos:
    <<: *macos_defaults
    dependencies:
      pre:
        - xcrun instruments -w "Apple TV 1080p (11.1)" || true
    steps:
      - attach_workspace:
          at: ~/react-native

      - run: *run-objc-tvos-tests

      - store_test_results:
          path: ~/react-native/reports/junit
      - store_artifacts:
          path: ~/react-native/reports/junit

  # Runs end to end tests
  test_objc_ios_e2e:
    <<: *macos_defaults
    dependencies:
      pre:
        - xcrun instruments -w "iPhone 5s (11.1)" || true
    steps:
      - attach_workspace:
          at: ~/react-native

      - run: *run-objc-ios-e2e-tests

      - store_test_results:
          path: ~/react-native/reports/junit
      - store_artifacts:
          path: ~/react-native/reports/junit

  # Checks podspec
  test_podspec:
    <<: *macos_defaults
    steps:
      - attach_workspace:
          at: ~/react-native

      - run: ./scripts/process-podspecs.sh
      
  # Publishes new version onto npm
  publish_npm_package:
    <<: *android_defaults
    steps:
      # Checkout code so that we can work with `git` in publish.js
      - checkout
      
      # Configure Android SDK and related dependencies
      - run: *configure-android-path
      - run: *install-android-build-dependencies
      - restore-cache: *restore-cache-android-packages
      - run: *install-android-packages
      - save-cache: *save-cache-android-packages

      # Install Android NDK
      - run: *create-ndk-directory
      - restore-cache: *restore-cache-ndk
      - run: *install-ndk
      - save-cache: *save-cache-ndk

      # Fetch dependencies using BUCK
      - restore-cache: *restore-cache-buck
      - run: *install-buck
      - save-cache: *save-cache-buck

      - run: buck fetch ReactAndroid/src/test/java/com/facebook/react/modules
      - run: buck fetch ReactAndroid/src/main/java/com/facebook/react
      - run: buck fetch ReactAndroid/src/main/java/com/facebook/react/shell
      - run: buck fetch ReactAndroid/src/test/...
      - run: buck fetch ReactAndroid/src/androidTest/...
      - run: ./gradlew :ReactAndroid:downloadBoost :ReactAndroid:downloadDoubleConversion :ReactAndroid:downloadFolly :ReactAndroid:downloadGlog :ReactAndroid:downloadJSCHeaders

      - run: *install-node
      - run: *install-yarn
      - restore-cache: *restore-yarn-cache
      - run: *yarn
      - save-cache: *save-yarn-cache
      
      - run:
          name: Publish React Native Package
          command: |
            if [ -z "$CIRCLE_PULL_REQUEST" ]; then
              echo "//registry.npmjs.org/:_authToken=${CIRCLE_NPM_TOKEN}" > ~/.npmrc
              git config --global user.email "reactjs-bot@users.noreply.github.com"
              git config --global user.name "npm Deployment Script"
              echo "machine github.com login reactjs-bot password $GITHUB_TOKEN" > ~/.netrc
              node ./scripts/publish-npm.js
            else
              echo "Skipping deploy."            
            fi

  # Set up an Android environment for downstream jobs
  test_android:
    <<: *android_defaults
    steps:
      - attach_workspace:
          at: ~/react-native

      # Configure Android SDK and related dependencies
      - run: *configure-android-path
      - run: *install-android-build-dependencies
      - restore-cache: *restore-cache-android-packages
      - run: *install-android-packages
      - save-cache: *save-cache-android-packages

      # Starting emulator in advance as it takes some time to boot.      
      - run: *create-avd
      - run: *launch-avd

      # Keep configuring Android dependencies while AVD boots up

      # Install Android NDK
      - run: *create-ndk-directory
      - restore-cache: *restore-cache-ndk
      - run: *install-ndk
      - save-cache: *save-cache-ndk

      # Fetch dependencies using BUCK
      - restore-cache: *restore-cache-buck
      - run: *install-buck
      - save-cache: *save-cache-buck

      - run: buck fetch ReactAndroid/src/test/java/com/facebook/react/modules
      - run: buck fetch ReactAndroid/src/main/java/com/facebook/react
      - run: buck fetch ReactAndroid/src/main/java/com/facebook/react/shell
      - run: buck fetch ReactAndroid/src/test/...
      - run: buck fetch ReactAndroid/src/androidTest/...
      - run: ./gradlew :ReactAndroid:downloadBoost :ReactAndroid:downloadDoubleConversion :ReactAndroid:downloadFolly :ReactAndroid:downloadGlog :ReactAndroid:downloadJSCHeaders

      # Build and compile
      - run: *build-android-app
      - run: *compile-native-libs

      # Build JavaScript Bundle for instrumentation tests
      - run: *install-node
      - run: *build-js-bundle

      # Wait for AVD to finish booting before running tests
      - run: *wait-for-avd
            
      # Test Suite
      - run: *run-android-unit-tests
      - run: *run-android-instrumentation-tests
      
      # post (always runs)
      - run: *collect-android-test-results
      - store_test_results:
          path: ~/react-native/reports/junit
      - store_artifacts:
          path: ~/react-native/reports/junit


  # Analyze pull request and raise any lint/flow issues.
  # Issues will be posted to the PR itself via GitHub bots.
  # This workflow should only fail if the bots fail to run.
  analyze_pr:
    <<: *js_defaults
    steps:
      - attach_workspace:
          at: ~/react-native

      - restore-cache: *restore-cache-analysis
      - run: *yarn
      - run:
          name: Install Additional Dependencies
          command: |
            if [ -n "$CIRCLE_PR_NUMBER" ]; then
              yarn add github@0.2.4
              cd bots
              yarn install --non-interactive --cache-folder ~/.cache/yarn
            else
              echo "Skipping dependency installation."            
            fi
      - save-cache: *save-cache-analysis

      - run:
          name: Analyze Pull Request
          command: |
            # DANGER_GITHUB_API_TOKEN=Facebook-Open-Source-Bot public_repo access token
            if [ -n "$CIRCLE_PR_NUMBER" ]; then
              cd bots && DANGER_GITHUB_API_TOKEN="b186c9a82bab3b08ec80""c0818117619eec6f281a" yarn danger
            else
              echo "Skipping pull request analysis."            
            fi
          when: always
      - run:
          name: Analyze Code
          command: |
            # GITHUB_TOKEN=eslint-bot public_repo access token
            if [ -n "$CIRCLE_PR_NUMBER" ]; then
              cat <(echo eslint; yarn --silent lint --format=json; echo flow; yarn --silent flow check --json) | GITHUB_TOKEN="af6ef0d15709bc91d""06a6217a5a826a226fb57b7" CI_USER=$CIRCLE_PROJECT_USERNAME CI_REPO=$CIRCLE_PROJECT_REPONAME PULL_REQUEST_NUMBER=$CIRCLE_PR_NUMBER node bots/code-analysis-bot.js
            else
              echo "Skipping code analysis."            
            fi
          when: always

# Workflows enables us to run multiple jobs in parallel
workflows:
  version: 2

  tests:
    jobs:

      # Checkout repo and run Yarn
      - checkout_code:
          filters: *filter-ignore-gh-pages

      # Run lint and flow checks
      - js_checks:
          filters: *filter-ignore-gh-pages
          requires:
            - checkout_code

      # Test JavaScript
      - test_javascript:
          filters: *filter-ignore-gh-pages
          requires:
            - checkout_code

      # Test JavaScript using Node 6, the minimum supported version
      - test_javascript_node6_compatibility:
          filters: *filter-ignore-gh-pages

      # Test Android
      - test_android:
          filters: *filter-ignore-gh-pages
          requires:
            - checkout_code

      # Build iOS & tvOS test apps
      - build_objc_ios_test_app:
          filters: *filter-ignore-gh-pages
          requires:
            - checkout_code
      - build_objc_tvos_test_app:
          filters: *filter-ignore-gh-pages
          requires:
            - checkout_code

      # End-to-end tests
      - test_objc_ios_e2e:
          filters: *filter-ignore-gh-pages
          requires:
            - checkout_code

  # Only runs on PRs
  analyze:
    jobs:
      # Checkout repo and run Yarn
      - checkout_code:
          filters: *filter-ignore-master-stable
          
      # Run code checks
      - analyze_pr:            
          filters: *filter-ignore-master-stable
          requires:            
            - checkout_code

  # Only runs on NN-stable branches
  deploy:
    jobs:          
      # If we are on a stable branch, wait for approval to deploy to npm
      - approve_publish_npm_package:
          filters: *filter-only-stable
          type: approval

      - publish_npm_package:
          requires:
            - approve_publish_npm_package

  # These tests are flaky or are yet to be fixed. They are placed on their own 
  # workflow to avoid marking benign PRs as broken.
  # To run them, uncomment the entire block and open a PR (do not merge). 
  # Once a test is fixed, move the test definition to the 'tests' workflow.
  # disabled_tests:
  #   jobs:
  #     # Checkout repo and run Yarn (pre-req, should succeed)
  #     - checkout_code:
  #         filters: *filter-ignore-gh-pages

  #     # The following were DISABLED because they have not run since 
  #     # the migration from Travis, and they have broken since then,
  #     # Test iOS & tvOS
  #     - test_objc_ios:
  #         filters: *filter-ignore-gh-pages
  #         requires:
  #           - checkout_code
  #     - test_objc_tvos:
  #         filters: *filter-ignore-gh-pages
  #         requires:
  #           - checkout_code
  #     # CocoaPods
  #     - test_podspec:
  #         filters: *filter-ignore-gh-pages
  #         requires:
  #           - checkout_code