Skip to content

Commit

Permalink
Test utils deprecations and updates:
Browse files Browse the repository at this point in the history
1. Moved react-addons-test-utils to react-dom/test-utils and added deprecation message.
2. Moved shallow renderer (previous accessible via TestUtils.createRenderer) to react-test-renderer/shallow and added deprecation message.
3. Updated READMEs for react-addons-test-utils and react-test-renderer
  • Loading branch information
Brian Vaughn committed Apr 4, 2017
1 parent 550381b commit 3a7eef2
Show file tree
Hide file tree
Showing 14 changed files with 2,304 additions and 12 deletions.
31 changes: 31 additions & 0 deletions addons/react-addons-test-utils/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
BSD License

For React software

Copyright (c) 2013-present, Facebook, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name Facebook nor the names of its contributors may be used to
endorse or promote products derived from this software without specific
prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 changes: 33 additions & 0 deletions addons/react-addons-test-utils/PATENTS
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Additional Grant of Patent Rights Version 2

"Software" means the React software distributed by Facebook, Inc.

Facebook, Inc. ("Facebook") hereby grants to each recipient of the Software
("you") a perpetual, worldwide, royalty-free, non-exclusive, irrevocable
(subject to the termination provision below) license under any Necessary
Claims, to make, have made, use, sell, offer to sell, import, and otherwise
transfer the Software. For avoidance of doubt, no license is granted under
Facebook's rights in any patent claims that are infringed by (i) modifications
to the Software made by you or any third party or (ii) the Software in
combination with any software or other technology.

The license granted hereunder will terminate, automatically and without notice,
if you (or any of your subsidiaries, corporate affiliates or agents) initiate
directly or indirectly, or take a direct financial interest in, any Patent
Assertion: (i) against Facebook or any of its subsidiaries or corporate
affiliates, (ii) against any party if such Patent Assertion arises in whole or
in part from any software, technology, product or service of Facebook or any of
its subsidiaries or corporate affiliates, or (iii) against any party relating
to the Software. Notwithstanding the foregoing, if Facebook or any of its
subsidiaries or corporate affiliates files a lawsuit alleging patent
infringement against you in the first instance, and you respond by filing a
patent infringement counterclaim in that lawsuit against that party that is
unrelated to the Software, the license granted hereunder will not terminate
under section (i) of this paragraph due to such counterclaim.

A "Necessary Claim" is a claim of a patent owned by Facebook that is
necessarily infringed by the Software standing alone.

A "Patent Assertion" is any lawsuit or other action alleging direct, indirect,
or contributory infringement or inducement to infringe any patent, including a
cross-claim or counterclaim.
9 changes: 9 additions & 0 deletions addons/react-addons-test-utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# react-addons-test-utils

This package provides the React TestUtils add-on.

See <https://facebook.github.io/react/docs/test-utils.html> for more information.

This package is deprecated as of version 15.5.0:
* TestUtils have been moved to `react-dom/test-utils`
* Shallow renderer has been moved to `react-test-renderer/shallow`
20 changes: 20 additions & 0 deletions addons/react-addons-test-utils/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/**
* Copyright 2013-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/

'use strict';

// This package has been deprecated in NPM as of version 15.5.0
// But NPM deprecation warnings are easy to overlook
// So a more explicit runtime warning seemed appropriate
console.error(

This comment has been minimized.

Copy link
@gaearon

gaearon Apr 6, 2017

Collaborator

Not sure if it matters but we generally use this check. Why not use warning module here?

This comment has been minimized.

Copy link
@bvaughn

bvaughn Apr 6, 2017

Contributor

Good call, Dan > I'll update it.

'ReactTestUtils has been moved to react-dom/test-utils. ' +
'Update references to remove this warning.'
);

module.exports = require('react-dom/lib/ReactTestUtils');
29 changes: 29 additions & 0 deletions addons/react-addons-test-utils/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "react-addons-test-utils",
"version": "15.5.0",
"main": "index.js",
"repository": "facebook/react",
"keywords": [
"react",
"react-addon"
],
"license": "BSD-3-Clause",
"dependencies": {
"fbjs": "^0.8.4",
"object-assign": "^4.1.0"
},
"peerDependencies": {
"react-dom": "^15.4.2"
},
"devDependencies": {
"jest": "^19.0.2",
"react": "^15.4.2",
"react-dom": "^15.4.2"
},
"files": [
"LICENSE",
"PATENTS",
"README.md",
"index.js"
]
}
60 changes: 60 additions & 0 deletions addons/react-addons-test-utils/test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/**
* Copyright 2013-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
* @emails react-core
*/

'use strict';

describe('ReactTestUtils', function() {
let ReactTestUtils;
let React;

beforeEach(function() {
spyOn(console, 'error');

React = require('react');
ReactTestUtils = require('./index');
});

it('should warn on include', function() {
expect(console.error).toHaveBeenCalledWith(
'ReactTestUtils has been moved to react-dom/test-utils. ' +
'Update references to remove this warning.'
);
});

it('should pass a basic smoke test', function() {
const ReactTestUtils = require('./index');
const onClick = jest.fn();

class MyComponent extends React.Component {
constructor(props, context) {
super(props, context);
this.state = { bar: 123 };
}
render() {
return <div onClick={onClick}>{this.props.baz}</div>;
}
}

const instance = ReactTestUtils.renderIntoDocument(
<MyComponent baz='abc' />
);

expect(instance.state.bar).toBe(123);
expect(instance.props.baz).toBe('abc');

const div = ReactTestUtils.findRenderedDOMComponentWithTag(instance, 'div');
expect(div.textContent).toBe('abc');

expect(onClick).not.toHaveBeenCalled();
ReactTestUtils.Simulate.click(div);
expect(onClick).toHaveBeenCalled();
});
});
Loading

0 comments on commit 3a7eef2

Please sign in to comment.