dromedary 0.1.00 → 0.3.01

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7c4953cb5e750a7e289cb591ab50655cad5920e
-  data.tar.gz: e6c1dcf1798ea13779f1759c9bbff33bce912275
+  metadata.gz: fea21242953b1f423fb38f9d24aa1b444c540469
+  data.tar.gz: 868bab3b50c29e45f3dac3a96dab2b60cde378b8
 SHA512:
-  metadata.gz: 7dc7fbae20ef3d331e3f27bd6e2779b7613193f275b4a8bd8602f63bdf81a57c7958d00120d8afb4d9da4422843e94c13872c2b07b6889942b26715c457270f9
-  data.tar.gz: 3bd2f99b43dc908f165597c91cbad255bc4936cd41189179fe2c3fcab8bc36fe45304579ce7fc7e97a0f92e2ed7f2f8ab13ccb6b1f721a8039625c28ba12e0d3
+  metadata.gz: dedb64bf51d47651dd8331f394a2ac02fce2aeea987a59869d40a58212cb1752e06b1d0d3b56269d996a10338001c44e2a2954c77ad2de4a68a5a729fd7f31a1
+  data.tar.gz: 21d7bef695d7c24b972cf3d1da30eda87a82fc3c6263dd3f5d580eaf0f61b42c6a0a5ee0e5c4b7a39f73aa406cef919fdd2d5efe7054935d45e93ae87a8189ac

data/lib/dromedary/tasks.rb

@@ -0,0 +1,11 @@
+require 'rake'
+
+module Dromedary
+  class Tasks
+    include Rake::DSL if defined? Rake::DSL
+    def install_tasks
+      load 'tasks/dromedary.rake'
+    end
+  end
+end
+Dromedary::Tasks.new.install_tasks

data/lib/dromedary_initializer.rb

@@ -1,15 +1,23 @@
 module DromedaryInitializer
   def self.run
-    if cucumber_initialized?
+    if cucumber_not_initialized?
       report_no_cucumber_found
     elsif already_initialized?
       report_already_initialized
     else
+      create_directory 'config'
       create_file 'config/dromedary.yml'
       create_file 'features/support/dromedary_hooks.rb'
+      create_file 'config/cucumber.yml'
+      create_file 'Rakefile'
 
       update_file 'config/dromedary.yml', dromedary_config_content
       update_file 'features/support/dromedary_hooks.rb', dromedary_hooks_content
+
+      update_file 'config/cucumber.yml', cucumber_config_content
+      update_file '.gitignore', gitignore_content
+      update_file 'Rakefile', rakefile_content
+      update_file 'Gemfile', gemfile_content
     end
   end
 
@@ -44,7 +52,7 @@ module DromedaryInitializer
     report_updating(file_name)
   end
 
-  def self.cucumber_initialized?
+  def self.cucumber_not_initialized?
     !File.exist?('features/support/env.rb')
   end
 
@@ -156,10 +164,65 @@ module DromedaryInitializer
      '',
      '  # 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.open("artifacts/testrail_reports/file_#{Time.now.to_i}.json}.json", "w") do |file|',
      '      file.puts @results.to_json',
      '    end',
      '  end',
      'end']
   end
+
+  def self.cucumber_config_content
+    ['',
+     '# Following lines were generated by Dromedary gem',
+     '# It contains required Cucumber profiles to ensure that all reporting works',
+     '',
+     cucumber_config_structure]
+  end
+
+  def self.cucumber_config_structure
+    ['junit_report: --format pretty --format junit --out artifacts/junit_xml_reports',
+     'run_json_report: --format json --out artifacts/cucumber_json_reports/run.json',
+     'rerun_json_report: --format json --out artifacts/cucumber_json_reports/rerun.json',
+     'rerun_formatter: --format rerun --out artifacts/final_test_reports/fails.log']
+  end
+
+  def self.gitignore_content
+    ['',
+     gitignore_structure]
+  end
+
+  def self.gitignore_structure
+    ['artifacts/']
+  end
+
+  def self.rakefile_content
+    ['',
+     '',
+     '# require Dromedary gem dependencies',
+     rakefile_structure]
+  end
+
+  def self.rakefile_structure
+    ["require 'dromedary/tasks'",
+     '',
+     '# describing Dromedary rake tasks',
+     "desc 'Rake task to run all the Dromedary sequence'",
+     'task :run_dromedary, :run_on do |task, args|',
+     '  ENV["RUN_ON"] = "#{args[:run_on]}"',
+     '  %W[prepare_for_a_ride store_cases_titles run_cucumber merge_junit_reports get_case_ids[run] rerun_if_needed generate_cucumber_json_reports create_run[smoke,#{args[:run_on]}] close_run[#{args[:run_on]}] final_clean_ups].each do |task_name|',
+     '    sh "rake #{task_name}" do',
+     '      #ignore errors',
+     '    end',
+     '  end',
+     'end']
+  end
+
+  def self.gemfile_content
+    ['',
+     gemfile_structure]
+  end
+
+  def self.gemfile_structure
+    ["gem 'junit_merge'"]
+  end
 end

data/lib/tasks/dromedary.rake

@@ -0,0 +1,267 @@
+require 'nokogiri'
+require 'yaml'
+require_relative '../testrail'
+
+DROMEDARY = YAML.load_file("#{Dir.pwd}/config/dromedary.yml")
+
+# TASKS
+
+# Preparation tasks
+
+desc 'This task creates required folders and files'
+task :prepare_for_a_ride do
+  %W[create_folders create_files].each do |task_name|
+    sh "rake #{task_name}" do
+      #ignore errors
+    end
+  end
+end
+
+desc 'This task creates required folder tree for reporting'
+task :create_folders do
+  %W[artifacts artifacts/cucumber_json_reports artifacts/junit_xml_reports artifacts/testrail_reports artifacts/final_test_reports].each do |dir_name|
+    Dir.mkdir "#{dir_name}"
+  end
+end
+
+desc 'This task creates and updates required files for reporting'
+task :create_files do
+  %W[artifacts/cucumber_json_reports/run.json artifacts/cucumber_json_reports/rerun.json artifacts/final_test_reports/final_cucumber_json_report.json artifacts/final_test_reports/run_results_with_case_id.json artifacts/final_test_reports/rerun_results_with_case_id.json artifacts/final_test_reports/test_cases.json].each do |file_name|
+    File.open(file_name, 'w') do |file|
+      file.puts '[]'
+    end
+  end
+  File.open('artifacts/final_test_reports/final_junit_report.xml', 'w') do |file|
+    xml_structure.each do |line|
+      file.puts line
+    end
+  end
+end
+
+desc 'Saving Test cases from remote TestRail project'
+task :store_cases_titles do
+  @client = TestRail::APIClient.new(DROMEDARY['testrail']['url'])
+  @client.user = DROMEDARY['testrail']['user']
+  @client.password = DROMEDARY['testrail']['password']
+
+  project_id = DROMEDARY['testrail']['project_id']
+  suite_id = DROMEDARY['testrail']['suite_id']
+  cases = @client.get_cases_for_suite(project_id, suite_id)
+  @full_cases = @client.get_cases_titles(cases, project_id, suite_id)
+
+  File.open('artifacts/final_test_reports/test_cases.json', 'w') do |file|
+    require 'json'
+    file.puts @full_cases.to_json
+  end
+end
+
+# Runner tasks
+
+desc 'Run Cucumber features for the first run'
+task :run_cucumber do
+  sh "cucumber -p junit_report -p rerun_formatter -p run_json_report" do
+    #ignore errors
+  end
+end
+
+desc 'Rerun Cucumber features according to the fails.log'
+task :rerun_failed do
+  sh "cucumber @artifacts/final_test_reports/fails.log -p junit_report -p rerun_json_report" do
+    #ignore errors
+  end
+end
+
+task :rerun_if_needed do
+  if File.file?("artifacts/final_test_reports/fails.log")
+    if File.read("artifacts/final_test_reports/fails.log").empty?
+      puts 'Rerun step skipped, no fails occurred during the first run'
+    else
+      fails = File.read("artifacts/final_test_reports/fails.log")
+
+      File.open('artifacts/final_test_reports/fails.log', 'w') do |file|
+        file.puts fails.gsub('\n', ' ')
+      end
+
+      sh "rake rerun_and_update_reports" do
+        #ignore errors
+      end
+    end
+  else
+    puts 'Rerun step skipped, no fails occurred during the first run'
+  end
+end
+
+desc 'Rerun failed Cucumber features and update respective reports'
+task :rerun_and_update_reports do
+  %W[clean_interim_reports rerun_failed merge_junit_reports get_case_ids[rerun]].each do |task_name|
+    sh "rake #{task_name}" do
+      #ignore errors
+    end
+  end
+end
+
+# Cleaning tasks
+
+desc 'Cleaning all interim reports'
+task :clean_interim_reports do
+  %W[clean_test_rail clean_junit].each do |task_name|
+    sh "rake #{task_name}" do
+      #ignore errors
+    end
+  end
+end
+
+desc 'Cleaning interim TestRail reports'
+task :clean_test_rail do
+  catalog = 'artifacts/testrail_reports'
+  files = Dir.entries(catalog).delete_if { |entry| File.directory?(entry) }
+  files.map! { |f| "#{catalog}/#{f}" }
+  rm files
+end
+
+desc 'Cleaning interim JUnit reports'
+task :clean_junit do
+  catalog = 'artifacts/junit_xml_reports'
+  files = Dir.entries(catalog).delete_if { |entry| File.directory?(entry) }
+  files.map! { |f| "#{catalog}/#{f}" }
+  rm files
+end
+
+desc 'Cleaning interim Cucumber JSON reports'
+task :clean_cucumber_json do
+  catalog = 'artifacts/cucumber_json_reports'
+  files = Dir.entries(catalog).delete_if { |entry| File.directory?(entry) }
+  files.map! { |f| "#{catalog}/#{f}" }
+  rm files
+end
+
+desc 'Cleaning rudimentary folders'
+task :clean_folders do
+  catalog = 'artifacts'
+  dirs = Dir.entries(catalog).drop 2
+  dirs.delete('final_test_reports')
+  dirs.map! { |f| "#{catalog}/#{f}" }
+  dirs.each do |dir_path|
+    remove_dir dir_path
+  end
+end
+
+desc 'Cleaning project tree from unnecessary files and folders'
+task :final_clean_ups do
+  %W[clean_test_rail clean_junit clean_cucumber_json clean_folders].each do |task_name|
+    sh "rake #{task_name}" do
+      #ignore errors
+    end
+  end
+end
+
+# Report generation tasks
+
+desc 'Merging interim JUnit reports to final JUnit report'
+task :merge_junit_reports do
+  file_names = Dir.entries('artifacts/junit_xml_reports').delete_if { |entry| File.directory?(entry) }
+  file_names.each do |file_name|
+    sh "junit_merge artifacts/junit_xml_reports/#{file_name} artifacts/final_test_reports/final_junit_report.xml" do
+      #ignore errors
+    end
+  end
+end
+
+desc 'Merging interim Cucumber json reports to final Cucumber json report'
+task :generate_cucumber_json_reports do
+  test_results = []
+
+  run_results = JSON.parse(File.read('artifacts/cucumber_json_reports/run.json'))
+  rerun_results = JSON.parse(File.read('artifacts/cucumber_json_reports/rerun.json'))
+
+  run_results.each do |x|
+    rerun_results.each do |y|
+      if y.values[0] == x.values[0]
+        x.merge!(y)
+      end
+    end
+    test_results.push(x)
+  end
+
+  File.open('artifacts/final_test_reports/final_cucumber_json_report.json', 'w') do |file|
+    require 'json'
+    file.puts test_results.to_json
+  end
+end
+
+desc 'Generating interim TestRail report for a particular run'
+task :get_case_ids, :run_type do |task, args|
+  @test_results = {}
+  file = File.read('artifacts/final_test_reports/test_cases.json')
+  @full_cases = JSON.parse(file)
+
+  file_names = Dir.entries('artifacts/testrail_reports').delete_if { |entry| File.directory?(entry) }
+  file_names.each do |file_name|
+    result = JSON.parse(File.read("artifacts/testrail_reports/#{file_name}"))
+    @test_results.update(result)
+  end
+
+  @results_json = []
+  @test_results.map do |full_desc,status_id|
+    n = 0
+    until n == status_id.count do
+      current_result = {:case_id => find_id(full_desc)[n], :status_id => status_id[n] } if find_id(full_desc)
+      @results_json.push(current_result)
+      n += 1
+    end
+  end
+
+  @results_json.compact!
+  File.open("artifacts/final_test_reports/#{args[:run_type]}_results_with_case_id.json", 'w') do |file|
+    file.write(@results_json.to_json)
+  end
+end
+
+desc 'Creating Test Run on remote TestRail project'
+task :create_run, :suite_type, :environment, :section_name do |task, args|
+  @client = TestRail::APIClient.new(DROMEDARY['testrail']['url'])
+  @client.user = DROMEDARY['testrail']['user']
+  @client.password = DROMEDARY['testrail']['password']
+  project_id = DROMEDARY['testrail']['project_id']
+  suite_id = DROMEDARY['testrail']['suite_id']
+
+  test_run_name =  DROMEDARY['testrail']['test_run_default_name'] + ' ' + args[:suite_type].capitalize + ' on ' + args[:environment].capitalize
+  test_run = @client.add_run(project_id, suite_id, test_run_name)
+  file = File.open('artifacts/final_test_reports/test_run_id.txt', File::CREAT|File::TRUNC|File::RDWR)
+  file.puts test_run['id']
+  file.close
+end
+
+desc 'Closing Test Run on remote TestRail project'
+task :close_run, :environment do
+  @client = TestRail::APIClient.new(DROMEDARY['testrail']['url'])
+  @client.user = DROMEDARY['testrail']['user']
+  @client.password = DROMEDARY['testrail']['password']
+
+  run_results = JSON.parse(File.read('artifacts/final_test_reports/run_results_with_case_id.json'))
+  rerun_results = JSON.parse(File.read('artifacts/final_test_reports/rerun_results_with_case_id.json'))
+  test_results = run_results + rerun_results
+
+  run_id = File.new('artifacts/final_test_reports/test_run_id.txt').read.chomp
+  @client.add_results_for_cases(run_id, test_results)
+  @client.mark_untested_tests_failed(run_id)
+  @client.close_run(run_id, data = {})
+end
+
+# METHODS
+
+def xml_structure
+  ['<?xml version="1.0" encoding="UTF-8"?>',
+   '<testsuite name="" tests="" failures="" errors="" time="" timestamp="">',
+   '  <!-- Randomized with seed 00000 -->',
+   '  <properties/>',
+   '</testsuite>']
+end
+
+def find_id(full_title)
+  @ids_array = []
+  @full_cases.select {|c| c['title'] == full_title.gsub('  ', ' ')}.each do |e|
+    @ids_array << e['id']
+  end
+  @ids_array unless @ids_array.empty?
+end

data/lib/testrail.rb

@@ -0,0 +1,264 @@
+#
+# TestRail API binding for Ruby (API v2, available since TestRail 3.0)
+#
+# Learn more:
+#
+# http://docs.gurock.com/testrail-api2/start
+# http://docs.gurock.com/testrail-api2/accessing
+#
+# Copyright Gurock Software GmbH. See license.md for details.
+#
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module TestRail
+  class APIClient
+    @url = ''
+    @user = ''
+    @password = ''
+
+    attr_accessor :user
+    attr_accessor :password
+
+    def initialize(base_url)
+      if !base_url.match(/\/$/)
+        base_url += '/'
+      end
+      @url = base_url + 'index.php?/api/v2/'
+    end
+
+    def add_run(project_id, suite_id, test_run_name, section_id=nil)
+      cases_ids = section_id ? get_all_cases(project_id, suite_id, section_id) : get_cases_for_suite(project_id, suite_id).map {|item| item['id']}
+      data = {'suite_id'=> suite_id, 'name' => test_run_name,'include_all'=>false, 'case_ids' => cases_ids }
+      send_post("add_run/#{project_id}", data)
+    end
+
+    def get_all_cases(project_id, suite_id, section_id)
+      all_sections = get_all_inherited_sections(project_id, suite_id, section_id)
+      cases_ids = []
+      all_sections.uniq!
+      all_sections.each do |section|
+        cases_ids += get_cases_for_section(project_id, suite_id, section)
+      end
+      cases_ids
+    end
+
+    def get_cases_for_suite(project_id, suite_id)
+      send_get("get_cases/#{project_id}&suite_id=#{suite_id}")
+    end
+
+    def get_cases_for_section(project_id, suite_id, section_id)
+      send_get("get_cases/#{project_id}&suite_id=#{suite_id}&section_id=#{section_id}").map {|item| item['id']}
+    end
+
+    def get_all_inherited_sections(project_id, suite_id, section_id)
+      hash = sections_hash(project_id, suite_id)
+      to_preceed = hash['entries'].find{|el| el['id'] == section_id}
+      results = []
+      get_entries_array to_preceed, results
+      results.map { |el| el['id']}
+    end
+
+    def get_cases_titles(cases, project_id, suite_id)
+      sections = get_sections(project_id, suite_id)
+      full_cases = []
+      cases.each do |c|
+        c['title'] = full_title(c, sections)
+        full_cases << c
+      end
+
+      full_cases
+    end
+
+    def add_results_for_cases(run_id, test_rail_results)
+      data = {}
+      data[:results] = test_rail_results
+      send_post("add_results_for_cases/#{run_id}", data)
+    end
+
+    def full_title(case_hash, sections)
+      parent_section_id = case_hash['section_id']
+      results = []
+      section = sections.find do |sec|
+        sec['id'] == parent_section_id
+      end
+
+      get_full_sections_title_for(section, sections, results)
+      results.push(case_hash['title']).join(' ')
+    end
+
+    def get_section(section_id)
+      send_get("get_section/#{section_id}")
+    end
+
+    def get_full_sections_title_for(section, sections, results)
+      results.unshift(section['name'])
+      unless section['depth'] == 0
+        parent_section = parent_section(section, sections)
+        get_full_sections_title_for(parent_section, sections, results)
+      end
+    end
+
+
+    def get_entries_array(node, results)
+      results << node
+      node['entries'].each do |entry|
+        results << entry
+        unless entry['entries'].empty?
+          get_entries_array(entry, results)
+        end
+      end
+    end
+
+    def parent_section(section, sections)
+      sections.find { |sec| sec['id'] == section['parent_id'] }
+    end
+
+    def build_hash(node, array)
+      nodes_to_proceed = array.select do |section|
+        section['parent_id'] == node['id']
+      end
+
+      nodes_to_proceed.each do |n|
+        node['entries'] << n
+        array.delete n
+        build_hash(n, array)
+      end
+    end
+
+
+    def sections_hash(project_id, suite_id)
+      all_sections = get_sections(project_id, suite_id)
+      all_sections.map! {|el| el['entries'] =[]; el}
+      main = all_sections.find {|el| el['depth'] == 0}
+      all_sections.delete(main)
+      build_hash(main, all_sections)
+      main
+    end
+
+    def get_section_id(project_id, suite_id, section_title)
+      all_sections = get_sections(project_id, suite_id)
+      all_sections.find{|section| section['name'] == section_title}['id']
+    end
+
+    def get_sections(project_id, suite_id)
+      send_get("get_sections/#{project_id}&suite_id=#{suite_id}")
+    end
+
+    def add_result_for_case(run_id, case_id, data)
+      send_post("add_result_for_case/#{run_id}/#{case_id}", data)
+    end
+
+    def close_run(run_id, data)
+      send_post("close_run/#{run_id}", data)
+    end
+
+    def mark_untested_tests_failed(run_id)
+      tests = get_untested_tests(run_id)
+      return if tests.empty?
+      tests_ids = tests.map {|t| t['id']}
+      mark_failed_tests_for_run(run_id, tests_ids)
+    end
+
+    def add_milestone(project_id, ms_name)
+      data = {"name"=> ms_name + Time.now.strftime("_%H/%M/%S_%d/%m/%Y")}
+      response = send_post("add_milestone/#{project_id}", data)
+      response['id']
+    end
+
+    def close_milestone(ms_id)
+      data = {'is_completed' => true}
+      send_post("update_milestone/#{ms_id}", data)
+    end
+
+    def mark_failed_tests_for_run(run_id, tests_ids)
+      data = {}
+      data['results'] = []
+      tests_ids.each do |id|
+        data['results'] << {'test_id'=>id, 'status_id'=>5}
+      end
+      send_post("add_results/#{run_id}", data)
+    end
+
+    def get_untested_tests(run_id)
+      send_get("get_tests/#{run_id}&status_id=3")
+    end
+
+
+    #
+    # Send Get
+    #
+    # Issues a GET request (read) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. get_case/1)
+    #
+    def send_get(uri)
+      _send_request('GET', uri, nil)
+    end
+
+    #
+    # Send POST
+    #
+    # Issues a POST request (write) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. add_case/1)
+    # data                The data to submit as part of the request (as
+    #                     Ruby hash, strings must be UTF-8 encoded)
+    #
+    def send_post(uri, data)
+      _send_request('POST', uri, data)
+    end
+
+    private
+    def _send_request(method, uri, data)
+      url = URI.parse(@url + uri)
+      if method == 'POST'
+        request = Net::HTTP::Post.new(url.path + '?' + url.query)
+        request.body = JSON.dump(data)
+      else
+        request = Net::HTTP::Get.new(url.path + '?' + url.query)
+      end
+      request.basic_auth(@user, @password)
+      request.add_field('Content-Type', 'application/json')
+
+      conn = Net::HTTP.new(url.host, url.port)
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      response = conn.request(request)
+
+      if response.body && !response.body.empty?
+        result = JSON.parse(response.body)
+      else
+        result = {}
+      end
+
+      if response.code != '200'
+        if result && result.key?('error')
+          error = '"' + result['error'] + '"'
+        else
+          error = 'No additional error message received'
+        end
+        raise APIError.new('TestRail API returned HTTP %s (%s)' %
+                               [response.code, error])
+      end
+
+      result
+    end
+  end
+
+  class APIError < StandardError
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dromedary
 version: !ruby/object:Gem::Version
-  version: 0.1.00
+  version: 0.3.01
 platform: ruby
 authors:
 - Denys Bazarnyi
@@ -20,8 +20,11 @@ extra_rdoc_files: []
 files:
 - bin/dromedary
 - lib/dromedary.rb
+- lib/dromedary/tasks.rb
 - lib/dromedary_initializer.rb
-homepage: 
+- lib/tasks/dromedary.rake
+- lib/testrail.rb
+homepage: http://rubygems.org/gems/dromedary
 licenses:
 - MIT
 metadata: {}