Player testing: Cavy framework setup

.github/workflows/ci.yml

@@ -94,6 +94,9 @@ jobs:
       - name: Install node_modules (example/)
         run: yarn install --frozen-lockfile --cwd example
 
+      - name: Install node_modules (integration_test/)
+        run: yarn install --frozen-lockfile --cwd integration_test
+
       - name: Compile TypeScript
         run: yarn typescript
 
@@ -117,6 +120,9 @@ jobs:
       - name: Install node_modules (example/)
         run: yarn install --frozen-lockfile --cwd example
 
+      - name: Install node_modules (integration_test/)
+        run: yarn install --frozen-lockfile --cwd integration_test
+
       - name: Build docs
         run: yarn docs
 
@@ -146,6 +152,9 @@ jobs:
       - name: Install node_modules (example/)
         run: yarn install --frozen-lockfile --cwd example
 
+      - name: Install node_modules (integration_test/)
+        run: yarn install --frozen-lockfile --cwd integration_test
+
       - name: Set up Gradle cache
         uses: gradle/gradle-build-action@v2
         with:

CONTRIBUTING.md

@@ -145,12 +145,20 @@ Our pre-commit hooks verify that your commit message matches this format when co
 
 The `package.json` file contains various scripts for common tasks:
 
-- `yarn bootstrap`: setup project by installing all dependencies and pods.
-- `yarn pods`: install pods only.
+- `yarn bootstrap`: setup the whole project by installing all dependencies and pods.
+- `yarn bootstrap:example`: setup example project by installing all dependencies and pods.
+- `yarn bootstrap:integration-test`: setup example project by installing all dependencies and pods.
 - `yarn build`: compile TypeScript files into `lib/` with ESBuild.
 - `yarn typescript`: type-check files with TypeScript.
 - `yarn lint`: lint files with ESLint.
-- `yarn test`: run unit tests with Jest.
+- `yarn format`: format files with Prettier.
+- `yarn docs`: generate documentation with TypeDoc.
+- `yarn brew`: install all dependencies for iOS development with Homebrew.
 - `yarn example start`: start the Metro server for the example app.
 - `yarn example android`: run the example app on Android.
+- `yarn example pods`: install pods only.
+- `yarn integration-test start`: start the Metro server for the example app.
+- `yarn integration-test test:android`: run the player tests on Android.
+- `yarn integration-test test:ios`: run the player tests on iOS.
+- `yarn integration-test pods`: install pods only.
 - `yarn example ios`: run the example app on iOS.

example/package.json

@@ -6,7 +6,10 @@
   "scripts": {
     "android": "react-native run-android",
     "ios": "react-native run-ios",
-    "start": "react-native start"
+    "start": "react-native start",
+    "pods": "yarn pods-install || yarn pods-update",
+    "pods-install": "yarn pod-install",
+    "pods-update": "pod update --silent"
   },
   "dependencies": {
     "@react-native-picker/picker": "2.5.1",

integration_test/babel.config.js

@@ -1,3 +1,17 @@
+const path = require('path');
+const pak = require('../package.json');
+
 module.exports = {
   presets: ['module:metro-react-native-babel-preset'],
+  plugins: [
+    [
+      'module-resolver',
+      {
+        extensions: ['.tsx', '.ts', '.js', '.json'],
+        alias: {
+          [pak.name]: path.join(__dirname, '../src/'),
+        },
+      },
+    ],
+  ],
 };

integration_test/index.test.js

@@ -0,0 +1,5 @@
+import { AppRegistry } from 'react-native';
+import TestableApp from './src/TestableApp';
+import { name as appName } from './app.json';
+
+AppRegistry.registerComponent(appName, () => TestableApp);

integration_test/package.json

@@ -6,26 +6,32 @@
     "android": "react-native run-android",
     "ios": "react-native run-ios",
     "start": "react-native start",
+    "playertest:android": "yarn cavy run-android",
+    "playertest:ios": "yarn cavy run-ios",
     "pods": "yarn pods-install || yarn pods-update",
     "pods-install": "yarn pod-install",
     "pods-update": "pod update --silent"
   },
   "dependencies": {
+    "cavy": "^4.0.2",
     "react": "18.2.0",
     "react-native": "npm:[email protected]"
   },
   "devDependencies": {
     "@babel/core": "^7.20.0",
     "@babel/preset-env": "^7.20.0",
     "@babel/runtime": "^7.20.0",
-    "@tsconfig/react-native": "^3.0.0",
-    "@types/react": "^18.0.24",
     "@react-native/metro-config": "^0.72.11",
+    "babel-plugin-module-resolver": "^5.0.0",
     "metro-react-native-babel-preset": "0.76.8",
     "pod-install": "^0.1.39",
-    "typescript": "4.8.4"
+    "@types/cavy": "^3.2.7",
+    "cavy-cli": "^3.0.0"
   },
   "engines": {
     "node": ">=16"
+  },
+  "resolutions": {
+    "@types/react": "~17.0.21"
   }
 }

integration_test/src/TestableApp.tsx

@@ -0,0 +1,32 @@
+import React from 'react';
+import { Tester, TestHookStore } from 'cavy';
+import Specs from '../tests';
+import { StyleSheet, Text, View } from 'react-native';
+import { Colors } from 'react-native/Libraries/NewAppScreen';
+
+const testHookStore = new TestHookStore();
+
+function TestableApp(): JSX.Element {
+  return (
+    <Tester specs={Specs} store={testHookStore}>
+      <View style={styles.container}>
+        <Text style={styles.text}>Tests will come here</Text>
+      </View>
+    </Tester>
+  );
+}
+
+export default TestableApp;
+
+const styles = StyleSheet.create({
+  container: {
+    flex: 1,
+    justifyContent: 'center',
+    alignItems: 'center',
+    padding: 10,
+  },
+  text: {
+    fontSize: 24,
+    color: Colors.darker,
+  },
+});

integration_test/tests/exampleSpec.ts

@@ -0,0 +1,9 @@
+import { TestScope } from 'cavy';
+
+export default (spec: TestScope) => {
+  spec.describe('cavy', () => {
+    spec.it('works', async () => {
+      await new Promise((resolve) => setTimeout(resolve, 1000));
+    });
+  });
+};

integration_test/tests/index.ts

@@ -0,0 +1,3 @@
+import ExampleSpec from './exampleSpec';
+
+export default [ExampleSpec];