qat-cucumber 6.0.0

data/lib/qat/formatter/test_ids.rb

@@ -0,0 +1,93 @@
+require 'cucumber/formatter/io'
+require 'json'
+
+module QAT
+  module Formatter
+    class TestIds
+      include Cucumber::Formatter::Io
+
+      def initialize(runtime, path_or_io, options)
+        @io                 = ensure_io(path_or_io)
+        @tags               = []
+        @scenario_tags      = []
+        @no_test_id         = {}
+        @max_test_id        = 0
+        @duplicate_test_ids = {}
+        @test_id_mapping    = {}
+        @options            = options
+      end
+
+      def before_feature(feature)
+        @in_scenarios = false
+      end
+
+      def tag_name(tag_name)
+        @scenario_tags << tag_name if @in_scenarios
+      end
+
+      def after_tags(tags)
+        @in_scenarios = true unless @in_scenarios
+      end
+
+      def scenario_name(keyword, name, file_colon_line, source_indent)
+        if @scenario_tags.any? { |tag| tag.match(/@test#(\d+)/) }
+          id           = @scenario_tags.map { |tag| tag.match(/@test#(\d+)/) }.compact.first.captures.first.to_i
+          @max_test_id = id if id > @max_test_id
+
+          test_id_info = { name: name,
+                           path: file_colon_line }
+
+          if @test_id_mapping[id]
+            if @duplicate_test_ids[id]
+              @duplicate_test_ids[id] << test_id_info
+            else
+              @duplicate_test_ids[id] = [@test_id_mapping[id], test_id_info]
+            end
+          else
+            @test_id_mapping[id] = test_id_info
+          end
+
+        else
+          @no_test_id[name] = file_colon_line unless @scenario_tags.include?('@dummy_test')
+        end
+        @scenario_tags = []
+      end
+
+      def after_features(features)
+        publish_result
+        @io.flush
+      end
+
+      private
+      def publish_result
+        content = {
+          max:       @max_test_id,
+          untagged:  @no_test_id,
+          mapping:   Hash[@test_id_mapping.sort],
+          duplicate: Hash[@duplicate_test_ids.sort]
+        }
+
+        if @duplicate_test_ids.any?
+          dups_info = @duplicate_test_ids.map do |id, dups|
+            text = dups.map { |dup| "Scenario: #{dup[:name]} - #{dup[:path]}" }.join("\n")
+            "TEST ID #{id}:\n#{text}\n"
+          end
+
+          duplicates_info = <<-TXT.gsub(/^\s*/, '')
+          ------------------------------------
+          Duplicate test ids found!
+          ------------------------------------
+          #{dups_info.join("\n")}
+          TXT
+          puts duplicates_info
+        end
+
+        @io.puts(content.to_json({
+                                   indent:    ' ',
+                                   space:     ' ',
+                                   object_nl: "\n"
+                                 }))
+      end
+    end
+  end
+end

data/lib/qat/jenkins.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+
+require 'qat/logger'
+require_relative 'cucumber/version'
+
+module QAT
+
+  #Jenkins helper. Should be required by the Cucumber module then running tests in a Jenkins server.
+  #@since 0.1.0
+  module Jenkins
+
+    #Default Jenkins environment variables to add register in the +QAT::Logger+.
+    DEFAULT_ENV_VARS = [
+      'BUILD_NUMBER',
+      'BUILD_URL',
+      'NODE_NAME',
+      'JOB_NAME',
+      'SVN_REVISION',
+      'GIT_COMMIT'
+    ]
+
+
+    #Register Jenkins environment variables in the Log4r::MDC hash.
+    #By default only the {DEFAULT_ENV_VARS} will be registered.
+    #@param [Hash] opts Options to modify default registry
+    #@option opts [Array<String>] :ignore ([]) List of default environment variables to ignore.
+    #@option opts [Array<String>] :add ([]) List of non default environment variables to add.
+    #@since 0.1.0
+    #@see http://log4r.rubyforge.org/rdoc/log4r/rdoc/MDC.html Log4r MDC
+    def self.register_vars(opts={})
+      ignore_list = opts[:ignore] || []
+      add_list    = opts[:add] || []
+
+      list = DEFAULT_ENV_VARS + add_list - ignore_list
+
+      list.each do |var|
+        Log4r::MDC.put var, ENV[var] if ENV[var]
+      end
+
+    end
+
+  end
+end

data/lib/qat/project/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# QAT is a Cucumber-based toolkit for automating tests. (https://gitlab.readinessit.com:8083/qa-toolkit/qat-core)
+gem 'qat', '~> 2.0', '>= 2.0.0'
+
+# QAT-Web is a browser controller for Web testing (http://gitlab.readinessit.com:8083/qa-toolkit/qat-web)
+#gem 'qat-web', '~> 2.0',  '>= 2.0.0'
+
+# Ruby headless display interface (http://leonid.shevtsov.me/en/headless)
+#gem 'headless', '~> 2.3', '>= 2.3.1'
+
+# The next generation developer focused tool for automated testing of webapps (https://github.com/seleniumhq/selenium)
+#gem 'selenium-webdriver', '~> 2.53', '>= 2.53.4'

data/lib/qat/project/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+# -*- encoding : utf-8 -*-
+require 'qat/tasks'

data/lib/qat/project/config/cucumber.yml

@@ -0,0 +1,13 @@
+qat: &qat >
+  --format QAT::Formatter::Console
+  --format html --out public/index.html
+  --format junit --out public/
+  --strict
+
+standard: &standard >
+  --format html --out public/index.html
+  --format junit --out features/reports
+
+flat: &flat --format pretty
+
+default: *qat

data/lib/qat/project/config/default.yml

@@ -0,0 +1 @@
+env: 'env-dummy'

data/lib/qat/project/config/env-dummy/hosts.yml

@@ -0,0 +1,9 @@
+frontend:
+  host: 'frontend.app.domain'
+  username: 'admin'
+  password: 'admin'
+
+backend:
+  host: '192.168.x.x'
+  username: 'app'
+  password: 'app'

data/lib/qat/project/config/env-dummy/jenkins.yml

@@ -0,0 +1,7 @@
+#Uncomment the next lines to manipulate environment variables reported from jenkins
+#env_vars:
+#  add:
+#    - EXECUTOR_NUMBER
+#    - JENKINS_URL
+#  ignore:
+#    - SVN_REVISION

data/lib/qat/project/config/env-dummy/logger.yml

@@ -0,0 +1,23 @@
+ log4r_config:
+   loggers:
+     - name: QAT
+       level: INFO
+       outputters:
+       - QAT
+
+   outputters:
+     - name: QAT
+       type: QatConsoleOutputter
+       default: true
+       formatter:
+         type: QatFormatter
+         colors: true
+
+     - type: QatRemoteOutputter
+       name: ReqCoverage
+       gelf_server: "127.0.0.1"
+       gelf_port: 12202
+       facility: 'QAT Requirement Coverage'
+       formatter:
+         type: PatternFormatter
+         pattern: "%m"

data/lib/qat/project/config/env-dummy/time.yml

@@ -0,0 +1,11 @@
+sync:
+  host: 'sync.host.com'
+  kill_if_failed: false
+  method: 'ntp' #or 'ssh' or user defined method
+  #opts: #option for sync methods
+  #  username: ''
+  #  password: ''
+  #  port: 22 #default for SSH
+  #  command: 'date' #SSH only
+
+#zone: "Auckland" #As defined in http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html

data/lib/qat/project/features/feature.feature

@@ -0,0 +1,45 @@
+@epic#1 @feature#2 @user_story#3 @dummy_feature
+Feature: some feature
+  In order to do something
+  As someone
+  I want to specify scenarios
+
+  Background: Some option precondition
+    Given true
+
+  @test#4 @dummy_test
+  Scenario: true
+    When true
+    Then true
+
+  @test#5 @dummy_test
+  Scenario Outline: Many trues
+    When <true>
+    Then <true>
+  Examples:
+    | true |
+    | true |
+    | true |
+    | true |
+    | true |
+
+  @test#6 @dummy_test
+  Scenario: Some other trueness
+    When true
+    Then true
+
+  @test#7 @dummy_test
+  Scenario Outline: Regretion outline
+    When <true>
+    Then <true>
+  Examples:
+    | true |
+    | true |
+    | true |
+    | true |
+    | true |
+
+  @test#8 @dummy_test
+  Scenario: normal regretion
+    When true
+    Then true

data/lib/qat/project/features/step_definitions/steps.rb

@@ -0,0 +1,4 @@
+Given /^true$/ do
+    assert true
+end
+

data/lib/qat/project/features/support/env.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+require 'qat/cucumber'
+
+############################################
+# Requires for your code libraries go here #
+############################################

data/lib/qat/project/features/support/hooks.rb

@@ -0,0 +1,32 @@
+#-*- encoding : utf-8 -*-
+
+#Uncomment all necessary custom hooks
+
+# AfterConfiguration do
+#   # Your code here
+# end
+
+# Before do |scenario|
+#   # Your code here
+# end
+
+# Around do |scenario, block|
+#   # Your code here
+#
+#   #DON'T FORGET TO CALL THE SCENARIO'S BLOCK!!!!
+#   block.call
+
+#   # Your code here
+# end
+
+# After do |scenario|
+#   # Your code here
+# end
+
+# AfterStep do |step|
+#   # Your code here
+# end
+
+# at_exit do
+#   # Your code here
+# end

data/lib/qat/tasks/list.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env rake
+#encoding: utf-8
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rake/testtask'
+require_relative '../formatter/scenario/name'
+require_relative '../formatter/tags'
+
+namespace :qat do
+  namespace :list do
+    desc 'Lists scenarios by tag'
+    task :by_tag, :tag do |_, params|
+      tag = params[:tag]
+      raise ArgumentError.new "A tag is needed to execute the task!" unless tag
+      raise ArgumentError.new "Tag '#{tag}' is invalid!" unless tag.start_with?('@')
+      ENV['CUCUMBER_OPTS'] = nil
+      Cucumber::Rake::Task.new('by_tag', 'Lists scenarios by tag') do |task|
+        task.cucumber_opts = ['--no-profile',
+                              '--dry-run',
+                              '--format', 'QAT::Formatter::Scenario::Name',
+                              '--tags', tag]
+        task.fork          = false
+      end.runner.run
+    end
+
+    desc 'List all scenarios without tags'
+    task :untagged do
+      ENV['CUCUMBER_OPTS'] = nil
+      Cucumber::Rake::Task.new('untagged', 'List all scenarios without tags') do |task|
+        task.cucumber_opts = ['--no-profile',
+                              '--dry-run',
+                              '--format', 'QAT::Formatter::Tags']
+        task.fork          = false
+      end.runner.run
+    end
+
+    desc 'List all duplicated names for scenarios'
+    task :dup_names, [:path] do |_, args|
+      ENV['CUCUMBER_OPTS'] = nil
+      Cucumber::Rake::Task.new('dup_names', 'List all duplicated names for scenarios') do |task|
+        task.cucumber_opts = [args[:path],
+                              '--no-profile',
+                              '--dry-run',
+                              '--format', 'QAT::Formatter::Scenario::Name',
+                              '--out', 'scenarios.json'].compact
+        task.fork          = false
+      end.runner.run
+    end
+  end
+end

data/lib/qat/tasks/steps.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+#encoding: utf-8
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rake/testtask'
+
+namespace :qat do
+  namespace :steps do
+    desc 'Automatic validation step definitions for test scenarios'
+    task :validation do
+      ENV['CUCUMBER_OPTS'] = nil
+      Cucumber::Rake::Task.new('validation', 'Automatic validation step definitions for test scenarios') do |task|
+        task.bundler       = false
+        task.cucumber_opts = ['--no-profile',
+                              '--dry-run',
+                              '--format progress']
+      end.runner.run
+    end
+  end
+end

data/lib/qat/tasks/tags/test_ids/helpers.rb

@@ -0,0 +1,105 @@
+# namespace for test ids utility methods and objects
+module TestIds
+  # helper methods for test id manipulation
+  module Helpers
+    # Tags all untagged scenarios present in the test id report
+    #@param report [TestIds::Report] test id report
+    def tag_untagged(report)
+      max_test_id = report.max_id
+      untagged    = report.untagged
+
+      if untagged.any?
+        files = map_untagged(untagged)
+
+        announce_changes(files)
+
+        update_test_ids(files, max_test_id)
+      else
+        puts "There are no scenarios without test id. Last test id given was '@test##{max_test_id}'."
+      end
+    end
+
+    private
+    # Returns all files containing untagged scenarios and their respective scenario line
+    #@param untagged [Array] list of untagged scenarios
+    #@return [Array]
+    def map_untagged(untagged)
+      files = {}
+
+      untagged.values.each do |file_colon|
+        file, colon = file_colon.split(':')
+        files[file] ||= []
+        files[file] << colon.to_i
+      end
+
+      files
+    end
+
+    # Announces to STDOUT the files that will be changed (test ids added)
+    #@param files [Array] list of files to change
+    #@see TestIds::Helpers#map_untaged
+    def announce_changes(files)
+      puts "Giving test ids to scenarios:"
+      puts files.to_json({
+                           indent:    ' ',
+                           space:     ' ',
+                           object_nl: "\n"
+                         })
+    end
+
+    # Rewrites the untagged files adding the missing test ids
+    #@param files [Array] list of files to change
+    #@param max_test_id [Integer] current max test id
+    def update_test_ids(files, max_test_id)
+      #iterate in file to give test id
+      begin
+        file_lines = []
+        files.each { |file, lines| max_test_id = rewrite_file(file, lines, max_test_id) }
+      rescue
+        path = File.join(Dir.pwd, 'public', 'test_ids_failed.feature')
+        puts "Tag attribution failed! Check '#{path}' for more information!"
+        File.write(path, file_lines.join)
+      end
+    end
+
+    # Rewrites the target file in the identified lines.
+    # Returns the max test id after the file update.
+    #@param file [String] file to rewrite
+    #@param lines [Array] lines to edit (add test id)
+    #@param max_test_id [Integer] current max test id
+    #@return [Integer]
+    def rewrite_file(file, lines, max_test_id)
+      norm_lines = lines.map { |line| line - 1 }
+      file_path  = File.join(Dir.pwd, file)
+      file_lines = File.readlines(file_path)
+
+      norm_lines.size.times do
+        line = norm_lines.shift
+        puts "Editing file #{file} @ line #{line}."
+        max_test_id = add_tags(file_lines, line, max_test_id)
+      end
+
+      File.write(file_path, file_lines.join)
+
+      max_test_id
+    end
+
+    # Adds the test id tag to the identified line to edit
+    # Returns the max test id after the file update.
+    #@param file_lines [Array] Set of file lines
+    #@param line [Integer] index of line to edit
+    #@param max_test_id [Integer] current max test id
+    #@return [Integer]
+    def add_tags(file_lines, line, max_test_id)
+      if file_lines[line-1].match(/^\s*@\w+/)
+        file_lines[line-1] = "  #{file_lines[line-1].strip} @test##{max_test_id += 1}\n"
+      else
+        file_lines[line] = "  @test##{max_test_id += 1}\n#{file_lines[line]}"
+      end
+
+      max_test_id
+    end
+
+    extend self
+  end
+end

data/lib/qat/tasks/tags/test_ids/report.rb

@@ -0,0 +1,41 @@
+require_relative 'helpers'
+
+# namespace for test ids utility methods and objects
+module TestIds
+  # the test id report wrapper
+  class Report
+    include Helpers
+
+    attr_reader :path, :content
+
+    def initialize(path)
+      @path    = path
+      @content = JSON.parse(File.read(path))
+    end
+
+    # Returns the report max test id
+    def max_id
+      @max_id ||= @content['max']
+    end
+
+    # Returns the report untagged tests information
+    def untagged
+      @untagged ||= @content['untagged']
+    end
+
+    # Returns the report test id mapping to scenarios information
+    def mapping
+      @mapping ||= @content['mapping']
+    end
+
+    # Returns the report duplicate test id information
+    def duplicate
+      @duplicate ||= @content['duplicate']
+    end
+
+    # Tags all untagged scenario with a test id
+    def tag_untagged!
+      tag_untagged(self)
+    end
+  end
+end

data/lib/qat/tasks/tags/test_ids.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env rake
+#encoding: utf-8
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rake/testtask'
+require 'json'
+require 'fileutils'
+require 'awesome_print'
+require_relative '../../formatter/test_ids'
+require_relative 'test_ids/report'
+require_relative 'test_ids/helpers'
+
+namespace :qat do
+  namespace :tags do
+    def run_report_task!
+      begin
+        Rake::Task['qat:tags:report_test_ids'].invoke
+      rescue SystemExit => exception
+        exitstatus = exception.status
+        @kernel.exit(exitstatus) unless exitstatus == 0
+      end
+    end
+
+    desc 'Generates the test id report in JSON'
+    task :report_test_ids do
+      FileUtils.mkdir('public') unless File.exists?(File.join(Dir.pwd, 'public'))
+      ENV['CUCUMBER_OPTS'] = nil
+      Cucumber::Rake::Task.new('test_ids', 'Generates test ids as tags for tests without test id') do |task|
+        task.bundler       = false
+        task.fork          = false
+        task.cucumber_opts = ['--no-profile',
+                              '--dry-run',
+                              '--format', 'QAT::Formatter::TestIds',
+                              '--out', 'public/test_ids.json']
+      end.runner.run
+    end
+
+    desc 'Validates the existing test ids and checks for duplicates'
+    task :validate_test_ids do
+      run_report_task!
+      #read json file
+      file_path = File.realpath(File.join(Dir.pwd, 'public', 'test_ids.json'))
+      report    = TestIds::Report.new(file_path)
+
+      exitstatus = report.duplicate.any? ? 1 : 0
+
+      exit(exitstatus)
+    end
+
+    desc 'Generates test ids as tags for tests without test id'
+    task :test_ids do
+      run_report_task!
+      #read json file
+      file_path = File.realpath(File.join(Dir.pwd, 'public', 'test_ids.json'))
+      report    = TestIds::Report.new(file_path)
+
+      report.tag_untagged!
+    end
+  end
+end

data/lib/qat/tasks/tags.rb

@@ -0,0 +1,2 @@
+#encoding: utf-8
+require_relative 'tags/test_ids'

data/lib/qat/tasks/test.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+#encoding: utf-8
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rake/testtask'
+
+namespace :qat do
+  namespace :test do
+    def clear_reports_folder!
+      mkdir_p 'public'
+      rm_rf ::File.join('public', '*')
+    end
+
+    Cucumber::Rake::Task.new('run', 'Run all test scenarios')
+
+    desc 'Run a complete feature'
+    task :feature, :feature_name do |_, params|
+      feature_name = params[:feature_name]
+      raise ArgumentError.new "A feature is needed to execute the task!" unless feature_name
+      Cucumber::Rake::Task.new(:feature) do
+        ENV['FEATURE'] = Dir.glob(File.join('features', '**', "#{feature_name}.feature")).first
+      end.runner.run
+    end
+
+    desc 'Run all test scenarios containing given tags'
+    task :tags, :tags do |_, params|
+      tags = params[:tags].is_a?(String) ? [params[:tags]] : params[:tags].to_a
+      raise ArgumentError.new "A tag is needed to execute the task!" unless tags.any?
+      ENV['CUCUMBER_OPTS'] = "#{ENV['CUCUMBER_OPTS']} --tags #{tags.join(',')}"
+      Cucumber::Rake::Task.new('run', 'Run all test scenarios containing given tags') do |task|
+        task.bundler = false
+      end.runner.run
+    end
+  end
+end

data/lib/qat/tasks.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+#encoding: utf-8
+#@version 1.0
+require_relative 'cucumber/core_ext/result'
+require_relative 'tasks/list'
+require_relative 'tasks/steps'
+require_relative 'tasks/tags'
+require_relative 'tasks/test'