log-courier 2.7.2 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c318bee7d97ff215d852e8980301665d48d8b81a17f6806e2ecbaaa596d9e43f
-  data.tar.gz: ad52cced8f9dad919a2521395db9fb442bb0535fed9b54ac555f9c140e70f917
+  metadata.gz: bbafa32351f4513cd8863a25bfbeeca97497d2b148f2350baf598f595205dffe
+  data.tar.gz: dddd5573b4d3908e0028652598ace3948bb0c516b2844c2d670940ad16f470cf
 SHA512:
-  metadata.gz: 200421b7dae625c4cdd88bc08197a32db9f50248a2e661af785ebae47d84fdacde97413d8c67189fa3047c2611786e0a3fdc28d56547cc87c047c4e644f38cea
-  data.tar.gz: 9ca5c1ef8145659c92a17d9ff0671ac2cc14900ef8d0a052f330055c1c4c55595065a37e0be045642fcd061c029206302f716df2e48012584720fd3622abac60
+  metadata.gz: 8ffa4c359125610432621adb716a6e25ef5c510436ff5a4d3501423815c8a5dbcf7873e4351fe30465110de37f422118f08dbd85d462f60829f4cbdcd3b5d33e
+  data.tar.gz: b10e56daebac839e8f320cd947ac04785154ec493e48efaa0228752412cb4e0728f75159a863fe4dbcc251dca9c8e2c7bf43e6755bb45b14436aad9b83bbcaa2

data/lib/log-courier/client.rb

@@ -17,14 +17,10 @@
 
 require 'log-courier/event_queue'
 require 'log-courier/protocol'
+require 'log-courier/version'
 require 'multi_json'
 require 'zlib'
 
-# Dummy until its no longer needed
-class NativeException
-  def dummy; end
-end
-
 module LogCourier
   class TimeoutError < StandardError; end
 
@@ -349,7 +345,7 @@ module LogCourier
       @logger&.warn 'Timeout occurred'
     rescue ShutdownSignal
       raise
-    rescue StandardError, NativeException => e
+    rescue StandardError => e
       # Unknown error occurred
       @logger&.warn e, hint: 'Unknown error'
     end

data/lib/log-courier/client_tcp.rb

@@ -35,12 +35,12 @@ module LogCourier
 
       @logger = @options[:logger]
 
-      [:port, :ssl_ca].each do |k|
-        raise "output/courier: '#{k}' is required" if @options[k].nil?
-      end
+      raise "output/courier: 'port' is required" if @options[:port].nil?
 
       return unless @options[:transport] == 'tls'
 
+      raise "output/courier: 'ssl_ca' is required if 'transport' is 'tls'" if @options[:ssl_ca].nil?
+
       c = 0
       [:ssl_certificate, :ssl_key].each do
         c += 1
@@ -71,7 +71,7 @@ module LogCourier
         run_send io_control
       rescue ShutdownSignal
         # Shutdown
-      rescue StandardError, NativeException => e # Can remove NativeException after 9.2.14.0 JRuby
+      rescue StandardError => e
         @logger&.warn e, hint: 'Unknown write error'
         io_control << ['F']
       end
@@ -79,7 +79,7 @@ module LogCourier
         run_recv io_control
       rescue ShutdownSignal
         # Shutdown
-      rescue StandardError, NativeException => e # Can remove NativeException after 9.2.14.0 JRuby
+      rescue StandardError => e
         @logger&.warn e, hint: 'Unknown read error'
         io_control << ['F']
       end
@@ -125,7 +125,7 @@ module LogCourier
     def handshake(io_control)
       return true if @options[:disable_handshake]
 
-      @socket.write ['HELO', 20, 0, 2, 7, 2, 'RYLC'].pack('A4NNNNNA4')
+      @socket.write ['HELO', 20, 0, MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION, 'RYLC'].pack('A4NNNNNA4')
 
       signature, data = receive
       if signature != 'VERS'
@@ -140,7 +140,7 @@ module LogCourier
       @logger&.info 'Remote identified', server_version: @vers[:client_version]
 
       true
-    rescue StandardError, NativeException => e # Can remove NativeException after 9.2.14.0 JRuby
+    rescue StandardError => e
       @logger&.warn e, hint: 'Unknown write error'
       io_control << ['F']
       false
@@ -177,7 +177,7 @@ module LogCourier
     rescue OpenSSL::SSL::SSLError => e
       @logger&.warn 'SSL write error', error: e.message
       io_control << ['F']
-    rescue IOError, Errno::ECONNRESET => e
+    rescue IOError, SystemCallError => e
       @logger&.warn 'Write error', error: e.message
       io_control << ['F']
     end
@@ -195,7 +195,7 @@ module LogCourier
     rescue EOFError
       @logger&.warn 'Connection closed by server'
       io_control << ['F']
-    rescue IOError, Errno::ECONNRESET => e
+    rescue IOError, SystemCallError => e
       @logger&.warn 'Read error', error: e.message
       io_control << ['F']
     end
@@ -271,15 +271,11 @@ module LogCourier
           @logger&.info 'Connected successfully', address: address, port: port
         end
 
-        # Add extra logging data now we're connected
-        @logger['address'] = address
-        @logger['port'] = port
-
         return true
-      rescue OpenSSL::SSL::SSLError, IOError, Errno::ECONNRESET => e
+      rescue OpenSSL::SSL::SSLError, IOError, SystemCallError => e
         @logger&.warn 'Connection failed', error: e.message, address: address, port: port
-      rescue StandardError, NativeException => e # Can remove NativeException after 9.2.14.0 JRuby
-        @logger&.warn e, hint: 'Unknown connection failure', address: address, port: port
+      rescue StandardError => e
+        @logger&.warn 'Unknown connection failure', hint: e.message, address: address, port: port
       end
 
       false

data/lib/log-courier/rspec/spec_helper.rb

@@ -0,0 +1,218 @@
+# Copyright 2014-2021 Jason Woods.
+#
+# 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.
+
+require 'cabin'
+require 'fileutils'
+require 'log-courier/client'
+require 'log-courier/server'
+
+TEMP_PATH = File.join(File.dirname(__FILE__), 'tmp')
+EVENT_WAIT_COUNT = 50
+EVENT_WAIT_TIME = 0.5
+
+# Common helpers for testing both ruby client and the courier
+shared_context 'LogCourier' do
+  before :all do
+    Thread.abort_on_exception = true
+
+    FileUtils.rm_r(TEMP_PATH) if File.directory?(TEMP_PATH)
+    Dir.mkdir(TEMP_PATH)
+
+    @ssl_cert = File.open(File.join(TEMP_PATH, 'ssl_cert'), 'w')
+    @ssl_key = File.open(File.join(TEMP_PATH, 'ssl_key'), 'w')
+    @ssl_csr = File.open(File.join(TEMP_PATH, 'ssl_csr'), 'w')
+
+    # Generate the ssl key
+    cnf_path = "#{File.dirname(__FILE__)}/openssl.cnf"
+    system("openssl req -config #{cnf_path} -new -batch -keyout #{@ssl_key.path} -out #{@ssl_csr.path}")
+    system(
+      "openssl x509 -extfile #{cnf_path} -extensions extensions_section -req -days 365 -in #{@ssl_csr.path}" \
+      " -signkey #{@ssl_key.path} -out #{@ssl_cert.path}",
+    )
+  end
+
+  after :all do
+    FileUtils.rm_r(TEMP_PATH) if File.directory?(TEMP_PATH)
+  end
+
+  before :each do
+    @event_queue = SizedQueue.new 10_000
+
+    @clients = {}
+    @servers = {}
+    @server_counts = {}
+    @server_threads = {}
+  end
+
+  after :each do
+    unless @servers.length.zero?
+      id, = @servers.first
+      raise "Server was not shutdown: #{id}"
+    end
+    unless @clients.length.zero?
+      id, = @clients.first
+      raise "Client was not shutdown: #{id}"
+    end
+  end
+
+  def start_client(**args)
+    args = {
+      id: '__default__',
+      transport: 'tls',
+      addresses: ['127.0.0.1'],
+    }.merge!(**args)
+
+    args[:ssl_ca] = @ssl_cert.path if args[:transport] == 'tls'
+
+    id = args[:id]
+    args[:port] = server_port(id) unless args.key?(:port)
+
+    logger = Cabin::Channel.new
+    logger.subscribe $stdout
+    logger['instance'] = "Client #{id}"
+    logger.level = :debug
+
+    # Reset server for each test
+    @clients[id] = LogCourier::Client.new(
+      logger: logger,
+      **args,
+    )
+  end
+
+  def shutdown_client(which = nil)
+    which = if which.nil?
+              @clients.keys
+            else
+              [which]
+            end
+    which.each do |id|
+      @clients[id].shutdown
+      @clients.delete id
+    end
+    nil
+  end
+
+  def start_server(**args)
+    args = {
+      id: '__default__',
+      transport: 'tls',
+    }.merge!(**args)
+
+    if args[:transport] == 'tls'
+      args[:ssl_certificate] = @ssl_cert.path
+      args[:ssl_key] = @ssl_key.path
+    end
+
+    id = args[:id]
+
+    logger = Cabin::Channel.new
+    logger.subscribe $stdout
+    logger['instance'] = "Server #{id}"
+    logger.level = :debug
+
+    raise 'Server already initialised' if @servers.key?(id)
+
+    # Reset server for each test
+    @servers[id] = LogCourier::Server.new(
+      logger: logger,
+      **args,
+    )
+
+    @server_counts[id] = 0
+    @server_threads[id] = Thread.new do
+      @servers[id].run do |event|
+        @server_counts[id] += 1
+        @event_queue << event
+      end
+    rescue LogCourier::ShutdownSignal
+      0
+    end
+    @servers[id]
+  end
+
+  # A helper to shutdown a Log Courier server
+  def shutdown_server(which = nil)
+    which = if which.nil?
+              @servers.keys
+            else
+              [which]
+            end
+    which.each do |id|
+      @server_threads[id].raise LogCourier::ShutdownSignal
+      @server_threads[id].join
+      @server_threads.delete id
+      @server_counts.delete id
+      @servers.delete id
+    end
+    nil
+  end
+
+  # A helper to get the port a server is bound to
+  def server_port(id = '__default__')
+    @servers[id].port
+  end
+
+  # A helper to get number of events received on the server
+  def server_count(id = '__default__')
+    @server_counts[id]
+  end
+
+  def receive_and_check(args = {})
+    args = {
+      total: nil,
+      check: true,
+      check_file: true,
+      check_order: true,
+      host: nil,
+    }.merge!(args)
+
+    # Quick check of the total events we are expecting - but allow time to receive them
+    total = if args[:total].nil?
+              @files.reduce(0) do |sum, f|
+                sum + f.count
+              end
+            else
+              args[:total]
+            end
+
+    args.delete_if do |_, v|
+      v.nil?
+    end
+
+    orig_total = total
+    check = args[:check]
+
+    waited = 0
+    while total.positive? && waited <= EVENT_WAIT_COUNT
+      if @event_queue.length.zero?
+        sleep(EVENT_WAIT_TIME)
+        waited += 1
+        next
+      end
+
+      waited = 0
+      until @event_queue.length.zero?
+        e = @event_queue.pop
+        total -= 1
+        next unless check
+
+        yield e
+      end
+    end
+
+    # Fancy calculation to give a nice "expected" output of expected num of events
+    expect(orig_total - total).to eq orig_total
+    nil
+  end
+end

data/lib/log-courier/server.rb

@@ -17,14 +17,10 @@
 
 require 'log-courier/event_queue'
 require 'log-courier/protocol'
+require 'log-courier/version'
 require 'multi_json'
 require 'zlib'
 
-# NativeException in case it is missing
-class NativeException
-  def dummy; end
-end
-
 module LogCourier
   class TimeoutError < StandardError; end
 

data/lib/log-courier/server_tcp.rb

@@ -137,7 +137,7 @@ module LogCourier
         end
 
         @logger&.warn 'Ephemeral port allocated', transport: @options[:transport], port: @port if @options[:port].zero?
-      rescue StandardError, NativeException => e # Until Jruby updated we need NativeException
+      rescue StandardError => e
         raise "input/courier: Failed to initialise: #{e}"
       end
     end
@@ -178,7 +178,7 @@ module LogCourier
       nil
     rescue ShutdownSignal
       nil
-    rescue StandardError, NativeException => e # Can remove NativeException after 9.2.14.0 JRuby
+    rescue StandardError => e
       # Some other unknown problem
       @logger&.warn e.message, hint: 'Unknown error, shutting down'
       nil
@@ -275,7 +275,7 @@ module LogCourier
       # Read errors, only action is to shutdown which we'll do in ensure
       @logger&.warn 'SSL error, connection aborted', error: e.message, peer: @peer
       nil
-    rescue IOError, Errno::ECONNRESET => e
+    rescue IOError, SystemCallError => e
       # Read errors, only action is to shutdown which we'll do in ensure
       @logger&.warn 'Connection aborted', error: e.message, peer: @peer
       nil
@@ -287,14 +287,14 @@ module LogCourier
       # Shutting down
       @logger&.info 'Server shutting down, closing connection', peer: @peer
       nil
-    rescue StandardError, NativeException => e # Can remove NativeException after 9.2.14.0 JRuby
+    rescue StandardError => e
       # Some other unknown problem
       @logger&.warn e.message, hint: 'Unknown error, connection aborted', peer: @peer
       nil
     ensure
       begin
         @fd.close
-      rescue OpenSSL::SSL::SSLError, IOError, NativeException
+      rescue OpenSSL::SSL::SSLError, IOError
         # Ignore during close
       end
     end
@@ -376,7 +376,7 @@ module LogCourier
       # Minor Version 4 bytes
       # Patch Version 4 bytes
       # Client String 4 bytes
-      data = [0, 2, 7, 2, 'RYLC'].pack('NNNNA4')
+      data = [0, MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION, 'RYLC'].pack('NNNNA4')
       send 'VERS', data
     end
 

data/lib/log-courier/version.rb

@@ -0,0 +1,7 @@
+# Version of LogCourier
+module LogCourier
+  MAJOR_VERSION = 2
+  MINOR_VERSION = 9
+  PATCH_VERSION = 1
+  VERSION = '2.9.1'.freeze
+end

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: log-courier
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.9.1
 platform: ruby
 authors:
 - Jason Woods
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2022-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: cabin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-  name: cabin
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -25,12 +25,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-  name: multi_json
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,9 +49,11 @@ files:
 - lib/log-courier/client_tcp.rb
 - lib/log-courier/event_queue.rb
 - lib/log-courier/protocol.rb
+- lib/log-courier/rspec/spec_helper.rb
 - lib/log-courier/server.rb
 - lib/log-courier/server_tcp.rb
-homepage: https://github.com/driskell/ruby-log-courier
+- lib/log-courier/version.rb
+homepage: https://github.com/driskell/log-courier
 licenses:
 - Apache-2.0
 metadata: {}
@@ -70,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby implementation of the Courier protocol