qTestScenarioRuby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc6e9dfd1295fe83365f0b536090eb6d4e31a38b
-  data.tar.gz: 3e9153475ba0e4582ebb70d687f077d7365898b5
+  metadata.gz: 3f743244a37c634d7147a58bcdc48469733d2413
+  data.tar.gz: 95886be96c6fd6c4cf1dc5fe6eb9157edb566427
 SHA512:
-  metadata.gz: a42ed9e488d80870624113340c604b425d7239030680249f106ccffe7d8e7478ac05bb9c7feff1447f4fca625c76d2a478d1f61ee723f6192478123c8d8ac0fa
-  data.tar.gz: d0f64e914993f1b78e335d143e464d04baf4ea6e8eca556e76af78eefa52036a13f5a8146123094cbf1064e1e2250557c3a48e6f0e84a12afaadfa0aa0e08b67
+  metadata.gz: fb59dc12bea654264ceda9b97a8099d5148874b4f18be4050d2c3113a4fb05f5b30ad7d5d3afaa67d7c370966c3071414cb2dc2c697aab99a6a2ed788ba9d935
+  data.tar.gz: 19a7cb4e86e7ba02591d734d764265e0855e5224473d9730daab4a9cb7c1b932118af55f231b0d32099a7173cf01706c786af13db93298129a21c33ff58791f9

data/lib/example/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'cucumber'
+gem 'rest-client'
+gem 'qTestScenarioRuby'

data/lib/example/Rakefile

@@ -0,0 +1,18 @@
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'qTestScenarioRuby'
+
+task :setup do
+  ENV['QTSCN_SERVER'] = 'http://localhost:9999/api'
+  ENV['QTSCN_SERVER_API_KEY'] = 'ZDUwMDU0MmMtYmY5OS00ZTJhLWI0YTktNzlmOGU2ZTgxM2Y4'
+  ENV['QTSCN_SERVER_FEATURE_DIR'] = 'features/features/'
+  ENV['QTSCN_JQL'] = 'project = RUBY-NEW'
+  ENV['QTSCN_KEYS'] = ''
+  ENV['QTSCN_SUPPORT_DIR'] = 'features/support/'
+end
+
+Cucumber::Rake::Task.new(:test)
+QTestScenario::Task::PrepareTest.new(:prepareTest)
+
+task :test => :setup
+task :prepareTest => :setup

data/lib/qTestScenarioRuby.rb

@@ -3,16 +3,35 @@ 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 '../lib/utils/hook_utils'
 require_relative 'configuration/constants'
 require 'fileutils'
 
 module QTestScenario
-  $outline_pattern = '%s, %s (#%s)'
-  $hook_version = '1.2'
+  OUTLINE_PATTERN = '%s, %s (#%s)'
+  HOOK_VERSION = '1.0'
+
+  module Task
+    class PrepareTest
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      def initialize(task_name = 'prepareTest')
+        task task_name do
+          plugin = QTestScenario::QTestScenarioPlugin.new({
+                                        'server' => ENV['QTSCN_SERVER'],
+                                        'api_key' => ENV['QTSCN_SERVER_API_KEY'],
+                                        'destination_dir' => ENV['QTSCN_SERVER_FEATURE_DIR'],
+                                        'jql' => ENV['QTSCN_JQL'],
+                                        'keys' => ENV['QTSCN_KEYS'],
+                                        'support_folder' => ENV['QTSCN_SUPPORT_DIR']})
+          plugin.prepare_test
+        end
+      end
+    end
+  end
 
   class QTestScenarioPlugin
-
-    attr_accessor :server, :api_key, :destination_dir, :jql, :keys, :support_folder, :project_path
+    attr_accessor :server, :api_key, :destination_dir, :jql, :keys, :support_folder
 
     def initialize(args)
       args.each do |k, v|
@@ -32,7 +51,7 @@ module QTestScenario
       end
 
       @setup_is_done = false
-      generate_hooks
+      HookUtils.generate_hook(@support_folder, HOOK_VERSION)
     end
 
     def prepare_test
@@ -113,7 +132,7 @@ module QTestScenario
             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]
+                outLineName = OUTLINE_PATTERN % [child.name, table.name, row.number]
                 feature_meta.scenarios[outLineName] = scenarioId
               }
             }
@@ -199,64 +218,6 @@ module QTestScenario
       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/utils/hook_utils.rb

@@ -0,0 +1,66 @@
+require 'fileutils'
+
+class HookUtils
+
+  def self.generate_hooks? (version_file_path, hook_file_path, hook_version)
+    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 self.generate_hook (support_folder, hook_version)
+    support_folder_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, hook_version)
+
+    if (generate_hook)
+      File.open(version_file_path, 'wb') do |f|
+        f << hook_version
+      end
+      generate_hook_file (hook_file_path)
+    end
+  end
+
+  def self.generate_hook_file(hook_file_path)
+    File.open(hook_file_path, 'wb') do |f|
+      f.puts 'require \'qTestScenarioRuby\''
+      f.puts ''
+      f.puts '$plugin = QTestScenario::QTestScenarioPlugin.new({'
+      f.puts '  \'server\' => ENV[\'QTSCN_SERVER\'],'
+      f.puts '  \'api_key\' => ENV[\'QTSCN_SERVER_API_KEY\'],'
+      f.puts '  \'destination_dir\' => ENV[\'QTSCN_SERVER_FEATURE_DIR\'],'
+      f.puts '  \'jql\' => ENV[\'QTSCN_JQL\'],'
+      f.puts '  \'keys\' => ENV[\'QTSCN_KEYS\'],'
+      f.puts '  \'support_folder\' => ENV[\'QTSCN_SUPPORT_DIR\']'
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qTestScenarioRuby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Thuan Tran
@@ -17,12 +17,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/configuration/constants.rb
+- lib/example/Gemfile
+- lib/example/Rakefile
 - 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/hook_utils.rb
 - lib/utils/q_test_scenario_utils.rb
 homepage: https://www.qasymphony.com/testing-platform/qtest-scenario/
 licenses: