jenkins-capistrano 0.0.7 → 0.1.0

data/.gitignore

@@ -1,18 +1,75 @@
+# Created by http://www.gitignore.io
+
+### Ruby ###
 *.gem
 *.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-vendor
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/example/Gemfile.lock
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### Vagrant ###
+.vagrant/
+
+
+### vim ###
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    jenkins-capistrano (0.1.0)
+      capistrano (< 3.0.0)
+      jenkins_api_client (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.4)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    capistrano (2.15.5)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    childprocess (0.5.3)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.0)
+    cucumber (1.3.15)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    highline (1.6.21)
+    jenkins_api_client (1.0.0)
+      json
+      mixlib-shellout (>= 1.1.0)
+      nokogiri (~> 1.6.0)
+      terminal-table (>= 1.4.0)
+      thor (>= 0.16.0)
+    json (1.8.1)
+    method_source (0.8.2)
+    mini_portile (0.6.0)
+    mixlib-shellout (1.4.0)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.1)
+    net-ssh-gateway (1.2.0)
+      net-ssh (>= 2.6.5)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    slop (3.5.0)
+    tapp (1.4.0)
+      thor
+    terminal-table (1.4.5)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  jenkins-capistrano!
+  pry
+  rake
+  tapp

data/README.md

@@ -1,29 +1,56 @@
 # jenkins-capistrano
 
-The capistrano tasks for Jenkins CI Server. Supports to manage following things:
+**Note**: 0.1.0 has incompatible change for Node creation.
+see [Release Notes](#release-notes) and [Node Configuration](#node-configuration) for detail.
+
+#### Table of Contents
+
+1. [Overview](#overview)
+1. [Installation](#installation)
+1. [Usage](#usage)
+  * [Job Configuration](#job-configuration)
+    * [Disabling Jobs](#disabling-jobs)
+  * [Node Configuration](#node-configuraton)
+    * [Note for the Credentials Plugin and multistage-extension]()
+  * [View Configuration](#view-configuraton)
+1. [Don't know how to write config.xml?](#dont-know-how-to-write-configxml)
+1. [Known Issues](#known-issues)
+  * [Using mutlibyte characters in config.xml](#using-multibyte-characters-in-configxml)
+1. [Todo](#todo)
+1. [Release Notes](#release-notes)
+1. [Contributing](#contributing)
+
+## Overview
+
+The capistrano tasks for Jenkins CI Server which manages following things:
 
 * Job
 * Node
 * View
-* Plugins(Experimental)
 
 ## Installation
 
 Add this line to your application's Gemfile::
 
-  gem 'jenkins-capistrano'
+```
+gem 'jenkins-capistrano'
+```
 
 And then execute::
 
-  $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as::
 
-  $ gem install jenkins-capistrano
+```
+$ gem install jenkins-capistrano
+```
 
-## Example
+## Usage
 
-See [example directory](https://github.com/cynipe/jenkins-capistrano/tree/develop/example>) or following instructions.
+See example directory or following instructions.
 
 ### Job Configuration
 
@@ -54,7 +81,7 @@ set :jenkins_host, 'http://localhost:8080'
 before 'deploy', 'jenkins:deploy_jobs'
 ```
 
-#### Want to disabling some jobs for specific environment?
+#### Disabling Jobs
 
 Since 0.0.5, you can disabling jobs using `disabled_jobs` option.
 Use this option with [multistage-extension](<https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension>).
@@ -64,7 +91,6 @@ Put the following line into `config/deploy/<env>.rb`:
 set :disabled_jobs, %w(job1 job2)
 ```
 
-
 ### Node Configuration
 
 config directory structure(name your json file as a node name):
@@ -73,32 +99,46 @@ config
 ├── deploy.rb
 └── jenkins
      └── nodes
-         ├── node1.json
-         ├── node2.json
-         └── node3.json
+         ├── node1.xml
+         ├── node2.xml
+         └── node3.xml
 ```
 
 sample node configuration:
-```json
-{
-  "name"        : "example",
-  "type"        : "hudson.slaves.DumbSlave$DescriptorImpl",
-  "description" : "some description",
-  "executors"   : 2,
-  "labels"      : "linux, java, ruby",
-  "slave_host"  : "example.com",
-  "slave_port"  : 22,
-  "slave_user"  : "jenkins",
-  "master_key"  : "/var/lib/jenkins/.ssh/id_rsa",
-  "slave_fs"    : "/home/jenkins",
-  "exclusive"   : true,
-  "java_path": "/opt/java/bin/java",
-  "jvm_options": "-Xmx512M",
-  "env_vars": {
-    "key1": "val1",
-    "key2": "val2"
-  }
-}
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>example</name>
+  <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-FOR-SLAVE</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>
 ```
 
 deploy.rb:
@@ -115,6 +155,62 @@ set :jenkins_host, 'http://localhost:8080'
 before 'deploy', 'jenkins:config_nodes'
 ```
 
+#### Note for the Credentials Plugin and multistage-extension
+
+Recently, Jenkins has changed the slave's auth method to use
+[Credentials Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Credentials+Plugin),
+and we need to use its id(credentialsId) to create slave configuration.
+However, Credentials Plugin doesn't have a REST interface to manage their credentials,
+and credentialsId is different on every Jenkins master.
+
+So, if you want to use same config.xml against different masters,
+use the ERB template support to specify correct credentialsId like as following:
+
+config/jenkins/nodes/node1.xml.erb:
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<slave>
+  <name>batch-slave</name>
+  <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>batch-slave</host>
+    <port>22</port>
+    <credentialsId><%= @credential_id %></credentialsId>
+    <jvmOptions>-Dfile.encoding=UTF-8</jvmOptions>
+  </launcher>
+  <label>hello</label>
+  <nodeProperties/>
+</slave>
+```
+
+config/deploy.rb
+```ruby
+set :application, "your-awesome-app"
+set :scm, :git
+set :repository,  "https://github.com/your/repository.git"
+
+set :jenkins_host, 'http://localhost:8080'
+before 'deploy', 'jenkins:config_nodes'
+```
+
+config/deploy/staging.rb:
+```xml
+set :jenkins_template_vars, {
+  :credential_id => 'STAGING-CREDENTIAL_ID'
+}
+```
+
+config/deploy/production.rb:
+```xml
+set :jenkins_template_vars, {
+  :credential_id => 'PRODUCTION-CREDENTIAL_ID'
+}
+```
+
 ### View Configuration
 
 config directory structure(name your json file as a node name):
@@ -166,37 +262,49 @@ set :jenkins_host, 'http://localhost:8080'
 before 'deploy', 'jenkins:config_views'
 ```
 
-#### Don't know how to write config.xml for view?
+## Don't know how to write config.xml?
 
-Create or configure the view you want to manage via usual operation through the Jenkins UI.
-Then, open the `JENKINS_HOME/config.xml` and copy the desired configuration from `<views>` section, and
-ommit `<owner class="hudson" reference="../../.."/>` line.
+First, create the job, node, or view you want to manage with via the Jenkins UI.
+Then, runnning following command to download them:
 
-### Plugin Configuration(experimental)
+```
+# For the job
+curl -o config/jenkins/jobs/<job_name>.xml http://jenkins.example.org/job/<job_name>/config.xml
 
-#### Note
+# For the node
+curl -o config/jenkins/nodes/<node_name>.xml http://jenkins.example.org/computer/<node_name>/config.xml
 
-This feature is may change its API without any notice.
-Use at your own risk.
+# For the view
+curl -o config/jenkins/views/<view_name>.xml http://jenkins.example.org/view/<view_name>/config.xml
+```
 
-deploy.rb:
-```ruby
-set :application, "your-awesome-app"
-set :scm, :git
-set :repository,  "https://github.com/your/repository.git"
+## Known Issues
+
+### Using mutlibyte characters in config.xml
 
-set :jenkins_plugins, %w(cron_column envinject join)
-# you can specify version as follows:
-#set :jenkins_plugins, %w(cron_column@1.1.2 envinject join@1.0.0)
-set :jenkins_install_timeout, 60 * 5      # default: 5min
-set :jenkins_plugin_enable_update, false  # dafault: false
-set :jenkins_plugin_enable_restart, false # default: false
+Until [jenkins_api_client PR143](https://github.com/arangamani/jenkins_api_client/pull/143) merged,
+put following code to your Gemfile:
 
-before 'deploy', 'jenkins:install_plugins'
+```ruby
+# FIXME after https://github.com/arangamani/jenkins_api_client/pull/143 merged
+gem 'jenkins_api_client', github: 'cynipe/jenkins_api_client', branch: 'fix-multibyte-configs'
 ```
 
+## TODO
+
+  * [ ] Reverse config support. something like `cap jenkins:reverse_job`
+  * [ ] CI cucumber tests on Wercker
+  * [ ] Capistrano v3 support
+  * [ ] Make examples triable on user's local
+  * [ ] Collect usage report using Google Analytics to see who uses this tool.
+
 ## Release Notes
 
+### 0.1.0
+  * **[INCOMPATIBLE CHANGE]** Remove plugin support
+  * **[INCOMPATIBLE CHANGE]** Change node configuration to use config.xml instead of json config
+  * Support erb template for config.xml(need to name the file xxx.xml.erb)
+
 ### 0.0.7
   * Fix disable_job is not working with recent version of Jenkins ([#9](https://github.com/cynipe/jenkins-capistrano/pull/9))
 
@@ -210,9 +318,14 @@ before 'deploy', 'jenkins:install_plugins'
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Added some feature'`)
+1. Run Integration tests as following:
+
+    $ vagrant up
+    $ bundle exec cucumber
+
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request
 
 [![githalytics.com alpha](https://cruel-carlota.pagodabox.com/e76247570c952ad3205ca7d6d3f0f7b5 "githalytics.com")](http://githalytics.com/cynipe/jenkins-capistrano)