cider_ci-support 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93150cebbc3735e9a269a391e09791330222d136
-  data.tar.gz: 5c266c6b80369755633d1ee542eb3dabc1589cfc
+  metadata.gz: 1bffbb16fb39c015e8d1b91203c1ce966dd5cfd9
+  data.tar.gz: 369b8553ea92f11d12b699cc03b4e3433ecb3c97
 SHA512:
-  metadata.gz: d8c6dc82d64c084df248407775cb6950e96a136bc4a5aded6a7edcf1bb06370535e5a688623df71060a142a7ff03c0fb1500ff6adb38ff28e8e6c522951528d7
-  data.tar.gz: eba540288c8116760dab86e1e3f9be1b297635bfe64fff6392f630bdb85273965260ea535dc60328565173235bcf0734c43f1ef7aa1c6e54411dcfd355aa3f85
+  metadata.gz: b8e4d554df03814384a77204d3f9855e91bf9fac7dce8e955c8d2950ebbbeb45d8ef3dd390cac384601c34cf88e693530b07d3aaa3c30280d99f5d4e8d99f632
+  data.tar.gz: 0dd73f1544193ba5bb2ef5eaeced57b22f11d34344d2d093526c97b805f8384ce4e5ebb8ce9e8ede4970b50beed4ad3ca5793d1c5b2b9b3aac2bf6b23bc7f2a5

data/README.md

@@ -1,6 +1,6 @@
-# Cider-CI Support for Ruby and Ruby on Rails projects 
+# Cider-CI Support for Ruby and Ruby on Rails projects
 
-This gem provides convenience executables to work with Cider-CI. 
+This gem provides convenience executables to work with Cider-CI.
 
 
 ## Installation
@@ -8,67 +8,35 @@ This gem provides convenience executables to work with Cider-CI.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cider_ci-support', '~> 1.0.0'
+gem 'cider_ci-support', '~> 3.0.0'
 ```
 
 ## Usage
 
-### Aggregate Coverage with `cider-ci_coverage` 
-
-1. Add [Simplecov]() to your project and configure it.
-
-2. Have the coverage output attached to the trials, e.g. 
-
-    ```yaml
-    task_defaults:
-      trial_attachments:
-        coverage_resultset:
-          glob: 'coverage/.resultset.json'
-          content-type: application/json
-    ```
-
-3. Run the tests on Cider-CI. 
-
-4. Within the top level directory of you project, e.g. 
-
-  ~~~
-  cider-ci_coverage 
-  ~~~
-
-  which will create the coverage output in `./coverage/`. Alternatively
-
-  ~~~
-  cider-ci_coverage --upload
-  ~~~
-
-  will additionally upload the files `./coverage/**/*`
-  as tree-attachments. 
-
-5.  Set the desired `limit` (optionally). `cider-ci_coverage` will exit
-    with value 0 if and only if the ration `covered / uncovered lines`
-    in per cent is above the *limit* (default 95%). This limit can be
-    set by the `--limit LIMIT` option where `LIMIT` is a integer.
-
-  ~~~
-  cider-ci_coverage --upload --limit 99
-  ~~~
-
-
 ### Static complexity code analysis with `cider-ci_flog`
 
 `cider-ci_flog` uses [flog][] to perform a static code analysis. It exits with
 0 if and only if there are no offenders. The original `flog` always exits with
 0. Therefore `cider-ci_flog` lends itself to be used within a task of
-a Cider-CI execution suite. 
+a Cider-CI execution suite.
 
 
 ### Static similarity code analysis with `cider-ci_flay`
 
-`cider-ci_flay` uses [flay][] to perform a static code
-analysis. It exits with 0 if and only if there are no offenders. The
-original `flay` always exits with 0. Therefore
-`cider-ci_flay` lends itself to be used within a task of a
-Cider-CI execution suite.
+`cider-ci_flay` uses [flay][] to perform a static code analysis. It exits with
+0 if and only if there are no offenders. The original `flay` always exits with
+0. Therefore `cider-ci_flay` lends itself to be used within a task of
+a Cider-CI execution suite.
+
+
+## Notes
+
+The Coverage analysis based on [SimpleCov]() has been removed with version 3.0.
+
+We deemed the inflicted complexity to hight to maintain it. The problems are
+not related to Cider-CI itself. If you want coverage support with Cider-CI we
+recommend to extract the code from an older version to get started.
+
 
   [flay]: http://ruby.sadi.st/Flay.html
   [flog]: http://ruby.sadi.st/Flog.html

data/bin/cider-ci_flay

@@ -23,12 +23,12 @@ def parse_options(options)
   OptionParser.new do |opts|
     opts.banner = 'Usage: cider-ci_flay FILE/DIR ...'
 
-    opts.on('-d', '--print-details')  do
+    opts.on('-d', '--print-details') do
       options.print_details = true
     end
 
     opts.on('-m', '--mass MASS', Integer,
-            "See flay documentation, default #{options.mass}.")  do |n|
+            "See flay documentation, default #{options.mass}.") do |n|
       options.mass = n
     end
   end.parse!

data/bin/cider-ci_flog

@@ -24,11 +24,11 @@ def parse_options(options)
   OptionParser.new do |opts|
     opts.banner = 'Usage: cider-ci_flog FILE/DIR ...'
 
-    opts.on('-l', '--limit N', Integer)  do |l|
+    opts.on('-l', '--limit N', Integer) do |l|
       options.limit = l
     end
 
-    opts.on('-d', '--print-details')  do
+    opts.on('-d', '--print-details') do
       options.print_details = true
     end
   end.parse!

data/cider_ci-support.gemspec

@@ -18,14 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '= 0.29.1'
+  spec.add_development_dependency 'rubocop', '= 0.35.1'
 
   spec.add_runtime_dependency 'flay', '~> 2.6.1'
   spec.add_runtime_dependency 'flog', '~> 4.3.2'
-  spec.add_runtime_dependency 'json_roa-client', '>= 1.0.0'
   spec.add_runtime_dependency 'mime-types'
-  spec.add_runtime_dependency 'simplecov', '~> 0.9'
-  spec.add_runtime_dependency 'thread', '= 0.1.5'
 end

data/lib/cider_ci/support/version.rb

@@ -1,5 +1,5 @@
 module Cider_CI
   module Support
-    VERSION = '2.0.0'
+    VERSION = '3.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cider_ci-support
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Thomas Schank
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.35.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.35.1
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.3.2
-- !ruby/object:Gem::Dependency
-  name: json_roa-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -108,39 +94,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: thread
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.5
 description: ''
 email:
 - DrTom@schank.ch
 executables:
-- cider-ci_coverage
 - cider-ci_flay
 - cider-ci_flog
 extensions: []
@@ -152,7 +109,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/cider-ci_coverage
 - bin/cider-ci_flay
 - bin/cider-ci_flog
 - cider_ci-support.gemspec

data/bin/cider-ci_coverage

@@ -1,303 +0,0 @@
-#!/usr/bin/env ruby
-###############################################################################
-# This script gathers ruby coverage information from a cider-ci instance and
-# aggregates it via simplecov.
-#
-# Authors: Thomas Schank <DrTom@schank.ch>
-#
-###############################################################################
-
-#  Planned features for the future:
-#
-# * upload result to cider-ci (attachments to the tree_id)
-
-require 'fileutils'
-require 'json_roa/client'
-require 'logger'
-require 'mime/types'
-require 'open-uri'
-require 'optparse'
-require 'ostruct'
-require 'simplecov'
-require 'thread/future'
-require 'thread/pool'
-
-###############################################################################
-# Globals (this is a script after all)
-###############################################################################
-
-Thread.abort_on_exception = true
-@debug = false
-@pool = nil
-
-@logger = Logger.new(STDERR)
-@logger.level = Logger::WARN
-
-###############################################################################
-# Download from Cider-CI
-###############################################################################
-
-def connect(base_url, username, password)
-  JSON_ROA::Client.connect base_url do |conn|
-    conn.basic_auth(username, password)
-    conn.ssl.verify = false
-  end
-end
-
-def get_job_resource(root, job_id)
-  root.relation('job').get('id' => job_id)
-end
-
-def print_progress_and_debug(separator = '.', msg = '')
-  if @debug
-    puts separator.to_s + " " + msg.to_s
-  else
-    print separator
-    STDOUT.flush
-  end
-end
-
-def get_and_convert_resultset_attachments(root, tree_id)
-  print 'download_resultset_attachments'; STDOUT.flush
-  root.relation('jobs').get('treeid' => tree_id).collection \
-    .map(&:get).map do |job|
-    job.relation('tasks').get('state' => 'passed').collection\
-      .map do |task_relation|
-      Thread.future @pool do
-        begin 
-          print_progress_and_debug('', task_relation)
-          task_relation.get.relation('trials') \
-            .get('state' => 'passed').collection.map(&:get).map do |trial|
-            print_progress_and_debug('.', trial)
-            trial.relation('trial-attachments') \
-              .get.collection.map do |tar|
-              print_progress_and_debug('.', "getting #{tar}")
-              trial_attachment_resource = tar.get
-              if (working_dir = trial.data['scripts'] \
-                  .map { |_k, v| v['working_dir'] }.compact.first) \
-                && (trial_attachment_resource.data['path'] =~ /resultset\.json/)
-                result_data_relation = trial_attachment_resource \
-                                       .relation('trial-attachment-data-stream')
-                print_progress_and_debug('*', "getting #{result_data_relation}")
-                resultset = result_data_relation.get.response.body
-                print_progress_and_debug('*', "converting resultset") 
-                convert_resultset resultset, working_dir
-              end
-            end
-          end
-          rescue Exception => e
-            @logger.error e
-        end
-      end
-    end.map { |f| f.value!(3) }
-  end.flatten.compact
-end
-
-###############################################################################
-# Upload
-###############################################################################
-
-def upload_as_tree_attachments(root, tree_id)
-  print 'upload_as_tree_attachments'; STDOUT.flush
-
-  Dir.glob('coverage/**/*').each do |filename|
-    content_type = MIME::Types.of(filename).first.content_type rescue nil
-    if content_type
-      Faraday::UploadIO.new(filename, content_type)
-      root.relation('tree-attachment-data-stream').put(
-        { 'treeid' => tree_id, 'path' => filename },
-        File.open(filename, 'rb').read, 'content-type' => content_type)
-      print_progress_and_debug('*')
-    end
-  end
-  puts ''
-end
-
-###############################################################################
-# Simplev cov
-###############################################################################
-
-def convert_resultset(resultset, working_dir)
-  JSON.parse(resultset.to_json).map do |command_name, data|
-    [command_name, data.map do |k, v|
-      case k
-      when 'coverage'
-        [k, v.map do |filename, file_coverage|
-          [(FileUtils.pwd + filename[working_dir.length, filename.length]) \
-           , file_coverage]
-        end.instance_eval { Hash[self] }]
-      else
-        [k, v]
-      end
-    end.instance_eval { Hash[self] }]
-  end.instance_eval { Hash[self] }.instance_eval do
-    SimpleCov::Result.from_hash(self)
-  end
-end
-
-def reduce_resultsets(resultsets)
-  puts 'reduce_resultsets'
-  resultsets.reduce({}) do |agg, resultset|
-    resultset.original_result.merge_resultset(agg)
-  end
-end
-
-def init_simple_cov
-  SimpleCov.add_group 'Models', 'app/models'
-  SimpleCov.add_group 'Controllers', 'app/controllers'
-  SimpleCov.add_group 'Views', 'app/views'
-  SimpleCov.add_group 'Helpers', 'app/helpers'
-  SimpleCov.add_group 'Factories', 'factories'
-  SimpleCov.add_group 'Libraries', 'app/lib'
-end
-
-###############################################################################
-# Run
-###############################################################################
-
-def run_coverage(root, tree_id)
-  get_and_convert_resultset_attachments(root, tree_id).instance_eval do
-    reduce_resultsets self
-  end.instance_eval do
-    if self.empty?
-      fail ScriptError, 'the collected and reduced coverage result is empty'
-    end
-    init_simple_cov
-    SimpleCov::Result.new self
-  end.instance_eval do
-    SimpleCov::Formatter::HTMLFormatter.new.format self
-    self
-  end
-end
-
-###############################################################################
-# Git 
-###############################################################################
-
-def assert_correct_tree_id(job)
-  if job.data['tree_id'] != `git log -n 1 --pretty=%T`.strip
-    fail ScriptError, 'you must be on the same tree_id as the job'
-  end
-end
-
-def get_current_tree_id
-  begin
-    tree_id = `"git" "log" "-n" "1" "--pretty=%T"`.strip
-  rescue _
-    raise ScriptError, 'could not determine the current tree_id'
-  end
-
-  if $?.exitstatus != 0 
-    raise ScriptError, "could not determine the current tree_id"
-  else
-    tree_id
-  end
-end
-
-###############################################################################
-# Thread pool
-###############################################################################
-
-def set_thread_pool(thread_pool_size)
-  @pool = Thread.pool thread_pool_size  
-end
-
-###############################################################################
-# Options, main ....
-###############################################################################
-
-def parse_options(options)
-  OptionParser.new do |opts|
-    opts.banner = 'Usage: cider-ci_coverage'
-
-    opts.on('-a', '--api-url API-URL') do |url|
-      options.api_url = url
-    end
-
-    opts.on('-e', '--job JOB_ID',
-            'Execution ID to retrieve coverage for') do |exid|
-      options.job_id = exid
-    end
-
-    opts.on('-t', '--thread-pool-size N', Integer) do |t|
-      options.thread_pool_size = t
-    end
-
-    opts.on('-u', '--username NAME', String) do |n|
-      options.username = n
-    end
-
-    opts.on('-p', '--password PASSWORD', String) do |p|
-      options.password = p
-    end
-
-    opts.on('-u', '--upload') do
-      options.upload = true
-    end
-
-    opts.on('-d', '--debug') do
-      @debug = true
-    end
-
-    opts.on('-l', '--limit N', Integer)  do |l|
-      options.limit = l
-    end
-  end.parse!
-
-  options
-end
-
-def main
-  options = OpenStruct.new
-  options.thread_pool_size = 50
-  options.username = ENV['CIDER_CI_USERNAME']
-  options.password = ENV['CIDER_CI_PASSWORD']
-  options.api_url = ENV['CIDER_CI_API_URL']
-  options.upload = false
-  options.limit = 95
-  parse_options options
-  options.api_url || fail(OptionParser::MissingArgument \
-                                , 'api_url is required, set CIDER_CI_API_URL \
-                                or provide -a option')
-  options.username || fail(OptionParser::MissingArgument \
-                            , 'username is required, set CIDER_CI_USERNAME')
-  options.password || fail(OptionParser::MissingArgument \
-                            , 'password is required, set CIDER_CI_PASSWORD')
-
-  root = connect(options.api_url, options.username, options.password).get
-  tree_id = get_current_tree_id
-  set_thread_pool options.thread_pool_size
-  FileUtils.rm_rf('coverage')
-  result = run_coverage root, tree_id
-  upload_as_tree_attachments root, tree_id if options.upload
-
-  coverage = (result.covered_lines / result.total_lines.to_f)
-
-  write_result_json coverage, options.limit
-
-  if passed? coverage, options.limit
-    exit
-  else
-    abort("FAILED coverage at #{per_cent(coverage)}% is \
-          below limit of #{options.limit}% ")
-  end
-end
-
-def write_result_json(coverage, limit)
-  result_message = passed?(coverage, limit) ? 'passed' : 'failed'
-  File.open('result.json', 'w')  do |file|
-    file.write({ value: coverage,
-                 summary: "#{result_message} with #{per_cent(coverage)}%"
-    }.to_json)
-  end
-end
-
-def passed?(coverage, limit)
-  coverage > limit / 100.0
-end
-
-def per_cent(relative_value)
-  (relative_value * 100.0).round(2)
-end
-
-main