coveralls-multi 1.3.2 → 1.4.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5576080e0e7d7a58994aaf0d9940b330eadf6302259d21362e95c82028a31e
-  data.tar.gz: de58bfaa0be98e33c48372fadac5014cf42566ddadeee9b6f39fb268c764e176
+  metadata.gz: 7ec07bebf8b0ad6cef3922fec3a21ae8da2ef333c2f1d6f350ae46ef7f3faf91
+  data.tar.gz: 8085c40de3074639088bcd9564cd52608b0d2fa007aebf213fc1b52eda9f99b7
 SHA512:
-  metadata.gz: a1cbf567889f1ae27bebd55cb5a384ca0352349272f8194961c8556895210d954c051e78df8ec84987c07456c719317a25f92eccba298d68388e6310ea92b7c8
-  data.tar.gz: 53548591c5096f87634f4839499c393117799ff99b7f26eefec8ca0b6e0cf0b77dcfc12b66d1916bfa3b39d0d1080811e891796b2d81ff1bad94f39f0db3c74d
+  metadata.gz: f4db280913be97c2d7d9345522d002d9706803694d816a69227118581a798c701eaf7d9a41130f8b1b4ac7e217c2ec7bf312a6407b353b1669424a3b85fa507a
+  data.tar.gz: a486d86bde16deb33033950b54f7765413853d89b2a8baa862ec4dfd8a4a7a11ab22d33ac198cbb58ad7e3da74a4ec2c16be9d449b23f3db07e1aa096798027a

data/.travis.yml

@@ -12,4 +12,4 @@ deploy:
   on:
     tags: true
     repo: radditude/coveralls-multi
-    branch: master
+    branch: main

data/README.md

@@ -1,5 +1,3 @@
-
-
 [![coveralls-multi](https://img.shields.io/gem/v/coveralls-multi.svg)](https://rubygems.org/gems/coveralls-multi) [![Travis](https://img.shields.io/travis/radditude/coveralls-multi/master.svg)](https://travis-ci.org/radditude/coveralls-multi) [![Coverage Status](https://coveralls.io/repos/github/radditude/coveralls-multi/badge.svg)](https://coveralls.io/github/radditude/coveralls-multi)
 
 # CoverallsMulti
@@ -10,11 +8,11 @@ CoverallsMulti is a Coveralls client with support for multi-language repos. Once
 
 #### Languages & Output Formats
 
-| *Language* | *Coverage tool* | *Config key* |
-|----------- | --------------- | ------------ |
-| Elixir | [ExCoveralls](https://github.com/parroty/excoveralls) (JSON output) | `excoveralls` |
-| JavaScript | [nyc](https://github.com/istanbuljs/nyc), or any tool that can output an lcov file | `lcov` |
-| Ruby | [SimpleCov](https://github.com/colszowka/simplecov) | `simplecov` |
+| _Language_ | _Coverage tool_                                                                    | _Config key_  |
+| ---------- | ---------------------------------------------------------------------------------- | ------------- |
+| Elixir     | [ExCoveralls](https://github.com/parroty/excoveralls) (JSON output)                | `excoveralls` |
+| JavaScript | [nyc](https://github.com/istanbuljs/nyc), or any tool that can output an lcov file | `lcov`        |
+| Ruby       | [SimpleCov](https://github.com/colszowka/simplecov)                                | `simplecov`   |
 
 #### CI Providers
 
@@ -22,7 +20,7 @@ CoverallsMulti is a Coveralls client with support for multi-language repos. Once
 
 #### Coming Soon
 
-Have another language, tool, or CI provider you'd like to see supported? [Let me know](https://github.com/radditude/coveralls-multi/issues/new).
+Have another language, tool, or CI provider you'd like to see supported? [File an issue](https://github.com/radditude/coveralls-multi/issues/new).
 
 ## Installation
 

data/coveralls-multi.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Coveralls client for multi-language repos.'
   spec.description   = 'A configurable Coveralls client that supports merging coverage from multiple languages & test suites.'
-  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.homepage      = 'https://github.com/radditude/coveralls-multi'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -20,12 +20,14 @@ Gem::Specification.new do |spec|
   spec.executables   = 'coveralls-multi'
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'coveralls-revelry', '~> 0.8.23'
   spec.add_dependency 'coveralls-lcov', '~> 1.5.1'
+  spec.add_dependency 'httparty', '~> 0.16.4'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls', '~> 0.8.22'
   spec.add_development_dependency 'pry', '~> 0.11.3'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.add_development_dependency 'webmock', '~> 3.5.1'
 end

data/lib/coveralls-multi.rb

@@ -1,3 +1,4 @@
+require 'coveralls-multi/api'
 require 'coveralls-multi/config'
 require 'coveralls-multi/formatter'
 require 'coveralls-multi/runner'

data/lib/coveralls-multi/api.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'httparty'
+require 'tempfile'
+
+module CoverallsMulti
+  # handles the post request to the Coveralls API
+  class API
+    class << self
+      def post_json(hash)
+        url = CoverallsMulti::Config.api_endpoint
+        puts "[CoverallsMulti] Submitting to #{url}"
+
+        response = HTTParty.post(
+          url,
+          body: {
+            json_file: json_file(hash),
+          },
+        )
+
+        puts "[CoverallsMulti] #{response['message']}" if response['message']
+        puts "[CoverallsMulti] #{response['url']}" if response['url']
+        puts "[CoverallsMulti] Error: #{response['error']}" if response['error']
+
+        response
+      end
+
+      def json_file(hash)
+        hash = add_api_config(hash)
+        write_to_file(hash)
+        file = nil
+
+        Tempfile.open(['coveralls-upload', 'json']) do |f|
+          f.write(hash.to_json)
+          file = f
+        end
+
+        File.new(file.path, 'rb')
+      end
+
+      def write_to_file(hash)
+        return unless CoverallsMulti::Config.debug_mode
+
+        output_file_path = "#{CoverallsMulti::Config.root}/coveralls.json"
+        puts "[CoverallsMulti] Debug mode on - writing results to #{output_file_path}"
+        File.write(output_file_path, JSON.pretty_generate(hash))
+      end
+
+      def add_api_config(hash)
+        config = CoverallsMulti::Config.api_config
+
+        if CoverallsMulti::Config.debug_mode
+          puts '[CoverallsMulti] Submitting with config:'
+          output = JSON.pretty_generate(config).gsub(/"repo_token": ?"(.*?)"/, '"repo_token": "[secure]"')
+          puts output
+        end
+
+        hash.merge(config)
+      end
+    end
+  end
+end

data/lib/coveralls-multi/config.rb

@@ -4,22 +4,22 @@ module CoverallsMulti
   # reads .coveralls.yml and sets module config options
   class Config
     class << self
+      def yaml_config
+        raise "[CoverallsMulti] Couldn't find config file" unless configuration_path && File.exist?(configuration_path)
+
+        YAML.load_file(configuration_path)
+      end
+
       def files
         yml = yaml_config['multi']
 
-        raise "Couldn't find coveralls-multi configuration in .coveralls.yml" unless yml
+        raise "[CoverallsMulti] Couldn't find multi configuration in .coveralls.yml" unless yml
 
         yml
       end
 
       def debug_mode
-        yaml_config['debug_mode'] && yaml_config['debug_mode'] == true
-      end
-
-      def yaml_config
-        raise "Couldn't find config file" unless configuration_path && File.exist?(configuration_path)
-
-        YAML.load_file(configuration_path)
+        yaml_config['debug_mode'] || ENV['COVERALLS_DEBUG']
       end
 
       def root
@@ -29,6 +29,148 @@ module CoverallsMulti
       def configuration_path
         File.expand_path(File.join(root, '.coveralls.yml')) if root
       end
+
+      def api_domain
+        ENV['COVERALLS_ENDPOINT'] || 'https://coveralls.io'
+      end
+
+      def api_endpoint
+        "#{api_domain}/api/v1/jobs"
+      end
+
+      def api_config
+        config = {
+          git: git_info,
+          repo_token: ENV['COVERALLS_REPO_TOKEN'] || yaml_config['repo_token'] || yaml_config['repo_secret_token'],
+        }
+
+        add_ci_env(config)
+        add_standard_service_params_for_generic_ci(config)
+        config
+      end
+
+      def git_info
+        Dir.chdir(root) do
+          {
+            head: git_head,
+            branch: git_branch,
+            remotes: git_remotes,
+          }
+        end
+      end
+
+      def git_head
+        {
+          id: ENV.fetch('GIT_ID', `git log -1 --pretty=format:'%H'`),
+          author_name: ENV.fetch('GIT_AUTHOR_NAME', `git log -1 --pretty=format:'%aN'`),
+          author_email: ENV.fetch('GIT_AUTHOR_EMAIL', `git log -1 --pretty=format:'%ae'`),
+          committer_name: ENV.fetch('GIT_COMMITTER_NAME', `git log -1 --pretty=format:'%cN'`),
+          committer_email: ENV.fetch('GIT_COMMITTER_EMAIL', `git log -1 --pretty=format:'%ce'`),
+          message: ENV.fetch('GIT_MESSAGE', `git log -1 --pretty=format:'%s'`),
+        }
+      end
+
+      def git_branch
+        ENV.fetch('GIT_BRANCH', `git rev-parse --abbrev-ref HEAD`)
+      end
+
+      def git_remotes
+        `git remote -v`.split(/\n/).map do |remote|
+          split_line = remote.split(' ').compact
+          { name: split_line[0], url: split_line[1] }
+        end.uniq
+      end
+
+      def add_ci_env(config)
+        return add_service_params_for_travis(config, yaml_config[:service_name] || nil) if ENV['TRAVIS']
+        return add_service_params_for_circleci(config) if ENV['CIRCLECI']
+        return add_service_params_for_semaphore(config) if ENV['SEMAPHORE']
+        return add_service_params_for_jenkins(config) if ENV['JENKINS_URL'] || ENV['JENKINS_HOME']
+        return add_service_params_for_appveyor(config) if ENV['APPVEYOR']
+        return add_service_params_for_tddium(config) if ENV['TDDIUM']
+        return add_service_params_for_gitlab(config) if ENV['GITLAB_CI']
+        return add_service_params_for_coveralls_local(config) if ENV['COVERALLS_RUN_LOCALLY']
+
+        config
+      end
+
+      def add_service_params_for_travis(config, service_name)
+        config[:service_job_id] = ENV['TRAVIS_JOB_ID']
+        config[:service_pull_request] = ENV['TRAVIS_PULL_REQUEST'] unless ENV['TRAVIS_PULL_REQUEST'] == 'false'
+        config[:service_name]   = service_name || 'travis-ci'
+        config[:service_branch] = ENV['TRAVIS_BRANCH']
+        config
+      end
+
+      def add_service_params_for_circleci(config)
+        config[:service_name]         = 'circleci'
+        config[:service_number]       = ENV['CIRCLE_BUILD_NUM']
+        config[:service_pull_request] = (ENV['CI_PULL_REQUEST'] || '')[/(\d+)$/, 1]
+        config[:parallel]             = ENV['CIRCLE_NODE_TOTAL'].to_i > 1
+        config[:service_job_number]   = ENV['CIRCLE_NODE_INDEX']
+        config
+      end
+
+      def add_service_params_for_semaphore(config)
+        config[:service_name]         = 'semaphore'
+        config[:service_number]       = ENV['SEMAPHORE_BUILD_NUMBER']
+        config[:service_pull_request] = ENV['PULL_REQUEST_NUMBER']
+        config
+      end
+
+      def add_service_params_for_jenkins(config)
+        config[:service_name]   = 'jenkins'
+        config[:service_number] = ENV['BUILD_NUMBER']
+        config[:service_branch] = ENV['BRANCH_NAME']
+        config[:service_pull_request] = ENV['ghprbPullId']
+        config
+      end
+
+      def add_service_params_for_appveyor(config)
+        config[:service_name]   = 'appveyor'
+        config[:service_number] = ENV['APPVEYOR_BUILD_VERSION']
+        config[:service_branch] = ENV['APPVEYOR_REPO_BRANCH']
+        config[:commit_sha] = ENV['APPVEYOR_REPO_COMMIT']
+        repo_name = ENV['APPVEYOR_REPO_NAME']
+        config[:service_build_url] = format('https://ci.appveyor.com/project/%s/build/%s', repo_name, config[:service_number])
+        config
+      end
+
+      def add_service_params_for_tddium(config)
+        config[:service_name]         = 'tddium'
+        config[:service_number]       = ENV['TDDIUM_SESSION_ID']
+        config[:service_job_number]   = ENV['TDDIUM_TID']
+        config[:service_pull_request] = ENV['TDDIUM_PR_ID']
+        config[:service_branch]       = ENV['TDDIUM_CURRENT_BRANCH']
+        config[:service_build_url]    = "https://ci.solanolabs.com/reports/#{ENV['TDDIUM_SESSION_ID']}"
+        config
+      end
+
+      def add_service_params_for_gitlab(config)
+        config[:service_name]         = 'gitlab-ci'
+        config[:service_job_number]   = ENV['CI_BUILD_NAME']
+        config[:service_job_id]       = ENV['CI_BUILD_ID']
+        config[:service_branch]       = ENV['CI_BUILD_REF_NAME']
+        config[:commit_sha]           = ENV['CI_BUILD_REF']
+        config
+      end
+
+      def add_service_params_for_coveralls_local(config)
+        config[:service_job_id]     = nil
+        config[:service_name]       = 'coveralls-multi'
+        config[:service_event_type] = 'manual'
+        config
+      end
+
+      def add_standard_service_params_for_generic_ci(config)
+        config[:service_name]         ||= ENV['CI_NAME']
+        config[:service_number]       ||= ENV['CI_BUILD_NUMBER']
+        config[:service_job_id]       ||= ENV['CI_JOB_ID']
+        config[:service_build_url]    ||= ENV['CI_BUILD_URL']
+        config[:service_branch]       ||= ENV['CI_BRANCH']
+        config[:service_pull_request] ||= (ENV['CI_PULL_REQUEST'] || '')[/(\d+)$/, 1]
+        config
+      end
     end
   end
 end

data/lib/coveralls-multi/formatter.rb

@@ -18,14 +18,15 @@ module CoverallsMulti
           src_file['source_digest'] = src_digest
           src_file
         end
-        puts 'Added source digests'
+        puts '[CoverallsMulti] Added source digests'
         merged_files
       end
 
       def parse_json(path)
         JSON.parse(IO.read("#{CoverallsMulti::Config.root}/#{path}"))
       rescue StandardError => e
-        raise e, "Could not parse file at #{path}"
+        puts "[CoverallsMulti] Could not parse file at #{path}"
+        raise e
       end
     end
   end

data/lib/coveralls-multi/formatters/excoveralls.rb

@@ -21,7 +21,9 @@ module CoverallsMulti
         end
         source_files
       rescue StandardError => e
-        raise e, "There was a problem converting the excoveralls file at #{file_path}"
+        puts "[CoverallsMulti] There was a problem converting the excoveralls file at #{file_path}."
+        puts '[CoverallsMulti] Make sure the file exists.'
+        raise e
       end
     end
   end

data/lib/coveralls-multi/formatters/lcov.rb

@@ -13,7 +13,9 @@ module CoverallsMulti
         # HACK: stringify keys without iterating over the whole array of hashes
         JSON.parse(JSON.dump(file[:source_files]))
       rescue StandardError, SystemExit => e
-        raise e, "There was a problem converting the lcov file at #{file_path}"
+        puts "[CoverallsMulti] There was a problem converting the lcov file at #{file_path}."
+        puts '[CoverallsMulti] Make sure the file exists.'
+        raise e
       end
     end
   end

data/lib/coveralls-multi/formatters/simplecov.rb

@@ -28,10 +28,11 @@ module CoverallsMulti
             end
           end
         rescue StandardError => e
-          raise e, "There was a problem formatting the simplecov report at #{file_path}"
+          puts "[CoverallsMulti] There was a problem formatting the simplecov report at #{file_path}."
+          puts '[CoverallsMulti] Make sure the file exists.'
+          raise e
         end
 
-        puts 'SimpleCov report reformatted to prepare for merge'
         source_files
       end
     end

data/lib/coveralls-multi/runner.rb

@@ -11,18 +11,9 @@ module CoverallsMulti
 
     def start
       payload = merge
-      write_to_file(payload)
-      puts 'Validating payload and pushing to Coveralls'
+      puts '[CoverallsMulti] Validating payload'
       valid = CoverallsMulti::Validator.new(payload).run
-      Coveralls::API.post_json('jobs', payload) if valid
-    end
-
-    def write_to_file(payload)
-      return unless CoverallsMulti::Config.debug_mode
-
-      output_file_path = "#{CoverallsMulti::Config.root}/coveralls.json"
-      puts "Debug mode on - writing results to #{output_file_path}"
-      File.write(output_file_path, JSON.pretty_generate(payload))
+      CoverallsMulti::API.post_json(payload) if valid
     end
 
     def merge
@@ -30,7 +21,7 @@ module CoverallsMulti
       merged = { 'source_files' => source_files }
       CoverallsMulti::Formatter.add_source_digests(merged)
 
-      puts 'All files merged and formatted'
+      puts '[CoverallsMulti] All coverage files merged and formatted'
       merged
     end
 
@@ -50,7 +41,8 @@ module CoverallsMulti
       string_klass = "CoverallsMulti::Formatter::#{string.capitalize}"
       Object.const_get(string_klass)
     rescue NameError => e
-      raise e, "Could not find formatter #{string_klass}"
+      puts "[CoverallsMulti] Could not find formatter #{string_klass}"
+      raise e
     end
   end
 end

data/lib/coveralls-multi/validator.rb

@@ -19,7 +19,8 @@ module CoverallsMulti
       parsed_json = JSON.dump(@payload)
       parsed_json
     rescue JSON::UnparserError => e
-      raise e, 'Payload could not be parsed to JSON!'
+      puts '[CoverallsMulti] Payload could not be parsed to JSON!'
+      raise e
     end
 
     def valid_coveralls_payload?

data/lib/coveralls-multi/version.rb

@@ -1,3 +1,3 @@
 module CoverallsMulti
-  VERSION = '1.3.2'.freeze
+  VERSION = '1.4.0.beta'.freeze
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: coveralls-multi
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0.beta
 platform: ruby
 authors:
 - CJ Horton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coveralls-revelry
+  name: coveralls-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.23
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.23
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
-  name: coveralls-lcov
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 0.16.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 0.16.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.22
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.22
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
 description: A configurable Coveralls client that supports merging coverage from multiple
   languages & test suites.
 email:
@@ -132,6 +160,7 @@ files:
 - bin/test
 - coveralls-multi.gemspec
 - lib/coveralls-multi.rb
+- lib/coveralls-multi/api.rb
 - lib/coveralls-multi/config.rb
 - lib/coveralls-multi/formatter.rb
 - lib/coveralls-multi/formatters/excoveralls.rb
@@ -140,7 +169,7 @@ files:
 - lib/coveralls-multi/runner.rb
 - lib/coveralls-multi/validator.rb
 - lib/coveralls-multi/version.rb
-homepage: 
+homepage: https://github.com/radditude/coveralls-multi
 licenses:
 - MIT
 metadata: {}
@@ -155,11 +184,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Coveralls client for multi-language repos.