hiptest-publisher 0.5.10 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5cfb12dc26314eb322e9eb69ce43c2af565c65f
-  data.tar.gz: 8579672e7b62bee13628e143d4e649016a16080c
+  metadata.gz: f43b16fba8918586730a65e4312b062c36b0b68d
+  data.tar.gz: 996e1d9199c1e7163557a5625dad39f6d5a375d7
 SHA512:
-  metadata.gz: a8d78d15ea41f418f2b724249b3ff3e255415b4e14732c750cc43f95e8e00add8190980702817a472254abf00058c903b89ccddd9c5a57a4ea00e1b0b4f08427
-  data.tar.gz: 8a15a2c537d4a082dfdc7e47f5c05734e4666f204040da0de8d1e19195abdef677f11e5119ea3ce327e0c3580ea5790c77203335baee023406ce24c3a4202ab8
+  metadata.gz: 79fb761dc2208ec15cccc08020853418088972797be6934cf96a2dea547ee35dc846a72eb614ad1b341ceb6d798c3ecb815bf05cf68d4d8118177400232155c3
+  data.tar.gz: adca0ee51d099c0c2664aaf50b94c3531d44f549dbba800253ac893b0b46df94a8bfa35491f765b166e63f16714b79b7670cdb10efaa64605b6fafc242317755

data/README.md

@@ -33,6 +33,7 @@ hiptest-publisher --token=<YOUR TOKEN>
 This will create a Ruby tests suite. For the moment, we support the following languages and frameworks:
 
  - Ruby (rspec / minitest)
+ - Cucumber Ruby
  - Python (unittest)
  - Java (JUnit / TestNg)
  - Robot Framework
@@ -45,7 +46,19 @@ You can specify the output language and framework in the command line, for examp
 hiptest-publisher --token=<YOUR TOKEN> --language=ruby --framework=minitest
 ```
 
-When publishing, you'll notice that a file called ``actionwords_signature.yaml``. Store this file in your code repository, it will be used to [handle updates of the action word](docs/upgrading_actionwords.md).
+When publishing, you'll notice a file called ``actionwords_signature.yaml``. Store this file in your code repository, it will be used to [handle updates of the action word](docs/upgrading_actionwords.md).
+
+Exporting a test run
+--------------------
+
+You can generate the test suite from a test run of your project by specifying option `--test-run-id=<xxx>` when calling `hiptest-publisher`. You can find the test run id in the address bar of your browser. If your browser address is `http://hiptest.net/app#/projects/1234/testRuns/6941`, then your test run id is `6941`. You can generate your tests from your test with this command line:
+
+```shell
+hiptest-publisher --token=<YOUR TOKEN> --test-run-id=6941
+```
+
+Available options
+-----------------
 
 For more information on the available options, use the following command:
 
@@ -56,18 +69,29 @@ hiptest-publisher --help
 You could obtain for example:
 
 ```shell
+Exports tests from Hiptest for automation.
+
 Specific options:
     -t, --token=TOKEN                Secret token (available in your project settings)
     -l, --language=LANG              Target language (default: ruby)
     -f, --framework=FRAMEWORK        Test framework to use
     -o, --output-directory=PATH      Output directory (default: .)
-    -c, --config-file=PATH           Configuration file (default: config)
+    -c, --config-file=PATH           Configuration file
         --overriden-templates=PATH   Folder for overriden templates
         --test-run-id=ID             Export data from a test run
         --scenario-ids=IDS           Filter scenarios by ids
         --scenario-tags=TAGS         Filter scenarios by tags
-        --tests-only                 Export only the tests (default: false)
-        --actionwords-only           Export only the actionwords (default: false)
+        --only=CATEGORIES            Restrict export to given file categories (--only=list to list them)
+        --tests-only                 (deprecated) alias for --only=tests (default: false)
+        --actionwords-only           (deprecated) alias for --only=actionwords (default: false)
+        --actionwords-signature      Export actionwords signature (default: false)
+        --show-actionwords-diff      Show actionwords diff since last update (summary) (default: false)
+        --show-actionwords-deleted   Output signature of deleted action words (default: false)
+        --show-actionwords-created   Output code for new action words (default: false)
+        --show-actionwords-renamed   Output signatures of renamed action words (default: false)
+        --show-actionwords-signature-changed
+                                     Output signatures of action words for which signature changed (default: false)
+        --with-folders               Use folders hierarchy to export files in respective directories, to be used with --split-scenarios (default: false)
         --split-scenarios            Export each scenario in a single file (default: false)
         --leafless-export            Use only last level action word (default: false)
     -s, --site=SITE                  Site to fetch from (default: https://hiptest.net)
@@ -102,10 +126,12 @@ output_directory = '<YOUR OUTPUT DIRECTORY>'
 package = 'com.youcompany'
 ```
 
+Note that options from command line arguments override options from config file.
+
 Posting results to Hiptest
 --------------------------
 
-You can use the options --push to push the results to Hiptest. For this, you first need to generate the test code from a Test run by specifying option ``--test_run_id=<xxx>`` during code generation (or add it to the configuration file).
+You can use the options --push to push the results back to Hiptest. For this, you first need to generate the test code from a Test run by specifying option ``--test-run-id=<xxx>`` during code generation (or add it to the configuration file).
 The tests must then generate a test report that is supported by Hiptest. Currently three types of test results are handled:
  - tap (Test Anything Protocol)
  - jUnit XML style

data/bin/hiptest-publisher

@@ -17,6 +17,13 @@ begin
 rescue LoadError
 end
 
+# Ensure ruby version >= 2
+if RUBY_VERSION.to_i < 2
+  STDERR.puts "Error: you are using #{RUBY_ENGINE} #{RUBY_VERSION}."
+  STDERR.puts "hiptest-publisher requires Ruby version >= 2.0.0."
+  exit 1
+end
+
 require 'hiptest-publisher'
 begin
   require 'pry' # only available in development

data/lib/config/cucumber-folders_as_features.conf

@@ -0,0 +1,18 @@
+[_common]
+language = cucumber
+indentation = '  '
+fallback_template = 'empty'
+
+[features]
+node_name = folders
+scenario_filename = '%s.feature'
+
+[step_definitions]
+node_name = actionwords
+filename = 'step_definitions.rb'
+naming_convention = 'underscore'
+
+[actionwords]
+language = ruby
+filename = 'actionwords.rb'
+naming_convention = 'underscore'

data/lib/config/cucumber.conf

@@ -0,0 +1,18 @@
+[_common]
+language = cucumber
+indentation = '  '
+fallback_template = 'empty'
+
+[features]
+node_name = tests
+scenario_filename = '%s.feature'
+
+[step_definitions]
+node_name = actionwords
+filename = 'step_definitions.rb'
+naming_convention = 'underscore'
+
+[actionwords]
+language = ruby
+filename = 'actionwords.rb'
+naming_convention = 'underscore'

data/lib/{templates/java/output_config → config/java.conf}

@@ -1,11 +1,13 @@
+[_common]
+package = 'com.example'
+indentation = '    '
+filename_convention = 'camelize'
+naming_convention = 'camelize_lower'
+
 [tests]
 filename = 'ProjectTest.java'
 scenario_filename = '%sTest.java'
-class_name_convention = 'camelize'
-indentation = "    "
 call_prefix = 'actionwords'
 
 [actionwords]
 filename = 'Actionwords.java'
-indentation = "    "
-naming_convention = 'camelize_lower'

data/lib/{templates/javascript/output_config → config/javascript.conf}

@@ -5,4 +5,4 @@ call_prefix = 'actionwords'
 
 [actionwords]
 filename = 'actionwords.js'
-naming_convention = 'camelize_lower'
+naming_convention = 'camelize_lower'

data/lib/{templates/python/output_config → config/python.conf}

@@ -1,10 +1,11 @@
+[_common]
+indentation = "    "
+
 [tests]
 filename = 'test_project.py'
 scenario_filename = 'test_%s.py'
 call_prefix = 'actionwords'
-indentation = "    "
 
 [actionwords]
 filename = 'actionwords.py'
-indentation = "    "
 naming_convention = 'underscore'

data/lib/{templates/robotframework/output_config → config/robotframework.conf}

@@ -1,9 +1,10 @@
+[_common]
+indentation = "\t"
+
 [tests]
 filename = 'project.txt'
 scenario_filename = 'test_%s.txt'
-indentation = "\t"
 
 [actionwords]
 filename = 'keywords.txt'
-indentation = "\t"
-naming_convention = 'underscore'
+naming_convention = 'underscore'

data/lib/{templates/ruby/output_config → config/ruby.conf}

@@ -4,4 +4,4 @@ scenario_filename = '%s_spec.rb'
 
 [actionwords]
 filename = 'actionwords.rb'
-naming_convention = 'underscore'
+naming_convention = 'underscore'

data/lib/{templates/seleniumide/output_config → config/seleniumide.conf}

@@ -1,11 +1,11 @@
+[_common]
+indentation = "  "
+fallback_template = 'empty'
+
 [tests]
 filename = 'project.html'
 scenario_filename = '%s.html'
 call_prefix = ''
-indentation = "  "
-fallback_template = 'empty'
 
 [actionwords]
 filename = 'actionwords.html'
-indentation = "  "
-fallback_template = 'empty'

data/lib/hiptest-publisher.rb

@@ -2,6 +2,7 @@ require 'colorize'
 require 'yaml'
 
 require 'hiptest-publisher/formatters/reporter'
+require 'hiptest-publisher/cli_options_checker'
 require 'hiptest-publisher/string'
 require 'hiptest-publisher/utils'
 require 'hiptest-publisher/options_parser'
@@ -16,13 +17,36 @@ module Hiptest
   class Publisher
     attr_reader :reporter
 
-    def initialize(args, listeners: nil)
+    def initialize(args, listeners: nil, exit_on_bad_arguments: true)
       @reporter = Reporter.new(listeners)
-      @options = OptionsParser.parse(args, reporter)
+      @cli_options = OptionsParser.parse(args, reporter)
+      # pass false to prevent hiptest-publisher from exiting, useful when used embedded
+      @exit_on_bad_arguments = exit_on_bad_arguments
+    end
+
+    def normalize_cli_options!
+      modified_cli_options = @cli_options.clone
+      if @cli_options.actionwords_only
+        modified_cli_options.only = 'actionwords'
+      elsif @cli_options.tests_only
+        modified_cli_options.only = 'tests'
+      end
+      @cli_options = modified_cli_options
     end
 
     def run
-      unless @options.push.nil? || @options.push.empty?
+      normalize_cli_options!
+      if CliOptionsChecker.new(@cli_options, reporter).bad_arguments?
+        exit 1 if @exit_on_bad_arguments
+        return
+      end
+
+      if @cli_options.only == 'list'
+        print_categories
+        return
+      end
+
+      unless @cli_options.push.nil? || @cli_options.push.empty?
         post_results
         return
       end
@@ -32,12 +56,12 @@ module Hiptest
 
       @project = get_project(xml)
 
-      if @options.actionwords_signature
+      if @cli_options.actionwords_signature
         export_actionword_signature
         return
       end
 
-      if @options.actionwords_diff || @options.aw_deleted|| @options.aw_created|| @options.aw_renamed|| @options.aw_signature_changed
+      if @cli_options.actionwords_diff || @cli_options.aw_deleted|| @cli_options.aw_created|| @cli_options.aw_renamed|| @cli_options.aw_signature_changed
         show_actionwords_diff
         return
       end
@@ -47,7 +71,7 @@ module Hiptest
 
     def fetch_xml_file
       show_status_message "Fetching data from Hiptest"
-      xml = fetch_project_export(@options)
+      xml = fetch_project_export(@cli_options)
       show_status_message "Fetching data from Hiptest", :success
 
       return xml
@@ -69,6 +93,7 @@ module Hiptest
       status_message = "#{message}: #{path}"
       begin
         show_status_message status_message
+        mkdirs_for(path)
         File.open(path, 'w') do |file|
           file.write(yield)
         end
@@ -80,71 +105,38 @@ module Hiptest
       end
     end
 
+    def mkdirs_for(path)
+      unless Dir.exists?(File.dirname(path))
+        FileUtils.mkpath(File.dirname(path))
+      end
+    end
+
     def add_listener(listener)
       reporter.add_listener(listener)
     end
 
     def write_node_to_file(path, node, context, message)
       write_to_file(path, message) do
-        Hiptest::Renderer.render(node, @options.language, context)
-      end
-    end
-
-    def export_tests
-      if @options.split_scenarios
-        @project.children[:tests].children[:tests].each do |test|
-          context = @language_config.tests_render_context
-          context[:test_file_name] = @language_config.scenario_output_file(test.children[:name])
-
-          write_node_to_file(
-            @language_config.scenario_output_dir(test.children[:name]),
-            test,
-            context,
-            "Exporting test \"#{test.children[:name]}\"")
-        end
-      else
-        write_node_to_file(
-          @language_config.tests_output_dir,
-          @project.children[:tests],
-          @language_config.tests_render_context,
-          "Exporting tests")
+        Hiptest::Renderer.render(node, context)
       end
     end
 
-    def export_scenarios
-      if @options.split_scenarios
-        @project.children[:scenarios].children[:scenarios].each do |scenario|
-          context = @language_config.tests_render_context
-          context[:test_file_name] = @language_config.scenario_output_file(scenario.children[:name])
-
+    def export_files
+      @language_config.language_group_configs.each do |language_group_config|
+        language_group_config.each_node_rendering_context(@project) do |node_rendering_context|
           write_node_to_file(
-            @language_config.scenario_output_dir(scenario.children[:name]),
-            scenario,
-            context,
-            "Exporting scenario \"#{scenario.children[:name]}\"")
+            node_rendering_context.path,
+            node_rendering_context.node,
+            node_rendering_context,
+            "Exporting #{node_rendering_context.description}",
+          )
         end
-      else
-        write_node_to_file(
-          @language_config.tests_output_dir,
-          @project.children[:scenarios],
-          @language_config.tests_render_context,
-          "Exporting scenarios")
       end
     end
 
-    def export_actionwords
-      write_node_to_file(
-        @language_config.aw_output_dir,
-        @project.children[:actionwords],
-        @language_config.actionword_render_context,
-        "Exporting actionwords"
-      )
-      export_actionword_signature
-    end
-
     def export_actionword_signature
       write_to_file(
-        "#{@options.output_directory}/actionwords_signature.yaml",
+        "#{@cli_options.output_directory}/actionwords_signature.yaml",
         "Exporting actionword signature"
       ) { Hiptest::SignatureExporter.export_actionwords(@project).to_yaml }
     end
@@ -152,22 +144,23 @@ module Hiptest
     def show_actionwords_diff
       begin
         show_status_message("Loading previous definition")
-        old = YAML.load_file("#{@options.output_directory}/actionwords_signature.yaml")
+        old = YAML.load_file("#{@cli_options.output_directory}/actionwords_signature.yaml")
         show_status_message("Loading previous definition", :success)
       rescue Exception => err
         show_status_message("Loading previous definition", :failure)
         reporter.dump_error(err)
       end
 
-      @language_config = LanguageConfigParser.new(@options)
+      @language_config = LanguageConfigParser.new(@cli_options)
       Hiptest::Nodes::ParentAdder.add(@project)
       Hiptest::Nodes::ParameterTypeAdder.add(@project)
       Hiptest::DefaultArgumentAdder.add(@project)
+      Hiptest::GherkinAdder.add(@project)
 
       current = Hiptest::SignatureExporter.export_actionwords(@project, true)
       diff =  Hiptest::SignatureDiffer.diff( old, current)
 
-      if @options.aw_deleted
+      if @cli_options.aw_deleted
         return if diff[:deleted].nil?
 
         diff[:deleted].map {|deleted|
@@ -176,16 +169,22 @@ module Hiptest
         return
       end
 
-      if @options.aw_created
+      if @cli_options.aw_created
         return if diff[:created].nil?
-        diff[:created].map {|created|
-          puts Hiptest::Renderer.render(created[:node], @options.language, @language_config.actionword_render_context)
-          puts ""
-        }
+
+        @language_config.language_group_configs.select { |language_group_config|
+          language_group_config[:group_name] == "actionwords"
+        }.each do |language_group_config|
+          diff[:created].each do |created|
+            node_rendering_context = language_group_config.build_node_rendering_context(created[:node])
+            puts node_rendering_context[:node].render(node_rendering_context)
+            puts ""
+          end
+        end
         return
       end
 
-      if @options.aw_renamed
+      if @cli_options.aw_renamed
         return if diff[:renamed].nil?
 
         diff[:renamed].map {|renamed|
@@ -194,13 +193,18 @@ module Hiptest
         return
       end
 
-      if @options.aw_signature_changed
+      if @cli_options.aw_signature_changed
         return if diff[:signature_changed].nil?
 
-        diff[:signature_changed].map {|signature_changed|
-          puts Hiptest::Renderer.render(signature_changed[:node], @options.language, @language_config.actionword_render_context)
-          puts ""
-        }
+        @language_config.language_group_configs.select { |language_group_config|
+          language_group_config[:group_name] == "actionwords"
+        }.each do |language_group_config|
+          diff[:signature_changed].each do |signature_changed|
+            node_rendering_context = language_group_config.build_node_rendering_context(signature_changed[:node])
+            puts signature_changed[:node].render(node_rendering_context)
+            puts ""
+          end
+        end
         return
       end
 
@@ -237,25 +241,41 @@ module Hiptest
     def export
       return if @project.nil?
 
-      @language_config = LanguageConfigParser.new(@options)
+      @language_config = LanguageConfigParser.new(@cli_options)
       Hiptest::Nodes::ParentAdder.add(@project)
       Hiptest::Nodes::ParameterTypeAdder.add(@project)
       Hiptest::DefaultArgumentAdder.add(@project)
       Hiptest::GherkinAdder.add(@project)
 
-      unless @options.actionwords_only
-        @options.leafless_export ? export_tests : export_scenarios
-      end
+      export_files
+      export_actionword_signature if @language_config.include_group?("actionwords")
+    end
 
-      export_actionwords unless @options.tests_only
+    def print_categories
+      language_config = LanguageConfigParser.new(@cli_options)
+      group_names = language_config.group_names
+      puts "For language #{@cli_options.language}, available file groups are"
+      group_names.each do |group_name|
+        puts "  - #{group_name}"
+      end
+      puts [
+        "",
+        "Usage examples:",
+        "",
+        "To export only #{group_names.first} files:",
+        "    hiptest-publisher --language=#{@cli_options.language} --only=#{group_names.first}",
+        "",
+        "To export both #{group_names.first} and #{group_names[1]} files:",
+        "    hiptest-publisher --language=#{@cli_options.language} --only=#{group_names.take(2).join(",")}"
+      ].join("\n")
     end
 
     def post_results
-      status_message = "Posting #{@options.push} to #{@options.site}"
+      status_message = "Posting #{@cli_options.push} to #{@cli_options.site}"
       show_status_message(status_message)
 
       begin
-        push_results(@options)
+        push_results(@cli_options)
         show_status_message(status_message, :success)
       rescue Exception => err
         show_status_message(status_message, :failure)