Class: Rake::XPI::Config

Inherits:
Object
  • Object
show all
Includes:
DSL
Defined in:
lib/rake/xpi.rb,
lib/rake/xpi/s3.rb,
lib/rake/xpi/github.rb,
lib/rake/xpi/bintray.rb,
lib/rake/xpi/sourceforge.rb

Constant Summary collapse

@@builds = 
'builds'

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Returns a new instance of Config.



22
23
24
25
26
27
28
29
 
# File 'lib/rake/xpi.rb', line 22

def initialize()
  @config = RecursiveOpenStruct.new(YAML::load_file('xpi.yml'), recurse_over_arrays: true)
  @timestamp = Time.now.to_i.to_s

  @config.to_h.keys.each{|key|
    self.class.send(:define_method, key) { @config[key] }
  }
end

Instance Method Details

#add_asset(tag, is_prerelease, asset_name, content, content_type) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rake/xpi/github.rb', line 33

def add_asset(tag, is_prerelease, asset_name, content, content_type)
  release = client.repos.releases.list(@config.github.user, @config.github.repo).detect{|rel| rel.tag_name == tag }
  if release
    raise "Release #{tag}: requested #{is_prerelease ? 'pre' : ''}release, found #{is_prerelease ? 'pre' : ''}release" if is_prerelease ^ release.prerelease
  else
    sha = `git rev-list --max-parents=0 HEAD`.split(/\n/).collect{|sha| sha.strip}.first
    release = client.repos.releases.create(@config.github.user, @config.github.repo, {
      tag_name: tag,
      target_commitish: sha,
      name: tag,
      body: tag,
      prerelease: !!is_prerelease
    })
  end

  client.repos.releases.assets.list(@config.github.user, @config.github.repo, release.id){ |asset|
    next unless asset.name == asset_name
    client.repos.releases.assets.delete(@config.github.user, @config.github.repo, asset.id)
  }
  client.repos.releases.assets.upload(@config.github.user, @config.github.repo, release.id, content, {
    name: asset_name,
    content_type: content_type
  })
end

#branch ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/rake/xpi.rb', line 128

def branch
  if @branch.nil?
    if pull_request
      @branch = 'pull-request-' + pull_request
    elsif ENV['TRAVIS_BRANCH']
      @branch = ENV['TRAVIS_BRANCH']
    elsif ENV['CIRCLE_BRANCH']
      @branch = ENV['CIRCLE_BRANCH']
    else
      @branch = `git rev-parse --abbrev-ref HEAD`.strip
    end
  end
  return @branch
end

#bump(level = nil) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rake/xpi.rb', line 34

def bump(level=nil)
  r = release.split('.').collect{|n| Integer(n)}
  r = case (level || 'patch').intern
      when :major then [r[0] + 1, 0, 0]
      when :minor then [r[0], r[1] + 1, 0]
      when :patch then [r[0], r[1], r[2] + 1]
      else raise "Unexpected release increase #{level.inspect}"
      end
  self.release = r.collect{|n| n.to_s}.join('.')
end

#client ⇒ Object 



23
24
25
26
27
28
29
30
31
 
# File 'lib/rake/xpi/github.rb', line 23

def client
  if @client.nil?
    raise "Github publishing not configured" unless @config.github && @config.github.user && @config.github.token
    token = ENV[@config.github.token]
    raise "Github publishing not configured" unless token
    @client = Github.new({oauth_token: token})
  end
  return @client
end

#download(url, file) ⇒ Object 



113
114
115
116
 
# File 'lib/rake/xpi.rb', line 113

def download(url, file)
  puts "Downloading #{url} to #{file}..."
  sh "curl -L #{url.shellescape} -o #{file.shellescape}"
end

#getxpis ⇒ Object 



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
 
# File 'lib/rake/xpi.rb', line 234

def getxpis
  return if ENV['OFFLINE'].to_s.downcase == 'true'
  return unless @config.test && @config.test.xpis && @config.test.xpis.install

  dir = File.expand_path(@config.test.xpis.install)
  FileUtils.mkdir_p(dir)
  installed = Dir["#{dir}/*.xpi"].collect{|f| File.basename(f) }

  sources = (@config.test.xpis.download || []).collect{|s| resolvexpi(s) }

  (installed - sources.collect{|s| s.xpi}).each{|xpi|
    STDERR.puts "Removing #{xpi}" unless ENV['VERBOSE'] == 'false'
    File.unlink("#{dir}/#{xpi}")
  }
  sources.reject{|s| installed.include?(s.xpi) && s.url !~ /^file:/ }.each{|s|
    # https://github.com/zotero/zotero/zipball/master for zotero master
    if s.xpi =~ /(.*)-master-.*.xpi$/
      src = $1
      tgt = "#{dir}/#{s.xpi}"
      STDERR.puts "Zipping #{s.xpi} to #{tgt}" unless ENV['VERBOSE'] == 'false'
      Dir.chdir(src){|path|
        Zip::File.open(tgt, 'w') do |zipfile|
          Dir["**/*"].sort.each{|file|
            zipfile.add(file, file)
          }
        end
      }
    else
      STDERR.puts "Downloading #{s.xpi}" unless ENV['VERBOSE'] == 'false'
      download(s.url, "#{dir}/#{s.xpi}")
    end
  }
end

#id ⇒ Object 



45
46
47
 
# File 'lib/rake/xpi.rb', line 45

def id
  return Nokogiri::XML(File.open('install.rdf')).at('//em:id').inner_text
end

#publish ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/rake/xpi/s3.rb', line 20

def publish
  raise "S3 publishing not configured" unless @config.s3 && @config.s3.id && @config.s3.secret
  id = ENV[@config.s3.id]
  secret = ENV[@config.s3.secret]
  return false unless id && secret

  s3 = Aws::S3::Resource.new(region: @config.s3.region, credentials: Aws::Credentials.new(id, secret))
  bucket = s3.bucket(@config.s3.bucket)

  obj = bucket.object("#{release_build? ? @config.s3.prefix : 'builds'}/#{self.versioned_xpi}")
  obj.upload_file(self.xpi, content_type: 'application/x-xpinstall')
  if release_build?
    update_rdf("https://s3.#{@config.s3.region}.amazonaws.com/#{@config.s3.bucket}/#{@config.s3.prefix}/#{self.versioned_xpi}"){|update|
      obj = bucket.object("#{@config.s3.prefix}/update.rdf")
      obj.upload_file(update, content_type: 'application/rdf+xml')
    }
  end
end

#pull_request ⇒ Object 



122
123
124
125
126
 
# File 'lib/rake/xpi.rb', line 122

def pull_request
  return ENV['TRAVIS_PULL_REQUEST'] if (ENV['TRAVIS_PULL_REQUEST'] || 'false') != 'false'
  return ENV['CI_PULL_REQUESTS'] if (ENV['CI_PULL_REQUESTS'] || '') != ''
  return nil
end

#release ⇒ Object 



48
49
50
 
# File 'lib/rake/xpi.rb', line 48

def release
  return Nokogiri::XML(File.open('install.rdf')).at('//em:version').inner_text
end

#release=(rel) ⇒ Object 



51
52
53
54
55
 
# File 'lib/rake/xpi.rb', line 51

def release=(rel)
  doc = Nokogiri::XML(File.open('install.rdf'))
  doc.at('//em:version').content = rel
  open('install.rdf', 'w'){|f| f.write(doc.to_xml)}
end

#release_build? ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/rake/xpi.rb', line 143

def release_build?
  if @release_build.nil?
    commitmsg = `git log -n 1 --pretty=oneline`.strip
    commit = %w{CIRCLE_SHA1 TRAVIS_COMMIT}.collect{|key| ENV[key]}.compact.first
    commit ||= 'local'

    releasemsg = "#{commit} #{release_message}"

    if ENV['VERBOSE'] != 'false'
      STDERR.puts "#{self.release}"
      STDERR.puts "  committed = #{commitmsg}"
      STDERR.puts "  release   = #{releasemsg}"
      STDERR.puts "  branch    = #{branch}"
    end

    @release_build = (commitmsg == releasemsg && branch == 'master')
  end

  return @release_build
end

#release_message ⇒ Object 



118
119
120
 
# File 'lib/rake/xpi.rb', line 118

def release_message
  return "release: #{self.xpi} #{self.release}"
end

#resolvexpi(source) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
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
 
# File 'lib/rake/xpi.rb', line 268

def resolvexpi(source)
  STDERR.puts "Resolving #{source}" unless ENV['VERBOSE'] == 'false'

  xpi = nil

  if source =~ /update\.rdf$/
    update_rdf = Nokogiri::XML(open(source))
    update_rdf.remove_namespaces!
    url = update_rdf.at('//updateLink').inner_text
  elsif source =~ /^https:\/\/addons\.mozilla\.org\//
    page = open(source).read
    page = Nokogiri::HTML(page)
    url = page.at_css('p.install-button').at_css('a')['href']

    url = URI.join(source, url ).to_s if url !~ /^http/

    return resolvexpi(url) if url =~ /\/contribute\/roadblock\//

    # AMO uses redirects, so I can't write the file to the final name just yet
    final_uri = nil
    open(url) do |h|
      final_uri = h.base_uri
    end
    url = final_uri.to_s
  elsif source =~ /^https:\/\/github\.com\/zotero\/([^\/]+)\/zipball\/master$/
    url = source
    src = $1
    Dir.chdir(src) {
      rev = `git log -n 1 --pretty=format:"%h"`
      xpi = "#{src}-master-#{rev}.xpi"
    }
  elsif source =~ /^file:/ || source =~ /\.xpi(\?|$)/
    url = source
  else
    throw "Unsupported XPI source #{source}"
  end

  xpi ||= url.sub(/.*\//, '').sub(/\?.*$/, '')
  STDERR.puts "Resolved to #{url}" unless ENV['VERBOSE'] == 'false'
  return OpenStruct.new(url: url, xpi: xpi)
end

#sign ⇒ Object 



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
 
# File 'lib/rake/xpi.rb', line 164

def sign
  return if ENV['SIGN'] == 'false'
  return unless @config.amo && @config.amo.issuer && @config.amo.secret
  issuer = ENV[@config.amo.issuer]
  secret = ENV[@config.amo.secret]
  return unless issuer && secret

  token = lambda {
    payload = {
      jti: SecureRandom.base64,
      iss: issuer,
      iat: Time.now.utc.to_i,
      exp: Time.now.utc.to_i + 60,
    }
    return JWT.encode(payload, secret, 'HS256')
  }

  duration = lambda{|secs|
    secs = secs.to_i
    mins  = secs / 60
    hours = mins / 60
    days  = hours / 24

    if days > 0
      "#{days} days and #{hours % 24} hours"
    elsif hours > 0
      "#{hours} hours and #{mins % 60} minutes"
    elsif mins > 0
      "#{mins} minutes and #{secs % 60} seconds"
    elsif secs >= 0
      "#{secs} seconds"
    end
  }

  url = "https://addons.mozilla.org/api/v3/addons/#{self.id}/versions/#{self.version}/"

  wait = nil
  begin
    Dir.mktmpdir{|dir|
      tmp = File.join(dir, self.versioned_xpi)
      FileUtils.cp(self.xpi, tmp)
      puts "Submit #{tmp} to #{url} for signing"
      RestClient.put(url, {upload: File.new(tmp)}, { 'Authorization' => "JWT #{token.call}", 'Content-Type' => 'multipart/form-data' })
    }
    wait = Time.now.to_i
    sleep 10
  rescue RestClient::Conflict
    puts "#{self.xpi} already signed"
    wait = Time.now.to_i
  end

  status = {}
  (1..100).each{|attempt|
    status = JSON.parse(RestClient.get(url, { 'Authorization' => "JWT #{token.call}"} ).to_s)
    files = (status['files'] || []).length
    signed = (files > 0 ? status['files'][0]['signed'] : false)
    puts "attempt #{attempt} after #{duration.call(Time.now.to_i - wait)}, #{files} files, signed: #{signed}"
    break if signed
    sleep 5
  }

  raise "Unexpected response: #{status['files'].inspect}" if !status['files'] || status['files'].length != 1 || !status['files'][0]['download_url']
  raise "Not signed: #{status['files'][0].inspect}" unless status['files'][0]['signed']

  puts "\ngetting signed XPI from #{status['files'][0]['download_url']}"
  File.open(self.xpi, 'wb'){|f|
    f.write(RestClient.get(status['files'][0]['download_url'], { 'Authorization' => "JWT #{token.call}"} ).body)
  }
end

#update_rdf ⇒ Object 



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
 
# File 'lib/rake/xpi.rb', line 71

def update_rdf
  _id = self.id
  _release = self.release
  _changelog = self.changelog
  _link = self.xpi_url

  update = Nokogiri::XML::Builder.new { |xml|
    xml.RDF('xmlns:RDF'=>'http://www.w3.org/1999/02/22-rdf-syntax-ns#', 'xmlns:em' =>
    'http://www.mozilla.org/2004/em-rdf#') {
      xml.parent.namespace = xml.parent.namespace_definitions.find{|ns|ns.prefix=='RDF'}
      xml['RDF'].Description(about: "urn:mozilla:extension:#{_id}") {
        xml['em'].updates {
          xml['RDF'].Seq {
            xml['RDF'].li {
              xml['RDF'].Description {
                xml['em'].version { xml.text _release }

                Nokogiri::XML(open('install.rdf')).xpath('//em:targetApplication/xmlns:Description').each{|target|
                  xml['em'].targetApplication {
                    xml['RDF'].Description {
                      xml['em'].id { xml.text target.at('./em:id').inner_text }
                      xml['em'].minVersion { xml.text target.at('./em:minVersion').inner_text }
                      xml['em'].maxVersion { xml.text target.at('./em:maxVersion').inner_text }
                      xml['em'].updateLink { xml.text _link }
                      xml['em'].updateInfoURL { xml.text _changelog }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
  Tempfile.create('update_rdf') do |tmp|
    tmp.write(update.to_xml)
    tmp.close
    yield tmp.path
  end
end

#update_url ⇒ Object 



58
59
60
 
# File 'lib/rake/xpi/github.rb', line 58

def update_url
  return "https://github.com/#{@config.github.user}/#{@config.github.repo}/releases/download/update.rdf/update.rdf"
end

#version ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rake/xpi.rb', line 57

def version
  b = "-#{branch}"
  b = '' if b == '-master'
  if release_build?
    return release
  elsif ENV['TRAVIS_BUILD_NUMBER']
    return release + "-travis#{b}-#{ENV['TRAVIS_BUILD_NUMBER']}"
  elsif ENV['CIRCLE_BUILD_NUM']
    return release + "-circle#{b}-#{ENV['CIRCLE_BUILD_NUM']}"
  else
    return release + "-#{Socket.gethostname}#{b}-#{@timestamp}"
  end
end

#versioned_xpi(v = nil) ⇒ Object 



30
31
32
 
# File 'lib/rake/xpi.rb', line 30

def versioned_xpi(v=nil)
  return File.basename(self.xpi, File.extname(self.xpi)) + '-' + (v || self.version) + File.extname(self.xpi)
end

#xpi_url ⇒ Object 



61
62
63
 
# File 'lib/rake/xpi/github.rb', line 61

def xpi_url
  return "https://github.com/#{@config.github.user}/#{@config.github.repo}/releases/download/#{release_build? ? self.version : @@builds}/#{self.versioned_xpi}"
end