Refactor auth code to ease transition to google-auth by theacodes · Pull Request #135 · googleapis/gax-python

theacodes · 2016-11-01T18:30:13Z

note This changes several public API methods.

theacodes · 2016-11-01T18:30:23Z

codecov-io · 2016-11-01T19:44:13Z

Current coverage is 98.21% (diff: 100%)

Merging #135 into master will increase coverage by 0.16%

@@             master       #135   diff @@
==========================================
  Files             8          8          
  Lines           616        616          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
+ Hits            604        605     +1   
+ Misses           12         11     -1   
  Partials          0          0

Powered by Codecov. Last update 0750185...7dfd9bd

geigerj

Thanks for doing this! I like how nicely create_stub cleaned up.

geigerj · 2016-11-02T20:33:05Z

google/gax/grpc.py

+            ignored.
+        service_path: The domain name of the API remote host.
+        service_port: The port on which to connect to the remote host.
+        credentials: The credentials for this request.


Could you clarify the difference between credentials and ssl_credentials in the docstring?

geigerj · 2016-11-02T20:43:46Z

google/gax/auth.py


 from __future__ import absolute_import

+import grpc


There is a design restriction on gax not to import grpc in any module except google.gax.grpc. (The intention is that when we support alternative transports, we should only need to switch out a single module.) Let's move secure_authorized_channel to grpc for this reason. gax should also not expose any methods that are grpc-specific in its public interface, so let's make secure_authorized_channel "private".

So this is here because eventually I'll defer most of this to google-auth - (see this PR - you'll notice a similar secure_authorized_channel function).

I can move this into grpc, but at that point I might as well just delete the auth file altogether - it will provide no discernible value. Which would you like?

Actually - I think I'm going to shove this into _grpc_oauth2client.py, so that I can add _grpc_google_auth.py with the same interface.

That makes sense. Let's just get rid of the auth module altogether. If I recall correctly, we only created it to begin with because oauth2client didn't provide the generic auth function; since google-auth is going to do that, we shouldn't expose the functionality on the gax surface.

Sorry, posted that comment before I saw yours. Moving it to a private module SGTM.

geigerj · 2016-11-02T20:45:39Z

test/test_grpc.py

-            _fake_create_stub, self.FAKE_SERVICE_PATH, self.FAKE_PORT,
-            metadata_transformer=lambda x: tuple())
-        self.assertFalse(auth.called)
+        self.assertFalse(secure_authorized_channel.called)


You should pass these variables as parameters to grpc.create_stub; otherwise this doesn't actually test anything.

I'm not sure what you mean here?

(see above)

Still not sure what you mean here.

Sorry, I misread this. Disregard this comment.

geigerj · 2016-11-02T20:46:46Z

test/test_grpc.py

+            _fake_create_stub, service_path=self.FAKE_SERVICE_PATH,
+            service_port=self.FAKE_PORT, credentials=credentials)
+
+        self.assertFalse(get_default_credentials.called)


get_default_credentials is an unused variable, so a meaningless assertion?

This ensures that default credentials are not used when explicit credentials are specified.

You haven't executed any code that references get_default_credentials at the point that you make the assertion that it hasn't been called; it's clear from the syntax alone that it hasn't been called. This is only meaningful if you pass it somehow to grpc.create_stub as a parameter.

create_stub has a branch that calls get_default_credentials, this assert ensures that branch was not executed.

Sorry, I misread this. Disregard this comment.

:) I thought I had caught the dumb for second. :D

geigerj · 2016-11-02T21:58:00Z

google/gax/grpc.py

+
 from grpc import RpcError, StatusCode
-from . import auth
+from . import _grpc_oauth2client


think this file accidentally got left out of the commit

Yeah, fixed. I also did away with the use of closures and went with @dhermes' suggestion of using a class like we do in google-auth.

…closures.

geigerj · 2016-11-02T22:08:43Z

google/gax/_grpc_oauth2client.py

@@ -0,0 +1,94 @@
+# Copyright 2015, Google Inc.


Cool. So this file goes away entirely once googleapis/google-auth-library-python#67 is merged, right?

It'll stay around until we formally deprecate oauth2client. I'll also be adding another module named _grpc_google_auth.py that'll be a very small interface to google.auth.

geigerj

Please update docs/index.rst -- that should fix the Travis failure. Otherwise LGTM

theacodes · 2016-11-02T22:12:54Z

Please update docs/index.rst

Done.

theacodes · 2016-11-02T22:15:51Z

Travis is green. ✨

theacodes · 2016-11-02T22:16:54Z

Thanks @geigerj! Can I get your review over at googleapis/google-auth-library-python#67? Once we merge that I can send another PR for _grpc_google_auth.py.

geigerj · 2016-11-02T22:19:11Z

Will do!

Refactor auth code to ease transition to google-auth

3aa8668

Jon Wayne Parrott added 2 commits November 1, 2016 12:33

Remove unused import

150b2b8

Add needed pylint disables

2976ffd

theacodes mentioned this pull request Nov 2, 2016

Gax pubsub ignores custom service account credentials and fetchs ADC instead googleapis/google-cloud-python#2631

Closed

geigerj suggested changes Nov 2, 2016

View reviewed changes

Jon Wayne Parrott added 2 commits November 2, 2016 14:44

Clarify docstring

7dfd9bd

Move auth to _grpc_oauth2client

c40a313

geigerj reviewed Nov 2, 2016

View reviewed changes

Move auth to _grpc_oauth2client, use MetadataPlugin class instead of …

9840751

…closures.

geigerj reviewed Nov 2, 2016

View reviewed changes

Update docs/index.rst

ed3ddd6

geigerj approved these changes Nov 2, 2016

View reviewed changes

geigerj merged commit 8c5fd0d into googleapis:master Nov 2, 2016

theacodes deleted the auth-refactor branch November 2, 2016 22:17

This was referenced Nov 17, 2016

Roll new release with preference for new google-auth library. #140

Merged

Update codegen to correspond to GAX auth changes googleapis/gapic-generator#756

Merged

Conversation

theacodes commented Nov 1, 2016

Uh oh!

theacodes commented Nov 1, 2016

Uh oh!

codecov-io commented Nov 1, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Current coverage is 98.21% (diff: 100%)

Uh oh!

geigerj 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

geigerj Nov 2, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

geigerj left a comment

Choose a reason for hiding this comment

Uh oh!

theacodes commented Nov 2, 2016

Uh oh!

theacodes commented Nov 2, 2016

Uh oh!

theacodes commented Nov 2, 2016

Uh oh!

geigerj commented Nov 2, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov-io commented Nov 1, 2016 •

edited

Loading

geigerj Nov 2, 2016 •

edited

Loading