capistrano-strategy-jenkins_artifact 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 144f11b2a0dead53db3e59b2f9d1a7b4749d7705
-  data.tar.gz: 3c7c69e2b4ef44e096cf04e6557955961ada1667
+  metadata.gz: 9a5db36572a0cb054e66d71245118d6daa2aa93b
+  data.tar.gz: b8b8d7af57076fdc8a497934478ad52d4d70a2b4
 SHA512:
-  metadata.gz: 47fac1367ade6516f8ed43c17d3550c2fd6c4b748d6a98d00e21bc6e873d1a027e8cace38191e28fa0b80377ea751c5cbd52a080aef06db3549251dee94a21ab
-  data.tar.gz: dcef58a7c88d9a2a8bc80e840f70d6a8c910383bc13074fc75945f5609d3609941bdc0ecc11052f1e2857a6e13c296b3b23821de80cc4248702fc7bed05dd49f
+  metadata.gz: afb7ace0e506779442a5c0cccdc8abffbfa3f277c1195e48129c0578984a8384fb29e63ae0f607b5451559119abcd157a28aef8b888c65a0b7eea36ea57f7f5c
+  data.tar.gz: 92c4db0b7d0419254396df95be93f67bc7d9cc04d983dc80562340f88628396810f613bedb0f16d62580943ffcb7619aa426d7e9a0546362f908158a9c81800c

data/README.md

@@ -38,6 +38,38 @@ set :is_multibranch_job, true
 set :deploy_via, :jenkins_artifact
 ```
 
+## Options
+
+| name | type | required? | default value |
+| ---- | ---- | --------- | ------------- |
+| `jenkins_origin` | String | **Y** | N/A |
+| `build_project` | String | **Y** | N/A |
+| `is_multibranch_job` | Boolean | n | `nil` |
+| `artifact_relative_path` | String | n | `nil` |
+| `artifact_compression_type` | (see below) | n | guessed by artifact URL |
+| `artifact_strip_level` | Numeric | n | `1` |
+| `release_name_from` | (see below) | n | `:build_at` |
+
+### Supported compression types
+
+* gzip
+* bzip2
+* xz
+* raw
+
+### `release_name_from` option
+
+You can set either `:build_at` (default) or `:deploy_at` to this option.
+
+By default, this storategy will set release_name from the artifact's build timestamp.  This behavior is different from Capistrano's default.
+If you prefer Capistrano's default behavior (use current timestamp for release_name), set this option to `:deploy_at`.
+
+## Options exposed by capistrano-strategy-jenkins_artifact
+
+| name | type |
+| ---- | ---- |
+| `artifact_url` | String |
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/aereal/capistrano-strategy-jenkins_artifact.

data/capistrano-strategy-jenkins_artifact.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "capistrano-strategy-jenkins_artifact"
-  spec.version       = "0.2.2"
+  spec.version       = "0.3.0"
   spec.authors       = ["aereal"]
   spec.email         = ["aereal@aereal.org"]
 

data/lib/capistrano/recipes/deploy/strategy/jenkins_artifact.rb

@@ -4,27 +4,19 @@ require 'capistrano/recipes/deploy/strategy/base'
 require 'jenkins_api_client'
 
 class ::JenkinsApi::Client::Job
-  def get_last_successful_build(job_name)
-    @logger.info "Obtaining last successful build number of #{job_name}"
-    @client.api_get_request("/job/#{path_encode(job_name)}/lastSuccessfulBuild")
-  end
-
-  def find_last_successful_artifact_with_path(job_name, relative_path)
-    response_json = get_last_successful_build(job_name)
-    if response_json['artifacts'].none? {|a| a['relativePath'] == relative_path }
-      abort "Specified artifact not found in curent_build !!"
-    end
-    jenkins_path          = response_json['url']
-    artifact_path         = URI.escape("#{jenkins_path}artifact/#{relative_path}")
+  def self.get_artifact_url_by_build(build, &finder)
+    finder ||= ->(_) { true }
+    matched_artifact   = build['artifacts'].find(&finder)
+    raise 'Specified artifact not found in current build !!' unless matched_artifact
+    relative_build_path = matched_artifact['relativePath']
+    jenkins_path          = build['url']
+    artifact_path         = URI.escape("#{jenkins_path}artifact/#{relative_build_path}")
     return artifact_path
   end
 
-  def find_last_successful_artifact(job_name)
-    last_successful_build  = get_last_successful_build(job_name)
-    relative_build_path   = last_successful_build['artifacts'][0]['relativePath']
-    jenkins_path          = last_successful_build['url']
-    artifact_path         = URI.escape("#{jenkins_path}artifact/#{relative_build_path}")
-    return artifact_path
+  def get_last_successful_build(job_name)
+    @logger.info "Obtaining last successful build number of #{job_name}"
+    @client.api_get_request("/job/#{path_encode(job_name)}/lastSuccessfulBuild")
   end
 end
 
@@ -58,15 +50,22 @@ class ::Capistrano::Deploy::Strategy::JenkinsArtifact < ::Capistrano::Deploy::St
   def deploy!
     dir_name = exists?(:is_multibranch_job) && fetch(:is_multibranch_job) ? fetch(:branch) : fetch(:build_project)
 
+    release_name_from = fetch(:release_name_from, :build_at)
+    if release_name_from != :build_at && release_name_from != :deploy_at
+      abort ':release_name_from must be either `:build_at` or `:deploy_at`'
+    end
+
     jenkins_origin = fetch(:jenkins_origin) or abort ":jenkins_origin configuration must be defined"
     client = JenkinsApi::Client.new(server_url: jenkins_origin.to_s)
+
+    last_successful_build = client.job.get_last_successful_build(dir_name)
+    build_at = Time.at(last_successful_build['timestamp'] / 1000)
+
     set(:artifact_url) do
-      uri = ''
-      if exists?(:artifact_relative_path)
-        uri = client.job.find_last_successful_artifact_with_path(dir_name, fetch(:artifact_relative_path))
-      else
-        uri = client.job.find_last_successful_artifact(dir_name)
-      end
+      artifact_finder = exists?(:artifact_relative_path) ?
+        ->(artifact) { artifact['relativePath'] == fetch(:artifact_relative_path) } :
+        ->(artifact) { true }
+      uri = JenkinsApi::Client::Job.get_artifact_url_by_build(last_successful_build, &artifact_finder)
       abort "No artifact found for #{dir_name}" if uri.empty?
       URI.parse(uri).tap {|uri|
         uri.scheme = jenkins_origin.scheme
@@ -75,9 +74,6 @@ class ::Capistrano::Deploy::Strategy::JenkinsArtifact < ::Capistrano::Deploy::St
       }.to_s
     end
 
-    last_successful_build = client.job.get_last_successful_build(dir_name)
-    deploy_at = Time.at(last_successful_build['timestamp'] / 1000)
-
     compression_type = fetch(
       :artifact_compression_type,
       _guess_compression_type(fetch(:artifact_url))
@@ -90,7 +86,9 @@ class ::Capistrano::Deploy::Strategy::JenkinsArtifact < ::Capistrano::Deploy::St
       tar_opts << "--strip-components=#{strip_level}"
     end
 
-    set(:release_name, deploy_at.strftime('%Y%m%d%H%M%S'))
+    if release_name_from == :build_at
+      set(:release_name, build_at.strftime('%Y%m%d%H%M%S'))
+    end
     set(:release_path, "#{fetch(:releases_path)}/#{fetch(:release_name)}")
     set(:latest_release, fetch(:release_path))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-strategy-jenkins_artifact
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - aereal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jenkins_api_client
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Capistrano 2 strategy that uses Jenkins' artifact as a distribution provider.