Class: Fluent::Plugin::FluentPackage::UpdateChecker

Inherits:
Object
  • Object
show all
Defined in:
lib/fluent/plugin/fluent_package_update_checker.rb

Constant Summary collapse

DEFAULT_PACKAGE_CONFIG_PATH = 
"/opt/fluent/share/config"

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ UpdateChecker

Returns a new instance of UpdateChecker.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 13

def initialize(options={})
  @logger = options[:logger]
  @options = options
  @newer_versions = []
  @newer_lts_versions = []
  @major_lts_updates = []
  @major_updates = []
  @tmp_dir = Dir.mktmpdir("fluent_package_update_notifier")
  begin
    require ENV["FLUENT_PACKAGE_CONFIG"] || DEFAULT_PACKAGE_CONFIG_PATH
  rescue LoadError
    @logger.info "Failed to load #{ENV["FLUENT_PACKAGE_CONFIG"] || DEFAULT_PACKAGE_CONFIG_PATH}"
  end
  @host_os = RbConfig::CONFIG['host_os']
  Specinfra.configuration.backend = windows? ? :cmd : :exec
  @os_info = Specinfra.backend.os_info
end

Instance Method Details

#cached_tags_path ⇒ Object 



44
45
46
47
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 44

def cached_tags_path
  ENV["FLUENT_PACKAGE_TAGS_PATH"] ?
    ENV["FLUENT_PACKAGE_TAGS_PATH"] : "#{@tmp_dir}/fluent-package-tags.json"
end

#check_package_released?(target_version) ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 135

def check_package_released?(target_version)
  major = target_version.segments.first
  check_remote_packages(target_version) do |url|
    begin
      URI.open(url)
      return true
    rescue => e
      # package is not available
      @logger.debug("#{url} is inaccessible", error: e)
    end
  end
  # assume package is not available by default
  false
end

#check_remote_packages(target_version) ⇒ Object 



129
130
131
132
133
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 129

def check_remote_packages(target_version)
  @options[:repository_sites].each do |url_prefix|
    yield generate_remote_package_url(url_prefix, target_version)
  end
end

#check_update_versions ⇒ Object 



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
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 150

def check_update_versions
  current_version = Gem::Version.new("#{PACKAGE_VERSION}")
  fetch_tags do |releases|
    releases.each do |release|
      version = release["name"]
      next if version.include?("-") # skip test artifacts
      target_version = Gem::Version.new(version.delete("v"))
      if target_version > current_version
        major = current_version.segments.first
        if same_lts_series?(current_version, target_version)
          @newer_lts_versions << version if check_package_released?(target_version)
        elsif version.start_with?("v#{major}")
          @newer_versions << version if check_package_released?(target_version)
        else
          # major upgrade standard/LTS version
          if major_lts_update?(current_version, target_version)
            # LTS
            @major_lts_updates << version if check_package_released?(target_version)
          else
            @major_updates << version if check_package_released?(target_version)
          end
        end
      end
    end
  end
ensure
  FileUtils.rm_rf(@tmp_dir)
end

#fetch_tags ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 53

def fetch_tags
  if tags_cached?
    yield JSON.parse(File.open(cached_tags_path).read)
  else
    URI.open(release_tags_url) do |resource|
      File.open(cached_tags_path, "w+") do |f|
        json = resource.read
        f.write(json)
        yield JSON.parse(json)
      end
    end
  end
end

#generate_remote_package_url(url_prefix, target_version) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 112

def generate_remote_package_url(url_prefix, target_version)
  if linux?
    case @os_info[:family]
    when "debian", "ubuntu"
      family_codename = "#{@os_info[:family]}/#{@os_info[:codename]}"
      package_url(url_prefix, family_codename, target_version)
    when "redhat"
      package_url(url_prefix, "redhat", target_version)
    when "amazon"
      major = Gem::Version.new(@os_info[:release]).segments.first
      package_url(url_prefix, "amazon/#{major}", target_version)
    end
  elsif windows?
    package_url(url_prefix, "windows", target_version)
  end
end

#linux? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 35

def linux?
  !!(@host_os =~ /linux/)
end

#major_lts_update?(base_version, target_version) ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
75
76
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 72

def major_lts_update?(base_version, target_version)
  @options[:lts] and
    base_version.segments.first < target_version.segments.first and
    [base_version.segments[1], target_version.segments[1]]  == [0, 0]
end

#notify_update_log ⇒ Object 



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
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 179

def notify_update_log
  candidates = nil
  if @options[:lts]
    if @options[:notify_major_upgrade]
      candidates = if @major_lts_updates.count > 0
                     @major_lts_updates
                   elsif @newer_lts_versions.count > 0
                     @newer_lts_versions
                   end
    else
      candidates = @newer_lts_versions
    end
  else
    if @options[:notify_major_upgrade]
      candidates = if @major_updates.count > 0
                     @major_updates
                   elsif @newer_versions.count > 0
                     @newer_versions
                   end
    else
      candidates = @newer_versions
    end
  end
  if candidates
    # Assume the version information are already sorted in descendant order by GitHub API
    url = "https://github.com/fluent/fluent-package-builder/releases/tag/#{candidates.first}"
    message = "fluent-package #{candidates.first} is available! See #{url} in details."
  else
    message = "No update for fluent-package #{PACKAGE_VERSION}"
  end
  case @options[:notify_level]
  when :warn
    @logger.warn(message)
  when :info
    @logger.info(message)
  end
end

#package_arch ⇒ Object 



78
79
80
81
82
83
84
85
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 78

def package_arch
  case @os_info[:family]
  when "debian", "ubuntu"
    @os_info[:arch] == "x86_64" ? "amd64" : "arm64"
  when "redhat", "amazon"
    @os_info[:arch] == "x86_64" ? "x64_64" : "aarch64"
  end
end

#package_url(prefix, distribution, version) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 87

def package_url(prefix, distribution, version)
  major = version.segments.first
  channel = @options[:lts] ? "lts/#{major}" : major
  case distribution
  when "debian", "ubuntu"
    codename = @os_info[:codename]
    File.join([prefix, channel, distribution, codename, "pool/contrib/f/fluent-package",
               "fluent-package_#{version}-1_#{package_arch}.deb"])
  when "redhat"
    major = Gem::Version.new(@os_info[:release]).segments.first
    File.join([prefix, channel, distribution, major, package_arch,
              "fluent-package_#{version}-1.el#{major}.#{package_arch}.rpm"])
  when "amazon/2023"
    File.join([prefix, channel, distribution, package_arch,
               "fluent-package_#{version}-1.amzn2023.#{package_arch}.rpm"])
  when "amazon/2"
    arch = @os_info[:arch] == "x86_64" ? "x64_64" : "aarch64"
    File.join([prefix, channel, distribution, package_arch,
               "fluent-package_#{version}-1.amzn2.#{package_arch}.rpm"])
  when "windows"
    File.join([prefix, channel, distribution,
               "fluent-package-#{version}-x64.msi"])
  end
end

#release_tags_url ⇒ Object 



49
50
51
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 49

def release_tags_url
  "https://api.github.com/repos/fluent/fluent-package-builder/tags"
end

#run ⇒ Object 



217
218
219
220
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 217

def run
  check_update_versions
  notify_update_log
end

#same_lts_series?(base_version, target_version) ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
70
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 67

def same_lts_series?(base_version, target_version)
  # compare [major, 0] pair information
  @options[:lts] and [base_version.segments.first, 0] == target_version.segments[..1]
end

#tags_cached? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
42
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 39

def tags_cached?
  File.exist?(cached_tags_path) and
    (Time.now - 60 * 60 * 24) < File.mtime(cached_tags_path)
end

#windows? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/fluent/plugin/fluent_package_update_checker.rb', line 31

def windows?
  !!(@host_os =~ /mswin|mingw/)
end