gcovtools 1.0.0

data/spec/gcovtools/project_spec.rb

@@ -0,0 +1,299 @@
+require_relative '../spec_helper'
+
+describe GCOVTOOLS::Project do
+
+  describe "#name" do
+    it "can be given in the constructor" do
+      project = GCOVTOOLS::Project.new "Test"
+      expect(project.name).to eq("Test")
+    end
+
+    it "is optional in the constructor" do
+      project = GCOVTOOLS::Project.new
+      expect(project.name).to eq("")
+    end
+
+    it "can be modified" do
+      project = GCOVTOOLS::Project.new "Test"
+      project.name = "Test2"
+      expect(project.name).to eq("Test2")
+    end
+    
+  end
+
+  describe "#files" do
+    it "returns no files if it is empty" do
+      project = GCOVTOOLS::Project.new "Test"
+      expect(project.files.count).to eq(0)
+    end
+
+    it "returns the files it has been given" do
+      project = GCOVTOOLS::Project.new "Test"
+      project << GCOVTOOLS::File.new("foobar.cpp")
+      project << GCOVTOOLS::File.new("boofar.cpp")
+      expect(project.files.count).to eq(2)
+      expect(project.files.map(&:name)).to include(a_string_ending_with("foobar.cpp"))
+      expect(project.files.map(&:name)).to include(a_string_ending_with("boofar.cpp"))
+    end
+  end
+
+  describe ".load_dir" do
+    it "loads all files in the given directory" do
+      project = GCOVTOOLS::Project.load_dir(File.join(File.dirname(__FILE__),"data"))
+      expect(project.files.count).to eq(3)
+      expect(project.files.map{|file|file.name}).to include(a_string_ending_with("test2.cpp"))
+      expect(project.files.map{|file|file.name}).not_to include(a_string_ending_with("test3.cpp"))
+    end
+    
+    it "recursively loads all files in the given directory structure" do
+      project = GCOVTOOLS::Project.load_dir(File.join(File.dirname(__FILE__),"data"), :recursive => true)
+      expect(project.files.count).to eq(4)
+      expect(project.files.map{|file|file.name}).to include(a_string_ending_with("test2.cpp"))
+      expect(project.files.map{|file|file.name}).to include( a_string_ending_with("test3.cpp") )
+    end
+
+  end
+
+  describe "#add_file" do
+    it "should add the given file" do
+      project = GCOVTOOLS::Project.new
+      project.add_file(File.join(File.dirname(__FILE__),"data","test2.cpp.gcov"))
+      expect(project.files.count).to eq(1)
+      expect(project.files[0].name).to eq( "test2.cpp" )
+    end
+
+    it "should split concatenated gcov files into multiple objects" do
+      project = GCOVTOOLS::Project.new
+      project.add_file(File.join(File.dirname(__FILE__),"concat","test_cat.cpp.gcov"))
+      expect(project.files.count).to eq(2)
+      expect(project.files.map(&:name)).to include( "test.cpp" )
+      expect(project.files.map(&:name)).to include( "test1.cpp" )
+    end
+
+    it "should filter using given array of expressions" do
+      project = GCOVTOOLS::Project.new
+      project.add_file(File.join(File.dirname(__FILE__),"data","test2.cpp.gcov"), :exclude => [/test2\.cpp/,/test3\.cpp/])
+      expect(project.files.count).to eq(0)
+    end
+
+    it "should filter out concatenated files that match the filter" do
+      project = GCOVTOOLS::Project.new
+      project.add_file(File.join(File.dirname(__FILE__),"concat","test_cat.cpp.gcov"), :exclude => [/test\.cpp$/])
+      expect(project.files.count).to eq(1)
+      expect(project.files.map(&:name)).not_to include( a_string_ending_with("test.cpp") )
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test1.cpp") )
+    end
+
+    it "should not filter out concatenated files that don't match the filter" do
+      project = GCOVTOOLS::Project.new
+      project.add_file(File.join(File.dirname(__FILE__),"concat","test_cat.cpp.gcov"), :exclude => [/test_cat\.cpp\.gcov$/])
+      expect(project.files.count).to eq(2)
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test.cpp") )
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test1.cpp") )
+    end
+
+    it "should filter inclusively if told to" do
+      project = GCOVTOOLS::Project.new
+      project.add_file(File.join(File.dirname(__FILE__),"concat","test_cat.cpp.gcov"), :include => [/test\.cpp$/] )
+      expect(project.files.count).to eq(1)
+      expect(project.files.map(&:name)).not_to include( a_string_ending_with("test1.cpp") )
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test.cpp") )
+    end
+
+    it "should apply all inclusive filters" do
+      project = GCOVTOOLS::Project.new
+      project.add_file(File.join(File.dirname(__FILE__),"concat","test_cat.cpp.gcov"), :include => [/test\.cpp$/,/test1\.cpp$/] )
+      expect(project.files.count).to eq(2)
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test1.cpp") )
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test.cpp") )
+    end
+
+    it "should apply exclusive filters after inclusive ones" do
+      project = GCOVTOOLS::Project.new
+      project.add_file(File.join(File.dirname(__FILE__),"concat","test_cat.cpp.gcov"), :include => [/test.*\.cpp$/], :exclude => [/test.cpp/] )
+      expect(project.files.count).to eq(1)
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test1.cpp") )
+      expect(project.files.map(&:name)).not_to include( a_string_ending_with("test.cpp") )
+    end
+
+    it "should merge file stats for identical filenames" do
+      project = GCOVTOOLS::Project.new
+      project.add_files do
+        file = GCOVTOOLS::File.new "myfile.cpp"
+        file.add_lines do
+          file << GCOVTOOLS::Line.new(0,:none,"Source:myfile.cpp")
+          file << GCOVTOOLS::Line.new(1,4,"line 1")
+          file << GCOVTOOLS::Line.new(2,23,"line 2")
+          file << GCOVTOOLS::Line.new(3,:none,"line 3")
+          file << GCOVTOOLS::Line.new(4,:missed,"line 4")
+          file << GCOVTOOLS::Line.new(5,:none,"line 5")
+        end
+
+        project << file
+
+        file = GCOVTOOLS::File.new "myfile.cpp"
+        file.add_lines do
+          file << GCOVTOOLS::Line.new(0,:none,"Source:myfile.cpp")
+          file << GCOVTOOLS::Line.new(1,:missed,"line 1")
+          file << GCOVTOOLS::Line.new(2,40,"line 2")
+          file << GCOVTOOLS::Line.new(3,:none,"line 3")
+          file << GCOVTOOLS::Line.new(4,:none,"line 4")
+        end
+
+        project << file
+        
+      end # add_files
+
+      expect(project.files.count).to eq(1)
+      
+    end # it
+
+  end # describe
+
+  describe "#add_dir" do
+    it "adds all files in the given directory" do
+      project = GCOVTOOLS::Project.load_dir(File.join(File.dirname(__FILE__),"data","data2"))
+      project.add_dir(File.join(File.dirname(__FILE__),"data"))
+      expect(project.files.count).to eq(4)
+      expect(project.files.map{|file|file.name}).to include( a_string_ending_with("test2.cpp") )
+      expect(project.files.map{|file|file.name}).to include( a_string_ending_with("test3.cpp") )
+    end
+
+    it "recursively adds all files in the given directory" do
+      project = GCOVTOOLS::Project.new
+      project.add_dir(File.join(File.dirname(__FILE__),"data"), :recursive => true)
+      expect(project.files.count).to eq(4)
+      expect(project.files.map{|file|file.name}).to include( a_string_ending_with("test2.cpp") )
+      expect(project.files.map{|file|file.name}).to include( a_string_ending_with("test3.cpp") )
+    end
+
+    it "filters using given singular expression" do
+      project = GCOVTOOLS::Project.new
+      project.add_dir(File.join(File.dirname(__FILE__),"data"), :recursive => true, :exclude => [/test2\.cpp/])
+      expect(project.files.count).to eq(3)
+      expect(project.files.map{|file|file.name}).not_to include( a_string_ending_with("test2.cpp") )
+      expect(project.files.map{|file|file.name}).to include( a_string_ending_with("test3.cpp") )
+    end
+
+    it "filters using given array of expressions" do
+      project = GCOVTOOLS::Project.new
+      project.add_dir(File.join(File.dirname(__FILE__),"data"), :recursive => true, :exclude => [/test2\.cpp/,/test3\.cpp/])
+      expect(project.files.count).to eq(2)
+      expect(project.files.map{|file|file.name}).not_to include( a_string_ending_with("test2.cpp") )
+      expect(project.files.map{|file|file.name}).not_to include( a_string_ending_with("test3.cpp") )
+    end
+
+    it "should filter out concatenated files that match the filter" do
+      project = GCOVTOOLS::Project.new
+      project.add_dir(File.join(File.dirname(__FILE__),"concat"), :recursive => true, :exclude => [/test\.cpp$/])
+      expect(project.files.count).to eq(1)
+      expect(project.files.map(&:name)).not_to include( a_string_ending_with("test.cpp") )
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test1.cpp") )
+    end
+
+    it "should not filter out concatenated files that don't match the filter" do
+      project = GCOVTOOLS::Project.new
+      project.add_dir(File.join(File.dirname(__FILE__),"concat"), :recursive => true, :exclude => [/test_cat\.cpp/])
+      expect(project.files.count).to eq(2)
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test.cpp") )
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test1.cpp") )
+    end
+
+    it "should filter inclusively if told to" do
+      project = GCOVTOOLS::Project.new
+      project.add_dir(File.join(File.dirname(__FILE__),"concat"), :recursive => true, :include => [/test\.cpp/])
+      expect(project.files.count).to eq(1)
+      expect(project.files.map(&:name)).not_to include( a_string_ending_with("test1.cpp") )
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test.cpp") )
+    end
+
+    it "should apply all inclusive filters" do
+      project = GCOVTOOLS::Project.new
+      project.add_dir(File.join(File.dirname(__FILE__),"concat"), :recursive => true, :include => [/test\.cpp$/,/test1\.cpp$/] )
+      expect(project.files.count).to eq(2)
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test1.cpp") )
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test.cpp") )
+    end
+
+    it "should apply exclusive filters after inclusive ones" do
+      project = GCOVTOOLS::Project.new
+      project.add_dir(File.join(File.dirname(__FILE__),"concat"), :recursive => true, :include => [/test.*\.cpp$/], :exclude => [/test.cpp/] )
+      expect(project.files.count).to eq(1)
+      expect(project.files.map(&:name)).to include( a_string_ending_with("test1.cpp") )
+      expect(project.files.map(&:name)).not_to include( a_string_ending_with("test.cpp") )
+    end
+
+  end
+
+
+  describe "#stats" do
+    it "should be computed based on file stats" do
+      project = GCOVTOOLS::Project.new
+
+      project.add_files do
+        file = GCOVTOOLS::File.new "myfile.cpp"
+        file.add_lines do
+          file << GCOVTOOLS::Line.new(1,4,"line 1")
+          file << GCOVTOOLS::Line.new(2,23,"line 2")
+          file << GCOVTOOLS::Line.new(3,:none,"line 3")
+          file << GCOVTOOLS::Line.new(4,:missed,"line 4")
+          file << GCOVTOOLS::Line.new(5,:none,"line 5")
+        end
+
+        project << file
+
+        file = GCOVTOOLS::File.new "myfile2.cpp"
+        file.add_lines do
+          file << GCOVTOOLS::Line.new(1,:missed,"line 1")
+          file << GCOVTOOLS::Line.new(2,40,"line 2")
+          file << GCOVTOOLS::Line.new(3,:none,"line 3")
+          file << GCOVTOOLS::Line.new(4,:none,"line 4")
+        end
+
+        project << file
+        
+      end
+      
+      expect(project.stats[:lines]).to eq(5)
+      expect(project.stats[:total_lines]).to eq(9)
+      expect(project.stats[:total_exec]).to eq(67)
+      expect(project.stats[:empty_lines]).to eq(4)
+      expect(project.stats[:exec_lines]).to eq(3)
+      expect(project.stats[:missed_lines]).to eq(2)
+      expect(project.stats[:coverage]).to eq(3.0/5)
+      expect(project.stats[:hits_per_line]).to eq(67.0/5)
+
+    end      
+
+    it "should be computed based on file stats" do
+      project = GCOVTOOLS::Project.new
+
+      project.add_files do
+        file = GCOVTOOLS::File.new "myfile.cpp"
+        file.add_lines do
+          file << GCOVTOOLS::Line.new(1,:none,"line 1")
+          file << GCOVTOOLS::Line.new(2,:none,"line 2")
+          file << GCOVTOOLS::Line.new(3,:none,"line 3")
+          file << GCOVTOOLS::Line.new(4,:none,"line 4")
+        end
+
+        project << file
+
+        file = GCOVTOOLS::File.new "myfile2.cpp"
+        file.add_lines do
+          file << GCOVTOOLS::Line.new(1,:none,"line 1")
+          file << GCOVTOOLS::Line.new(2,:none,"line 2")
+        end
+
+        project << file
+        
+      end
+      
+      expect(project.stats[:lines]).to eq(0)
+      expect(project.stats[:coverage]).to eq(1)
+      expect(project.stats[:hits_per_line]).to eq(0)
+
+    end # it
+  end # describe #stats
+
+end # describe Project

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+# require_relative '../lib/logging'
+# GCOVTOOLS::logger.level = Logger::INFO
+
+require 'simplecov'
+SimpleCov.start
+
+require_relative '../lib/line'
+require_relative '../lib/file'
+require_relative '../lib/project'
+
+$LOAD_PATH << File.expand_path(File.join('..', 'lib'), File.dirname(__FILE__))
+

data/src/Makefile

@@ -0,0 +1,48 @@
+CXX=clang++
+CFLAGS=-I. --coverage
+DEPS = test.h
+OBJ = test.o test1.o test2.o test3.o
+SPECDIR = ../spec/gcov2x
+OUTDIR = $(SPECDIR)/data
+OUTDIR_CAT = $(SPECDIR)/concat
+
+all: $(OUTDIR)/test.cpp.gcov $(OUTDIR)/test1.cpp.gcov $(OUTDIR)/test2.cpp.gcov $(OUTDIR)/data2/test3.cpp.gcov $(OUTDIR)/data2/test3.cpp.gcov $(OUTDIR_CAT)/test_cat.cpp.gcov
+
+$(OUTDIR)/test.cpp.gcov: test.cpp.gcov $(OUTDIR)
+	@cp -fv $< $@
+
+$(OUTDIR)/test1.cpp.gcov: test1.cpp.gcov $(OUTDIR)
+	@cp -fv $< $@
+
+$(OUTDIR)/test2.cpp.gcov: test2.cpp.gcov $(OUTDIR)
+	@cp -fv $< $@
+
+$(OUTDIR)/data2/test3.cpp.gcov: test3.cpp.gcov $(OUTDIR)/data2
+	@cp -fv $< $@
+
+$(OUTDIR_CAT)/test_cat.cpp.gcov: test.cpp.gcov test1.cpp.gcov
+	@echo "\nCreating $@\n"
+	@cat $^ > $@
+
+%.cpp.gcov: %.cpp test
+	@./test
+	@llvm-cov -l -p $<
+
+test: $(OBJ)
+	$(CXX) $(CFLAGS) -o $@ $^ 
+
+%.o: %.cpp $(DEPS)
+	$(CXX) $(CFLAGS) -c -o $@ $< 
+
+$(OUTDIR):
+	mkdir -p $(OUTDIR)
+
+$(OUTDIR)/data2:
+	mkdir -p $(OUTDIR)/data2
+
+$(OUTDIR_CAT):
+	mkdir -p $(OUTDIR_CAT)
+
+clean:
+	@rm -f *.o *.gcda *.gcno *.gcov
+	@rm -f test

data/src/test.cpp

@@ -0,0 +1,9 @@
+#include "test.h"
+
+int main( int argc, const char* argv[] )
+{
+    reached(2);
+    reached2(2);
+    reached3(2);
+    return 0;
+}

data/src/test.h

@@ -0,0 +1,7 @@
+
+int reached(int);
+int reached2(int);
+int reached3(int);
+int unreached(int);
+int unreached3(int);
+int unreached4(int);

data/src/test1.cpp

@@ -0,0 +1,16 @@
+
+int reached( int i )
+{
+    int j = i;
+
+    if( j == 2 )
+        return j;
+    
+    return 3;
+}
+
+int unreached( int x )
+{
+    int y = x;
+    return y+3;
+}

data/src/test2.cpp

@@ -0,0 +1,17 @@
+
+int unreached2( int x )
+{
+    int y = x;
+    return y+3;
+}
+
+int reached2( int i )
+{
+    int j = i;
+
+    if( j == 2 )
+        return j;
+    
+    return 3;
+}
+

data/src/test3.cpp

@@ -0,0 +1,17 @@
+
+int unreached3( int x )
+{
+    int y = x;
+    return y+3;
+}
+
+int reached3( int i )
+{
+    int j = i;
+
+    if( j == 2 )
+        return j;
+    
+    return 3;
+}
+

data/tasks/rubygems.rake

@@ -0,0 +1,3 @@
+require 'rubygems/tasks'
+
+Gem::Tasks.new(:sign => {:checksum => true } )

data/tasks/spec.rake

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: gcovtools
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mattias Bergbom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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: rubygems-tasks
+  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: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: gcovtools digests .gcov files generated by llvm-cov and translates them
+  into various common formats
+email: mattias.bergbom@gmail.com
+executables:
+- gcovtools
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/gcovtools
+- gcovtools.gemspec
+- lib/ansii_formatter.rb
+- lib/file.rb
+- lib/gcovtools.rb
+- lib/html_formatter.rb
+- lib/html_view.html.erb
+- lib/json_formatter.rb
+- lib/line.rb
+- lib/logging.rb
+- lib/project.rb
+- lib/version.rb
+- lib/xml_formatter.rb
+- spec/gcovtools/concat/test_cat.cpp.gcov
+- spec/gcovtools/data/data2/test3.cpp.gcov
+- spec/gcovtools/data/test.cpp.gcov
+- spec/gcovtools/data/test1.cpp.gcov
+- spec/gcovtools/data/test2.cpp.gcov
+- spec/gcovtools/file_spec.rb
+- spec/gcovtools/line_spec.rb
+- spec/gcovtools/project_spec.rb
+- spec/spec_helper.rb
+- src/Makefile
+- src/test.cpp
+- src/test.h
+- src/test1.cpp
+- src/test2.cpp
+- src/test3.cpp
+- tasks/rubygems.rake
+- tasks/spec.rake
+homepage: http://rubygems.org/gems/gcovtools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: gcov parser and formatter
+test_files: []