probedock-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d941395e464c62eab491d4939d4a8a64096cbac6
-  data.tar.gz: 4e35bc79a67d9f0cf1460ea0f167f5b7061a34a7
+  metadata.gz: 23bf815842f4bd1f2c40d19802e6bde6d2343aee
+  data.tar.gz: f66d5ae1474538712d06fe75de4e096a462c60d4
 SHA512:
-  metadata.gz: e7b22566142e31593d73930d26ef56eefc3f1e491a0deb1f22c5a1960806d07d3e82d2510706fc92f5086dd1fa1eddccb94e89db091525211d2dfb1c05a38998
-  data.tar.gz: b05d2128a07ae016a8a7616a7651b0fa4d9b1d21d08a8a6ba4cf8c6a057d7da0d486540bd9990090910dbfd4fe7208598ef10480cdb1fc769360f3728a28b8b9
+  metadata.gz: 2f95da27dbb3b7bff866d392719e97f5bc07685b3fa5617759a28ca4375551f9c5aef2a929458144eecfb12c384a5c98b31677f45065af866a691e406b0a394a
+  data.tar.gz: 5089ff9bfda8ff1755eee59deb59fec0e3d82005d0f37d396544ec2b63a788ea52baf6527e2abe1a5811b534a1373fe6257603aeae590beb1da5888efbc4ab64

data/README.md

@@ -17,7 +17,7 @@
 Add it to your Gemfile:
 
 ```rb
-gem 'probedock-ruby', '~> 0.1.0'
+gem 'probedock-ruby', '~> 0.1.1'
 ```
 
 Run `bundle install`.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/probe_dock_ruby/client.rb

@@ -1,3 +1,5 @@
+require 'paint'
+
 module ProbeDockProbe
 
   class Client
@@ -41,7 +43,7 @@ module ProbeDockProbe
 
     def build_payload test_run, options = {}
       begin
-        TestPayload.new(test_run).to_h options
+        test_run.to_h options
       rescue PayloadError => e
         fail e.message
       end

data/lib/probe_dock_ruby/config.rb

@@ -1,20 +1,13 @@
 require 'yaml'
 
-# Utilities to send test results to Probe Dock.
 module ProbeDockProbe
 
   def self.config
-    @config ||= Config.new.tap(&:load!)
+    @config ||= Config.new
   end
 
-  def self.configure options = {}
-
-    yield config if block_given?
-
-    config.check!
-    config.load_warnings.each{ |w| warn Paint["Probe Dock - #{w}", :yellow] }
-
-    config
+  def self.config= config
+    @config = config
   end
 
   class Config
@@ -59,9 +52,9 @@ module ProbeDockProbe
       @servers.clear
 
       @load_warnings = []
-      return unless config = load_config_files
+      config = load_config_files
 
-      @publish = parse_env_flag :publish, !!config[:publish]
+      @publish = parse_env_flag :publish, config.fetch(:publish, true)
       @server_name = parse_env_option(:server) || config[:server]
       @local_mode = parse_env_flag(:local) || !!config[:local]
 
@@ -87,9 +80,16 @@ module ProbeDockProbe
       project_options.merge! api_id: @server.project_api_id if @server and @server.project_api_id
       @project.update project_options
 
+      yield self if block_given?
+
+      check!
+      @load_warnings.each{ |w| warn Paint["Probe Dock - #{w}", :yellow] }
+
       self
     end
 
+    private
+
     def check!
 
       configs = [ home_config_file, working_config_file ]
@@ -106,8 +106,6 @@ module ProbeDockProbe
       end
     end
 
-    private
-
     def build_servers config
 
       default_server_options = { project_api_id: config[:project][:api_id] }
@@ -123,7 +121,7 @@ module ProbeDockProbe
 
       configs = [ home_config_file, working_config_file ]
       actual_configs = configs.select{ |f| File.exists? f }
-      return false if actual_configs.empty?
+      return { servers: [], payload: {}, project: {} } if actual_configs.empty?
 
       actual_configs.collect!{ |f| YAML.load_file f }
 

data/lib/probe_dock_ruby/test_result.rb

@@ -1,40 +1,42 @@
 module ProbeDockProbe
   class TestResult
-    attr_reader :key, :name, :category, :tags, :tickets, :data, :duration, :message
-
-    def initialize project, example, groups = [], options = {}
+    attr_reader :key, :fingerprint, :name, :category, :tags, :tickets, :data, :duration, :message
+
+    def initialize project, options = {}
+
+      if !options[:fingerprint]
+        raise Error, "The :fingerprint option is required (unique identifier for the test)"
+      elsif !options[:name]
+        raise Error, "The :name option is required (human-friendly identifier for the test, not necessarily unique)"
+      elsif !options.key?(:passed)
+        raise Error, "The :passed option is required (indicates whether the test passed or not)"
+      elsif !options[:duration]
+        raise Error, "The :duration options is required (indicates how long it took to run the test)"
+      end
 
-      @category = project.category
-      @tags = project.tags
-      @tickets = project.tickets
+      @key = options[:key]
+      @fingerprint = options[:fingerprint]
+      @name = options[:name]
 
-      @grouped = extract_grouped example, groups
-
-      [ :key, :name, :category, :tags, :tickets, :data ].each do |attr|
-        instance_variable_set "@#{attr}".to_sym, send("extract_#{attr}".to_sym, example, groups)
-      end
+      @category = options[:category] || project.category
+      @tags = (wrap(options[:tags]) + wrap(project.tags)).compact.collect(&:to_s).uniq
+      @tickets = (wrap(options[:tickets]) + wrap(project.tickets)).compact.collect(&:to_s).uniq
 
       @passed = !!options[:passed]
       @duration = options[:duration]
       @message = options[:message]
+
+      @data = options[:data] || {}
+      @data = @data.deep_stringify_keys if @data.respond_to? :deep_stringify_keys
     end
 
     def passed?
       @passed
     end
 
-    def grouped?
-      @grouped
-    end
-
-    def update options = {}
-      @passed &&= options[:passed]
-      @duration += options[:duration]
-      @message = [ @message, options[:message] ].select{ |m| m }.join("\n\n") if options[:message]
-    end
-
     def to_h options = {}
       {
+        'f' => @fingerprint,
         'p' => @passed,
         'd' => @duration
       }.tap do |h|
@@ -48,63 +50,6 @@ module ProbeDockProbe
       end
     end
 
-    def self.extract_grouped example, groups = []
-      !!groups.collect{ |g| meta(g)[:grouped] }.compact.last
-    end
-
-    def self.extract_key example, groups = []
-      (groups.collect{ |g| meta(g)[:key] } << meta(example)[:key]).compact.reject{ |k| k.strip.empty? }.last
-    end
-
-    def self.meta holder
-      meta = holder.metadata[:probe_dock] || {}
-      if meta.kind_of? String
-        { key: meta }
-      elsif meta.kind_of? Hash
-        meta
-      else
-        {}
-      end
-    end
-
-    private
-
-    def meta *args
-      self.class.meta *args
-    end
-
-    def extract_grouped *args
-      self.class.extract_grouped *args
-    end
-
-    def extract_key *args
-      self.class.extract_key *args
-    end
-
-    def extract_name example, groups = []
-      parts = groups.dup
-      parts = parts[0, parts.index{ |p| meta(p)[:grouped] } + 1] if @grouped
-      parts << example unless @grouped
-      parts.collect{ |p| p.description.strip }.join ' '
-    end
-
-    def extract_category example, groups = []
-      cat = (groups.collect{ |g| meta(g)[:category] }.unshift(@category) << meta(example)[:category]).compact.last
-      cat ? cat.to_s : nil
-    end
-
-    def extract_tags example, groups = []
-      (wrap(@tags) + groups.collect{ |g| wrap meta(g)[:tags] } + (wrap meta(example)[:tags])).flatten.compact.uniq.collect(&:to_s)
-    end
-
-    def extract_tickets example, groups = []
-      (wrap(@tickets) + groups.collect{ |g| wrap meta(g)[:tickets] } + (wrap meta(example)[:tickets])).flatten.compact.uniq.collect(&:to_s)
-    end
-
-    def extract_data example, groups = []
-      meta(example)[:data] || {}
-    end
-
     def wrap a
       a.kind_of?(Array) ? a : [ a ]
     end

data/lib/probe_dock_ruby/test_run.rb

@@ -9,23 +9,8 @@ module ProbeDockProbe
       @project = project
     end
 
-    def add_result example, groups = [], options = {}
-      if TestResult.extract_grouped(example, groups) and (existing_result = @results.find{ |r| r.grouped? && r.key == TestResult.extract_key(example, groups) })
-        existing_result.update options
-      else
-        @results << TestResult.new(@project, example, groups, options)
-      end
-    end
-
-    def results_without_key
-      @results.select{ |r| !r.key or r.key.to_s.strip.empty? }
-    end
-
-    def results_by_key
-      @results.inject({}) do |memo,r|
-        (memo[r.key] ||= []) << r unless !r.key or r.key.to_s.strip.empty?
-        memo
-      end
+    def add_result options = {}
+      @results << TestResult.new(@project, options)
     end
 
     def to_h options = {}
@@ -45,40 +30,9 @@ module ProbeDockProbe
 
     def validate!
       # TODO: validate duration
-
+      # TODO: log information about duplicate keys (if any)
       raise PayloadError.new("Missing project") if !@project
       @project.validate!
-
-      # FIXME: log info/warnings
-      #validate_no_results_without_key
-      #validate_no_duplicate_keys
-    end
-
-    def validate_no_duplicate_keys
-
-      results_with_duplicate_key = results_by_key.select{ |k,r| r.length >= 2 }
-      return if results_with_duplicate_key.none?
-
-      msg = "the following keys are used by multiple test results".tap do |s|
-        results_with_duplicate_key.each_pair do |key,results|
-          s << "\n     - #{key}"
-          results.each{ |r| s << "\n       - #{r.name}" }
-        end
-      end
-
-      raise PayloadError.new(msg)
-    end
-
-    def validate_no_results_without_key
-
-      keyless = results_without_key
-      return if keyless.empty?
-
-      msg = "the following test results are missing a key".tap do |s|
-        keyless.each{ |r| s << "\n     - #{r.name}" }
-      end
-
-      raise PayloadError.new(msg)
     end
   end
 end

data/lib/probe_dock_ruby.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 module ProbeDockProbe
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 
   class Error < StandardError; end
   class PayloadError < Error; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: probedock-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Simon Oulevay (Alpha Hydrae)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -198,7 +198,6 @@ files:
 - lib/probe_dock_ruby/project.rb
 - lib/probe_dock_ruby/server.rb
 - lib/probe_dock_ruby/tasks.rb
-- lib/probe_dock_ruby/test_payload.rb
 - lib/probe_dock_ruby/test_result.rb
 - lib/probe_dock_ruby/test_run.rb
 - lib/probe_dock_ruby/uid.rb

data/lib/probe_dock_ruby/test_payload.rb

@@ -1,18 +0,0 @@
-require 'fileutils'
-require 'digest/sha2'
-
-module ProbeDockProbe
-
-  class TestPayload
-
-    class Error < ProbeDockProbe::Error; end
-
-    def initialize run
-      @run = run
-    end
-
-    def to_h options = {}
-      @run.to_h options
-    end
-  end
-end