Skip to content

Commit

Permalink
Improve logging messages for release notes fetchers
Browse files Browse the repository at this point in the history
  • Loading branch information
imobachgs committed Sep 26, 2017
1 parent 8d41a39 commit 02698d9
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 4 deletions.
8 changes: 7 additions & 1 deletion src/lib/y2packager/release_notes_content_prefs.rb
Expand Up @@ -19,5 +19,11 @@ module Y2Packager
# @return [Symbol] Language to use if release notes for user_lang are not available
# @!attribute [rw] format
# @return [Symbol] Release notes format (:txt or :rtf)
ReleaseNotesContentPrefs = Struct.new(:user_lang, :fallback_lang, :format)
ReleaseNotesContentPrefs = Struct.new(:user_lang, :fallback_lang, :format) do
# @return [String] Human readable representation of content preferences
def to_s
"content preferences: language '#{user_lang}', fallback language: '#{fallback_lang}', "\
"and format '#{format}'"
end
end
end
4 changes: 2 additions & 2 deletions src/lib/y2packager/release_notes_fetchers/rpm.rb
Expand Up @@ -51,8 +51,8 @@ def release_notes(prefs)
end

relnotes = extract_release_notes(prefs)
log.info "Release notes for #{product.name} in #{release_notes_package} " \
"with #{prefs.inspect}: #{relnotes.inspect}"
log.info "Got release notes for #{product.name} from package #{release_notes_package} " \
"with #{prefs}"
relnotes
end

Expand Down
3 changes: 2 additions & 1 deletion src/lib/y2packager/release_notes_fetchers/url.rb
Expand Up @@ -114,7 +114,8 @@ def release_notes(prefs)
relnotes = fetch_release_notes(prefs)

if relnotes
log.info "Release notes for #{product.name} with #{prefs.inspect}: #{relnotes.inspect}"
log.info "Got release notes for #{product.name} from URL #{relnotes_url} " \
"with #{prefs}"
return relnotes
end

Expand Down
16 changes: 16 additions & 0 deletions test/lib/release_notes_content_prefs_test.rb
@@ -0,0 +1,16 @@
#!/usr/bin/env rspec

require_relative "../test_helper"
require "y2packager/release_notes_content_prefs"

describe Y2Packager::ReleaseNotesContentPrefs do
subject(:prefs) { described_class.new("es_ES", "en", :txt) }

describe "#to_s" do
it "returns a human readable representation" do
expect(prefs.to_s).to eq(
"content preferences: language 'es_ES', fallback language: 'en', and format 'txt'"
)
end
end
end

0 comments on commit 02698d9

Please sign in to comment.