hudson-remote-cli 0.0.1

data/lib/hudson-remote-cli/job.rb

@@ -0,0 +1,144 @@
+module Hudson
+  class Job < HudsonObject
+    attr_reader :name
+
+    class << self
+      def create(name, config_path)
+        name.strip!
+
+        config = File.open(config_path).read
+
+        res = send_xml_post_request(
+          uri_for(@@api_create_item, {:name => name}),
+          config
+        )
+        raise(APIError, "Error creating job #{name}: #{res.body}") if
+          res.class != Net::HTTPOK
+
+        Job.new(name)
+      end
+    end
+
+    def initialize(name)
+      name.strip!
+      raise "no job named #{name}!" unless Hudson.jobs.include?(name)
+      @name = name
+      load_json_api
+    end
+
+    def load_json_api
+      @api_job = "job/#{@name}/api/json"
+      @api_job_config = "job/#{@name}/config.xml"
+      @api_job_description = "job/#{@name}/description"
+      @api_job_build = "job/#{@name}/build"
+      @api_job_withparam_build = "job/#{@name}/buildWithParameters"
+      @api_job_delete = "job/#{@name}/doDelete"
+      @api_job_disable = "job/#{@name}/disable"
+      @api_job_enable = "job/#{@name}/enable"
+    end
+
+    def api(keys = nil, refresh = true)
+      api_base(@api_job, keys, refresh)
+    end
+
+    def active?
+      api('color')['color'].include?('anime')
+    end
+
+    def buildable?
+      api('buildable')['buildable']
+    end
+
+    def last_success_build
+      res = api('lastSuccessfulBuild[number]')['lastSuccessfulBuild']
+      res.nil? ? 0 : res['number']
+    end
+
+    def last_build
+      res = api('lastBuild[number]')['lastBuild']
+      res.nil? ? 0 : res['number']
+    end
+
+    def builds
+      res = api('builds[number]')['builds']
+      res.nil? ? [] : res.map { |b| b['number'] }
+    end
+
+    def update(config)
+      @config = File.open(config).read unless config.nil?
+      res = send_xml_post_request(uri_for(@api_job_config), @config)
+      @config = nil
+      res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+    end
+
+    def config
+      return @config unless @config.nil?
+      @config = get(uri_for(@api_job_config))
+      @config
+    end
+
+    def description
+      return @description unless @description.nil?
+      @description = get(uri_for(@api_job_description))
+      @description
+    end
+
+    def description=(description)
+      @description = description
+      send_post_request(uri_for(@api_job_description), {
+        :description => @description
+      })
+    end
+
+    def copy(name = nil)
+      name = "copy_of_#{@name}" if name.nil?
+      name.strip!
+      res = send_post_request(uri_for(@@api_create_item), {
+        :name => name,
+        :mode => 'copy',
+        :from => @name
+      })
+      raise(APIError, "Error copying job #{@name}: #{res.body}") if
+        res.class != Net::HTTPFound
+      Job.new(name)
+    end
+
+    def disable
+      res = send_post_request(uri_for(@api_job_disable))
+      res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+    end
+
+    def enable
+      res = send_post_request(uri_for(@api_job_enable))
+      res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+    end
+
+    def delete
+      res = send_post_request(uri_for(@api_job_delete))
+      res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+    end
+
+    def build(param = {})
+      response = nil
+      if param.size.eql? 0
+        response = send_post_request(uri_for(@api_job_build), {:delay => '0sec'})
+      else
+        param[:delay] = '0sec' unless param.has_key? :delay
+        response = send_post_request(uri_for(@api_job_withparam_build), param)
+      end
+      response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+    end
+
+    def build!(param = {})
+      build(param)
+      wait_for_build
+    end
+
+    def wait_for_build(poll_freq = 10)
+      loop do
+        break if !active? and !BuildQueue.list.include?(@name)
+        sleep poll_freq
+      end
+    end
+  end
+end

data/lib/hudson-remote-cli/system.rb

@@ -0,0 +1,18 @@
+module Hudson
+  class System < HudsonObject
+    class << self
+      def api(keys = nil, refresh = false)
+        api_base(@@api_hudson, keys, refresh)
+      end
+
+      def overallLoad(keys = nil, refresh = false)
+        api_base(@@api_overallLoad, keys, refresh)
+      end
+
+      def jobs(*param)
+        jobs = api('jobs[name]', true)
+        jobs['jobs'].map { |j| j['name'] }
+      end
+    end
+  end
+end

data/lib/hudson-remote-cli/version.rb

@@ -0,0 +1,3 @@
+module Hudson
+  VERSION = '0.0.1'
+end

data/lib/hudson-remote-cli.rb

@@ -0,0 +1,118 @@
+require 'net/http'
+require 'net/https'
+require 'rack/utils'
+require 'zlib'
+require 'json'
+require 'hudson-remote-cli/version'
+require 'hudson-remote-cli/config'
+
+module Hudson
+  autoload :System, 'hudson-remote-cli/system'
+  autoload :BuildQueue, 'hudson-remote-cli/build_queue'
+  autoload :Job, 'hudson-remote-cli/job'
+  autoload :Build, 'hudson-remote-cli/build'
+
+  class APIError < StandardError; end
+
+  class HudsonObject
+    def self.uri_for(path, query = {})
+      uri = URI.parse(URI.encode(File.join(Hudson[:url], path)))
+      uri.query = Rack::Utils.build_query(query)
+      uri
+    end
+
+    def uri_for(path, query = {})
+      self.class.uri_for(path, query)
+    end
+
+    def self.load_json_api
+      @@_api_cache = Hash.new
+
+      @@api_hudson = 'api/json'
+      @@api_create_item = 'createItem'
+      @@api_overallLoad = 'overallLoad/api/json'
+    end
+
+    load_json_api
+
+    def self.hudson_request(uri, request)
+       Net::HTTP.start(uri.host, uri.port) do |http|
+        http = Net::HTTP.new(uri.host, uri.port)
+        if uri.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        http.request(request)
+      end
+    end
+
+    def self.get(uri)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.basic_auth(Hudson[:user], Hudson[:password]) if
+        Hudson[:user] and Hudson[:password]
+      request['Content-Type'] = 'text/html'
+      response = hudson_request(uri, request)
+
+      if response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+        encoding = response.get_fields("Content-Encoding")
+        if encoding and encoding.include?("gzip")
+          return Zlib::GzipReader.new(StringIO.new(response.body)).read
+        else
+          return response.body
+        end
+      else
+        $stderr.puts response.body
+        raise APIError, "Error retrieving #{uri.request_uri}"
+      end
+    end
+
+    def get(uri)
+      self.class.get(uri)
+    end
+
+    def self.send_post_request(uri, data={})
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.basic_auth(Hudson[:user], Hudson[:password]) if
+        Hudson[:user] and Hudson[:password]
+      request.set_form_data(data)
+      hudson_request(uri, request)
+    end
+
+    def send_post_request(uri, data={})
+      self.class.send_post_request(uri, data)
+    end
+
+    def self.send_xml_post_request(uri, xml, data=nil)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['Content-Type'] = 'text/xml'
+      request.basic_auth(Hudson[:user], Hudson[:password]) if
+        Hudson[:user] and Hudson[:password]
+      request.set_form_data(data) if data
+      request.body = xml
+      hudson_request(uri,request)
+    end
+
+    def send_xml_post_request(uri, xml, data=nil)
+      self.class.send_xml_post_request(uri, xml, data)
+    end
+
+    def self.api_base(api, keys = nil, refresh = false)
+      cache_key = [api, keys.nil? ? '__ALL__' : keys].join '_'
+
+      return @@_api_cache[cache_key] if
+        @@_api_cache.has_key?(cache_key) and not refresh
+
+      json = get(uri_for(api, keys.nil? ? {} : {:tree => keys}))
+      @@_api_cache[cache_key] = JSON.load(json)
+      @@_api_cache[cache_key]
+    end
+
+    def api_base(api, keys = nil, refresh = false)
+      self.class.api_base(api, keys, refresh)
+    end
+  end
+
+  def self.method_missing(method, *args, &block)
+    Hudson::System.send(method, *args, block)
+  end
+end

data/spec/build_queue_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module Hudson
+  describe BuildQueue do
+    describe '#api' do
+      it 'should be a Hash' do
+        api = BuildQueue.api
+        api.class.should eq(Hash)
+      end
+
+      it 'should be only jobs[name, color]' do
+        jobs = BuildQueue.api('items[task[name]]')
+        jobs.keys.should eq(['items'])
+      end
+    end
+  end
+end

data/spec/config.xml

@@ -0,0 +1,258 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<project>
+  <actions/>
+  <description></description>
+  <project-properties class="java.util.concurrent.ConcurrentHashMap">
+    <entry>
+      <string>blockBuildWhenDownstreamBuilding</string>
+      <boolean-property>
+        <originalValue class="boolean">false</originalValue>
+        <propertyOverridden>false</propertyOverridden>
+      </boolean-property>
+    </entry>
+    <entry>
+      <string>org-hudsonci-plugins-snapshotmonitor-SnapshotTrigger</string>
+      <trigger-property>
+        <propertyOverridden>false</propertyOverridden>
+      </trigger-property>
+    </entry>
+    <entry>
+      <string>org-hudsonci-plugins-snapshotmonitor-WatchedDependenciesProperty</string>
+      <base-property>
+        <propertyOverridden>false</propertyOverridden>
+      </base-property>
+    </entry>
+    <entry>
+      <string>logRotator</string>
+      <log-rotator-property>
+        <propertyOverridden>false</propertyOverridden>
+      </log-rotator-property>
+    </entry>
+    <entry>
+      <string>au-com-centrumsystems-hudson-plugin-buildpipeline-trigger-BuildPipelineTrigger</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>blockBuildWhenUpstreamBuilding</string>
+      <boolean-property>
+        <originalValue class="boolean">false</originalValue>
+        <propertyOverridden>false</propertyOverridden>
+      </boolean-property>
+    </entry>
+    <entry>
+      <string>scmCheckoutRetryCount</string>
+      <integer-property>
+        <propertyOverridden>false</propertyOverridden>
+      </integer-property>
+    </entry>
+    <entry>
+      <string>hudson-plugins-promoted_builds-JobPropertyImpl</string>
+      <base-property>
+        <propertyOverridden>false</propertyOverridden>
+      </base-property>
+    </entry>
+    <entry>
+      <string>org-hudsonci-maven-plugin-dependencymonitor-DependencyNotifier</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>hudson-plugins-git-GitPublisher</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>org-hudsonci-maven-plugin-artifactrecorder-ArtifactArchiver</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>hudson-tasks-Mailer</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>cleanWorkspaceRequired</string>
+      <boolean-property>
+        <originalValue class="boolean">false</originalValue>
+        <propertyOverridden>false</propertyOverridden>
+      </boolean-property>
+    </entry>
+    <entry>
+      <string>hudson-tasks-test-AggregatedTestResultPublisher</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>hudson-tasks-junit-JUnitResultArchiver</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>hudson-tasks-Fingerprinter</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>hudson-plugins-ansicolor-AnsiColorBuildWrapper</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>true</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>hudson-plugins-downstream_ext-DownstreamTrigger</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>hudson-tasks-JavadocArchiver</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>parametersDefinitionProperties</string>
+      <copy-write-list-property>
+        <originalValue class="hudson.util.CopyOnWriteList"/>
+        <propertyOverridden>false</propertyOverridden>
+      </copy-write-list-property>
+    </entry>
+    <entry>
+      <string>customWorkspace</string>
+      <string-property>
+        <propertyOverridden>false</propertyOverridden>
+      </string-property>
+    </entry>
+    <entry>
+      <string>quietPeriod</string>
+      <integer-property>
+        <propertyOverridden>false</propertyOverridden>
+      </integer-property>
+    </entry>
+    <entry>
+      <string>hudson-tasks-BuildTrigger</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>hudson-triggers-SCMTrigger</string>
+      <trigger-property>
+        <propertyOverridden>false</propertyOverridden>
+      </trigger-property>
+    </entry>
+    <entry>
+      <string>builders</string>
+      <describable-list-property>
+        <originalValue class="hudson.util.DescribableList">
+          <hudson.tasks.Shell>
+            <command>echo nice
+sleep 10</command>
+          </hudson.tasks.Shell>
+        </originalValue>
+        <propertyOverridden>false</propertyOverridden>
+      </describable-list-property>
+    </entry>
+    <entry>
+      <string>jdk</string>
+      <string-property>
+        <propertyOverridden>false</propertyOverridden>
+      </string-property>
+    </entry>
+    <entry>
+      <string>appointedNode</string>
+      <base-property>
+        <propertyOverridden>false</propertyOverridden>
+      </base-property>
+    </entry>
+    <entry>
+      <string>hudson-plugins-perforce-PerforceTagNotifier</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>concurrentBuild</string>
+      <boolean-property>
+        <originalValue class="boolean">false</originalValue>
+        <propertyOverridden>false</propertyOverridden>
+      </boolean-property>
+    </entry>
+    <entry>
+      <string>hudson-tasks-ArtifactArchiver</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+    <entry>
+      <string>org-hudsonci-maven-plugin-dependencymonitor-DependencyTrigger</string>
+      <trigger-property>
+        <propertyOverridden>false</propertyOverridden>
+      </trigger-property>
+    </entry>
+    <entry>
+      <string>scm</string>
+      <scm-property>
+        <originalValue class="hudson.scm.NullSCM"/>
+        <propertyOverridden>false</propertyOverridden>
+      </scm-property>
+    </entry>
+    <entry>
+      <string>hudson-triggers-TimerTrigger</string>
+      <trigger-property>
+        <propertyOverridden>false</propertyOverridden>
+      </trigger-property>
+    </entry>
+    <entry>
+      <string>org-hudsonci-maven-plugin-artifactrecorder-ArtifactFingerprinter</string>
+      <external-property>
+        <propertyOverridden>false</propertyOverridden>
+        <modified>false</modified>
+      </external-property>
+    </entry>
+  </project-properties>
+  <keepDependencies>false</keepDependencies>
+  <createdBy>im-op</createdBy>
+  <creationTime>1375924970937</creationTime>
+  <properties/>
+  <cascadingChildrenNames class="java.util.concurrent.CopyOnWriteArraySet"/>
+  <cascading-job-properties class="java.util.concurrent.CopyOnWriteArraySet">
+    <string>org-hudsonci-plugins-snapshotmonitor-WatchedDependenciesProperty</string>
+    <string>hudson-plugins-promoted_builds-JobPropertyImpl</string>
+  </cascading-job-properties>
+  <scm class="hudson.scm.NullSCM"/>
+  <canRoam>false</canRoam>
+  <disabled>false</disabled>
+  <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <triggers class="vector"/>
+  <concurrentBuild>false</concurrentBuild>
+  <cleanWorkspaceRequired>false</cleanWorkspaceRequired>
+  <builders/>
+  <publishers/>
+  <buildWrappers/>
+</project>

data/spec/job_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module Hudson
+  describe Job, Build do
+    let (:job_name) { 'hudson-remote-cli-test' }
+    let (:job_conf) { File.join(File.dirname(__FILE__), 'config.xml') }
+
+    describe '#create' do
+      it 'should be a new job in test hudson' do
+        Hudson::Job.create job_name, job_conf
+        Hudson.jobs.include?(job_name).should be_true
+      end
+    end
+
+    describe 'Job Actions' do
+      before(:each) do
+        @job = Hudson::Job.new(job_name)
+      end
+
+      it 'should be job_name' do
+        @job.name.should eq(job_name)
+      end
+
+      context 'job enable/disable test' do
+        after(:each) { @job.enable }
+
+        it 'should be enabled' do
+          @job.enable
+          @job.buildable?.should be_true
+        end
+
+        it 'should be disabled' do
+          @job.disable
+          @job.buildable?.should be_false
+        end
+      end
+
+      context 'job description set/get' do
+        it 'shoud be "test success"' do
+          @job.description = 'test success'
+          @job.description.should eq('test success')
+        end
+      end
+
+      context 'job build/active/lastnumber test' do
+        before(:each) do
+          @job.wait_for_build
+          @last_number = @job.last_build
+        end
+
+        it 'should be trigger a build' do
+          @job.build!
+          last_number = @job.last_build
+          (last_number - @last_number).should eq(1)
+        end
+      end
+    end
+
+    describe 'build test' do
+      before(:each) do
+        @build = Hudson::Build.new(job_name)
+      end
+
+      it 'should be 1' do
+        @build.number.should eq(1)
+      end
+
+      it 'should be suit for the time in record' do
+        (10 - (@build.end_time - @build.start_time)).should < 2
+      end
+    end
+
+    describe '#delete' do
+      it 'should be no test_job more' do
+        @job = Hudson::Job.new(job_name)
+        @job.delete
+        Hudson.jobs.include?(job_name).should be_false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'hudson-remote-cli'
+require 'rspec'
+
+Hudson[:url] = 'http://localhost:8235/hudson'
+Hudson[:user] = 'test'
+Hudson[:password] = 'test'

data/spec/system_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Hudson
+  describe System do
+    describe '#api' do
+      it 'should be a Hash' do
+        api = Hudson.api
+        api.class.should eq(Hash)
+      end
+
+      it 'should be only jobs[name, color]' do
+        jobs = Hudson.api('jobs[name,color]')
+        jobs.keys.should eq(['jobs'])
+      end
+    end
+
+    describe '#overallLoad' do
+      it 'should be 4 keys at least' do
+        api = Hudson.overallLoad
+        (%w{busyExecutors queueLength totalExecutors totalQueueLength} -
+          api.keys).should eq([])
+      end
+    end
+  end
+end