{"action":"created","comment":{"url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/comments/267120462","pull_request_review_id":216448299,"id":267120462,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI2NzEyMDQ2Mg==","diff_hunk":"@@ -15,10 +15,56 @@ as well as always iterating on our testing infrastructure.\n \n ## Testing Framework\n \n-[`py.test`](https://docs.pytest.org/en/latest/) is the default framework we use\n+[`pytest`](https://docs.pytest.org/en/latest/) is the default framework we use\n for testing.\n \n \n+## Test Suite Structure\n+\n+### Test Module Naming/Organization\n+\n+Where possible, test suites should mirror the module structure of their\n+corresponding package.  For example, the\n+[`eth-abi`](https://github.com/ethereum/eth-abi) package has a submodule called\n+[`eth_abi.grammar`](https://github.com/ethereum/eth-abi/blob/master/eth_abi/grammar.py).\n+Accordingly, it has a testing module called\n+[`tests.grammar`](https://github.com/ethereum/eth-abi/blob/master/tests/grammar.py)\n+that contains testing routines for resources provided by the `eth_abi.grammar`\n+module.\n+\n+Test suites may also include a `tests.end_to_end` module that defines\n+functional testing of a package's public API.  This might include common tasks\n+performed with a package that compose different individual components of that\n+package.\n+\n+### Test Case Naming\n+\n+Test case names should adhere to the following format where possible:\n+\n+```\n+def test_<function or class name>_<short description of functionality being tested>:\n+    ...\n+```\n+\n+For example, test cases for a function called `foo` might be named as follows:\n+\n+```python\n+def test_foo_does_kung_fu():\n+    kung_fu = foo()\n+\n+def test_foo_raises_value_error():\n+    with pytest.raises(ValueError):\n+        foo(...)\n+\n+...\n+```\n+\n+***Note:*** At the time of writing this section on test suite structure, many","path":"testing.md","position":49,"original_position":49,"commit_id":"4cf74fe124d2770d9e327d38fbc5c7c68e67b725","original_commit_id":"4cf74fe124d2770d9e327d38fbc5c7c68e67b725","user":{"login":"davesque","id":791437,"node_id":"MDQ6VXNlcjc5MTQzNw==","avatar_url":"https://avatars2.githubusercontent.com/u/791437?v=4","gravatar_id":"","url":"https://api.github.com/users/davesque","html_url":"https://github.com/davesque","followers_url":"https://api.github.com/users/davesque/followers","following_url":"https://api.github.com/users/davesque/following{/other_user}","gists_url":"https://api.github.com/users/davesque/gists{/gist_id}","starred_url":"https://api.github.com/users/davesque/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davesque/subscriptions","organizations_url":"https://api.github.com/users/davesque/orgs","repos_url":"https://api.github.com/users/davesque/repos","events_url":"https://api.github.com/users/davesque/events{/privacy}","received_events_url":"https://api.github.com/users/davesque/received_events","type":"User","site_admin":false},"body":"Ahh, nevermind.  I get what you were saying.  I should be using the `>` line prefix for quotations.","created_at":"2019-03-19T22:17:58Z","updated_at":"2019-03-19T22:17:58Z","html_url":"https://github.com/ethereum/snake-charmers-tactical-manual/pull/40#discussion_r267120462","pull_request_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/40","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/comments/267120462"},"html":{"href":"https://github.com/ethereum/snake-charmers-tactical-manual/pull/40#discussion_r267120462"},"pull_request":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/40"}},"in_reply_to_id":266929802},"pull_request":{"url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/40","id":262307307,"node_id":"MDExOlB1bGxSZXF1ZXN0MjYyMzA3MzA3","html_url":"https://github.com/ethereum/snake-charmers-tactical-manual/pull/40","diff_url":"https://github.com/ethereum/snake-charmers-tactical-manual/pull/40.diff","patch_url":"https://github.com/ethereum/snake-charmers-tactical-manual/pull/40.patch","issue_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/issues/40","number":40,"state":"open","locked":false,"title":"Add section on test suite structure","user":{"login":"davesque","id":791437,"node_id":"MDQ6VXNlcjc5MTQzNw==","avatar_url":"https://avatars2.githubusercontent.com/u/791437?v=4","gravatar_id":"","url":"https://api.github.com/users/davesque","html_url":"https://github.com/davesque","followers_url":"https://api.github.com/users/davesque/followers","following_url":"https://api.github.com/users/davesque/following{/other_user}","gists_url":"https://api.github.com/users/davesque/gists{/gist_id}","starred_url":"https://api.github.com/users/davesque/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davesque/subscriptions","organizations_url":"https://api.github.com/users/davesque/orgs","repos_url":"https://api.github.com/users/davesque/repos","events_url":"https://api.github.com/users/davesque/events{/privacy}","received_events_url":"https://api.github.com/users/davesque/received_events","type":"User","site_admin":false},"body":"As per a discussion on discord, this PR adds a section on suggested test suite structure.  Also fixes a couple of other random things.","created_at":"2019-03-19T04:30:48Z","updated_at":"2019-03-19T22:17:58Z","closed_at":null,"merged_at":null,"merge_commit_sha":"d364029337199d9e081deff5e695e031d8335896","assignee":null,"assignees":[],"requested_reviewers":[{"login":"carver","id":205327,"node_id":"MDQ6VXNlcjIwNTMyNw==","avatar_url":"https://avatars0.githubusercontent.com/u/205327?v=4","gravatar_id":"","url":"https://api.github.com/users/carver","html_url":"https://github.com/carver","followers_url":"https://api.github.com/users/carver/followers","following_url":"https://api.github.com/users/carver/following{/other_user}","gists_url":"https://api.github.com/users/carver/gists{/gist_id}","starred_url":"https://api.github.com/users/carver/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/carver/subscriptions","organizations_url":"https://api.github.com/users/carver/orgs","repos_url":"https://api.github.com/users/carver/repos","events_url":"https://api.github.com/users/carver/events{/privacy}","received_events_url":"https://api.github.com/users/carver/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/40/commits","review_comments_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/40/comments","review_comment_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/issues/40/comments","statuses_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/statuses/4cf74fe124d2770d9e327d38fbc5c7c68e67b725","head":{"label":"davesque:test-suite-structure","ref":"test-suite-structure","sha":"4cf74fe124d2770d9e327d38fbc5c7c68e67b725","user":{"login":"davesque","id":791437,"node_id":"MDQ6VXNlcjc5MTQzNw==","avatar_url":"https://avatars2.githubusercontent.com/u/791437?v=4","gravatar_id":"","url":"https://api.github.com/users/davesque","html_url":"https://github.com/davesque","followers_url":"https://api.github.com/users/davesque/followers","following_url":"https://api.github.com/users/davesque/following{/other_user}","gists_url":"https://api.github.com/users/davesque/gists{/gist_id}","starred_url":"https://api.github.com/users/davesque/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davesque/subscriptions","organizations_url":"https://api.github.com/users/davesque/orgs","repos_url":"https://api.github.com/users/davesque/repos","events_url":"https://api.github.com/users/davesque/events{/privacy}","received_events_url":"https://api.github.com/users/davesque/received_events","type":"User","site_admin":false},"repo":{"id":167060965,"node_id":"MDEwOlJlcG9zaXRvcnkxNjcwNjA5NjU=","name":"snake-charmers-tactical-manual","full_name":"davesque/snake-charmers-tactical-manual","private":false,"owner":{"login":"davesque","id":791437,"node_id":"MDQ6VXNlcjc5MTQzNw==","avatar_url":"https://avatars2.githubusercontent.com/u/791437?v=4","gravatar_id":"","url":"https://api.github.com/users/davesque","html_url":"https://github.com/davesque","followers_url":"https://api.github.com/users/davesque/followers","following_url":"https://api.github.com/users/davesque/following{/other_user}","gists_url":"https://api.github.com/users/davesque/gists{/gist_id}","starred_url":"https://api.github.com/users/davesque/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davesque/subscriptions","organizations_url":"https://api.github.com/users/davesque/orgs","repos_url":"https://api.github.com/users/davesque/repos","events_url":"https://api.github.com/users/davesque/events{/privacy}","received_events_url":"https://api.github.com/users/davesque/received_events","type":"User","site_admin":false},"html_url":"https://github.com/davesque/snake-charmers-tactical-manual","description":"Development *stuff* for the Snake Charmers EF team","fork":true,"url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual","forks_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/forks","keys_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/keys{/key_id}","collaborators_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/teams","hooks_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/hooks","issue_events_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/issues/events{/number}","events_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/events","assignees_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/assignees{/user}","branches_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/branches{/branch}","tags_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/tags","blobs_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/git/refs{/sha}","trees_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/git/trees{/sha}","statuses_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/statuses/{sha}","languages_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/languages","stargazers_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/stargazers","contributors_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/contributors","subscribers_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/subscribers","subscription_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/subscription","commits_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/commits{/sha}","git_commits_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/git/commits{/sha}","comments_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/comments{/number}","issue_comment_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/issues/comments{/number}","contents_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/contents/{+path}","compare_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/compare/{base}...{head}","merges_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/merges","archive_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/downloads","issues_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/issues{/number}","pulls_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/pulls{/number}","milestones_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/milestones{/number}","notifications_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/labels{/name}","releases_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/releases{/id}","deployments_url":"https://api.github.com/repos/davesque/snake-charmers-tactical-manual/deployments","created_at":"2019-01-22T20:18:01Z","updated_at":"2019-03-19T00:54:11Z","pushed_at":"2019-03-19T04:52:40Z","git_url":"git://github.com/davesque/snake-charmers-tactical-manual.git","ssh_url":"git@github.com:davesque/snake-charmers-tactical-manual.git","clone_url":"https://github.com/davesque/snake-charmers-tactical-manual.git","svn_url":"https://github.com/davesque/snake-charmers-tactical-manual","homepage":"http://python.ethereum.org/","size":63,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":null,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"ethereum:master","ref":"master","sha":"1f9411c4fdd27cd263080fcd70617296a91d95d3","user":{"login":"ethereum","id":6250754,"node_id":"MDEyOk9yZ2FuaXphdGlvbjYyNTA3NTQ=","avatar_url":"https://avatars3.githubusercontent.com/u/6250754?v=4","gravatar_id":"","url":"https://api.github.com/users/ethereum","html_url":"https://github.com/ethereum","followers_url":"https://api.github.com/users/ethereum/followers","following_url":"https://api.github.com/users/ethereum/following{/other_user}","gists_url":"https://api.github.com/users/ethereum/gists{/gist_id}","starred_url":"https://api.github.com/users/ethereum/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ethereum/subscriptions","organizations_url":"https://api.github.com/users/ethereum/orgs","repos_url":"https://api.github.com/users/ethereum/repos","events_url":"https://api.github.com/users/ethereum/events{/privacy}","received_events_url":"https://api.github.com/users/ethereum/received_events","type":"Organization","site_admin":false},"repo":{"id":103953670,"node_id":"MDEwOlJlcG9zaXRvcnkxMDM5NTM2NzA=","name":"snake-charmers-tactical-manual","full_name":"ethereum/snake-charmers-tactical-manual","private":false,"owner":{"login":"ethereum","id":6250754,"node_id":"MDEyOk9yZ2FuaXphdGlvbjYyNTA3NTQ=","avatar_url":"https://avatars3.githubusercontent.com/u/6250754?v=4","gravatar_id":"","url":"https://api.github.com/users/ethereum","html_url":"https://github.com/ethereum","followers_url":"https://api.github.com/users/ethereum/followers","following_url":"https://api.github.com/users/ethereum/following{/other_user}","gists_url":"https://api.github.com/users/ethereum/gists{/gist_id}","starred_url":"https://api.github.com/users/ethereum/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ethereum/subscriptions","organizations_url":"https://api.github.com/users/ethereum/orgs","repos_url":"https://api.github.com/users/ethereum/repos","events_url":"https://api.github.com/users/ethereum/events{/privacy}","received_events_url":"https://api.github.com/users/ethereum/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/ethereum/snake-charmers-tactical-manual","description":"Development *stuff* for the Snake Charmers EF team","fork":false,"url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual","forks_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/forks","keys_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/teams","hooks_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/hooks","issue_events_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/issues/events{/number}","events_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/events","assignees_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/assignees{/user}","branches_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/branches{/branch}","tags_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/tags","blobs_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/git/refs{/sha}","trees_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/statuses/{sha}","languages_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/languages","stargazers_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/stargazers","contributors_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/contributors","subscribers_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/subscribers","subscription_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/subscription","commits_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/commits{/sha}","git_commits_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/git/commits{/sha}","comments_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/comments{/number}","issue_comment_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/issues/comments{/number}","contents_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/contents/{+path}","compare_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/merges","archive_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/downloads","issues_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/issues{/number}","pulls_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls{/number}","milestones_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/milestones{/number}","notifications_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/labels{/name}","releases_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/releases{/id}","deployments_url":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/deployments","created_at":"2017-09-18T15:00:44Z","updated_at":"2019-03-18T10:31:59Z","pushed_at":"2019-03-19T04:52:41Z","git_url":"git://github.com/ethereum/snake-charmers-tactical-manual.git","ssh_url":"git@github.com:ethereum/snake-charmers-tactical-manual.git","clone_url":"https://github.com/ethereum/snake-charmers-tactical-manual.git","svn_url":"https://github.com/ethereum/snake-charmers-tactical-manual","homepage":"http://python.ethereum.org/","size":68,"stargazers_count":34,"watchers_count":34,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":13,"mirror_url":null,"archived":false,"open_issues_count":17,"license":null,"forks":13,"open_issues":17,"watchers":34,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/40"},"html":{"href":"https://github.com/ethereum/snake-charmers-tactical-manual/pull/40"},"issue":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/issues/40"},"comments":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/issues/40/comments"},"review_comments":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/40/comments"},"review_comment":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/pulls/40/commits"},"statuses":{"href":"https://api.github.com/repos/ethereum/snake-charmers-tactical-manual/statuses/4cf74fe124d2770d9e327d38fbc5c7c68e67b725"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"davesque"}}