From 3eb8db569b512101fc6935db1baa11b5334ac3da Mon Sep 17 00:00:00 2001 From: Angel Caamal Date: Thu, 19 Mar 2026 00:15:33 +0000 Subject: [PATCH] feat(storage): introduce storage client endpoint sample and test for migration --- storage/package.json | 30 +++++++++++ storage/resources/.gitignore | 1 + storage/resources/resourcesSub1/testSub1.txt | 2 + storage/resources/test.txt | 1 + storage/resources/test2.txt | 1 + storage/scripts/cleanup | 44 +++++++++++++++ storage/setClientEndpoint.js | 53 +++++++++++++++++++ storage/system-test/storage.test.js | 30 +++++++++++ ...t_9d800329-00da-4cdd-9a3e-7ac6743d5813.txt | 0 9 files changed, 162 insertions(+) create mode 100644 storage/package.json create mode 100644 storage/resources/.gitignore create mode 100644 storage/resources/resourcesSub1/testSub1.txt create mode 100644 storage/resources/test.txt create mode 100644 storage/resources/test2.txt create mode 100644 storage/scripts/cleanup create mode 100644 storage/setClientEndpoint.js create mode 100644 storage/system-test/storage.test.js create mode 100644 storage/system-test/test_9d800329-00da-4cdd-9a3e-7ac6743d5813.txt diff --git a/storage/package.json b/storage/package.json new file mode 100644 index 0000000000..71acc18ab5 --- /dev/null +++ b/storage/package.json @@ -0,0 +1,30 @@ +{ + "name": "@google-cloud/storage-samples", + "description": "Samples for the Cloud Storage Client Library for Node.js.", + "license": "Apache-2.0", + "author": "Google Inc.", + "engines": { + "node": ">=12" + }, + "repository": "googleapis/nodejs-storage", + "private": true, + "files": [ + "*.js" + ], + "scripts": { + "cleanup": "node scripts/cleanup", + "test": "mocha system-test/*.js --timeout 800000" + }, + "dependencies": { + "@google-cloud/pubsub": "^4.0.0", + "@google-cloud/storage": "^7.19.0", + "node-fetch": "^2.6.7", + "uuid": "^8.0.0", + "yargs": "^16.0.0" + }, + "devDependencies": { + "chai": "^4.2.0", + "mocha": "^8.0.0", + "p-limit": "^3.1.0" + } +} diff --git a/storage/resources/.gitignore b/storage/resources/.gitignore new file mode 100644 index 0000000000..6738013702 --- /dev/null +++ b/storage/resources/.gitignore @@ -0,0 +1 @@ +downloaded.txt diff --git a/storage/resources/resourcesSub1/testSub1.txt b/storage/resources/resourcesSub1/testSub1.txt new file mode 100644 index 0000000000..51f4b307d5 --- /dev/null +++ b/storage/resources/resourcesSub1/testSub1.txt @@ -0,0 +1,2 @@ +Sub1 +Hello World! \ No newline at end of file diff --git a/storage/resources/test.txt b/storage/resources/test.txt new file mode 100644 index 0000000000..c57eff55eb --- /dev/null +++ b/storage/resources/test.txt @@ -0,0 +1 @@ +Hello World! \ No newline at end of file diff --git a/storage/resources/test2.txt b/storage/resources/test2.txt new file mode 100644 index 0000000000..010302410b --- /dev/null +++ b/storage/resources/test2.txt @@ -0,0 +1 @@ +Hello World 2! \ No newline at end of file diff --git a/storage/scripts/cleanup b/storage/scripts/cleanup new file mode 100644 index 0000000000..61bd73114f --- /dev/null +++ b/storage/scripts/cleanup @@ -0,0 +1,44 @@ +#!/usr/bin/env node + +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +const {Storage} = require('@google-cloud/storage'); +const storage = new Storage(); +const NAME_REG_EXP = /^nodejs-storage-samples-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$/; + +storage + .getBuckets() + .then(([buckets]) => { + let promise = Promise.resolve(); + + buckets + .filter((bucket) => NAME_REG_EXP.test(bucket.name)) + .forEach((bucket) => { + promise = promise.then(() => { + return bucket.deleteFiles() + .then(() => bucket.deleteFiles(), console.error) + .then(() => { + console.log(`Deleting ${bucket.name}`); + return bucket.delete(); + }, console.error) + .catch(console.error); + }); + }); + }) + .catch((err) => { + console.error('ERROR:', err); + }); diff --git a/storage/setClientEndpoint.js b/storage/setClientEndpoint.js new file mode 100644 index 0000000000..6d5ed079bf --- /dev/null +++ b/storage/setClientEndpoint.js @@ -0,0 +1,53 @@ +// Copyright 2022 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +/** + * This application demonstrates set a custom endpoint with + * the Google Cloud Storage API. + * + * For more information, see the README.md under /storage and the documentation + * at https://cloud.google.com/storage/docs. + */ + +function main(apiEndpoint = 'https://storage.googleapis.com') { + // [START storage_set_client_endpoint] + /** + * TODO(developer): Uncomment the following lines before running the sample. + */ + // The custom endpoint to which requests should be made + // const apiEndpoint = 'https://yourcustomendpoint.com'; + + // Imports the Google Cloud client library + const {Storage} = require('@google-cloud/storage'); + try { + // Creates a client + const storage = new Storage({ + apiEndpoint: apiEndpoint, + useAuthWithCustomEndpoint: true, + }); + + console.log(`Client initiated with endpoint: ${storage.apiEndpoint}.`); + } catch (error) { + console.error( + 'Error executing set client endpoint:', + error.message || error + ); + } + + // [END storage_set_client_endpoint] +} + +main(...process.argv.slice(2)); diff --git a/storage/system-test/storage.test.js b/storage/system-test/storage.test.js new file mode 100644 index 0000000000..9aacf774be --- /dev/null +++ b/storage/system-test/storage.test.js @@ -0,0 +1,30 @@ +// Copyright 2022 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +'use strict'; + +const {assert} = require('chai'); +const {it} = require('mocha'); +const cp = require('child_process'); + +const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'}); + +it('should intialize storage with a custom api endpoint', async () => { + const apiEndpoint = 'https://storage.googleapis.com'; + const output = execSync(`node setClientEndpoint.js ${apiEndpoint}`); + assert.match( + output, + new RegExp(`Client initiated with endpoint: ${apiEndpoint}.`) + ); +}); diff --git a/storage/system-test/test_9d800329-00da-4cdd-9a3e-7ac6743d5813.txt b/storage/system-test/test_9d800329-00da-4cdd-9a3e-7ac6743d5813.txt new file mode 100644 index 0000000000..e69de29bb2