codescout-runner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80d1341e3132b625b860c552941d26e6bf532b24
+  data.tar.gz: d369ff8c61a1e7157247b5d54a72bd622bf6169b
+SHA512:
+  metadata.gz: 65d127e52062fc0c8c548d8f91272123e67e6d2568bebff20c131218c4bfc0bc1665e7cf526922c01378cc5075d464844450c8987bec596ca026144c1ffef6ce
+  data.tar.gz: 0e6bbbfb44d0fa5cd8f3563af43484cddd44c35c4296fc4fa308e7c0da946bce85c7504496822ac79417b19345dce69b6d2f1b532549188c207600952c694aea

data/.gitignore

@@ -0,0 +1,24 @@
+#*
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.#*
+.DS_Store
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = false
+end

data/bin/codescout-runner

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + "/../lib")
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "rubygems"
+require "codescout/runner"
+
+if ENV["CODESCOUT_URL"].nil?
+  STDERR.puts "CODESCOUT_URL is required"
+  exit 1
+end
+
+if ENV["CODESCOUT_PUSH"].nil?
+  STDERR.puts "CODESCOUT_PUSH is required"
+  exit 1
+end
+
+Codescout::Runner.perform(ENV["CODESCOUT_URL"], ENV["CODESCOUT_PUSH"])

data/codescout-runner.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path("../lib/codescout/runner/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "codescout-runner"
+  s.version     = Codescout::Runner::VERSION
+  s.summary     = "No description for now"
+  s.description = "No description for now, maybe later"
+  s.homepage    = "https://github.com"
+  s.authors     = ["Dan Sosedoff"]
+  s.email       = ["dan.sosedoff@gmail.com"]
+  s.license     = "MIT"
+
+  s.add_dependency "json",               "~> 1.8"
+  s.add_dependency "hashie",             "~> 3.3"
+  s.add_dependency "faraday",            "~> 0.9"
+  s.add_dependency "codescout-analyzer", "0.0.1"
+
+  s.add_development_dependency "rake",      "~> 10"
+  s.add_development_dependency "rspec",     "~> 3.0"
+  s.add_development_dependency "simplecov", "~> 0.9"
+  s.add_development_dependency "webmock",   "~> 1.18"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths = ["lib"]
+end

data/lib/codescout/runner.rb

@@ -0,0 +1,14 @@
+require "codescout/runner/version"
+require "codescout/runner/errors"
+require "codescout/runner/shell"
+require "codescout/runner/client"
+require "codescout/runner/key"
+require "codescout/runner/build"
+
+module Codescout
+  module Runner
+    def self.perform(service_url, push_token)
+      Codescout::Runner::Build.new(service_url, push_token).run
+    end
+  end
+end

data/lib/codescout/runner/build.rb

@@ -0,0 +1,67 @@
+module Codescout::Runner
+  class Build
+    attr_reader :client, :push_token, :push
+    attr_reader :clone_path, :output_path
+
+    def initialize(service_url, push_token)
+      @shell       = Codescout::Runner::Shell.new
+      @client      = Codescout::Runner::Client.new(service_url)
+      @push_token  = push_token
+      @clone_path  = "/tmp/#{@push_token}"
+      @output_path = "#{@clone_path}/codescout.json"
+    end
+
+    def run
+      cleanup
+      fetch_push
+      setup_ssh_keys
+      clone_repository
+      checkout_commit
+      generate_report
+      submit_report
+    end
+
+    private
+
+    def cleanup
+      shell("rm -rf #{clone_path}")
+    end
+
+    def fetch_push
+      @push = client.fetch_push(push_token)
+    end
+
+    def setup_ssh_keys
+      # No need to install ssh keys for public repos
+      return unless @push.repository =~ /git@/
+
+      Codescout::Runner::Key.new(@push.public_key, @push.private_key).install
+    end
+    
+    def clone_repository
+      options = "--depth 50 --branch #{push.branch}"
+      shell("git clone #{options} #{push.repository} #{clone_path}")
+    end
+
+    def checkout_commit
+      shell("cd #{clone_path} && git checkout -f #{push.commit}")
+    end
+
+    def generate_report
+      shell("codescout #{clone_path} > #{output_path}")
+    end
+
+    def submit_report
+      client.send_payload(push_token, File.read(output_path))
+    end
+
+    def shell(command)
+      result = @shell.execute(command)
+
+      if !result
+        message = "Command failed: #{command}"
+        raise Codescout::Runner::BuildError, message
+      end
+    end
+  end
+end

data/lib/codescout/runner/client.rb

@@ -0,0 +1,41 @@
+require "faraday"
+require "json"
+require "hashie"
+
+module Codescout::Runner
+  class Client
+    def initialize(url)
+      @url = url
+    end
+
+    def fetch_push(token)
+      response = connection.get("/worker/push/#{token}")
+      json = JSON.load(response.body)
+      obj = Hashie::Mash.new(json)
+
+      if obj.error
+        raise Codescout::Runner::ClientError, obj.error
+      end
+
+      obj
+
+    rescue JSON::ParserError => err
+      raise Codescout::Runner::ClientError, err.message
+    rescue Faraday::ConnectionFailed => err
+      raise Codescout::Runner::ClientError, err.message
+    end
+
+    def send_payload(token, payload)
+      connection.post("/worker/payload/#{token}", payload) do |c|
+        c.headers["Content-Type"] = "text/plain"
+      end
+    end
+
+    def connection
+      @connection ||= Faraday.new(@url) do |c|
+        c.use(Faraday::Request::UrlEncoded)
+        c.adapter(Faraday.default_adapter)
+      end
+    end
+  end
+end

data/lib/codescout/runner/errors.rb

@@ -0,0 +1,5 @@
+module Codescout::Runner
+  class Error < StandardError ; end
+  class ClientError < Error ; end
+  class BuildError < Error ; end
+end

data/lib/codescout/runner/key.rb

@@ -0,0 +1,41 @@
+module Codescout::Runner
+  class Key
+    def initialize(public_key, private_key)
+      @public_key  = public_key
+      @private_key = private_key
+    end
+
+    def install
+      return if keys_installed?
+
+      write(private_key_path, @private_key)
+      write(public_key_path, @public_key)
+    end
+
+    private
+
+    def keys_installed?
+      installed?(private_key_path) && installed?(public_key_path)
+    end
+
+    def home_path
+      ENV["HOME"]
+    end
+
+    def private_key_path
+      File.join(home_path, ".ssh/id_rsa")
+    end
+
+    def public_key_path
+      File.join(home_path, ".ssh/id_rsa.pub")
+    end
+
+    def write(path, content)
+      File.open(path, "w") { |f| f.write(content) }
+    end
+
+    def installed?(path)
+      File.exists?(path) && File.size(path) > 0
+    end
+  end
+end

data/lib/codescout/runner/shell.rb

@@ -0,0 +1,8 @@
+module Codescout::Runner
+  class Shell
+    def execute(command)
+      `#{command}`
+      $?.success?
+    end
+  end
+end

data/lib/codescout/runner/version.rb

@@ -0,0 +1,5 @@
+module Codescout
+  module Runner
+    VERSION = "0.0.1"
+  end
+end

data/spec/fixtures/invalid_token.json

@@ -0,0 +1,4 @@
+{
+  "error": "Invalid push token",
+  "status": 400
+}

data/spec/fixtures/push.json

@@ -0,0 +1,7 @@
+{
+  "repository": "https://github.com/foo/bar.git",
+  "branch": "master",
+  "commit": "master",
+  "private_key": "private",
+  "public_key": "public"
+}

data/spec/lib/runner/build_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Codescout::Runner::Build do
+  let(:build) { described_class.new("http://foo", "token") }
+
+  describe "#initialize" do
+    it "initializes build" do
+      expect(build.push_token).to eq "token"
+      expect(build.clone_path).to eq "/tmp/token"
+      expect(build.output_path).to eq "/tmp/token/codescout.json"
+    end
+  end
+
+  describe "#run" do
+    let(:shell) { double }
+
+    let(:push) do
+      double(
+        repository: "repo",
+        branch: "master",
+        commit: "commit"
+      )
+    end
+
+    before do
+      allow(ENV).to receive(:[]).with("HOME") { "/tmp" }
+      allow(File).to receive(:read).with("/tmp/token/codescout.json") { "output" }
+      allow(Codescout::Runner::Shell).to receive(:new) { shell }
+      allow(build.client).to receive(:fetch_push) { push }
+      allow(build.client).to receive(:send_payload).with("token", "output")
+
+      stub_shell(shell, "rm -rf /tmp/token") { true }
+    end
+
+    it "executes the build" do
+      stub_shell(shell, "git clone --depth 50 --branch master repo /tmp/token") { true }
+      stub_shell(shell, "cd /tmp/token && git checkout -f commit") { true }
+      stub_shell(shell, "codescout /tmp/token > /tmp/token/codescout.json") { true }
+
+      build.run
+    end
+
+    context "when git clone fails" do
+      before do
+        stub_shell(shell, "git clone --depth 50 --branch master repo /tmp/token") { false }
+      end
+
+      it "raises error" do
+        expect { build.run }.to raise_error Codescout::Runner::BuildError, "Command failed: git clone --depth 50 --branch master repo /tmp/token"
+      end
+    end
+
+    context "when git checkout fails" do
+      before do
+        stub_shell(shell, "git clone --depth 50 --branch master repo /tmp/token") { true }
+        stub_shell(shell, "cd /tmp/token && git checkout -f commit") { false }
+      end
+
+      it "raises error" do
+        expect { build.run }.to raise_error Codescout::Runner::BuildError, "Command failed: cd /tmp/token && git checkout -f commit"
+      end
+    end
+
+    context "when codescout command fails" do
+      before do
+        stub_shell(shell, "git clone --depth 50 --branch master repo /tmp/token") { true }
+        stub_shell(shell, "cd /tmp/token && git checkout -f commit") { true }
+        stub_shell(shell, "codescout /tmp/token > /tmp/token/codescout.json") { false }
+      end
+
+      it "raises error" do
+        expect { build.run }.to raise_error Codescout::Runner::BuildError, "Command failed: codescout /tmp/token > /tmp/token/codescout.json"
+      end
+    end
+  end
+end

data/spec/lib/runner/client_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Codescout::Runner::Client do
+  let(:client) { described_class.new("http://foo") }
+
+  describe "#fetch_push" do
+    context "when connection failed" do
+      before do
+        allow_any_instance_of(Faraday::Connection).to receive(:get) do
+          raise Faraday::ConnectionFailed, "Refused"
+        end
+      end
+
+      it "raises error" do
+        expect { client.fetch_push("bar") }.
+          to raise_error Codescout::Runner::ClientError
+      end
+    end
+
+    context "when push token is invalid" do
+      before do
+        stub_request(:get, "http://foo/worker/push/bar").
+          with(headers: {
+            'Accept' => '*/*',
+            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+            'User-Agent' => 'Faraday v0.9.0'
+          }).
+          to_return(
+            status: 400, body: fixture("invalid_token.json"), headers: {}
+          )
+      end
+
+      it "raises error" do
+        expect { client.fetch_push("bar") }.
+          to raise_error Codescout::Runner::ClientError
+      end
+    end
+
+    context "when push token is valid" do
+      let(:result) { client.fetch_push("bar") }
+
+      before do
+        stub_request(:get, "http://foo/worker/push/bar").
+          with(headers: {
+            'Accept' => '*/*',
+            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+            'User-Agent' => 'Faraday v0.9.0'
+          }).
+          to_return(
+            status: 200, body: fixture("push.json"), headers: {}
+          )
+      end
+
+      it "returns a hashie object" do
+        expect(result).to be_a Hashie::Mash
+        expect(result.repository).to eq "https://github.com/foo/bar.git"
+        expect(result.branch).to eq "master"
+        expect(result.commit).to eq "master"
+        expect(result.private_key).to eq "private"
+        expect(result.public_key).to eq "public"
+      end
+    end
+  end
+end

data/spec/lib/runner/key_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe Codescout::Runner::Key do
+  let(:private_key) { "private" }
+  let(:public_key)  { "public"  }
+
+  let(:key) do
+    described_class.new(public_key, private_key)
+  end
+
+  before(:all) do
+    FileUtils.mkdir_p("/tmp/.ssh")
+  end
+
+  before do
+    allow(ENV).to receive(:[]).with("HOME") { "/tmp" }
+  end
+
+  after(:all) do
+    FileUtils.rm_rf("/tmp/.ssh")
+  end
+
+  describe "#install" do
+    before { key.install }
+
+    it "writes private key" do
+      expect(File.read("/tmp/.ssh/id_rsa")).to eq private_key
+    end
+
+    it "write public key" do
+      expect(File.read("/tmp/.ssh/id_rsa.pub")).to eq public_key
+    end
+  end
+end

data/spec/lib/runner/shell_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Codescout::Runner::Shell do
+  let(:shell) { described_class.new }
+
+  describe "#execute" do
+    pending
+  end
+end

data/spec/lib/runner_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Codescout::Runner do
+  describe ".perform" do
+    let(:build) { double }
+
+    before do
+      allow(build).to receive(:run)
+      allow(Codescout::Runner::Build).to receive(:new) { build }
+
+      described_class.perform("url", "token")
+    end
+
+    it "executes a build" do
+      expect(build).to have_received(:run)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require "simplecov"
+
+SimpleCov.start do
+  add_filter "spec/"
+end
+
+require "webmock/rspec"
+require "lib/codescout/runner"
+
+def fixture_path(filename = nil)
+  path = File.expand_path("../fixtures", __FILE__)
+  filename.nil? ? path : File.join(path, filename)
+end
+
+def fixture(file)
+  File.read(File.join(fixture_path, file))
+end
+
+def stub_shell(shell, command)
+  allow(shell).to receive(:execute).with(command) { yield }
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: codescout-runner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codescout-analyzer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: No description for now, maybe later
+email:
+- dan.sosedoff@gmail.com
+executables:
+- codescout-runner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Rakefile
+- bin/codescout-runner
+- codescout-runner.gemspec
+- lib/codescout/runner.rb
+- lib/codescout/runner/build.rb
+- lib/codescout/runner/client.rb
+- lib/codescout/runner/errors.rb
+- lib/codescout/runner/key.rb
+- lib/codescout/runner/shell.rb
+- lib/codescout/runner/version.rb
+- spec/fixtures/invalid_token.json
+- spec/fixtures/push.json
+- spec/lib/runner/build_spec.rb
+- spec/lib/runner/client_spec.rb
+- spec/lib/runner/key_spec.rb
+- spec/lib/runner/shell_spec.rb
+- spec/lib/runner_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: No description for now
+test_files:
+- spec/fixtures/invalid_token.json
+- spec/fixtures/push.json
+- spec/lib/runner/build_spec.rb
+- spec/lib/runner/client_spec.rb
+- spec/lib/runner/key_spec.rb
+- spec/lib/runner/shell_spec.rb
+- spec/lib/runner_spec.rb
+- spec/spec_helper.rb