Unify conditional test logic

This makes the logic a bit easier to read, but also lets us skip some integration tests on Jasmine, which will be needed as we make Circus stricter.
jestjs · May 27, 2018 · eaa1555 · eaa1555
1 parent d5dd58c
commit eaa1555
Show file tree

Hide file tree

Showing 16 changed files with 69 additions and 76 deletions.
diff --git a/integration-tests/__tests__/cli-handles-exact-filenames.test.js b/integration-tests/__tests__/cli-handles-exact-filenames.test.js
@@ -10,13 +10,13 @@
 'use strict';
 
 const path = require('path');
-const SkipOnWindows = require('../../scripts/SkipOnWindows');
+const ConditionalTest = require('../../scripts/ConditionalTest');
 const {extractSummary, cleanup, writeFiles} = require('../Utils');
 const runJest = require('../runJest');
 
 const DIR = path.resolve(__dirname, '../cli_accepts_exact_filenames');
 
-SkipOnWindows.suite();
+ConditionalTest.skipSuiteOnWindows();
 
 beforeEach(() => cleanup(DIR));
 afterAll(() => cleanup(DIR));

diff --git a/integration-tests/__tests__/each.test.js b/integration-tests/__tests__/each.test.js
@@ -13,9 +13,9 @@ const path = require('path');
 const runJest = require('../runJest');
 const {extractSummary} = require('../Utils');
 const dir = path.resolve(__dirname, '../each');
-const SkipOnJestCircus = require('../../scripts/SkipOnJestCircus');
+const ConditionalTest = require('../../scripts/ConditionalTest');
 
-SkipOnJestCircus.suite();
+ConditionalTest.skipSuiteOnJestCircus();
 
 test('works with passing tests', () => {
   const result = runJest(dir, ['success.test.js']);

diff --git a/integration-tests/__tests__/jest_changed_files.test.js b/integration-tests/__tests__/jest_changed_files.test.js
@@ -15,10 +15,10 @@ import {
   findRepos,
   getChangedFilesForRoots,
 } from '../../packages/jest-changed-files/src';
-const SkipOnWindows = require('../../scripts/SkipOnWindows');
+const ConditionalTest = require('../../scripts/ConditionalTest');
 const {cleanup, run, writeFiles} = require('../Utils');
 
-SkipOnWindows.suite();
+ConditionalTest.skipSuiteOnWindows();
 
 const DIR = path.resolve(os.tmpdir(), 'jest_changed_files_test_dir');
 

diff --git a/integration-tests/__tests__/location_in_results.test.js b/integration-tests/__tests__/location_in_results.test.js
@@ -8,11 +8,10 @@
  */
 'use strict';
 
-import skipOnJestCicrus from '../../scripts/SkipOnJestCircus';
 const runJest = require('../runJest');
-const SkipOnJestCircus = require('../../scripts/SkipOnJestCircus');
+const ConditionalTest = require('../../scripts/ConditionalTest');
 
-skipOnJestCicrus.suite();
+ConditionalTest.skipSuiteOnJestCircus();
 
 it('defaults to null for location', () => {
   const result = runJest.json('location-in-results').json;
@@ -37,7 +36,7 @@ it('adds correct location info when provided with flag', () => {
   // Technically the column should be 3, but callsites is not correct.
   // jest-circus uses stack-utils + asyncErrors which resolves this.
   expect(assertions[1].location).toEqual({
-    column: SkipOnJestCircus.isJestCircusRun() ? 3 : 2,
+    column: ConditionalTest.isJestCircusRun() ? 3 : 2,
     line: 15,
   });
 });
diff --git a/integration-tests/__tests__/show_config.test.js b/integration-tests/__tests__/show_config.test.js
@@ -10,12 +10,12 @@
 'use strict';
 
 const path = require('path');
-const SkipOnWindows = require('../../scripts/SkipOnWindows');
+const ConditionalTest = require('../../scripts/ConditionalTest');
 const runJest = require('../runJest');
 const os = require('os');
 const {cleanup, writeFiles} = require('../Utils');
 
-SkipOnWindows.suite();
+ConditionalTest.skipSuiteOnWindows();
 const DIR = path.resolve(os.tmpdir(), 'show_config_test');
 
 beforeEach(() => cleanup(DIR));

diff --git a/packages/jest-circus/src/__mocks__/test_utils.js b/packages/jest-circus/src/__mocks__/test_utils.js
@@ -14,15 +14,15 @@ import {spawnSync} from 'child_process';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
-import skipOnWindows from '../../../../scripts/SkipOnWindows';
+import ConditionalTest from '../../../../scripts/ConditionalTest';
 
 const CIRCUS_PATH = require.resolve('../../build/index');
 const CIRCUS_RUN_PATH = require.resolve('../../build/run');
 const CIRCUS_STATE_PATH = require.resolve('../../build/state');
 const TEST_EVENT_HANDLER_PATH = require.resolve('./test_event_handler');
 const BABEL_REGISTER_PATH = require.resolve('babel-register');
 
-skipOnWindows.suite();
+ConditionalTest.skipSuiteOnWindows();
 
 export const runTest = (source: string) => {
   const tmpFilename = path.join(os.tmpdir(), 'circus-test-file.js');

diff --git a/packages/jest-circus/src/__tests__/hooks.test.js b/packages/jest-circus/src/__tests__/hooks.test.js
@@ -12,8 +12,8 @@
 
 import {runTest} from '../__mocks__/test_utils';
 
-const SkipOnWindows = require('../../../../scripts/SkipOnWindows');
-SkipOnWindows.suite();
+const ConditionalTest = require('../../../../scripts/ConditionalTest');
+ConditionalTest.skipSuiteOnWindows();
 
 test('beforeEach is executed before each test in current/child describe blocks', () => {
   const {stdout} = runTest(`

diff --git a/packages/jest-cli/src/__tests__/search_source.test.js b/packages/jest-cli/src/__tests__/search_source.test.js
@@ -12,7 +12,7 @@ import path from 'path';
 
 jest.setTimeout(15000);
 
-const SkipOnWindows = require('../../../../scripts/SkipOnWindows');
+const ConditionalTest = require('../../../../scripts/ConditionalTest');
 
 const rootDir = path.resolve(__dirname, 'test_root');
 const testRegex = path.sep + '__testtests__' + path.sep;
@@ -25,7 +25,7 @@ let findMatchingTests;
 let normalize;
 
 describe('SearchSource', () => {
-  SkipOnWindows.suite();
+  ConditionalTest.skipSuiteOnWindows();
 
   const name = 'SearchSource';
   let Runtime;

diff --git a/packages/jest-haste-map/src/__tests__/index.test.js b/packages/jest-haste-map/src/__tests__/index.test.js
@@ -103,7 +103,7 @@ jest.mock('graceful-fs', () => ({
 }));
 jest.mock('fs', () => require('graceful-fs'));
 
-const SkipOnWindows = require('../../../../scripts/SkipOnWindows');
+const ConditionalTest = require('../../../../scripts/ConditionalTest');
 
 const cacheFilePath = '/cache-file';
 let consoleWarn;
@@ -119,7 +119,7 @@ let mockWorker;
 let getCacheFilePath;
 
 describe('HasteMap', () => {
-  SkipOnWindows.suite();
+  ConditionalTest.skipSuiteOnWindows();
 
   beforeEach(() => {
     jest.resetModules();

diff --git a/packages/jest-haste-map/src/__tests__/worker.test.js b/packages/jest-haste-map/src/__tests__/worker.test.js
@@ -10,7 +10,7 @@
 
 import path from 'path';
 import fs from 'graceful-fs';
-import SkipOnWindows from '../../../../scripts/SkipOnWindows';
+import ConditionalTest from '../../../../scripts/ConditionalTest';
 
 import H from '../constants';
 
@@ -20,7 +20,7 @@ let mockFs;
 let readFileSync;
 
 describe('worker', () => {
-  SkipOnWindows.suite();
+  ConditionalTest.skipSuiteOnWindows();
 
   beforeEach(() => {
     mockFs = {

diff --git a/packages/jest-haste-map/src/crawlers/__tests__/node.test.js b/packages/jest-haste-map/src/crawlers/__tests__/node.test.js
@@ -8,7 +8,7 @@
 
 'use strict';
 
-const SkipOnWindows = require('../../../../../scripts/SkipOnWindows');
+const ConditionalTest = require('../../../../../scripts/ConditionalTest');
 
 jest.mock('child_process', () => ({
   spawn: jest.fn((cmd, args) => {
@@ -72,7 +72,7 @@ let nodeCrawl;
 let childProcess;
 
 describe('node crawler', () => {
-  SkipOnWindows.suite();
+  ConditionalTest.skipSuiteOnWindows();
 
   beforeEach(() => {
     jest.resetModules();

diff --git a/packages/jest-repl/src/__tests__/jest_repl.test.js b/packages/jest-repl/src/__tests__/jest_repl.test.js
@@ -9,12 +9,12 @@
 
 const {spawnSync} = require('child_process');
 const path = require('path');
-const SkipOnWindows = require('../../../../scripts/SkipOnWindows');
+const ConditionalTest = require('../../../../scripts/ConditionalTest');
 
 const JEST_RUNTIME = path.resolve(__dirname, '../../bin/jest-repl.js');
 
 describe('Repl', () => {
-  SkipOnWindows.suite();
+  ConditionalTest.skipSuiteOnWindows();
 
   describe('cli', () => {
     it('runs without errors', () => {

diff --git a/packages/jest-runtime/src/__tests__/runtime_cli.test.js b/packages/jest-runtime/src/__tests__/runtime_cli.test.js
@@ -10,9 +10,9 @@
 
 const path = require('path');
 const {sync: spawnSync} = require('execa');
-const SkipOnWindows = require('../../../../scripts/SkipOnWindows');
+const ConditionalTest = require('../../../../scripts/ConditionalTest');
 
-SkipOnWindows.suite();
+ConditionalTest.skipSuiteOnWindows();
 
 const JEST_RUNTIME = path.resolve(__dirname, '../../bin/jest-runtime.js');
 

diff --git a/scripts/ConditionalTest.js b/scripts/ConditionalTest.js
@@ -0,0 +1,42 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow
+ */
+
+/* eslint-disable jest/no-focused-tests */
+
+const ConditionalTest = {
+  isJestCircusRun() {
+    return process.env.JEST_CIRCUS === '1';
+  },
+
+  skipSuiteOnJasmine() {
+    if (!this.isJestCircusRun()) {
+      fit('does not work on Jasmine', () => {
+        console.warn('[SKIP] Does not work on Jasmine');
+      });
+    }
+  },
+
+  skipSuiteOnJestCircus() {
+    if (this.isJestCircusRun()) {
+      fit('does not work on jest-circus', () => {
+        console.warn('[SKIP] Does not work on jest-circus');
+      });
+    }
+  },
+
+  skipSuiteOnWindows() {
+    if (process.platform === 'win32') {
+      fit('does not work on Windows', () => {
+        console.warn('[SKIP] Does not work on Windows');
+      });
+    }
+  },
+};
+
+module.exports = ConditionalTest;
diff --git a/scripts/SkipOnJestCircus.js b/scripts/SkipOnJestCircus.js
diff --git a/scripts/SkipOnWindows.js b/scripts/SkipOnWindows.js