Skip to content

chore: Migrate samples to google-cloud-pubsub v3 #30618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aandreassa merged 6 commits into from
Jul 22, 2025
Merged

chore: Migrate samples to google-cloud-pubsub v3 #30618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f468f54
Migrate samples under schemas_test.rb
yoshi-automation Jul 9, 2025
6491105
chore: Migrate subscription samples to google-cloud-pubsub-v2
yoshi-automation Jul 9, 2025
72ce692
chore: migrate topic samples to google-cloud-pubsub-v2
yoshi-automation Jul 10, 2025
c0bbaea
Samples fixes
yoshi-automation Jul 17, 2025
743f732
s/Pubsub/PubSub/g in samples directory
yoshi-automation Jul 17, 2025
ec848b7
Rubocop fixes
yoshi-automation Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions google-cloud-pubsub/samples/acceptance/quickstart_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,18 @@
require_relative "../quickstart.rb"

describe "quickstart" do
let(:pubsub) { Google::Cloud::Pubsub.new }
let(:pubsub) { Google::Cloud::PubSub.new }
let(:topic_id) { random_topic_id }
let(:topic_admin) { pubsub.topic_admin }

it "supports quickstart_create_topic" do
assert_output "Topic projects/#{pubsub.project}/topics/#{topic_id} created.\n" do
quickstart topic_id: topic_id
end

topic = pubsub.topic topic_id
topic = topic_admin.get_topic topic: pubsub.topic_path(topic_id)
assert topic
# cleanup
topic.delete
topic_admin.delete_topic topic: topic.name
end
end
149 changes: 115 additions & 34 deletions google-cloud-pubsub/samples/acceptance/schemas_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,27 @@


describe "schemas" do
let(:pubsub) { Google::Cloud::Pubsub.new }
let(:pubsub) { Google::Cloud::PubSub.new }
let(:schema_id) { random_schema_id }
let(:topic_id) { random_topic_id }
let(:subscription_id) { random_subscription_id }
let(:avsc_file) { File.expand_path "data/us-states.avsc", __dir__ }
let(:topic_admin) { pubsub.topic_admin }
let(:subscription_admin) { pubsub.subscription_admin }
let(:schemas) { pubsub.schemas }

after do
@subscription.delete if @subscription
@topic.delete if @topic
@schema.delete if @schema
subscription_admin.delete_subscription subscription: @subscription.name if @subscription
topic_admin.delete_topic topic: @topic.name if @topic
schemas.delete_schema name: @schema.name if @schema
end

it "supports pubsub_create_schema, pubsub_get_schema, pubsub_list_schemas, pubsub_delete_schema" do
# create_avro_schema
assert_output "Schema projects/#{pubsub.project}/schemas/#{schema_id} created.\n" do
create_avro_schema schema_id: schema_id, avsc_file: avsc_file
end
@schema = pubsub.schema schema_id
@schema = schemas.get_schema name: pubsub.schema_path(schema_id)
assert @schema
assert_equal "projects/#{pubsub.project}/schemas/#{schema_id}", @schema.name

Expand Down Expand Up @@ -75,13 +78,19 @@
let(:record) { { "name" => "Alaska", "post_abbr" => "AK" } }

it "supports pubsub_create_topic_with_schema, pubsub_publish_avro_records with binary encoding" do
@schema = pubsub.create_schema schema_id, :avro, avsc_definition
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :AVRO,
definition: avsc_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id


# pubsub_create_topic_with_schema
assert_output "Topic projects/#{pubsub.project}/topics/#{topic_id} created.\n" do
create_topic_with_schema topic_id: topic_id, schema_id: schema_id, message_encoding: :binary
create_topic_with_schema topic_id: topic_id, schema_id: schema_id, message_encoding: :BINARY
end
@topic = pubsub.topic topic_id
@topic = topic_admin.get_topic topic: pubsub.topic_path(topic_id)
assert @topic
assert_equal "projects/#{pubsub.project}/topics/#{topic_id}", @topic.name

Expand All @@ -92,13 +101,18 @@
end

it "supports pubsub_create_topic_with_schema, pubsub_publish_avro_records with JSON encoding" do
@schema = pubsub.create_schema schema_id, :avro, avsc_definition
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :AVRO,
definition: avsc_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id

# pubsub_create_topic_with_schema
assert_output "Topic projects/#{pubsub.project}/topics/#{topic_id} created.\n" do
create_topic_with_schema topic_id: topic_id, schema_id: schema_id, message_encoding: :json
create_topic_with_schema topic_id: topic_id, schema_id: schema_id, message_encoding: :JSON
end
@topic = pubsub.topic topic_id
@topic = topic_admin.get_topic topic: pubsub.topic_path(topic_id)
assert @topic
assert_equal "projects/#{pubsub.project}/topics/#{topic_id}", @topic.name

Expand All @@ -109,15 +123,28 @@
end

it "supports pubsub_subscribe_avro_records with binary encoding" do
@schema = pubsub.create_schema schema_id, :avro, avsc_definition
@topic = pubsub.create_topic random_topic_id, schema_name: schema_id, message_encoding: :binary
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :AVRO,
definition: avsc_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id

schema_settings = Google::Cloud::PubSub::V1::SchemaSettings.new schema: pubsub.schema_path(schema_id),
encoding: :BINARY


@topic = topic_admin.create_topic name: pubsub.topic_path(random_topic_id),
schema_settings: schema_settings

@subscription = @topic.subscribe random_subscription_id
@subscription = subscription_admin.create_subscription name: pubsub.subscription_path(random_subscription_id),
topic: @topic.name

writer = Avro::IO::DatumWriter.new avro_schema
buffer = StringIO.new
writer.write record, Avro::IO::BinaryEncoder.new(buffer)
@topic.publish buffer
publisher = pubsub.publisher @topic.name
publisher.publish buffer
sleep 5

# pubsub_subscribe_avro_records
Expand All @@ -129,12 +156,24 @@
end

it "supports pubsub_subscribe_avro_records with JSON encoding" do
@schema = pubsub.create_schema schema_id, :avro, avsc_definition
@topic = pubsub.create_topic random_topic_id, schema_name: schema_id, message_encoding: :json
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :AVRO,
definition: avsc_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id
schema_settings = Google::Cloud::PubSub::V1::SchemaSettings.new schema: pubsub.schema_path(schema_id),
encoding: :JSON

@subscription = @topic.subscribe random_subscription_id

@topic.publish record.to_json
@topic = topic_admin.create_topic name: pubsub.topic_path(random_topic_id),
schema_settings: schema_settings

@subscription = subscription_admin.create_subscription name: pubsub.subscription_path(random_subscription_id),
topic: @topic.name

publisher = pubsub.publisher @topic.name
publisher.publish record.to_json
sleep 5

# pubsub_subscribe_avro_records
Expand All @@ -153,13 +192,19 @@
let(:revision_file) { File.expand_path "data/us-states-revision.proto", __dir__ }

it "supports pubsub_create_topic_with_schema, pubsub_publish_proto_messages with binary encoding" do
@schema = pubsub.create_schema schema_id, :protocol_buffer, proto_definition
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :PROTOCOL_BUFFER,
definition: proto_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id

# pubsub_create_topic_with_schema
assert_output "Topic projects/#{pubsub.project}/topics/#{topic_id} created.\n" do
create_topic_with_schema topic_id: topic_id, schema_id: schema_id, message_encoding: :binary
create_topic_with_schema topic_id: topic_id, schema_id: schema_id, message_encoding: :BINARY
end
@topic = pubsub.topic topic_id

@topic = topic_admin.get_topic topic: pubsub.topic_path(topic_id)
assert @topic
assert_equal "projects/#{pubsub.project}/topics/#{topic_id}", @topic.name

Expand All @@ -170,13 +215,19 @@
end

it "supports pubsub_create_topic_with_schema, pubsub_publish_proto_messages with JSON encoding" do
@schema = pubsub.create_schema schema_id, :protocol_buffer, proto_definition
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :PROTOCOL_BUFFER,
definition: proto_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id

# pubsub_create_topic_with_schema
assert_output "Topic projects/#{pubsub.project}/topics/#{topic_id} created.\n" do
create_topic_with_schema topic_id: topic_id, schema_id: schema_id, message_encoding: :json
create_topic_with_schema topic_id: topic_id, schema_id: schema_id, message_encoding: :JSON
end
@topic = pubsub.topic topic_id

@topic = topic_admin.get_topic topic: pubsub.topic_path(topic_id)
assert @topic
assert_equal "projects/#{pubsub.project}/topics/#{topic_id}", @topic.name

Expand All @@ -187,13 +238,25 @@
end

it "supports pubsub_subscribe_proto_messages with binary encoding" do
@schema = pubsub.create_schema schema_id, :protocol_buffer, proto_definition
@topic = pubsub.create_topic random_topic_id, schema_name: schema_id, message_encoding: :binary
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :PROTOCOL_BUFFER,
definition: proto_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id

schema_settings = Google::Cloud::PubSub::V1::SchemaSettings.new schema: pubsub.schema_path(schema_id),
encoding: :BINARY

@topic = topic_admin.create_topic name: pubsub.topic_path(random_topic_id),
schema_settings: schema_settings

@subscription = @topic.subscribe random_subscription_id
@subscription = subscription_admin.create_subscription name: pubsub.subscription_path(random_subscription_id),
topic: @topic.name

state = Utilities::StateProto.new name: "Alaska", post_abbr: "AK"
@topic.publish Utilities::StateProto.encode(state)
publisher = pubsub.publisher @topic.name
publisher.publish Utilities::StateProto.encode(state)
sleep 5

# pubsub_subscribe_proto_messages
Expand All @@ -205,13 +268,25 @@
end

it "supports pubsub_subscribe_proto_messages with JSON encoding" do
@schema = pubsub.create_schema schema_id, :protocol_buffer, proto_definition
@topic = pubsub.create_topic random_topic_id, schema_name: schema_id, message_encoding: :json
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :PROTOCOL_BUFFER,
definition: proto_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id

@subscription = @topic.subscribe random_subscription_id
schema_settings = Google::Cloud::PubSub::V1::SchemaSettings.new schema: pubsub.schema_path(schema_id),
encoding: :JSON

@topic = topic_admin.create_topic name: pubsub.topic_path(random_topic_id),
schema_settings: schema_settings

@subscription = subscription_admin.create_subscription name: pubsub.subscription_path(random_subscription_id),
topic: @topic.name

state = Utilities::StateProto.new name: "Alaska", post_abbr: "AK"
@topic.publish Utilities::StateProto.encode_json(state)
publisher = pubsub.publisher @topic.name
publisher.publish Utilities::StateProto.encode_json(state)
sleep 5

# pubsub_subscribe_proto_messages
Expand All @@ -223,7 +298,13 @@
end

it "supports pubsub_commit_proto_schema & pubsub_commit_list_schema_revisions" do
@schema = pubsub.create_schema schema_id, :protocol_buffer, proto_definition
schema = Google::Cloud::PubSub::V1::Schema.new name: schema_id,
type: :PROTOCOL_BUFFER,
definition: proto_definition
@schema = schemas.create_schema parent: pubsub.project_path,
schema: schema,
schema_id: schema_id

rev_id = @schema.revision_id

# pubsub_commit_proto_schema
Expand Down
Loading
Loading