sinonjs/sinon

Document how to stub out the network layer

Open

#1,459 opened on 2017年6月15日

GitHub で見る
 (4 comments) (2 reactions) (1 assignee)JavaScript (9,548 stars) (764 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.