Mock transport with pc frames by migueleliasweb · Pull Request #2008 · google/go-github

migueleliasweb · 2021-07-16T14:25:40Z

An attempt to address #1800

Uses runtime.Frames to get a the caller method in the SDK and use it to mock a response
Uses code generation to automagically generate all possible matches for all exported methods currently in the SDK

migueleliasweb · 2021-07-16T14:29:14Z

I've added the code generation to all methods now. Let me know your thoughts @gmlewis 👍 .

codecov · 2021-07-16T15:34:18Z

Codecov Report

Merging #2008 (257d492) into master (f47f8fe) will decrease coverage by 0.39%.
The diff coverage is 56.33%.

@@            Coverage Diff             @@
##           master    #2008      +/-   ##
==========================================
- Coverage   97.84%   97.44%   -0.40%     
==========================================
  Files         105      108       +3     
  Lines        6809     6968     +159     
==========================================
+ Hits         6662     6790     +128     
- Misses         80      110      +30     
- Partials       67       68       +1

Impacted Files	Coverage Δ
mock/client.go	`56.33% <56.33%> (ø)`
github/checks.go	`100.00% <0.00%> (ø)`
github/repos_commits.go	`100.00% <0.00%> (ø)`
github/actions_runners.go	`100.00% <0.00%> (ø)`
github/actions_runner_groups.go	`100.00% <0.00%> (ø)`
github/repos_hooks_deliveries.go	`93.10% <0.00%> (ø)`
github/orgs_hooks_deliveries.go	`100.00% <0.00%> (ø)`
github/github.go	`97.07% <0.00%> (+0.04%)`	⬆️
github/messages.go	`100.00% <0.00%> (+2.94%)`	⬆️

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 f47f8fe...257d492. Read the comment docs.

gmlewis

Thank you, @migueleliasweb . I'm liking this approach.
You will also want to add a new generator to this PR here:
https://github.com/google/go-github/blob/master/github/github.go#L6-L7

gmlewis · 2021-07-16T15:40:37Z

+
+func MustMarshal(v interface{}) []byte {
+	b, err := json.Marshal(v)
+


Please remove this blank line.

gmlewis · 2021-07-16T15:41:07Z

+	}
+}
+
+func NewMockHttpClient(options ...MockHttpClientOption) *http.Client {


Please add godoc comment.

Suggested change

func NewMockHttpClient(options ...MockHttpClientOption) *http.Client {

func NewMockHTTPClient(options ...MockHTTPClientOption) *http.Client {

gmlewis · 2021-07-16T15:41:14Z

+
+type MockHttpClientOption func(*MockRoundTripper)
+
+func WithRequestMatch(


Please add godoc comment.

gmlewis · 2021-07-16T15:41:24Z

+
+var _ http.RoundTripper = &MockRoundTripper{}
+
+type MockHttpClientOption func(*MockRoundTripper)


Please add godoc comment.

Suggested change

type MockHttpClientOption func(*MockRoundTripper)

type MockHTTPClientOption func(*MockRoundTripper)

gmlewis · 2021-07-16T15:41:41Z

+	RequestMocks map[RequestMatch][][]byte
+}
+
+// RoundTrip implements http.RoundTripper interface


Suggested change

// RoundTrip implements http.RoundTripper interface

// RoundTrip implements http.RoundTripper interface.

gmlewis · 2021-07-16T16:05:07Z

+
+				if receiverType, ok := fn.Recv.List[0].Type.(*ast.StarExpr); ok {
+					if receiverTypeIndent, ok := receiverType.X.(*ast.Ident); ok {
+						if receiverTypeIndent.Name != "" {


This line can then be deleted if you take my suggestions above.

gmlewis · 2021-07-16T16:06:10Z

+						if receiverTypeIndent.Name != "" {
+							varName := fmt.Sprintf(
+								"RequestMatch%s%s",
+								strings.Replace(


After the reduction in indentation above, this strings.Replace could all fit nicely on a single line.

gmlewis · 2021-07-16T16:06:55Z

+		return requestMatches[i].Value < requestMatches[j].Value
+	})
+
+	// fmt.Println("requestMatches:", requestMatches)


Please remove this debugging line.

gmlewis · 2021-07-16T16:08:25Z

+
+	// fmt.Println("requestMatches:", requestMatches)
+
+	buf := bytes.NewBufferString("")


Suggested change

buf := bytes.NewBufferString("")

var buf bytes.Buffer

gmlewis · 2021-07-16T16:08:35Z

+	buf := bytes.NewBufferString("")
+
+	template.Must(template.New("source").Parse(source)).Execute(
+		buf,


Suggested change

buf,

&buf,

gmlewis · 2021-07-16T19:28:00Z

After further consideration, I think that @willnorris is correct in his comment that this would be a great utility to place in an external helper repo.

So my recommendation is that we close this PR and also close #1800 and point to a new helper repo in this repo's README.md once it has been implemented.

migueleliasweb · 2021-07-17T05:47:31Z

Thanks @gmlewis for the extensive review!

I left a comment in the initial PR (#1980) so you and Will can talk more. I will wait until the decision is made to move this to a new repo or not before proceeding with the rest of the implementation.

migueleliasweb added 7 commits July 12, 2021 22:27

Add draft for mock http client for unittesting

a05ca1c

Use ioutil for NopCloser

6ed3ab7

Fix unittests for draft mock http client

804c61e

Fix typo on mock/client.go and mock/client_test.go

bb74f7b

Use program counter frames instead of regexp

bd3938d

Add gen request matches

500cb58

Minor fixes to mock pkg

257d492

google-cla Bot added the cla: yes Indication that the PR author has signed a Google Contributor License Agreement. label Jul 16, 2021

migueleliasweb mentioned this pull request Jul 16, 2021

Add draft for mock http client for unittesting #1980

Closed

gmlewis requested changes Jul 16, 2021

View reviewed changes

gmlewis added the DO NOT MERGE Do not merge this PR. label Jul 16, 2021

migueleliasweb closed this Jul 27, 2021


		func MustMarshal(v interface{}) []byte {
		b, err := json.Marshal(v)

	func NewMockHttpClient(options ...MockHttpClientOption) *http.Client {
	func NewMockHTTPClient(options ...MockHTTPClientOption) *http.Client {


		type MockHttpClientOption func(*MockRoundTripper)

		func WithRequestMatch(


		var _ http.RoundTripper = &MockRoundTripper{}

		type MockHttpClientOption func(*MockRoundTripper)

	// RoundTrip implements http.RoundTripper interface
	// RoundTrip implements http.RoundTripper interface.


		// fmt.Println("requestMatches:", requestMatches)

		buf := bytes.NewBufferString("")

Conversation

migueleliasweb commented Jul 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

migueleliasweb commented Jul 16, 2021

Uh oh!

codecov Bot commented Jul 16, 2021

Codecov Report

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gmlewis commented Jul 16, 2021

Uh oh!

migueleliasweb commented Jul 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

migueleliasweb commented Jul 16, 2021 •

edited

Loading