Removes global test client and calls setup for each client test #766

chriskingnet · 2017-10-27T23:09:23Z

This is my attempt at removing the global client, as outlined in #762.

As I am a new contributor to this lib, I thought this might be a good issue to have a go at as suggested - as you get to see quite a lot of the test code. Also put my find and replace skills to the test! :D

This seemed to work, all the test keep running and it was achieved I think pretty much exactly as outlined in the issue.

dmitshur · 2017-10-28T02:34:23Z

This is a great start @chriskingnet, thanks! But see #762 (comment).

chriskingnet · 2017-10-28T21:22:07Z

Have made a few changes, based on the discussion from #762, and now also removed the mux and server objects from being package global.

dmitshur · 2017-10-31T05:40:03Z

CONTRIBUTING.md

@@ -25,7 +25,7 @@ again.
     issue that you are planning to work on that bug or feature so that it can
     be assigned to you.

-  1. Follow the normal process of [forking][] the project, and setup a new
+  1. Follow the normal process of [forking][] the project, and setup() a new


This change looks unintentional.

Thanks for spotting, I have fixed this now.

dmitshur · 2017-10-31T05:42:52Z

On the the one hand, I think it'd be nice if this PR actually made use of the fact that tests are independent and made them run in parallel. That is the reason to be making these changes; if we don't make tests parallel, these changes have no positive effect. Also, making the tests run in parallel may uncover unexpected issues, ones that might result in us deciding to abort this change. It'd better to find that out sooner rather than later.

On the other hand, we should merge this PR sooner, because it'll keep getting merge conflicts when other PRs get merged.

What do you think we should aim for, @gmlewis and @chriskingnet?

dmitshur · 2017-10-31T05:55:07Z

Ok, I see the original motivation for doing this in #732 (comment)...

So even if making tests in parallel won't work, it's still worth to make the tests not share globals. In that case, I'm okay with this PR not making tests run in parallel, that can be a separate PR.

chriskingnet · 2017-10-31T11:29:56Z

Thanks for the comments, @shurcooL. I agree with the two step approach here - first remove the dependencies on the global variables, and then do the work to parallelise the tests.

I am not sure what is going on here, though, I have tried to merge and resolve the conflicts, but it is still reporting them. I must be doing something wrong.

gmlewis

This is looking good, @chriskingnet! Thank you for doing this.
Just a few things requested in order to better document the new-and-improved setup function and its return values, please.

gmlewis · 2017-10-31T16:12:47Z

github/github_test.go

@@ -42,9 +31,9 @@ const (
 // setup sets up a test HTTP server along with a github.Client that is
 // configured to talk to that test server. Tests should register handlers on
 // mux which provide mock responses for the API method being tested.


I would like to capture the removed comments from lines 26, 29, 32, and 73 into the description of setup so that it is clear what the purpose of the return values are.

Thanks for spotting, @gmlewis. Have re-inserted in the new places they are built :)

gmlewis · 2017-10-31T16:13:50Z

CONTRIBUTING.md

@@ -25,7 +25,7 @@ again.
     issue that you are planning to work on that bug or feature so that it can
     be assigned to you.

-  1. Follow the normal process of [forking][] the project, and setup a new
+  1. Follow the normal process of [forking][] the project, and a new


Maybe revert all changes to CONTRIBUTING.md ?

…t-client

chriskingnet · 2017-11-16T20:58:10Z

Sorry for the delay on this. I have now merged master, fixed the newly added tests and reverted all comments that were caught in the find-replace.

gmlewis · 2017-11-16T21:45:07Z

github/github_test.go

-func setup() {
-	// test server
-	mux = http.NewServeMux()
+func setup() (string, *http.ServeMux, *Client, func()) {


Thanks, @chriskingnet! I was actually thinking about putting the comments into the setup func comments immediately following line 44, but that's OK. As an alternative, I propose the following...

@shurcooL - for documentation purposes, what do you think about using named return values here?
I personally think it would make the code (and godocs) easier to understand:

func setup() (url string, mux *http.ServeMux, client *Client, teardown func()) {

Agreed, named returned values would help readability. Seeing string and func() doesn't say much.

Thanks for the input on this, @shurcooL. Have now included this :)

chriskingnet · 2017-11-18T08:58:59Z

Have named return values. Good idea, thanks @gmlewis!

dmitshur · 2017-11-22T21:40:52Z

github/repos_contents_test.go

@@ -91,14 +91,14 @@ func TestRepositoriesService_GetReadme(t *testing.T) {
 }

 func TestRepositoriesService_DownloadContents_Success(t *testing.T) {
-	setup()
+	serverBaseURL, mux, client, teardown := setup()


Minor, but I'd rename serverBaseURL to just serverURL for consistency with the return variable name in setup. At least I don't see a good reason to give it a different, more verbose name.

dmitshur · 2017-11-22T21:43:24Z

github/github_test.go


-	// github client configured to use test server
+	// client is the GitHub client being tested and is
+	// configured to use test server


Minor, missing period at end of sentence.

dmitshur · 2017-11-22T21:44:01Z

github/github_test.go

-
-	// server is a test HTTP server used to provide mock API responses.
-	server *httptest.Server
-)


dmitshur

I have one major change request (and 2 minor nits, see above), but everything else looks great.

You've addressed Glenn's earlier concerns, so I think I can merge this after you apply these changes.

Thanks again for taking this on @chriskingnet!

dmitshur · 2017-11-22T21:51:41Z

github/github_test.go

@@ -42,8 +31,8 @@ const (
 // setup sets up a test HTTP server along with a github.Client that is
 // configured to talk to that test server. Tests should register handlers on
 // mux which provide mock responses for the API method being tested.
-func setup() {
-	// test server
+func setup() (serverURL string, mux *http.ServeMux, client *Client, teardown func()) {


I've looked over the PR, and noticed that the vast majority of instances ignore serverURL. In fact, it's only used in 1 place.

client and teardown are the most often used parameters, used in all instances.

mux is used second most, missing in about 20-30% of them.

Since setup is going to be called in so many places and in all future tests, let's optimize their order based on frequency of use. I think the following order would be better (most often used parameters first, except teardown is always last):

func setup() (client *Client, mux *http.ServeMux, serverURL string, teardown func())

I just think that's going to look nicer than the _, mux, client, teardown := setup() lines that we get now.

Thanks for the feedback, @shurcooL. This is a very valid point, and something that is going to be used so often deserves this kind of depth of designing for sure.

I will make this change and also merge in any new tests again. Unfortunately I am unable to work on this until next week - but I will endeavour to get it done then.

…ove-global-test-client

chriskingnet · 2017-12-02T10:44:14Z

Hi @shurcooL, I have merged master and I think I have changed everything. Sorry it took a few days for me to get around from it. I'm pleased with how this looks now - this parameter ordering is much better. Let me know if there is anything else you spot :)

dmitshur

LGTM. This looks really nice. Thank you for doing this @chriskingnet and @gmlewis for the idea!

This refactor removes the global test variables used by all tests, replacing them with local variables that are independent in each test. This is better style, easier to read and be confident about correctness, and allows tests to be parallelized in the future. Resolves google#762.

removes global test client and calls setup for each client test

49066fd

googlebot added the cla: yes Indication that the PR author has signed a Google Contributor License Agreement. label Oct 27, 2017

removes mux and server from global package scope

f749b0e

fixes comments that got caught in the find replace crossfire

576bc4e

dmitshur reviewed Oct 31, 2017

View reviewed changes

chriskingnet added 3 commits October 31, 2017 12:21

merges changes from master

cb3b763

removes unintentional comment change

c20a30e

Merge branch 'master' into remove-global-test-client

53be863

gmlewis requested changes Oct 31, 2017

View reviewed changes

chriskingnet added 5 commits November 16, 2017 21:23

Merge remote-tracking branch 'upstream/master' into remove-global-tes…

c982a31

…t-client

removes global vars from merged tests

52b77f9

reverts all changes to contributing.md

0e33860

merges in changes to contributing.md from master

040a796

re-includes removed comments

eac6e9c

gmlewis reviewed Nov 16, 2017

View reviewed changes

names return values

6670f6a

dmitshur reviewed Nov 22, 2017

View reviewed changes

github/github_test.go

// server is a test HTTP server used to provide mock API responses.

server *httptest.Server

)

Copy link

Member

dmitshur Nov 22, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

dmitshur requested changes Nov 22, 2017

View reviewed changes

chriskingnet added 3 commits December 2, 2017 11:28

Merge branch 'master' of https://github.com/google/go-github into rem…

7437cdf

…ove-global-test-client

fixes test from merge

4663a34

alters return parameter ordering of setup func

bb0ce63

adds full stop to comment

a825cde

dmitshur approved these changes Dec 2, 2017

View reviewed changes

dmitshur merged commit df88dd9 into google:master Dec 2, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removes global test client and calls setup for each client test #766

Removes global test client and calls setup for each client test #766

chriskingnet commented Oct 27, 2017

dmitshur commented Oct 28, 2017

chriskingnet commented Oct 28, 2017

dmitshur Oct 31, 2017

chriskingnet Oct 31, 2017

dmitshur commented Oct 31, 2017 •

edited

Loading

dmitshur commented Oct 31, 2017

chriskingnet commented Oct 31, 2017

gmlewis left a comment

gmlewis Oct 31, 2017

chriskingnet Nov 16, 2017

gmlewis Oct 31, 2017

chriskingnet commented Nov 16, 2017

gmlewis Nov 16, 2017

dmitshur Nov 17, 2017

chriskingnet Nov 18, 2017

chriskingnet commented Nov 18, 2017

dmitshur Nov 22, 2017

dmitshur Nov 22, 2017

dmitshur Nov 22, 2017

dmitshur left a comment •

edited

Loading

dmitshur Nov 22, 2017 •

edited

Loading

chriskingnet Nov 22, 2017

chriskingnet commented Dec 2, 2017

dmitshur left a comment

Removes global test client and calls setup for each client test #766

Removes global test client and calls setup for each client test #766

Conversation

chriskingnet commented Oct 27, 2017

dmitshur commented Oct 28, 2017

chriskingnet commented Oct 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmitshur commented Oct 31, 2017 • edited Loading

dmitshur commented Oct 31, 2017

chriskingnet commented Oct 31, 2017

gmlewis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chriskingnet commented Nov 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chriskingnet commented Nov 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmitshur left a comment • edited Loading

Choose a reason for hiding this comment

dmitshur Nov 22, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chriskingnet commented Dec 2, 2017

dmitshur left a comment

Choose a reason for hiding this comment

dmitshur commented Oct 31, 2017 •

edited

Loading

dmitshur left a comment •

edited

Loading

dmitshur Nov 22, 2017 •

edited

Loading