sinonjs/sinon

Document how to stub out the network layer

Open

#1,459 创建于 2017年6月15日

在 GitHub 查看
 (4 评论) (2 反应) (1 负责人)JavaScript (9,548 star) (764 fork)batch import
DocumentationHelp wantedhacktoberfestpinned

描述

If one tracks the sinon tag on Stack Overflow one can see that a lot of the questions involve stubbing out the network layer. A lot of people try using the networking utilities in Sinon when doing testing in Node - ultimately failing as they fail to see that XHR is not supported in Node. Example question.

We should create a how-to on stubbing out network requests in Node and the browser (perhaps even for the same module).

贡献者指南

技术栈
javascript
领域
documentationtesting
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Sinon basicsNode.js testingBrowser testingAsynchronous stubs
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
Review the existing Sinon documentation on stubs and fakes, and examine the linked Stack Overflow question to understand common pitfalls. Then create a how to guide in the Sinon docs repository (likely in docs/) covering stubbing network requests in Node (using nock or similar) and in browser (using sinon's fake XMLHttpRequest). Include code examples and explain the differences between environments.