feat: add e2e setup with CircleCi integration (#24)

Author: wojteg1337

.circleci/config.yml

@@ -1,185 +1,70 @@
-# -------------------------
-#        DEFAULTS
-# -------------------------
-defaults: &defaults
-  working_directory: ~/react-native-image-editor
-  environment:
-  - GIT_COMMIT_DESC: git log --format=oneline -n 1 $CIRCLE_SHA1
+version: 2.1
 
-# LINUX
-linux_defaults: &linux_defaults
-  <<: *defaults
-  docker:
-  - image: circleci/node:8
-  environment:
-  - PATH: "/opt/yarn/yarn-v1.5.1/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+orbs:
+  rn: react-native-community/[email protected]
 
-# ANDROID
-android_defaults: &android_defaults
-  <<: *defaults
-  docker:
-  - image: circleci/android:api-27-node8-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"'
-  - BUILD_THREADS: 2
-
-# MACOS
-macos_defaults: &macos_defaults
-  <<: *defaults
-  resource_class: "large"
-  macos:
-    xcode: "10.1.0"
-
-# -------------------------
-#         ALIASES
-# -------------------------
-
-aliases:
-# CACHE
-- &restore-yarn-cache
-  keys:
-  - yarn-cache-{{ arch }}-{{ checksum "package.json" }}-{{ checksum "yarn.lock" }}
-  - yarn-cache-{{ arch }}
-- &save-yarn-cache
-  paths:
-  - ~/.cache/yarn
-  - ~/Library/Detox/ios
-  key: yarn-cache-{{ arch }}-{{ checksum "package.json" }}-{{ checksum "yarn.lock" }}
-
-- &restore-gradle-cache
-  keys:
-  - gradle-cache-{{ checksum "android/build.gradle" }}-{{ checksum "example/android/build.gradle" }}-{{ checksum "example/android/app/build.gradle" }}
-- &save-gradle-cache
-  paths:
-  - ~/.gradle
-  key: gradle-cache-{{ checksum "android/build.gradle" }}-{{ checksum "example/android/build.gradle" }}-{{ checksum "example/android/app/build.gradle" }}
-
-# INSTALLATION
-- &yarn
-  name: Yarn Install
-  command: |
-    yarn install --network-concurrency 1 --non-interactive --cache-folder ~/.cache/yarn & wait
-
-# ANALYSE
-- &eslint
-  name: ESLint Checks
-  command: yarn test:eslint
-
-- &flow
-  name: Flow Checks
-  command: yarn test:flow
-
-# - &jest
-#   name: Jest Unit Tests
-#   command: yarn test:jest
-
-# -------------------------
-#          JOBS
-# -------------------------
-version: 2
 jobs:
-  # Set up a Linux environment for downstream jobs
-  linux-checkout:
-    <<: *linux_defaults
-    steps:
-    - checkout
-    - restore-cache: *restore-yarn-cache
-    - run: rm -rf node_modules
-    - run: yarn cache clean
-    - run: *yarn
-    - save-cache: *save-yarn-cache
-    - persist_to_workspace:
-        root: .
-        paths: .
-
-  eslint:
-    <<: *linux_defaults
-    steps:
-    - attach_workspace:
-        at: ~/react-native-image-editor
-    - run: *eslint
-
-  flow:
-    <<: *linux_defaults
-    steps:
-    - attach_workspace:
-        at: ~/react-native-image-editor
-    - run: *flow
-  
-  # jest:
-  #   <<: *linux_defaults
-  #   steps:
-  #   - attach_workspace:
-  #       at: ~/react-native-image-editor
-  #   - run: *jest
-  
-  android-compile:
-    <<: *android_defaults
+  checkout_code:
+    executor: rn/linux_js
     steps:
-    - attach_workspace:
-        at: ~/react-native-image-editor
-    - restore-cache: *restore-gradle-cache
-    - run:
-        name: Accept Android licences
-        command: |-
-          yes | sdkmanager --licenses || exit 0
-          yes | sdkmanager --update || exit 0
-    - run:
-        name: Build Android Example App and Library
-        command: |-
-          cd example/android
-          ./gradlew clean assembleDebug
-    - save-cache: *save-gradle-cache
-  
-  ios-checkout:
-    <<: *macos_defaults
-    steps:
-    - checkout
-    - restore-cache: *restore-yarn-cache
-    - run: rm -rf node_modules
-    - run: yarn cache clean
-    - run: *yarn
-    - save-cache: *save-yarn-cache
-    - persist_to_workspace:
-        root: .
-        paths: .
-
-  ios-compile:
-    <<: *macos_defaults
+      - checkout
+      - persist_to_workspace:
+          root: .
+          paths: .
+  analyse:
+    executor: rn/linux_js
     steps:
-    - attach_workspace:
-        at: ~/react-native-image-editor
-    - run:
-        name: Build example app
-        command: |-
-          react-native run-ios --project-path example/ios
+      - attach_workspace:
+          at: .
+      - rn/yarn_install
+      - run:
+          name: Lint JS Code (ESLint)
+          command: yarn run test:eslint
+      - run:
+          name: Flow
+          command: yarn run test:flow
+      # TODO: uncomment after adding jest tests
+      # - run:
+      #     name: Jest
+      #     command: yarn run test:jest
+      - run:
+          name: Build Android JavaScript Bundle
+          command: yarn run test:detox:android:bundle:release
+      - run:
+          name: Build iOS JavaScript Bundle
+          command: yarn run test:detox:ios:bundle:release
 
-# -------------------------
-#        WORKFLOWS
-# -------------------------
 workflows:
-  version: 2
-  Test:
+  test:
     jobs:
-    - linux-checkout
-    - eslint:
-        requires:
-        - linux-checkout
-    - flow:
-        requires:
-        - linux-checkout
-    # - jest:
-    #     requires:
-    #     - linux-checkout
-    - android-compile:
-        requires:
-        - linux-checkout
-# Disabled until we have macOS containers enabled        
-#     - ios-checkout
-#     - ios-compile:
-#         requires:
-#         - ios-checkout
+      - checkout_code
+      - analyse:
+          requires:
+            - checkout_code
+      - rn/android_build:
+          name: build_android_debug
+          project_path: "example/android"
+          build_type: debug
+          requires:
+            - analyse
+      - rn/android_build:
+          name: build_android_release
+          project_path: "example/android"
+          build_type: release
+          requires:
+            - analyse
+      - rn/android_test:
+          detox_configuration: "android.emu.release"
+          detox_loglevel: "trace"
+          requires:
+            - build_android_release
+      - rn/ios_build_and_test:
+          project_path: "example/ios/ImageEditorExample.xcodeproj"
+          derived_data_path: "example/ios/build"
+          device: "iPhone X"
+          build_configuration: "Release"
+          scheme: "ImageEditorExample"
+          detox_configuration: "ios.sim.release"
+          detox_loglevel: "trace"
+          requires:
+            - analyse

.gitignore

@@ -43,4 +43,7 @@ local.properties
 buck-out/
 \.buckd/
 *.keystore
+
+# bundle
+.tmp/
 

example/.gitignore

@@ -39,7 +39,8 @@ yarn-error.log
 # BUCK
 buck-out/
 \.buckd/
-*.keystore
+debug.keystore
+!release.keystore
 
 # fastlane
 #

example/android/app/build.gradle

@@ -73,7 +73,8 @@ import com.android.build.OutputFile
  */
 
 project.ext.react = [
-    entryFile: "index.js"
+    entryFile: "example/index.js",
+    root: "../../../"
 ]
 
 apply from: "../../../node_modules/react-native/react.gradle"
@@ -103,6 +104,18 @@ android {
         targetSdkVersion rootProject.ext.targetSdkVersion
         versionCode 1
         versionName "1.0"
+        testBuildType System.getProperty('testBuildType', 'debug')  //this will later be used to control the test apk build type
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    signingConfigs {
+        release {
+            if (project.hasProperty('EXAMPLE_APP_STORE_FILE')) {
+                storeFile file(EXAMPLE_APP_STORE_FILE)
+                storePassword EXAMPLE_APP_STORE_PASSWORD
+                keyAlias EXAMPLE_APP_KEY_ALIAS
+                keyPassword EXAMPLE_APP_KEY_PASSWORD
+            }
+        }
     }
     splits {
         abi {
@@ -114,6 +127,7 @@ android {
     }
     buildTypes {
         release {
+            signingConfig signingConfigs.release
             minifyEnabled enableProguardInReleaseBuilds
             proguardFiles getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro"
         }
@@ -137,6 +151,8 @@ dependencies {
     implementation project(':rnImageEditor')
     implementation "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"
     implementation "com.facebook.react:react-native:+"  // From node_modules
+    androidTestImplementation(project(path: ":detox"))
+    androidTestImplementation 'junit:junit:4.12'
 }
 
 // Run this once to be able to run the application with BUCK

example/android/app/release.keystore

@@ -0,0 +1,24 @@
+package com.imageeditorexample;
+
+import com.wix.detox.Detox;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import androidx.test.filters.LargeTest;
+import androidx.test.rule.ActivityTestRule;
+
+@RunWith(AndroidJUnit4.class)
+@LargeTest
+public class DetoxTest {
+
+    @Rule
+    public ActivityTestRule<MainActivity> mActivityRule = new ActivityTestRule<>(MainActivity.class, false, false);
+
+    @Test
+    public void runDetoxTests() {
+        Detox.runTests(mActivityRule);
+    }
+}

example/android/app/src/androidTest/java/com/imageeditorexample/DetoxTest.java

@@ -3,30 +3,43 @@
 buildscript {
     ext {
         buildToolsVersion = "28.0.3"
-        minSdkVersion = 16
+        minSdkVersion = 18
         compileSdkVersion = 28
         targetSdkVersion = 27
         supportLibVersion = "28.0.0"
+        // e2e
+        ext.kotlinVersion = '1.3.0'
+
     }
     repositories {
         google()
         jcenter()
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:3.2.1'
-
-        // NOTE: Do not place your application dependencies here; they belong
-        // in the individual module build.gradle files
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
     }
 }
 
 allprojects {
+    task downloadDependencies() {
+        description 'Download all dependencies to the Gradle cache'
+        doLast {
+            configurations.findAll().each { config ->
+                if (config.name.contains("minReactNative") && config.canBeResolved) {
+                print config.name
+                print '\n'
+                config.files
+                }
+            }
+        }
+    }
+    
     repositories {
         mavenLocal()
         google()
         jcenter()
         maven {
-            // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
             url "$rootDir/../../node_modules/react-native/android"
         }
     }

example/android/app/src/main/java/com/asyncstorageexample/MainActivity.java renamed to example/android/app/src/main/java/com/imageeditorexample/MainActivity.java

@@ -16,3 +16,8 @@
 # This option should only be used with decoupled projects. More details, visit
 # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
 # org.gradle.parallel=true
+
+EXAMPLE_APP_STORE_FILE=release.keystore
+EXAMPLE_APP_KEY_ALIAS=androiddebugkey
+EXAMPLE_APP_STORE_PASSWORD=android
+EXAMPLE_APP_KEY_PASSWORD=android