Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pragma for feature testing: @gate #18581

Merged
merged 4 commits into from
Apr 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ module.exports = {
__UMD__: true,
__EXPERIMENTAL__: true,
__VARIANT__: true,
gate: true,
trustedTypes: true,
},
};
201 changes: 201 additions & 0 deletions scripts/babel/__tests__/transform-test-gate-pragma-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
'use strict';

describe('transform-test-gate-pragma', () => {
// Fake runtime
// eslint-disable-next-line no-unused-vars
const _test_gate = (gateFn, testName, cb) => {
test(testName, (...args) => {
shouldPass = gateFn(context);
return cb(...args);
});
};

// eslint-disable-next-line no-unused-vars
const _test_gate_focus = (gateFn, testName, cb) => {
// NOTE: Tests in this file are not actually focused because the calls to
// `test.only` and `fit` are compiled to `_test_gate_focus`. So if you want
// to focus something, swap the following `test` call for `test.only`.
test(testName, (...args) => {
shouldPass = gateFn(context);
isFocused = true;
return cb(...args);
});
};

// Feature flags, environment variables, etc. We can configure this in
// our test set up.
const context = {
flagThatIsOff: false,
flagThatIsOn: true,
environment: 'fake-environment',
};

let shouldPass;
let isFocused;
beforeEach(() => {
shouldPass = null;
isFocused = false;
});

test('no pragma', () => {
expect(shouldPass).toBe(null);
});

// unrelated comment
test('no pragma, unrelated comment', () => {
expect(shouldPass).toBe(null);
});

// @gate flagThatIsOn
test('basic positive test', () => {
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOff
test('basic negative test', () => {
expect(shouldPass).toBe(false);
});

// @gate flagThatIsOn
it('it method', () => {
expect(shouldPass).toBe(true);
});

/* eslint-disable jest/no-focused-tests */

// @gate flagThatIsOn
test.only('test.only', () => {
expect(isFocused).toBe(true);
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOff
it.only('it.only', () => {
expect(isFocused).toBe(true);
expect(shouldPass).toBe(false);
});

// @gate flagThatIsOn
fit('fit', () => {
expect(isFocused).toBe(true);
expect(shouldPass).toBe(true);
});

/* eslint-enable jest/no-focused-tests */

// @gate !flagThatIsOff
test('flag negation', () => {
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOn
// @gate !flagThatIsOff
test('multiple gates', () => {
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOn
// @gate flagThatIsOff
test('multiple gates 2', () => {
expect(shouldPass).toBe(false);
});

// @gate !flagThatIsOff && flagThatIsOn
test('&&', () => {
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOff || flagThatIsOn
test('||', () => {
expect(shouldPass).toBe(true);
});

// @gate (flagThatIsOn || flagThatIsOff) && flagThatIsOn
test('groups', () => {
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOn == !flagThatIsOff
test('==', () => {
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOn === !flagThatIsOff
test('===', () => {
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOn != !flagThatIsOff
test('!=', () => {
expect(shouldPass).toBe(false);
});

// @gate flagThatIsOn != !flagThatIsOff
test('!==', () => {
expect(shouldPass).toBe(false);
});

// @gate flagThatIsOn === true
test('true', () => {
expect(shouldPass).toBe(true);
});

// @gate flagThatIsOff === false
test('false', () => {
expect(shouldPass).toBe(true);
});

// @gate environment === "fake-environment"
test('double quoted strings', () => {
expect(shouldPass).toBe(true);
});

// @gate environment === 'fake-environment'
test('single quoted strings', () => {
expect(shouldPass).toBe(true);
});
});

describe('transform test-gate-pragma: actual runtime', () => {
// These tests use the actual gating runtime used by the rest of our
// test suite.

// @gate __DEV__
test('__DEV__', () => {
if (!__DEV__) {
throw Error("Doesn't work in production!");
}
});

// Always should fail because of the unguarded console.error
// @gate false
test('works with console.error tracking', () => {
console.error('Should cause test to fail');
});

// Always should fail because of the unguarded console.warn
// @gate false
test('works with console.warn tracking', () => {
console.warn('Should cause test to fail');
});

// @gate false
test('works with console tracking if error is thrown before end of test', () => {
console.warn('Please stop that!');
console.error('Stop that!');
throw Error('I told you to stop!');
});
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat testing strategy ^


describe('dynamic gate method', () => {
// @gate experimental && __DEV__
test('returns same conditions as pragma', () => {
expect(gate(ctx => ctx.experimental && ctx.__DEV__)).toBe(true);
});
});
Loading