systemd-journal 2.0.0 → 2.1.1

data/lib/systemd/journal/writable.rb

@@ -1,5 +1,5 @@
-require 'systemd/journal/native'
-require 'systemd/journal_error'
+require "systemd/journal/native"
+require "systemd/journal_error"
 
 module Systemd
   class Journal
@@ -8,21 +8,21 @@ module Systemd
     # (https://github.com/zonque/systemd-journal.gem).
     module Writable
       # system is unusable
-      LOG_EMERG   = 0
+      LOG_EMERG = 0
       # action must be taken immediately
-      LOG_ALERT   = 1
+      LOG_ALERT = 1
       # critical conditions
-      LOG_CRIT    = 2
+      LOG_CRIT = 2
       # error conditions
-      LOG_ERR     = 3
+      LOG_ERR = 3
       # warning conditions
       LOG_WARNING = 4
       # normal but significant condition
-      LOG_NOTICE  = 5
+      LOG_NOTICE = 5
       # informational
-      LOG_INFO    = 6
+      LOG_INFO = 6
       # debug-level messages
-      LOG_DEBUG   = 7
+      LOG_DEBUG = 7
 
       # @private
       def self.included(base)
@@ -66,7 +66,7 @@ module Systemd
         #   severity of the event.
         # @param [String] message the content of the message to write.
         def print(level, message)
-          rc = Native.sd_journal_print(level, message.to_s.gsub('%', '%%'))
+          rc = Native.sd_journal_print(level, message.to_s.gsub("%", "%%"))
           raise JournalError, rc if rc < 0
         end
 
@@ -74,7 +74,7 @@ module Systemd
         # @param [Hash] contents the set of key-value pairs defining the event.
         def message(contents)
           items = contents.flat_map do |k, v|
-            value = v.to_s.gsub('%', '%%')
+            value = v.to_s.gsub("%", "%%")
             [:string, "#{k.to_s.upcase}=#{value}"]
           end
           # add a null pointer to terminate the varargs

data/lib/systemd/journal.rb

@@ -1,17 +1,17 @@
-require 'systemd/journal/version'
-require 'systemd/journal/native'
-require 'systemd/journal/flags'
-require 'systemd/journal/writable'
-require 'systemd/journal/fields'
-require 'systemd/journal/navigable'
-require 'systemd/journal/filterable'
-require 'systemd/journal/waitable'
-require 'systemd/journal/shim'
-require 'systemd/journal_error'
-require 'systemd/journal_entry'
-require 'systemd/id128'
-require 'systemd/ffi_size_t'
-require 'systemd'
+require "systemd/journal/version"
+require "systemd/journal/native"
+require "systemd/journal/flags"
+require "systemd/journal/writable"
+require "systemd/journal/fields"
+require "systemd/journal/navigable"
+require "systemd/journal/filterable"
+require "systemd/journal/waitable"
+require "systemd/journal/shim"
+require "systemd/journal_error"
+require "systemd/journal_entry"
+require "systemd/id128"
+require "systemd/ffi_size_t"
+require "systemd"
 
 module Systemd
   # Class to allow interacting with the systemd journal.
@@ -26,11 +26,14 @@ module Systemd
     include Systemd::Journal::Filterable
     include Systemd::Journal::Waitable
 
+    # Returns the iterations to auto reopen
+    attr_reader :auto_reopen
+
     # Returns a new instance of a Journal, opened with the provided options.
     # @param [Hash] opts optional initialization parameters.
     # @option opts [Integer] :flags a set of bitwise OR-ed
     #   {Systemd::Journal::Flags} which control what journal files are opened.
-    #   Defaults to `0`, meaning all journals avaiable to the current user.
+    #   Defaults to `0`, meaning all journals available to the current user.
     # @option opts [String] :path if provided, open the journal files living
     #   in the provided directory only.  Any provided flags will be ignored
     #   since sd_journal_open_directory does not currently accept any flags.
@@ -46,9 +49,15 @@ module Systemd
     #     path: '/var/log/journal/5f5777e46c5f4131bd9b71cbed6b9abf'
     #   )
     def initialize(opts = {})
+      @reopen_options = opts.dup # retain the options for auto reopen
       open_type, flags = validate_options!(opts)
       ptr = FFI::MemoryPointer.new(:pointer, 1)
 
+      @reopen_filter_conditions = [] # retain the conditions for auto reopen
+      @auto_reopen = (opts.key?(:auto_reopen) ? opts.delete(:auto_reopen) : false)
+      if @auto_reopen
+        @auto_reopen = @auto_reopen.is_a?(Integer) ? @auto_reopen : ITERATIONS_TO_AUTO_REOPEN
+      end
       @finalize = (opts.key?(:finalize) ? opts.delete(:finalize) : true)
       rc = open_journal(open_type, ptr, opts, flags)
       raise JournalError, rc if rc < 0
@@ -62,7 +71,7 @@ module Systemd
       j = new(opts.merge(finalize: false))
       yield j
     ensure
-      j.close if j
+      j&.close
     end
 
     # Iterate over each entry in the journal, respecting the applied
@@ -88,13 +97,13 @@ module Systemd
     def read_field(field)
       len_ptr = FFI::MemoryPointer.new(:size_t, 1)
       out_ptr = FFI::MemoryPointer.new(:pointer, 1)
-      field   = field.to_s.upcase
+      field = field.to_s.upcase
       rc = Native.sd_journal_get_data(@ptr, field, out_ptr, len_ptr)
 
       raise JournalError, rc if rc < 0
 
       len = len_ptr.read_size_t
-      string_from_out_ptr(out_ptr, len).split('=', 2).last
+      string_from_out_ptr(out_ptr, len).split("=", 2).last
     end
 
     # Read the contents of all fields from the current journal entry.
@@ -121,7 +130,7 @@ module Systemd
 
       JournalEntry.new(
         results,
-        realtime_ts:  read_realtime,
+        realtime_ts: read_realtime,
         monotonic_ts: read_monotonic
       )
     end
@@ -228,6 +237,21 @@ module Systemd
       )
     end
 
+    # @private
+    def self.finalize(ptr)
+      proc { Native.sd_journal_close(ptr) unless ptr.nil? }
+    end
+
+    # @private
+    # some sd_journal_* functions return strings that we're expected to free
+    # ourselves. This function copies the string from a char* to a ruby string,
+    # frees the char*, and returns the ruby string.
+    def self.read_and_free_outstr(ptr)
+      str = ptr.read_string
+      Shim.free(ptr)
+      str
+    end
+
     private
 
     def open_journal(type, ptr, opts, flags)
@@ -239,13 +263,13 @@ module Systemd
         Native.sd_journal_open_directory(ptr, opts[:path], 0)
       when :files, :file
         files = Array(opts[type])
-        @open_target = "file#{files.one? ? '' : 's'}:#{files.join(',')}"
+        @open_target = "file#{files.one? ? "" : "s"}:#{files.join(",")}"
         Native.sd_journal_open_files(ptr, array_to_ptrs(files), 0)
       when :container
         @open_target = "container:#{opts[:container]}"
         Native.sd_journal_open_container(ptr, opts[:container], flags)
       when :local
-        @open_target = 'journal:local'
+        @open_target = "journal:local"
         Native.sd_journal_open(ptr, flags)
       else
         raise ArgumentError, "Unknown open type: #{type}"
@@ -261,7 +285,7 @@ module Systemd
     end
 
     def read_monotonic
-      out  = FFI::MemoryPointer.new(:uint64, 1)
+      out = FFI::MemoryPointer.new(:uint64, 1)
       boot = FFI::MemoryPointer.new(Systemd::Id128::Native::Id128, 1)
 
       rc = Native.sd_journal_get_monotonic_usec(@ptr, out, boot)
@@ -289,7 +313,7 @@ module Systemd
 
       if type == :container && !Native.open_container?
         raise ArgumentError,
-              'This native library version does not support opening containers'
+          "This native library version does not support opening containers"
       end
 
       flags = opts[:flags] if [:local, :container].include?(type)
@@ -298,10 +322,6 @@ module Systemd
       [type, flags]
     end
 
-    def self.finalize(ptr)
-      proc { Native.sd_journal_close(ptr) unless ptr.nil? }
-    end
-
     def enumerate_helper(enum_function)
       len_ptr = FFI::MemoryPointer.new(:size_t, 1)
       out_ptr = FFI::MemoryPointer.new(:pointer, 1)
@@ -311,20 +331,11 @@ module Systemd
       return nil if rc == 0
 
       len = len_ptr.read_size_t
-      string_from_out_ptr(out_ptr, len).split('=', 2)
+      string_from_out_ptr(out_ptr, len).split("=", 2)
     end
 
     def string_from_out_ptr(p, len)
       p.read_pointer.read_string(len)
     end
-
-    # some sd_journal_* functions return strings that we're expected to free
-    # ourselves. This function copies the string from a char* to a ruby string,
-    # frees the char*, and returns the ruby string.
-    def self.read_and_free_outstr(ptr)
-      str = ptr.read_string
-      Shim.free(ptr)
-      str
-    end
   end
 end

data/lib/systemd/journal_entry.rb

@@ -12,8 +12,8 @@ module Systemd
     #   with a given journal entry.
     def initialize(entry, context = {})
       inspect = []
-      @entry  = entry
-      @ctx    = context
+      @entry = entry
+      @ctx = context
       @fields = entry.map do |key, value|
         name = key.downcase.to_sym
         define_singleton_method(name) { value } unless respond_to?(name)
@@ -21,7 +21,7 @@ module Systemd
         inspect.push("#{name}: '#{value}'")
         name
       end
-      @inspect = inspect.join(', ')
+      @inspect = inspect.join(", ")
     end
 
     # Returns the wall-clock time that this entry was received by the journal.
@@ -43,7 +43,12 @@ module Systemd
     def method_missing(m, *args)
       # not all journal entries will have all fields.  don't raise an error
       # unless the user passed arguments.
-      super(m, *args) unless args.empty?
+      super unless args.empty?
+    end
+
+    # @private
+    def respond_to_missing?(m, include_private = false)
+      fields&.include?(m) || super
     end
 
     # Get the value of a given field in the entry, or nil if it doesn't exist
@@ -94,7 +99,7 @@ module Systemd
 
     # @private
     def inspect
-      format('#<%s:0x%016x %s>', self.class.name, object_id, @inspect)
+      format("#<%s:0x%016x %s>", self.class.name, object_id, @inspect)
     end
 
     private

data/lib/systemd/journal_error.rb

@@ -1,7 +1,7 @@
-require 'ffi'
+require "ffi"
 
 module Systemd
-  # This execption is raised whenever a sd_journal_* call returns an error.
+  # This exception is raised whenever a sd_journal_* call returns an error.
   class JournalError < StandardError
     # Returns the (positive) error number.
     attr_reader :code

data/lib/systemd-journal.rb

@@ -1,2 +1,2 @@
 # included for backwards compatibility with older versions
-require 'systemd/journal'
+require "systemd/journal"

data/lib/systemd.rb

@@ -1,4 +1,4 @@
-require 'systemd/id128'
+require "systemd/id128"
 
 module Systemd
   # See {Systemd::Id128.machine_id}.

data/spec/spec_helper.rb

@@ -1,18 +1,18 @@
-require 'rspec'
-require 'json'
-require 'simplecov'
+require "rspec"
+require "json"
+require "simplecov"
 
 module SpecHelper
   def fixture_dir
-    @path ||= File.join(File.expand_path('..', __FILE__), 'fixtures')
+    @path ||= File.join(File.expand_path("..", __FILE__), "fixtures")
   end
 
   def journal_file
-    @file ||= File.join(fixture_dir, 'test.journal')
+    @file ||= File.join(fixture_dir, "test.journal")
   end
 
   def journal_json
-    @json ||= JSON.parse(File.read(File.join(fixture_dir, 'test.json')))
+    @json ||= JSON.parse(File.read(File.join(fixture_dir, "test.json")))
   end
 
   def entry_field(index, name)
@@ -21,9 +21,9 @@ module SpecHelper
 end
 
 SimpleCov.start do
-  add_filter '.bundle/'
+  add_filter ".bundle/"
 end
-require 'systemd/journal'
+require "systemd/journal"
 
 RSpec.configure do |config|
   config.disable_monkey_patching!

data/spec/systemd/id128_spec.rb

@@ -1,14 +1,14 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe Systemd::Id128 do
   subject(:id128) { Systemd::Id128 }
 
-  describe 'machine_id' do
-    it 'should be a 128 bit hexadecimal string' do
+  describe "machine_id" do
+    it "should be a 128 bit hexadecimal string" do
       expect(id128.machine_id).to match(/[0-9a-f]{16}/)
     end
 
-    it 'should match when called twice' do
+    it "should match when called twice" do
       m1 = id128.machine_id
       m2 = id128.machine_id
       expect(m1).to eq(m2)
@@ -17,26 +17,28 @@ RSpec.describe Systemd::Id128 do
 
   # travis-ci does not boot with systemd so these cases
   # will raise exceptions.
-  context 'when booted under systemd' do
-    describe 'boot_id' do
-      it 'should be a 128 bit hexadecimal string' do
-        expect(id128.boot_id).to match(/[0-9a-f]{16}/)
-      end
+  unless ENV["TRAVIS"]
+    context "when booted under systemd" do
+      describe "boot_id" do
+        it "should be a 128 bit hexadecimal string" do
+          expect(id128.boot_id).to match(/[0-9a-f]{16}/)
+        end
 
-      it 'should match when called twice' do
-        b1 = id128.boot_id
-        b2 = id128.boot_id
-        expect(b1).to eq(b2)
+        it "should match when called twice" do
+          b1 = id128.boot_id
+          b2 = id128.boot_id
+          expect(b1).to eq(b2)
+        end
       end
     end
-  end unless ENV['TRAVIS']
+  end
 
-  describe 'random' do
-    it 'should be a 128 bit hexadecimal string' do
+  describe "random" do
+    it "should be a 128 bit hexadecimal string" do
       expect(id128.random).to match(/[0-9a-f]{16}/)
     end
 
-    it 'should return a different value when called again' do
+    it "should return a different value when called again" do
       r1 = id128.random
       r2 = id128.random
       expect(r1).to_not eq(r2)

data/spec/systemd/journal_entry_spec.rb

@@ -1,81 +1,81 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe Systemd::JournalEntry do
-  let(:msg)       { 'test message' }
-  let(:pid)       { '123' }
-  let(:hash)      { { '_PID' => pid, 'MESSAGE' => msg } }
+  let(:msg) { "test message" }
+  let(:pid) { "123" }
+  let(:hash) { {"_PID" => pid, "MESSAGE" => msg} }
   subject(:entry) { Systemd::JournalEntry.new(hash) }
 
-  describe 'initialize' do
-    it 'takes a hash as an argument' do
+  describe "initialize" do
+    it "takes a hash as an argument" do
       expect { Systemd::JournalEntry.new(hash) }.to_not raise_error
     end
   end
 
-  describe '[]' do
-    it 'accepts symbols as a field name' do
+  describe "[]" do
+    it "accepts symbols as a field name" do
       expect(entry[:message]).to eq(msg)
     end
 
-    it 'accepts strings as a field name' do
-      expect(entry['message']).to eq(msg)
+    it "accepts strings as a field name" do
+      expect(entry["message"]).to eq(msg)
     end
 
-    it 'doesnt care about case' do
-      expect(entry['MeSSage']).to eq(msg)
+    it "doesnt care about case" do
+      expect(entry["MeSSage"]).to eq(msg)
     end
 
-    it 'returns nil if not found' do
-      expect(entry['missing']).to be nil
+    it "returns nil if not found" do
+      expect(entry["missing"]).to be nil
     end
   end
 
-  describe 'each' do
-    it 'is chainable as an enumerator' do
+  describe "each" do
+    it "is chainable as an enumerator" do
       expect(entry.each.class).to be(Enumerator)
     end
 
-    it 'yields each key/value in turn' do
+    it "yields each key/value in turn" do
       items = entry.map { |k, v| [k, v] }
-      expect(items).to eq([['_PID', pid], ['MESSAGE', msg]])
+      expect(items).to eq([["_PID", pid], ["MESSAGE", msg]])
     end
   end
 
-  describe 'to_h' do
-    it 'returns a deep copy of the entry' do
+  describe "to_h" do
+    it "returns a deep copy of the entry" do
       copy = subject.to_h
       expect(copy).to eq(hash)
-      expect { copy['_PID'] << '3' }.to_not change { subject._pid }
+      expect { copy["_PID"] << "3" }.to_not change { subject._pid }
     end
   end
 
-  describe 'catalog' do
-    context 'without a catalog' do
-      it 'returns nil if the entry has no catalog' do
+  describe "catalog" do
+    context "without a catalog" do
+      it "returns nil if the entry has no catalog" do
         expect(entry.catalog).to be nil
       end
     end
 
-    context 'with a catalog' do
-      let(:catalog) { 'Process @_PID@ said @MESSAGE@' }
+    context "with a catalog" do
+      let(:catalog) { "Process @_PID@ said @MESSAGE@" }
       subject(:entry) do
-        Systemd::JournalEntry.new(hash.merge(message_id: '123'))
+        Systemd::JournalEntry.new(hash.merge(message_id: "123"))
       end
 
       before(:each) do
         allow(Systemd::Journal).to receive(:catalog_for).and_return(catalog)
       end
 
-      it 'does field substitution by default' do
-        expect(entry.catalog).to eq('Process 123 said test message')
+      it "does field substitution by default" do
+        expect(entry.catalog).to eq("Process 123 said test message")
       end
 
-      it 'does field substitution when requested' do
+      it "does field substitution when requested" do
         expect(entry.catalog(replace: true))
-          .to eq('Process 123 said test message')
+          .to eq("Process 123 said test message")
       end
 
-      it 'skips field substition if requested' do
+      it "skips field substitution if requested" do
         expect(entry.catalog(replace: false)).to eq(catalog)
       end
     end