fluent-plugin-formatter-protobuf 0.0.1

data/test/plugin/test_formatter_protobuf.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'helper'
+require 'fluent/plugin/formatter_protobuf'
+
+class ProtobufFormatterTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  VALID_INCLUDE_PATHS = [File.expand_path(File.join(__dir__, '..', 'proto', 'addressbook_pb.rb'))].freeze
+
+  sub_test_case 'configure' do
+    test 'fail if include_paths is empty' do
+      assert_raise(Fluent::ConfigError) do
+        create_driver({ message_name: '', include_paths: [] })
+      end
+    end
+
+    test 'fail if no protobuf class can be found with message_name' do
+      assert_raise(Fluent::ConfigError) do
+        create_driver({ message_name: 'Some.Name', include_paths: VALID_INCLUDE_PATHS })
+      end
+    end
+
+    test 'passes on valid configuration' do
+      assert_nothing_raised do
+        create_driver({ message_name: 'tutorial.AddressBook', include_paths: VALID_INCLUDE_PATHS })
+      end
+    end
+  end
+
+  sub_test_case 'format' do
+    test 'encodes into Protobuf binary' do
+      formatter = create_formatter({ message_name: 'tutorial.AddressBook', include_paths: VALID_INCLUDE_PATHS })
+
+      formatted = formatter.format('some-tag', 1234,
+                                   { people: [{ name: 'Masahiro', id: 1337, email: 'repeatedly _at_ gmail.com' }] })
+      golden_file = File.binread(File.expand_path(File.join(__dir__, '..', 'proto', 'addressbook.bin')))
+      assert_equal(golden_file, formatted)
+    end
+  end
+
+  private
+
+  def create_driver(conf = {})
+    Fluent::Test::Driver::Formatter.new(Fluent::Plugin::ProtobufFormatter).configure(conf)
+  end
+
+  def create_formatter(conf)
+    create_driver(conf).instance
+  end
+end

data/test/proto/README.md

@@ -0,0 +1,10 @@
+# proto
+
+This directory contains relevant Protobuf files for testing.
+
+```
+addressbook       - Plain text data, used to pass into `protoc` for generating binary encoded Protobuf golden file `addressbook.bin`
+addressbook.bin   - Protobuf encoded golden file
+addressbook.proto - Protobuf definition file
+addressbook_pb.rb - Generated Protobuf Ruby code
+```

data/test/proto/addressbook

@@ -0,0 +1 @@
+people: [{name:"Masahiro", id: 1337, email: "repeatedly _at_ gmail.com"}]

data/test/proto/addressbook.bin

@@ -0,0 +1,4 @@
+
+(
+Masahiro�
+repeatedly _at_ gmail.com

data/test/proto/addressbook.proto

@@ -0,0 +1,31 @@
+// Taken from https://github.com/protocolbuffers/protobuf/blob/32af37aa387f7480669388cad5ebbc22ec75ed8b/examples/addressbook.proto
+syntax = "proto3";
+package tutorial;
+
+import "google/protobuf/timestamp.proto";
+
+message Person {
+  string name = 1;
+  int32 id = 2;  // Unique ID number for this person.
+  string email = 3;
+
+  enum PhoneType {
+    MOBILE = 0;
+    HOME = 1;
+    WORK = 2;
+  }
+
+  message PhoneNumber {
+    string number = 1;
+    PhoneType type = 2;
+  }
+
+  repeated PhoneNumber phones = 4;
+
+  google.protobuf.Timestamp last_updated = 5;
+}
+
+// Our address book file is just one of these.
+message AddressBook {
+  repeated Person people = 1;
+}

data/test/proto/addressbook_pb.rb

@@ -0,0 +1,36 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: addressbook.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("addressbook.proto", :syntax => :proto3) do
+    add_message "tutorial.Person" do
+      optional :name, :string, 1
+      optional :id, :int32, 2
+      optional :email, :string, 3
+      repeated :phones, :message, 4, "tutorial.Person.PhoneNumber"
+      optional :last_updated, :message, 5, "google.protobuf.Timestamp"
+    end
+    add_message "tutorial.Person.PhoneNumber" do
+      optional :number, :string, 1
+      optional :type, :enum, 2, "tutorial.Person.PhoneType"
+    end
+    add_enum "tutorial.Person.PhoneType" do
+      value :MOBILE, 0
+      value :HOME, 1
+      value :WORK, 2
+    end
+    add_message "tutorial.AddressBook" do
+      repeated :people, :message, 1, "tutorial.Person"
+    end
+  end
+end
+
+module Tutorial
+  Person = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("tutorial.Person").msgclass
+  Person::PhoneNumber = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("tutorial.Person.PhoneNumber").msgclass
+  Person::PhoneType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("tutorial.Person.PhoneType").enummodule
+  AddressBook = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("tutorial.AddressBook").msgclass
+end