fix: custom root or calling Gradle outside of project directory

.circleci/config.yml

@@ -16,6 +16,10 @@ executors:
  <<: *defaults
  docker:
  - image: circleci/ruby:2.4-node
+ reactnative:
+ <<: *defaults
+ docker:
+ - image: reactnativecommunity/react-native-android
 
 commands:
  install-dependencies:
@@ -40,7 +44,7 @@ commands:
  install-cocoapods:
  steps:
  - attach_workspace:
-at: ~/react-native-cli
+ at: ~/react-native-cli
  - run: gem install cocoapods
 
  run-lint:
@@ -86,7 +90,7 @@ jobs:
  steps:
  - run-unit-tests
  e2e-tests:
- executor: node8
+ executor: reactnative
  steps:
  - run-e2e-tests
  lts-tests:

__e2e__/default.test.ts

@@ -1,4 +1,4 @@
-import {run, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
+import {runCLI, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
 
 const DIR = getTempDirectory('test_default_behavior');
 
@@ -11,6 +11,6 @@ afterEach(() => {
 });
 
 test('shows up help information without passing in any args', () => {
- const {stdout} = run(DIR);
+ const {stdout} = runCLI(DIR);
  expect(stdout).toMatchSnapshot();
 });

__e2e__/init.test.ts

@@ -1,6 +1,6 @@
 import fs from 'fs';
 import path from 'path';
-import {run, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
+import {runCLI, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
 
 const DIR = getTempDirectory('command-init');
 
@@ -35,7 +35,7 @@ afterEach(() => {
 });
 
 test('init --template fails without package name', () => {
- const {stderr} = run(
+ const {stderr} = runCLI(
  DIR,
  ['init', '--template', 'react-native-new-template'],
  {expectedFailure: true},
@@ -50,7 +50,7 @@ test('init --template filepath', () => {
  templatePath = templatePath.split('\\').join('/');
  }
 
- const {stdout} = run(DIR, [
+ const {stdout} = runCLI(DIR, [
  'init',
  '--template',
  `file://${templatePath}`,
@@ -76,7 +76,7 @@ test('init --template file with custom directory', () => {
  templatePath = templatePath.split('\\').join('/');
  }
 
- const {stdout} = run(DIR, [
+ const {stdout} = runCLI(DIR, [
  'init',
  '--template',
  `file://${templatePath}`,

__e2e__/install.test.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import {run, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
+import {runCLI, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
 
 const DIR = getTempDirectory('command-install-test');
 const pkg = 'react-native-config';
@@ -17,7 +17,7 @@ test.each(['yarn', 'npm'])('install module with %s', pm => {
  if (pm === 'yarn') {
  writeFiles(DIR, {'yarn.lock': ''});
  }
- const {stdout, code} = run(DIR, ['install', pkg]);
+ const {stdout, code} = runCLI(DIR, ['install', pkg]);
 
  expect(stdout).toContain(`Installing "${pkg}"`);
  expect(stdout).toContain(`Linking "${pkg}"`);

__e2e__/root.test.ts

@@ -0,0 +1,62 @@
+import path from 'path';
+
+import {
+ spawnScript,
+ runCLI,
+ getTempDirectory,
+ cleanup,
+ writeFiles,
+} from '../jest/helpers';
+
+const cwd = getTempDirectory('test_different_roots');
+
+beforeAll(() => {
+ // Register all packages to be linked
+ for (const pkg of ['platform-ios', 'platform-android']) {
+ spawnScript('yarn', ['link'], {
+ cwd: path.join(__dirname, `../packages/${pkg}`),
+ });
+ }
+
+ // Clean up folder and re-create a new project
+ cleanup(cwd);
+ writeFiles(cwd, {});
+
+ // Initialise React Native project
+ runCLI(cwd, ['init', 'TestProject']);
+
+ // Link CLI to the project
+ const pkgs = [
+ '@react-native-community/cli-platform-ios',
+ '@react-native-community/cli-platform-android',
+ ];
+
+ spawnScript('yarn', ['link', ...pkgs], {
+ cwd: path.join(cwd, 'TestProject'),
+ });
+});
+
+afterAll(() => {
+ cleanup(cwd);
+});
+
+test('works when Gradle is run outside of the project hierarchy', () => {
+ /**
+ * Location of Android project
+ */
+ const androidProjectRoot = path.join(cwd, 'TestProject/android');
+
+ /*
+ * Grab absolute path to Gradle wrapper. The fact that we are using
+ * a wrapper from the project is just a convinience to avoid installing
+ * Gradle globally
+ */
+ const gradleWrapper = path.join(androidProjectRoot, 'gradlew');
+
+ // Execute `gradle` with `-p` flag and `cwd` outside of project hierarchy
+ const {stdout} = spawnScript(gradleWrapper, ['-p', androidProjectRoot], {
+ cwd: '/',
+ });
+
+ expect(stdout).toContain('BUILD SUCCESSFUL');
+});

__e2e__/uninstall.test.ts

@@ -1,4 +1,4 @@
-import {run, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
+import {runCLI, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
 
 const DIR = getTempDirectory('command-uninstall-test');
 const pkg = 'react-native-config';
@@ -23,7 +23,9 @@ test('uninstall fails when package is not defined', () => {
  "dependencies": {}
  }`,
  });
- const {stderr, code} = run(DIR, ['uninstall'], {expectedFailure: true});
+ const {stderr, code} = runCLI(DIR, ['uninstall'], {
+ expectedFailure: true,
+ });
 
  expect(stderr).toContain('missing required argument');
  expect(code).toBe(1);
@@ -35,7 +37,9 @@ test('uninstall fails when package is not installed', () => {
  "dependencies": {}
  }`,
  });
- const {stderr, code} = run(DIR, ['uninstall', pkg], {expectedFailure: true});
+ const {stderr, code} = runCLI(DIR, ['uninstall', pkg], {
+ expectedFailure: true,
+ });
 
  expect(stderr).toContain(`Failed to unlink "${pkg}".`);
  expect(code).toBe(1);
@@ -45,7 +49,7 @@ test.each(['yarn', 'npm'])('uninstall module with %s', pm => {
  if (pm === 'yarn') {
  writeFiles(DIR, {'yarn.lock': ''});
  }
- const {stdout, code} = run(DIR, ['uninstall', pkg]);
+ const {stdout, code} = runCLI(DIR, ['uninstall', pkg]);
 
  expect(stdout).toContain(`Unlinking "${pkg}"`);
  expect(stdout).toContain(`Uninstalling "${pkg}"`);

__e2e__/unknown.test.ts

@@ -1,4 +1,4 @@
-import {run, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
+import {runCLI, getTempDirectory, cleanup, writeFiles} from '../jest/helpers';
 
 const DIR = getTempDirectory('test_unknown');
 
@@ -11,12 +11,12 @@ afterEach(() => {
 });
 
 test('warn for passing in unknown commands', () => {
- const {stderr} = run(DIR, ['unknown'], {expectedFailure: true});
+ const {stderr} = runCLI(DIR, ['unknown'], {expectedFailure: true});
  expect(stderr).toContain('error Unrecognized command "unknown".');
 });
 
 test('suggest matching command', () => {
- const {stderr} = run(DIR, ['ini'], {expectedFailure: true});
+ const {stderr} = runCLI(DIR, ['ini'], {expectedFailure: true});
  expect(stderr).toContain(
  'error Unrecognized command "ini". Did you mean "init"?',
  );

jest/helpers.ts

@@ -18,20 +18,20 @@ type RunOptions = {
  expectedFailure?: boolean;
 };
 
-type CLIArgs = {
- dir: string;
- args: string[] | undefined;
- options: RunOptions;
-};
-
-export function run(
+/**
+ * Helper function to run CLI command in a given folder
+ */
+export function runCLI(
  dir: string,
  args?: string[],
  options: RunOptions = {
  expectedFailure: false,
  },
 ) {
- return spawnCli(dir, args, options);
+ return spawnScript(process.execPath, [CLI_PATH, ...(args || [])], {
+ ...options,
+ cwd: dir,
+ });
 }
 
 // Runs cli until a given output is achieved, then kills it with `SIGTERM`
@@ -43,7 +43,11 @@ export async function runUntil(
  expectedFailure: false,
  },
 ) {
- const spawnPromise = spawnCliAsync(dir, args, {timeout: 30000, ...options});
+ const spawnPromise = spawnScriptAsync(dir, args || [], {
+ timeout: 30000,
+ cwd: dir,
+ ...options,
+ });
 
  spawnPromise.stderr.pipe(
  new Writable({
@@ -119,33 +123,45 @@ export const copyDir = (src: string, dest: string) => {
 export const getTempDirectory = (name: string) =>
  path.resolve(os.tmpdir(), name);
 
-function spawnCli(dir: string, args?: string[], options: RunOptions = {}) {
- const {spawnArgs, spawnOptions} = getCliArguments({dir, args, options});
+type SpawnOptions = RunOptions & {
+ cwd: string;
+};
+
+type SpawnFunction<T> = (
+ execPath: string,
+ args: string[],
+ options: SpawnOptions,
+) => T;
 
- const result = execa.sync(process.execPath, spawnArgs, spawnOptions);
+export const spawnScript: SpawnFunction<execa.ExecaReturns> = (
+ execPath,
+ args,
+ options,
+) => {
+ const result = execa.sync(execPath, args, getExecaOptions(options));
 
-handleTestCliFailure(options, result, dir, args);
+handleTestFailure(execPath, options, result, args);
 
  return result;
-}
-
-function spawnCliAsync(dir: string, args?: string[], options: RunOptions = {}) {
- const {spawnArgs, spawnOptions} = getCliArguments({dir, args, options});
+};
 
+const spawnScriptAsync: SpawnFunction<execa.ExecaChildProcess> = (
+ execPath,
+ args,
+ options,
+) => {
  try {
- return execa(process.execPath, spawnArgs, spawnOptions);
+ return execa(execPath, args, getExecaOptions(options));
  } catch (result) {
-handleTestCliFailure(options, result, dir, args);
+handleTestFailure(execPath, options, result, args);
  return result;
  }
-}
+};
 
-function getCliArguments({dir, args, options}: CLIArgs) {
- const isRelative = !path.isAbsolute(dir);
+function getExecaOptions(options: SpawnOptions) {
+ const isRelative = !path.isAbsolute(options.cwd);
 
- if (isRelative) {
- dir = path.resolve(__dirname, dir);
- }
+ const cwd = isRelative ? path.resolve(__dirname, options.cwd) : options.cwd;
 
  const env = Object.assign({}, process.env, {FORCE_COLOR: '0'});
 
@@ -156,28 +172,27 @@ function getCliArguments({dir, args, options}: CLIArgs) {
  env.NODE_PATH = options.nodePath;
  }
 
- const spawnArgs = [CLI_PATH, ...(args || [])];
- const spawnOptions = {
- cwd: dir,
+ return {
+ cwd,
  env,
  reject: false,
  timeout: options.timeout || 0,
  };
- return {spawnArgs, spawnOptions};
 }
 
-function handleTestCliFailure(
- options: RunOptions,
+function handleTestFailure(
+ cmd: string,
+ options: SpawnOptions,
  result: {[key: string]: any},
- dir: string,
  args: string[] | undefined,
 ) {
  if (!options.expectedFailure && result.code !== 0) {
- console.log(`Running CLI failed for unexpected reason. Here's more info:
-${chalk.bold('dir:')} ${dir}
-${chalk.bold('args:')} ${(args || []).join(' ')}
-${chalk.bold('stderr:')} ${result.stderr}
-${chalk.bold('stdout:')} ${result.stdout}
-${chalk.bold('code:')} ${result.code}`);
+ console.log(`Running ${cmd} command failed for unexpected reason. Here's more info:
+${chalk.bold('cmd:')} ${cmd} 
+${chalk.bold('options:')} ${JSON.stringify(options)}
+${chalk.bold('args:')} ${(args || []).join(' ')}
+${chalk.bold('stderr:')} ${result.stderr}
+${chalk.bold('stdout:')} ${result.stdout}
+${chalk.bold('code:')} ${result.code}`);
  }
 }