dromedary 0.1.00

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7c4953cb5e750a7e289cb591ab50655cad5920e
+  data.tar.gz: e6c1dcf1798ea13779f1759c9bbff33bce912275
+SHA512:
+  metadata.gz: 7dc7fbae20ef3d331e3f27bd6e2779b7613193f275b4a8bd8602f63bdf81a57c7958d00120d8afb4d9da4422843e94c13872c2b07b6889942b26715c457270f9
+  data.tar.gz: 3bd2f99b43dc908f165597c91cbad255bc4936cd41189179fe2c3fcab8bc36fe45304579ce7fc7e97a0f92e2ed7f2f8ab13ccb6b1f721a8039625c28ba12e0d3

data/bin/dromedary

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'dromedary'
+Dromedary.init(ARGV[0])

data/lib/dromedary.rb

@@ -0,0 +1,29 @@
+require 'rake'
+require_relative 'dromedary_initializer'
+
+class Dromedary
+  include DromedaryInitializer
+
+  def self.init(options)
+    case options
+    when '--init'
+      show_init_msg
+      initialize_project
+    else
+      welcome
+    end
+  end
+
+  def self.welcome
+    puts 'Hello world! I am a wild Dromedary!'
+    puts 'If you like to take a ride, you will need to run "dromedary --init" first'
+  end
+
+  def self.initialize_project
+    DromedaryInitializer.run
+  end
+
+  def self.show_init_msg
+    puts 'Initializes folder structure and generates files for Dromedary reporting'
+  end
+end

data/lib/dromedary_initializer.rb

@@ -0,0 +1,165 @@
+module DromedaryInitializer
+  def self.run
+    if cucumber_initialized?
+      report_no_cucumber_found
+    elsif already_initialized?
+      report_already_initialized
+    else
+      create_file 'config/dromedary.yml'
+      create_file 'features/support/dromedary_hooks.rb'
+
+      update_file 'config/dromedary.yml', dromedary_config_content
+      update_file 'features/support/dromedary_hooks.rb', dromedary_hooks_content
+    end
+  end
+
+  def self.create_directory(dir_name)
+    create_directory_or_file dir_name, true
+  end
+
+  def self.create_file(file_name)
+    create_directory_or_file file_name, false
+  end
+
+  def self.create_directory_or_file(file_name, directory)
+    file_type = if directory
+                  :mkdir_p
+                else
+                  :touch
+                end
+
+    report_exists(file_name) || return if File.exist?(file_name)
+
+    report_creating(file_name)
+    FileUtils.send file_type, file_name
+  end
+
+  def self.update_file(file_name, content)
+    open(file_name, 'a') do |file|
+      content.flatten!.each do |line|
+        file.puts line
+      end
+    end
+
+    report_updating(file_name)
+  end
+
+  def self.cucumber_initialized?
+    !File.exist?('features/support/env.rb')
+  end
+
+  def self.already_initialized?
+    File.exist?('config/dromedary.yml') || File.exist?('features/support/dromedary_hooks.rb')
+  end
+
+  def self.report_exists(file)
+    puts "     exist   #{file}"
+  end
+
+  def self.report_creating(file)
+    puts "  creating   #{file}"
+  end
+
+  def self.report_updating(file)
+    puts "  updating   #{file}"
+  end
+
+  def self.report_no_cucumber_found
+    puts "  Dromedary had searched all Sahara desert for Cucumber, but didn't found it"
+    puts '  Are you sure that you had initialized Cucumber project?'
+    puts "  If not, try to run 'cucumber --init' first"
+  end
+
+  def self.report_already_initialized
+    puts '  Our suspicious Dromedary says that you have already initialized it'
+    puts "  There is no need to run 'dromedary -- init' command more than once"
+  end
+
+  def self.dromedary_config_content
+    ['# This file was generated by Dromedary gem',
+     '# It contains required settings to support TestRail integration',
+     '# Fill in each line with credentials of your TestRail account',
+     '',
+     dromedary_config_structure,
+     ' # By default Dromedary creates Test Runs on TestRail this way:',
+     ' # test_run_default_name + Suite Type + on Environment',
+     ' # So at the end you will get something like this:',
+     ' # "My_project Regression on Staging"']
+  end
+
+  def self.dromedary_config_structure
+    ['testrail:',
+     ' url:',
+     ' user:',
+     ' password:',
+     ' project_id:',
+     ' suite_id:',
+     ' test_run_default_name:']
+  end
+
+  def self.dromedary_hooks_content
+    ['# This file was generated by Dromedary gem',
+     '# It contains required Cucumber hooks to ensure that all reporting works',
+     '# Do not edit this file',
+     '',
+     dromedary_hooks_structure]
+  end
+
+  def self.dromedary_hooks_structure
+    [dromedary_before_hooks,
+     '',
+     dromedary_afterstep_hooks,
+     '',
+     dromedary_after_hooks]
+  end
+
+  def self.dromedary_before_hooks
+    ['Before do',
+     "  # setting environment to 'local' in order not to generate reporting",
+     "  # if you need individual reports, just put this variable to 'false'",
+     "  ENV['local'] ||= 'true'",
+     "  @local = ENV['local']",
+     '',
+     '  # creating results hash for TestRail',
+     '  @results = {}',
+     '  # and resetting passed steps count',
+     '  @passed_steps_count = 0',
+     'end']
+  end
+
+  def self.dromedary_afterstep_hooks
+    ['AfterStep do |step|',
+     '  @passed_steps_count += 1 if step.passed?',
+     'end']
+  end
+
+  def self.dromedary_after_hooks
+    ['After do |scenario|',
+     '  # updating results hash for TestRail after each scenario',
+     '  feature_name = scenario.feature.name',
+     '  scenario_name = scenario.name',
+     '',
+     '  scenario.test_steps.each do |step|',
+     "    if step.text != 'Before hook' && step.text != 'AfterStep hook'",
+     "      step_name = File.open(step.location.file).readlines[step.location.line-1].lstrip",
+     "      full_description = (feature_name + ' ' + scenario_name + ' ' + step_name).rstrip",
+     '      status_id = []',
+     '      status_id =  @passed_steps_count > 0 ? (status_id.push 1) : (status_id.push 5)',
+     '      if @results[ full_description ]',
+     '        @results[ full_description ].push(status_id).flatten!',
+     '      else',
+     '        @results[ full_description ] = status_id',
+     '      end',
+     '      @passed_steps_count -= 1',
+     '    end',
+     '  end',
+     '',
+     '  # setting TestRail to generate reports at specific folder',
+     "  unless @local == 'true'",
+     '    File.open("artifacts/test_rail_results/file_#{UUID.generate(:compact).to_s}.json", "w") do |file|',
+     '      file.puts @results.to_json',
+     '    end',
+     '  end',
+     'end']
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: dromedary
+version: !ruby/object:Gem::Version
+  version: 0.1.00
+platform: ruby
+authors:
+- Denys Bazarnyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-07 00:00:00.000000000 Z
+dependencies: []
+description: Dromedary is a helper gem which will unify and simplyfy test reporting
+  approaches for different Ruby Based Test Automation Solutions
+email: denys.bazarnyi@storecast.de
+executables:
+- dromedary
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/dromedary
+- lib/dromedary.rb
+- lib/dromedary_initializer.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Test reporting helper gem
+test_files: []