Class: Mixlib::Install::Backend::PackageRouter

Inherits:
Base
  • Object
show all
Defined in:
lib/mixlib/install/backend/package_router.rb

Constant Summary collapse

ENDPOINT = 
"https://packages.chef.io".freeze
COMPAT_DOWNLOAD_URL_ENDPOINT = 
"http://packages.chef.io".freeze

Instance Attribute Summary

Attributes inherited from Base

#options

Instance Method Summary collapse

Methods inherited from Base

#filter_artifacts, #info, #initialize, #normalize_platform, #platform_filters_available?, #windows_artifact_fixup!

Constructor Details

This class inherits a constructor from Mixlib::Install::Backend::Base

Instance Method Details

#artifacts_for_version(version) ⇒ Array<ArtifactInfo>

Get artifacts for a given version, channel and product_name

Returns:

  • (Array<ArtifactInfo>) —

    Array of info about found artifacts



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/mixlib/install/backend/package_router.rb', line 123

def artifacts_for_version(version)
  begin
    results = get("/api/v1/#{options.channel}/#{omnibus_project}/#{version}/artifacts")["results"]
  rescue Net::HTTPServerException => e
    if e.message =~ /404/
      return []
    else
      raise e
    end
  end

  # Merge artifactory properties to a flat Hash
  results.collect! do |result|
    {
      "filename" => result["name"],
    }.merge(
      map_properties(result["properties"])
    )
  end

  # Convert results to build records
  results.map { |a| create_artifact(a) }
end

#available_artifacts ⇒ Array<ArtifactInfo>

Create filtered list of artifacts

channel, product name, and product version.

Returns:

  • (Array<ArtifactInfo>) —

    list of artifacts for the configured



39
40
41
42
43
44
45
46
 
# File 'lib/mixlib/install/backend/package_router.rb', line 39

def available_artifacts
  artifacts = if options.latest_version? || options.partial_version?
                latest_version
              else
                artifacts_for_version(options.product_version)
              end
  windows_artifact_fixup!(artifacts)
end

#available_versions ⇒ Array<String>

Gets available versions from Artifactory via AQL. Returning simply the list of versions.

Returns:

  • (Array<String>) —

    Array of available versions



53
54
55
56
57
58
59
 
# File 'lib/mixlib/install/backend/package_router.rb', line 53

def available_versions
  # We are only including a single property, version and that exists
  # under the properties in the following structure:
  # "properties" => [ {"key"=>"omnibus.version", "value"=>"12.13.3"} ]
  ver_list = versions.map { |i| Mixlib::Versioning.parse(extract_version_from_response(i)) }.sort
  ver_list.uniq.map(&:to_s)
end

#create_artifact(artifact_map) ⇒ Object 



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
 
# File 'lib/mixlib/install/backend/package_router.rb', line 168

def create_artifact(artifact_map)
  # set normalized platform and platform version
  platform, platform_version = normalize_platform(
    artifact_map["omnibus.platform"],
    artifact_map["omnibus.platform_version"]
  )

  # create the standardized file path
  chef_standard_path = generate_chef_standard_path(
    options.channel,
    artifact_map["omnibus.project"],
    artifact_map["omnibus.version"],
    platform,
    platform_version,
    artifact_map["filename"]
  )

  if options.include_metadata?
    # retrieve the metadata using the standardized path
    begin
      metadata = get("#{chef_standard_path}.metadata.json")
      license_content = metadata["license_content"]
      software_dependencies = metadata.fetch("version_manifest", {})
                                .fetch("software", nil)
    rescue Net::HTTPServerException => e
      if e.message =~ /404/
        license_content, software_dependencies = nil
      else
        raise e
      end
    end
  else
    license_content, software_dependencies = nil
  end

  # create the download path with the correct endpoint
  base_url = if use_compat_download_url_endpoint?(platform, platform_version)
               COMPAT_DOWNLOAD_URL_ENDPOINT
             else
               endpoint
             end

  ArtifactInfo.new(
    architecture:          Util.normalize_architecture(artifact_map["omnibus.architecture"]),
    license:               artifact_map["omnibus.license"],
    license_content:       license_content,
    md5:                   artifact_map["omnibus.md5"],
    platform:              platform,
    platform_version:      platform_version,
    product_description:   product_description,
    product_name:          options.product_name,
    sha1:                  artifact_map["omnibus.sha1"],
    sha256:                artifact_map["omnibus.sha256"],
    software_dependencies: software_dependencies,
    url:                   "#{base_url}/#{chef_standard_path}",
    version:               artifact_map["omnibus.version"]
  )
end

#create_http_request(full_path) ⇒ Object 



160
161
162
163
164
165
166
 
# File 'lib/mixlib/install/backend/package_router.rb', line 160

def create_http_request(full_path)
  request = Net::HTTP::Get.new(full_path)

  request.add_field("User-Agent", Util.user_agent_string(options.user_agent_headers))

  request
end

#extract_version_from_response(response) ⇒ Object 



115
116
117
 
# File 'lib/mixlib/install/backend/package_router.rb', line 115

def extract_version_from_response(response)
  response["properties"].find { |item| item["key"] == "omnibus.version" }["value"]
end

#get(url) ⇒ Object

GET request



150
151
152
153
154
155
156
157
158
 
# File 'lib/mixlib/install/backend/package_router.rb', line 150

def get(url)
  uri = URI.parse(endpoint)
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = (uri.scheme == "https")
  full_path = File.join(uri.path, url)
  res = http.request(create_http_request(full_path))
  res.value
  JSON.parse(res.body)
end

#latest_version ⇒ Array<ArtifactInfo>

Get artifacts for the latest version, channel and product_name When a partial version is set the results will be filtered before return latest version.

Returns:

  • (Array<ArtifactInfo>) —

    Array of info about found artifacts



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/mixlib/install/backend/package_router.rb', line 97

def latest_version
  product_versions = if options.partial_version?
                       v = options.product_version
                       partial_version = v.end_with?(".") ? v : v + "."
                       versions.find_all { |ver| extract_version_from_response(ver).start_with?(partial_version) }
                     else
                       versions
                     end

  # Use mixlib versioning to parse and sort versions
  ordered_versions = product_versions.sort_by do |v|
    Mixlib::Versioning.parse(extract_version_from_response(v))
  end.reverse

  version = extract_version_from_response(ordered_versions.first)
  artifacts_for_version(version)
end

#use_compat_download_url_endpoint?(platform, platform_version) ⇒ boolean

For some older platform & platform_version combinations we need to use COMPAT_DOWNLOAD_URL_ENDPOINT since these versions have an OpenSSL version that can not verify the ENDPOINT based urls

Returns:

  • (boolean) —

    use compat download url endpoint



234
235
236
237
238
239
240
241
 
# File 'lib/mixlib/install/backend/package_router.rb', line 234

def use_compat_download_url_endpoint?(platform, platform_version)
  case "#{platform}-#{platform_version}"
  when "freebsd-9", "el-5", "solaris2-5.9", "solaris2-5.10"
    true
  else
    false
  end
end

#versions ⇒ Array<Array<Hash>] Build records for available versions

Get available versions from Artifactory via AQL. Returning the full API response

Returns:

  • (Array<Array<Hash>] Build records for available versions) —

    Array<Array<Hash>] Build records for available versions



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
 
# File 'lib/mixlib/install/backend/package_router.rb', line 65

def versions
  items = get("/api/v1/#{options.channel}/#{omnibus_project}/versions")["results"]

  # Circumvent early when there are no product artifacts in a specific channel
  if items.empty?
    raise ArtifactsNotFound, <<-EOF
No artifacts found matching criteria.
  product name: #{options.product_name}
  channel: #{options.channel}
EOF
  end

  # Filter out the partial builds if we are in :unstable channel
  # In other channels we do not need to do this since all builds are
  # always complete. Infact we should not do this since for some arcane
  # builds like Chef Client 10.X we do not have build record created in
  # artifactory.
  if options.channel == :unstable
    # We check if "artifacts" field contains something since it is only
    # populated with the build record if "artifact.module.build" exists.
    items.reject! { |i| i["artifacts"].nil? }
  end

  items
end