results_keeper 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c9877f4580c196f8adfe980e5b4ac09b3443147
-  data.tar.gz: 223977ee86856fbe16f20ee94873a896143ddd9b
+  metadata.gz: 0c4e73090baacd2c643c5660017efd309fe48462
+  data.tar.gz: f8a7806dddc8637b521dd54320a791a1ec7c9259
 SHA512:
-  metadata.gz: 1d6fe87a3cd4978e129c0a20ceac7f43f9d7394983bc7e97c26fe0b7106119be55eeb7e348616d5f9cbd8ec299019fd86a56a2bac20a85c83d967e74fbebb736
-  data.tar.gz: 5c8e2e0b975a912931474341aeba577b3aa9093a99aa729e6d2039328893aa2426bf52ec1ebc114b83fb6fc70b47d48d8f3cccee866317554234a1bb809dd961
+  metadata.gz: c736b710a9eb48c9756b26b9a5139d6add670da90fb3c5ad62d8ad282ba3281fc89ea7698d5e535f4553421e8dc8ce0ca687167e327db8c7b5c769eb002bae1a
+  data.tar.gz: b7405e367e633beab844a7b82da96428d7aa5a179a2add136bd59f3c1a34250abbb1a8261596d7eb618a532ce7eb033cd49054c6874006e6e451cfed3910ce74

data/lib/results_keeper.rb

@@ -1,118 +1,32 @@
-require 'net/http'
 require 'json'
-require 'rest_client'
-require_relative 'string'
 require 'singleton'
-require 'pry'
-require_relative 'test_data_generator'
+require_relative 'results_keeper/results_sender'
+require_relative 'results_keeper/messages'
 
 class ResultsKeeper
   include Singleton
 
-  DEFAULT_PORT = 3000
-  DEFAULT_HOST = 'localhost'
+  attr_reader :test_started_time, :results_sender
 
   def initialize
-    @data_generator = TestDataGenerator.new
-    @tmp_data ||= {}
-    @tmp_data[:tests] ||= []
-    @rk_host = ENV['RK_REPORT_SERVER_HOST'] || DEFAULT_HOST
-    @rk_port = ENV['RK_REPORT_SERVER_PORT'] || DEFAULT_PORT
+    @results_sender = RkCucumber::ResultsSender.new
   end
 
   def send_revision
-    @revision = send_json(@data_generator.revision_data,
-                          'revisions',
-                          "#{@data_generator.project_name} > #{@data_generator.revision_name} started")
+    @results_sender.send_revision
   end
 
   def send_revision_complete
-    send_not_sent_scenarios
-    send_json(@data_generator.revision_completed_data,
-              'revisions',
-              "#{@data_generator.revision_name} completed")
+    @results_sender.send_revision_complete
   end
 
   def send_test(scenario)
-    # In case if the host is not available we need to send revision once more (when it comes back)
-    send_revision unless @revision
-    return add_test_to_tmp(scenario) unless @revision
-    @screenshot_path = save_screenshot(scenario) if ENV['RK_SEND_SCREENSHOTS']
-    @test = send_json(@data_generator.test_data(scenario, @revision), 'tests')
-    send_screenshot(@screenshot_path) if @screenshot_path
-  end
-
-  def save_screenshot(scenario)
-    if scenario.exception
-      begin
-        screenshot_name = "#{Time.now.to_i}_#{rand(1000..9999)}.png"
-        @file_path = "tmp/screenshots/#{screenshot_name}"
-        Capybara.page.save_screenshot(@file_path)
-        @file_path
-      rescue
-        console_message('Could not take a screenshot :(')
-        nil
-      end
-    end
-  end
-
-  def add_test_to_tmp(scenario)
-    #console_warning_message("Could not send '#{scenario.name}' there seems to be a problem with #{@rk_host}:#{@rk_port}")
-    @tmp_data[:tests] << scenario
-    puts console_warning_message("Not sent scenarios amount: #{@tmp_data[:tests].count}")
-  end
-
-  def send_not_sent_scenarios
-    if @revision
-      @tmp_data[:tests].each do |s|
-        console_message("Trying to re-send '#{s.name}' once more")
-        send_test(s)
-      end
-    else
-      false
-    end
-   end
-
-  def send_json(body, path, message_to_client=nil)
-
-    body['secret_key'] = ENV['RK_SECRET_KEY']
-    @path = "/api/#{path}"
-    @body = body.to_json
-
-    begin
-      request = Net::HTTP::Post.new(@path, initheader = {'Content-Type' => 'application/json'})
-      request.body = @body
-      response = Net::HTTP.new(@rk_host, @rk_port).start {|http| http.request(request)}
-
-      message_to_client ? console_message("#{message_to_client} - #{response.code} - #{response.message}") : console_message("#{response.code} - #{response.message}")
-      JSON.parse(response.body)
-    rescue
-      console_warning_message("There seems to be a problem with #{@rk_host}:#{@rk_port}, make sure your RK_SECRET_KEY is correct and server is up.")
-      false
-    end
-  end
-
-  def send_screenshot(screenshot_path)
-    begin
-      params = {project: @revision['project_id'], revision: @revision['revision_id'], test: @test['id']}
-      RestClient.post("http://#{@rk_host}:#{@rk_port}/api/tests/upload_screenshot",
-                      :name_of_file_param => File.new(screenshot_path), :body => params)
-      File.delete(screenshot_path)
-    rescue => e
-      console_warning_message("Could not send screenshot, there seems to be a problem with #{@rk_host}:#{@rk_port}")
+    unless @results_sender.send_test(scenario, @test_started_time)
+      @results_sender.add_test_to_tmp(scenario, @test_started_time)
     end
   end
 
   def test_started(scenarion=nil)
-    @data_generator.test_started
-  end
-
-  def console_message(text)
-    puts "    Results Keeper: #{text}".blue unless ENV['HIDE_RK_MESSAGES'] == 'true'
-  end
-
-  def console_warning_message(text)
-    puts "    Results Keeper: #{text}".yellow unless ENV['HIDE_RK_MESSAGES'] == 'true'
+    @test_started_time = Time.now
   end
 end
-

data/lib/results_keeper/config.rb

@@ -0,0 +1,40 @@
+require_relative 'messages'
+
+module RkCucumber
+  class Config
+    class << self
+
+      def default
+        {
+          project_name: 'Default',
+          report_server_host: 'results-keeper.com',
+          report_server_port: 80,
+          api: {
+            revision_path: 'revisions',
+            test_path: 'tests'
+            }
+        }
+      end
+
+      def config
+        opts = {}
+        opts[:report_server_host] = ENV['RK_REPORT_SERVER_HOST'] if ENV['RK_REPORT_SERVER_HOST']
+        opts[:report_server_port] = ENV['RK_REPORT_SERVER_PORT'] if ENV['RK_REPORT_SERVER_PORT']
+        opts[:project_name] = ENV['RK_PROJECT_NAME'] || default_project_name
+        opts[:revision_name] = ENV['RK_REVISION_NAME'] || ENV['RK_REVISION_NAME'] = "Result for #{Time.now}"
+        opts[:secret_key] = ENV['RK_SECRET_KEY'] || raise(RkCucumber::Messages.no_secret_key)
+        default.merge!(opts)
+      end
+
+      private
+
+      def default_project_name
+        begin
+          `pwd`.strip.split('/').last
+        rescue
+          'Default'
+        end
+      end
+    end
+  end
+end

data/lib/results_keeper/messages.rb

@@ -0,0 +1,50 @@
+require_relative 'string'
+require_relative 'config'
+
+module RkCucumber
+  class Messages
+    class << self
+
+      # ERROR
+      def take_screenshot_error
+        console_warning_message('Could not take a screenshot :(')
+      end
+
+      def error_send_screenshot
+        console_warning_message("Could not send screenshot, there seems to be a problem with #{RkCucumber::Config.config[:report_server_host]}:#{RkCucumber::Config.config[:report_server_port]}")
+      end
+
+      def error_not_sent_scenario(amount)
+        console_warning_message("Not sent scenarios amount: #{amount}")
+      end
+
+      def no_secret_key
+        'RK_SECRET_KEY env var not found. Please use export RK_SECRET_KEY=<your secret key> to set it.'
+      end
+
+      # INFO
+      def info_trying_resend(scenario_name)
+        console_message("Trying to re-send '#{scenario_name}' once more")
+      end
+
+      def info_message_to_client(response, message_to_client=nil)
+        message_to_client ? console_message("#{message_to_client} - #{response.code} - #{response.message}") : console_message("#{response.code} - #{response.message}")
+      end
+
+      # WARN
+      def warn_problem_with_rk
+        console_warning_message("There seems to be a problem with #{RkCucumber::Config.config[:report_server_host]}:#{RkCucumber::Config.config[:report_server_port]}, make sure your RK_SECRET_KEY is correct and server is up.")
+      end
+
+      def console_message(text)
+        private
+        puts "    Results Keeper: #{text}".blue unless ENV['HIDE_RK_MESSAGES'] == 'true'
+      end
+
+      def console_warning_message(text)
+        private
+        puts "    Results Keeper: #{text}".yellow unless ENV['HIDE_RK_MESSAGES'] == 'true'
+      end
+    end
+  end
+end

data/lib/results_keeper/results_sender.rb

@@ -0,0 +1,90 @@
+require 'net/http'
+require 'json'
+require 'rest_client'
+require_relative 'messages'
+require_relative 'test_data_generator'
+require_relative 'config'
+
+module RkCucumber
+  class ResultsSender
+
+    attr_reader :tmp_data
+
+    def initialize
+      @data_generator = RkCucumber::TestDataGenerator.new
+      @tmp_data ||= {}
+      @tmp_data[:tests] ||= []
+    end
+
+    def send_revision
+      @revision = send_json(@data_generator.revision_data,
+                            RkCucumber::Config.default[:api][:revision_path],
+                            "#{RkCucumber::Config.config[:project_name]} > #{RkCucumber::Config.config[:revision_name]} started")
+    end
+
+    def send_revision_complete
+      send_not_sent_scenarios
+      send_json(@data_generator.revision_completed_data,
+                RkCucumber::Config.default[:api][:revision_path],
+                "#{RkCucumber::Config.config[:revision_name]} completed")
+    end
+
+    def send_test(scenario, test_started_at)
+      # In case if the host is not available we need to send revision once more (when it comes back)
+      send_revision unless @revision
+      return nil unless @revision
+      screenshot_path = @data_generator.save_screenshot(scenario) if ENV['RK_SEND_SCREENSHOTS']
+      @test = send_json(@data_generator.test_data(scenario, @revision, test_started_at),
+                        RkCucumber::Config.default[:api][:test_path])
+      return nil unless @test
+      send_screenshot(screenshot_path) if screenshot_path
+      @test
+    end
+
+    def send_not_sent_scenarios
+      if @revision
+        @tmp_data[:tests].each do |s|
+          s[:revision_id] = @revision['revision_id'] unless s[:revision_id]
+          RkCucumber::Messages.info_trying_resend(s[:name])
+          send_json(s, RkCucumber::Config.default[:api][:test_path]) if @revision
+        end
+      else
+        false
+      end
+    end
+
+    def send_json(body, path, message_to_client=nil)
+      body['secret_key'] = RkCucumber::Config.config[:secret_key]
+      @path = "/api/#{path}"
+      @body = body.to_json
+      begin
+        request = Net::HTTP::Post.new(@path, initheader = {'Content-Type' => 'application/json'})
+        request.body = @body
+        response = Net::HTTP.new(RkCucumber::Config.config[:report_server_host],
+                                 RkCucumber::Config.config[:report_server_port]).start {|http| http.request(request)}
+
+        RkCucumber::Messages.info_message_to_client(response, message_to_client)
+        JSON.parse(response.body)
+      rescue
+        RkCucumber::Messages.warn_problem_with_rk
+        false
+      end
+    end
+
+    def send_screenshot(screenshot_path)
+      begin
+        params = {project: @revision['project_id'], revision: @revision['revision_id'], test: @test['id']}
+        RestClient.post("http://#{RkCucumber::Config.config[:report_server_host]}:#{RkCucumber::Config.config[:report_server_port]}/api/tests/upload_screenshot",
+                        :name_of_file_param => File.new(screenshot_path), :body => params)
+        File.delete(screenshot_path)
+      rescue
+        RkCucumber::Messages.error_send_screenshot
+      end
+    end
+
+    def add_test_to_tmp(scenario, test_started_at)
+      @tmp_data[:tests] << @data_generator.test_data(scenario, @revision, test_started_at)
+      RkCucumber::Messages.error_not_sent_scenario(@tmp_data[:tests].count)
+    end
+  end
+end

data/lib/results_keeper/test_data_generator.rb

@@ -0,0 +1,67 @@
+require_relative 'config'
+require_relative 'messages'
+
+module RkCucumber
+  class TestDataGenerator
+
+    SCENARIO_HOOKS = 'Before hook  After hook  Around hook'
+
+    def revision_data
+      { revision: RkCucumber::Config.config[:revision_name], project: RkCucumber::Config.config[:project_name] }
+    end
+
+    def revision_completed_data
+      { revision: RkCucumber::Config.config[:revision_name], project: RkCucumber::Config.config[:project_name], completed: 1 }
+    end
+
+    def test_data(scenario, revision, test_started_at)
+      revision ||= { revision_id: nil }
+      test_duration = Time.now - test_started_at
+      scenario_error = scenario.exception.message if scenario.exception
+      run_path = "cucumber #{scenario.location.file}:#{scenario.location.line}"
+      {
+        name: scenario.name,
+        status: scenario.status,
+        feature_name: scenario.feature.name,
+        run_path: run_path,
+        tags: scenario.tags.map(&:name).join(', '),
+        error: scenario_error,
+        revision_id: revision['revision_id'],
+        steps: scenario_steps(scenario),
+        duration: test_duration
+      }
+    end
+
+    def save_screenshot(scenario)
+      if scenario.exception
+        begin
+          screenshot_name = "#{Time.now.to_i}_#{rand(1000..9999)}.png"
+          @file_path = "tmp/screenshots/#{screenshot_name}"
+          Capybara.page.save_screenshot(@file_path)
+          @file_path
+        rescue
+          RkCucumber::Messages.take_screenshot_error
+          nil
+        end
+      end
+    end
+
+    private
+
+    def step_keyword(test_step)
+      test_step.source.last.keyword
+    end
+
+    def scenario_steps(scenario)
+      steps = []
+      scenario.test_steps.each do |test_step|
+        if test_step.to_s.include? 'Cucumber::Core::Test'
+          steps << "#{step_keyword(test_step)} #{test_step.name.to_s}" unless SCENARIO_HOOKS.include?(test_step.name.to_s)
+        else
+          steps << "#{step_keyword(test_step)} #{test_step.to_s}" unless SCENARIO_HOOKS.include?(test_step.to_s)
+        end
+      end
+      steps
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: results_keeper
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Ivan Kozakov
+- Volodymyr Zubchynskyi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flickraw
@@ -46,8 +47,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/results_keeper.rb
-- lib/string.rb
-- lib/test_data_generator.rb
+- lib/results_keeper/config.rb
+- lib/results_keeper/messages.rb
+- lib/results_keeper/results_sender.rb
+- lib/results_keeper/string.rb
+- lib/results_keeper/test_data_generator.rb
 homepage: https://bitbucket.org/results_keeper/results_keeper_cucumber/
 licenses:
 - MIT
@@ -68,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Result Keeper

data/lib/test_data_generator.rb

@@ -1,67 +0,0 @@
-class TestDataGenerator
-
-  SCENARIO_HOOKS = 'Before hook  After hook  Around hook'
-
-  attr_reader :project_name, :revision_name
-
-  def initialize
-    @project_name ||= ENV['RK_PROJECT_NAME'] || default_project_name
-    @revision_name ||= ENV['RK_REVISION_NAME'] || "Result for #{Time.now}"
-  end
-
-  def revision_data
-    { revision: @revision_name, project: @project_name }
-  end
-
-  def revision_completed_data
-    { revision: @revision_name, project: @project_name, completed: 1 }
-  end
-
-  def test_data(scenario, revision)
-    test_duration = Time.now - @test_started_at
-    scenario_error = scenario.exception.message if scenario.exception
-    run_path = "cucumber #{scenario.location.file}:#{scenario.location.line}"
-    {
-      name: scenario.name,
-      status: scenario.status,
-      feature_name: scenario.feature.name,
-      run_path: run_path,
-      tags: scenario.tags.map(&:name).join(', '),
-      error: scenario_error,
-      revision_id: revision['revision_id'],
-      steps: scenario_steps(scenario),
-      duration: test_duration
-    }
-  end
-
-  def test_started(scenarion=nil)
-    @test_started_at = Time.now
-  end
-
-  private
-
-  def step_keyword(test_step)
-    test_step.source.last.keyword
-  end
-
-  def scenario_steps(scenario)
-    steps = []
-    scenario.test_steps.each do |test_step|
-      if test_step.to_s.include? 'Cucumber::Core::Test'
-        steps << "#{step_keyword(test_step)} #{test_step.name.to_s}" unless SCENARIO_HOOKS.include?(test_step.name.to_s)
-      else
-        steps << "#{step_keyword(test_step)} #{test_step.to_s}" unless SCENARIO_HOOKS.include?(test_step.to_s)
-      end
-    end
-    steps
-  end
-
-
-  def default_project_name
-    begin
-      `pwd`.strip.split('/').last
-    rescue
-      'Default'
-    end
-  end
-end