jenkins-capistrano 0.0.7 → 0.1.0

data/features/config_nodes.feature

@@ -0,0 +1,121 @@
+Feature: Configuring Nodes
+
+  Scenario: Configuring the new node
+    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/nodes/node1.xml" with:
+    """
+    <?xml version="1.0" encoding="UTF-8"?>
+    <slave>
+      <name>node1</name>
+      <description>Created</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>node1.lan</host>
+        <port>22</port>
+        <credentialsId>credential</credentialsId>
+      </launcher>
+      <label/>
+      <nodeProperties/>
+    </slave>
+    """
+    When I successfully run `bundle exec cap jenkins:config_nodes`
+    Then the output should contain:
+      """
+      node node1 created.
+      """
+    And the Jenkins has following nodes:
+      | Name  | Description |
+      | node1 | Created     |
+
+  Scenario: Configuring the node already created
+    Given the Jenkins server has following nodes:
+      | Name  | Description |
+      | node1 | Created     |
+    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/nodes/node1.xml" with:
+    """
+    <?xml version="1.0" encoding="UTF-8"?>
+    <slave>
+      <name>node1</name>
+      <description>Updated</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>node1.lan</host>
+        <port>22</port>
+        <credentialsId>credential</credentialsId>
+      </launcher>
+      <label/>
+      <nodeProperties/>
+    </slave>
+    """
+    When I successfully run `bundle exec cap jenkins:config_nodes`
+    Then the output should contain:
+      """
+      node node1 created.
+      """
+    And the Jenkins has following nodes:
+      | Name  | Description |
+      | node1 | Updated     |
+
+  Scenario: Configuring the nodes 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/nodes/node1.xml.erb" with:
+    """
+    <?xml version="1.0" encoding="UTF-8"?>
+    <slave>
+      <name>node1</name>
+      <description><%= @templated %></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>node1.lan</host>
+        <port>22</port>
+        <credentialsId>credential</credentialsId>
+      </launcher>
+      <label/>
+      <nodeProperties/>
+    </slave>
+    """
+    When I successfully run `bundle exec cap jenkins:config_nodes`
+    Then the Jenkins has following nodes:
+      | Name  | Description |
+      | node1 | Yay!!       |
+    And the output should contain:
+      """
+      node node1 created.
+      """

data/features/config_views.feature

@@ -0,0 +1,136 @@
+Feature: Configuring Views
+
+  Scenario: Configuring the new view
+    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/views/view1.xml" with:
+    """
+    <listView>
+      <name>view1</name>
+      <description>Created</description>
+      <filterExecutors>false</filterExecutors>
+      <filterQueue>false</filterQueue>
+      <properties class="hudson.model.View$PropertyList"/>
+      <jobNames class="tree-set">
+        <comparator class="hudson.util.CaseInsensitiveComparator" reference="../../../hudson.plugins.view.dashboard.Dashboard/jobNames/comparator"/>
+      </jobNames>
+      <jobFilters/>
+      <columns>
+        <hudson.views.StatusColumn/>
+        <hudson.views.WeatherColumn/>
+        <hudson.views.JobColumn/>
+        <hudson.views.LastSuccessColumn/>
+        <hudson.views.LastFailureColumn/>
+        <hudson.views.LastDurationColumn/>
+        <hudson.views.BuildButtonColumn/>
+      </columns>
+      <includeRegex>.*</includeRegex>
+    </listView>
+    """
+    When I successfully run `bundle exec cap jenkins:config_views`
+    Then the output should contain:
+      """
+      view view1 created.
+      """
+    And the Jenkins has following views:
+      | Name  | Description |
+      | view1 | Created     |
+
+  Scenario: Configuring the view already created
+    Given the Jenkins server has following views:
+      | Name  | Description |
+      | view1 | Created     |
+    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/views/view1.xml" with:
+    """
+    <listView>
+      <name>view1</name>
+      <description>Updated</description>
+      <filterExecutors>false</filterExecutors>
+      <filterQueue>false</filterQueue>
+      <properties class="hudson.model.View$PropertyList"/>
+      <jobNames class="tree-set">
+        <comparator class="hudson.util.CaseInsensitiveComparator" reference="../../../hudson.plugins.view.dashboard.Dashboard/jobNames/comparator"/>
+      </jobNames>
+      <jobFilters/>
+      <columns>
+        <hudson.views.StatusColumn/>
+        <hudson.views.WeatherColumn/>
+        <hudson.views.JobColumn/>
+        <hudson.views.LastSuccessColumn/>
+        <hudson.views.LastFailureColumn/>
+        <hudson.views.LastDurationColumn/>
+        <hudson.views.BuildButtonColumn/>
+      </columns>
+      <includeRegex>.*</includeRegex>
+    </listView>
+    """
+    When I successfully run `bundle exec cap jenkins:config_views`
+    Then the output should contain:
+      """
+      view view1 created.
+      """
+    And the Jenkins has following views:
+      | Name  | Description |
+      | view1 | Updated     |
+
+  Scenario: Configuring the views 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/views/view1.xml.erb" with:
+    """
+    <listView>
+      <name>view1</name>
+      <description><%= @templated %></description>
+      <filterExecutors>false</filterExecutors>
+      <filterQueue>false</filterQueue>
+      <properties class="hudson.model.View$PropertyList"/>
+      <jobNames class="tree-set">
+        <comparator class="hudson.util.CaseInsensitiveComparator" reference="../../../hudson.plugins.view.dashboard.Dashboard/jobNames/comparator"/>
+      </jobNames>
+      <jobFilters/>
+      <columns>
+        <hudson.views.StatusColumn/>
+        <hudson.views.WeatherColumn/>
+        <hudson.views.JobColumn/>
+        <hudson.views.LastSuccessColumn/>
+        <hudson.views.LastFailureColumn/>
+        <hudson.views.LastDurationColumn/>
+        <hudson.views.BuildButtonColumn/>
+      </columns>
+      <includeRegex>.*</includeRegex>
+    </listView>
+    """
+    When I successfully run `bundle exec cap jenkins:config_views`
+    Then the Jenkins has following views:
+      | Name  | Description |
+      | view1 | Yay!!       |
+    And the output should contain:
+      """
+      view view1 created.
+      """

data/features/help.feature

@@ -0,0 +1,83 @@
+Feature: Help
+
+  Scenario: Show help for all tasks
+    Given a file named "Capfile" with:
+      """
+      require 'jenkins-capistrano'
+      """
+    When I successfully run `bundle exec cap -T`
+    Then the output should contain:
+      """
+      cap invoke               # Invoke a single command on the remote servers.
+      cap jenkins:config_jobs  # Configure the jobs to Jenkins server.
+      cap jenkins:config_nodes # Configure the nodes to Jenkins server.
+      cap jenkins:config_views # Configure the views to Jenkins server.
+      cap jenkins:deploy_jobs  # [DEPRECATED] Use jenkins:config_jobs instead.
+      cap shell                # Begin an interactive Capistrano session.
+      """
+
+  Scenario: Show help for config_jobs
+    Given a file named "Capfile" with:
+      """
+      require 'jenkins-capistrano'
+      """
+    When I successfully run `bundle exec cap -e jenkins:config_jobs`
+    Then the output should contain:
+      """
+      Configure the jobs to Jenkins server.
+
+      Configuration
+      -------------
+      jenkins_job_config_dir
+          the directory path where the config.xml stored.
+          default: 'config/jenkins/jobs'
+
+      disabled_jobs
+          job names array which should be disabled after deployment.
+          default: []
+      """
+
+  Scenario: Show help for config_jobs
+    Given a file named "Capfile" with:
+      """
+      require 'jenkins-capistrano'
+      """
+    When I successfully run `bundle exec cap -e jenkins:deploy_jobs`
+    Then the output should contain:
+      """
+      [DEPRECATED] Use jenkins:config_jobs instead.
+      """
+
+  Scenario: Show help for config_nodes
+    Given a file named "Capfile" with:
+      """
+      require 'jenkins-capistrano'
+      """
+    When I successfully run `bundle exec cap -e jenkins:config_nodes`
+    Then the output should contain:
+      """
+      Configure the nodes to Jenkins server.
+
+      Configuration
+      -------------
+      jenkins_node_config_dir
+          the directory path where the node's configuration stored.
+          default: 'config/jenkins/nodes'
+      """
+
+  Scenario: Show help for config_views
+    Given a file named "Capfile" with:
+      """
+      require 'jenkins-capistrano'
+      """
+    When I successfully run `bundle exec cap -e jenkins:config_views`
+    Then the output should contain:
+      """
+      Configure the views to Jenkins server.
+
+      Configuration
+      -------------
+      jenkins_view_config_dir
+          the directory path where the view's configuration stored.
+          default: 'config/jenkins/views'
+      """

data/features/step_definitions/jenkins_steps.rb

@@ -0,0 +1,19 @@
+
+Given(/^the plain Jenkins server$/) do
+  %w(job node view).each {|t| api.send(t.to_sym).delete_all! }
+end
+
+Then(/^the Jenkins has following (job|node|view)s:$/) do |type, table|
+  jenkins_has_following_configs type, table
+end
+
+Given(/^the Jenkins server has following (job|node|view)s:$/) do |type, table|
+  step 'the plain Jenkins server'
+  table.hashes.each do |row|
+    args = [row['Name'], row['Description'], row['Disabled']].compact
+    send("create_#{type}".to_sym, *args)
+  end
+  # TODO want to call Then step with table inside of Given step, but have no idea.
+  # step "Given the Jenkins has following #{type}s:", table
+  jenkins_has_following_configs type, table
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'pry'
+require 'aruba/cucumber'
+Before do
+  @aruba_timeout_seconds = 600
+end

data/features/support/jenkins_helper.rb

@@ -0,0 +1,113 @@
+require 'jenkins_api_client'
+require 'nokogiri'
+
+module JenkinsHelper
+
+  def api
+    @api ||= JenkinsApi::Client.new(
+      :server_url   => 'http://localhost:8080',
+      :log_location => '/dev/null'
+    )
+  end
+
+  def exists?(type, name)
+    return api.job.exists?(name) if type == 'job'
+    api.send(type.to_s).list.include? name
+  end
+
+  def config(type, name)
+    Nokogiri::XML(api.send(type.to_sym).get_config(name))
+  end
+
+  def description(type, name)
+    config(type, name).xpath('//description').text
+  end
+
+  def job_disabled?(name)
+    config(:job, name).xpath('//disabled').text
+  end
+
+  def jenkins_has_following_configs(type, table)
+    table.hashes.each do |row|
+      expect(exists?(type, row['Name'])).to eql true
+      expect(description(type, row['Name'])).to eql row['Description']
+      if disabled = row['Disabled'] # only for the jobs
+        expect(job_disabled?(row['Name'])).to eql disabled
+      end
+    end
+  end
+
+  def create_job(name, description, disabled)
+    api.job.create(name, <<-XML.gsub(/^ +/, ''))
+      <?xml version="1.0" encoding="UTF-8"?>
+      <project>
+        <actions/>
+        <description>#{description}</description>
+        <keepDependencies>false</keepDependencies>
+        <properties/>
+        <scm class="hudson.scm.NullSCM"/>
+        <canRoam>true</canRoam>
+        <disabled>#{disabled}</disabled>
+        <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+        <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+        <jdk>Default</jdk>
+        <triggers/>
+        <concurrentBuild>false</concurrentBuild>
+        <builders/>
+        <publishers/>
+      </project>
+    XML
+  end
+
+  def create_node(name, description)
+    params =  { :name => name, :slave_host => 'dummy-by-jenkins-capistrano', :private_key_file => 'dummy' }
+    api.node.create_dumb_slave(params)
+    api.node.post_config(name, <<-XML.gsub(/^ +/, ''))
+      <?xml version="1.0" encoding="UTF-8"?>
+      <slave>
+        <name>#{name}</name>
+        <description>#{description}</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>node1.lan</host>
+          <port>22</port>
+          <credentialsId>credential</credentialsId>
+        </launcher>
+        <label/>
+        <nodeProperties/>
+      </slave>
+    XML
+  end
+
+  def create_view(name, description)
+    api.view.create name
+    api.view.post_config(name, <<-XML.gsub(/^ +/, ''))
+      <listView>
+        <name>#{name}</name>
+        <description>#{description}</description>
+        <filterExecutors>false</filterExecutors>
+        <filterQueue>false</filterQueue>
+        <properties class="hudson.model.View$PropertyList"/>
+        <jobNames class="tree-set">
+          <comparator class="hudson.util.CaseInsensitiveComparator" reference="../../../hudson.plugins.view.dashboard.Dashboard/jobNames/comparator"/>
+        </jobNames>
+        <jobFilters/>
+        <columns>
+          <hudson.views.StatusColumn/>
+          <hudson.views.WeatherColumn/>
+          <hudson.views.JobColumn/>
+          <hudson.views.LastSuccessColumn/>
+          <hudson.views.LastFailureColumn/>
+          <hudson.views.LastDurationColumn/>
+          <hudson.views.BuildButtonColumn/>
+        </columns>
+        <includeRegex>.*</includeRegex>
+      </listView>
+    XML
+  end
+
+end
+World(JenkinsHelper)