testswarm-client 0.2.0

data/README.rdoc

@@ -0,0 +1,41 @@
+= TestSwarm::Client
+
+Simple library for interacting with TestSwarm servers. Makes it easy to create
+jobs, and may in future allow us to query the TestSwarm server.
+
+
+== Example
+
+    # Create a client to talk to the server, and get a reference to the project
+    # you want to submit a job to.
+
+    client  = TestSwarm::Client.new('http://testswarm.songkick.net')
+    project = client.project('my_project', :auth => 'abc123')
+
+    # Create the job. This checks the project out of version control, creates a
+    # snapshot, builds the project and determines its revision ID.
+
+    job = TestSwarm::Job.create(
+      :rcs        => {
+        :type     => 'git',
+        :url      => 'git://github.com/songkick/foo.git'
+      },
+
+      :directory  => "/var/www/testswarm/changeset/#{project.name}",
+      :build      => 'coffee -c spec/',
+      :inject     => 'spec/*.html'
+    )
+
+    # Add test suites to the job. A test suite has a name and a URL. We can use
+    # the revision number to build the path to our test files.
+
+    path = "#{client.url}/changeset/#{project.name}/#{job.revision}"
+    ['FooSpec', 'BarSpec'].each do |spec|
+      job.add_suite(spec, "#{path}/spec/browser.html?spec=#{spec}")
+    end
+
+    # Send the job to the server, giving a name, maximum run count, and which
+    # browsers to run the job in. Returns the TestSwarm job ID if the job is new.
+
+    project.submit_job("My Commit #{job.revision}", job, :max => 5, :browsers => 'all')
+

data/lib/testswarm/client.rb

@@ -0,0 +1,33 @@
+require 'cgi'
+require 'fileutils'
+require 'json'
+require 'net/http'
+require 'uri'
+
+require File.dirname(__FILE__) + '/job'
+require File.dirname(__FILE__) + '/project'
+
+module TestSwarm
+
+  DEFAULT_BROWSERS = 'all'
+  DEFAULT_MAX      = 1
+  INJECT_SCRIPT    = '/js/inject.js'
+
+  class Client
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def project(name, options = {})
+      Project.new(self, name, options)
+    end
+
+    def uri
+      @uri ||= URI.parse(@url)
+    end
+  end
+
+end
+

data/lib/testswarm/job.rb

@@ -0,0 +1,333 @@
+module TestSwarm
+  class Job
+
+    class AlreadyPrepared < StandardError ; end
+    class MissingConfig   < StandardError ; end
+    class FailedCheckout  < StandardError ; end
+    class UnknownRevision < StandardError ; end
+    class BuildFailed     < StandardError ; end
+
+    def self.create(*args)
+      job = new(*args)
+      job.prepare!
+      job
+    end
+
+    def initialize(settings)
+      @suites    = {}
+      @rcs       = settings[:rcs]
+      @directory = settings[:directory]
+      @diff      = settings[:diff]
+      @build     = settings[:build]
+      @inject    = settings[:inject]
+      @keep      = settings[:keep]
+      @new       = true
+
+      raise MissingConfig, "Required setting :rcs is missing" unless @rcs
+      raise MissingConfig, "Required setting :rcs->:type is missing" unless @rcs[:type]
+      raise MissingConfig, "Required setting :rcs->:url is missing" unless @rcs[:url]
+      raise MissingConfig, "Required setting :directory is missing" unless @directory
+      raise MissingConfig, "Required setting :inject is missing" unless @inject
+
+      @directory = File.expand_path(@directory)
+
+      Kernel.at_exit { close_logfile }
+    end
+
+    def add_suite(name, url)
+      @suites[name] = url
+    end
+
+    def each_suite
+      @suites.keys.sort.each do |name|
+        yield(name, @suites[name])
+      end
+    end
+
+    def new?
+      @new
+    end
+
+    def prepare!
+      raise AlreadyPrepared if @prepared
+      @prepared = true
+
+      @pwd = Dir.pwd
+
+      enter_base_directory
+
+      return @new = false unless acquire_lock
+
+      checkout_codebase
+      determine_revision
+      discard_old_releases
+
+      if existing_job? or not javascript_changed?
+        @new = false
+        return reset
+      end
+
+      build_project
+      reset
+    end
+
+    def revision
+      unless @revision
+        raise UnknownRevision, "Job may not have been prepared"
+      end
+      @revision
+    end
+
+    def inject_script(url)
+      return unless @inject
+
+      log "chdir #{File.join @directory, revision}"
+      Dir.chdir(File.join(@directory, revision))
+
+      Dir.glob(@inject).each do |path|
+        log "Injecting #{url} into #{path}"
+        html = File.read(path)
+        html.gsub! /<\/head>/, %Q{<script>document.write('<scr' + 'ipt src="#{url}?' + (new Date).getTime() + '"><\/scr' + 'ipt>');<\/script><\/head>}
+        File.open(path, 'w') { |f| f.write(html) }
+      end
+    end
+
+    def log(message)
+      FileUtils.mkdir_p(@directory)
+      @logfile ||= File.open(File.join(@directory, 'testswarm.log'), 'a')
+      @logfile.sync = true
+      @logfile.puts("[#{Time.now.strftime '%Y-%m-%d %H:%M:%S'}] #{message}")
+    end
+
+  private
+
+    def tmp_dir
+      @tmp_dir ||= "tmp-#{Time.now.to_i}"
+    end
+
+    def enter_base_directory
+      log "mkdir -p #{@directory}"
+      FileUtils.mkdir_p(@directory)
+
+      log "chdir #{@directory}"
+      Dir.chdir(@directory)
+    end
+
+    def acquire_lock
+      if File.exist?('.lock')
+        log "Locked, marking job as not new"
+        return false
+      end
+
+      log "Writing lock to #{@directory}/.lock"
+      File.open('.lock', 'w') do |f|
+        f.sync = true
+        f.write('')
+      end
+      true
+    end
+
+    def checkout_codebase
+      case @rcs[:type]
+      when 'svn' then checkout_svn_codebase
+      when 'git' then checkout_git_codebase
+      end
+      unless File.exists?(tmp_dir)
+        reset
+        raise FailedCheckout, "Failed to check out code from #{@rcs.inspect}"
+      end
+      log "chdir #{tmp_dir}"
+      Dir.chdir(tmp_dir)
+    end
+
+    def checkout_svn_codebase
+      log "svn co #{@rcs[:url]} #{tmp_dir}"
+      `svn co #{@rcs[:url]} #{tmp_dir}`
+    end
+
+    def checkout_git_codebase
+      log "git clone #{@rcs[:url]} #{tmp_dir}"
+      `git clone #{@rcs[:url]} #{tmp_dir}`
+
+      log "chdir #{tmp_dir}"
+      Dir.chdir(tmp_dir)
+
+      if @rcs[:branch]
+        log "git checkout origin/#{@rcs[:branch]}"
+        `git checkout origin/#{@rcs[:branch]}`
+      end
+      log "git submodule update --init --recursive"
+      `git submodule update --init --recursive`
+
+      log "chdir #{@directory}"
+      Dir.chdir(@directory)
+    end
+
+    def determine_revision
+      @revision = case @rcs[:type]
+                  when 'svn' then determine_svn_revision
+                  when 'git' then determine_git_revision
+                  else ''
+                  end
+
+      @revision.strip!
+      log "Revision: #{@revision}"
+      log "Previous: #{@previous_revision}" if @previous_revision
+
+      if @revision.empty?
+        reset
+        raise UnknownRevision, "Could not determine revision"
+      end
+
+      log "chdir #{@directory}"
+      Dir.chdir(@directory)
+    end
+
+    def determine_svn_revision
+      @previous_revision = Dir.entries(@directory).
+                           grep(/^\d+$/).
+                           sort_by { |s| s.to_i }.
+                           last
+
+      log "svn info | grep Revision"
+      `svn info | grep Revision`.gsub(/Revision: /, '')
+    end
+
+    def determine_git_revision
+      latest = latest_git_commits(100)
+      @previous_revision = Dir.entries(@directory).
+                           grep(/^[0-9a-f]+$/).
+                           sort_by { |s| latest.index(s) || 1000 }.
+                           first
+
+      log "git rev-parse --short HEAD"
+      `git rev-parse --short HEAD`
+    end
+
+    def discard_old_releases
+      return unless @keep
+
+      log "chdir #{tmp_dir}"
+      Dir.chdir(tmp_dir)
+
+      latest_commits = case @rcs[:type]
+                       when 'svn' then latest_svn_commits(@keep)
+                       when 'git' then latest_git_commits(@keep)
+                       end
+
+      log "Keeping releases #{latest_commits.join ', '}"
+
+      log "chdir #{@directory}"
+      Dir.chdir(@directory)
+
+      Dir.entries(@directory).each do |entry|
+        next unless entry =~ /^[a-z0-9]+$/i
+        next if latest_commits.include?(entry)
+
+        log "rm -rf #{entry}"
+        FileUtils.rm_rf(entry)
+      end
+    end
+
+    def latest_svn_commits(n)
+      `svn log --limit 5`.strip.
+      split("\n").
+      grep(/^r\d+/).
+      map { |line| line.split(/^r|\s*\|\s*/)[1] }
+    end
+
+    def latest_git_commits(n)
+      `git log --oneline | head -#{n} | cut -d ' ' -f 1`.strip.split("\n")
+    end
+
+    def existing_job?
+      File.exists?(File.join(@directory, @revision))
+    end
+
+    def javascript_changed?
+      return true unless @diff and @previous_revision
+
+      log "chdir #{tmp_dir}"
+      Dir.chdir(tmp_dir)
+
+      [@diff].flatten.each do |pattern|
+        return true if javascript_changed_in?(pattern)
+      end
+      false
+    end
+
+    def javascript_changed_in?(pattern)
+      case @rcs[:type]
+      when 'svn' then javascript_changed_in_svn?(pattern)
+      when 'git' then javascript_changed_in_git?(pattern)
+      end
+    end
+
+    def javascript_changed_in_svn?(pattern)
+      counter = "svn diff -r #{@previous_revision}:#{@revision} | grep 'Index:' | grep '#{pattern}' | wc -l"
+      count = `#{counter}`
+      log "#{counter} -> #{count}"
+      count.strip.to_i > 0
+    end
+
+    def javascript_changed_in_git?(pattern)
+      counter = "git diff --stat #{@previous_revision} HEAD | grep '#{pattern}' | wc -l"
+      count = `#{counter}`
+      log "#{counter} -> #{count}"
+      count.strip.to_i > 0
+    end
+
+    def build_project
+      log "chdir #{@directory}"
+      Dir.chdir(@directory)
+
+      log "mv #{tmp_dir} #{@revision}"
+      FileUtils.mv(tmp_dir, @revision)
+
+      log "chdir #{@revision}"
+      Dir.chdir(@revision)
+
+      return unless @build
+
+      [@build].flatten.each do |step|
+        log step
+        `#{step}`
+        unless $?.exitstatus.zero?
+          reset
+          log "Failed while running #{step}"
+          raise BuildFailed, "Failed while running #{step}"
+        end
+      end
+    end
+
+    def reset
+      remove_tmp
+      restore_working_directory
+      release_lock
+    end
+
+    def remove_tmp
+      log "chdir #{@directory}"
+      Dir.chdir(@directory)
+      log "rm -rf #{tmp_dir}"
+      FileUtils.rm_rf(tmp_dir)
+    end
+
+    def restore_working_directory
+      log "chdir #{@pwd}"
+      Dir.chdir(@pwd)
+    end
+
+    def release_lock
+      log "rm #{@directory}/.lock"
+      FileUtils.rm("#{@directory}/.lock")
+    end
+
+    def close_logfile
+      @logfile.close if @logfile
+      @logfile = nil
+    end
+
+  end
+end
+

data/lib/testswarm/project.rb

@@ -0,0 +1,81 @@
+module TestSwarm
+  class Project
+
+    class SubmissionFailed < StandardError ; end
+
+    attr_reader :name
+
+    def initialize(client, name, options = {})
+      @client  = client
+      @name    = name
+      @options = options
+    end
+
+    def payload(job, params = {})
+      cgi = {
+        'action'        => 'addjob',
+        'authUsername'  => @name,
+        'authToken'     => @options[:auth],
+        'jobName'       => params[:name],
+        'runMax'        => params[:max] || DEFAULT_MAX
+      }
+
+      query = ''
+      cgi.keys.sort.each do |key|
+        query += '&' unless query.empty?
+        query += "#{key}=#{escape cgi[key]}"
+      end
+
+      browsers = [params[:browsers] || DEFAULT_BROWSERS].flatten
+      browsers.each do |browser|
+        query += "&browserSets[]=#{escape browser}"
+      end
+
+      job.each_suite do |name, url|
+        query += "&runNames[]=#{escape name}&runUrls[]=#{escape url}"
+      end
+      query
+    end
+
+    def submit_job(name, job, options = {})
+      job.inject_script(@client.url + INJECT_SCRIPT)
+
+      http = Net::HTTP.start(@client.uri.host, @client.uri.port)
+      data = payload(job, job_params(name, options))
+
+      job.log "POST #{@client.url} #{data}"
+
+      response = http.post('/api.php', data)
+      job.log "Response: #{response.body}"
+      job_data = JSON.parse(response.body)['addjob'] rescue nil
+
+      unless job_data
+        job.log 'Job submission failed'
+        job.log response.body
+        return nil
+      end
+
+      job.log "Job ID: #{job_data['id']}"
+      job.log "Runs: #{job_data['runTotal']}, user agents: #{job_data['uaTotal']}"
+
+      job_data['id'].to_s
+
+    rescue => e
+      job.log 'Job submission failed'
+      job.log e.message
+      job.log e.backtrace
+    end
+
+  private
+
+    def escape(string)
+      CGI.escape(string.to_s)
+    end
+
+    def job_params(name, options)
+      options.merge(:name => name)
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "bundler/setup"
+require File.dirname(__FILE__) + '/../lib/testswarm/client'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+

data/spec/testswarm/job_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe TestSwarm::Job do
+  let(:params) {{
+    :rcs        => {
+      :type     => 'git',
+      :url      => 'git://github.com/songkick/foo.git'
+    },
+
+    :directory  => "/var/www/testswarm/changeset/skweb",
+    :build      => 'coffee -c spec/',
+    :inject     => 'spec/*.html'
+  }}
+
+  describe :new do
+    def raises_error
+      lambda {
+        TestSwarm::Job.new(params)
+      } .should raise_error(TestSwarm::Job::MissingConfig)
+    end
+
+    it "raises an error if no RCS is given" do
+      params.delete(:rcs)
+      raises_error
+    end
+
+    it "raises an error if no RCS type is given" do
+      params[:rcs].delete(:type)
+      raises_error
+    end
+
+    it "raises an error if no RCS URL is given" do
+      params[:rcs].delete(:url)
+      raises_error
+    end
+
+    it "raises an error if no directory is given" do
+      params.delete(:directory)
+      raises_error
+    end
+
+    it "raises an error if no inject is given" do
+      params.delete(:inject)
+      raises_error
+    end
+  end
+end
+

data/spec/testswarm/project_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+describe TestSwarm::Project do
+  let(:uri)     { URI.new("http://testswarm.songkick.net") }
+  let(:client)  { TestSwarm::Client.new("http://testswarm.songkick.net") }
+  let(:project) { client.project("skweb", :auth => "123abc") }
+  let(:job)     { TestSwarm::Job.new(:rcs => {:type => '', :url => ''}, :directory => '', :inject => '') }
+
+  describe :paylooad do
+    before do
+      job.add_suite "Foo", "http://testswarm.songkick.net/changeset/skweb/1f7103f/test/browser.html?spec=FooSpec"
+      job.add_suite "Bar", "http://testswarm.songkick.net/changeset/skweb/1f7103f/test/browser.html?spec=BarSpec"
+    end
+
+    it "returns CGI-encoded data to be submitted to the server" do
+      project.payload(job, :name => "Job Name").should == [
+        "action=addjob",
+        "authToken=123abc",
+        "authUsername=skweb",
+        "jobName=Job+Name",
+        "runMax=1",
+        "browserSets[]=all",
+        "runNames[]=Bar",
+        "runUrls[]=http%3A%2F%2Ftestswarm.songkick.net%2Fchangeset%2Fskweb%2F1f7103f%2Ftest%2Fbrowser.html%3Fspec%3DBarSpec",
+        "runNames[]=Foo",
+        "runUrls[]=http%3A%2F%2Ftestswarm.songkick.net%2Fchangeset%2Fskweb%2F1f7103f%2Ftest%2Fbrowser.html%3Fspec%3DFooSpec"
+      ].join("&")
+    end
+
+    it "allows defaults to be overridden" do
+      project.payload(job, :browsers => "popular").should =~ /browserSets\[\]=popular/
+      project.payload(job, :max => 5).should =~ /runMax=5/
+    end
+  end
+
+  describe :submit_job do
+    let(:http)     { mock Net::HTTP }
+    let(:response) { mock Net::HTTPOK }
+
+    before { job.stub(:inject_script) }
+
+    it "posts the job's CGI payload to the server" do
+      Net::HTTP.should_receive(:start).with("testswarm.songkick.net", 80).and_return(http)
+      params = {:name => "Job Name"}
+      project.should_receive(:payload).with(job, params).and_return("cgi-data")
+      http.should_receive(:post).with("/api.php", "cgi-data").and_return(response)
+      response.should_receive(:body).at_least(1).and_return(%{{"addjob":{"id":1}}})
+      project.submit_job("Job Name", job)
+    end
+
+    it "passes options through when constructing the payload" do
+      params = {:name => "Job Name", :browsers => "beta"}
+      project.should_receive(:payload).with(job, params).and_return("cgi-data")
+      FakeWeb.register_uri(:post, "http://testswarm.songkick.net/api.php", :body => %{{"addjob":{"id":75}}})
+      project.submit_job("Job Name", job, :browsers => "beta")
+    end
+
+    it "returns the ID of the job" do
+      FakeWeb.register_uri(:post, "http://testswarm.songkick.net/api.php", :body => %{{"addjob":{"id":75,"runTotal":2,"uaTotal":8}}})
+      project.submit_job("Job Name", job).should == "75"
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: testswarm-client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- James Coglan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: jcoglan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- lib/testswarm/project.rb
+- lib/testswarm/client.rb
+- lib/testswarm/job.rb
+- spec/testswarm/project_spec.rb
+- spec/testswarm/job_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+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.23
+signing_key: 
+specification_version: 3
+summary: Client library for Mozilla TestSwarm
+test_files: []
+has_rdoc: