gocd 0.5 → 1.0

data/lib/gocd/pipeline_config/job.rb

@@ -0,0 +1,21 @@
+require_relative './pipeline_config'
+
+module GOCD
+  module PIPELINE_CONFIG
+    class Job
+      include GOCD::PIPELINE_CONFIG
+      attr_reader :pipeline, :stage, :name, :resources
+
+      def initialize(pipeline, stage, data)
+        @pipeline = pipeline
+        @stage = stage
+        @name = data['name']
+        @resources = data['resources'].nil? ? [] : to_array(data['resources']['resource'])
+      end
+
+      def pipeline=(new_name)
+        @pipeline = new_name
+      end
+    end
+  end
+end

data/lib/gocd/pipeline_config/pipeline.rb

@@ -0,0 +1,30 @@
+require_relative './stage'
+
+module GOCD
+  module PIPELINE_CONFIG
+    class Pipeline
+      include GOCD::PIPELINE_CONFIG
+      attr_reader :name, :stages, :template
+
+      def initialize(data)
+        @template = data['template']
+        @name = data['name']
+        @stages = to_stages(data['stage']) || []
+      end
+
+      def has_template?
+        !template.nil?
+      end
+
+      def name=(new_name)
+        @name = new_name
+        @stages.each { |stage| stage.pipeline = new_name }
+      end
+
+      private
+      def to_stages(data)
+        to_array(data).map { |stage| GOCD::PIPELINE_CONFIG::Stage.new(name, stage) } unless data.nil?
+      end
+    end
+  end
+end

data/lib/gocd/pipeline_config/pipeline_config.rb

@@ -0,0 +1,72 @@
+require_relative './environment'
+require_relative './pipeline_group'
+require_relative './pipeline'
+require_relative './repository/pipeline_config_repository'
+
+module GOCD
+  module PIPELINE_CONFIG
+    @config_response = nil
+
+    def environments
+      raw_environments = to_array(pipeline_config_response["cruise"]["environments"]["environment"])
+      environments = raw_environments.map do |environment|
+        GOCD::PIPELINE_CONFIG::Environment.new(environment)
+      end
+
+      add_pipelines_to_environments environments, pipelines
+      environments
+    end
+
+    def pipelines
+      pipelines = groups.map { |group| group.pipelines }.flatten
+      merge_pipelines_with_templates pipelines, templates
+    end
+
+    def templates
+      raw_templates = to_array(pipeline_config_response["cruise"]["templates"]["pipeline"])
+      raw_templates.map { |template| GOCD::PIPELINE_CONFIG::Template.new(template) }
+    end
+
+    def groups
+      raw_groups = to_array(pipeline_config_response['cruise']['pipelines'])
+      raw_groups.map do |group|
+        GOCD::PIPELINE_CONFIG::PipelineGroup.new(group)
+      end
+    end
+
+    def pipeline_config_response
+      @config_response ||= PipelineConfigRepository.fetch_config
+    end
+
+    def to_array(data)
+      [data].compact.flatten
+    end
+
+    private
+    def add_pipelines_to_environments(environments, pipelines)
+      environments.each do |environment|
+        pipelines_for_env = []
+        environment.pipeline_names.each do |pipeline|
+          pipelines_for_env << pipelines.select { |p| p.name == pipeline }
+        end
+        environment.enrich_with_pipelines pipelines_for_env.flatten.compact
+      end
+    end
+
+    def merge_pipelines_with_templates(pipelines, templates)
+      pipeline_with_templates = pipelines.select { |p| p.has_template? }
+      standalone_pipelines = pipelines - pipeline_with_templates
+
+      pipelines_merged_with_templates = pipeline_with_templates.map do |pwt|
+        matched_template = templates.select { |t| t.name.upcase == pwt.template.upcase }
+        if matched_template.size > 0
+          matched_template.first.name = pwt.name
+          matched_template
+        else
+          pwt
+        end
+      end
+      [standalone_pipelines + pipelines_merged_with_templates].flatten.compact
+    end
+  end
+end

data/lib/gocd/pipeline_config/pipeline_group.rb

@@ -0,0 +1,20 @@
+require_relative './pipeline'
+
+module GOCD
+  module PIPELINE_CONFIG
+    class PipelineGroup
+      include GOCD::PIPELINE_CONFIG
+      attr_reader :name, :pipelines
+
+      def initialize(group_data)
+        @name = group_data['group']
+        @pipelines = to_pipelines(group_data['pipeline']) || []
+      end
+
+      private
+      def to_pipelines(pipelines_data)
+        to_array(pipelines_data).map { |pipeline| GOCD::PIPELINE_CONFIG::Pipeline.new(pipeline) } unless pipelines_data.nil?
+      end
+    end
+  end
+end

data/lib/gocd/pipeline_config/repository/pipeline_config_repository.rb

@@ -0,0 +1,11 @@
+require 'active_support/core_ext/hash/conversions'
+
+module GOCD
+  module PIPELINE_CONFIG
+    class PipelineConfigRepository
+      def self.fetch_config
+        Hash.from_xml(`curl -s -k -u #{GOCD.credentials.curl_credentials} #{GOCD.server.url}/go/api/admin/config/current.xml`)
+      end
+    end
+  end
+end

data/lib/gocd/pipeline_config/stage.rb

@@ -0,0 +1,26 @@
+require_relative './job'
+
+module GOCD
+  module PIPELINE_CONFIG
+    class Stage
+      include GOCD::PIPELINE_CONFIG
+      attr_reader :pipeline, :name, :jobs
+
+      def initialize(pipeline, data)
+        @pipeline = pipeline
+        @name = data['name']
+        @jobs = data['jobs'].nil? ? [] : to_jobs(data['jobs']['job'])
+      end
+
+      def pipeline=(new_name)
+        @pipeline = new_name
+        @jobs.each { |job| job.pipeline = new_name }
+      end
+
+      private
+      def to_jobs(data)
+        to_array(data).map { |job| GOCD::PIPELINE_CONFIG::Job.new(pipeline, name, job) }
+      end
+    end
+  end
+end

data/lib/gocd/pipeline_config/template.rb

@@ -0,0 +1,6 @@
+module GOCD
+  module PIPELINE_CONFIG
+    class Template < Pipeline
+    end
+  end
+end

data/lib/gocd/version.rb

@@ -1,3 +1,3 @@
 module GOCD
-  VERSION = '0.5'
+  VERSION = '1.0'
 end

data/spec/gocd/agents/agent_spec.rb

@@ -0,0 +1,98 @@
+require './lib/gocd/agents/agent'
+
+RSpec.describe GOCD::Agent, 'agent' do
+
+  agent_response = {
+      'hostname' => 'agent 1',
+      'uuid' => '1a2s3d4f',
+      'operating_system' => 'Linux',
+      'free_space' => 76202504192,
+      'agent_state' => 'Idle',
+      'resources' => %w(java automation),
+      'environments' => %w(iOS android),
+      'sandbox' => '/Applications/GoAgent.app',
+      'agent_config_state' => 'Disabled',
+      'ip_address' => '10.0.0.1'
+  }
+
+  context 'agent getters' do
+    before(:each) do
+      @agent = GOCD::Agent.new agent_response
+    end
+
+    it '#name should return agent name' do
+      expect(@agent.name).to eq 'agent 1'
+    end
+
+    it '#uuid should return agent uuid' do
+      expect(@agent.uuid).to eq '1a2s3d4f'
+    end
+
+    it '#os should return agent operating system' do
+      expect(@agent.os).to eq 'Linux'
+    end
+
+    it '#free_space should return free space on agent' do
+      expect(@agent.free_space).to eq 76202504192
+    end
+
+    it '#state should return agent state' do
+      expect(@agent.state).to eq 'Idle'
+    end
+
+    it '#resources should return agent resources' do
+      expect(@agent.resources).to eq %w(java automation)
+    end
+
+    it '#has_resource should return true when agent has given resource' do
+      expect(@agent.has_resource 'java').to be_truthy
+    end
+
+    it '#has_resource should return false when agent does not have given resource' do
+      expect(@agent.has_resource 'abcd').to be_falsy
+    end
+
+    it '#environments should return agent environments' do
+      expect(@agent.environments).to eq %w(iOS android)
+    end
+
+    it '#has_environment should return true when agent has given environment' do
+      expect(@agent.has_environment 'iOS').to be_truthy
+    end
+
+    it '#has_environment should return false when agent does not have given environment' do
+      expect(@agent.has_environment 'abcd').to be_falsy
+    end
+
+    it '#location should return agent sandbox location' do
+      expect(@agent.location).to eq '/Applications/GoAgent.app'
+    end
+
+    it '#idle? should return true when agent is Idle' do
+      expect(@agent.idle?).to be_truthy
+    end
+
+    it '#building? should return true when agent is Building' do
+      agent_response['agent_state'] = 'Building'
+      @agent = GOCD::Agent.new agent_response
+      expect(@agent.building?).to be_truthy
+    end
+
+    it '#missing? should return true when agent is Missing' do
+      agent_response['agent_state'] = 'Missing'
+      @agent = GOCD::Agent.new agent_response
+      expect(@agent.missing?).to be_truthy
+    end
+
+    it '#disabled? should return true when agent is disabled' do
+      expect(@agent.disabled?).to be_truthy
+    end
+
+    it '#disabled? should return false when agent is not disabled' do
+      agent_response['agent_config_state'] = 'Running'
+      @agent = GOCD::Agent.new agent_response
+      expect(@agent.disabled?).to be_falsy
+    end
+  end
+
+end

data/spec/gocd/agents/agents_repository_spec.rb

@@ -0,0 +1,79 @@
+require_relative '../../../lib/gocd/agents/agents_repository'
+require_relative '../../../lib/gocd/config/credentials'
+require_relative '../../../lib/gocd/config/server'
+require_relative '../../../lib/gocd/exception/data_fetch_exception'
+
+
+def setup_credential_and_server
+  GOCD.credentials = GOCD::Credentials.new 'admin', 'password'
+  GOCD.server = GOCD::Server.new 'http://gocd.com'
+end
+
+RSpec.describe GOCD::AgentRepository, 'agent' do
+
+  response_json = '{
+  "_embedded": {
+    "agents": [
+      {
+        "uuid": "1q2w3e4r",
+        "hostname": "agent 1",
+        "ip_address": "10.131.2.150",
+        "sandbox": "/Applications/GoAgent.app",
+        "operating_system": "Mac OS X",
+        "free_space": 76202508288,
+        "agent_config_state": "Enabled",
+        "agent_state": "Idle",
+        "build_state": "Idle",
+        "resources": [
+          "java",
+          "automation"
+        ],
+        "environments": [
+          "Automation",
+          "iOS"
+        ]
+      },
+      {
+        "uuid": "0p9o8i7u",
+        "hostname": "agent 2",
+        "ip_address": "10.131.2.150",
+        "sandbox": "/Applications/GoAgent.app.2",
+        "operating_system": "Mac OS X",
+        "free_space": 76202504192,
+        "agent_config_state": "Enabled",
+        "agent_state": "Idle",
+        "build_state": "Idle",
+        "resources": [
+          "promotion"
+        ],
+        "environments": [
+          "iOS"
+        ]
+      }
+    ]
+  }
+}'
+
+  it '#agents should return all agent' do
+    setup_credential_and_server
+    curl_command = "curl -s -k -u admin:password http://gocd.com/go/api/agents -H 'Accept: application/vnd.go.cd.v4+json'"
+    expect(GOCD::AgentRepository).to receive(:`).with(curl_command).and_return(response_json)
+
+    agents = GOCD::AgentRepository.agents
+    expect(agents.size).to eq 2
+    expect(agents[0].name).to eq 'agent 1'
+    expect(agents[0].uuid).to eq '1q2w3e4r'
+    expect(agents[1].name).to eq 'agent 2'
+    expect(agents[1].uuid).to eq '0p9o8i7u'
+
+  end
+
+  it '#agents should raise GOCDDataFetchException exception' do
+    GOCD::AgentRepository.instance_variable_set(:@agents, nil)
+    setup_credential_and_server
+    curl_command = "curl -s -k -u admin:password http://gocd.com/go/api/agents -H 'Accept: application/vnd.go.cd.v4+json'"
+    expect(GOCD::AgentRepository).to receive(:`).with(curl_command).and_return(nil)
+
+    expect{GOCD::AgentRepository.agents}.to raise_error(GOCDDataFetchException).with_message('Could not fetch data from server!!')
+  end
+end

data/spec/gocd/agents/agents_spec.rb

@@ -0,0 +1,37 @@
+require './lib/gocd/agents/agents'
+require_relative '../../../lib/gocd/agents/agents_repository'
+
+
+RSpec.describe GOCD::Agents, 'agents' do
+
+  context 'All Agents' do
+
+    it '#idle should filter out idle agents' do
+      agent1 = instance_double('agent', :idle? => true)
+      agent2 = instance_double('agent', :idle? => false)
+      expect(GOCD::Agents).to receive(:agents).and_return([agent1, agent2])
+      expect(GOCD::Agents.idle.size).to eq 1
+    end
+
+    it '#idle should filter out missing agents' do
+      agent1 = instance_double('agent', :missing? => true)
+      agent2 = instance_double('agent', :missing? => false)
+      expect(GOCD::Agents).to receive(:agents).and_return([agent1, agent2])
+      expect(GOCD::Agents.missing.size).to eq 1
+    end
+
+    it '#idle should filter out agents in building state' do
+      agent1 = instance_double('agent', :building? => true)
+      agent2 = instance_double('agent', :building? => false)
+      expect(GOCD::Agents).to receive(:agents).and_return([agent1, agent2])
+      expect(GOCD::Agents.building.size).to eq 1
+    end
+
+    it '#idle should filter out disabled agents' do
+      agent1 = instance_double('agent', :disabled? => true)
+      agent2 = instance_double('agent', :disabled? => false)
+      expect(GOCD::Agents).to receive(:agents).and_return([agent1, agent2])
+      expect(GOCD::Agents.disabled.size).to eq 1
+    end
+  end
+end

data/spec/gocd/config/credentials_spec.rb

@@ -0,0 +1,9 @@
+require './lib/gocd/config/credentials'
+
+RSpec.describe GOCD::Credentials, 'credentials' do
+
+  it '#curl_credentials should return credentials' do
+    credentials = GOCD::Credentials.new 'admin', 'password'
+    expect(credentials.curl_credentials).to eq 'admin:password'
+  end
+end

data/spec/gocd/history/history_fetcher_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../../../lib/gocd/history/history_fetcher'
+require_relative '../../../lib/gocd/config/credentials'
+require_relative '../../../lib/gocd/config/server'
+require_relative '../../../lib/gocd/pipeline_config/job'
+require 'rest-client'
+require 'ostruct'
+
+def setup_credential_and_server
+  GOCD.credentials = GOCD::Credentials.new 'admin', 'password'
+  GOCD.server = GOCD::Server.new 'http://gocd.com'
+end
+
+RSpec.describe GOCD::HistoryFetcher, 'history' do
+
+  response = "cruise_agent,cruise_job_duration,cruise_job_id,cruise_job_result,cruise_pipeline_counter,cruise_pipeline_label,cruise_stage_counter,cruise_timestamp_01_scheduled,cruise_timestamp_02_assigned,cruise_timestamp_03_preparing,cruise_timestamp_04_building,cruise_timestamp_05_completing,cruise_timestamp_06_completed,tests_failed_count,tests_ignored_count,tests_total_count,tests_total_duration\nAgent1,320,826882,Passed,10314,pipe-10314-job-5621,1,2017-02-23T14:49:17Z,2017-02-23T14:49:22Z,2017-02-23T14:49:33Z,2017-02-23T14:49:41Z,2017-02-23T14:54:39Z,2017-02-23T14:55:02Z,0,0,4218,84.882\n"
+  job = GOCD::PIPELINE_CONFIG::Job.new('Pipeline', 'stage', {'name' => 'job'})
+
+  before(:each) do
+    setup_credential_and_server
+    params = "pipelineName=#{job.pipeline}&stageName=#{job.stage}&jobName=#{job.name}&limitPipeline=latest&limitCount=#{1}"
+    request = {
+        method: :get,
+        url: "http://gocd.com/go/properties/search?#{params}",
+        user: 'admin',
+        password: 'password',
+    }
+    expect(RestClient::Request).to receive(:execute).with(request).and_return(OpenStruct.new({body: response}))
+  end
+
+  it 'should fetch history of a job' do
+    histories = GOCD::HistoryFetcher.fetch_job_history(job, 1)
+
+    expect(histories.size).to eq 1
+    history = histories.first
+    expect(history['cruise_agent']).to eq 'Agent1'
+    expect(history['cruise_job_duration']).to eq '320'
+    expect(history['cruise_job_id']).to eq '826882'
+    expect(history['cruise_job_result']).to eq 'Passed'
+    expect(history['cruise_pipeline_counter']).to eq '10314'
+    expect(history['cruise_pipeline_label']).to eq 'pipe-10314-job-5621'
+    expect(history['cruise_stage_counter']).to eq '1'
+    expect(history['cruise_timestamp_01_scheduled']).to eq '2017-02-23T14:49:17Z'
+    expect(history['cruise_timestamp_02_assigned']).to eq '2017-02-23T14:49:22Z'
+    expect(history['cruise_timestamp_04_building']).to eq '2017-02-23T14:49:41Z'
+    expect(history['cruise_timestamp_05_completing']).to eq '2017-02-23T14:54:39Z'
+    expect(history['cruise_timestamp_06_completed']).to eq '2017-02-23T14:55:02Z'
+  end
+
+  it 'should fetch raw history of a job' do
+    histories = GOCD::HistoryFetcher.fetch_raw_job_history(job, 1)
+
+    expect(histories).to eq response
+  end
+end