lcoveralls 0.1.0.pre.1

data/bin/lcoveralls

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+#
+# Copyright 2014 Paul Colby
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Include our lib path, if not already.
+lib_path = File.join(File.dirname(File.dirname(File.realpath(__FILE__))), 'lib')
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'lcoveralls'
+Lcoveralls::Runner.new().run

data/lib/lcoveralls/color_formatter.rb

@@ -0,0 +1,52 @@
+#
+# Copyright 2014 Paul Colby
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'logger'
+
+module Lcoveralls
+
+  class ColorFormatter < Logger::Formatter
+
+    COLOR_CODES = {
+      'Warning' => '35',
+      'Error'   => '31',
+      'Fatal'   => '31;1',
+      'Unknown' => '31;1'
+    }
+
+    def initialize(color)
+      @color = color
+    end
+
+    def call(severity, datetime, progname, msg)
+      severity.capitalize!
+      if severity == 'Warn' then severity = 'Warning' end
+
+      if %w[Warning Error Fatal Unknown].include?(severity) then
+        msg = "#{severity}: #{msg}"
+      end
+
+      color_code = COLOR_CODES[severity] if @color
+      if color_code then
+        "\x1b[#{color_code}m#{msg}\x1b[0m\n"
+      else
+        "#{msg}\n"
+      end
+    end
+
+  end
+
+end

data/lib/lcoveralls/coveralls_request.rb

@@ -0,0 +1,53 @@
+#
+# Copyright 2014 Paul Colby
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'json'
+require 'net/http'
+
+module Lcoveralls
+
+  class CoverallsRequest < Net::HTTP::Post
+
+    def initialize(job, path='/api/v1/jobs')
+      super path
+      @boundary = (1...70).map { self.class.boundary_chr(rand(62)) }.join
+      set_content_type "multipart/form-data, boundary=#{@boundary}"
+      @body =
+        "--#{@boundary}\r\n" +
+        "Content-Disposition: form-data; name=\"json_file\"; filename=\"json_file\"\r\n" +
+        "Content-Type: application/json\r\n\r\n" +
+        JSON::generate(job) + "\r\n--#{@boundary}--\r\n"
+    end
+
+    # Note, 0-73 is valid for MIME, but only 0-61 is valid for HTTP headers.
+    def self.boundary_chr(index)
+      case index
+      when 0..9
+        index.to_s
+      when 10..35
+        ('a'.ord + index - 10).chr
+      when 36..61
+        ('A'.ord + index - 36).chr
+      when 62..73
+        "'()+_,-./:=?"[index - 62]
+      else
+        abort "Invalid boundary index #{index}"
+      end
+    end
+
+  end
+
+end

data/lib/lcoveralls/logger.rb

@@ -0,0 +1,27 @@
+#
+# Copyright 2014 Paul Colby
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'logger'
+
+class Logger
+
+  TRACE = DEBUG - 1
+
+  def trace(progname = nil, &block)
+    add(TRACE, nil, progname, &block)
+  end
+
+end

data/lib/lcoveralls/option_parser.rb

@@ -0,0 +1,84 @@
+#
+# Copyright 2014 Paul Colby
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'logger'
+require 'optparse'
+
+module Lcoveralls
+
+  class OptionParser
+
+    def parse!(args)
+      options =  {
+        :color    => $stderr.isatty,
+        :git      => 'git',
+        :service  => File.basename($0),
+        :severity => Logger::INFO
+      }
+
+      if ENV.has_key? 'TRAVIS_JOB_NUMBER' then
+        options[:service] = 'travis-ci'
+        options[:job_id] = ENV['TRAVIS_JOB_NUMBER']
+      end
+
+      parser = ::OptionParser.new do |o|
+      o.banner = "Usage: #{o.program_name} [options] [tracefile(s)]"
+      o.summary_width = 30
+      o.separator ''
+
+      o.separator 'Code / coveralls.io options:'
+      o.on(      '--dryrun',      'Do not submit to coveralls.io' ) { options[:dryrun] = true }
+      o.on(      '--export [PATH=stdout]', 'Export Coveralls job data') do |path|
+        options[:export] = case path
+        when 'stderr'; $stderr
+        when 'stdout'; $stdout
+        when nil ; $stdout
+        else File.new(path, 'w')
+        end
+      end
+      o.on('-r', '--root PATH',   'Set the path to the repo root') { |path|  options[:root]  = File.realpath(path) }
+      o.on('-s', '--service NAME','Set coveralls service name')    { |name|  options[:service] = name }
+      o.on('-t', '--token TOKEN', 'Set coveralls repo token')      { |token| options[:token] = token }
+      o.separator ''
+
+      o.separator 'Stderr output options:'
+      o.on(      '--[no-]color', 'Colorize output')  { |color| options[:color] = color }
+      o.on('-d', '--debug',      'Enable debugging') { options[:severity] = Logger::DEBUG }
+      o.on(      '--trace',      'Maximum output')   { options[:severity] = Logger::TRACE }
+      o.on('-q', '--quiet',      'Show less output') { options[:severity] = options[:severity] + 1 }
+      o.on('-v', '--verbose',    'Show more output') { options[:severity] = options[:severity] - 1 }
+      o.separator ''
+
+      o.separator 'Miscellaneous options:'
+      o.on(      '--[no-]git PATH', 'Path to the git program') { |path| options[:git] = path }
+      o.on('-h', '--help',    'Print usage text, then exit')     { puts o; exit }
+      o.on(      '--version', 'Print version number, then exit') { puts VERSION.join('.'); exit }
+      o.separator ''
+      end
+
+      begin
+        parser.parse! args
+        options
+      rescue ::OptionParser::InvalidOption => e
+        $stderr.puts parser
+        $stderr.puts e
+        exit!
+      end
+    end
+
+  end
+
+end

data/lib/lcoveralls/runner.rb

@@ -0,0 +1,211 @@
+#!/usr/bin/ruby -w
+#
+# Copyright 2014 Paul Colby
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'find'
+
+module Lcoveralls
+  class Runner
+
+    def initialize
+      # Parse the command line options.
+      parser = Lcoveralls::OptionParser.new
+      @options = parser.parse! ARGV
+
+      # Setup a logger instance.
+      @log = Logger.new(STDERR)
+      @log.formatter = Lcoveralls::ColorFormatter.new @options[:color]
+      @log.sev_threshold = @options[:severity]
+      @log.debug { "Options: #{@options}" }
+    end
+
+    def find_root(info_files)
+      # Try source file(s) covered by the lcov tracefile(s).
+      root_dirs = Hash.new(0)
+      info_files.each do |file|
+        File.open(file).each do |line|
+          line.match(/^SF:(.*)$/) do |match|
+            Dir.chdir(File.dirname(match[1])) do
+              root_dir = `"#{@options[:git]}" rev-parse --show-toplevel`.rstrip
+             root_dirs[root_dir] = root_dirs[root_dir] + 1 unless root_dir.empty?
+            end if Dir.exist?(File.dirname(match[1]))
+          end
+        end
+      end
+
+      if root_dirs.empty?
+        nil
+      elsif root_dirs.size == 1
+        root_dirs.shift[0]
+      else
+        root_dir = root_dirs.max_by { |key, value| value }[0]
+        @log.warn "Found multiple possible repo roots. Settled on #{root_dir}"
+        root_dir
+      end
+    end
+
+    def get_percentage(lines_hit, lines_found, bold=false)
+      perc = lines_hit.to_f / lines_found.to_f * 100.0
+      color = case when perc >= 90; 32 when perc >= 75; 33 else 31 end
+      if bold then color = "1;#{color}" end
+      perc = perc.finite? ? format('%5.1f%', perc) : ' ' * 6
+      perc = "\x1b[#{color}m#{perc}\x1b[0m" if @options[:color] and color
+      perc
+    end
+
+    def get_source_files(info_files, root_dir)
+      sources = {}
+      total_lines_found = 0
+      total_lines_hit = 0
+      info_files.each do |file|
+        @log.debug "Processing tracefile: #{file}"
+        source_pathname = nil
+        in_record = false
+        lines_found = nil
+        lines_hit = nil
+        File.open(file).each do |line|
+          @log.debug "#{file}: #{line.rstrip}"
+
+          # SF:<absolute path to the source file>
+          line.match('^SF:' + Regexp.quote(root_dir) + '/(.*)$') do |match|
+            @log.warn 'Found source filename without preceding end_of_record' if in_record
+            @log.debug "Found source filename: #{match[1]}"
+            source_pathname = match[1]
+            if !sources.has_key?(source_pathname) then
+              source = File.read(match[1])
+              sources[source_pathname] = {
+                :name => source_pathname,
+                :source => source,
+                :coverage => Array.new(source.lines.count)
+              }
+            end
+            in_record = true
+          end
+
+          # DA:<line number>,<execution count>[,<checksum>]
+          line.match(/^DA:(?<line>\d+),(?<count>\d+)(,(?<checksum>.*))?$/) do |match|
+            line_index = match[:line].to_i - 1
+            if !sources[source_pathname][:coverage][line_index] then
+              sources[source_pathname][:coverage][line_index] = 0
+            end
+            sources[source_pathname][:coverage][line_index] = 
+              sources[source_pathname][:coverage][line_index] + match[:count].to_i;
+          end if in_record
+
+          # LF:<lines found> or LH:<lines hit>
+          line.match(/^LF:(?<count>\d+)$/) { |match| lines_found = match[:count] }
+          line.match(/^LH:(?<count>\d+)$/) { |match| lines_hit   = match[:count] }
+
+          # end_of_record
+          if line == "end_of_record\n" and in_record then
+            @log.info begin
+              perc = get_percentage(lines_hit, lines_found)
+              "[#{perc}] #{source_pathname} (#{lines_hit}/#{lines_found})"
+            end
+            total_lines_found = total_lines_found + lines_found.to_i
+            total_lines_hit = total_lines_hit + lines_hit.to_i
+            in_record = false
+            lines_found = nil
+            lines_hit = nil
+          end
+        end
+      end
+
+      @log.info begin
+        perc = get_percentage(total_lines_hit, total_lines_found, true)
+        "[#{perc}] Total (#{total_lines_hit}/#{total_lines_found})"
+      end
+
+      sources.values
+    end
+
+    def get_git_info(root_dir)
+      Dir.chdir(root_dir) do
+        info = {
+          :head => {
+            :id             => `"#{@options[:git]}" show --format='%H' --no-patch`.rstrip,
+            :author_name    => `"#{@options[:git]}" show --format='%an' --no-patch`.rstrip,
+            :author_email   => `"#{@options[:git]}" show --format='%ae' --no-patch`.rstrip,
+            :commiter_name  => `"#{@options[:git]}" show --format='%cn' --no-patch`.rstrip,
+            :commiter_email => `"#{@options[:git]}" show --format='%ce' --no-patch`.rstrip,
+            :message        => `"#{@options[:git]}" show --format='%B' --no-patch`.rstrip,
+          },
+          :branch  => `"#{@options[:git]}" rev-parse --abbrev-ref HEAD`.rstrip,
+          :remotes => []
+        }
+
+        `"#{@options[:git]}" remote --verbose`.each_line do |line|
+          line.match(/^(?<name>\S+)\s+(?<url>\S+)(\s+\((fetch|push)\))?/) do |match|
+            info[:remotes] << Hash[match.names.zip(match.captures)]
+          end
+        end
+        info[:remotes].uniq!
+        info.delete(:remotes) if info[:remotes].empty?
+
+        info
+      end if Dir.exist?(root_dir)
+    end
+
+    def run
+      # Find *.info tracefiles if none specified on the command line.
+      Find.find('.') do |path|
+        @log.trace { "Looking for tracefiles: #{path}" }
+        if path =~ /.*\.info$/ then
+          @log.info { "Found tracefile: #{path}" }
+          ARGV << path
+        end
+      end unless ARGV.any?
+
+      @options[:root] = find_root(ARGV) unless @options.include?(:root)
+      if !@options[:root] then
+        @log.error 'Root not specified, nor detected; consider using --root'
+        exit!
+      end
+
+      # Build the coveralls.io job request.
+      job = {}
+      job[:repo_token] = @options[:token] if @options.has_key? :token
+      job[:service_name] = @options[:service] if @options.has_key? :service
+      job[:service_job_id] = @options[:job_id] if @options.has_key? :job_id
+      if !job.has_key?(:token) and !job.has_key?(:service_job_id) then
+        @log.warn 'No service job id detected; consider using --token'
+      end
+      job[:source_files] = get_source_files(ARGV, @options[:root])
+      job[:git] = get_git_info(@options[:root]) unless !@options[:git]
+      job[:run_at] = Time.new
+      request = Lcoveralls::CoverallsRequest.new(job)
+      @log.trace { request.body }
+
+      # If asked to, export the Coveralls API job request JSON document.
+      if @options.has_key? :export then
+        @options[:export].write(JSON::pretty_generate job);
+      end
+
+      # Send (if not in dryrun mode) the Coveralls API request.
+      uri = URI('https://coveralls.io/api/v1/jobs')
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+      if !@options[:dryrun] then
+        @log.debug { "Sending #{request.body.size} bytes to coveralls.io" }
+        res = http.request(request)
+        puts res.body if res
+      end
+    end
+
+  end
+end

data/lib/lcoveralls/version.rb

@@ -0,0 +1,19 @@
+#
+# Copyright 2014 Paul Colby
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Lcoveralls
+  VERSION = [ 0, 1, 0, 'pre', 1 ]
+end

data/lib/lcoveralls.rb

@@ -0,0 +1,22 @@
+#
+# Copyright 2014 Paul Colby
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'lcoveralls/color_formatter'
+require 'lcoveralls/coveralls_request'
+require 'lcoveralls/logger'
+require 'lcoveralls/option_parser'
+require 'lcoveralls/runner'
+require 'lcoveralls/version'

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: lcoveralls
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.1
+  prerelease: 6
+platform: ruby
+authors:
+- Paul Colby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-04-28 00:00:00.000000000 Z
+dependencies: []
+description: Lcoveralls is a simple script for reporting code coverage results from
+  LCOV to Coveralls.
+email: ruby@colby.id.au
+executables:
+- lcoveralls
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lcoveralls.rb
+- lib/lcoveralls/color_formatter.rb
+- lib/lcoveralls/option_parser.rb
+- lib/lcoveralls/version.rb
+- lib/lcoveralls/logger.rb
+- lib/lcoveralls/runner.rb
+- lib/lcoveralls/coveralls_request.rb
+- bin/lcoveralls
+homepage: https://github.com/pcolby/lcoveralls
+licenses:
+- Apache-2.0
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Report Gcov / LCOV (ie C, C++, Go, etc) code coverage to coveralls.io
+test_files: []