feat: adding e2e tests, build automation and linting (#174)

* Added lint-staged with pre-commit hooks to have more consistent code styling. 
* Integrated the test app into this repository
* Added simple end to end tests for the test app
* Using Github Actions for CI/CD
* Using semantic-release for fully automated version management and package publishing

.eslintignore

@@ -0,0 +1,2 @@
+example/RNBackgroundExample/node_modules
+example/RNBackgroundExample/e2e

.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: '@react-native-community',
+};

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect -->
+
+# Summary
+
+<!--
+Explain the **motivation** for making this change: here are some points to help you:
+
+* What issues does the pull request solve? Please tag them so that they will get automatically closed once the PR is merged
+* What is the feature? (if applicable)
+* How did you implement the solution?
+* What areas of the library does it impact?
+-->
+
+## Test Plan
+
+<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. -->
+
+### What's required for testing (prerequisites)?
+
+### What are the steps to reproduce (after prerequisites)?
+
+## Compatibility
+
+| OS      | Implemented |
+| ------- | :---------: |
+| iOS     |    ✅❌     |
+| Android |    ✅❌     |
+
+## Checklist
+
+<!-- Check completed item, when applicable, via: [X] -->
+
+- [ ] I have tested this on a device and a simulator
+- [ ] I added the documentation in `README.md`
+- [ ] I updated the typed files (TS and Flow)
+- [ ] I've added Detox End-to-End Test(s)
+- [ ] I've created a snack to demonstrate the changes: LINK HERE

.github/workflows/android.yml

@@ -0,0 +1,62 @@
+name: Test Android Example App
+
+on: [push, pull_request]
+
+jobs:
+  react-native-android:
+    runs-on: macos-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+
+    steps:
+    - name: Checkout project
+      uses: actions/checkout@v1
+
+    - name: Specify node version
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12
+
+    - name: Use specific Java version for sdkmanager to work
+      uses: joschi/setup-jdk@v1
+      with:
+        java-version: 'openjdk8'
+        architecture: 'x64'
+
+    - name: Setup Android emulator
+      run: |
+        echo y | sudo $ANDROID_HOME/tools/bin/sdkmanager "system-images;android-28;google_apis;x86" > /dev/null
+        $ANDROID_HOME/tools/bin/avdmanager -s create avd -n emu -k "system-images;android-28;google_apis;x86" -b "x86" -c 1G -d 7 -f
+
+    - name: Install node_modules
+      working-directory: example/RNBackgroundExample/
+      run:
+        yarn install --frozen-lockfile
+
+    - name: Deploy
+      working-directory: example/RNBackgroundExample/
+      run:
+        yarn e2e/deploy/android
+
+    - name: Start Emulator
+      working-directory: example/RNBackgroundExample/
+      timeout-minutes: 5
+      run: |
+        export PATH=$PATH:$ANDROID_HOME/platform-tools
+        $ANDROID_HOME/emulator/emulator @emu -noaudio -no-boot-anim -netdelay none -accel on -no-snapshot &
+        adb wait-for-device; adb shell 'while [[ -z $(getprop sys.boot_completed) ]]; do sleep 1; done;'; adb shell wm dismiss-keyguard
+
+    - name: Android test
+      working-directory: example/RNBackgroundExample/
+      timeout-minutes: 8
+      run: |
+        mkdir -p ./artifacts
+        node e2e/start-server.js &
+        adb reverse tcp:8080 tcp:8080
+        yarn e2e/test/android --record-videos failing
+
+    - uses: actions/upload-artifact@master
+      name: Provide videos of failed E2E tests
+      if: failure()
+      with:
+        name: android-failing-e2e-videos
+        path: example/RNBackgroundExample/artifacts

.github/workflows/deploy-release.yml

@@ -0,0 +1,28 @@
+name: Deploy & Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy-release:
+    runs-on: macos-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+
+    steps:
+    - name: Checkout project
+      uses: actions/checkout@v1
+
+    - name: Specify node version
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12
+
+    - name: Release to NPM
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      run: |
+        yarn install --frozen-lockfile
+        npx semantic-release

.github/workflows/iOS.yml

@@ -0,0 +1,40 @@
+name: Test iOS Example App
+
+on: [push, pull_request]
+
+jobs:
+  react-native-ios:
+    runs-on: macos-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+
+    steps:
+    - name: Checkout project
+      uses: actions/checkout@v1
+
+    - name: Specify node version
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12
+
+    - name: Setup Detox
+      run: |
+        brew tap wix/brew
+        brew install applesimutils
+
+    - name: Install node_modules
+      working-directory: example/RNBackgroundExample/
+      run:
+        yarn install --frozen-lockfile
+
+    - name: Deploy
+      working-directory: example/RNBackgroundExample/
+      run:
+        yarn deploy/release/ios
+
+    - name: iOS test
+      working-directory: example/RNBackgroundExample/
+      timeout-minutes: 8
+      run: |
+        npx detox clean-framework-cache && npx detox build-framework-cache
+        node e2e/start-server.js &
+        yarn e2e/test/ios

.github/workflows/node.yml

@@ -0,0 +1,24 @@
+name: Node Environment
+
+on: [push, pull_request]
+
+jobs:
+  node-lint-tests:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v1
+
+    - name: setup node
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12
+
+    - name: install node_modules
+      run: yarn install --frozen-lockfile
+
+    - name: node lint
+      run:
+        yarn lint:ci

.gitignore

@@ -33,6 +33,7 @@ DerivedData
 *.ipa
 *.xcuserstate
 project.xcworkspace
+Pods/
 
 # Android/IntelliJ
 #

.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  bracketSpacing: true,
+  jsxBracketSameLine: true,
+  singleQuote: true,
+  trailingComma: 'all',
+};

CHANGELOG.md

@@ -0,0 +1,3 @@
+Since Version > 5.3.0 we follow semantic versioning.
+
+See the [releases](https://github.com/Vydia/react-native-background-upload/releases) page on GitHub for information regarding each release.

README.md

@@ -1,4 +1,10 @@
 # react-native-background-upload [![npm version](https://badge.fury.io/js/react-native-background-upload.svg)](https://badge.fury.io/js/react-native-background-upload)
+
+
+![GitHub Actions status](https://github.com/Vydia/react-native-background-upload/workflows/iOS/badge.svg)
+
+![GitHub Actions status](https://github.com/Vydia/react-native-background-upload/workflows/android/badge.svg)
+
 The only React Native http post file uploader with android and iOS background support.  If you are uploading large files like videos, use this so your users can background your app during a long upload.
 
 NOTE: Use major version 4 with RN 47.0 and greater.  If you have RN less than 47, use 3.0.  To view all available versions:
@@ -79,7 +85,7 @@ No further actions required.
 
 ## 3. Expo
 
-To use this library with [Expo](https://expo.io) one must first detach (eject) the project and follow [step 2](#2-link-native-code) instructions. Additionally on iOS there is a must to add a Header Search Path to other dependencies which are managed using Pods. To do so one has to add `$(SRCROOT)/../../../ios/Pods/Headers/Public` to Header Search Path in `VydiaRNFileUploader` module using XCode. 
+To use this library with [Expo](https://expo.io) one must first detach (eject) the project and follow [step 2](#2-link-native-code) instructions. Additionally on iOS there is a must to add a Header Search Path to other dependencies which are managed using Pods. To do so one has to add `$(SRCROOT)/../../../ios/Pods/Headers/Public` to Header Search Path in `VydiaRNFileUploader` module using XCode.
 
 # Usage
 
@@ -146,7 +152,7 @@ All top-level methods are available as named exports or methods on the default e
 
 ### startUpload(options)
 
-The primary method you will use, this starts the upload process.  
+The primary method you will use, this starts the upload process.
 
 Returns a promise with the string ID of the upload.  Will reject if there is a connection problem, the file doesn't exist, or there is some other problem.
 
@@ -292,7 +298,7 @@ Is there an example/sandbox app to test out this package?
 
 > Yes, there is a simple react native app that comes with an [express](https://github.com/expressjs/express) server where you can see react-native-background-upload in action and try things out in an isolated local environment.
 
-[ReactNativeBackgroundUploadExample](https://github.com/Vydia/ReactNativeBackgroundUploadExample)
+[RNBackgroundExample](https://github.com/Vydia/react-native-background-upload/blob/master/example/RNBackgroundExample)
 
 Does it support iOS camera roll assets?
 

example/RNBackgroundExample/.buckconfig

@@ -0,0 +1,6 @@
+
+[android]
+  target = Google Inc.:Google APIs:23
+
+[maven_repositories]
+  central = https://repo1.maven.org/maven2

example/RNBackgroundExample/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: '@react-native-community',
+};

example/RNBackgroundExample/.flowconfig

@@ -0,0 +1,75 @@
+[ignore]
+; We fork some components by platform
+.*/*[.]android.js
+
+; Ignore "BUCK" generated dirs
+<PROJECT_ROOT>/\.buckd/
+
+; Ignore polyfills
+node_modules/react-native/Libraries/polyfills/.*
+
+; These should not be required directly
+; require from fbjs/lib instead: require('fbjs/lib/warning')
+node_modules/warning/.*
+
+; Flow doesn't support platforms
+.*/Libraries/Utilities/LoadingView.js
+
+[untyped]
+.*/node_modules/@react-native-community/cli/.*/.*
+
+[include]
+
+[libs]
+node_modules/react-native/Libraries/react-native/react-native-interface.js
+node_modules/react-native/flow/
+
+[options]
+emoji=true
+
+esproposal.optional_chaining=enable
+esproposal.nullish_coalescing=enable
+
+module.file_ext=.js
+module.file_ext=.json
+module.file_ext=.ios.js
+
+munge_underscores=true
+
+module.name_mapper='^react-native$' -> '<PROJECT_ROOT>/node_modules/react-native/Libraries/react-native/react-native-implementation'
+module.name_mapper='^react-native/\(.*\)$' -> '<PROJECT_ROOT>/node_modules/react-native/\1'
+module.name_mapper='^[./a-zA-Z0-9$_-]+\.\(bmp\|gif\|jpg\|jpeg\|png\|psd\|svg\|webp\|m4v\|mov\|mp4\|mpeg\|mpg\|webm\|aac\|aiff\|caf\|m4a\|mp3\|wav\|html\|pdf\)$' -> '<PROJECT_ROOT>/node_modules/react-native/Libraries/Image/RelativeImageStub'
+
+suppress_type=$FlowIssue
+suppress_type=$FlowFixMe
+suppress_type=$FlowFixMeProps
+suppress_type=$FlowFixMeState
+
+suppress_comment=\\(.\\|\n\\)*\\$FlowFixMe\\($\\|[^(]\\|(\\(<VERSION>\\)? *\\(site=[a-z,_]*react_native\\(_ios\\)?_\\(oss\\|fb\\)[a-z,_]*\\)?)\\)
+suppress_comment=\\(.\\|\n\\)*\\$FlowIssue\\((\\(<VERSION>\\)? *\\(site=[a-z,_]*react_native\\(_ios\\)?_\\(oss\\|fb\\)[a-z,_]*\\)?)\\)?:? #[0-9]+
+suppress_comment=\\(.\\|\n\\)*\\$FlowExpectedError
+
+[lints]
+sketchy-null-number=warn
+sketchy-null-mixed=warn
+sketchy-number=warn
+untyped-type-import=warn
+nonstrict-import=warn
+deprecated-type=warn
+unsafe-getters-setters=warn
+inexact-spread=warn
+unnecessary-invariant=warn
+signature-verification-failure=warn
+deprecated-utility=error
+
+[strict]
+deprecated-type
+nonstrict-import
+sketchy-null
+unclear-type
+unsafe-getters-setters
+untyped-import
+untyped-type-import
+
+[version]
+^0.105.0

example/RNBackgroundExample/.gitattributes

@@ -0,0 +1 @@
+*.pbxproj -text