jenkins-build 0.1.3 → 0.2.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 730faf862114af0c23a1d01d874413eafc182d41
-  data.tar.gz: c1e1a6ad206f10b633ef145586a41f28293f0fb3
+  metadata.gz: 5b6b94d13fe633861036016e4433bc9cb0262d88
+  data.tar.gz: 1c68f33db52e5b75bb0657a977671ff8415f82d6
 SHA512:
-  metadata.gz: 3168364d029f0ae5248e29cbf73001ca58cafc588f6bcdf00a31ca1ab31bed7e402eb48db6799c4e6925f495f76827a6e6c875712189d7648df3b62671914c89
-  data.tar.gz: 38d0d8f0439c304c9eac1fd11dccf80d8ed2dcb83325f2f492fcb8dca5c4b99ff02e00b2bc7b771e5d4b53242eee7d928a0e5e47093ba61de074ef497d461a6f
+  metadata.gz: 323c82d6f72314c238b4e77a0b616a05dc96c3225138c2f6a9975bfa094a9d33e8070688cf85ef173548bc4949266a36d592c5b216fd72bdc43e4a6434521c7e
+  data.tar.gz: 92ce0ba7f74ce0cb6cf6ddb7a6e0080198278421154f1a58071216fb82be8b5b05059751ca98c4d029e995b6528160913bc9721c7b9df3d77b7f75e3cb54a1f1

data/.gitignore

@@ -6,5 +6,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/examples.txt
 /tmp/
 .jenkins-build
+.*.swp

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
 --color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in jenkins-build.gemspec
 gemspec
+
+
+gem 'pry'
+gem 'pry-byebug', platform: :mri

data/README.md

@@ -9,14 +9,19 @@ Install it from rubygems.org:
 gem install jenkins-build
 ```
 
-
 ## Usage
 
-You have to configure `jenkins-build` to use your jenkins server and project.
-Do that by running:
+First, you need to get your user and API Key for Jenkins. To do that you need to
+log in, in the right corner click your name, then click Configure in the left
+sidebar and finally press 'Show API Token'. You'll need later both the User ID
+and API Token.
+
+Then you have to configure `jenkins-build` to use your jenkins server and
+project. Do that by running:
 
 ```shell
-jenkins-build configure
+jenkins-build configure --api-key JENKINS_API_KEY --user JENKINS_USER_ID
+--server JENKINS_SERVER_URL --project JENKINS_PROJECT_NAME
 ```
 
 And then you can trigger build by running:
@@ -25,14 +30,15 @@ And then you can trigger build by running:
 jenkins-build trigger
 ```
 
-To get your API Key go to your Jenkins, log in, in the right corner click your name, then click
-Configuration in the left sidebar and finally press 'Show API Token'.
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git commits
+and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/jenkins/build.rb

@@ -4,6 +4,9 @@ module Jenkins
     autoload :CLI, 'jenkins/build/cli'
     autoload :Configuration, 'jenkins/build/configuration'
     autoload :Client, 'jenkins/build/client'
+    autoload :Hub, 'jenkins/build/hub'
+    autoload :TestReport, 'jenkins/build/test_report'
+    autoload :Build, 'jenkins/build/build'
     autoload :VERSION, 'jenkins/build/version'
   end
 end

data/lib/jenkins/build/build.rb

@@ -0,0 +1,20 @@
+module Jenkins
+  module Build
+    class Build
+      BUILDS = %w[\d+ lastBuild lastStableBuild lastSuccessfulBuild lastFailedBuild lastUnstableBuild lastUnsuccessfulBuild lastCompletedBuild].freeze
+      JENKINS_PATH = %r{^/jobs/(?<job>[\w-]+)/(?<build_number>#{Regexp.union(BUILDS)})}.freeze
+      NUMBER = /\A\d+\z/.freeze
+
+      attr_reader :uri, :job, :number
+
+      def initialize(url)
+        @uri = URI(url)
+
+        match = @uri.path.match(JENKINS_PATH) or return
+
+        @job = match[:job]
+        @number = (number = match[:build_number]) =~ NUMBER ? number.to_i : number
+      end
+    end
+  end
+end

data/lib/jenkins/build/cli.rb

@@ -6,6 +6,10 @@ module Jenkins
 
       extend Jenkins::Build::Git
 
+      def self.configuration
+        Jenkins::Build::Configuration
+      end
+
       desc "configure", "configures this project"
       option :project, desc: 'Jenkins project name', required: true
       option :server, desc: 'Jenkins server', required: true
@@ -33,14 +37,49 @@ module Jenkins
       option :branch, desc: 'Git branch', default: current_branch
       desc 'status', 'prints status of a branch'
       def status
-        unless system('which', 'hub')
+        ci_status = self.ci_status
+
+        puts "#{ci_status.status}: #{ci_status.uri}"
+      end
+
+      option :branch, desc: 'Git branch', default: current_branch
+      option :job, desc: 'Jenkins job', default: configuration.project
+      option :build, desc: 'Jenkins build number', default: 'lastBuild'
+      option :kind, desc: 'Kind of test failures', type: :string, enum: %w[test spec feature]
+
+      desc 'failures', 'prints failed tests and how to run them'
+      def failures
+        ci_status = self.ci_status
+
+        build = ci_status.build || Jenkins::Build::Build.new(jenkins_job_url)
+
+        report = client.test_report(number: build.number, project: build.job)
+
+        failures = report.failures.compact
+
+        if (kind = options[:kind])
+          failures.select! { |failure| failure.start_with?(kind) }
+        end
+
+        puts failures
+      end
+
+      protected
+
+      def ci_status
+        hub.ci_status(sha: branch)
+      end
+
+      def hub
+        hub = Hub.new
+
+        unless hub.available?
           warn 'install `hub` tool to get ci status (https://github.com/github/hub)'
           exit 1
         end
-        exec('hub', 'ci-status', branch, '-v')
-      end
 
-      private
+        hub
+      end
 
       def branch
         options[:branch]
@@ -50,8 +89,12 @@ module Jenkins
         @client ||= Jenkins::Build::Client.new(configuration)
       end
 
+      def jenkins_job_url
+        URI.join(configuration.server, ['jobs', options[:job], options[:build]].join('/'))
+      end
+
       def configuration
-        @configuration ||= Jenkins::Build::Configuration.new(Dir.pwd)
+        @configuration ||= self.class.configuration.current
       end
     end
   end

data/lib/jenkins/build/client.rb

@@ -13,6 +13,10 @@ module Jenkins
         @connection = Net::HTTP.new(@base_uri.host, @base_uri.port)
         @connection.use_ssl = (@base_uri.scheme == 'https')
 
+        if ENV['DEBUG']
+          @connection.set_debug_output $stderr
+        end
+
         @connection
       end
 
@@ -25,6 +29,20 @@ module Jenkins
         end
       end
 
+      def build(number: 'lastBuild'.freeze, project: @configuration.project)
+        response = get("/job/#{project}/#{number}/api/json")
+      end
+
+      def test_report(number: 'lastBuild'.freeze, project: @configuration.project, builder: TestReport::Builder.new)
+        response = get("/job/#{project}/#{number}/testReport/api/json")
+
+        case response
+          when Net::HTTPOK then builder.build_report(JSON.parse response.body)
+          else
+            raise InvalidResponse, response
+        end
+      end
+
       private
 
       class InvalidResponse < StandardError
@@ -42,12 +60,23 @@ module Jenkins
         uri = URI.join(@base_uri, path)
         body = JSON.generate(params)
 
-        post = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+        post = Net::HTTP::Post.new(uri, json_header)
         post.set_form_data json: body
 
         request(post)
       end
 
+      def get(path)
+        uri = URI.join(@base_uri, path)
+        post = Net::HTTP::Get.new(uri)
+
+        request(post)
+      end
+
+      def json_header
+        { 'Content-Type' => 'application/json' }
+      end
+
       def request(request)
         request.basic_auth(@configuration.user, @configuration.api_key)
 

data/lib/jenkins/build/configuration.rb

@@ -9,6 +9,16 @@ module Jenkins
 
       CONFIG_KEYS = [:server, :project, :api_key, :user]
 
+      class << self
+        extend Forwardable
+
+        def current
+          new(Dir.pwd)
+        end
+
+        def_delegators :current, *CONFIG_KEYS
+      end
+
       def initialize(folder)
         @config = Pathname(CONFIG).expand_path(folder).freeze
         @store = YAML::Store.new(@config)

data/lib/jenkins/build/hub.rb

@@ -0,0 +1,32 @@
+module Jenkins
+  module Build
+    class Hub
+
+      def available?
+        system('which', 'hub', out: '/dev/null')
+      end
+
+      def ci_status(sha: nil)
+        status, build_url = CiStatus.parse self.class.execute(sha)
+        CiStatus.new(status, build_url)
+      end
+
+      def self.execute(commit)
+        `hub ci-status -v #{commit}`
+      end
+
+      class CiStatus < Struct.new(:status, :build)
+        MATCHER = %r{^(?<status>[^:]+): (?<build_url>https?://.+)$}.freeze
+
+
+        def self.parse(output)
+          hub = output.match(MATCHER) or return
+
+          build = Jenkins::Build::Build.new(hub[:build_url])
+          [ hub[:status], build ]
+        end
+      end
+    end
+
+  end
+end

data/lib/jenkins/build/test_report.rb

@@ -0,0 +1,150 @@
+module Jenkins
+  module Build
+    class TestReport
+      def initialize(suites, cases)
+        @suites = suites.freeze
+        @cases = cases.freeze
+      end
+
+      def failures
+        path = project_path
+        failures = @cases.select(&:failure?)
+
+        failures.map do |failure|
+          failure.cause(path)
+        end
+      end
+
+      def suites
+        @suites
+      end
+
+      def project_path
+        group = @cases.map(&:project_path).compact.group_by{ |path| path }.values.max_by(&:size) or return
+        group.first
+      end
+
+      class Builder
+
+        def build_report(report)
+          suites, cases = report.delete('suites'.freeze).map(&method(:build_suite)).transpose
+
+          TestReport.new(suites, cases.flatten)
+        end
+
+        def build_suite(suite)
+          cases = suite.delete('cases'.freeze).map(&method(:build_case))
+          [ Suite.new(suite, cases), cases ]
+        end
+
+        def build_case(test)
+          status = Status.new(test.delete('status'.freeze))
+          stack_trace = StackTrace.new(test.delete('errorStackTrace'))
+          Case.new(test, status, stack_trace)
+        end
+
+      end
+
+      protected
+
+      class Suite
+        def initialize(suite, cases)
+          @suite = suite
+          @cases = cases
+        end
+      end
+
+      class Case
+        attr_reader :status, :stack_trace
+
+        def initialize(test, status, stack_trace)
+          @test = test
+          @status = status
+          @stack_trace = stack_trace
+        end
+
+        def failure?
+          status.failure?
+        end
+
+        def cause(path)
+          stack_trace.cause(path)
+        end
+
+        def project_path
+          path = stack_trace.root_path
+          path.empty? ? nil : path
+        end
+      end
+
+      class Status
+        def initialize(status)
+          @status = status
+        end
+
+        def failure?
+          @status == 'FAILED'.freeze
+        end
+
+        def success?
+          @status == 'PASSED'.freeze
+        end
+      end
+
+      class StackTrace
+        attr_reader :stack_trace, :stderr, :root_path
+
+        def initialize(stderr)
+          @stderr = stderr
+          @stack_trace = extract_stack_frames(stderr.to_s).flatten.compact.reject(&method(:system_path?))
+          @root_path = longest_common_substr(stack_trace) || ''
+        end
+
+        def cause(project_path = root_path)
+          stack_trace.lazy.reverse_each.
+            map { |path| relative_path(path, project_path) }.
+            find(&method(:test_stack_frame?))
+        end
+
+        TEST_PATHS = %w[test spec features]
+
+        def test_stack_frame?(project_frame)
+          TEST_PATHS.any?(&project_frame.method(:start_with?))
+        end
+
+        def relative_path(full_frame, project_path)
+          full_frame.sub(project_path, ''.freeze)
+        end
+
+        RUBY_STACK_FRAME = /[^\w\/](\.?\/[\w._-][\/\w._-]+:\d+)/.freeze
+        CUCUMBER_STACK_FRAME = /(features\/[\w._-][\/\w._-]+:\d+)/.freeze
+
+        def extract_stack_frames(text)
+          text.scan(RUBY_STACK_FRAME) + text.scan(CUCUMBER_STACK_FRAME)
+        end
+
+        SYSTEM_PATHS = %w[/usr/lib /lib]
+
+        def system_path?(path)
+          SYSTEM_PATHS.any?(&path.method(:start_with?))
+        end
+
+        # http://stackoverflow.com/questions/2158313/finding-common-string-in-array-of-strings-ruby
+        def longest_common_substr(strings)
+          return unless strings.length > 1
+          shortest = strings.min_by(&:length) or return
+          maxlen = shortest.length
+          maxlen.downto(0) do |len|
+            0.upto(maxlen - len) do |start|
+              substr = shortest[start,len]
+              return substr if strings.all?{|str| str.start_with?(substr) }
+            end
+          end
+
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/jenkins/build/version.rb

@@ -1,5 +1,5 @@
 module Jenkins
   module Build
-    VERSION = "0.1.3"
+    VERSION = "0.2.0.pre1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins-build
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0.pre1
 platform: ruby
 authors:
 - Michal Cichra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -83,10 +84,13 @@ files:
 - bin/jenkins-build
 - jenkins-build.gemspec
 - lib/jenkins/build.rb
+- lib/jenkins/build/build.rb
 - lib/jenkins/build/cli.rb
 - lib/jenkins/build/client.rb
 - lib/jenkins/build/configuration.rb
 - lib/jenkins/build/git.rb
+- lib/jenkins/build/hub.rb
+- lib/jenkins/build/test_report.rb
 - lib/jenkins/build/version.rb
 homepage: https://github.com/3scale/jenkins-build
 licenses: []
@@ -102,13 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: CLI utility to trigger jobs on jenkins.
 test_files: []
+has_rdoc: