feat: adds README, samples and integration tests for downscoping with CAB #1311

xil222 · 2021-10-30T00:32:43Z

This PR does the followings for downscoping with CAB.

Add samples and descriptions.
Add a setup script and integration tests.

generated-files-bot · 2021-10-30T00:32:46Z

Warning: This pull request is touching the following templated files:

README.md - README.md is managed by synthtool. However, a partials file can be used to update the README, e.g.: https://github.com/googleapis/nodejs-storage/blob/main/.readme-partials.yaml
samples/README.md - samples/README.md is managed by synthtool. However, a partials file can be used to update the README, e.g.: https://github.com/googleapis/nodejs-storage/blob/main/.readme-partials.yaml

xil222 · 2021-11-02T00:09:47Z

Hi @bcoe , could you get back to me when you are back?
Looks like the serviceAccount for integration test doesn't have certain access causing the failure.
Error: kokoro-system-test@long-door-651.iam.gserviceaccount.com does not have storage.objects.get access to the Google Cloud Storage object.
it seems that the serviceAccount key is downloaded from gfile at here which I can't modify access by myself.
Is there any ways to do that? Thanks

lsirac

Just did a quick first pass. Can you also take a look at the lint warnings on the downscoped files?

samples/test/downscoping-with-cab.test.js

samples/downscopedclient.js

README.md

samples/test/downscoping-with-cab.test.js

…le-auth-library-nodejs into xinxinxin-cabsamples

bcoe

Just one nit about tests, also question about API, mainly how does this compare to other implementations? Should we be planning work to give Node.js a more ergonomic API for extending the auth library.

README.md

bcoe · 2021-11-08T15:50:47Z

README.md

+  projectId: 'my_project_id',
+  authClient: {
+    sign: () => Promise.reject('unsupported'),
+    getCredentials: () => Promise.reject(),


The approach you came up with here ends up not looking quite as ugly as I was fearing.

How does this compare to Python and other languages? Is there work we should be tracking to make this API easier?

In Python and Java directly passing authClient as variable to create Storage object without need to redefine a couple of APIs such as sign() or getCredentials().
And, yes, the long-term work is referred in last PR
GoogleCloudPlatform/nodejs-docs-samples#2368 (comment)
and you can track in bug b/196442993

samples/test/downscoping-with-cab.test.js

samples/downscopedclient.js

xil222 · 2021-11-19T18:07:50Z

@xil222 samples are looking reasonable, but integration tests appear to be flaky, or perhaps just an assertion isn't quite right.

just made it correct

bojeil-google

Overall this looks fine. However, this deviates from existing samples/integration tests.
The pattern is to have a sample file with output under this directory: https://github.com/googleapis/google-auth-library-nodejs/tree/main/samples

Example: https://github.com/googleapis/google-auth-library-nodejs/blob/main/samples/signBlob.js

Then you would write the test asserting the output of the sample (via child_process.exec) in here:
https://github.com/googleapis/google-auth-library-nodejs/tree/main/samples/test

samples/test/downscoping-with-cab.test.js

bojeil-google · 2021-12-15T19:05:53Z

You could try to pass the bucket and object name via environment variable. Similar to here:

google-auth-library-nodejs/samples/test/externalclient.test.js

Line 281 in e91472a

GOOGLE_APPLICATION_CREDENTIALS: configFilePath,

🤖 I have created a release \*beep\* \*boop\* --- ## [7.11.0](https://www.github.com/googleapis/google-auth-library-nodejs/compare/v7.10.4...v7.11.0) (2021-12-15) ### Features * adds README, samples and integration tests for downscoping with CAB ([#1311](https://www.github.com/googleapis/google-auth-library-nodejs/issues/1311)) ([4549116](https://www.github.com/googleapis/google-auth-library-nodejs/commit/454911637eca6a1272a729b2b2dfcf690c53fe29)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Add description, samples and integration tests for CAB

bb89f2b

xil222 requested review from a team as code owners October 30, 2021 00:32

product-auto-label bot added the samples Issues that are directly related to samples. label Oct 30, 2021

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 30, 2021

xil222 added 2 commits October 29, 2021 17:33

fix lints

ff0560c

fix copyright format and import

2dabb8d

xil222 requested review from lsirac, bojeil-google and bcoe October 30, 2021 00:40

xil222 added 3 commits October 29, 2021 17:40

Merge branch 'main' into xinxinxin-cabsamples

406a329

add storage dependency

b025c24

try on header fix

2051d0f

Merge branch 'main' into xinxinxin-cabsamples

901472d

lsirac reviewed Nov 4, 2021

View reviewed changes

lsirac changed the title ~~feat: Add description, samples and integration tests for downscoping with CAB.~~ feat: adds README, samples and integration tests for downscoping with CAB Nov 4, 2021

xil222 added 2 commits November 4, 2021 16:52

fix some comments

6410b28

Merge branch 'xinxinxin-cabsamples' of https://github.com/xil222/goog…

e4034ab

…le-auth-library-nodejs into xinxinxin-cabsamples

xil222 requested a review from lsirac November 4, 2021 23:53

bcoe suggested changes Nov 8, 2021

View reviewed changes

xil222 added 3 commits November 8, 2021 10:18

Merge branch 'main' into xinxinxin-cabsamples

041615b

update readme

1941ba5

Merge branch 'main' into xinxinxin-cabsamples

9724ac2

lsirac reviewed Nov 9, 2021

View reviewed changes

samples/downscopedclient.js Outdated Show resolved Hide resolved

lsirac approved these changes Nov 9, 2021

View reviewed changes

bcoe added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 11, 2021

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 11, 2021

xil222 requested a review from bcoe November 12, 2021 17:44

xil222 added the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 18, 2021

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 18, 2021

bcoe approved these changes Nov 19, 2021

View reviewed changes

bcoe added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 19, 2021

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 19, 2021

bojeil-google suggested changes Nov 30, 2021

View reviewed changes

xil222 added 2 commits December 13, 2021 14:40

Merge branch 'main' into xinxinxin-cabsamples

cfcc49c

tweak child exec process

02cf854

xil222 added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Dec 15, 2021

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 15, 2021

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 15, 2021

fix lint

087ccd0

xil222 added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Dec 15, 2021

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 15, 2021

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 15, 2021

xil222 requested a review from bojeil-google December 15, 2021 18:08

bojeil-google suggested changes Dec 15, 2021

View reviewed changes

samples/test/downscoping-with-cab.test.js Outdated Show resolved Hide resolved

samples/test/downscoping-with-cab.test.js Outdated Show resolved Hide resolved

set bucket name and object name environment variable

b7d91a7

xil222 added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Dec 15, 2021

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 15, 2021

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Dec 15, 2021

xil222 requested a review from bojeil-google December 15, 2021 19:53

bojeil-google approved these changes Dec 15, 2021

View reviewed changes

xil222 merged commit 4549116 into googleapis:main Dec 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adds README, samples and integration tests for downscoping with CAB #1311

feat: adds README, samples and integration tests for downscoping with CAB #1311

xil222 commented Oct 30, 2021

generated-files-bot bot commented Oct 30, 2021

xil222 commented Nov 2, 2021

lsirac left a comment

bcoe left a comment

bcoe Nov 8, 2021

xil222 Nov 8, 2021

xil222 commented Nov 19, 2021

bojeil-google left a comment

bojeil-google commented Dec 15, 2021

feat: adds README, samples and integration tests for downscoping with CAB #1311

feat: adds README, samples and integration tests for downscoping with CAB #1311

Conversation

xil222 commented Oct 30, 2021

generated-files-bot bot commented Oct 30, 2021

xil222 commented Nov 2, 2021

lsirac left a comment

Choose a reason for hiding this comment

bcoe left a comment

Choose a reason for hiding this comment

bcoe Nov 8, 2021

Choose a reason for hiding this comment

xil222 Nov 8, 2021

Choose a reason for hiding this comment

xil222 commented Nov 19, 2021

bojeil-google left a comment

Choose a reason for hiding this comment

bojeil-google commented Dec 15, 2021