-
Notifications
You must be signed in to change notification settings - Fork 227
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
samples: add samples for AWS Kinesis ingestion (#1896)
* samples: add samples for AWS Kinesis ingestion * samples: add topic type update sample for kinesis ingestion * tests: add system tests for kinesis samples * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * tests:remove incorrect test for new sample * samples: simplify parameter names --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
d13d395
commit 9589e9f
Showing
7 changed files
with
435 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // Copyright 2024 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 | ||
| // | ||
| // https://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. | ||
|
|
||
| // This is a generated sample, using the typeless sample bot. Please | ||
| // look for the source TypeScript sample (.ts) for modifications. | ||
| 'use strict'; | ||
|
|
||
| /** | ||
| * This sample demonstrates how to perform basic operations on topics with | ||
| * the Google Cloud Pub/Sub API. | ||
| * | ||
| * For more information, see the README.md under /pubsub and the documentation | ||
| * at https://cloud.google.com/pubsub/docs. | ||
| */ | ||
|
|
||
| // sample-metadata: | ||
| // title: Create Topic With Kinesis Ingestion | ||
| // description: Creates a new topic, with Kinesis ingestion enabled. | ||
| // usage: node createTopicWithKinesisIngestion.js <topic-name> <role-arn> <gcp-service-account> <stream-arn> <consumer-arn> | ||
|
|
||
| // [START pubsub_create_topic_with_kinesis_ingestion] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID'; | ||
| // const roleArn = 'arn:aws:iam:...'; | ||
| // const gcpServiceAccount = 'ingestion-account@...'; | ||
| // const streamArn = 'arn:aws:kinesis:...'; | ||
| // const consumerArn = 'arn:aws:kinesis:...'; | ||
|
|
||
| // Imports the Google Cloud client library | ||
| const {PubSub} = require('@google-cloud/pubsub'); | ||
|
|
||
| // Creates a client; cache this for further use | ||
| const pubSubClient = new PubSub(); | ||
|
|
||
| async function createTopicWithKinesisIngestion( | ||
| topicNameOrId, | ||
| awsRoleArn, | ||
| gcpServiceAccount, | ||
| streamArn, | ||
| consumerArn | ||
| ) { | ||
| // Creates a new topic with a schema. Note that you might also | ||
| // pass Encodings.Json or Encodings.Binary here. | ||
| await pubSubClient.createTopic({ | ||
| name: topicNameOrId, | ||
| ingestionDataSourceSettings: { | ||
| awsKinesis: { | ||
| awsRoleArn, | ||
| gcpServiceAccount, | ||
| streamArn, | ||
| consumerArn, | ||
| }, | ||
| }, | ||
| }); | ||
| console.log(`Topic ${topicNameOrId} created with AWS Kinesis ingestion.`); | ||
| } | ||
| // [END pubsub_create_topic_with_kinesis_ingestion] | ||
|
|
||
| function main( | ||
| topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID', | ||
| roleArn = 'arn:aws:iam:...', | ||
| gcpServiceAccount = 'ingestion-account@...', | ||
| streamArn = 'arn:aws:kinesis:...', | ||
| consumerArn = 'arn:aws:kinesis:...' | ||
| ) { | ||
| createTopicWithKinesisIngestion( | ||
| topicNameOrId, | ||
| roleArn, | ||
| gcpServiceAccount, | ||
| streamArn, | ||
| consumerArn | ||
| ).catch(err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
| } | ||
|
|
||
| main(...process.argv.slice(2)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -96,6 +96,43 @@ describe('topics', () => { | |
| assert.ok(exists, 'Topic was created'); | ||
| }); | ||
|
|
||
| const kinesisFakeArns = { | ||
| roleArn: 'arn:aws:iam::111111111111:role/fake-role-name', | ||
| gcpServiceAccount: | ||
| '[email protected]', | ||
| streamArn: 'arn:aws:kinesis:us-west-2:111111111111:stream/fake-stream-name', | ||
| consumerArn: | ||
| 'arn:aws:kinesis:us-west-2:111111111111:stream/fake-stream-name/consumer/consumer-1:1111111111', | ||
| }; | ||
|
|
||
| it('should create a topic with kinesis ingestion', async () => { | ||
| const name = topicName('create-kinesis'); | ||
|
|
||
| const output = execSync( | ||
| `${commandFor('createTopicWithKinesisIngestion')} ${name} ${ | ||
| kinesisFakeArns.roleArn | ||
| } ${kinesisFakeArns.gcpServiceAccount} ${kinesisFakeArns.streamArn} ${ | ||
| kinesisFakeArns.consumerArn | ||
| }` | ||
| ); | ||
| assert.include(output, `Topic ${name} created with AWS Kinesis ingestion.`); | ||
| const [topics] = await pubsub.getTopics(); | ||
| const exists = topics.some(t => t.name === fullTopicName(name)); | ||
| assert.ok(exists, 'Topic was created'); | ||
| }); | ||
|
|
||
| it('should update a topic with kinesis integration', async () => { | ||
| const pair = await createPair('update-kinesis'); | ||
| const output = execSync( | ||
| `${commandFor('updateTopicIngestionType')} ${pair.t.name} ${ | ||
| kinesisFakeArns.roleArn | ||
| } ${kinesisFakeArns.gcpServiceAccount} ${kinesisFakeArns.streamArn} ${ | ||
| kinesisFakeArns.consumerArn | ||
| }` | ||
| ); | ||
| assert.include(output, 'Topic updated with Kinesis source successfully.'); | ||
| }); | ||
|
|
||
| it('should list topics', async () => { | ||
| const pair = await createPair('list'); | ||
| const output = execSync(`${commandFor('listAllTopics')}`); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // Copyright 2024 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 | ||
| // | ||
| // https://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. | ||
|
|
||
| /** | ||
| * This sample demonstrates how to perform basic operations on topics with | ||
| * the Google Cloud Pub/Sub API. | ||
| * | ||
| * For more information, see the README.md under /pubsub and the documentation | ||
| * at https://cloud.google.com/pubsub/docs. | ||
| */ | ||
|
|
||
| // sample-metadata: | ||
| // title: Create Topic With Kinesis Ingestion | ||
| // description: Creates a new topic, with Kinesis ingestion enabled. | ||
| // usage: node createTopicWithKinesisIngestion.js <topic-name> <role-arn> <gcp-service-account> <stream-arn> <consumer-arn> | ||
|
|
||
| // [START pubsub_create_topic_with_kinesis_ingestion] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID'; | ||
| // const roleArn = 'arn:aws:iam:...'; | ||
| // const gcpServiceAccount = 'ingestion-account@...'; | ||
| // const streamArn = 'arn:aws:kinesis:...'; | ||
| // const consumerArn = 'arn:aws:kinesis:...'; | ||
|
|
||
| // Imports the Google Cloud client library | ||
| import {PubSub} from '@google-cloud/pubsub'; | ||
|
|
||
| // Creates a client; cache this for further use | ||
| const pubSubClient = new PubSub(); | ||
|
|
||
| async function createTopicWithKinesisIngestion( | ||
| topicNameOrId: string, | ||
| awsRoleArn: string, | ||
| gcpServiceAccount: string, | ||
| streamArn: string, | ||
| consumerArn: string | ||
| ) { | ||
| // Creates a new topic with a schema. Note that you might also | ||
| // pass Encodings.Json or Encodings.Binary here. | ||
| await pubSubClient.createTopic({ | ||
| name: topicNameOrId, | ||
| ingestionDataSourceSettings: { | ||
| awsKinesis: { | ||
| awsRoleArn, | ||
| gcpServiceAccount, | ||
| streamArn, | ||
| consumerArn, | ||
| }, | ||
| }, | ||
| }); | ||
| console.log(`Topic ${topicNameOrId} created with AWS Kinesis ingestion.`); | ||
| } | ||
| // [END pubsub_create_topic_with_kinesis_ingestion] | ||
|
|
||
| function main( | ||
| topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID', | ||
| roleArn = 'arn:aws:iam:...', | ||
| gcpServiceAccount = 'ingestion-account@...', | ||
| streamArn = 'arn:aws:kinesis:...', | ||
| consumerArn = 'arn:aws:kinesis:...' | ||
| ) { | ||
| createTopicWithKinesisIngestion( | ||
| topicNameOrId, | ||
| roleArn, | ||
| gcpServiceAccount, | ||
| streamArn, | ||
| consumerArn | ||
| ).catch(err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
| } | ||
|
|
||
| main(...process.argv.slice(2)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // Copyright 2024 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. | ||
|
|
||
| /** | ||
| * This sample demonstrates how to perform basic operations on | ||
| * subscriptions with the Google Cloud Pub/Sub API. | ||
| * | ||
| * For more information, see the README.md under /pubsub and the documentation | ||
| * at https://cloud.google.com/pubsub/docs. | ||
| */ | ||
|
|
||
| // sample-metadata: | ||
| // title: Update Topic Ingestion Type | ||
| // description: Update the ingestion type on a topic. | ||
| // usage: node updateTopicIngestionType.js <topic-name-or-id> <stream-arn> <consumer-arn> <aws-role-arn> <gcp-service-account> | ||
|
|
||
| // [START pubsub_update_topic_type] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID'; | ||
| // const awsRoleArn = 'arn:aws:iam:...'; | ||
| // const gcpServiceAccount = 'ingestion-account@...'; | ||
| // const streamArn = 'arn:aws:kinesis:...'; | ||
| // const consumerArn = 'arn:aws:kinesis:...'; | ||
|
|
||
| // Imports the Google Cloud client library | ||
| import {PubSub, TopicMetadata} from '@google-cloud/pubsub'; | ||
|
|
||
| // Creates a client; cache this for further use | ||
| const pubSubClient = new PubSub(); | ||
|
|
||
| async function updateTopicIngestionType( | ||
| topicNameOrId: string, | ||
| awsRoleArn: string, | ||
| gcpServiceAccount: string, | ||
| streamArn: string, | ||
| consumerArn: string | ||
| ) { | ||
| const metadata: TopicMetadata = { | ||
| ingestionDataSourceSettings: { | ||
| awsKinesis: { | ||
| awsRoleArn, | ||
| gcpServiceAccount, | ||
| streamArn, | ||
| consumerArn, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| await pubSubClient.topic(topicNameOrId).setMetadata(metadata); | ||
|
|
||
| console.log('Topic updated with Kinesis source successfully.'); | ||
| } | ||
| // [END pubsub_update_topic_type] | ||
|
|
||
| function main( | ||
| topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID', | ||
| roleArn = 'arn:aws:iam:...', | ||
| gcpServiceAccount = 'ingestion-account@...', | ||
| streamArn = 'arn:aws:kinesis:...', | ||
| consumerArn = 'arn:aws:kinesis:...' | ||
| ) { | ||
| updateTopicIngestionType( | ||
| topicNameOrId, | ||
| roleArn, | ||
| gcpServiceAccount, | ||
| streamArn, | ||
| consumerArn | ||
| ).catch(err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
| } | ||
|
|
||
| main(...process.argv.slice(2)); |
Oops, something went wrong.