rubysl-syslog 1.0.0

data/spec/alert_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../shared/log', __FILE__)
+require 'syslog'
+
+describe "Syslog.alert" do
+  it_behaves_like :syslog_log, :alert
+end

data/spec/close_spec.rb

@@ -0,0 +1,54 @@
+require 'syslog'
+
+describe "Syslog.close" do
+  platform_is_not :windows do
+
+    before :each do
+      Syslog.opened?.should be_false
+    end
+
+    after :each do
+      Syslog.opened?.should be_false
+    end
+
+    it "closes the log" do
+      Syslog.opened?.should be_false
+      Syslog.open
+      Syslog.opened?.should be_true
+      Syslog.close
+      Syslog.opened?.should be_false
+    end
+
+    it "raises a RuntimeError if the log's already closed" do
+      lambda { Syslog.close }.should raise_error(RuntimeError)
+    end
+
+    it "it does not work inside blocks" do
+      lambda {
+        Syslog.open { |s| s.close }
+      }.should raise_error(RuntimeError)
+      Syslog.opened?.should == false
+    end
+
+    it "sets the identity to nil" do
+      Syslog.open("rubyspec")
+      Syslog.ident.should == "rubyspec"
+      Syslog.close
+      Syslog.ident.should be_nil
+    end
+
+    it "sets the options to nil" do
+      Syslog.open("rubyspec", Syslog::LOG_PID)
+      Syslog.options.should == Syslog::LOG_PID
+      Syslog.close
+      Syslog.options.should == nil
+    end
+
+    it "sets the facility to nil" do
+      Syslog.open
+      Syslog.facility.should == 8
+      Syslog.close
+      Syslog.facility.should == nil
+    end
+  end
+end

data/spec/constants_spec.rb

@@ -0,0 +1,54 @@
+require 'syslog'
+
+describe "Syslog::Constants" do
+  platform_is_not :windows do
+
+    before :all do
+
+    @constants = %w(LOG_AUTHPRIV LOG_USER LOG_LOCAL2 LOG_NOTICE LOG_NDELAY
+                    LOG_SYSLOG LOG_ALERT LOG_FTP LOG_LOCAL5 LOG_ERR LOG_AUTH
+                    LOG_LOCAL1 LOG_ODELAY LOG_NEWS LOG_DAEMON LOG_LOCAL4
+                    LOG_CRIT LOG_INFO LOG_PERROR LOG_LOCAL0 LOG_CONS LOG_LPR
+                    LOG_LOCAL7 LOG_WARNING LOG_CRON LOG_LOCAL3 LOG_EMERG
+                    LOG_NOWAIT LOG_UUCP LOG_PID LOG_KERN LOG_MAIL LOG_LOCAL6
+                    LOG_DEBUG)
+    end
+
+    it "includes the Syslog constants" do
+      @constants.each do |c|
+        Syslog::Constants.should have_constant(c)
+      end
+    end
+
+  end
+
+  # The masks are defined in <syslog.h>
+
+  describe "Syslog::Constants.LOG_MASK" do
+    it "returns the mask value for a priority" do
+      Syslog::Constants.LOG_MASK(Syslog::LOG_DEBUG).should == 128
+      Syslog::Constants.LOG_MASK(Syslog::LOG_WARNING).should == 16
+    end
+
+    not_compliant_on :rubinius do
+      it "works on undefined constants" do
+        Syslog::Constants.LOG_MASK(1337).should == 33554432
+        Syslog::Constants.LOG_MASK(7331).should == 8
+      end
+    end
+  end
+
+  describe "Syslog::Constants.LOG_UPTO" do
+    it "returns a mask for the priorities up to a given argument" do
+      Syslog::Constants.LOG_UPTO(Syslog::LOG_ALERT).should == 3
+      Syslog::Constants.LOG_UPTO(Syslog::LOG_DEBUG).should == 255
+    end
+
+    not_compliant_on :rubinius do
+      it "works on undefined constants" do
+        Syslog::Constants.LOG_UPTO(1337).should == 67108863
+      end
+    end
+  end
+end
+

data/spec/crit_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../shared/log', __FILE__)
+require 'syslog'
+
+describe "Syslog.crit" do
+  it_behaves_like :syslog_log, :crit
+end

data/spec/debug_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../shared/log', __FILE__)
+require 'syslog'
+
+describe "Syslog.debug" do
+  it_behaves_like :syslog_log, :debug
+end

data/spec/emerg_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../shared/log', __FILE__)
+require 'syslog'
+
+describe "Syslog.emerg" do
+  # Some way needs do be found to prevent this spec
+  # from causing output on all open terminals. If this
+  # is not possible, this spec may need a special guard
+  # that only runs when requested.
+  quarantine! do
+    it_behaves_like :syslog_log, :emerg
+  end
+end

data/spec/err_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../shared/log', __FILE__)
+require 'syslog'
+
+describe "Syslog.err" do
+  it_behaves_like :syslog_log, :err
+end

data/spec/facility_spec.rb

@@ -0,0 +1,44 @@
+require 'syslog'
+
+describe "Syslog.facility" do
+  platform_is_not :windows do
+
+    before :each do
+      Syslog.opened?.should be_false
+    end
+
+    after :each do
+      Syslog.opened?.should be_false
+    end
+
+    it "returns the logging facility" do
+      Syslog.open("rubyspec", 3, Syslog::LOG_MAIL)
+      Syslog.facility.should == Syslog::LOG_MAIL
+      Syslog.close
+    end
+
+    it "returns nil if the log is closed" do
+      Syslog.opened?.should be_false
+      Syslog.facility.should == nil
+    end
+
+    it "defaults to LOG_USER" do
+      Syslog.open
+      Syslog.facility.should == Syslog::LOG_USER
+      Syslog.close
+    end
+
+    it "resets after each open call" do
+      Syslog.open
+      Syslog.facility.should == Syslog::LOG_USER
+
+      Syslog.open!("rubyspec", 3, Syslog::LOG_MAIL)
+      Syslog.facility.should == Syslog::LOG_MAIL
+      Syslog.close
+
+      Syslog.open
+      Syslog.facility.should == Syslog::LOG_USER
+      Syslog.close
+    end
+  end
+end

data/spec/ident_spec.rb

@@ -0,0 +1,31 @@
+require 'syslog'
+
+describe "Syslog.ident" do
+  platform_is_not :windows do
+
+    before :each do
+      Syslog.opened?.should be_false
+    end
+
+    after :each do
+      Syslog.opened?.should be_false
+    end
+
+    it "returns the logging identity" do
+      Syslog.open("rubyspec")
+      Syslog.ident.should == "rubyspec"
+      Syslog.close
+    end
+
+    it "returns nil if the log is closed" do
+      Syslog.opened?.should == false
+      Syslog.ident.should == nil
+    end
+
+    it "defaults to $0" do
+      Syslog.open
+      Syslog.ident.should == $0
+      Syslog.close
+    end
+  end
+end

data/spec/info_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../shared/log', __FILE__)
+require 'syslog'
+
+describe "Syslog.info" do
+  it_behaves_like :syslog_log, :info
+end

data/spec/inspect_spec.rb

@@ -0,0 +1,35 @@
+require 'syslog'
+
+describe "Syslog.inspect" do
+  platform_is_not :windows do
+
+    before :each do
+      Syslog.opened?.should be_false
+    end
+
+    after :each do
+      Syslog.opened?.should be_false
+    end
+
+    it "returns a string a closed log" do
+      Syslog.inspect.should =~ /opened=false/
+    end
+
+    it "returns a string for an opened log" do
+      Syslog.open
+      Syslog.inspect.should =~ /opened=true.*/
+      Syslog.close
+    end
+
+    it "includes the ident, options, facility and mask" do
+      Syslog.open("rubyspec", Syslog::LOG_PID, Syslog::LOG_USER)
+      inspect_str = Syslog.inspect.split ", "
+      inspect_str[0].should =~ /opened=true/
+      inspect_str[1].should == "ident=\"rubyspec\""
+      inspect_str[2].should == "options=#{Syslog::LOG_PID}"
+      inspect_str[3].should == "facility=#{Syslog::LOG_USER}"
+      inspect_str[4].should == "mask=255>"
+      Syslog.close
+    end
+  end
+end

data/spec/instance_spec.rb

@@ -0,0 +1,9 @@
+require 'syslog'
+
+describe "Syslog.instance" do
+  platform_is_not :windows do
+    it "returns the module" do
+      Syslog.instance.should == Syslog
+    end
+  end
+end

data/spec/log_spec.rb

@@ -0,0 +1,52 @@
+require 'syslog'
+
+describe "Syslog.log" do
+  platform_is_not [:windows, :darwin] do
+
+    before :each do
+      Syslog.opened?.should be_false
+    end
+
+    after :each do
+      Syslog.opened?.should be_false
+    end
+
+    it "receives a priority as first argument" do
+      lambda {
+        Syslog.open("rubyspec", Syslog::LOG_PERROR) do |s|
+          s.log(Syslog::LOG_ALERT, "Hello")
+          s.log(Syslog::LOG_CRIT, "World")
+        end
+      }.should output_to_fd("rubyspec: Hello\nrubyspec: World\n", $stderr)
+    end
+
+    it "accepts undefined priorites" do
+      lambda {
+        Syslog.open("rubyspec", Syslog::LOG_PERROR) do |s|
+          s.log(1337, "Hello")
+        end
+        # use a regex since it'll output unknown facility/priority messages
+      }.should output_to_fd(/rubyspec: Hello/, $stderr)
+    end
+
+    it "fails with TypeError on nil log messages" do
+      Syslog.open do |s|
+        lambda { s.log(1, nil) }.should raise_error(TypeError)
+      end
+    end
+
+    it "fails if the log is closed" do
+      lambda {
+        Syslog.log(Syslog::LOG_ALERT, "test")
+      }.should raise_error(RuntimeError)
+    end
+
+    it "accepts printf parameters" do
+      lambda {
+        Syslog.open("rubyspec", Syslog::LOG_PERROR) do |s|
+          s.log(Syslog::LOG_ALERT, "%s x %d", "chunky bacon", 2)
+        end
+      }.should output_to_fd("rubyspec: chunky bacon x 2\n", $stderr)
+    end
+  end
+end

data/spec/mask_spec.rb

@@ -0,0 +1,129 @@
+require 'syslog'
+
+describe "Syslog.mask" do
+  platform_is_not :windows do
+
+    before :each do
+      Syslog.opened?.should be_false
+    end
+
+    after :each do
+      Syslog.opened?.should be_false
+    end
+
+    # make sure we return the mask to the default value
+    after :all do
+      Syslog.open { |s| s.mask = 255 }
+    end
+
+    it "returns the log priority mask" do
+      Syslog.open("rubyspec") do
+        Syslog.mask.should == 255
+        Syslog.mask = 3
+        Syslog.mask.should == 3
+        Syslog.mask = 255
+      end
+    end
+
+    it "defaults to 255" do
+      Syslog.open do |s|
+        s.mask.should == 255
+      end
+    end
+
+    it "returns nil if the log is closed" do
+      Syslog.opened?.should == false
+      Syslog.mask.should == nil
+    end
+
+    platform_is :darwin do
+      it "resets if the log is reopened" do
+        Syslog.open
+        Syslog.mask.should == 255
+        Syslog.mask = 64
+
+        Syslog.reopen("rubyspec") do
+          Syslog.mask.should == 255
+        end
+
+        Syslog.open do
+          Syslog.mask.should == 255
+        end
+      end
+    end
+
+    platform_is_not :darwin do
+      it "persists if the log is reopened" do
+        Syslog.open
+        Syslog.mask.should == 255
+        Syslog.mask = 64
+
+        Syslog.reopen("rubyspec") do
+          Syslog.mask.should == 64
+        end
+
+        Syslog.open do
+          Syslog.mask.should == 64
+        end
+      end
+    end
+  end
+end
+
+describe "Syslog.mask=" do
+  platform_is_not :windows do
+
+    before :each do
+      Syslog.opened?.should be_false
+    end
+
+    after :each do
+      Syslog.opened?.should be_false
+    end
+
+    # make sure we return the mask to the default value
+    after :all do
+      Syslog.open { |s| s.mask = 255 }
+    end
+
+    it "sets the log priority mask" do
+      Syslog.open do
+        Syslog.mask = 64
+        Syslog.mask.should == 64
+      end
+    end
+
+    it "persists if the log is reopened" do
+      Syslog.open
+      Syslog.mask = 64
+
+      Syslog.reopen("rubyspec") do
+        Syslog.mask.should == 64
+        Syslog.mask = 255
+      end
+
+      Syslog.open do
+        Syslog.mask.should == 255
+      end
+    end
+
+    it "raises an error if the log is closed" do
+      lambda { Syslog.mask = 1337 }.should raise_error(RuntimeError)
+    end
+
+    it "only accepts numbers" do
+      Syslog.open do
+
+        Syslog.mask = 1337
+        Syslog.mask.should == 1337
+
+        Syslog.mask = 3.1416
+        Syslog.mask.should == 3
+
+        lambda { Syslog.mask = "oh hai" }.should raise_error(TypeError)
+        lambda { Syslog.mask = "43" }.should raise_error(TypeError)
+
+      end
+    end
+  end
+end