gcovtools 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8314cd41c5ead47cae359e181b5021016ddb7e23
+  data.tar.gz: 565783cb5e96dedff1a27c229da4b86aa2fa6bad
+SHA512:
+  metadata.gz: 13767da67d715e9cda49872f549f1ee415113c82cefaff960e43e239149eae0e32faeeb5054b661733899a5013892c6d50b581b58fec43675c0afaa5699a56d4
+  data.tar.gz: 5aa48a5638137f9613de783e944a41100b5cdc5283e6230f46a04bb811daa2ed2a44c348b253721eca06161ee3de9ad235bc51ca774755f4b0c8567001d9a392

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+## Emacs
+*~

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Mattias Bergbom
+
+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,25 @@
+gcovtools
+======
+
+![Travis CI Status](https://travis-ci.org/mattiasbergbom/gcovtools.svg)
+
+**gcovtools** provides various tools and utilities for processing coverage data emitted from [llvm-cov](http://llvm.org/docs/CommandGuide/llvm-cov.html).
+
+Quick Start
+-----------
+
+First, unless you haven't already done so, compile your project using ```clang --coverage``` and digest the output using ```llvm-cov``` (see the `src` dir for examples). You should end up with one or more ```.gcov``` files.
+
+Next, install the gem:
+
+```gem install gcovtools```
+
+This should furnish you with a ```gcovtools``` executable in your path.
+
+Finally, execute ```gcovtools``` in one of multiple possible ways. For instance, generate a HTML coverage report:
+
+```gcovtools convert --format html *.gcov > coverage.html```
+
+Disclaimer
+----------
+This is a work in progress.

data/Rakefile

@@ -0,0 +1,2 @@
+Dir['tasks/**/*.rake'].sort.each { |lib| load lib }
+

data/bin/gcovtools

@@ -0,0 +1,138 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require 'mixlib/cli'
+
+require_relative '../lib/logging'
+require_relative '../lib/gcovtools'
+require_relative '../lib/ansii_formatter'
+require_relative '../lib/xml_formatter'
+require_relative '../lib/html_formatter'
+require_relative '../lib/json_formatter'
+require_relative '../lib/version'
+
+class Util
+  def Util.opt_wrap(s, width=61)
+    s.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n                                       # ")
+  end
+end
+ 
+class MyCLI < Thor
+
+  class_option :verbose, :type => :boolean, :desc => "Be verbose"
+  desc "report FILES", "generate a coverage report from one or more gcov FILES"
+
+  method_option :recursive, :type => :boolean, :desc => "Search for input files recursively in the directory/ies specified."
+  
+  method_option :include,
+  :desc => ::Util.opt_wrap("A list of regex filters which specify which files to include in the report. Will filter on the actual filename (taking into account any path mangling done by llvm-cov) as well as the 'Source' meta attribute in the GCOVTOOLS data. 
+Available presets:
+:xcode - Xcode system headers
+:linux - Linux system headers
+"),
+  :type => :array
+
+  method_option :exclude,
+  :desc => ::Util.opt_wrap("A list of regex filters which specify which files NOT to include in the report. Will filter on the actual filename (taking into account any path mangling done by llvm-cov) as well as the 'Source' meta attribute in the GCOVTOOLS data. The filters will be applied in the order inclusive-exclusive, where an empty/unspecified filter means to include all files encountered.
+
+Available presets:
+:xcode - Xcode system headers
+:linux - Linux system headers
+"),
+  :type => :array
+
+  method_option :inclusive,
+  :desc => ::Util.opt_wrap("Filter inclusively instead of exclusively (which is the default)."),
+  :type => :boolean
+
+  method_option :format,
+  :aliases => "-f",
+  :desc => ::Util.opt_wrap("The output format (ascii, html, xml, json)"),
+  :default => "ascii"
+  
+  method_option :css,
+  :aliases => "-c",
+  :desc => ::Util.opt_wrap("CSS file to reference in HTML output.")
+
+  method_option :xsl,
+  :aliases => "-x",
+  :desc => ::Util.opt_wrap("XSL file to reference in XML output.")
+
+  method_option :recursive,
+  :aliases => "-r",
+  :desc => ::Util.opt_wrap("Recursively load all .gcov files in the given directory"),
+  :type => :boolean
+  
+  method_option :verbose,
+  :aliases => "-v",
+  :desc => ::Util.opt_wrap("Verbose output"),
+  :type => :boolean
+
+  # --------------------------------------------------------------------------------------- #
+  # Generate report
+  # --------------------------------------------------------------------------------------- #
+  def report(*filenames)
+
+    fail "Got no filename" unless filenames
+
+    if options[:verbose]
+      GCOVTOOLS::logger.level = Logger::INFO
+    end
+
+    GCOVTOOLS::logger.info "gcovtools v#{GCOVTOOLS::VERSION}"
+
+    proj = GCOVTOOLS::Project.new
+
+    filter = { 
+      :include => [],
+      :exclude => [] 
+    }
+
+    [:include,:exclude].each do |verb|
+
+      if !options[verb].nil? 
+        options[verb].each do |f|
+          filter[verb] <<  case f
+                           when ":xcode" then /Developer\/(Toolchains|Platforms)\/.*\/usr\/include\//
+                           when ":linux" then /\/usr\/include\//
+                           when nil then nil
+                           else /#{f}/
+                           end
+        end # each f
+      end
+      GCOVTOOLS::logger.info "#{verb.to_s}: #{filter[verb]}"
+    end
+
+    filenames.each do |filename|
+      GCOVTOOLS::logger.info "processing: #{filename}"
+      if File.directory? filename
+        proj.add_dir filename, :recursive => options[:recursive], :include => filter[:include], :exclude => filter[:exclude]
+      elsif File.file? filename
+        proj.add_file filename, :include => filter[:include], :exclude => filter[:exclude]
+      end
+    end
+
+    GCOVTOOLS::logger.info "project has #{proj.files.count} files after filtering"
+    GCOVTOOLS::logger.info "#{proj.files.map(&:name).join("\n")}"
+
+    case options[:format].to_sym
+    when :ascii then
+      formatter = GCOVTOOLS::ANSIIFormatter.new proj
+      formatter.print
+    when :html then
+      formatter = GCOVTOOLS::HTMLFormatter.new( proj, :css => options[:css] )
+      formatter.print
+    when :xml then
+      formatter = GCOVTOOLS::XMLFormatter.new( proj, :xsl => options[:xsl] )
+      formatter.print
+    when :json then
+      formatter = GCOVTOOLS::JSONFormatter.new proj
+      formatter.print
+    else
+      fail "Invalid output format: #{options[:format]}"
+    end
+  end
+
+end
+
+MyCLI.start(ARGV)

data/gcovtools.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path('../lib/version.rb', __FILE__)
+
+Gem::Specification.new do |gem|
+
+  gem.name        = 'gcovtools'
+  gem.version     = GCOVTOOLS::VERSION
+  gem.date        = '2014-12-09'
+  gem.summary     = "gcov parser and formatter"
+  gem.description = "gcovtools digests .gcov files generated by llvm-cov and translates them into various common formats"
+  gem.authors     = ["Mattias Bergbom"]
+  gem.email       = 'mattias.bergbom@gmail.com'
+  gem.files       = `git ls-files`.split($\)
+  gem.executables = ["gcovtools"]
+  gem.homepage    = 'http://rubygems.org/gems/gcovtools'
+  gem.license     = 'MIT'
+  gem.required_ruby_version = '>= 2.0'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rubygems-tasks'
+  gem.add_development_dependency 'simplecov'
+  
+  gem.add_runtime_dependency 'terminal-table'
+  gem.add_runtime_dependency 'term-ansicolor'
+  gem.add_runtime_dependency 'thor'
+  gem.add_runtime_dependency 'gyoku', '~> 1.0'
+
+end

data/lib/ansii_formatter.rb

@@ -0,0 +1,34 @@
+require 'term/ansicolor'
+include Term::ANSIColor
+
+require_relative './project'
+require_relative './file'
+require_relative './line'
+
+module GCOVTOOLS
+  
+  class ANSIIFormatter
+    
+    def initialize project
+      @project = project
+    end
+    
+    def print
+      
+      @project.files.each do |file|
+        puts "#{white}#{bold}=== #{file.meta['Source']} ===#{reset}"
+        file.lines.select{|line| line.number > 0}.each do |line|
+          col = case line.count
+                when :none then dark+white
+                when :missed then black+on_red
+                else green
+                end
+          puts col + line.text + reset
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/file.rb

@@ -0,0 +1,149 @@
+require_relative './line'
+require 'pathname'
+
+class TrueClass
+  def to_i
+    return 1
+  end
+end
+
+class FalseClass
+  def to_i
+    return 0
+  end
+end
+
+module GCOVTOOLS
+
+  class File
+
+    attr_reader :name, :lines, :meta, :stats
+
+    def initialize name
+      fail "name required" unless name and name.is_a? String
+      @name = name
+      @lines = {}
+      @meta = {}
+      @stats = {}
+      _update_stats
+    end
+
+    # return lines as array, in order by number
+    def lines
+      @lines.sort.map{|key,val|val}
+    end
+
+    def add_lines &block
+      fail "add_lines requires a block" unless block_given?
+      @adding = true
+      yield
+      @adding = false
+      _update_stats
+    end
+
+    def _update_stats
+      @stats = { 
+        :missed_lines => 0,
+        :exec_lines => 0,
+        :empty_lines => 0,
+        :total_exec => 0,
+        :total_lines => 0,
+        :lines => 0,
+        :coverage => 0.0,
+        :hits_per_line => 0.0
+      }
+
+      @lines.each do |index,line|
+        @stats[:missed_lines] += (line.state == :missed).to_i
+        @stats[:exec_lines] += (line.state == :exec).to_i
+        @stats[:total_exec] += (line.count.is_a?(Integer) ? line.count : 0 )
+        @stats[:empty_lines] += (line.state == :none).to_i
+      end
+      
+      @stats[:lines] = @stats[:exec_lines] + @stats[:missed_lines]
+      @stats[:total_lines] = @stats[:lines] + @stats[:empty_lines]
+
+      if @stats[:lines] > 0 
+        @stats[:coverage] = @stats[:exec_lines].to_f / @stats[:lines].to_f
+        @stats[:hits_per_line] = @stats[:total_exec].to_f / @stats[:lines]
+      else
+        @stats[:coverage] = 1
+        @stats[:hits_per_line] = 0
+      end
+      
+      @stats[:coverage_s] = sprintf("%0.01f%",100.0*@stats[:coverage])
+      @stats[:hits_per_line_s] = sprintf("%0.02f",@stats[:hits_per_line])
+
+    end
+
+    def _add_line line
+      if line.number == 0
+        key,val = /([^:]+):(.*)$/.match(line.text).to_a[1..2]
+        @meta[key] = val
+      else
+        @lines[line.number] = line
+      end
+    end
+
+    def <<(line)
+      fail "need to be in add_lines block" unless @adding
+      _add_line line
+    end
+
+    def self.load filename
+      files = []
+      file = nil
+      ::File.open(filename, "r") do |file_handle|
+        file_handle.each_line do |line_|
+          line = GCOVTOOLS::Line.parse(line_)
+          if line.number == 0
+            key,val = /([^:]+):(.*)$/.match(line.text).to_a[1..2]
+            if key == 'Source'
+              if !file.nil?
+                file._update_stats
+                files << file
+              end # if
+              file = GCOVTOOLS::File.new val
+            end # if source
+          end # if line == 0
+          file._add_line line
+        end # each line
+      end# file_handle
+      if file
+        file._update_stats
+        files << file
+      end # if file
+      files
+    end
+
+    def self.demangle filename
+      result = filename.dup
+      if start = result.index(/###/)
+        result = result[start..-1]
+      end
+      
+      result.gsub!( /(###|#|\^|\.gcov$)/, {"###"=>"/","#"=>"/","^"=>"..",".gcov"=>""} ) 
+      result = ::Pathname.new(result).cleanpath.to_s
+      result
+    end
+
+    def merge! other
+      other.lines.each do |line|
+        if @lines.has_key? line.number
+          @lines[line.number].merge! line
+        else
+          @lines[line.number] = line
+        end
+      end
+      _update_stats
+    end
+
+    def merge other
+      result = self.dup
+      result.merge! other
+      result
+    end
+
+  end # class File
+
+end

data/lib/gcovtools.rb

@@ -0,0 +1,4 @@
+require_relative './line'
+require_relative './file'
+require_relative './project'
+require_relative './version'

data/lib/html_formatter.rb

@@ -0,0 +1,84 @@
+
+require_relative './project'
+require_relative './file'
+require_relative './line'
+
+require 'erb'
+require 'cgi'
+
+module GCOVTOOLS
+  
+  class HTMLFormatter
+    
+    def get_binding # this is only a helper method to access the objects binding method
+      binding
+    end
+    
+    def initialize project, va={}
+      @project = project
+      @css = va[:css]
+
+      if !@css
+        @csslink = <<EOF
+      <style>
+
+      </style>
+EOF
+      else
+        @csslink = "<link rel=\"stylesheet\" href=\"#{@css}\" />"
+      end
+      
+      @template = ::File.read(::File.join(::File.dirname(__FILE__),"html_view.html.erb"))
+    end # initialize
+    
+    def class_of line
+      case line.count
+      when :none then "irrelevant"
+      when :missed then "missed"
+      else "ok"
+      end
+    end
+
+    def class_of_stat value, error_comp, warning_comp=nil
+      if eval("#{value}#{error_comp}")
+        return "value_error"
+      elsif !warning_comp.nil? and eval("#{value}#{warning_comp}")
+        return "value_warning"
+      else
+        return "value_ok"
+      end
+    end
+
+    def class_of_file file, error_level, warning_level=nil
+      if file.stats[:coverage] <= error_level
+        return "header error"
+      elsif !warning_level.nil? and file.stats[:coverage] < warning_level
+        return "header warning"
+      else
+        return "header ok"
+      end
+    end
+
+    def count_of line
+      case line.count
+      when :none then ""
+      when :missed then "<strong>miss</strong>"
+      else line.count
+      end
+    end
+
+    def encode text
+      CGI.escapeHTML( text )
+    end
+
+    def print
+      
+      renderer = ERB.new( @template )
+      
+      puts renderer.result(self.get_binding)
+      
+    end # HTMLFormatter#print
+
+  end # HTMLFormatter
+
+end # GCOVTOOLS