1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
|
# frozen_string_literal: true
RSpec.describe Dry::Logger do
include_context "stream"
it "raises on unsupported stream type" do
expect { Dry.Logger(:test, stream: []) }.to raise_error(ArgumentError, /unsupported/)
end
context "default" do
subject(:logger) { Dry.Logger(:test, stream: stream) }
it "logs to $stdout by default using a plain text message" do
message = "hello, world"
logger.info(message)
expect(output).to match(message)
end
it "logs to $stdout by default using a plain text message and payload" do
message = "hello, world"
logger.info(message, test: true)
expect(output).to match("#{message} test=true")
end
it "logs to $stdout by default using a plain text block message" do
message = "hello, world"
logger.info { message }
expect(output).to match(message)
end
it "logs to $stdout by default using a payload block" do
logger.info { {test: true} }
expect(output).to match("test=true")
end
it "logs to $stdout by default using a plain text block message and payload" do
message = "hello, world"
logger.info(test: true) { message }
expect(output).to match("#{message} test=true")
end
it "logs to $stdout by default using a plain text message and payload block" do
message = "hello, world"
logger.info(message) { {test: true} }
expect(output).to match("#{message} test=true")
end
it "does not execute the block if severity is higher" do
logger.debug { raise }
end
end
context "using progname" do
subject(:logger) { Dry.Logger(:test, stream: stream, template: "%<progname>s: %<message>s %<payload>s") }
it "uses the logger ID as the progname" do
message = "hello, world"
logger.info(message)
expect(output).to match("test: #{message}")
end
it "replaces the default progname with the progname: keyword argument" do
message = "hello, world"
logger.info(message, progname: "newprog", test: true)
expect(output).to match("newprog: #{message} test=true")
end
it "replaces the progname with the first string argument when the message is given as a block" do
message = "hello, world"
logger.info("newprog") { message }
expect(output).to match("newprog: hello, world")
end
it "replaces the progname with the progname: keyword argument when the message is given as a block" do
message = "hello, world"
logger.info(progname: "newprog", test: true) { message }
expect(output).to match("newprog: #{message} test=true")
end
end
context "adding backends via block only" do
it "doesn't setup the default logger" do
logger = Dry.Logger(:test, stream: stream) { |setup|
setup.add_backend(formatter: :string, template: "[%<severity>s] %<message>s")
}
expect(logger.backends.size).to be(1)
logger.info "Hello World!"
expect(output).to eql("[INFO] Hello World!\n")
end
end
context "registering a custom template" do
subject(:logger) { Dry.Logger(:test, stream: stream, template: :my_details) }
before do
Dry::Logger.register_template(:my_details, "[%<severity>s] [%<time>s] %<message>s")
end
it "logs to $stdout by default using a registered template" do
message = "hello, world"
logger.info(message)
expect(output).to eql("[INFO] [2017-01-15 16:00:23 +0100] hello, world\n")
end
end
context "using external logger as backend" do
subject(:logger) { Dry.Logger(:test, stream: stream).add_backend(backend) }
context "with an stdlib logger" do
let(:backend) { Logger.new(stream) }
it "logs info messages" do
backend.formatter = -> (_, _, _, msg) { msg }
logger.info(message = "hello, world")
expect(stream).to include(message)
end
end
end
context "file" do
subject(:logger) { Dry.Logger(:test, stream: stream) }
context "relative path" do
let(:stream) { random_file_name }
context "when file doesn't exist" do
it "creates file" do
logger
expect(stream).to be_exist
logger.info(message = "newline")
expect(read(stream)).to match(message)
end
end
context "when file already exists" do
before do
generate_file(stream, existing_message)
end
let(:existing_message) { "existing" }
it "appends to file" do
logger.info(new_message = "appended")
expect(read(stream)).to match(existing_message)
expect(read(stream)).to match(new_message)
end
end
end
context "absolute path" do
let(:stream) { random_file_name(tmp: TMP) }
it "creates file" do
logger
expect(stream).to be_exist
end
end
context "log-file rotation" do
let(:stream) { random_file_name(tmp: TMP) }
let(:file_path_without_ext) { File.join(File.dirname(stream), File.basename(stream, ".*")) }
context "default" do
subject(:logger) { Dry.Logger(:test, stream: stream) }
it "does not rotate logs by default" do
2000.times { logger.info("Hello log message!") }
expect(File.exist?("#{file_path_without_ext}.log")).to be true
expect(File.exist?("#{file_path_without_ext}.log.1")).to be false
end
end
context "based on size" do
subject(:logger) { Dry.Logger(:test, stream: stream, shift_age: 3, shift_size: 10_000) }
it "rotates logs based on shift_age and shift_size" do
2000.times { logger.info("Hello log message!") }
expect(File.exist?("#{file_path_without_ext}.log")).to be true
expect(File.exist?("#{file_path_without_ext}.log.1")).to be true
expect(File.exist?("#{file_path_without_ext}.log.2")).to be false
end
end
context "based on period" do
let(:now) { Time.parse("2025-06-06 07:07:23 +0100") }
subject(:logger) { Dry.Logger(:test, stream: stream, shift_age: "daily") }
before do
# Ruby's logger reads the timestamp from the file for the base-time.
# That's why we need to mock the mtime of the file with the spec's now.
allow_any_instance_of(File::Stat).to receive(:mtime).and_return(now)
end
it "rotates logs based on period" do
logger.info("Hello log message!")
allow(Time).to receive(:now).and_return(now + (60 * 60 * 24))
logger.info("Hello log message!")
expect(File.exist?("#{file_path_without_ext}.log")).to be true
expect(File.exist?("#{file_path_without_ext}.log.20250606")).to be true
end
context "with custom suffix" do
subject(:logger) { Dry.Logger(:test, stream: stream, shift_age: "monthly", shift_period_suffix: "month%m") }
it "rotates logs based on period" do
logger.info("Hello log message!")
allow(Time).to receive(:now).and_return(now + (60 * 60 * 24 * 30))
logger.info("Hello log message!")
expect(File.exist?("#{file_path_without_ext}.log")).to be true
expect(File.exist?("#{file_path_without_ext}.log.month06")).to be true
end
end
end
end
end
context "when IO" do
subject(:logger) { Dry.Logger(:test, stream: stream) }
let(:stream) { io_stream(destination) }
let(:destination) { file_with_directory }
it "appends" do
logger.info(message = "foo")
logger.close
expect(read(destination)).to match(message)
end
end
context "when StringIO" do
subject(:logger) { Dry.Logger(:test, stream: stream) }
let(:stream) { StringIO.new }
it "appends" do
logger.info(message = "foo")
expect(read(stream)).to match(message)
end
end
context "log level" do
subject(:logger) { Dry.Logger(:test, level: level) }
it "uses INFO by default" do
expect(Dry.Logger(:test).level).to eq(Dry::Logger::INFO)
end
context "when integer" do
let(:level) { 3 }
it "translates into level" do
expect(logger.level).to eq(Dry::Logger::ERROR)
end
end
context "when integer out of boundary" do
let(:level) { 99 }
it "sets level to default" do
expect(logger.level).to eq(Dry::Logger::INFO)
end
end
context "when symbol" do
let(:level) { :error }
it "translates into level" do
expect(logger.level).to eq(Dry::Logger::ERROR)
end
end
context "when string" do
let(:level) { "error" }
it "translates into level" do
expect(logger.level).to eq(Dry::Logger::ERROR)
end
end
context "when uppercased string" do
let(:level) { "ERROR" }
it "translates into level" do
expect(logger.level).to eq(Dry::Logger::ERROR)
end
end
context "when unknown level" do
let(:level) { "foo" }
it "sets level to default" do
expect(logger.level).to eq(Dry::Logger::INFO)
end
end
context "when constant" do
let(:level) { Dry::Logger::ERROR }
it "translates into level" do
expect(logger.level).to eq(Dry::Logger::ERROR)
end
end
end
describe "with nil formatter" do
subject(:logger) { Dry.Logger(:test, stream: stream, formatter: nil) }
it "falls back to string formatter" do
logger.info("foo")
expect(output).to eq "foo\n"
end
end
describe "with filters" do
it "does not mutate the original payload hash" do
logger = Dry.Logger(:test, stream:, filters: %w[password token])
data = {password: "secret", token: "abc123", user: "john"}
original_data = data.dup
logger.info("Login attempt", **data)
expect(data).to eq(original_data)
end
end
end
|