slather 1.7.1 → 1.8

data/spec/slather/coverage_service/coveralls_spec.rb

@@ -44,7 +44,7 @@ describe Slather::CoverageService::Coveralls do
 
       it "should return valid json for coveralls coverage data" do
         fixtures_project.stub(:travis_job_id).and_return("9182")
-        fixtures_project.stub(:ci_access_token).and_return("abc123")
+        fixtures_project.stub(:coverage_access_token).and_return("abc123")
         expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"travis-pro\",\"repo_token\":\"abc123\"}").excluding("source_files")
         expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.send(:coverage_files).map(&:as_json).to_json).at_path("source_files")
       end
@@ -54,25 +54,44 @@ describe Slather::CoverageService::Coveralls do
         expect { fixtures_project.send(:coveralls_coverage_data) }.to raise_error(StandardError)
       end
     end
-    
+
     context "coverage_service is :circleci" do
       before(:each) { fixtures_project.ci_service = :circleci }
-    
+
       it "should return valid json for coveralls coverage data" do
         fixtures_project.stub(:circleci_job_id).and_return("9182")
-        fixtures_project.stub(:ci_access_token).and_return("abc123")
+        fixtures_project.stub(:coverage_access_token).and_return("abc123")
         fixtures_project.stub(:circleci_pull_request).and_return("1")
+        fixtures_project.stub(:circleci_build_url).and_return("https://circleci.com/gh/Bruce/Wayne/1")
         fixtures_project.stub(:circleci_git_info).and_return({ :head => { :id => "ababa123", :author_name => "bwayne", :message => "hello" }, :branch => "master" })
-        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"circleci\",\"repo_token\":\"abc123\",\"service_pull_request\":\"1\",\"git\":{\"head\":{\"id\":\"ababa123\",\"author_name\":\"bwayne\",\"message\":\"hello\"},\"branch\":\"master\"}}").excluding("source_files")
+        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"circleci\",\"repo_token\":\"abc123\",\"service_pull_request\":\"1\",\"service_build_url\":\"https://circleci.com/gh/Bruce/Wayne/1\",\"git\":{\"head\":{\"id\":\"ababa123\",\"author_name\":\"bwayne\",\"message\":\"hello\"},\"branch\":\"master\"}}").excluding("source_files")
         expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.send(:coverage_files).map(&:as_json).to_json).at_path("source_files")
       end
-    
+
       it "should raise an error if there is no CIRCLE_BUILD_NUM" do
         fixtures_project.stub(:circleci_job_id).and_return(nil)
         expect { fixtures_project.send(:coveralls_coverage_data) }.to raise_error(StandardError)
       end
     end
 
+    context "coverage_service is :jenkins" do
+      before(:each) { fixtures_project.ci_service = :jenkins }
+
+      it "should return valid json for coveralls coverage data" do
+        fixtures_project.stub(:jenkins_job_id).and_return("9182")
+        fixtures_project.stub(:coverage_access_token).and_return("abc123")
+        fixtures_project.stub(:jenkins_git_info).and_return({head: {id: "master", author_name: "author", message: "pull title" }, branch: "branch"})
+        fixtures_project.stub(:jenkins_branch_name).and_return('master')
+        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql("{\"service_job_id\":\"9182\",\"service_name\":\"jenkins\",\"repo_token\":\"abc123\",\"git\":{\"head\":{\"id\":\"master\",\"author_name\":\"author\",\"message\":\"pull title\"},\"branch\":\"branch\"}}").excluding("source_files")
+        expect(fixtures_project.send(:coveralls_coverage_data)).to be_json_eql(fixtures_project.send(:coverage_files).map(&:as_json).to_json).at_path("source_files")
+      end
+
+      it "should raise an error if there is no BUILD_ID" do
+        fixtures_project.stub(:jenkins_job_id).and_return(nil)
+        expect { fixtures_project.send(:coveralls_coverage_data) }.to raise_error(StandardError)
+      end
+    end
+
     it "should raise an error if it does not recognize the ci_service" do
       fixtures_project.ci_service = :jenkins_ci
       expect { fixtures_project.send(:coveralls_coverage_data) }.to raise_error(StandardError)

data/spec/slather/coverage_service/hardcover_spec.rb

@@ -0,0 +1,87 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Slather::CoverageService::Hardcover do
+
+  let(:fixtures_project) do
+    proj = Slather::Project.open(FIXTURES_PROJECT_PATH)
+    proj.extend(Slather::CoverageService::Hardcover)
+  end
+
+  let(:fixture_yaml) do
+      yaml_text = <<-EOF
+        hardcover_repo_token: "27dd855e706b22126ec6daaaf7bb40b5"
+        hardcover_base_url: "http://api.hardcover.io"
+      EOF
+      yaml = YAML.load(yaml_text)
+  end
+
+  describe "#coverage_file_class" do
+    it "should return CoverallsCoverageFile" do
+      expect(fixtures_project.send(:coverage_file_class)).to eq(Slather::CoverallsCoverageFile)
+    end
+  end
+
+  describe "#job_id" do
+    it "should return the Jenkins JOB_NAME and BUILD_NUMBER environment variables" do
+      ENV['BUILD_NUMBER'] = "9182"
+      ENV['JOB_NAME'] = "slather-master"
+      expect(fixtures_project.send(:jenkins_job_id)).to eq("slather-master/9182")
+    end
+  end
+
+  describe '#hardcover_coverage_data' do
+
+    context "coverage_service is :jenkins_ci" do
+      before(:each) do
+        fixtures_project.ci_service = :jenkins_ci
+        Slather::Project.stub(:yml).and_return(fixture_yaml)
+      end
+
+      it "should return a valid json" do
+        json = JSON(fixtures_project.send(:hardcover_coverage_data))
+        expect(json["service_job_id"]).to eq("slather-master/9182")
+        expect(json["service_name"]).to eq("jenkins-ci")
+        expect(json["repo_token"]).to eq("27dd855e706b22126ec6daaaf7bb40b5")
+        expect(json["source_files"]).to_not be_empty
+      end
+
+      it "should raise an error if there is no BUILD_NUMBER or JOB_NAME" do
+        fixtures_project.stub(:jenkins_job_id).and_return(nil)
+        expect { fixtures_project.send(:hardcover_coverage_data) }.to raise_error(StandardError)
+      end
+    end
+
+    it "should raise an error if it does not recognize the ci_service" do
+      fixtures_project.ci_service = :non_existing_ci
+      expect { fixtures_project.send(:hardcover_coverage_data) }.to raise_error(StandardError)
+    end
+  end
+
+  describe '#post' do
+    before(:each) do
+      Slather::Project.stub(:yml).and_return(fixture_yaml)
+      fixtures_project.ci_service = :jenkins_ci
+    end
+
+    it "should save the hardcover_coverage_data to a file and post it to hardcover" do
+      fixtures_project.stub(:jenkins_job_id).and_return("slather-master/9182")
+      fixtures_project.stub(:coverage_service_url).and_return("http://api.hardcover.io")
+      expect(fixtures_project).to receive(:`) do |cmd|
+        expect(cmd).to eq("curl --form json_file=@hardcover_json_file http://api.hardcover.io/v1/jobs")
+      end.once
+      fixtures_project.post
+    end
+
+    it "should always remove the hardcover_json_file after it's done" do
+      fixtures_project.stub(:`)
+
+      fixtures_project.stub(:jenkins_job_id).and_return("slather-master/9182")
+      fixtures_project.stub(:coverage_service_url).and_return("http://api.hardcover.io")
+      fixtures_project.post
+      expect(File.exist?("hardcover_json_file")).to be_falsy
+      fixtures_project.stub(:jenkins_job_id).and_return(nil)
+      expect { fixtures_project.post }.to raise_error
+      expect(File.exist?("hardcover_json_file")).to be_falsy
+    end
+  end
+end

data/spec/slather/coverage_service/html_output_spec.rb

@@ -0,0 +1,179 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+require 'nokogiri'
+
+describe Slather::CoverageService::HtmlOutput do
+
+  OUTPUT_DIR_PATH = "html"
+
+  let(:fixture_html_files) do
+    ["index",
+    "fixtures.m",
+    "peekaview.m",
+    "fixtures_cpp.cpp",
+    "fixtures_mm.mm",
+    "fixtures_m.m",
+    "Branches.m",
+    "Empty.m",
+    "fixturesTests.m",
+    "peekaviewTests.m",
+    "BranchesTests.m"].map { |file| "#{file}.html"}
+  end
+
+  let(:fixtures_project) do
+    proj = Slather::Project.open(FIXTURES_PROJECT_PATH)
+    proj.extend(Slather::CoverageService::HtmlOutput)
+  end
+
+  describe '#coverage_file_class' do
+    it "should return CoverageFile" do
+      expect(fixtures_project.send(:coverage_file_class)).to eq(Slather::CoverageFile)
+    end
+  end
+
+  describe '#post' do
+    before(:each) {
+      fixtures_project.stub(:print_path_coverage)
+    }
+
+    after(:each) {
+      FileUtils.rm_rf(OUTPUT_DIR_PATH) if Dir.exist?(OUTPUT_DIR_PATH)
+    }
+
+    def extract_header_title(doc)
+      doc.at_css('title').text
+    end
+
+    it "should create all coverage as static html files" do
+      fixtures_project.post
+
+      fixture_html_files.map { |filename|
+        File.join(OUTPUT_DIR_PATH, filename)
+      }.each { |filepath|
+        expect(File.exist?(filepath)).to be_truthy
+      }
+    end
+
+    it "should print out the path of the html folder by default" do
+      fixtures_project.post
+
+      expect(fixtures_project).to have_received(:print_path_coverage).with("html/index.html")
+    end
+
+    it "should open the index.html automatically if --show is flagged" do
+      fixtures_project.stub(:open_coverage)
+
+      fixtures_project.show_html = true
+      fixtures_project.post
+
+      expect(fixtures_project).to have_received(:open_coverage).with("html/index.html")
+    end
+
+    it "should create index html with correct coverage information" do
+      def extract_title(doc)
+        doc.at_css('#reports > h2').text
+      end
+
+      def extract_coverage_text(doc)
+        doc.at_css('#total_coverage').text
+      end
+
+      def extract_coverage_class(doc)
+        doc.at_css('#total_coverage').attribute("class").to_s
+      end
+
+      def extract_cov_header(doc)
+        doc.css("table.coverage_list > thead > tr > th").map { |header|
+          [header.text, header.attribute("data-sort")].join(", ")
+        }.join("; ")
+      end
+
+      def extract_cov_index(doc)
+        coverages = doc.css("table.coverage_list > tbody > tr").map { |tr|
+          tr.css("td").map { |td|
+            if td.attribute("class")
+              td.attribute("class").to_s.split.join(", ") + ", #{td.text}"
+            elsif span = td.at_css("span")
+              span.attribute("class").to_s.split.join(", ")  + ", #{td.text}"
+            else
+              td.text
+            end
+          }.join("; ")
+        }
+
+        list = doc.css("table.coverage_list > tbody").attribute("class")
+        coverages.append(list.to_s)
+      end
+
+      fixtures_project.post
+
+      file = File.open(File.join(FIXTURES_HTML_FOLDER_PATH, "index.html"))
+      fixture_doc = Nokogiri::HTML(file)
+      file.close
+
+      file = File.open(File.join(OUTPUT_DIR_PATH, "index.html"))
+      current_doc = Nokogiri::HTML(file)
+      file.close
+
+      expect(extract_header_title(current_doc)).to eq(extract_header_title(fixture_doc))
+      expect(extract_title(current_doc)).to eq(extract_title(fixture_doc))
+      expect(extract_coverage_text(current_doc)).to eq(extract_coverage_text(fixture_doc))
+      expect(extract_coverage_class(current_doc)).to eq(extract_coverage_class(fixture_doc))
+      expect(extract_cov_header(current_doc)).to eq(extract_cov_header(fixture_doc))
+      expect(extract_cov_index(current_doc)).to eq(extract_cov_index(fixture_doc))
+    end
+
+    it "should create html coverage for each file with correct coverage" do
+      def extract_title(doc)
+        doc.css('#coverage > h2 > span').map{ |x| x.text.strip }.join(", ")
+      end
+
+      def extract_subtitle(doc)
+        (sub = doc.at_css('h4.cov_subtitle')) ? sub.text : ""
+      end
+
+      def extract_filepath(doc)
+        (path = doc.at_css('h4.cov_filepath'))? path.text : ""
+      end
+
+      def extract_cov_data(doc)
+        doc.css("table.source_code > tr").map { |tr|
+          ([tr.attribute("class")] + tr.css('td').map(&:text)).join(",")
+        }
+      end
+
+      fixtures_project.post
+
+      fixture_html_files.each { |filename|
+        file = File.open(File.join(FIXTURES_HTML_FOLDER_PATH, filename))
+        fixture_doc = Nokogiri::HTML(file)
+        file.close
+
+        file = File.open(File.join(OUTPUT_DIR_PATH, filename))
+        current_doc = Nokogiri::HTML(file)
+        file.close
+
+        expect(extract_title(fixture_doc)).to eq(extract_title(current_doc))
+        expect(extract_subtitle(fixture_doc)).to eq(extract_subtitle(current_doc))
+        expect(extract_filepath(fixture_doc)).to eq(extract_filepath(current_doc))
+        expect(extract_cov_data(fixture_doc)).to eq(extract_cov_data(current_doc))
+      }
+    end
+
+    it "should create an HTML report directory in the given output directory" do
+      fixtures_project.output_directory = "./output"
+      fixtures_project.post
+
+      expect(Dir.exist?(fixtures_project.output_directory)).to be_truthy
+
+      FileUtils.rm_rf(fixtures_project.output_directory) if Dir.exist?(fixtures_project.output_directory)
+    end
+
+    it "should create the default directory (html) if output directory is faulty" do
+      fixtures_project.output_directory = "  "
+      fixtures_project.post
+
+      expect(Dir.exist?(OUTPUT_DIR_PATH)).to be_truthy
+    end
+
+  end
+end

data/spec/slather/project_spec.rb

@@ -243,12 +243,19 @@ describe Slather::Project do
     end
   end
 
-  describe "#configure_ci_access_token_from_yml" do
-    it "should set the ci_access_token if it has been provided by the yml" do
-      Slather::Project.stub(:yml).and_return({"ci_access_token" => "abc123"})
-      expect(fixtures_project).to receive(:ci_access_token=).with("abc123")
-      fixtures_project.configure_ci_access_token_from_yml
-    end
+  describe "#configure_coverage_access_token" do
+    it "should set the coverage_access_token if it has been provided by the yml" do
+      Slather::Project.stub(:yml).and_return({"coverage_access_token" => "abc123"})
+      expect(fixtures_project).to receive(:coverage_access_token=).with("abc123")
+      fixtures_project.configure_coverage_access_token_from_yml
+    end
+    
+    it "should set the coverage_access_token if it is in the ENV" do
+      stub_const('ENV', ENV.to_hash.merge('COVERAGE_ACCESS_TOKEN' => 'asdf456'))
+      expect(fixtures_project).to receive(:coverage_access_token=).with("asdf456")
+      fixtures_project.configure_coverage_access_token_from_yml
+    end
+    
   end
 
   describe "#coverage_service=" do

data/spec/spec_helper.rb

@@ -9,11 +9,12 @@ require 'equivalent-xml'
 
 FIXTURES_XML_PATH = File.join(File.dirname(__FILE__), 'fixtures/cobertura.xml')
 FIXTURES_JSON_PATH = File.join(File.dirname(__FILE__), 'fixtures/gutter.json')
+FIXTURES_HTML_FOLDER_PATH = File.join(File.dirname(__FILE__), 'fixtures/fixtures_html')
 FIXTURES_PROJECT_PATH = File.join(File.dirname(__FILE__), 'fixtures/fixtures.xcodeproj')
 
 RSpec.configure do |config|
   config.before(:suite) do
-    `xcodebuild -project #{FIXTURES_PROJECT_PATH} -scheme fixtures -configuration Debug test`
+    `xcodebuild -project "#{FIXTURES_PROJECT_PATH}" -scheme fixtures -configuration Debug test`
   end
 
   config.after(:suite) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slather
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: '1.8'
 platform: ruby
 authors:
 - Mark Larsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,6 +180,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/highlight.pack.js
+- assets/list.min.js
+- assets/slather.css
 - bin/slather
 - docs/logo.jpg
 - lib/cocoapods_plugin.rb
@@ -188,6 +191,8 @@ files:
 - lib/slather/coverage_service/cobertura_xml_output.rb
 - lib/slather/coverage_service/coveralls.rb
 - lib/slather/coverage_service/gutter_json_output.rb
+- lib/slather/coverage_service/hardcover.rb
+- lib/slather/coverage_service/html_output.rb
 - lib/slather/coverage_service/simple_output.rb
 - lib/slather/coveralls_coverage_file.rb
 - lib/slather/project.rb
@@ -217,12 +222,25 @@ files:
 - spec/fixtures/fixturesTests/Supporting Files/fixturesTests-Info.plist
 - spec/fixtures/fixturesTests/fixturesTests.m
 - spec/fixtures/fixturesTests/peekaviewTests.m
+- spec/fixtures/fixtures_html/Branches.m.html
+- spec/fixtures/fixtures_html/BranchesTests.m.html
+- spec/fixtures/fixtures_html/Empty.m.html
+- spec/fixtures/fixtures_html/fixtures.m.html
+- spec/fixtures/fixtures_html/fixturesTests.m.html
+- spec/fixtures/fixtures_html/fixtures_cpp.cpp.html
+- spec/fixtures/fixtures_html/fixtures_m.m.html
+- spec/fixtures/fixtures_html/fixtures_mm.mm.html
+- spec/fixtures/fixtures_html/index.html
+- spec/fixtures/fixtures_html/peekaview.m.html
+- spec/fixtures/fixtures_html/peekaviewTests.m.html
 - spec/fixtures/gutter.json
 - spec/slather/cocoapods_plugin_spec.rb
 - spec/slather/coverage_file_spec.rb
 - spec/slather/coverage_service/cobertura_xml_spec.rb
 - spec/slather/coverage_service/coveralls_spec.rb
 - spec/slather/coverage_service/gutter_json_spec.rb
+- spec/slather/coverage_service/hardcover_spec.rb
+- spec/slather/coverage_service/html_output_spec.rb
 - spec/slather/coverage_service/simple_output_spec.rb
 - spec/slather/fixtures.gcno
 - spec/slather/project_spec.rb
@@ -276,12 +294,25 @@ test_files:
 - spec/fixtures/fixturesTests/Supporting Files/fixturesTests-Info.plist
 - spec/fixtures/fixturesTests/fixturesTests.m
 - spec/fixtures/fixturesTests/peekaviewTests.m
+- spec/fixtures/fixtures_html/Branches.m.html
+- spec/fixtures/fixtures_html/BranchesTests.m.html
+- spec/fixtures/fixtures_html/Empty.m.html
+- spec/fixtures/fixtures_html/fixtures.m.html
+- spec/fixtures/fixtures_html/fixturesTests.m.html
+- spec/fixtures/fixtures_html/fixtures_cpp.cpp.html
+- spec/fixtures/fixtures_html/fixtures_m.m.html
+- spec/fixtures/fixtures_html/fixtures_mm.mm.html
+- spec/fixtures/fixtures_html/index.html
+- spec/fixtures/fixtures_html/peekaview.m.html
+- spec/fixtures/fixtures_html/peekaviewTests.m.html
 - spec/fixtures/gutter.json
 - spec/slather/cocoapods_plugin_spec.rb
 - spec/slather/coverage_file_spec.rb
 - spec/slather/coverage_service/cobertura_xml_spec.rb
 - spec/slather/coverage_service/coveralls_spec.rb
 - spec/slather/coverage_service/gutter_json_spec.rb
+- spec/slather/coverage_service/hardcover_spec.rb
+- spec/slather/coverage_service/html_output_spec.rb
 - spec/slather/coverage_service/simple_output_spec.rb
 - spec/slather/fixtures.gcno
 - spec/slather/project_spec.rb