slather 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 650160f33d5e86eca751efa9a24c33a532ee9b88651dd7e854537b8cd513badb
-  data.tar.gz: cc54b5a1c8f6702bcc16e21cd4aa013d138d6c03df1f3d66993d5df7acf0dfd1
+  metadata.gz: eeaf99ed5212bdc90e8098dfde877452af7f074ecfd41fc577d46f90b1ee65eb
+  data.tar.gz: 5dbd0db5223f26990c2bfd3ab02f4ed36a15d8088a0b5c393f522a785a0176cd
 SHA512:
-  metadata.gz: 29bc765b62d0bd6e61719d8f27c18d0ab4e071eeada2cfb784f3d7877d13ec1477579b0271c1042e34d02f3e68788cd6d057c55abb17082c6c82d63cba4008e3
-  data.tar.gz: 92bad0129f231ebda10ab8ab87d6339bcde04655cdc8b2e9c4d7455277436d00d1739f465c211c408971a8e811d6534183f74a4b3255d910fb099073471ebea1
+  metadata.gz: 6802b4ef28cfb856bf68d214416d6a455de715723327dc7167600bc9cae705dacbdbffb0b8d154b2027dde6d5b2f6baec719f69a81e5293a437da1e260461e73
+  data.tar.gz: c6b95c762eaa1d5260da5de5910e7f429a79e45556a3b32568ba8c7c9f3ed173ed514330793c39babc767e4f021dda7fc83971750d16407d0149050286495b95

data/.travis.yml

@@ -1,10 +1,10 @@
 language: objective-c
 script: bundle exec rake
-osx_image: xcode9.2
+osx_image: xcode12.2
 
 before_install:
   - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
-  - gem install bundler -v "~> 1.0" --no-ri --no-rdoc
+  - gem install bundler -v "~> 2.0" --no-document
 
 install:
   - bundle install --without=documentation

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v2.6.0
+
+* Added GitHub actions support
+  [martin-key](https://github.com/martin-key), [troyfontaine](https://github.com/troyfontaine)
+  [#468](https://github.com/SlatherOrg/slather/pull/468)
+
 ## v2.5.0
 
 * Fixed activesupport and cocoapods dependencies

data/README.md

@@ -149,7 +149,7 @@ ignore:
   - ProjectTestsGroup/*
 ```
 
-And then in your `.travis.yml` or `circle.yml`, call `slather` after a successful build:
+And then in your `.travis.yml` or `circle.yml` or `github-action.yml`, call `slather` after a successful build:
 
 ```yml
 # .travis.yml
@@ -168,6 +168,25 @@ test:
 
 ```
 
+```yml
+# github-action.yml
+  myjob:
+    steps:
+      - run: |
+          bundle config path vendor/bundle
+          bundle install --without=documentation --jobs 4 --retry 3
+      - name: Extract branch name
+        shell: bash
+        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+        id: get_branch
+      - run: bundle exec slather
+        env:
+          GIT_BRANCH: ${{ steps.get_branch.outputs.branch }}
+          CI_PULL_REQUEST: ${{ github.event.number }}
+          COVERAGE_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+```
+
 #### Usage with Travis CI Pro
 
 To use Coveralls with Travis CI Pro (for private repos), add following lines along with other settings to `.slather.yml`:
@@ -265,3 +284,4 @@ Please make sure to follow our general coding style and add test coverage for ne
 * [@jhersh](https://github.com/jhersh), CircleCI support.
 * [@tarbrain](https://github.com/tarbrain), Cobertura support and bugfixing.
 * [@ikhsan](https://github.com/ikhsan), html support.
+* [@martin-key](https://github.com/martin-key) and [@troyfontaine](https://github.com/troyfontaine), Github Actions support.

data/lib/slather/command/coverage_command.rb

@@ -8,6 +8,7 @@ class CoverageCommand < Clamp::Command
   option ["--jenkins"], :flag, "Indicate that the builds are running on Jenkins"
   option ["--buildkite"], :flag, "Indicate that the builds are running on Buildkite"
   option ["--teamcity"], :flag, "Indicate that the builds are running on TeamCity"
+  option ["--github"], :flag, "Indicate that the builds are running on Github Actions"
 
   option ["--coveralls", "-c"], :flag, "Post coverage results to coveralls"
   option ["--simple-output", "-s"], :flag, "Output coverage results to the terminal"
@@ -91,6 +92,8 @@ class CoverageCommand < Clamp::Command
       project.ci_service = :buildkite
     elsif teamcity?
       project.ci_service = :teamcity
+    elsif github?
+      project.ci_service = :github
     end
   end
 

data/lib/slather/coverage_file.rb

@@ -43,18 +43,23 @@ module Slather
 
     def gcov_data
       @gcov_data ||= begin
-        gcov_output = `gcov "#{source_file_pathname}" --object-directory "#{gcno_file_pathname.parent}" --branch-probabilities --branch-counts`
-        # Sometimes gcov makes gcov files for Cocoa Touch classes, like NSRange. Ignore and delete later.
-        gcov_files_created = gcov_output.scan(/creating '(.+\..+\.gcov)'/)
+        gcov_data = ""
+
+        Dir.chdir(project.project_dir) do
+          gcov_output = `gcov "#{source_file_pathname}" --object-directory "#{gcno_file_pathname.parent}" --branch-probabilities --branch-counts`
+          # Sometimes gcov makes gcov files for Cocoa Touch classes, like NSRange. Ignore and delete later.
+          gcov_files_created = gcov_output.scan(/creating '(.+\..+\.gcov)'/)
+
+          gcov_file_name = "./#{source_file_pathname.basename}.gcov"
+          if File.exists?(gcov_file_name)
+            gcov_data = File.new(gcov_file_name).read
+          else
+            gcov_data = ""
+          end
 
-        gcov_file_name = "./#{source_file_pathname.basename}.gcov"
-        if File.exists?(gcov_file_name)
-          gcov_data = File.new(gcov_file_name).read
-        else
-          gcov_data = ""
+          gcov_files_created.each { |file| FileUtils.rm_f(file) }
         end
 
-        gcov_files_created.each { |file| FileUtils.rm_f(file) }
         gcov_data
       end
     end

data/lib/slather/coverage_service/coveralls.rb

@@ -36,6 +36,21 @@ module Slather
       end
       private :jenkins_job_id
 
+      def github_job_id
+        ENV['GITHUB_RUN_ID']
+      end
+      private :github_job_id
+
+      def github_pull_request
+        ENV['CI_PULL_REQUEST'] || ""
+      end
+      private :github_pull_request
+
+      def github_repo_name
+        ENV['GITHUB_REPOSITORY'] || ""
+      end
+      private :github_repo_name
+
       def jenkins_branch_name
         branch_name = ENV['GIT_BRANCH'] || ENV['BRANCH_NAME']
         if branch_name.include? 'origin/'
@@ -51,6 +66,11 @@ module Slather
       end
       private :teamcity_branch_name
 
+      def github_branch_name
+        ENV['GIT_BRANCH'] || `git ls-remote --heads origin | grep $(git rev-parse HEAD) | cut -d / -f 3-`.chomp
+      end
+      private :github_branch_name
+
       def buildkite_job_id
         ENV['BUILDKITE_BUILD_NUMBER']
       end
@@ -119,6 +139,23 @@ module Slather
         "https://buildkite.com/" + ENV['BUILDKITE_PROJECT_SLUG'] + "/builds/" + ENV['BUILDKITE_BUILD_NUMBER'] + "#"
       end
 
+      def github_git_info
+        {
+          :head => {
+            :id => ENV['GITHUB_SHA'],
+            :author_name => ENV['GITHUB_ACTOR'],
+            :message => (`git log --format=%s -n 1 HEAD`.chomp || "")
+          },
+          :branch => github_branch_name
+        }
+      end
+      private :github_git_info
+
+      def github_build_url
+        "https://github.com/" + ENV['GITHUB_REPOSITORY'] + "/actions/runs/" + ENV['GITHUB_RUN_ID']
+      end
+      private :github_build_url
+
       def coveralls_coverage_data
         if ci_service == :travis_ci || ci_service == :travis_pro
           if travis_job_id
@@ -206,6 +243,26 @@ module Slather
           else
             raise StandardError, "Environment variable `TC_BUILD_NUMBER` not set. Is this running on a teamcity build?"
           end
+        elsif ci_service == :github
+
+          if coverage_access_token.to_s.strip.length == 0
+            raise StandardError, "Access token is not set. Uploading coverage data for private repositories requires an access token."
+          end
+
+          if github_job_id
+            {
+              :service_job_id => github_job_id,
+              :service_name => "github",
+              :repo_token => coverage_access_token,
+              :repo_name => github_repo_name,
+              :source_files => coverage_files.map(&:as_json),
+              :service_build_url => github_build_url,
+              :service_pull_request => github_pull_request,
+              :git => github_git_info
+            }.to_json
+          else
+            raise StandardError, "Environment variable `GITHUB_RUN_ID` not set.  Is this running on github build?"
+          end
         else
           raise StandardError, "No support for ci named #{ci_service}"
         end

data/lib/slather/version.rb

@@ -1,3 +1,3 @@
 module Slather
-  VERSION = '2.5.0' unless defined?(Slather::VERSION)
+  VERSION = '2.6.0' unless defined?(Slather::VERSION)
 end

data/slather.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'simplecov', '~> 0'
   spec.add_development_dependency 'rake', '~> 12.3'

data/spec/slather/coverage_service/coveralls_spec.rb

@@ -151,6 +151,26 @@ describe Slather::CoverageService::Coveralls do
         ENV['GIT_BRANCH'] = git_branch
       end
     end
+
+    context "coverage_service is :github" do
+      before(:each) { fixtures_project.ci_service = :github }
+
+      it "should return valid json for coveralls coverage data" do
+        allow(fixtures_project).to receive(:github_job_id).and_return("9182")
+        allow(fixtures_project).to receive(:coverage_access_token).and_return("abc123")
+        allow(fixtures_project).to receive(:github_pull_request).and_return("1")
+        allow(fixtures_project).to receive(:github_build_url).and_return("https://github.com/Bruce/Wayne/actions/runs/1")
+        allow(fixtures_project).to receive(:github_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\":\"github\",\"repo_name\":\"\",\"repo_token\":\"abc123\",\"service_pull_request\":\"1\",\"service_build_url\":\"https://github.com/Bruce/Wayne/actions/runs/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.coverage_files.map(&:as_json).to_json).at_path("source_files")
+      end
+
+      it "should raise an error if there is no GITHUB_RUN_ID" do
+        allow(fixtures_project).to receive(:github_job_id).and_return(nil)
+        expect { fixtures_project.send(:coveralls_coverage_data) }.to raise_error(StandardError)
+      end
+    end
+
   end
 
   describe '#coveralls_coverage_data' do

data/spec/slather/project_spec.rb

@@ -653,8 +653,8 @@ describe Slather::Project do
     it "should find relevant source files" do
       source_files = fixtures_project.find_source_files
       expect(source_files.count).to eq(2)
-      expect(source_files.first.to_s).to include("fixtures.m")
-      expect(source_files.last.to_s).to include("fixturesTwo.m")
+      expect(source_files.first.to_s).to include("fixturesTwo.m")
+      expect(source_files.last.to_s).to include("fixtures.m")
     end
 
     it "should print out the coverage for each file, and then total coverage" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slather
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Mark Larsen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement