jenkins-capistrano 0.0.7 → 0.1.0

data/Vagrantfile

@@ -0,0 +1,23 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box_url = 'https://github.com/2creatives/vagrant-centos/releases/download/v6.5.3/centos65-x86_64-20140116.box'
+  config.vm.box = 'centos65-x86_64-20140116'
+
+  config.vm.provider :virtualbox do |vb|
+    vb.customize ['modifyvm', :id, '--memory', '512']
+  end
+
+  config.vm.network 'forwarded_port', guest: 8080, host: 8080
+  config.vm.provision :shell, :inline => (<<-SCRIPT).gsub(/^ */, '')
+    curl -o /etc/yum.repos.d/jenkins.repo http://pkg.jenkins-ci.org/redhat/jenkins.repo >/dev/null 2&>1
+    rpm --import http://pkg.jenkins-ci.org/redhat/jenkins-ci.org.key
+    yum -y install java-1.7.0-openjdk jenkins
+    service jenkins start
+  SCRIPT
+end
+

data/example/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'railsless-deploy'
-gem 'jenkins-capistrano'
+gem 'capistrano_colors'
+gem 'pry'
+gem 'jenkins-capistrano', :path => '..'

data/example/README.md

@@ -1,32 +1,28 @@
 # jenkins-capistrano example
 
-jenkins-capistranoを使って、master-slave構成のJenkinsに以下のことを行う設定例
+This is a example **batch** project with jekins-capistrano configs
+which deploy and configure the following staff to the master-slave Jenkins:
 
-* バッチで必要なジョブ
-* バッチを実際に実行するためのスレーブノードの登録
-* バッチプログラム(binディレクトリ)のデプロイ
+* A job to execute the batch program
+* A node to excute the job
+* The batch program itself
 
-## 前提
+## Deploy
 
-* ローカルにruby1.8.7+が入っていること
-* 各スレーブノードに`/opt/hello`ディレクトリがあること
-* `/opt/hello`ディレクトリにjenkinsユーザが書き込み権限があること
-* jenkinsユーザがマスターノードからスレーブノードに公開鍵認証で接続できること
+### Development
 
-## デプロイの仕方
-
-本番環境:
 ```
-$ script/deploy production
+$ script/deploy
 ```
 
-ステージング環境:
+### Staging
+
 ```
 $ script/deploy staging
 ```
 
-開発環境:
+### Production
+
 ```
-$ script/deploy
+$ script/deploy production
 ```
-

data/example/config/deploy.rb

@@ -1,8 +1,8 @@
 set :application, 'hello'
 set :repository, 'http://example.org/your/repository.git'
 set :scm, :git
-set :branch, 'develop' # デフォルトブランチの設定
-set :deploy_via, :copy # ローカルクローンしてリモートにコピー(リモートでクローンしないように)
+set :branch, 'develop'
+set :deploy_via, :copy
 set :deploy_to, "/opt/#{application}"
 set :use_sudo, false
 set :keep_releases, 5
@@ -10,14 +10,13 @@ set :keep_releases, 5
 set :stages, %w(develop staging production)
 set :default_stage, 'develop'
 
-set :user, 'jenkins'
-# 公開鍵認証を推奨
-#set :password do
-#  ENV['DEPLOY_PASSWORD'] || Capistrano::CLI.password_prompt("linux user password[#{user}]: ")
-#end
+set :user, 'vagrant'
+set :password do
+  ENV['DEPLOY_PASSWORD'] || Capistrano::CLI.password_prompt("linux user password[#{user}]: ")
+end
 
-set :jenkins_username, user
-# 必要であれば
+# if you need the credentials
+# set :jenkins_username, 'jenkins'
 #set :jenkins_password do
 #  ENV['DEPLOY_PASSWORD'] || Capistrano::CLI.password_prompt("jenkins server password[#{user}]: ")
 #end
@@ -27,9 +26,6 @@ after  'deploy', 'jenkins:deploy_jobs'
 after  'deploy', 'jenkins:deploy_jobs'
 after  'deploy', 'deploy:cleanup'
 
-# ローカルにgitコマンドがあること
 depend :local, :command, 'git'
-# リモートにデプロイ用ディレクトリがあること
 depend :remote, :directory, deploy_to
-# jenkinsユーザで書き込みができること
 depend :remote, :writable, deploy_to

data/example/config/deploy/develop.rb

@@ -1,5 +1,7 @@
 # ブランチはconfig/deploy.rbの設定に従う
-role :batch, 'dev-slave01.local'
-set :jenkins_host, 'dev-master.local'
+role :batch, 'localhsot:22222'
+set :jenkins_host, 'localhost:8080'
 set :jenkins_node_config_dir, 'config/jenkins/nodes/develop'
-
+set :jenkins_template_vars, {
+  credential_id: 'AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA'
+}

data/example/config/deploy/production.rb

@@ -1,9 +1,19 @@
 set :branch, 'v1.0.0'
 
 role :batch, 'prod-slave01.local'
-# 複数ノードの場合
-#role :batch, 'prod-slave02.local'
-#role :batch, 'prod-slave03.local'
+role :batch, 'prod-slave02.local'
+role :batch, 'prod-slave03.local'
 
 set :jenkins_host, 'prod-master.local'
 set :jenkins_node_config_dir, 'config/jenkins/nodes/production'
+set :jenkins_template_vars, {
+  slave01: {
+    credential_id: 'PRODUCTION-SLAVE01-CREDENTIAL',
+  },
+  slave02: {
+    credential_id: 'PRODUCTION-SLAVE02-CREDENTIAL',
+  },
+  slave03: {
+    credential_id: 'PRODUCTION-SLAVE03-CREDENTIAL',
+  }
+}

data/example/config/deploy/staging.rb

@@ -1,10 +1,19 @@
 set :branch, 'release/1.0.1'
 
 role :batch, 'stg-slave01.local'
-# 複数ノードの場合
-#role :batch, 'stg-slave02.local'
-#role :batch, 'stg-slave03.local'
+role :batch, 'stg-slave02.local'
+role :batch, 'stg-slave03.local'
 
 set :jenkins_host, 'stg-master.local'
 set :jenkins_node_config_dir, 'config/jenkins/nodes/staging'
-
+set :jenkins_template_vars, {
+  slave01: {
+    credential_id: 'STAGING-SLAVE01-CREDENTIAL',
+  },
+  slave02: {
+    credential_id: 'STAGING-SLAVE02-CREDENTIAL',
+  },
+  slave03: {
+    credential_id: 'STAGING-SLAVE03-CREDENTIAL',
+  }
+}

data/example/config/jenkins/nodes/develop/dev-slave01.xml.erb

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>dev-slave01</name>
+  <description>Slave01</description>
+  <remoteFS>/home/jenkins</remoteFS>
+  <numExecutors>5</numExecutors>
+  <mode>EXCLUSIVE</mode>
+  <retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
+  <launcher class="hudson.plugins.sshslaves.SSHLauncher" plugin="ssh-slaves@1.5">
+    <host>dev-slave01.local</host>
+    <port>22</port>
+    <credentialsId><%= @credential_id %></credentialsId>
+    <jvmOptions>-Dfile.encoding=UTF-8</jvmOptions>
+  </launcher>
+  <label>hello</label>
+  <nodeProperties>
+    <hudson.slaves.EnvironmentVariablesNodeProperty>
+      <envVars serialization="custom">
+        <unserializable-parents/>
+        <tree-map>
+          <default>
+            <comparator class="hudson.util.CaseInsensitiveComparator"/>
+          </default>
+          <int>2</int><!-- must specify env var count -->
+          <string>LANG</string>
+          <string>ja_JP.UTF-8</string>
+          <string>ENVIRONMENT</string>
+          <string>develop</string>
+        </tree-map>
+      </envVars>
+    </hudson.slaves.EnvironmentVariablesNodeProperty>
+  </nodeProperties>
+</slave>

data/example/config/jenkins/nodes/production/prod-slave01.xml.erb

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>prod-slave01</name>
+  <description>Slave01</description>
+  <remoteFS>/home/jenkins</remoteFS>
+  <numExecutors>5</numExecutors>
+  <mode>EXCLUSIVE</mode>
+  <retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
+  <launcher class="hudson.plugins.sshslaves.SSHLauncher" plugin="ssh-slaves@1.5">
+    <host>prod-slave01.local</host>
+    <port>22</port>
+    <credentialsId><%= @slave01[:credential_id] %></credentialsId>
+    <jvmOptions>-Dfile.encoding=UTF-8</jvmOptions>
+  </launcher>
+  <label>hello</label>
+  <nodeProperties>
+    <hudson.slaves.EnvironmentVariablesNodeProperty>
+      <envVars serialization="custom">
+        <unserializable-parents/>
+        <tree-map>
+          <default>
+            <comparator class="hudson.util.CaseInsensitiveComparator"/>
+          </default>
+          <int>2</int><!-- must specify env var count -->
+          <string>LANG</string>
+          <string>ja_JP.UTF-8</string>
+          <string>ENVIRONMENT</string>
+          <string>production</string>
+        </tree-map>
+      </envVars>
+    </hudson.slaves.EnvironmentVariablesNodeProperty>
+  </nodeProperties>
+</slave>

data/example/config/jenkins/nodes/production/prod-slave02.xml.erb

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>prod-slave02</name>
+  <description>Slave02</description>
+  <remoteFS>/home/jenkins</remoteFS>
+  <numExecutors>5</numExecutors>
+  <mode>EXCLUSIVE</mode>
+  <retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
+  <launcher class="hudson.plugins.sshslaves.SSHLauncher" plugin="ssh-slaves@1.5">
+    <host>prod-slave02.local</host>
+    <port>22</port>
+    <credentialsId><%= @slave02[:credential_id] %></credentialsId>
+    <jvmOptions>-Dfile.encoding=UTF-8</jvmOptions>
+  </launcher>
+  <label>hello</label>
+  <nodeProperties>
+    <hudson.slaves.EnvironmentVariablesNodeProperty>
+      <envVars serialization="custom">
+        <unserializable-parents/>
+        <tree-map>
+          <default>
+            <comparator class="hudson.util.CaseInsensitiveComparator"/>
+          </default>
+          <int>2</int><!-- must specify env var count -->
+          <string>LANG</string>
+          <string>ja_JP.UTF-8</string>
+          <string>ENVIRONMENT</string>
+          <string>production</string>
+        </tree-map>
+      </envVars>
+    </hudson.slaves.EnvironmentVariablesNodeProperty>
+  </nodeProperties>
+</slave>

data/example/config/jenkins/nodes/production/prod-slave03.xml.erb

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>prod-slave03</name>
+  <description>Slave03</description>
+  <remoteFS>/home/jenkins</remoteFS>
+  <numExecutors>5</numExecutors>
+  <mode>EXCLUSIVE</mode>
+  <retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
+  <launcher class="hudson.plugins.sshslaves.SSHLauncher" plugin="ssh-slaves@1.5">
+    <host>prod-slave03.local</host>
+    <port>22</port>
+    <credentialsId><%= @slave03[:credential_id] %></credentialsId>
+    <jvmOptions>-Dfile.encoding=UTF-8</jvmOptions>
+  </launcher>
+  <label>hello</label>
+  <nodeProperties>
+    <hudson.slaves.EnvironmentVariablesNodeProperty>
+      <envVars serialization="custom">
+        <unserializable-parents/>
+        <tree-map>
+          <default>
+            <comparator class="hudson.util.CaseInsensitiveComparator"/>
+          </default>
+          <int>2</int><!-- must specify env var count -->
+          <string>LANG</string>
+          <string>ja_JP.UTF-8</string>
+          <string>ENVIRONMENT</string>
+          <string>production</string>
+        </tree-map>
+      </envVars>
+    </hudson.slaves.EnvironmentVariablesNodeProperty>
+  </nodeProperties>
+</slave>

data/example/config/jenkins/nodes/staging/stg-slave01.xml.erb

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>stg-slave01</name>
+  <description>Slave01</description>
+  <remoteFS>/home/jenkins</remoteFS>
+  <numExecutors>5</numExecutors>
+  <mode>EXCLUSIVE</mode>
+  <retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
+  <launcher class="hudson.plugins.sshslaves.SSHLauncher" plugin="ssh-slaves@1.5">
+    <host>stg-slave01.local</host>
+    <port>22</port>
+    <credentialsId><%= @slave01[:credential_id] %></credentialsId>
+    <jvmOptions>-Dfile.encoding=UTF-8</jvmOptions>
+  </launcher>
+  <label>hello</label>
+  <nodeProperties>
+    <hudson.slaves.EnvironmentVariablesNodeProperty>
+      <envVars serialization="custom">
+        <unserializable-parents/>
+        <tree-map>
+          <default>
+            <comparator class="hudson.util.CaseInsensitiveComparator"/>
+          </default>
+          <int>2</int><!-- must specify env var count -->
+          <string>LANG</string>
+          <string>ja_JP.UTF-8</string>
+          <string>ENVIRONMENT</string>
+          <string>staging</string>
+        </tree-map>
+      </envVars>
+    </hudson.slaves.EnvironmentVariablesNodeProperty>
+  </nodeProperties>
+</slave>

data/example/config/jenkins/nodes/staging/stg-slave02.xml.erb

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>stg-slave02</name>
+  <description>Slave02</description>
+  <remoteFS>/home/jenkins</remoteFS>
+  <numExecutors>5</numExecutors>
+  <mode>EXCLUSIVE</mode>
+  <retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
+  <launcher class="hudson.plugins.sshslaves.SSHLauncher" plugin="ssh-slaves@1.5">
+    <host>stg-slave02.local</host>
+    <port>22</port>
+    <credentialsId><%= @slave02[:credential_id] %></credentialsId>
+    <jvmOptions>-Dfile.encoding=UTF-8</jvmOptions>
+  </launcher>
+  <label>hello</label>
+  <nodeProperties>
+    <hudson.slaves.EnvironmentVariablesNodeProperty>
+      <envVars serialization="custom">
+        <unserializable-parents/>
+        <tree-map>
+          <default>
+            <comparator class="hudson.util.CaseInsensitiveComparator"/>
+          </default>
+          <int>2</int><!-- must specify env var count -->
+          <string>LANG</string>
+          <string>ja_JP.UTF-8</string>
+          <string>ENVIRONMENT</string>
+          <string>staging</string>
+        </tree-map>
+      </envVars>
+    </hudson.slaves.EnvironmentVariablesNodeProperty>
+  </nodeProperties>
+</slave>

data/example/config/jenkins/nodes/staging/stg-slave03.xml.erb

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>stg-slave03</name>
+  <description>Slave03</description>
+  <remoteFS>/home/jenkins</remoteFS>
+  <numExecutors>5</numExecutors>
+  <mode>EXCLUSIVE</mode>
+  <retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
+  <launcher class="hudson.plugins.sshslaves.SSHLauncher" plugin="ssh-slaves@1.5">
+    <host>stg-slave03.local</host>
+    <port>22</port>
+    <credentialsId><%= @slave03[:credential_id] %></credentialsId>
+    <jvmOptions>-Dfile.encoding=UTF-8</jvmOptions>
+  </launcher>
+  <label>hello</label>
+  <nodeProperties>
+    <hudson.slaves.EnvironmentVariablesNodeProperty>
+      <envVars serialization="custom">
+        <unserializable-parents/>
+        <tree-map>
+          <default>
+            <comparator class="hudson.util.CaseInsensitiveComparator"/>
+          </default>
+          <int>2</int><!-- must specify env var count -->
+          <string>LANG</string>
+          <string>ja_JP.UTF-8</string>
+          <string>ENVIRONMENT</string>
+          <string>staging</string>
+        </tree-map>
+      </envVars>
+    </hudson.slaves.EnvironmentVariablesNodeProperty>
+  </nodeProperties>
+</slave>

data/example/script/bootstrap

@@ -2,9 +2,8 @@
 
 set -e
 
-(gem spec bundler -v '~> 1.2.0' > /dev/null 2>&1) || gem install bundler -v '~> 1.2.0' --no-rdoc --no-ri
+(gem spec bundler -v '~> 1.6.0' > /dev/null 2>&1) || gem install bundler -v '~> 1.6.0' --no-rdoc --no-ri
 
-# 常に綺麗な設定で行うように
 rm -rf .bundle/config
 bundle install --binstubs .bundle/bin --path .bundle
 

data/features/config_jobs.feature

@@ -0,0 +1,162 @@
+Feature: Configuring Jobs
+
+  Scenario: Configuring jobs to newly created Jenkins
+    Given the plain Jenkins server
+    And a file named "Capfile" with:
+    """
+    require 'jenkins-capistrano'
+    load 'config/deploy'
+    """
+    And a file named "config/deploy.rb" with:
+    """
+    set :jenkins_host, 'http://localhost:8080'
+    """
+    And a file named "config/jenkins/jobs/job1.xml" with:
+    """
+    <?xml version="1.0" encoding="UTF-8"?><project>
+      <actions/>
+      <description>Created</description>
+      <keepDependencies>false</keepDependencies>
+      <properties/>
+      <scm class="hudson.scm.NullSCM"/>
+      <canRoam>true</canRoam>
+      <disabled>false</disabled>
+      <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+      <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+      <jdk>Default</jdk>
+      <triggers/>
+      <concurrentBuild>false</concurrentBuild>
+      <builders/>
+      <publishers/>
+    </project>
+    """
+    When I successfully run `bundle exec cap jenkins:config_jobs`
+    Then the output should contain:
+      """
+      job job1 created.
+      """
+    And the Jenkins has following jobs:
+      | Name | Description | Disabled |
+      | job1 | Created     | false    |
+
+  Scenario: Configuring jobs already created
+    Given the Jenkins server has following jobs:
+      | Name | Description | Disabled |
+      | job1 | Created     | false    |
+    And a file named "Capfile" with:
+    """
+    require 'jenkins-capistrano'
+    load 'config/deploy'
+    """
+    And a file named "config/deploy.rb" with:
+    """
+    set :jenkins_host, 'http://localhost:8080'
+    """
+    And a file named "config/jenkins/jobs/job1.xml" with:
+    """
+    <?xml version="1.0" encoding="UTF-8"?><project>
+      <actions/>
+      <description>Updated</description>
+      <keepDependencies>false</keepDependencies>
+      <properties/>
+      <scm class="hudson.scm.NullSCM"/>
+      <canRoam>true</canRoam>
+      <disabled>false</disabled>
+      <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+      <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+      <jdk>Default</jdk>
+      <triggers/>
+      <concurrentBuild>false</concurrentBuild>
+      <builders/>
+      <publishers/>
+    </project>
+    """
+    When I successfully run `bundle exec cap jenkins:config_jobs`
+    Then the Jenkins has following jobs:
+      | Name | Description | Disabled |
+      | job1 | Updated     | false    |
+    And the output should contain:
+      """
+      job job1 created.
+      """
+
+  Scenario: Disabling the specified job
+    Given the plain Jenkins server
+    And a file named "Capfile" with:
+    """
+    require 'jenkins-capistrano'
+    load 'config/deploy'
+    """
+    And a file named "config/deploy.rb" with:
+    """
+    set :jenkins_host, 'http://localhost:8080'
+    set :disabled_jobs, %w(job1)
+    """
+    And a file named "config/jenkins/jobs/job1.xml" with:
+    """
+    <?xml version="1.0" encoding="UTF-8"?><project>
+      <actions/>
+      <description>Disabled</description>
+      <keepDependencies>false</keepDependencies>
+      <properties/>
+      <scm class="hudson.scm.NullSCM"/>
+      <canRoam>true</canRoam>
+      <disabled>false</disabled>
+      <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+      <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+      <jdk>Default</jdk>
+      <triggers/>
+      <concurrentBuild>false</concurrentBuild>
+      <builders/>
+      <publishers/>
+    </project>
+    """
+    When I successfully run `bundle exec cap jenkins:config_jobs`
+    Then the Jenkins has following jobs:
+      | Name | Description | Disabled |
+      | job1 | Disabled    | true     |
+    And the output should contain:
+      """
+      job job1 created.
+          -> disabled
+      """
+
+  Scenario: Configuring the jobs with teamplated config.xmls
+    Given the plain Jenkins server
+    And a file named "Capfile" with:
+    """
+    require 'jenkins-capistrano'
+    load 'config/deploy'
+    """
+    And a file named "config/deploy.rb" with:
+    """
+    set :jenkins_host, 'http://localhost:8080'
+    set :jenkins_template_vars, { :templated => 'Yay!!' }
+    """
+    And a file named "config/jenkins/jobs/job1.xml.erb" with:
+    """
+    <?xml version="1.0" encoding="UTF-8"?><project>
+      <actions/>
+      <description><%= @templated %></description>
+      <keepDependencies>false</keepDependencies>
+      <properties/>
+      <scm class="hudson.scm.NullSCM"/>
+      <canRoam>true</canRoam>
+      <disabled>false</disabled>
+      <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+      <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+      <jdk>Default</jdk>
+      <triggers/>
+      <concurrentBuild>false</concurrentBuild>
+      <builders/>
+      <publishers/>
+    </project>
+    """
+    When I successfully run `bundle exec cap jenkins:config_jobs`
+    Then the Jenkins has following jobs:
+      | Name | Description | Disabled |
+      | job1 | Yay!!       | false    |
+    And the output should contain:
+      """
+      job job1 created.
+      """