capybara-bamboo-client 0.0.1

data/README.md

@@ -0,0 +1,52 @@
+# Capybara::Bamboo::Client
+
+This gem helps Bamboo users who have admin access to config/run/stop/enable/disable plans
+but don't have privileges like bulk action perform actions on Bamboo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-bamboo-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-bamboo-client
+
+## Usage
+
+e.g. My project URL on Bamboo is https://bamboo.neilma.com.au/browse/neil
+
+require 'capybara-bamboo-client'
+include Capybara::Bamboo
+
+bamboo_client = Client.configure do |config|
+      config.bamboo_url = 'https://bamboo.neilma.com.au/browse/neil'
+      config.username = 'username'
+      config.password = 'password'
+end
+
+bamboo_client.login
+
+bamboo_client.construct_plans
+bamboo_client.plans.each do |plan|
+  plan.disable # Disable all the plans, also can put if condition in to target only wanted plans
+  plan.enable # Enable all the plans
+  plan.stop
+  plan.start
+end
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/capybara-bamboo-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/capybara-bamboo-client.rb

@@ -0,0 +1,60 @@
+require 'capybara'
+require 'rspec'
+require 'capybara/poltergeist'
+require 'site_prism'
+
+Dir[File.expand_path('../capybara-bamboo-client/**/*.rb', __FILE__)].each {|file| require file}
+
+module Capybara
+  module Bamboo
+    module Client
+      class << self
+        include Capybara::DSL
+        include ::RSpec::Matchers
+        include BambooHelper
+        attr_accessor :bamboo_url, :capybara_timeout, :username, :password, :phantomjs_path, :plans, :app_host
+
+        def configure
+          yield self
+          @capybara_timeout ||= 60
+          @phantomjs_path ||= File.expand_path('../../drivers/phantomjs.exe', __FILE__)
+          @plans = []
+          @app_host ||= app_host_from_url(bamboo_url)
+          register_driver capybara_timeout, phantomjs_path, app_host
+          self
+        end
+
+        def login
+          visit bamboo_url
+          expect(page.all('createPlanLink').any?).to be false
+          click_link 'login'
+          fill_in 'loginForm_os_username', with: username || ENV[:BAMBOO_USERNAME]
+          fill_in 'loginForm_os_password', with: password || ENV[:BAMBOO_PASSWORD]
+          find('#loginForm_save').click
+          expect(page).to have_button('createPlanLink')
+        end
+
+        def logout
+          reset_session!
+          visit bamboo_url
+          expect(page).to have_link('login')
+        end
+
+        def construct_plans
+          find('table[id="dashboard"]').all('tbody tr').each do |tr|
+            tds = tr.all('td')
+            plan_name_link = tds.first.find('a')
+            plan_key = get_plan_key(plan_name_link[:id])
+            operation_links = tds.last.all('a')
+            @plans << Plan.new({app_host: app_host, name: plan_name_link.text, key: plan_key,
+                                url: plan_name_link[:href],
+                                build_action_url: operation_links.first[:href],
+                                edit_plan_url: operation_links[1][:href],
+                                favourite_plan_url: operation_links.last[:href]}).tap{|i| p i.inspect}
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/capybara-bamboo-client/bamboo_helper.rb

@@ -0,0 +1,31 @@
+module Capybara
+  module Bamboo
+    module Client
+      module BambooHelper
+
+        def self.included(base)
+          super
+        end
+
+        def register_driver(timeout, phantomjs_path, app_host)
+          Capybara.current_driver = :poltergeist
+          Capybara.register_driver :poltergeist do |app|
+            Capybara::Poltergeist::Driver.new(app, {js_errors: false, phantomjs: phantomjs_path})
+          end
+          Capybara.run_server = false
+          Capybara.app_host = app_host
+          Capybara.default_wait_time = timeout
+        end
+
+        def get_plan_key(link_id)
+          link_id.split(':').last
+        end
+
+        def app_host_from_url(bamboo_url)
+          /(.*)\/browse\/(.*)/.match(bamboo_url)[1]
+        end
+
+      end
+    end
+  end
+end

data/lib/capybara-bamboo-client/plan.rb

@@ -0,0 +1,34 @@
+require 'capybara'
+
+module Capybara
+  module Bamboo
+    module Client
+      class Plan
+        include Capybara::DSL
+
+        def initialize(opts)
+          opts.keys.each do |attr_key|
+            self.class.send(:attr_accessor, attr_key)
+            instance_variable_set("@#{attr_key}", opts[attr_key])
+          end
+        end
+
+        def disable
+          visit "/build/admin/suspendBuild.action?returnUrl=%2Fchain%2Fadmin%2Fconfig%2FdefaultStages.action%3FbuildKey%3D#{key}&buildKey=#{key}"
+        end
+
+        def enable
+          visit "/build/admin/resumeBuild.action?returnUrl=%2Fchain%2Fadmin%2Fconfig%2FdefaultStages.action%3FbuildKey%3D#{key}&buildKey=#{key}"
+        end
+
+        def start
+          visit "/build/admin/triggerManualBuild.action?buildKey=#{key}"
+        end
+
+        def stop
+          visit "/build/admin/ajax/stopPlan.action?planKey=#{key}"
+        end
+      end
+    end
+  end
+end

data/lib/capybara-bamboo-client/version.rb

@@ -0,0 +1,7 @@
+module Capybara
+  module Bamboo
+    module Client
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Client do
+
+  let(:home_page) {Home.new}
+  let(:bamboo_client) do
+    Client.configure do |config|
+      config.bamboo_url = home_page.url
+      config.username = 'test_username'
+      config.password = 'test_password'
+      config.app_host = 'http://localhost:63342/capybara-bamboo-client/spec/fixtures'
+    end
+  end
+
+  context '#configure()' do
+    it 'sets bamboo url' do
+      expect(bamboo_client.bamboo_url).to eq home_page.url
+    end
+
+    it 'registers capybara driver with specific timeout' do
+      expect(bamboo_client.capybara_timeout).to eq 60
+      bamboo_client.capybara_timeout = 70
+      expect(bamboo_client.capybara_timeout).to eq 70
+    end
+  end
+
+  context '#login() and then #logout()' do
+    it 'logs in successfully when credentials have been configured' do
+      expect{bamboo_client.login}.not_to raise_error
+      expect{bamboo_client.logout}.not_to raise_error
+    end
+  end
+
+  context 'Logged in' do
+    before(:each) {bamboo_client.login}
+    context '#construct_plans()' do
+      it 'returns all the plans on the dashboard' do
+        bamboo_client.construct_plans
+        expect(bamboo_client.plans.length).to eq 2
+      end
+    end
+  end
+
+end

data/spec/fixtures/home.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title></title>
+</head>
+<body>
+<a href="login.html" id="login">Log in</a>
+</body>
+</html>

data/spec/fixtures/home_logged_in.html

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title></title>
+</head>
+<body>
+<ul>
+    <li id="userInfo">
+    </li>
+</ul>
+<button id="createPlanLink">Create</button>
+<a href="home.html" id="log-out">Logout</a>
+<table id="dashboard">
+    <tbody>
+    <tr>
+        <td>
+            <a id="viewBuild:plan1" href="plan1.html">Plan1</a>
+        </td>
+        <td>
+            <a id="manualBuild_plan1", style="display:inline"><span>Run</span></a>
+            <a id="editBuild_plan1", style="display:inline"><span>Edit 'plan1'</span></a>
+            <a id="toggleFavourite_plan1", style="display:inline"><span>Favourite</span></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a id="viewBuild:plan2" href="plan2.html">Plan2</a>
+        </td>
+        <td>
+            <a id="manualBuild_plan2", style="display:inline"><span>Run</span></a>
+            <a id="editBuild_plan2", style="display:inline"><span>Edit 'plan2'</span></a>
+            <a id="toggleFavourite_plan2", style="display:inline"><span>Favourite</span></a>
+        </td>
+    </tr>
+    </tbody>
+</table>
+</body>
+</html>

data/spec/fixtures/login.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title></title>
+</head>
+<body>
+<form action="home_logged_in.html" method="post">
+    <input type="text" name="os_username" value="" id="loginForm_os_username" autofocus="">
+    <input type="password" name="os_password" value="" id="loginForm_os_password">
+    <input type="submit" name="save" value="Log in" id="loginForm_save" accesskey="S">
+</form>
+</body>
+</html>

data/spec/pages/home.rb

@@ -0,0 +1,5 @@
+class Home < SitePrism::Page
+
+  set_url "http://localhost:63342/capybara-bamboo-client/spec/fixtures/home.html"
+
+end

data/spec/plan_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+include Capybara::Bamboo::Client
+describe Plan do
+
+  context '#initialize()' do
+    it 'dynamically sets up attr accessors' do
+      opts = {name: 'plan_name', plan_url: 'plan_url'}
+      plan = Plan.new(opts)
+      opts.keys.each {|key| expect(plan.send(key)).to eq opts[key] }
+    end
+  end
+end

data/spec/real_client_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'capybara-bamboo-client'
+
+describe 'IAG Bamboo Client' do
+
+  let(:bamboo_client) do
+    Client.configure do |config|
+      config.bamboo_url = 'https://bamboo.iag.com.au/browse/ITSM'
+      config.username = 'yuanming.ma'
+      config.password = 'cguweb1'
+    end
+  end
+
+  context '#login() and then #logout()' do
+    it 'logs in successfully when credentials have been configured' do
+      expect{bamboo_client.login}.not_to raise_error
+      expect{bamboo_client.logout}.not_to raise_error
+    end
+  end
+
+  context 'Logged in' do
+    before(:each) {bamboo_client.login}
+    context '#construct_plans()' do
+      it 'returns all the plans on the dashboard' do
+        bamboo_client.construct_plans
+        expect(bamboo_client.plans.length).to eq 2
+        bamboo_client.plans.each do |plan|
+          plan.disable if plan.name == 'UAT'
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each {|file| require file}
+Dir[File.expand_path('../fixtures/*.rb', __FILE__)].each {|file| require file}
+Dir[File.expand_path('../pages/*.rb', __FILE__)].each {|file| require file}
+include Capybara::Bamboo

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: capybara-bamboo-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Neil Ma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capybara-driven, Bamboo interactions with limited admin access
+email:
+- mayuanming@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/capybara-bamboo-client/bamboo_helper.rb
+- lib/capybara-bamboo-client/plan.rb
+- lib/capybara-bamboo-client/version.rb
+- lib/capybara-bamboo-client.rb
+- spec/client_spec.rb
+- spec/fixtures/home.html
+- spec/fixtures/home_logged_in.html
+- spec/fixtures/login.html
+- spec/pages/home.rb
+- spec/plan_spec.rb
+- spec/real_client_spec.rb
+- spec/spec_helper.rb
+- drivers/phantomjs.exe
+- README.md
+homepage: https://github.com/neilma/capybara-bamboo-client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.29
+signing_key: 
+specification_version: 3
+summary: Capybara-driven, Bamboo interactions with limited admin access
+test_files:
+- spec/client_spec.rb
+- spec/fixtures/home.html
+- spec/fixtures/home_logged_in.html
+- spec/fixtures/login.html
+- spec/pages/home.rb
+- spec/plan_spec.rb
+- spec/real_client_spec.rb
+- spec/spec_helper.rb