Class: CiCd::Builder::Repo::S3

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

Instance Attribute Summary

Attributes inherited from Base

#builder

Instance Method Summary collapse

Methods inherited from Base

#getKey, #initInventory, #tempArtifactFile

Constructor Details

#initialize(builder) ⇒ S3 



10
11
12
13
 
# File 'lib/cicd/builder/mixlib/repo/S3.rb', line 10

def initialize(builder)
  raise "Missing variable AWS_S3_BUCKET" unless ENV.has_key?('AWS_S3_BUCKET')
  super(builder)
end

Instance Method Details

#_update(hash, key, value) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/cicd/builder/mixlib/repo/S3.rb', line 134

def _update(hash, key, value)
  h = {}
  i = -1
  hash[key].each { |v| h[v] = i+=1 }
  unless h.has_key?(value)
    h[value] = h.keys.size # No -1 because this is evaluated BEFORE we make the addition!
  end
  s = h.sort_by { |_, v| v }
  s = s.map { |v| v[0] }
  hash[key] = s
  h[value]
end

#convert_build(h) ⇒ Object 



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

def convert_build(h)
  if h.has_key?('number')
    h['build_number'] = h['number']
    h.delete 'number'
  elsif h.has_key?('build_number')
    h.delete 'number'
  else
    h_build  = h.has_key?('build') ? h['build'] : h['build_name']
    h_number = h_build.gsub(/^.*?-build-([0-9]+)$/, '\1').to_i

    h['build_number'] = h_number
    h['build_name']   = h_build
    h.delete 'build'
    h.delete 'number'
  end
  if h.has_key?('build')
    h_build  = h.has_key?('build')
    h_number = h_build.gsub(/^.*?-build-([0-9]+)$/, '\1').to_i

    h['build_number'] = h_number
    h['build_name']   = h_build
    h.delete 'build'
    h.delete 'number'
  end
  h
end

#getS3 ⇒ Object 



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

def getS3()
  region = ENV['AWS_REGION'] || ::Aws.config[:region] || 'us-east-1'
  unless @s3
    # noinspection RubyArgCount
    @s3 = ::Aws::S3::Client.new(region: region)
  end
  unless @s3 and ((@s3.config.access_key_id and @s3.config.secret_access_key) or @s3.config.credentials)
    @logger.warn "Unable to find AWS credentials in standard locations:
ENV['AWS_ACCESS_KEY'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
Shared credentials file, ~/.aws/credentials
EC2 Instance profile
"
    if ENV['AWS_PROFILE']
      @logger.info "Trying profile '#{ENV['AWS_PROFILE']}' explicitly"
      creds = Aws::SharedCredentials.new( path: File.expand_path('~/.aws/credentials'), profile: ENV['AWS_PROFILE'] )
      if creds.loadable?
        # noinspection RubyArgCount
        @s3 = ::Aws::S3::Client.new(region: region, credentials: creds)
      end
    else
      @logger.warn 'No AWS_PROFILE defined'
    end
  end
  unless @s3 and ((@s3.config.access_key_id and @s3.config.secret_access_key) or @s3.config.credentials)
    raise 'Unable to find AWS credentials!'
  end
  @s3
end

#maybeS3Object(key, s3 = nil) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/cicd/builder/mixlib/repo/S3.rb', line 118

def maybeS3Object(key, s3 = nil)
  s3 ||= getS3()
  s3_obj = begin
    obj = ::Aws::S3::Object.new(bucket_name: ENV['AWS_S3_BUCKET'], key: key, client: s3)
    obj.etag
    obj
  rescue Aws::S3::Errors::NotFound
    nil
  rescue Aws::S3::Errors::NoSuchKey
    nil
  end
  s3_obj
end

#takeInventory ⇒ Object 



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

def takeInventory()
  def _update(hash, key, value)
    h = {}
    i = -1
    hash[key].each { |v| h[v] = i+=1 }
    unless h.has_key?(value)
      h[value] = h.keys.size # No -1 because this is evaluated BEFORE we make the addition!
    end
    s = h.sort_by { |_, v| v }
    s = s.map { |v| v[0] }
    hash[key] = s
    h[value]
  end

  # Read and parse in JSON
  json_s    = ''
  json      = nil
  varianth  = nil

  key    = "#{@vars[:project_name]}/INVENTORY.json"
  s3_obj = maybeS3Object(key)
  # If the inventory has started then add to it else create a new one
  if s3_obj.nil?
    # Start a new inventory
    over = true
  else
    resp = s3_obj.get()
    body = resp.body
    if body.is_a?(String)
      json_s = resp.data
    else
      body.rewind
      json_s = body.read()
    end
    json = Yajl::Parser.parse(json_s)
    over = false
    # Is the inventory format up to date ...
    constraint = ::Semverse::Constraint.new "<= #{@options[:gen]}"
    version    = ::Semverse::Version.new(json['gen'])
    # raise CiCd::Builder::Errors::InvalidVersion.new "The constraint failed: #{json['gen']} #{constraint}"

    unless constraint.satisfies?(version)
      raise CiCd::Builder::Errors::InvalidVersion.new "The inventory generation is newer than I can manage: #{version} <=> #{@options[:gen]}"
    end
    if json['container'] and json['container']['variants']
      # but does not have our variant then add it
      variants = json['container']['variants']
      unless variants[@vars[:variant]]
        variants[@vars[:variant]] = {}
        varianth = variants[@vars[:variant]]
        varianth['builds'] = []
        varianth['branches'] = []
        varianth['versions'] = []
        varianth['releases'] = []
        varianth['latest'] = {
            branch: -1,
            version: -1,
            build: -1,
            release: -1,
        }
      end
      varianth = variants[@vars[:variant]]
      # If the inventory 'latest' format is up to date ...
      unless varianth['latest'] and
          varianth['latest'].is_a?(Hash)
        # Start over ... too old/ incompatible
        over = true
      end
    else
      # Start over ... too old/ incompatible
      over = true
    end
  end
  # Starting fresh ?
  if over or json.nil?
    json_s = initInventory()
  else
    raise CiCd::Builder::Errors::Internal.new sprintf('Internal logic error! %s::%d', __FILE__,__LINE__) if varianth.nil?
    # Add the new build if we don't have it
    unless varianth['builds'].map { |b| b['build_name'] }.include?(@vars[:build_nmn])
      #noinspection RubyStringKeysInHashInspection
      filing = {
          'drawer'        => @vars[:build_nam],
          'build_name'    => @vars[:build_nmn],
          'build_number'  => @vars[:build_num],
          'release'       => @vars[:release],
      }
      if @vars.has_key?(:artifacts)
        filing['artifacts'] = @vars[:artifacts].map { |artifact| File.basename(artifact[:key]) }
      end
      assembly = json['container']['assembly'] or raise("Expected an 'assembly'")
      if assembly['extension'] != !vars[:build_ext]
        # noinspection RubyStringKeysInHashInspection
        filing['assembly'] = {
            'extension' => @vars[:build_ext],
            'type'      => 'tarbzip2'
        }
      end
      varianth['builds'] << filing
    end
    build_lst = (varianth['builds'].size-1)
    build_rel = build_lst
    i = -1
    varianth['builds'].each{ |h|
      i += 1
      convert_build(h)
      convert_build(varianth['builds'][build_rel])
      if h['release'].to_i > varianth['builds'][build_rel]['release'].to_i
        build_rel = i
      elsif h['release'] == varianth['builds'][build_rel]['release']
        build_rel = i if h['build_number'].to_i > varianth['builds'][build_rel]['build_number'].to_i
      end
    }

    # Add new branch ...
    build_bra = _update(varianth, 'branches', @vars[:build_bra])
    # Add new version ...
    build_ver = _update(varianth, 'versions', @vars[:build_ver])

    # Set latest
    varianth['latest'] = {
        branch:  build_bra,
        version: build_ver,
        build:   build_lst,
        release: build_rel,
    }
    json['gen'] = @options[:gen]
    json_s = JSON.pretty_generate( json, { indent: "\t", space: ' '})
  end
  begin
    md5 = Digest::MD5.hexdigest(json_s)
    # [:'x-amz-meta-digest'] = "md5=#{md5}"
    resp = getS3.put_object(    bucket: ENV['AWS_S3_BUCKET'],
                                key: key,
                                body: json_s,
                                # acl: 'authenticated-read',
                                metadata: {checksum: md5, digest: "md5=#{md5}"},
    )
    s3_obj = maybeS3Object(key)
    # s3_obj.etag
    @logger.info "Inventory URL: #{s3_obj.presigned_url(:get, expires_in: 86400)}"
    return 0
  rescue Exception => e
    @logger.error("Exception: #{e.class.name}: #{e.message}\n#{e.backtrace.ai}")
    return Errors::INVENTORY_UPLOAD_EXCEPTION
  end
end

#uploadBuildArtifacts ⇒ Object 



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

def uploadBuildArtifacts()
  if @vars.has_key?(:build_dir) and @vars.has_key?(:build_pkg)
    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()
    artifacts << {
        key:        "#{key}.MANIFEST.json",
        data:       {:data => manifest},
        public_url: :manifest_url,
        read_url:   :manifest_url,
        label:      'Manifest URL'
    }

    # Store the checksum
    artifacts << {
        key:        "#{@vars[:project_name]}/#{@vars[:variant]}/#{@vars[:build_nam]}/#{@vars[:build_nmn]}.checksum",
        data:       {:data => @vars[:build_sha]},
        public_url: :checksum_url,
        read_url:   :checksum_url,
        label:      'Checksum URL'
    }

    @vars[:return_code] = uploadToRepo(artifacts)
    if 0 == @vars[:return_code]
      @vars[:return_code] = takeInventory()
    end
    @vars[:return_code]
  else
    @vars[:return_code] = Errors::NO_ARTIFACTS
  end
  @vars[:return_code]
end

#uploadToRepo(artifacts) ⇒ Object 



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

def uploadToRepo(artifacts)
  s3 = getS3()
  artifacts.each{|art|

    s3_obj = maybeS3Object(art[:key], s3)
    upload = false
    if art[:data][:data]
      # md5 = Digest::MD5.hexdigest(art[:data][:data])
      tempArtifactFile('artifact', art[:data])
    end
    if s3_obj.nil?
      upload = true
      etag   = ''
    else
      @logger.info "s3://#{ENV['AWS_S3_BUCKET']}/#{art[:key]} exists"
      etag = s3_obj.etag.gsub(/"/, '')
    end
    md5 = if art[:data].has_key?(:file)
            # md5 = Digest::MD5.file(art[:data][:file]).hexdigest
            calcLocalETag(etag, art[:data][:file])
          else
            raise "Internal error: No :file in #{art[:data].ai}"
          end
    unless s3_obj.nil?
      unless etag == md5
        checksum = s3_obj.metadata[:checksum]
        unless checksum and checksum == md5
          @logger.warn "s3://#{ENV['AWS_S3_BUCKET']}/#{art[:key]} is different from our #{art[:key]}(#{s3_obj.etag} <=> #{md5})"
          upload = true
        end
      end
    end

    if upload
      @logger.info "Upload new s3://#{ENV['AWS_S3_BUCKET']}/#{art[:key]}"
      # Get size before upload changes our object
      body = nil
      if art[:data].has_key?(:file)
        size = File.size(art[:data][:file])
        body = File.open(art[:data][:file], 'r')
      else
        # size = art[:data][:data].length
        # body = art[:data][:data]
        raise "Internal error: No :file in #{art[:data].ai}"
      end
      art[:data][:metadata] = {checksum: md5, digest: "md5=#{md5}"}
      # art[:data][:'x-amz-meta-digest'] = "md5=#{md5}"
      res = s3.put_object(        bucket: ENV['AWS_S3_BUCKET'],
                                     key: art[:key],
                                    body: body,
                                   # acl: 'authenticated-read',
                          content_length: size,
                                metadata: art[:data][:metadata],
                          )
      s3_obj = maybeS3Object(art[:key], s3)
      raise "Failed to upload '#{art[:key]}'" unless s3_obj
      if art.has_key?(:public_url)
        @vars[art[:public_url]] = s3_obj.public_url
      end
      if art.has_key?(:read_url)
        @vars[art[:read_url]]   = s3_obj.presigned_url(:get, expires_in: 86400)
        @logger.info "#{art[:label]}: #{@vars[art[:read_url]]}"
      end
    end
    if art[:data][:temp]
      File.unlink(art[:data][:file])
    end
  }
  0
end