qTestScenarioRuby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc6e9dfd1295fe83365f0b536090eb6d4e31a38b
+  data.tar.gz: 3e9153475ba0e4582ebb70d687f077d7365898b5
+SHA512:
+  metadata.gz: a42ed9e488d80870624113340c604b425d7239030680249f106ccffe7d8e7478ac05bb9c7feff1447f4fca625c76d2a478d1f61ee723f6192478123c8d8ac0fa
+  data.tar.gz: d0f64e914993f1b78e335d143e464d04baf4ea6e8eca556e76af78eefa52036a13f5a8146123094cbf1064e1e2250557c3a48e6f0e84a12afaadfa0aa0e08b67

data/lib/configuration/constants.rb

@@ -0,0 +1,33 @@
+module QspecResult
+  PASSED = 'PASSED'
+  UNCOMPLETED = 'UNCOMPLETED'
+  FAILED = 'FAILED'
+  SKIP = 'SKIP'
+end
+
+class Constants
+
+  def self.getMappingFileName
+    '.qtestscenario'
+  end
+
+  def self.getCreateExecutionUri
+    '/qspec/api/execution'
+  end
+
+  def self.getFeatureFilesUri
+    '/qspec/api/feature-file'
+  end
+
+  def self.getSubmitFeatureTestLogUri
+    '/qspec/api/feature/%s/test-log'
+  end
+
+  def self.getUpdateExecutionUri
+    '/qspec/api/execution/%s'
+  end
+
+  def self.getConfigFile
+    'config/config.yml'
+  end
+end

data/lib/logs/execution_log.rb

@@ -0,0 +1,28 @@
+
+class Time
+  def to_ms
+    (self.to_f * 1000.0).to_i
+  end
+end
+
+class ExecutionLog
+  attr_accessor :executionId, :startDate, :endDate, :host
+
+  def initialize
+    @host = Socket.gethostname
+    @startDate = Time.now.to_ms
+  end
+
+  def self.from_json data
+    executionLog = ExecutionLog.new
+    executionLog.executionId = data['execution_id']
+    executionLog.startDate = data['start_date']
+    executionLog.endDate = data['end_date']
+    executionLog.host = data['host']
+    executionLog
+  end
+
+  def to_json(options={})
+    {'execution_id' => @executionId, 'start_date' => @startDate, 'end_date' => @endDate, 'host' => @host}.to_json
+  end
+end

data/lib/logs/feature_log.rb

@@ -0,0 +1,29 @@
+class FeatureLog
+  attr_accessor :featureId, :result, :startDate, :endDate, :executionId, :scenarioLogs, :versionId,
+                :totalScenariosNumber, :currentScenariosNumber, :resultSet
+
+  def initialize
+    @currentScenariosNumber = 0
+    @scenarioLogs = []
+    @resultSet = []
+  end
+
+  def to_json(options={})
+    {'feature_id' => @featureId, 'result' => @result, 'start_date' => @startDate, 'end_date' => @endDate, 'execution_id' => @executionId,
+     'scenario_logs' => @scenarioLogs, 'versionId' => @versionId}.to_json
+  end
+
+  def addScenarioResult result
+    @resultSet.push result
+    @currentScenariosNumber += 1
+  end
+
+  def addScenarioLog scenarioLog
+    @scenarioLogs.push scenarioLog
+  end
+
+  def done?
+    @currentScenariosNumber.eql? totalScenariosNumber
+  end
+
+end

data/lib/logs/scenario_log.rb

@@ -0,0 +1,16 @@
+class ScenarioLog
+  attr_accessor :featureId, :featureName, :execution_method, :result, :startDate, :endDate,
+                :executionLog, :scenarioId, :host, :scenarioName, :outLineResult
+
+  def initialize
+    @execution_method = "AUTOMATE"
+    @outLineResult = []
+  end
+
+  def to_json(options={})
+    {'feature_id' => @featureId, 'feature_name' => @featureName, 'execution_method' => @execution_method,
+     'result' => @result, 'start_date' => @startDate, 'end_date' => @endDate, 'execute_log' => @executionLog,
+     'scenario_id' => @scenarioId, 'host' => @host}.to_json
+  end
+
+end

data/lib/qTestScenarioRuby.rb

@@ -0,0 +1,263 @@
+require_relative '../lib/qspec_feature/feature_meta'
+require_relative '../lib/qspec_feature/qspec_feature'
+require_relative '../lib/utils/q_test_scenario_utils'
+require_relative '../lib/logs/feature_log'
+require_relative '../lib/logs/scenario_log'
+require_relative 'configuration/constants'
+require 'fileutils'
+
+module QTestScenario
+  $outline_pattern = '%s, %s (#%s)'
+  $hook_version = '1.2'
+
+  class QTestScenarioPlugin
+
+    attr_accessor :server, :api_key, :destination_dir, :jql, :keys, :support_folder, :project_path
+
+    def initialize(args)
+      args.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+      if @server.nil? or @api_key.nil? or @destination_dir.nil?
+        puts '--------------------------------------------------------------'
+        puts 'Must set at least Jira host URI (server), api key (api_key) and destination folder (destination_dir) for feature files'
+        puts '--------------------------------------------------------------'
+        exit 1
+      end
+      if @jql.nil? and @keys.nil?
+        puts '--------------------------------------------------------------'
+        puts 'Must set at least jql or issue key to select feature files'
+        puts '--------------------------------------------------------------'
+        exit 1
+      end
+
+      @setup_is_done = false
+      generate_hooks
+    end
+
+    def prepare_test
+      FileUtils.rm_rf(@destination_dir)
+      begin
+        FileUtils.mkdir(@destination_dir)
+      rescue
+        # retry if we encounter PermissionDenied exception
+        FileUtils.mkdir(@destination_dir)
+      end
+
+      response = QTestScenarioUtils.get_feature_files(@keys, @jql, @server, @api_key)
+      if response.code === 200
+        features = JSON.parse(response.body)
+        feature_mapper = Hash.new
+
+        features.each { |feature|
+          qspec_feature = QspecFeature.from_json feature
+
+          # Write qspec_feature to file
+          write_to_file(@destination_dir, qspec_feature.fileName, qspec_feature.content)
+
+          feature_meta = FeatureMeta.new(qspec_feature.id, qspec_feature.name, qspec_feature.scenarios, qspec_feature.versionId)
+          feature_mapper[qspec_feature.name] = feature_meta.to_json
+        }
+
+        # Write qspecFeature mapping to file
+        write_to_file(@destination_dir, Constants.getMappingFileName, feature_mapper.to_json)
+      end
+    end
+
+    def write_to_file (destination_dir, file_name, content)
+      path = destination_dir + file_name
+      File.open(path, 'wb') do |f|
+        f.puts content
+      end
+    end
+
+    def get_scenario_log (scenariosLog, featureMeta, scenario)
+      scenariosLog.each { |scenarioLog|
+        scenarioId = featureMeta.scenarios[scenario.name]
+        if scenarioLog.scenarioId.eql? scenarioId
+          return scenarioLog
+        end
+      }
+      return nil
+    end
+
+    def before_scenario (scenario)
+
+      if (!@setup_is_done)
+        @setup_is_done = true
+        @feature_mappings_map = QTestScenarioUtils.load_feature_mapping_file(@destination_dir)
+        @execution = QTestScenarioUtils.create_execution(@server, @api_key)
+        @feature_logs_map = Hash.new
+        @scenario_id_to_outline_number = Hash.new
+        @current_outline_count = 0
+      end
+
+      feature_meta = @feature_mappings_map[scenario.feature.name]
+      feature_log = @feature_logs_map[feature_meta.id]
+      if feature_log.nil?
+        # new feature if not exists
+        feature_log = FeatureLog.new
+        feature_log.totalScenariosNumber = feature_meta.scenarios.length
+        feature_log.featureId = feature_meta.id
+        feature_log.versionId = feature_meta.versionId
+        feature_log.executionId = @execution.executionId
+        feature_log.startDate = Time.now.to_ms
+        feature_log.totalScenariosNumber = feature_meta.scenarios.length
+        @feature_logs_map[feature_meta.id] = feature_log
+
+        # build outline count for scenarios
+        scenario.feature.feature_elements.each { |child|
+          if ('Scenario Outline'.eql? child.keyword) || ('scenario outline'.eql? child.keyword)
+            outline_example_count = 0
+            scenarioId = feature_meta.scenarios[child.name]
+            child.examples_tables.each { |table|
+              outline_example_count += table.example_rows.length
+              table.example_rows.each { |row|
+                outLineName = $outline_pattern % [child.name, table.name, row.number]
+                feature_meta.scenarios[outLineName] = scenarioId
+              }
+            }
+            @scenario_id_to_outline_number[scenarioId] = outline_example_count
+          end
+        }
+      end
+      # get the scenario log, in case Scenario Outline, we will get the same scenarioLog
+      scenario_log = get_scenario_log(feature_log.scenarioLogs, feature_meta, scenario)
+      scenario_id = feature_meta.scenarios[scenario.name]
+
+      if scenario_log.nil?
+        scenario_log = ScenarioLog.new
+        scenario_log.featureId = feature_meta.id
+        scenario_log.featureName = feature_meta.name
+        scenario_log.startDate = Time.now.to_ms
+        scenario_log.host = Socket.gethostname
+        scenario_log.scenarioName = scenario.name
+        scenario_log.scenarioId = scenario_id
+        feature_log.addScenarioLog(scenario_log)
+      end
+    end
+
+    def calculate_result (results)
+      if results.include? QspecResult::FAILED
+        result = QspecResult::FAILED
+      elsif results.include? QspecResult::UNCOMPLETED
+        result = QspecResult::UNCOMPLETED
+      else
+        result = QspecResult::PASSED
+      end
+      result
+    end
+
+    def after_scenario (scenario)
+      feature_meta = @feature_mappings_map[scenario.feature.name]
+      feature_log = @feature_logs_map[feature_meta.id]
+      scenario_log = get_scenario_log(feature_log.scenarioLogs, feature_meta, scenario)
+
+      if !scenario_log.nil?
+        scenario_log.endDate = Time.now.to_ms
+        result = ''
+        if scenario.failed?
+          scenario_log.executionLog = scenario.exception
+          result = QspecResult::FAILED
+        else
+          if 'passed'.eql? scenario.status.to_s
+            result = QspecResult::PASSED
+          else
+            result = QspecResult::UNCOMPLETED
+          end
+        end
+
+        if !scenario.outline?
+          # not scenario outline: update result to scenarioLog
+          scenario_log.result = result
+          feature_log.addScenarioResult(scenario_log.result)
+        else
+          # scenario outline: doesn't calculate scenario, defer it until all outline has been executed
+          scenario_log.outLineResult.push(result)
+          @current_outline_count += 1
+
+          if @current_outline_count.eql? @scenario_id_to_outline_number[scenario_log.scenarioId]
+            # put the outline result to scenario log
+            scenario_log.result = calculate_result(scenario_log.outLineResult)
+            feature_log.addScenarioResult(scenario_log.result)
+            @current_outline_count = 0
+          end
+        end
+      end
+
+      if feature_log.done?
+        # all scenarios have been executed, updates the qspecFeature log and sends it to scenario server
+        feature_log.result = calculate_result(feature_log.resultSet)
+        feature_log.endDate = Time.now.to_ms
+
+        QTestScenarioUtils.submit_feature_test_log(feature_log, @server, @api_key)
+      end
+    end
+
+    def at_exit
+      @execution.endDate = Time.now.to_ms
+      QTestScenarioUtils.update_execution(@execution, @server, @api_key)
+    end
+
+    def generate_hooks? (version_file_path, hook_file_path)
+      generate_hook = false
+      begin
+        File.open(version_file_path, 'r') do |f|
+          versionUsed = f.gets
+          if !$hook_version.eql? versionUsed
+            File.delete(hook_file_path)
+            generate_hook = true
+          end
+        end
+      rescue
+        # hook_version does not exist, then generate hook
+        generate_hook = true
+      end
+      generate_hook
+    end
+
+    def generate_hooks
+      support_folder_path = @project_path + '/' + @support_folder + '/hook/'
+      if !File.directory? (support_folder_path)
+        FileUtils.mkdir(support_folder_path)
+      end
+
+      version_file_path = support_folder_path + 'hook_version'
+      hook_file_path = support_folder_path + 'hooks.rb'
+      generate_hook = generate_hooks?(version_file_path, hook_file_path)
+
+      if (generate_hook)
+        File.open(version_file_path, 'wb') do |f|
+          f << $hook_version
+        end
+
+        File.open(hook_file_path, 'wb') do |f|
+          f.puts 'require \'qTestScenarioRuby\''
+          f.puts ''
+          f.puts '$plugin = QTestScenario::QTestScenarioPlugin.new({'
+          f.puts '    \'server\' => ENV[\'server\'],'
+          f.puts '    \'api_key\' => ENV[\'api_key\'],'
+          f.puts '    \'destination_dir\' => ENV[\'destination_dir\'],'
+          f.puts '    \'jql\' => ENV[\'jql\'],'
+          f.puts '    \'support_folder\' => ENV[\'support_folder\'],'
+          f.puts '    \'project_path\' => Dir.pwd'
+          f.puts '    })'
+          f.puts ''
+          f.puts 'Before do |scenario|'
+          f.puts '  $plugin.before_scenario scenario'
+          f.puts 'end'
+          f.puts ''
+          f.puts 'After do |scenario|'
+          f.puts '  $plugin.after_scenario scenario'
+          f.puts 'end'
+          f.puts ''
+          f.puts 'at_exit do'
+          f.puts '  $plugin.at_exit'
+          f.puts 'end'
+        end
+      end
+    end
+  end
+end
+
+

data/lib/qspec_feature/feature_meta.rb

@@ -0,0 +1,18 @@
+class FeatureMeta
+  attr_accessor :id, :name, :scenarios, :versionId
+
+  def initialize(id, name, scenarios, versionId)
+    @id = id
+    @name = name
+    @scenarios = scenarios
+    @versionId = versionId
+  end
+
+  def to_json(options={})
+    {'id' => @id, 'name' => @name, 'scenarios' => @scenarios, 'versionId' => @versionId}
+  end
+
+  def self.from_json data
+    self.new data['id'], data['name'], data['scenarios'], data['versionId']
+  end
+end

data/lib/qspec_feature/qspec_feature.rb

@@ -0,0 +1,16 @@
+class QspecFeature
+  attr_accessor :id, :fileName, :name, :content, :versionId, :scenarios
+
+  def initialize(id, name, content, versionId, fileName, scenarios)
+    @id = id
+    @name = name
+    @content = content
+    @versionId = versionId
+    @fileName = fileName
+    @scenarios = scenarios
+  end
+
+  def self.from_json data
+    QspecFeature.new data['id'], data['name'], data['content'], data['versionId'], data['fileName'], data['scenarios']
+  end
+end

data/lib/utils/q_test_scenario_utils.rb

@@ -0,0 +1,61 @@
+require 'rest-client'
+require 'fileutils'
+require_relative '../../lib/logs/execution_log'
+require_relative '../../lib/qspec_feature/feature_meta'
+require_relative '../../lib/configuration/constants'
+
+module QTestScenario
+
+  class QTestScenarioUtils
+
+    def self.get_feature_files(keys, jql, server, apiKey)
+      params = '?keys=' + keys if (!keys.nil? && !keys.empty?)
+      params = '?jql=' + CGI::escape(jql) if (!jql.nil? && !jql.empty?)
+
+      resource = RestClient::Resource.new(server + Constants.getFeatureFilesUri  + params)
+      response = resource.get( :Authorization => apiKey )
+    end
+
+    def self.create_execution(server, api_key)
+      execution = ExecutionLog.new
+      response = RestClient.post(
+          server + Constants.getCreateExecutionUri,
+          execution.to_json,
+          { :Authorization => api_key, :content_type => 'application/json' }
+      )
+      result = JSON.parse response
+      ExecutionLog.from_json(result)
+    end
+
+    def self.update_execution (execution, server, api_key)
+      uri = Constants.getUpdateExecutionUri % [execution.executionId]
+      RestClient.put(
+          server + uri,
+          execution.to_json,
+          { :Authorization => api_key, :content_type => 'application/json' }
+      )
+    end
+
+    def self.load_feature_mapping_file(destination_dir)
+      feature_mappings_map = Hash.new
+      File.open(destination_dir + Constants.getMappingFileName, 'r') do |f|
+        feature_mappings = JSON.parse f.read
+        feature_mappings.each { |feature_name, feature_meta_json|
+          feature_meta = FeatureMeta.from_json feature_meta_json
+          feature_mappings_map[feature_name] = feature_meta
+        }
+      end
+      feature_mappings_map
+    end
+
+    def self.submit_feature_test_log (feature_test_log, server, api_key)
+
+      uri = Constants.getSubmitFeatureTestLogUri % [feature_test_log.featureId]
+      response = RestClient.post(
+          server + uri,
+          feature_test_log.to_json,
+          { :Authorization => api_key, :content_type => 'application/json' }
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: qTestScenarioRuby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thuan Tran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby plugin of qTest Scenario
+email: thuantran@qasymphony.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/configuration/constants.rb
+- lib/logs/execution_log.rb
+- lib/logs/feature_log.rb
+- lib/logs/scenario_log.rb
+- lib/qspec_feature/feature_meta.rb
+- lib/qspec_feature/qspec_feature.rb
+- lib/qTestScenarioRuby.rb
+- lib/utils/q_test_scenario_utils.rb
+homepage: https://www.qasymphony.com/testing-platform/qtest-scenario/
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: qTest Scenario Ruby plugin!
+test_files: []