inch_ci-worker 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d8e5c139f7993f520ee717f19c37eca754583f3
+  data.tar.gz: 5eba432e0dfda541f9cc59ff3a87ac8b812aa257
+SHA512:
+  metadata.gz: d1979a0695fa591d823e934a4d8fdff77b7b9c5c469740898bd4bb5b7be45e8deb857f4ed02ccc44ed77abf797f90e487889e7b1cdb64891f7201a19d8d9cfef
+  data.tar.gz: 57ed86823276f198cff450d2d43fc38556fd06fb3ce0a6016114b996ee8ede438127a8a0d58eb26b5a752e7c97013a6587736301409cedd50061deab5c0a3791

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+inch_ci

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inch_ci-worker.gemspec
+gemspec
+
+gem 'repomen', :path => '../repomen'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 René Föhring
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# InchCi::Worker
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'inch_ci-worker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inch_ci-worker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/inch_ci-worker/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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/bin/inch_ci-worker

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+# @return [String] the path to the 'lib' directory of Inch
+def find_lib_path
+  path = __FILE__
+  while File.symlink?(path)
+    path = File.expand_path(File.readlink(path), File.dirname(path))
+  end
+  File.join(File.dirname(File.expand_path(path)), '..', 'lib')
+end
+
+$LOAD_PATH.unshift(find_lib_path)
+
+require 'bundler/setup'
+require 'inch_ci/worker'
+
+class Command
+  class Build
+    def initialize(url, branch_name = nil, revision = nil)
+      InchCI::Worker::Build::Task.new(url, branch_name, revision)
+    end
+  end
+
+  class ListTags
+    def initialize(url, branch_name)
+      InchCI::Worker::ListTags::Task.new(url, branch_name)
+    end
+  end
+
+  MAP = {
+    'build' => Build,
+    'list-tags' => ListTags
+  }
+
+  def self.run(command_name, args)
+    if command_class = MAP[command_name]
+      command_class.new(*args)
+    else
+      puts "Unrecognized command: #{command_name}".color(:red)
+      puts "Valid commands: #{MAP.keys.sort.join(', ')}"
+      exit 1
+    end
+  end
+end
+
+command_name = ARGV.shift
+Command.run(command_name, ARGV)

data/inch_ci-worker.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inch_ci/worker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inch_ci-worker"
+  spec.version       = InchCI::Worker::VERSION
+  spec.authors       = ["René Föhring"]
+  spec.email         = ["rf@bamaru.de"]
+  spec.summary       = %q{Worker for the Inch CI project}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/inch-ci/inch_ci-worker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "inch", "~> 0.4"
+end

data/lib/inch_ci/worker/build/report.rb

@@ -0,0 +1,78 @@
+require 'yaml'
+
+module InchCI
+  module Worker
+    module Build
+      class Report < Struct.new(:build)
+        def to_yaml
+          to_hash.to_yaml
+        end
+
+        private
+
+        def to_hash
+          data = {
+              'status' => build.status,
+              'repo_url' => build.url,
+              'branch_name' => build.branch_name,
+              'started_at' => build.started_at,
+              'finished_at' => build.started_at,
+              'latest_revision' => build.latest_revision,
+            }
+          data['service_name'] = build.service_name.to_s if build.service_name
+          data['user_name'] = build.user_name if build.user_name
+          data['repo_name'] = build.repo_name if build.repo_name
+          if build.revision_uid
+            data['revision_uid'] = build.revision_uid
+            data['revision_message'] = build.revision_message
+            data['revision_author_name'] = build.revision_author_name
+            data['revision_author_email'] = build.revision_author_email
+            data['revision_authored_at'] = build.revision_authored_at
+          end
+          data['tag'] = build.tag_uid if build.tag_uid
+          data['objects'] = objects_hash if build.objects
+          {'build' => data}
+        end
+
+        def objects_hash
+          build.objects.map do |o|
+            code_object_to_hash(o)
+          end
+        end
+
+        def code_object_to_hash(o)
+          {
+            'type' => o.type.gsub('Inch::CodeObject::Proxy::', ''),
+            'fullname' => o.fullname,
+            'docstring' => o.original_docstring.to_s,
+            'score' => o.score.to_i,
+            'grade' => o.grade.to_s,
+            'priority' => o.priority.to_i,
+            'location' => location(o.files.first),
+            'roles' => o.roles.map { |r| role_to_hash(o, r) },
+          }
+        end
+
+        def location(file)
+          return unless file
+          "#{file.relative_path}:#{file.line_no}"
+        end
+
+        def role_to_hash(object, role)
+          ref_name = role.object.fullname
+          name = role.class.to_s.gsub('Inch::Evaluation::Role::', '')
+          hash = {
+            'name' => name,
+            'priority' => role.priority,
+          }
+          hash['potential_score'] = role.potential_score if role.potential_score
+          hash['score'] = role.score if role.score
+          hash['min_score'] = role.min_score if role.min_score
+          hash['max_score'] = role.max_score if role.max_score
+          hash['ref_name'] = ref_name if object.fullname != ref_name
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/inch_ci/worker/build/result.rb

@@ -0,0 +1,81 @@
+module InchCI
+  module Worker
+    module Build
+      class Result < Struct.new(:repo, :branch_name, :latest_revision, :objects)
+        extend Forwardable
+
+        def_delegators :repo, :url
+        def_delegators :repo, :service_name, :user_name, :repo_name
+        def_delegators :repo, :revision_message
+        def_delegators :repo, :revision_author_name
+        def_delegators :repo, :revision_author_email
+        def_delegators :repo, :revision_authored_at
+
+        attr_accessor :started_at
+        attr_accessor :finished_at
+        attr_writer :status
+
+        def duration
+          finished_at - started_at
+        end
+
+        def revision_uid
+          repo.revision
+        end
+
+        def status
+          @status || 'error'
+        end
+
+        def tag_uid
+          repo.tag.empty? ? nil : repo.tag
+        end
+      end
+
+      class ResultSuccess < Result
+        def status
+          'success'
+        end
+      end
+
+      class ResultFail < Result
+        def revision_uid; nil; end
+        def revision_message; nil; end
+        def revision_author_name; nil; end
+        def revision_author_email; nil; end
+        def revision_authored_at; nil; end
+        def tag_uid; nil; end
+        def service_name; nil; end
+        def user_name; nil; end
+        def repo_name; nil; end
+        def status
+          'failed'
+        end
+      end
+
+      class ResultRetrieverFailed < ResultFail
+        def status
+          'failed:retriever'
+        end
+      end
+
+      class ResultChangeBranchFailed < ResultFail
+        def status
+          'failed:change_branch'
+        end
+      end
+
+      class ResultCheckoutRevisionFailed < ResultFail
+        def status
+          'failed:checkout_revision'
+        end
+      end
+
+      class ResultParserFailed < ResultFail
+        def status
+          'failed:parser'
+        end
+      end
+    end
+  end
+end

data/lib/inch_ci/worker/build/task.rb

@@ -0,0 +1,69 @@
+require 'inch'
+require 'repomen'
+
+require_relative 'result'
+require_relative 'report'
+
+module InchCI
+  module Worker
+    module Build
+      class Task
+        def initialize(url, branch_name = 'master', revision = nil)
+          @work_dir = Dir.mktmpdir
+          if revision.nil?
+            revision = 'HEAD'
+            @latest_revision = true
+          end
+          started_at = Time.now
+          @result = build(url, branch_name, revision, !!@latest_revision)
+          @result.finished_at = Time.now
+          @result.started_at = started_at
+          puts Report.new(@result).to_yaml
+        ensure
+          FileUtils.remove_entry @work_dir
+        end
+
+        private
+
+        def build(url, branch_name, revision, latest_revision)
+          @url = url
+          if retrieve_repo
+            if repo.change_branch(branch_name, true)
+              if repo.checkout_revision(revision)
+                if @codebase = parse_codebase(repo.path)
+                  ResultSuccess.new(repo, branch_name, latest_revision, @codebase.objects)
+                else
+                  ResultParserFailed.new(repo, branch_name, latest_revision, nil)
+                end
+              else
+                ResultCheckoutRevisionFailed.new(repo, branch_name, latest_revision, nil)
+              end
+            else
+              ResultChangeBranchFailed.new(repo, branch_name, latest_revision, nil)
+            end
+          else
+            ResultRetrieverFailed.new(repo, branch_name, latest_revision, nil)
+          end
+        end
+
+        def parse_codebase(path)
+          YARD::Config.options[:safe_mode] = true
+          begin
+            ::Inch::Codebase.parse(path)
+          rescue
+            nil
+          end
+        end
+
+        def repo
+          @repo ||= Repomen::Retriever.new(@url, :work_dir => @work_dir)
+        end
+
+        # @return [Repomen::Retriever,nil] either the retrieved repo or +nil+
+        def retrieve_repo
+          repo.retrieved? ? repo : nil
+        end
+      end
+    end
+  end
+end

data/lib/inch_ci/worker/build.rb

@@ -0,0 +1,8 @@
+require_relative 'build/task'
+
+module InchCI
+  module Worker
+    module Build
+    end
+  end
+end

data/lib/inch_ci/worker/list_tags/report.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+
+module InchCI
+  module Worker
+    module ListTags
+      class Report < Struct.new(:tag_list)
+        def to_yaml
+          to_hash.to_yaml
+        end
+
+        private
+
+        def to_hash
+          {'tags' => tag_list}
+        end
+      end
+    end
+  end
+end

data/lib/inch_ci/worker/list_tags/task.rb

@@ -0,0 +1,53 @@
+require 'inch'
+require 'repomen'
+
+require_relative 'report'
+
+module InchCI
+  module Worker
+    module ListTags
+      class Task
+        def initialize(url, branch_name = 'master')
+          @work_dir = Dir.mktmpdir
+          @url = url
+          @branch_name = branch_name
+          puts Report.new(build_tag_list).to_yaml
+        ensure
+          FileUtils.remove_entry @work_dir
+        end
+
+        private
+
+        def build_tag_list
+          if retrieve_repo
+            if repo.change_branch(@branch_name, true)
+              tag_list
+            else
+              # ChangeBranchFailed
+            end
+          else
+            # RetrieverFailed
+          end
+        end
+
+        def repo
+          @repo ||= Repomen::Retriever.new(@url, :work_dir => @work_dir)
+        end
+
+        # @return [Repomen::Retriever,nil] either the retrieved repo or +nil+
+        def retrieve_repo
+          repo.retrieved? ? repo : nil
+        end
+
+        def tag_list
+          Dir.chdir(repo.path) do
+            output = `git for-each-ref --sort='taggerdate' refs/tags`
+            output.lines.map do |line|
+              line.split("\t").last.gsub('refs/tags/', '').chomp
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch_ci/worker/list_tags.rb

@@ -0,0 +1,10 @@
+require_relative 'list_tags/task'
+
+module InchCI
+  module Worker
+    module ListTags
+      class Task
+      end
+    end
+  end
+end

data/lib/inch_ci/worker/version.rb

@@ -0,0 +1,5 @@
+module InchCI
+  module Worker
+    VERSION = "0.2.0"
+  end
+end

data/lib/inch_ci/worker.rb

@@ -0,0 +1,15 @@
+require 'repomen'
+
+# Set the directory where checked out repos are kept
+Repomen.config.work_dir = ENV['REPOMEN_WORK_DIR'] || File.join(__dir__, '..', '..', 'tmp')
+
+# Check out the whole history
+Repomen.config.only_last_revision = false
+
+module InchCI
+  module Worker
+  end
+end
+
+require 'inch_ci/worker/build'
+require 'inch_ci/worker/list_tags'

data/test/integration/build_test.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+describe ::InchCI::Worker::Build do
+  let(:described_class) { ::InchCI::Worker::Build::Task }
+  let(:branch_name) { 'master' }
+  let(:url) { 'git@bitbucket.org:atlassian_tutorial/helloworld.git' }
+  let(:incorrect_url) { 'git@bitbucket.org:atlassian_tutorial/helloworld123.git' }
+
+  #
+  # Good scenarios
+  #
+
+  it 'should retrieve the repo' do
+    out, err = capture_io do
+      @task = described_class.new(url, branch_name)
+    end
+    refute out.empty?
+    assert_match /status: success/, out
+    assert err.empty?
+  end
+
+  it 'should retrieve the repo and checkout revision' do
+    skip # helloworld doesnot have tags
+    # TODO: make own helloworld repo
+    out, err = capture_io do
+      @task = described_class.new(url, branch_name, 'v0.1.0')
+    end
+    refute out.empty?
+    assert_match /status: success/, out
+    assert err.empty?
+  end
+
+  #
+  # Deal with invalid parameters
+  #
+
+  it "should not retrieve non-existing branch in repo" do
+    out, err = capture_io do
+      @task = described_class.new(url, 'somebranch')
+    end
+    refute out.empty?
+    assert_match /status: failed:change_branch/, out
+  end
+
+  it "should not retrieve non-existing revision in repo" do
+    out, err = capture_io do
+      @task = described_class.new(url, branch_name, 'vX.X.X')
+    end
+    refute out.empty?
+    assert_match /status: failed:checkout_revision/, out
+  end
+
+  #
+  # Deal with not existing repos, whatever the parameters are
+  #
+
+  it "should not retrieve non-existing repo" do
+    out, err = capture_io do
+      @task = described_class.new(incorrect_url, branch_name)
+    end
+    refute out.empty?
+    assert_match /status: failed:retriever/, out
+  end
+
+  it "should not retrieve non-existing branch in non-existing repo" do
+    out, err = capture_io do
+      @task = described_class.new(incorrect_url, 'somebranch')
+    end
+    refute out.empty?
+    assert_match /status: failed:retriever/, out
+  end
+
+  it "should not retrieve non-existing revision in non-existing repo" do
+    out, err = capture_io do
+      @task = described_class.new(incorrect_url, branch_name, 'vX.X.X')
+    end
+    refute out.empty?
+    assert_match /status: failed:retriever/, out
+  end
+
+  #
+  # Deal with errors thrown by Inch itself
+  #
+
+  module ::Inch::Codebase
+    class << self
+      alias :parse_original :parse
+    end
+  end
+
+  it "should not retrieve error throwing repo" do
+    # Patch the Parser to fail
+    codebase = ::Inch::Codebase
+    def codebase.parse(*args)
+      raise "Vending machine is broken!"
+    end
+
+    out, err = capture_io do
+      @task = described_class.new(url, branch_name)
+    end
+    refute out.empty?
+    assert_match /status: failed:parser/, out
+
+    # Let's repair the Parser
+    def codebase.parse(*args)
+      parse_original(*args)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'minitest/autorun'
+require 'bundler'
+Bundler.require
+require 'inch_ci/worker'

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: inch_ci-worker
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- René Föhring
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: ''
+email:
+- rf@bamaru.de
+executables:
+- inch_ci-worker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/inch_ci-worker
+- inch_ci-worker.gemspec
+- lib/inch_ci/worker.rb
+- lib/inch_ci/worker/build.rb
+- lib/inch_ci/worker/build/report.rb
+- lib/inch_ci/worker/build/result.rb
+- lib/inch_ci/worker/build/task.rb
+- lib/inch_ci/worker/list_tags.rb
+- lib/inch_ci/worker/list_tags/report.rb
+- lib/inch_ci/worker/list_tags/task.rb
+- lib/inch_ci/worker/version.rb
+- test/integration/build_test.rb
+- test/test_helper.rb
+homepage: https://github.com/inch-ci/inch_ci-worker
+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.0
+signing_key: 
+specification_version: 4
+summary: Worker for the Inch CI project
+test_files:
+- test/integration/build_test.rb
+- test/test_helper.rb
+has_rdoc: