test/syslog/test_syslog_logger.rb

   1 # coding: US-ASCII
   2 # frozen_string_literal: false
   3 require 'test/unit'
   4 require 'tempfile'
   5 begin
   6   require 'syslog/logger'
   7 rescue LoadError
   8   # skip.  see the bottom of this file.
   9 end
  10
  11 # These tests ensure Syslog::Logger works like Logger
  12
  13 class TestSyslogRootLogger < Test::Unit::TestCase
  14
  15   module MockSyslog
  16
  17     PRIMASK = Syslog::Level.constants.inject(0) { |mask, name| mask | Syslog::Level.const_get(name) }
  18
  19     LEVEL_LABEL_MAP = {
  20       Syslog::LOG_ALERT   => 'ALERT',
  21       Syslog::LOG_ERR     => 'ERR',
  22       Syslog::LOG_WARNING => 'WARNING',
  23       Syslog::LOG_NOTICE  => 'NOTICE',
  24       Syslog::LOG_INFO    => 'INFO',
  25       Syslog::LOG_DEBUG   => 'DEBUG'
  26     }
  27
  28     @facility = Syslog::LOG_USER
  29
  30     class << self
  31
  32       attr_reader :facility
  33       attr_reader :line
  34       attr_reader :program_name
  35
  36       def log(priority, format, *args)
  37         level = priority & PRIMASK
  38         @line = "<#{priority}> #{LEVEL_LABEL_MAP[level]} - #{format % args}"
  39       end
  40
  41       def open(program_name)
  42         @program_name = program_name
  43       end
  44
  45       def reset
  46         @line = ''
  47       end
  48
  49     end
  50   end
  51
  52   Syslog::Logger.syslog = MockSyslog
  53
  54   LEVEL_LABEL_MAP = {
  55     Logger::DEBUG => 'DEBUG',
  56     Logger::INFO => 'INFO',
  57     Logger::WARN => 'WARN',
  58     Logger::ERROR => 'ERROR',
  59     Logger::FATAL => 'FATAL',
  60     Logger::UNKNOWN => 'ANY',
  61   }
  62
  63   def setup
  64     @logger = Logger.new(nil)
  65   end
  66
  67   class Log
  68     attr_reader :line, :label, :datetime, :pid, :severity, :progname, :msg
  69     def initialize(line)
  70       @line = line
  71       /\A(\w+), \[([^#]*)#(\d+)\]\s+(\w+) -- (\w*): ([\x0-\xff]*)/ =~ @line
  72       @label, @datetime, @pid, @severity, @progname, @msg = $1, $2, $3, $4, $5, $6
  73     end
  74   end
  75
  76   def log_add(severity, msg, progname = nil, &block)
  77     log(:add, severity, msg, progname, &block)
  78   end
  79
  80   def log(msg_id, *arg, &block)
  81     Log.new(log_raw(msg_id, *arg, &block))
  82   end
  83
  84   def log_raw(msg_id, *arg, &block)
  85     Tempfile.create(File.basename(__FILE__) + '.log') {|logdev|
  86       @logger.instance_eval { @logdev = Logger::LogDevice.new(logdev) }
  87       assert_equal true, @logger.__send__(msg_id, *arg, &block)
  88       logdev.rewind
  89       logdev.read
  90     }
  91   end
  92
  93   def test_initialize
  94     assert_equal Logger::DEBUG, @logger.level
  95   end
  96
  97   def test_custom_formatter
  98     @logger.formatter = Class.new {
  99       def call severity, time, progname, msg
 100         "hi mom!"
 101       end
 102     }.new
 103
 104     assert_match(/hi mom!/, log_raw(:fatal, 'fatal level message'))
 105   end
 106
 107   def test_add
 108     msg = log_add nil,           'unknown level message' # nil == unknown
 109     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 110
 111     msg = log_add Logger::FATAL, 'fatal level message'
 112     assert_equal LEVEL_LABEL_MAP[Logger::FATAL],   msg.severity
 113
 114     msg = log_add Logger::ERROR, 'error level message'
 115     assert_equal LEVEL_LABEL_MAP[Logger::ERROR],   msg.severity
 116
 117     msg = log_add Logger::WARN,  'warn level message'
 118     assert_equal LEVEL_LABEL_MAP[Logger::WARN],    msg.severity
 119
 120     msg = log_add Logger::INFO,  'info level message'
 121     assert_equal LEVEL_LABEL_MAP[Logger::INFO],    msg.severity
 122
 123     msg = log_add Logger::DEBUG, 'debug level message'
 124     assert_equal LEVEL_LABEL_MAP[Logger::DEBUG],   msg.severity
 125   end
 126
 127   def test_add_level_unknown
 128     @logger.level = Logger::UNKNOWN
 129
 130     msg = log_add nil,           'unknown level message' # nil == unknown
 131     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 132
 133     msg = log_add Logger::FATAL, 'fatal level message'
 134     assert_equal '', msg.line
 135
 136     msg = log_add Logger::ERROR, 'error level message'
 137     assert_equal '', msg.line
 138
 139     msg = log_add Logger::WARN,  'warn level message'
 140     assert_equal '', msg.line
 141
 142     msg = log_add Logger::INFO,  'info level message'
 143     assert_equal '', msg.line
 144
 145     msg = log_add Logger::DEBUG, 'debug level message'
 146     assert_equal '', msg.line
 147   end
 148
 149   def test_add_level_fatal
 150     @logger.level = Logger::FATAL
 151
 152     msg = log_add nil,           'unknown level message' # nil == unknown
 153     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 154
 155     msg = log_add Logger::FATAL, 'fatal level message'
 156     assert_equal LEVEL_LABEL_MAP[Logger::FATAL],   msg.severity
 157
 158     msg = log_add Logger::ERROR, 'error level message'
 159     assert_equal '', msg.line
 160
 161     msg = log_add Logger::WARN,  'warn level message'
 162     assert_equal '', msg.line
 163
 164     msg = log_add Logger::INFO,  'info level message'
 165     assert_equal '', msg.line
 166
 167     msg = log_add Logger::DEBUG, 'debug level message'
 168     assert_equal '', msg.line
 169   end
 170
 171   def test_add_level_error
 172     @logger.level = Logger::ERROR
 173
 174     msg = log_add nil,           'unknown level message' # nil == unknown
 175     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 176
 177     msg = log_add Logger::FATAL, 'fatal level message'
 178     assert_equal LEVEL_LABEL_MAP[Logger::FATAL],   msg.severity
 179
 180     msg = log_add Logger::ERROR, 'error level message'
 181     assert_equal LEVEL_LABEL_MAP[Logger::ERROR],   msg.severity
 182
 183     msg = log_add Logger::WARN,  'warn level message'
 184     assert_equal '', msg.line
 185
 186     msg = log_add Logger::INFO,  'info level message'
 187     assert_equal '', msg.line
 188
 189     msg = log_add Logger::DEBUG, 'debug level message'
 190     assert_equal '', msg.line
 191   end
 192
 193   def test_add_level_warn
 194     @logger.level = Logger::WARN
 195
 196     msg = log_add nil,           'unknown level message' # nil == unknown
 197     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 198
 199     msg = log_add Logger::FATAL, 'fatal level message'
 200     assert_equal LEVEL_LABEL_MAP[Logger::FATAL],   msg.severity
 201
 202     msg = log_add Logger::ERROR, 'error level message'
 203     assert_equal LEVEL_LABEL_MAP[Logger::ERROR],   msg.severity
 204
 205     msg = log_add Logger::WARN,  'warn level message'
 206     assert_equal LEVEL_LABEL_MAP[Logger::WARN],   msg.severity
 207
 208     msg = log_add Logger::INFO,  'info level message'
 209     assert_equal '', msg.line
 210
 211     msg = log_add Logger::DEBUG, 'debug level message'
 212     assert_equal '', msg.line
 213   end
 214
 215   def test_add_level_info
 216     @logger.level = Logger::INFO
 217
 218     msg = log_add nil,           'unknown level message' # nil == unknown
 219     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 220
 221     msg = log_add Logger::FATAL, 'fatal level message'
 222     assert_equal LEVEL_LABEL_MAP[Logger::FATAL],   msg.severity
 223
 224     msg = log_add Logger::ERROR, 'error level message'
 225     assert_equal LEVEL_LABEL_MAP[Logger::ERROR],   msg.severity
 226
 227     msg = log_add Logger::WARN,  'warn level message'
 228     assert_equal LEVEL_LABEL_MAP[Logger::WARN],    msg.severity
 229
 230     msg = log_add Logger::INFO,  'info level message'
 231     assert_equal LEVEL_LABEL_MAP[Logger::INFO],    msg.severity
 232
 233     msg = log_add Logger::DEBUG, 'debug level message'
 234     assert_equal '', msg.line
 235   end
 236
 237   def test_add_level_debug
 238     @logger.level = Logger::DEBUG
 239
 240     msg = log_add nil,           'unknown level message' # nil == unknown
 241     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 242
 243     msg = log_add Logger::FATAL, 'fatal level message'
 244     assert_equal LEVEL_LABEL_MAP[Logger::FATAL],   msg.severity
 245
 246     msg = log_add Logger::ERROR, 'error level message'
 247     assert_equal LEVEL_LABEL_MAP[Logger::ERROR],   msg.severity
 248
 249     msg = log_add Logger::WARN,  'warn level message'
 250     assert_equal LEVEL_LABEL_MAP[Logger::WARN],    msg.severity
 251
 252     msg = log_add Logger::INFO,  'info level message'
 253     assert_equal LEVEL_LABEL_MAP[Logger::INFO],    msg.severity
 254
 255     msg = log_add Logger::DEBUG, 'debug level message'
 256     assert_equal LEVEL_LABEL_MAP[Logger::DEBUG],   msg.severity
 257   end
 258
 259   def test_unknown
 260     msg = log :unknown, 'unknown level message'
 261     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 262
 263     @logger.level = Logger::UNKNOWN
 264     msg = log :unknown, 'unknown level message'
 265     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 266
 267     @logger.level = Logger::FATAL
 268     msg = log :unknown, 'unknown level message'
 269     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 270
 271     @logger.level = Logger::ERROR
 272     msg = log :unknown, 'unknown level message'
 273     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 274
 275     @logger.level = Logger::WARN
 276     msg = log :unknown, 'unknown level message'
 277     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 278
 279     @logger.level = Logger::INFO
 280     msg = log :unknown, 'unknown level message'
 281     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 282
 283     @logger.level = Logger::DEBUG
 284     msg = log :unknown, 'unknown level message'
 285     assert_equal LEVEL_LABEL_MAP[Logger::UNKNOWN], msg.severity
 286   end
 287
 288   def test_fatal
 289     msg = log :fatal, 'fatal level message'
 290     assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
 291
 292     @logger.level = Logger::UNKNOWN
 293     msg = log :fatal, 'fatal level message'
 294     assert_equal '', msg.line
 295
 296     @logger.level = Logger::FATAL
 297     msg = log :fatal, 'fatal level message'
 298     assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
 299
 300     @logger.level = Logger::ERROR
 301     msg = log :fatal, 'fatal level message'
 302     assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
 303
 304     @logger.level = Logger::WARN
 305     msg = log :fatal, 'fatal level message'
 306     assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
 307
 308     @logger.level = Logger::INFO
 309     msg = log :fatal, 'fatal level message'
 310     assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
 311
 312     @logger.level = Logger::DEBUG
 313     msg = log :fatal, 'fatal level message'
 314     assert_equal LEVEL_LABEL_MAP[Logger::FATAL], msg.severity
 315   end
 316
 317   def test_fatal_eh
 318     @logger.level = Logger::FATAL
 319     assert_equal true, @logger.fatal?
 320
 321     @logger.level = Logger::UNKNOWN
 322     assert_equal false, @logger.fatal?
 323   end
 324
 325   def test_error
 326     msg = log :error, 'error level message'
 327     assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
 328
 329     @logger.level = Logger::UNKNOWN
 330     msg = log :error, 'error level message'
 331     assert_equal '', msg.line
 332
 333     @logger.level = Logger::FATAL
 334     msg = log :error, 'error level message'
 335     assert_equal '', msg.line
 336
 337     @logger.level = Logger::ERROR
 338     msg = log :error, 'error level message'
 339     assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
 340
 341     @logger.level = Logger::WARN
 342     msg = log :error, 'error level message'
 343     assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
 344
 345     @logger.level = Logger::INFO
 346     msg = log :error, 'error level message'
 347     assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
 348
 349     @logger.level = Logger::DEBUG
 350     msg = log :error, 'error level message'
 351     assert_equal LEVEL_LABEL_MAP[Logger::ERROR], msg.severity
 352   end
 353
 354   def test_error_eh
 355     @logger.level = Logger::ERROR
 356     assert_equal true, @logger.error?
 357
 358     @logger.level = Logger::FATAL
 359     assert_equal false, @logger.error?
 360   end
 361
 362   def test_warn
 363     msg = log :warn, 'warn level message'
 364     assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
 365
 366     @logger.level = Logger::UNKNOWN
 367     msg = log :warn, 'warn level message'
 368     assert_equal '', msg.line
 369
 370     @logger.level = Logger::FATAL
 371     msg = log :warn, 'warn level message'
 372     assert_equal '', msg.line
 373
 374     @logger.level = Logger::ERROR
 375     msg = log :warn, 'warn level message'
 376     assert_equal '', msg.line
 377
 378     @logger.level = Logger::WARN
 379     msg = log :warn, 'warn level message'
 380     assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
 381
 382     @logger.level = Logger::INFO
 383     msg = log :warn, 'warn level message'
 384     assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
 385
 386     @logger.level = Logger::DEBUG
 387     msg = log :warn, 'warn level message'
 388     assert_equal LEVEL_LABEL_MAP[Logger::WARN], msg.severity
 389   end
 390
 391   def test_warn_eh
 392     @logger.level = Logger::WARN
 393     assert_equal true, @logger.warn?
 394
 395     @logger.level = Logger::ERROR
 396     assert_equal false, @logger.warn?
 397   end
 398
 399   def test_info
 400     msg = log :info, 'info level message'
 401     assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
 402
 403     @logger.level = Logger::UNKNOWN
 404     msg = log :info, 'info level message'
 405     assert_equal '', msg.line
 406
 407     @logger.level = Logger::FATAL
 408     msg = log :info, 'info level message'
 409     assert_equal '', msg.line
 410
 411     @logger.level = Logger::ERROR
 412     msg = log :info, 'info level message'
 413     assert_equal '', msg.line
 414
 415     @logger.level = Logger::WARN
 416     msg = log :info, 'info level message'
 417     assert_equal '', msg.line
 418
 419     @logger.level = Logger::INFO
 420     msg = log :info, 'info level message'
 421     assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
 422
 423     @logger.level = Logger::DEBUG
 424     msg = log :info, 'info level message'
 425     assert_equal LEVEL_LABEL_MAP[Logger::INFO], msg.severity
 426   end
 427
 428   def test_info_eh
 429     @logger.level = Logger::INFO
 430     assert_equal true, @logger.info?
 431
 432     @logger.level = Logger::WARN
 433     assert_equal false, @logger.info?
 434   end
 435
 436   def test_debug
 437     msg = log :debug, 'debug level message'
 438     assert_equal LEVEL_LABEL_MAP[Logger::DEBUG], msg.severity
 439
 440     @logger.level = Logger::UNKNOWN
 441     msg = log :debug, 'debug level message'
 442     assert_equal '', msg.line
 443
 444     @logger.level = Logger::FATAL
 445     msg = log :debug, 'debug level message'
 446     assert_equal '', msg.line
 447
 448     @logger.level = Logger::ERROR
 449     msg = log :debug, 'debug level message'
 450     assert_equal '', msg.line
 451
 452     @logger.level = Logger::WARN
 453     msg = log :debug, 'debug level message'
 454     assert_equal '', msg.line
 455
 456     @logger.level = Logger::INFO
 457     msg = log :debug, 'debug level message'
 458     assert_equal '', msg.line
 459
 460     @logger.level = Logger::DEBUG
 461     msg = log :debug, 'debug level message'
 462     assert_equal LEVEL_LABEL_MAP[Logger::DEBUG], msg.severity
 463   end
 464
 465   def test_debug_eh
 466     @logger.level = Logger::DEBUG
 467     assert_equal true, @logger.debug?
 468
 469     @logger.level = Logger::INFO
 470     assert_equal false, @logger.debug?
 471   end
 472
 473 end if defined?(Syslog)
 474
 475 class TestSyslogLogger < TestSyslogRootLogger
 476
 477   @facility = Syslog::LOG_USER
 478
 479   def facility
 480     self.class.instance_variable_get("@facility")
 481   end
 482
 483   def setup
 484     super
 485     @logger = Syslog::Logger.new
 486   end
 487
 488   SEVERITY_MAP = {}.tap { |map|
 489     level2severity = Syslog::Logger::LEVEL_MAP.invert
 490
 491     MockSyslog::LEVEL_LABEL_MAP.each { |level, name|
 492       map[name] = TestSyslogRootLogger::LEVEL_LABEL_MAP[level2severity[level]]
 493     }
 494   }
 495
 496   class Log
 497     attr_reader :line, :label, :datetime, :pid, :severity, :progname, :msg, :priority
 498     def initialize(line)
 499       @line = line
 500       return unless /\A<(\d+)> (\w+) - (.*)\Z/ =~ @line
 501       priority, severity, @msg = $1, $2, $3
 502       @severity = SEVERITY_MAP[severity]
 503       @priority = priority.to_i
 504     end
 505   end
 506
 507   def log_add(severity, msg, progname = nil, &block)
 508     log(:add, severity, msg, progname, &block)
 509   end
 510
 511   def log(msg_id, *arg, &block)
 512     Log.new(log_raw(msg_id, *arg, &block))
 513   end
 514
 515   def log_raw(msg_id, *arg, &block)
 516     assert_equal true, @logger.__send__(msg_id, *arg, &block)
 517     msg = MockSyslog.line
 518     MockSyslog.reset
 519     return msg
 520   end
 521
 522   def test_unknown_eh
 523     @logger.level = Logger::UNKNOWN
 524     assert_equal true, @logger.unknown?
 525
 526     @logger.level = Logger::UNKNOWN + 1
 527     assert_equal false, @logger.unknown?
 528   end
 529
 530   def test_facility
 531     assert_equal facility, @logger.facility
 532   end
 533
 534   def test_priority
 535     msg = log_add nil,           'unknown level message' # nil == unknown
 536     assert_equal facility|Syslog::LOG_ALERT,   msg.priority
 537
 538     msg = log_add Logger::FATAL, 'fatal level message'
 539     assert_equal facility|Syslog::LOG_ERR,     msg.priority
 540
 541     msg = log_add Logger::ERROR, 'error level message'
 542     assert_equal facility|Syslog::LOG_WARNING, msg.priority
 543
 544     msg = log_add Logger::WARN,  'warn level message'
 545     assert_equal facility|Syslog::LOG_NOTICE,  msg.priority
 546
 547     msg = log_add Logger::INFO,  'info level message'
 548     assert_equal facility|Syslog::LOG_INFO,    msg.priority
 549
 550     msg = log_add Logger::DEBUG, 'debug level message'
 551     assert_equal facility|Syslog::LOG_DEBUG,   msg.priority
 552   end
 553
 554   class CustomSyslogLogger < Syslog::Logger
 555     def level
 556       Logger::INFO
 557     end
 558   end
 559
 560   def test_overriding_level
 561     @logger = CustomSyslogLogger.new
 562     log = log_add Logger::INFO, 'msg'
 563     assert_equal 'msg', log.msg
 564
 565     log = log_add Logger::DEBUG, 'msg'
 566     assert_nil log.msg
 567   end
 568
 569 end if defined?(Syslog)
 570
 571
 572 # Create test class for each available facility
 573
 574 Syslog::Facility.constants.each do |facility_symb|
 575
 576   test_syslog_class = Class.new(TestSyslogLogger) do
 577
 578     @facility = Syslog.const_get(facility_symb)
 579
 580     def setup
 581       super
 582       @logger.facility = facility
 583     end
 584
 585   end
 586   Object.const_set("TestSyslogLogger_#{facility_symb}", test_syslog_class)
 587
 588 end if defined?(Syslog)