deimos-ruby 1.12.4 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6868444b14bad26f41d6b9ae08e02b402c33e17131df0db31874551c69b2d2b
-  data.tar.gz: 64d5856bf685c2de06a3fe2124fcbf441953600073a0a1786663877013f52080
+  metadata.gz: c57c2700b01b998f358cb4e96ee6e6b2c1c8c32936d741b2371182a6017f7adc
+  data.tar.gz: 440bf25b629ba34da51cd1c0a1b443858bcd4ca270fed800b6e277c050b0741f
 SHA512:
-  metadata.gz: 6e0ff08f0224cf67ccd6361c8e75d30e516acec862edeb233401bfd61ccd2cfd8fe2b38658be1ff6fabfdae396caefa856e22182ed995fd03dc7afa7a644a8c5
-  data.tar.gz: 543da676aff990c852f2208a39539650f77255f7aa5e50f3e9651352fb84c9303f78daa51e43b27abdc295175b891cca29b578d2b786773da8184f45ff11439b
+  metadata.gz: 05df77f7f8890959ea91817a7497c11348d3b68f349462275a1ffb133a1c8194d9ee2282ac3dbe14a389bd09f16f059c88b467c05fb959c1a334b7c3789ade92
+  data.tar.gz: bc8b8c832a7399a6c60a4a0ac71582aff4ff324d5a2c9bb2a73241bb64de3a958d09208e1c127d36e8b3c47077857224ec853aaea769ef00aaef88dc6e6cf0e9

data/.gemfiles/avro_turf-0.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile '../Gemfile'
+
+gem 'avro_turf', '~> 0.11'

data/.gemfiles/avro_turf-1.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile '../Gemfile'
+
+gem 'avro_turf', '~> 1.0'

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [ master ]
+
+env:
+  GIT_COMMIT_SHA: ${{ github.sha }}
+  GIT_BRANCH: ${{ github.ref }}
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITH: lint
+      BUNDLE_WITHOUT: development:test
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+
+      - name: Rubocop
+        run: bundle exec rubocop --format progress
+
+  build:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/.gemfiles/${{ matrix.gemfile }}.gemfile
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
+        gemfile: [ 'avro_turf-0', 'avro_turf-1' ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Test
+        run: bundle exec rspec

data/.gitignore

@@ -12,6 +12,7 @@
 /test/version_tmp/
 /tmp/
 /log/
+Gemfile.lock
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -38,4 +39,4 @@
 
 test.sqlite3
 
-.idea
+.idea

data/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 1.13.0 - 2022-03-30
+
+- Pass the Deimos logger to `AvroTurf::Messaging` for consistent logging
+- Fix an issue with nullable enums not being included in the auto-generated schema class
+
+# 1.12.6 - 2022-03-14
+
+- Fix NameError when using Datadog Metrics
+- Fix unwanted STDOUT output when loading the main `Deimos` module
+
+# 1.12.5 - 2022-03-09
+
+- Allow use of new avro_turf versions where child schemas are not listed with the top level schemas
+- Add support for SASL authentication with brokers
+- Add support for Basic auth with Schema Registry
+
 # 1.12.4 - 2022-01-13
 
 - Fix bug where schema controller mixin was using the schema name to register and not the namespaced schema name

data/README.md

@@ -259,7 +259,7 @@ like this:
 ```javascript
 {
   "namespace": "com.my-namespace",
-  "name": "MySchema-key",
+  "name": "MySchema_key",
   "type": "record",
   "doc": "Key for com.my-namespace.MySchema",
   "fields": [
@@ -934,8 +934,8 @@ The following metrics are reported:
 
 ### Configuring Metrics Providers
 
-See the `metrics` field under [Configuration](CONFIGURATION.md).
-View all available Metrics Providers [here](lib/deimos/metrics/metrics_providers)
+See the `metrics` field under [Configuration](#configuration).
+View all available Metrics Providers [here](lib/deimos/metrics)
 
 ### Custom Metrics Providers
 

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'deimos'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/deimos-ruby.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency('avro_turf', '~> 0.11')
+  spec.add_runtime_dependency('avro_turf', '>= 0.11', '< 2')
   spec.add_runtime_dependency('phobos', '>= 1.9', '< 3.0')
   spec.add_runtime_dependency('ruby-kafka', '< 2')
   spec.add_runtime_dependency('sigurd', '~> 0.0.1')

data/docs/CONFIGURATION.md

@@ -130,9 +130,21 @@ kafka.client_id|`phobos`|Identifier for this application.
 kafka.connect_timeout|15|The socket timeout for connecting to the broker, in seconds.
 kafka.socket_timeout|15|The socket timeout for reading and writing to the broker, in seconds.
 kafka.ssl.enabled|false|Whether SSL is enabled on the brokers.
+kafka.ssl.ca_certs_from_system|false|Use CA certs from system.
 kafka.ssl.ca_cert|nil| A PEM encoded CA cert, a file path to the cert, or an Array of certs to use with an SSL connection.
 kafka.ssl.client_cert|nil|A PEM encoded client cert to use with an SSL connection, or a file path to the cert.
 kafka.ssl.client_cert_key|nil|A PEM encoded client cert key to use with an SSL connection.
+kafka.sasl.enabled|false|Whether SASL is enabled on the brokers.
+kafka.sasl.gssapi_principal|nil|A KRB5 principal.
+kafka.sasl.gssapi_keytab|nil|A KRB5 keytab filepath.
+kafka.sasl.plain_authzid|nil|Plain authorization ID.
+kafka.sasl.plain_username|nil|Plain username.
+kafka.sasl.plain_password|nil|Plain password.
+kafka.sasl.scram_username|nil|SCRAM username.
+kafka.sasl.scram_password|nil|SCRAM password.
+kafka.sasl.scram_mechanism|nil|Scram mechanism, either "sha256" or "sha512".
+kafka.sasl.enforce_ssl|nil|Whether to enforce SSL with SASL.
+kafka.sasl.oauth_token_provider|nil|OAuthBearer Token Provider instance that implements method token. See {Sasl::OAuth#initialize}.
 
 ## Consumer Configuration
 
@@ -177,9 +189,11 @@ Config name|Default|Description
 -----------|-------|-----------
 schema.backend|`:mock`|Backend representing the schema encoder/decoder. You can see a full list [here](../lib/deimos/schema_backends).
 schema.registry_url|`http://localhost:8081`|URL of the Confluent schema registry.
+schema.user|nil|Basic auth user.
+schema.password|nil|Basic auth password.
 schema.path|nil|Local path to find your schemas.
 schema.use_schema_classes|false|Set this to true to use generated schema classes in your application.
-schema.generated_schema_path|`app/lib/schema_classes`|Local path to generated schema classes.
+schema.generated_class_path|`app/lib/schema_classes`|Local path to generated schema classes.
 
 ## Database Producer Configuration
 

data/lib/deimos/config/configuration.rb

@@ -136,6 +136,58 @@ module Deimos
 
         # Verify certificate hostname if supported (ruby >= 2.4.0)
         setting :verify_hostname, true
+
+        # Use CA certs from system. This is useful to have enabled for Confluent Cloud
+        # @return [Boolean]
+        setting :ca_certs_from_system, false
+      end
+
+      setting :sasl do
+        # Whether SASL is enabled on the brokers.
+        # @return [Boolean]
+        setting :enabled
+
+        # A KRB5 principal.
+        # @return [String]
+        setting :gssapi_principal
+
+        # A KRB5 keytab filepath.
+        # @return [String]
+        setting :gssapi_keytab
+
+        # Plain authorization ID. It needs to default to '' in order for it to work.
+        # This is because Phobos expects it to be truthy for using plain SASL.
+        # @return [String]
+        setting :plain_authzid, ''
+
+        # Plain username.
+        # @return [String]
+        setting :plain_username
+
+        # Plain password.
+        # @return [String]
+        setting :plain_password
+
+        # SCRAM username.
+        # @return [String]
+        setting :scram_username
+
+        # SCRAM password.
+        # @return [String]
+        setting :scram_password
+
+        # Scram mechanism, either "sha256" or "sha512".
+        # @return [String]
+        setting :scram_mechanism
+
+        # Whether to enforce SSL with SASL.
+        # @return [Boolean]
+        setting :enforce_ssl
+
+        # OAuthBearer Token Provider instance that implements
+        # method token. See {Sasl::OAuth#initialize}.
+        # @return [Object]
+        setting :oauth_token_provider
       end
     end
 
@@ -272,6 +324,14 @@ module Deimos
       # @return [String]
       setting :registry_url, 'http://localhost:8081'
 
+      # Basic Auth user.
+      # @return [String]
+      setting :user
+
+      # Basic Auth password.
+      # @return [String]
+      setting :password
+
       # Local path to look for schemas in.
       # @return [String]
       setting :path
@@ -287,11 +347,11 @@ module Deimos
 
     # The configured metrics provider.
     # @return [Metrics::Provider]
-    setting :metrics, Metrics::Mock.new
+    setting :metrics, default_proc: proc { Metrics::Mock.new }
 
     # The configured tracing / APM provider.
     # @return [Tracing::Provider]
-    setting :tracer, Tracing::Mock.new
+    setting :tracer, default_proc: proc { Tracing::Mock.new }
 
     setting :db_producer do
 

data/lib/deimos/config/phobos_config.rb

@@ -38,6 +38,7 @@ module Deimos
           connect_timeout: self.kafka.connect_timeout,
           socket_timeout: self.kafka.socket_timeout,
           ssl_verify_hostname: self.kafka.ssl.verify_hostname,
+          ssl_ca_certs_from_system: self.kafka.ssl.ca_certs_from_system,
           seed_brokers: Array.wrap(self.kafka.seed_brokers)
         },
         producer: {
@@ -84,6 +85,26 @@ module Deimos
           p_config[:kafka]["ssl_#{key}".to_sym] = ssl_var_contents(self.kafka.ssl.send(key))
         end
       end
+
+      if self.kafka.sasl.enabled
+        p_config[:kafka][:sasl_over_ssl] = self.kafka.sasl.enforce_ssl
+        %w(
+          gssapi_principal
+          gssapi_keytab
+          plain_authzid
+          plain_username
+          plain_password
+          scram_username
+          scram_password
+          scram_mechanism
+          oauth_token_provider
+        ).each do |key|
+          value = self.kafka.sasl.send(key)
+          next if value.blank?
+
+          p_config[:kafka]["sasl_#{key}".to_sym] = value
+        end
+      end
       p_config
     end
 
@@ -102,6 +123,9 @@ module Deimos
         if k.starts_with?('ssl')
           k = k.sub('ssl_', '')
           self.kafka.ssl.send("#{k}=", v)
+        elsif k.starts_with?('sasl')
+          k = (k == 'sasl_over_ssl') ? 'enforce_ssl' : k.sub('sasl_', '')
+          self.kafka.sasl.send("#{k}=", v)
         else
           self.kafka.send("#{k}=", v)
         end

data/lib/deimos/metrics/datadog.rb

@@ -13,7 +13,7 @@ module Deimos
         raise 'Metrics config must specify namespace' if config[:namespace].nil?
 
         logger.info("DatadogMetricsProvider configured with: #{config}")
-        @client = Datadog::Statsd.new(
+        @client = ::Datadog::Statsd.new(
           config[:host_ip],
           config[:host_port]
         )

data/lib/deimos/schema_backends/avro_schema_registry.rb

@@ -26,7 +26,10 @@ module Deimos
           schema_store: @schema_store,
           registry_url: Deimos.config.schema.registry_url,
           schemas_path: Deimos.config.schema.path,
-          namespace: @namespace
+          user: Deimos.config.schema.user,
+          password: Deimos.config.schema.password,
+          namespace: @namespace,
+          logger: Deimos.config.logger
         )
       end
     end

data/lib/deimos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deimos
-  VERSION = '1.12.4'
+  VERSION = '1.13.0'
 end

data/lib/generators/deimos/schema_class_generator.rb

@@ -53,10 +53,36 @@ module Deimos
           generate_class_from_schema_base(schema_base, key_schema_base: key_schema_base)
         end
 
+        # @param schema [Avro::Schema::NamedSchema]
+        # @return [Array<Avro::Schema::NamedSchema]
+        def child_schemas(schema)
+          if schema.respond_to?(:fields)
+            schema.fields.map(&:type)
+          elsif schema.respond_to?(:values)
+            [schema.values]
+          elsif schema.respond_to?(:items)
+            [schema.items]
+          elsif schema.respond_to?(:schemas)
+            schema.schemas
+          else
+            []
+          end
+        end
+
+        # @param schemas [Array<Avro::Schema::NamedSchema>]
+        # @return [Array<Avro::Schema::NamedSchema>]
+        def collect_all_schemas(schemas)
+          schemas.dup.each do |schema|
+            schemas.concat(collect_all_schemas(child_schemas(schema)))
+          end
+          schemas.select { |s| s.respond_to?(:name) }.uniq
+        end
+
         # @param schema_base [Deimos::SchemaBackends::Base]
         # @param key_schema_base[Avro::Schema::NamedSchema]
         def generate_class_from_schema_base(schema_base, key_schema_base: nil)
-          schemas = schema_base.schema_store.schemas.values
+          schemas = collect_all_schemas(schema_base.schema_store.schemas.values)
+
           sub_schemas = schemas.reject { |s| s.name == schema_base.schema }
           @sub_schema_templates = sub_schemas.map do |schema|
             _generate_class_template_from_schema(schema)

data/spec/active_record_batch_consumer_spec.rb

@@ -315,7 +315,7 @@ module ActiveRecordBatchConsumerTest
         Class.new(described_class) do
           schema 'MySchema'
           namespace 'com.my-namespace'
-          key_config schema: 'MySchemaCompound-key'
+          key_config schema: 'MySchemaCompound_key'
           record_class Widget
           compacted false
 

data/spec/active_record_consumer_spec.rb

@@ -76,7 +76,7 @@ module ActiveRecordConsumerTest
                                      updated_at: 1.day.ago.to_i,
                                      some_datetime_int: Time.zone.now.to_i,
                                      timestamp: 2.minutes.ago.to_s
-                                   }, { call_original: true, key: 5 })
+                                   }, call_original: true, key: 5)
 
               expect(Widget.count).to eq(1)
               widget = Widget.last
@@ -96,7 +96,7 @@ module ActiveRecordConsumerTest
                                      some_int: 3,
                                      some_datetime_int: Time.zone.now.to_i,
                                      timestamp: 2.minutes.ago.to_s
-                                   }, { call_original: true, key: 5 })
+                                   }, call_original: true, key: 5)
               expect(Widget.unscoped.count).to eq(1)
               widget = Widget.unscoped.last
               expect(widget.id).to eq(5)
@@ -120,7 +120,7 @@ module ActiveRecordConsumerTest
             test_consume_message(MyCustomFetchConsumer, {
                                    test_id: 'id1',
                                    some_int: 3
-                                 }, { call_original: true })
+                                 }, call_original: true)
             expect(widget1.reload.updated_at.in_time_zone).
               to eq(Time.local(2020, 5, 6, 5, 5, 5))
             travel_back
@@ -132,13 +132,13 @@ module ActiveRecordConsumerTest
             test_consume_message(MyCustomFetchConsumer, {
                                    test_id: 'id1',
                                    some_int: 3
-                                 }, { call_original: true })
+                                 }, call_original: true)
             expect(widget1.reload.some_int).to eq(3)
             expect(Widget.count).to eq(1)
             test_consume_message(MyCustomFetchConsumer, {
                                    test_id: 'id2',
                                    some_int: 4
-                                 }, { call_original: true })
+                                 }, call_original: true)
             expect(Widget.count).to eq(2)
             expect(Widget.find_by_test_id('id1').some_int).to eq(3)
             expect(Widget.find_by_test_id('id2').some_int).to eq(4)
@@ -153,7 +153,7 @@ module ActiveRecordConsumerTest
                                    updated_at: 1.day.ago.to_i,
                                    some_datetime_int: Time.zone.now.to_i,
                                    timestamp: 2.minutes.ago.to_s
-                                 }, { call_original: true, key: 5 })
+                                 }, call_original: true, key: 5)
             expect(Widget.count).to eq(0)
           end
         end

data/spec/active_record_producer_spec.rb

@@ -76,7 +76,7 @@ describe Deimos::ActiveRecordProducer do
 
         it 'should be able to call the record' do
           widget = Widget.create!(test_id: 'abc2', some_int: 3)
-          MyProducerWithID.send_event(id: widget.id, test_id: 'abc2', some_int: 3)
+          MyProducerWithID.send_event({id: widget.id, test_id: 'abc2', some_int: 3})
           expect('my-topic-with-id').to have_sent(
             test_id: 'abc2',
             some_int: 3,

data/spec/config/configuration_spec.rb

@@ -70,6 +70,7 @@ describe Deimos, 'configuration' do
         connect_timeout: 15,
         socket_timeout: 15,
         ssl_verify_hostname: true,
+        ssl_ca_certs_from_system: false,
         seed_brokers: ['localhost:9092']
       },
       listeners: [
@@ -138,10 +139,22 @@ describe Deimos, 'configuration' do
         connect_timeout 30
         socket_timeout 30
         ssl.enabled(true)
+        ssl.ca_certs_from_system(true)
         ssl.ca_cert('cert')
         ssl.client_cert('cert')
         ssl.client_cert_key('key')
         ssl.verify_hostname(false)
+        sasl.enabled true
+        sasl.gssapi_principal 'gssapi_principal'
+        sasl.gssapi_keytab 'gssapi_keytab'
+        sasl.plain_authzid 'plain_authzid'
+        sasl.plain_username 'plain_username'
+        sasl.plain_password 'plain_password'
+        sasl.scram_username 'scram_username'
+        sasl.scram_password 'scram_password'
+        sasl.scram_mechanism 'scram_mechanism'
+        sasl.enforce_ssl true
+        sasl.oauth_token_provider 'oauth_token_provider'
       end
       consumers do
         session_timeout 30
@@ -210,11 +223,22 @@ describe Deimos, 'configuration' do
           client_id: 'phobos2',
           connect_timeout: 30,
           socket_timeout: 30,
+          ssl_ca_certs_from_system: true,
           ssl_ca_cert: 'cert',
           ssl_client_cert: 'cert',
           ssl_client_cert_key: 'key',
           ssl_verify_hostname: false,
-          seed_brokers: ['my-seed-brokers']
+          seed_brokers: ['my-seed-brokers'],
+          sasl_gssapi_principal: 'gssapi_principal',
+          sasl_gssapi_keytab: 'gssapi_keytab',
+          sasl_plain_authzid: 'plain_authzid',
+          sasl_plain_username: 'plain_username',
+          sasl_plain_password: 'plain_password',
+          sasl_scram_username: 'scram_username',
+          sasl_scram_password: 'scram_password',
+          sasl_scram_mechanism: 'scram_mechanism',
+          sasl_over_ssl: true,
+          sasl_oauth_token_provider: 'oauth_token_provider',
         },
         listeners: [
           {

data/spec/consumer_spec.rb

@@ -32,8 +32,8 @@ module ConsumerTest
 
           it 'should consume a message' do
             test_consume_message(MyConsumer,
-                                 'test_id' => 'foo',
-                                 'some_int' => 123) do |payload, _metadata|
+                                 {'test_id' => 'foo',
+                                 'some_int' => 123}) do |payload, _metadata|
                                    expect(payload['test_id']).to eq('foo')
                                    expect(payload['some_int']).to eq(123)
                                  end
@@ -64,15 +64,15 @@ module ConsumerTest
 
           it 'should consume a message on a topic' do
             test_consume_message('my_consume_topic',
-                                 'test_id' => 'foo',
-                                 'some_int' => 123) do |payload, _metadata|
+                                 {'test_id' => 'foo',
+                                 'some_int' => 123}) do |payload, _metadata|
                                    expect(payload['test_id']).to eq('foo')
                                    expect(payload['some_int']).to eq(123)
                                  end
           end
 
           it 'should fail on invalid message' do
-            test_consume_invalid_message(MyConsumer, 'invalid' => 'key')
+            test_consume_invalid_message(MyConsumer, {'invalid' => 'key'})
           end
 
           it 'should fail if reraise is false but fatal_error is true' do
@@ -85,14 +85,14 @@ module ConsumerTest
               config.consumers.fatal_error = proc { true }
               config.consumers.reraise_errors = false
             end
-            test_consume_invalid_message(MyConsumer, 'invalid' => 'key')
+            test_consume_invalid_message(MyConsumer, {'invalid' => 'key'})
           end
 
           it 'should fail on message with extra fields' do
             test_consume_invalid_message(MyConsumer,
-                                         'test_id' => 'foo',
+                                         {'test_id' => 'foo',
                                          'some_int' => 123,
-                                         'extra_field' => 'field name')
+                                         'extra_field' => 'field name'})
           end
 
           it 'should not fail when before_consume fails without reraising errors' do
@@ -102,7 +102,7 @@ module ConsumerTest
                 MyConsumer,
                 { 'test_id' => 'foo',
                   'some_int' => 123 },
-                { skip_expectation: true }
+                skip_expectation: true
               ) { raise 'OH NOES' }
             }.not_to raise_error
           end
@@ -113,7 +113,7 @@ module ConsumerTest
               test_consume_message(
                 MyConsumer,
                 { 'invalid' => 'key' },
-                { skip_expectation: true }
+                skip_expectation: true
               )
             }.not_to raise_error
           end
@@ -122,7 +122,7 @@ module ConsumerTest
             expect {
               test_consume_message(MyConsumer,
                                    { 'test_id' => 'foo', 'some_int' => 123 },
-                                   { call_original: true })
+                                   call_original: true)
             }.to raise_error('This should not be called unless call_original is set')
           end
         end
@@ -189,10 +189,10 @@ module ConsumerTest
       it 'should consume a message' do
         expect(Deimos.config.metrics).to receive(:histogram).twice
         test_consume_message('my_consume_topic',
-                             'test_id' => 'foo',
+                             {'test_id' => 'foo',
                              'some_int' => 123,
                              'updated_at' => Time.now.to_i,
-                             'timestamp' => 2.minutes.ago.to_s) do |payload, _metadata|
+                             'timestamp' => 2.minutes.ago.to_s}) do |payload, _metadata|
                                expect(payload['test_id']).to eq('foo')
                              end
       end
@@ -200,17 +200,17 @@ module ConsumerTest
       it 'should fail nicely when timestamp wrong format' do
         expect(Deimos.config.metrics).to receive(:histogram).twice
         test_consume_message('my_consume_topic',
-                             'test_id' => 'foo',
+                             {'test_id' => 'foo',
                              'some_int' => 123,
                              'updated_at' => Time.now.to_i,
-                             'timestamp' => 'dffdf') do |payload, _metadata|
+                             'timestamp' => 'dffdf'}) do |payload, _metadata|
                                expect(payload['test_id']).to eq('foo')
                              end
         test_consume_message('my_consume_topic',
-                             'test_id' => 'foo',
+                             {'test_id' => 'foo',
                              'some_int' => 123,
                              'updated_at' => Time.now.to_i,
-                             'timestamp' => '') do |payload, _metadata|
+                             'timestamp' => ''}) do |payload, _metadata|
                                expect(payload['test_id']).to eq('foo')
                              end
       end

data/spec/generators/schema_class/my_schema_with_complex_types_spec.rb

@@ -57,7 +57,7 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
     end
 
     let(:schema_fields) do
-      %w(test_id test_float test_int_array test_optional_int test_string_array some_integer_map some_record some_optional_record some_record_array some_record_map some_enum_array)
+      %w(test_id test_float test_int_array test_optional_int test_string_array some_integer_map some_record some_optional_record some_record_array some_record_map some_enum_array some_optional_enum)
     end
 
     it 'should return the name of the schema and namespace' do
@@ -77,6 +77,7 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
         'test_float' => 1.2,
         'test_string_array' => %w(abc def),
         'test_int_array' => [123, 456],
+        'some_optional_enum' => nil,
         'test_optional_int' => 123,
         'some_integer_map' => { 'int_1' => 1, 'int_2' => 2 },
         'some_record' => { 'a_record_field' => 'field 1' },
@@ -96,7 +97,7 @@ RSpec.describe Schemas::MySchemaWithComplexTypes do
     end
 
     it 'should return a JSON string of the payload' do
-      s = '{"test_id":"test id","test_float":1.2,"test_string_array":["abc","def"],"test_int_array":[123,456],"test_optional_int":123,"some_integer_map":{"int_1":1,"int_2":2},"some_record":{"a_record_field":"field 1"},"some_optional_record":{"a_record_field":"field 2"},"some_record_array":[{"a_record_field":"field 3"},{"a_record_field":"field 4"}],"some_record_map":{"record_1":{"a_record_field":"field 5"},"record_2":{"a_record_field":"field 6"}},"some_enum_array":["sym1","sym2"]}'
+      s = '{"test_id":"test id","test_float":1.2,"test_string_array":["abc","def"],"test_int_array":[123,456],"test_optional_int":123,"some_integer_map":{"int_1":1,"int_2":2},"some_record":{"a_record_field":"field 1"},"some_optional_record":{"a_record_field":"field 2"},"some_record_array":[{"a_record_field":"field 3"},{"a_record_field":"field 4"}],"some_record_map":{"record_1":{"a_record_field":"field 5"},"record_2":{"a_record_field":"field 6"}},"some_enum_array":["sym1","sym2"],"some_optional_enum":null}'
       expect(klass.to_json).to eq(s)
     end
   end