Update documentation on automocking #5630

czystyl · 2018-02-21T09:20:27Z

Summary

Updated sections in documentation:

automock
genMockFromModule
enableAutomock and disabledAutomock

Added few example with tests related to changes that made in documentation.

Test plan

facebook-github-bot · 2018-02-21T09:20:48Z

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

codecov-io · 2018-02-21T09:38:46Z

Codecov Report

Merging #5630 into master will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5630      +/-   ##
==========================================
- Coverage   60.94%   60.89%   -0.05%     
==========================================
  Files         215      215              
  Lines        7335     7319      -16     
  Branches        4        3       -1     
==========================================
- Hits         4470     4457      -13     
+ Misses       2864     2861       -3     
  Partials        1        1

Impacted Files	Coverage Δ
...st-cli/src/plugins/update_snapshots_interactive.js	`37.5% <0%> (-9.87%)`	⬇️
packages/jest-cli/src/watch.js	`72.46% <0%> (-0.27%)`	⬇️
packages/jest-cli/src/plugins/update_snapshots.js	`100% <0%> (ø)`	⬆️
packages/jest-cli/src/plugins/test_name_pattern.js	`100% <0%> (ø)`	⬆️
packages/jest-cli/src/plugins/test_path_pattern.js	`100% <0%> (ø)`	⬆️
packages/jest-cli/src/base_watch_plugin.js
packages/jest-cli/src/watch_plugin.js	`50% <0%> (ø)`
packages/jest-runtime/src/index.js	`73.55% <0%> (+0.14%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ab04b7...91ea3b1. Read the comment docs.

thymikee · 2018-02-21T11:41:57Z

docs/Configuration.md

+});
+```
+
+If you are introducing Jest to a large organization with an existing codebase


I don't think that's a good recommendation now, as then switching to "automock": false will be painful. We should kill that paragraph imo.

cc @cpojer @SimenB

I am fine with rolling back this guidance. You are right.

thymikee · 2018-02-21T11:43:05Z

docs/JestObjectAPI.md

@@ -49,9 +49,43 @@ will be cleared and will never have the opportunity to execute in the future.

 Disables automatic mocking in the module loader.

+> See `automock` section of [configuration](Configuration.md) for more


Can you link to the exact place, e.g. Configuration.md#automock-boolean?

thymikee · 2018-02-21T11:43:55Z

docs/JestObjectAPI.md

+
+```js
+// __tests__/disableAutomocking.js
+jest.disableAutomock();


We should be good to move this below import, babel-jest will hoist that.

thymikee · 2018-02-21T11:44:10Z

docs/JestObjectAPI.md

@@ -75,6 +109,35 @@ Enables automatic mocking in the module loader.

 Returns the `jest` object for chaining.

+> See `automock` section of [configuration](Configuration.md) for more


direct link

thymikee · 2018-02-21T11:45:27Z

docs/JestObjectAPI.md

+
+```js
+// __tests__/genMockFromModule.test.js
+import utils from '../utils';


Please remove this, as it's not necessary and redefining it below will throw error.

thymikee

Left some notes inlined

thymikee

I feel it's good to go now. One last thing could be removing the // implementation comment, because it's not necessary.
Please remove it :)

…ng-dock

thymikee · 2018-02-21T12:53:08Z

One more thing, a changelog entry! 😄

thymikee · 2018-02-21T13:32:11Z

CHANGELOG.md

@@ -2,6 +2,8 @@

 ### Fixes

+* `[docs]` Update automatic mocks documentation


Let's add this under ### Chore & Maintenance section below Fixes

czystyl · 2018-02-21T14:10:44Z

Ok done 👍

sayo96 · 2018-04-12T13:22:33Z

check this for a sample of manual and automatic mock
https://facebook.github.io/jest/docs/en/es6-class-mocks.html

sayo96 · 2018-04-12T13:36:27Z

using jest.mock( ' ' ) - creates a automatic mock whereas manual mocks are created by making mock functions in a seperate mock folder .Iam a newbie and its what i interpret upon first reading..

github-actions · 2021-05-12T17:24:14Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

czystyl added 4 commits February 20, 2018 22:03

Update documentation about automocking

954bc79

Add tests for genMockFromModule

9718940

Add test for enableAutomock

186f559

Update genMockFromModule section

42c02dc

czystyl added 2 commits February 21, 2018 10:26

Split examples

c02db18

Update tests in examples

a9026ca

thymikee reviewed Feb 21, 2018

View reviewed changes

thymikee requested changes Feb 21, 2018

View reviewed changes

czystyl and others added 2 commits February 21, 2018 12:52

Request changes

f9b2442

Remove automock guidance

e81f1b3

thymikee reviewed Feb 21, 2018

View reviewed changes

czystyl added 2 commits February 21, 2018 13:39

Remove unnecessary comments

def143e

Merge remote-tracking branch 'origin/automocking-dock' into automocki…

ddbc781

…ng-dock

thymikee approved these changes Feb 21, 2018

View reviewed changes

thymikee changed the title ~~Automocking dock~~ Update documentation on automocking Feb 21, 2018

Update changelog

904f449

thymikee reviewed Feb 21, 2018

View reviewed changes

Add chore section to changelog

91ea3b1

thymikee merged commit 4b6f850 into jestjs:master Feb 21, 2018

czystyl deleted the automocking-dock branch February 21, 2018 14:34

This was referenced Feb 26, 2018

jest versions available: 22.4.2, 22.4.1, 22.4.0 serlo/serlo-abc#269

Closed

Update jest in / from 22.0.4 to 22.4.2 dailybruin/sources#140

Closed

This was referenced Mar 5, 2018

Update jest-environment-jsdom in / from 22.2.0 to 22.4.1 opencomponents/base-templates#271

Closed

Update jest in / from 22.2.1 to 22.4.2 opencomponents/base-templates#272

Merged

github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update documentation on automocking #5630

Update documentation on automocking #5630

czystyl commented Feb 21, 2018 •

edited

Loading

facebook-github-bot commented Feb 21, 2018

codecov-io commented Feb 21, 2018 •

edited

Loading

thymikee Feb 21, 2018

thymikee Feb 21, 2018

cpojer Feb 21, 2018

thymikee Feb 21, 2018 •

edited

Loading

thymikee Feb 21, 2018

thymikee Feb 21, 2018

thymikee Feb 21, 2018

thymikee left a comment

thymikee left a comment

thymikee commented Feb 21, 2018

thymikee Feb 21, 2018

czystyl commented Feb 21, 2018

sayo96 commented Apr 12, 2018

sayo96 commented Apr 12, 2018

github-actions bot commented May 12, 2021

		@@ -49,9 +49,43 @@ will be cleared and will never have the opportunity to execute in the future.

		Disables automatic mocking in the module loader.

		> See `automock` section of [configuration](Configuration.md) for more

		@@ -75,6 +109,35 @@ Enables automatic mocking in the module loader.

		Returns the `jest` object for chaining.

		> See `automock` section of [configuration](Configuration.md) for more

		@@ -2,6 +2,8 @@

		### Fixes

		* `[docs]` Update automatic mocks documentation

Update documentation on automocking #5630

Update documentation on automocking #5630

Conversation

czystyl commented Feb 21, 2018 • edited Loading

Summary

Test plan

facebook-github-bot commented Feb 21, 2018

codecov-io commented Feb 21, 2018 • edited Loading

Codecov Report

thymikee Feb 21, 2018

Choose a reason for hiding this comment

thymikee Feb 21, 2018

Choose a reason for hiding this comment

cpojer Feb 21, 2018

Choose a reason for hiding this comment

thymikee Feb 21, 2018 • edited Loading

Choose a reason for hiding this comment

thymikee Feb 21, 2018

Choose a reason for hiding this comment

thymikee Feb 21, 2018

Choose a reason for hiding this comment

thymikee Feb 21, 2018

Choose a reason for hiding this comment

thymikee left a comment

Choose a reason for hiding this comment

thymikee left a comment

Choose a reason for hiding this comment

thymikee commented Feb 21, 2018

thymikee Feb 21, 2018

Choose a reason for hiding this comment

czystyl commented Feb 21, 2018

sayo96 commented Apr 12, 2018

sayo96 commented Apr 12, 2018

github-actions bot commented May 12, 2021

czystyl commented Feb 21, 2018 •

edited

Loading

codecov-io commented Feb 21, 2018 •

edited

Loading

thymikee Feb 21, 2018 •

edited

Loading