Class: CiCd::Builder::Repo::Artifactory

Inherits:
Base
  • Object
show all
Defined in:
lib/cicd/builder/mixlib/repo/artifactory.rb

Instance Attribute Summary

Attributes inherited from Base

#builder

Instance Method Summary collapse

Methods inherited from Base

#getKey, #initInventory, #tempArtifactFile

Constructor Details

#initialize(builder) ⇒ Artifactory 



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
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 10

def initialize(builder)
  # Check for the necessary environment variables
  map_keys = {}

  %w[ARTIFACTORY_ENDPOINT ARTIFACTORY_USERNAME ARTIFACTORY_PASSWORD ARTIFACTORY_REPO].each { |k|
    map_keys[k]= (not ENV.has_key?(k) or ENV[k].empty?)
  }
  missing = map_keys.keys.select{ |k| map_keys[k] }

  if missing.count() > 0
    raise("Need these environment variables: #{missing.ai}")
  end

  super(builder)

  # ::Artifactory.configure do |config|
  #   # The endpoint for the Artifactory server. If you are running the "default"
  #   # Artifactory installation using tomcat, don't forget to include the
  #   # +/artifactoy+ part of the URL.
  #   config.endpoint = artifactory_endpoint()
  #
  #   # The basic authentication information. Since this uses HTTP Basic Auth, it
  #   # is highly recommended that you run Artifactory over SSL.
  #   config.username = ENV['ARTIFACTORY_USERNAME']
  #   config.password = ENV['ARTIFACTORY_PASSWORD']
  #
  #   # Speaking of SSL, you can specify the path to a pem file with your custom
  #   # certificates and the gem will wire it all up for you (NOTE: it must be a
  #   # valid PEM file).
  #   # config.ssl_pem_file = '/path/to/my.pem'
  #
  #   # Or if you are feelying frisky, you can always disable SSL verification
  #   # config.ssl_verify = false
  #
  #   # You can specify any proxy information, including any authentication
  #   # information in the URL.
  #   # config.proxy_username = 'user'
  #   # config.proxy_password = 'password'
  #   # config.proxy_address  = 'my.proxy.server'
  #   # config.proxy_port     = '8080'
  # end
  @client = ::Artifactory::Client.new()
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 55

def method_missing(name, *args)
  if name =~ %r'^artifactory_'
    key = name.to_s.upcase
    raise "ENV has no key #{key}" unless ENV.has_key?(key)
    ENV[key]
  else
    super
  end
end

Instance Method Details

#copyArtifact(artifact_module, artifact_version, artifact_path, artifact) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 255

def copyArtifact(artifact_module, artifact_version, artifact_path, artifact)
  begin
    if artifact.attributes[:uri].eql?(File.join(artifactory_endpoint, artifactory_repo, artifact_path))
      @logger.info "Not copying (identical artifact): #{artifact_path}"
    else
      @logger.info "[#{Time.now.strftime('%Y-%m-%d %H:%M:%S %z')}] Start copy #{artifact_path} = #{artifact.attributes[:size]} bytes"
      result = artifact.copy("#{artifactory_repo()}/#{artifact_path}")
      @logger.info "[#{Time.now.strftime('%Y-%m-%d %H:%M:%S %z')}] Copied: #{result.ai}"
    end
    objects = maybeArtifactoryObject(artifact_module, artifact_version, false)
    unless objects.size > 0
      sleep 10
      objects = maybeArtifactoryObject(artifact_module, artifact_version, false)
      raise "Failed to copy '#{artifact_path}'" unless objects.size > 0
    end
    objects
  rescue Exception => e
    @logger.error "Failed to copy #{artifact_path}: #{e.class.name} #{e.message}"
    raise e
  end
end

#get_artifact_file_name_ext(data) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 102

def get_artifact_file_name_ext(data)
  file_name = File.basename(data[:file])
  if file_name =~ %r'^#{data[:name]}'
    file_name.gsub!(%r'^#{data[:name]}\.*', '')
  end
  file_name.gsub!(%r'\.\.+','.')
  file_name.gsub!(%r'\.*-*#{data[:version]}', '')
  file_name.gsub!(%r'\.*-*#{data[:build]}-*', '')
  file_ext = file_name.dup
  file_ext.gsub!(%r'^.*?\.*(tar\.gz|tgz|tar\.bzip2|bzip2|tar\.bz2|bz2|zip|jar|war|groovy)$', '\1')
  unless file_ext.empty?
    file_name.gsub!(%r'\.*#{file_ext}$', '')
  end
  file_name.gsub!(%r'(\.\d+)+$', '')
  return file_name, file_ext
end

#getArtifactName(name, file_name, artifact_version, file_ext) ⇒ Object 



205
206
207
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 205

def getArtifactName(name, file_name, artifact_version, file_ext)
  artifact_name = "#{name}#{artifact_version.empty? ? '' : "-#{artifact_version}"}.#{file_ext}" # #{file_name}
end

#getArtifactPath(artifact_module, artifact_version, artifact_name) ⇒ Object 



201
202
203
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 201

def getArtifactPath(artifact_module, artifact_version, artifact_name)
  artifact_path = "#{artifactory_org_path()}/#{artifact_module}/#{artifact_version}/#{artifact_name}"
end

#matchArtifactoryObjects(artifact_path, data, objects) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 189

def matchArtifactoryObjects(artifact_path, data, objects)
  # matched = false
  objects.select do |artifact|
    @logger.debug "\tChecking: #{artifact.attributes.ai} for #{artifact_path}"
    # if artifact.uri.match(%r'#{artifact_path}$')
    #   @logger.info "\tMatched: #{artifact.attributes.select { |k, _| k != :client }.ai}"
    # end
    matched = (artifact.md5.eql?(data[:md5]) or artifact.sha1.eql?(data[:sha1]))
    matched
  end
end

#maybeArtifactoryObject(artifact_name, artifact_version, wide = true) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 210

def maybeArtifactoryObject(artifact_name,artifact_version,wide=true)
  begin
    # Get a list of matching artifacts in this repository
    result = @client.artifact_gavc_search(group: artifactory_org_path(), name: artifact_name, version: "#{artifact_version}", repos: [artifactory_repo()])
    if result.size > 0
      @logger.info "Artifactory gavc_search match g=#{artifactory_org_path()},a=#{artifact_name},v=#{artifact_version},r=#{artifactory_repo()}: #{result}"
      # raise "GAVC started working: #{result.ai}"
    elsif wide
      @logger.warn 'GAVC search came up empty!'
      result = @client.artifact_search(name: artifact_name, repos: [artifactory_repo()])
      @logger.info "Artifactory search match a=#{artifact_name},r=#{artifactory_repo()}: #{result}"
    end
    result
  rescue Exception => e
    @logger.error "Artifactory error: #{e.class.name} #{e.message}"
    raise e
  end
end

#maybeUploadArtifactoryObject(args) ⇒ Object 



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
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 120

def maybeUploadArtifactoryObject(args)
  data             = args[:data]
  artifact_module  = args[:artifact_module]
  artifact_version = args[:artifact_version]
  file_ext         = args[:file_ext]
  file_name        = args[:file_name]

  artifact_name = getArtifactName(data[:name], file_name, artifact_version, file_ext) # artifact_path = "#{artifactory_org_path()}/#{data[:name]}/#{data[:version]}-#{@vars[:variant]}/#{artifact_name}"
  artifact_path = getArtifactPath(artifact_module, artifact_version, artifact_name)
  objects = maybeArtifactoryObject(artifact_module, artifact_version, false)
  upload = false
  matched = []
  if objects.nil? or objects.size == 0
    upload = true
  else
    @logger.info "#{artifactory_endpoint()}/#{artifactory_repo()}/#{artifact_path} exists - #{objects.size} results"
    @logger.info "\t#{objects.map{|o| o.attributes[:uri]}.join("\n\t")}"
    matched = matchArtifactoryObjects(artifact_path, data, objects)
    upload ||= (matched.size == 0)
  end
  if upload
    properties_matrix = {}
    data.select{|k,_| not k.to_s.eql?('file')}.each do |k,v|
      properties_matrix["product.#{k}"] = v
    end
    data[:properties] = properties_matrix.merge(@properties_matrix)
    objects = uploadArtifact(artifact_module, artifact_version, artifact_path, data)
    matched = matchArtifactoryObjects(artifact_path, data, objects)
  else
    @logger.info "Keep existing #{matched.map{|o| o.attributes[:uri]}.join("\t")}"
  end
  if data[:temp]
    if File.exists?(data[:file])
      File.unlink(data[:file]) if File.exists?(data[:file])
      data.delete(:file)
      data.delete(:temp)
    else
      @logger.warn "Temporary file disappeared: #{data.ai}"
    end
  end
  @vars[:return_code] = Errors::ARTIFACT_NOT_UPLOADED unless matched.size > 0
  if @vars[:return_code] == 0
    artifact_version += "-#{data[:build] || @vars[:build_num]}"
    artifact_name = getArtifactName(data[:name], file_name, artifact_version, file_ext, )
    artifact_path = getArtifactPath(artifact_module, artifact_version, artifact_name)
    copies  = maybeArtifactoryObject(artifact_module, artifact_version, false)
    matched = matchArtifactoryObjects(artifact_path, data, copies)
    upload  = (matched.size == 0)
    if upload
      objects.each do |artifact|
        copied = copyArtifact(artifact_module, artifact_version, artifact_path, artifact)
        unless copied.size > 0
          @vars[:return_code] = Errors::ARTIFACT_NOT_COPIED
          break
        end
      end
    else
      @logger.info "Keep existing #{matched.map{|o| o.attributes[:uri]}.join("\t")}"
    end
  end
  args[:data]             = data
  args[:artifact_module]  = artifact_module
  args[:artifact_version] = artifact_version
  args[:file_ext]         = file_ext
  args[:file_name]        = file_name

  @vars[:return_code]
end

#uploadArtifact(artifact_module, artifact_version, artifact_path, data) ⇒ Object 



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
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 229

def uploadArtifact(artifact_module, artifact_version, artifact_path, data)
  data[:size] = File.size(data[:file])
  artifact = ::Artifactory::Resource::Artifact.new(local_path: data[:file], client: @client)
  # noinspection RubyStringKeysInHashInspection
  artifact.checksums =  {
                        'md5'   => data[:md5],
                        'sha1'  => data[:sha1],
                        }
  artifact.size = data[:size]
  @logger.info "[#{Time.now.strftime('%Y-%m-%d %H:%M:%S %z')}] Start upload #{artifact_path} = #{data[:size]} bytes"
  result = artifact.upload(artifactory_repo(), "#{artifact_path}", data[:properties] || {})
  @logger.info "[#{Time.now.strftime('%Y-%m-%d %H:%M:%S %z')}] Uploaded: #{result.attributes.select { |k, _| k != :client }.ai}"
  artifact.upload_checksum(artifactory_repo(), "#{artifact_path}", :sha1, data[:sha1])
  artifact.upload_checksum(artifactory_repo(), "#{artifact_path}", :md5,  data[:md5])
  attempt = 0
  objects = []
  while attempt < 3
    objects = maybeArtifactoryObject(artifact_module, artifact_version, false)
    break if objects.size > 0
    sleep 2
    attempt += 1
  end
  raise "Failed to upload '#{artifact_path}'" unless objects.size > 0
  objects
end

#uploadBuildArtifacts ⇒ Object 



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
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 278

def uploadBuildArtifacts()
  @logger.step __method__.to_s
  if @vars.has_key?(:build_dir) and @vars.has_key?(:build_pkg)
    begin
      artifacts = @vars[:artifacts] rescue []

      key = getKey()
      if File.exists?(@vars[:build_pkg])
        # Store the assembly - be sure to inherit possible overrides in pkg name and ext but dictate the drawer!
        artifacts << {
            key:        "#{File.join(File.dirname(key),File.basename(@vars[:build_pkg]))}",
            data:       {:file => @vars[:build_pkg]},
            public_url: :build_url,
            label:      'Package URL'
        }
      else
        @logger.warn "Skipping upload of missing artifact: '#{@vars[:build_pkg]}'"
      end

      # Store the metadata
      manifest = manifestMetadata()
      hash     = JSON.parse(manifest)

      @vars[:return_code] = uploadToRepo(artifacts)
      # if 0 == @vars[:return_code]
      #   @vars[:return_code] = takeInventory()
      # end
      @vars[:return_code]
    rescue => e
      @logger.error "#{e.class.name} #{e.message}"
      @vars[:return_code] = Errors::ARTIFACT_UPLOAD_EXCEPTION
      raise e
    end
  else
    @vars[:return_code] = Errors::NO_ARTIFACTS
  end
  @vars[:return_code]
end

#uploadToRepo(artifacts) ⇒ Object 



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
 
# File 'lib/cicd/builder/mixlib/repo/artifactory.rb', line 66

def uploadToRepo(artifacts)
  # Set a few build properties on the endpoint URL
  @properties_matrix = {
      :'build.name'   =>  @vars[:build_mdd][:Project],
      :'build.number' =>  @vars[:build_mdd][:Build],
      :'vcs.revision' =>  @vars[:build_mdd][:Commit]
  }
  @vars[:build_mdd].each do |k,v|
    @properties_matrix["build.#{k.downcase}"] = v
  end
  # matrix = properties.map{|k,v| (v.nil? or v.empty?) ? nil : "#{k}=#{v}"}.join("\;").gsub(%r'^\;*(.*?)\;*$', '\1')
  # @client.endpoint += ";#{matrix}"
  artifacts.each{|art|
    data = art[:data]
    if data.has_key?(:data)
      tempArtifactFile(data[:name], data)
    end
    if data.has_key?(:file)
      data[:sha1] = Digest::SHA1.file(data[:file]).hexdigest
      data[:md5]  = Digest::MD5.file(data[:file]).hexdigest
    else
      raise 'Artifact does not have file or data?'
    end
    file_name, file_ext = get_artifact_file_name_ext(data)
    if file_name =~ %r'\.+'
      raise "Unable to parse out file name in #{data[:file]}"
    end
    unless file_name.empty?
      file_name = '_'+file_name.gsub(%r'^(\.|-|)(\w)', '\2').gsub(%r'(\.|-)+', '_')
    end
    maybeUploadArtifactoryObject(data: data, artifact_module: data[:module], artifact_version: data[:version] || @vars[:version], file_name: file_name, file_ext: file_ext) # -#{@vars[:variant]
    break unless @vars[:return_code] == 0
  }
  @vars[:return_code]
end