hiptest-publisher 2.3.0 → 3.1.0

data/lib/hiptest-publisher/client.rb

@@ -21,6 +21,9 @@ module Hiptest
     end
   end
 
+  class AsyncExportUnavailable < StandardError
+  end
+
   class MaximumRedirectionReachedError < StandardError
   end
 
@@ -28,15 +31,17 @@ module Hiptest
 
   class Client
     attr_reader :cli_options
+    attr_writer :async_options
 
     def initialize(cli_options, reporter = nil)
       @cli_options = cli_options
       @reporter = reporter || NullReporter.new
+      @async_options = { max_attempts: 200, sleep_time_between_attemps: 5 }
     end
 
     def url
       if cli_options.push?
-        "#{cli_options.site}/import_test_results/#{cli_options.token}/#{cli_options.push_format}#{execution_environment_query_parameter}"
+        "#{cli_options.site}/import_test_results/#{cli_options.token}/#{cli_options.push_format}#{push_query_parameters}"
       elsif test_run_id
         "#{base_publication_path}/test_run/#{test_run_id}#{test_run_export_filter}"
       else
@@ -86,7 +91,7 @@ module Hiptest
       return "?filter_status=#{value}"
     end
 
-    def fetch_project_export
+    def fetch_project
       cached = export_cache.cache_for(url)
 
       unless cached.nil?
@@ -95,17 +100,18 @@ module Hiptest
         end
       end
 
-      @reporter.with_status_message I18n.t(:fetching_data) do
-        response = send_get_request(url)
-        if response.code_type == Net::HTTPNotFound
-          raise ClientError, I18n.t('errors.project_not_found')
-        end
-
-        content = response.body
-        export_cache.cache(url, content)
+      content = @reporter.with_status_message I18n.t(:fetching_data) do
+        break fetch_project_export if use_synchronous_fetch?
 
-        return content
+        begin
+          fetch_project_export_asynchronously
+        rescue AsyncExportUnavailable
+          fetch_project_export
+        end
       end
+
+      export_cache.cache(url, content)
+      content
     end
 
     def available_test_runs
@@ -136,6 +142,50 @@ module Hiptest
 
     private
 
+    def use_synchronous_fetch?
+      cli_options.push? || cli_options.leafless_export || test_run_id
+    end
+
+    def fetch_project_export
+      response = send_get_request(url)
+      if response.code_type == Net::HTTPNotFound
+        raise ClientError, I18n.t('errors.project_not_found')
+      end
+
+      response.body
+    end
+
+    def fetch_project_export_asynchronously
+      publication_export_id = fetch_asynchronous_publication_export_id
+      url = "#{base_publication_path}/async_project/#{publication_export_id}"
+      response = nil
+
+      # the server should respond with a timeout after 15 minutes
+      # it is about 180 attempts with a sleep time of 5 seconds between each requests
+      sleep_time_between_attemps = @async_options[:sleep_time_between_attemps]
+      max_attempts = @async_options[:max_attempts]
+
+      loop do
+        response = send_get_request(url)
+
+        break unless response.code_type == Net::HTTPAccepted
+        break if 0 >= (max_attempts -= 1)
+
+        sleep(sleep_time_between_attemps)
+      end
+
+      response.body
+    end
+
+    def fetch_asynchronous_publication_export_id
+      url = "#{base_publication_path}/async_project#{project_export_filters}"
+      response = send_post_request(url)
+
+      raise AsyncExportUnavailable if response.code_type == Net::HTTPNotFound
+
+      JSON.parse(response.body)['publication_export_id']
+    end
+
     def export_cache
       @export_cache ||= ExportCache.new(
         @cli_options.cache_dir,
@@ -243,6 +293,7 @@ module Hiptest
         response = http.request(request)
 
         raise RedirectionError.new("Got redirected", response['location']) if response.is_a?(Net::HTTPRedirection)
+
         response
       end
     end
@@ -255,10 +306,21 @@ module Hiptest
       ).find_proxy
     end
 
-    def execution_environment_query_parameter
-      return "?execution_environment=#{cli_options.execution_environment}" unless cli_options.execution_environment.strip.empty?
+    def push_query_parameters
+      parameters = {}
+      unless cli_options.execution_environment.strip.empty?
+        parameters['execution_environment'] = cli_options.execution_environment
+      end
+
+      unless cli_options.build_id.strip.empty?
+        parameters['build_id'] = cli_options.build_id
+      end
+
+      unless cli_options.build_name.strip.empty?
+        parameters['build_name'] = cli_options.build_name
+      end
 
-      ""
+      parameters.empty? ? "" : "?#{parameters.map {|key, value| "#{key}=#{URI.escape(value)}"}.join("&")}"
     end
   end
 end

data/lib/hiptest-publisher/formatters/console_formatter.rb

@@ -63,6 +63,7 @@ class ConsoleFormatter
       cursor_offset = ""
     else
       return unless tty?
+      return if IO.console.nil?
       rows, columns = IO.console.winsize
       return if columns == 0
       @immediate_verbose = false

data/lib/hiptest-publisher/handlebars_helper.rb

@@ -88,7 +88,7 @@ module Hiptest
     end
 
     def hh_join_gherkin_dataset(context, items, block, else_block = nil)
-      items.map! {|item| item.gsub(/\|/, "\\|")}
+      items.map! { |item| item.gsub(/\|/, "\\|").gsub("\n", "\\n") }
 
       hh_join(context, items, ' | ', block, else_block)
     end

data/lib/hiptest-publisher/options_parser.rb

@@ -203,14 +203,14 @@ class OptionsParser
     {
       'Ruby' => ['Rspec', 'MiniTest'],
       'Cucumber' => ['Ruby', 'Java', 'Javascript', 'Groovy', 'TypeScript'],
-      'Cucumber_Expressions' => ['TypeScript'],
+      'Cucumber_Legacy' => ['Java', 'Groovy', 'TypeScript'],
       'Java' => ['JUnit', 'Test NG', 'Espresso'],
       'Python' => ['Unittest'],
       'Robot Framework' => [''],
       'Selenium IDE' => [''],
       'Javascript' => ['qUnit', 'Jasmine', 'Mocha', 'Protractor', 'CodeceptJS'],
       'CSharp' => ['NUnit'],
-      'PHP' => ['PHPUnit', 'UnitTest'],
+      'PHP' => ['PHPUnit'],
       'SpecFlow' => [''],
       'Behave' => [''],
       'Behat' => [''],
@@ -229,6 +229,7 @@ class OptionsParser
       Option.new(nil, 'filename-pattern=PATTERN', nil, String, I18n.t('options.filename_pattern'), :filename_pattern),
       Option.new('c', 'config-file=PATH', nil, String, I18n.t('options.config'), :config),
       Option.new(nil, 'overriden-templates=PATH', '', String, I18n.t('options.overriden_templates'), :overriden_templates),
+      Option.new(nil, 'overriden-language-configs=PATH', '', String, I18n.t('options.overriden_language_configs'), :overriden_language_configs),
       Option.new(nil, 'test-run-id=ID', '', String, I18n.t('options.test_run_id'), :test_run_id),
       Option.new(nil, 'test-run-name=NAME', '', String, I18n.t('options.test_run_name'), :test_run_name),
       Option.new(nil, 'only=CATEGORIES', nil, String, I18n.t('options.only'), :only),
@@ -251,12 +252,14 @@ class OptionsParser
       Option.new(nil, 'empty-folders', false, nil, I18n.t('options.empty_folders'), :empty_folders),
       Option.new(nil, 'split-scenarios', false, nil, I18n.t('options.split_scenarios'), :split_scenarios),
       Option.new(nil, 'leafless-export', false, nil, I18n.t('options.leafless_export'), :leafless_export),
-      Option.new('s', 'site=SITE', 'https://app.hiptest.com', String, I18n.t('options.site'), :site),
+      Option.new('s', 'site=SITE', 'https://studio.cucumber.io', String, I18n.t('options.site'), :site),
       Option.new(nil, 'http-proxy=PROXY_URL', nil, String, I18n.t('options.http_proxy'), :http_proxy),
       Option.new('p', 'push=FILE.TAP', '', String, I18n.t('options.push'), :push),
       Option.new(nil, 'global-failure-on-missing-reports', false, nil, I18n.t('options.global_failure_on_missing_reports'), :global_failure_on_missing_reports),
       Option.new(nil, 'push-format=tap', 'tap', String, I18n.t('options.push_format'), :push_format),
       Option.new(nil, 'execution-environment=NAME', '', String, I18n.t('options.execution_environment'), :execution_environment),
+      Option.new(nil, 'build-id=ID', '', String, I18n.t('options.build_id'), :build_id),
+      Option.new(nil, 'build-name=NAME', '', String, I18n.t('options.build_name'), :build_name),
       Option.new(nil, 'sort=[id,order,alpha]', 'order', String, I18n.t('options.sort'), :sort),
       Option.new(nil, '[no-]uids', false, nil, I18n.t('options.uids'), :uids),
       Option.new(nil, '[no-]parent-folder-tags', true, nil, I18n.t('options.parent_folder_tags'), :parent_folder_tags),
@@ -275,7 +278,8 @@ class OptionsParser
       Option.new(nil, 'check-version', false, nil, I18n.t('options.check_version'), :check_version),
       Option.new(nil, 'force', false, nil, I18n.t('options.force_overwrite'), :force_overwrite),
       Option.new(nil, '[no-]color', nil, nil, I18n.t('options.color'), :color),
-      Option.new('v', 'verbose', false, nil, I18n.t('options.verbose'), :verbose)
+      Option.new('v', 'verbose', false, nil, I18n.t('options.verbose'), :verbose),
+      Option.new(nil, 'indentation=INDENTATION', nil, EmptiableString, I18n.t('options.indentation'), :indent)
     ]
   end
 
@@ -382,6 +386,7 @@ class NodeRenderingContext
 
   def renderer_addons
     addons = @properties.renderer_addons || ""
+
     addons.split.map do |addon_name|
       Hiptest.const_get(addon_name)
     end
@@ -389,11 +394,12 @@ class NodeRenderingContext
 end
 
 class TemplateFinder
-  attr_reader :template_dirs, :overriden_templates, :forced_templates, :fallback_template
+  attr_reader :template_dirs, :overriden_templates, :overriden_language_configs, :forced_templates, :fallback_template
 
   def initialize(
     template_dirs: nil,
     overriden_templates: nil,
+    overriden_language_configs: nil,
     indentation: '  ',
     forced_templates: nil,
     fallback_template: nil,
@@ -573,6 +579,7 @@ class LanguageGroupConfig
   end
 
   def indentation
+    return @user_params[:indent] unless @user_params[:indent].nil?
     @language_group_params[:indentation] || '  '
   end
 
@@ -694,7 +701,21 @@ class LanguageConfigParser
                   else
                     "#{cli_options.language}-#{cli_options.framework}.conf"
                   end
-    config_path = File.expand_path("#{hiptest_publisher_path}/lib/config/#{config_name.downcase}")
+    config_path = "/lib/config/#{config_name.downcase}"
+    config_prefix = if !cli_options.overriden_language_configs.to_s.empty?
+                      # If the user has specified a overiden language config path, check it first. If the config
+                      # exists there, return that, otherwise fall back to the default setup and look for a config there.
+                      expanded = File.expand_path("#{cli_options.overriden_language_configs}/#{config_name.downcase}")
+
+                      # If the file exists in the path the user specified, set the config path to blank so we will be
+                      # looking in the exact path that the user requested.
+                      if File.file?(expanded)
+                        config_path = ''
+                        expanded
+                      end
+                    end
+
+    config_path = File.expand_path("#{config_prefix || hiptest_publisher_path}#{config_path}")
 
     if !File.file?(config_path)
       if cli_options.framework.to_s.empty?

data/lib/hiptest-publisher/renderer.rb

@@ -27,7 +27,11 @@ module Hiptest
       if node.is_a? Hiptest::Nodes::Node
         @rendered_children = {}
 
-        node.children.each {|name, child| @rendered_children[name] = @rendered[child]}
+        node.children.each do |name, child| 
+          @rendered_children[name] = @rendered[child]
+
+          @rendered_children[name].uniq! if name == :actionwords && @rendered_children[name].is_a?(Array)
+        end
         @rendered[node] = render_node(node, super(node))
       elsif node.is_a? Array
         @rendered[node] = node.map {|item| @rendered[item]}

data/lib/hiptest-publisher.rb

@@ -83,7 +83,7 @@ module Hiptest
     end
 
     def fetch_xml_file
-      @client.fetch_project_export
+      @client.fetch_project
     rescue ClientError => err
       # This should not be an error that needs reporting to an exception monitoring app
       reporter.show_error(err.message)

data/lib/templates/cucumber/groovy/step-definitions/actionword.hbs

@@ -1,4 +1,4 @@
-{{#if rendered_children.gherkin_annotation }}{{{ rendered_children.gherkin_annotation }}}(~"^{{#escape_backslashes_and_double_quotes}}{{> gherkin_pattern}}{{/escape_backslashes_and_double_quotes}}\$") { {{{ join rendered_children.parameters_ordered_by_pattern ', '}}} ->{{#indent}}
+{{#if rendered_children.gherkin_annotation }}{{{ rendered_children.gherkin_annotation }}}("{{#escape_backslashes_and_double_quotes}}{{> gherkin_typed_pattern}}{{/escape_backslashes_and_double_quotes}}") { {{{ join rendered_children.parameters_ordered_by_pattern ', '}}} ->{{#indent}}
 {{{ context.call_prefix }}}.{{{camelize_lower uniq_name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{camelize_lower param}}}{{/join}}{{/if}})
 {{/indent}}
 }

data/lib/templates/cucumber/groovy/step-definitions/actionwords.hbs

@@ -1,8 +1,9 @@
 package {{{ context.package }}}
 
-import cucumber.api.DataTable
+import io.cucumber.datatable.DataTable
+import io.cucumber.groovy.EN
 
-this.metaClass.mixin(cucumber.api.groovy.EN)
+this.metaClass.mixin(EN)
 
 Actionwords {{{ context.call_prefix }}} = new Actionwords()
 

data/lib/templates/cucumber/groovy/step-definitions/library.hbs

@@ -1,8 +1,9 @@
 package {{{ context.package }}}
 
-import cucumber.api.DataTable
+import io.cucumber.datatable.DataTable
+import io.cucumber.groovy.EN
 
-this.metaClass.mixin(cucumber.api.groovy.EN)
+this.metaClass.mixin(EN)
 
 Actionwords {{{ context.call_prefix }}} = new Actionwords()
 

data/lib/templates/cucumber/groovy/step-definitions/libraryactionword.hbs

@@ -1,4 +1,4 @@
-{{#if rendered_children.gherkin_annotation }}{{{ rendered_children.gherkin_annotation }}}(~"^{{#escape_backslashes_and_double_quotes}}{{> gherkin_pattern}}{{/escape_backslashes_and_double_quotes}}\$") { {{{ join rendered_children.parameters_ordered_by_pattern ', '}}} ->{{#indent}}
+{{#if rendered_children.gherkin_annotation }}{{{ rendered_children.gherkin_annotation }}}("{{#escape_backslashes_and_double_quotes}}{{> gherkin_typed_pattern}}{{/escape_backslashes_and_double_quotes}}") { {{{ join rendered_children.parameters_ordered_by_pattern ', '}}} ->{{#indent}}
 {{{ context.call_prefix }}}.get{{{camelize library_name}}}Library().{{{camelize_lower uniq_name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{camelize_lower param}}}{{/join}}{{/if}})
 {{/indent}}
 }

data/lib/templates/cucumber/java/actionword.hbs

@@ -1,4 +1,4 @@
-{{#if rendered_children.gherkin_annotation }}@{{{ rendered_children.gherkin_annotation }}}("{{#escape_backslashes_and_double_quotes}}{{> gherkin_pattern}}{{/escape_backslashes_and_double_quotes}}")
+{{#if rendered_children.gherkin_annotation }}@{{{ rendered_children.gherkin_annotation }}}("{{#escape_backslashes_and_double_quotes}}{{> gherkin_typed_pattern}}{{/escape_backslashes_and_double_quotes}}")
 public void {{{camelize_lower rendered_children.name}}}({{{ join rendered_children.parameters_ordered_by_pattern ', '}}}) {{#curly}}{{#indent}}
 {{{ context.call_prefix }}}.{{{camelize_lower rendered_children.name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{camelize_lower param}}}{{/join}}{{/if}});
 {{/indent}}

data/lib/templates/cucumber/java/actionwords.hbs

@@ -1,7 +1,7 @@
 package {{{ context.package }}};
 
-import cucumber.api.DataTable;
-import cucumber.api.java.en.*;
+import io.cucumber.datatable.DataTable;
+import io.cucumber.java.en.*;
 
 public class StepDefinitions {{#curly}}{{#indent}}
 public Actionwords {{{ context.call_prefix }}} = new Actionwords();

data/lib/templates/cucumber/typescript/actionword.hbs

@@ -1,5 +1,5 @@
 {{#if rendered_children.gherkin_annotation }}
-{{{ rendered_children.gherkin_annotation }}}(/{{> gherkin_pattern}}/, async ({{#if rendered_children.parameters}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}) => {{#curly}}{{#indent}}
+{{{ rendered_children.gherkin_annotation }}}('{{> gherkin_typed_pattern}}', async ({{#if rendered_children.parameters}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}) => {{#curly}}{{#indent}}
 actionWords.{{{camelize_lower rendered_children.name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{underscore param}}}{{/join}}{{/if}});
 {{/indent}}
 {{/curly}});{{/if}}

data/lib/templates/cucumber/typescript/libraryactionword.hbs

@@ -1,5 +1,5 @@
 {{#if rendered_children.gherkin_annotation}}
-{{{ rendered_children.gherkin_annotation }}}(/{{> gherkin_pattern}}/, async ({{#if rendered_children.parameters}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}) => {{#curly}}{{#indent}}
+{{{ rendered_children.gherkin_annotation }}}('{{> gherkin_typed_pattern}}', async ({{#if rendered_children.parameters}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}) => {{#curly}}{{#indent}}
 libraryActionWord.getDefaultLibrary().{{{camelize_lower rendered_children.name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{underscore param}}}{{/join}}{{/if}});
 {{/indent}}
 {{/curly}});{{/if}}

data/lib/templates/cucumber_legacy/groovy/step-definitions/actionword.hbs

@@ -0,0 +1,5 @@
+{{#if rendered_children.gherkin_annotation }}{{{ rendered_children.gherkin_annotation }}}(~"^{{#escape_backslashes_and_double_quotes}}{{> gherkin_pattern}}{{/escape_backslashes_and_double_quotes}}\$") { {{{ join rendered_children.parameters_ordered_by_pattern ', '}}} ->{{#indent}}
+{{{ context.call_prefix }}}.{{{camelize_lower uniq_name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{camelize_lower param}}}{{/join}}{{/if}})
+{{/indent}}
+}
+{{/if}}

data/lib/templates/cucumber_legacy/groovy/step-definitions/actionwords.hbs

@@ -0,0 +1,10 @@
+package {{{ context.package }}}
+
+import cucumber.api.DataTable
+
+this.metaClass.mixin(cucumber.api.groovy.EN)
+
+Actionwords {{{ context.call_prefix }}} = new Actionwords()
+
+{{#each rendered_children.actionwords as |actionword|}}{{{actionword}}}
+{{/each}}

data/lib/templates/cucumber_legacy/groovy/step-definitions/library.hbs

@@ -0,0 +1,10 @@
+package {{{ context.package }}}
+
+import cucumber.api.DataTable
+
+this.metaClass.mixin(cucumber.api.groovy.EN)
+
+Actionwords {{{ context.call_prefix }}} = new Actionwords()
+
+{{#each rendered_children.library_actionwords as |actionword|}}{{{actionword}}}
+{{/each}}

data/lib/templates/cucumber_legacy/groovy/step-definitions/libraryactionword.hbs

@@ -0,0 +1,5 @@
+{{#if rendered_children.gherkin_annotation }}{{{ rendered_children.gherkin_annotation }}}(~"^{{#escape_backslashes_and_double_quotes}}{{> gherkin_pattern}}{{/escape_backslashes_and_double_quotes}}\$") { {{{ join rendered_children.parameters_ordered_by_pattern ', '}}} ->{{#indent}}
+{{{ context.call_prefix }}}.get{{{camelize library_name}}}Library().{{{camelize_lower uniq_name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{camelize_lower param}}}{{/join}}{{/if}})
+{{/indent}}
+}
+{{/if}}

data/lib/templates/cucumber_legacy/java/actionword.hbs

@@ -0,0 +1,6 @@
+{{#if rendered_children.gherkin_annotation }}@{{{ rendered_children.gherkin_annotation }}}("{{#escape_backslashes_and_double_quotes}}{{> gherkin_pattern}}{{/escape_backslashes_and_double_quotes}}")
+public void {{{camelize_lower rendered_children.name}}}({{{ join rendered_children.parameters_ordered_by_pattern ', '}}}) {{#curly}}{{#indent}}
+{{{ context.call_prefix }}}.{{{camelize_lower rendered_children.name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{camelize_lower param}}}{{/join}}{{/if}});
+{{/indent}}
+{{/curly}}
+{{/if}}

data/lib/templates/cucumber_legacy/java/actionwords.hbs

@@ -0,0 +1,12 @@
+package {{{ context.package }}};
+
+import cucumber.api.DataTable;
+import cucumber.api.java.en.*;
+
+public class StepDefinitions {{#curly}}{{#indent}}
+public Actionwords {{{ context.call_prefix }}} = new Actionwords();
+
+{{#each rendered_children.actionwords as |actionword|}}{{{actionword}}}
+{{/each}}
+{{/indent}}
+{{/curly}}

data/lib/templates/cucumber_legacy/typescript/actionword.hbs

@@ -0,0 +1,5 @@
+{{#if rendered_children.gherkin_annotation }}
+{{{ rendered_children.gherkin_annotation }}}(/{{> gherkin_pattern}}/, async ({{#if rendered_children.parameters}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}) => {{#curly}}{{#indent}}
+actionWords.{{{camelize_lower rendered_children.name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{underscore param}}}{{/join}}{{/if}});
+{{/indent}}
+{{/curly}});{{/if}}

data/lib/templates/{cucumber_expressions → cucumber_legacy}/typescript/libraryactionword.hbs

@@ -1,5 +1,5 @@
 {{#if rendered_children.gherkin_annotation}}
-{{{ rendered_children.gherkin_annotation }}}('{{> gherkin_typed_pattern}}', async ({{#if rendered_children.parameters}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}) => {{#curly}}{{#indent}}
+{{{ rendered_children.gherkin_annotation }}}(/{{> gherkin_pattern}}/, async ({{#if rendered_children.parameters}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}) => {{#curly}}{{#indent}}
 libraryActionWord.getDefaultLibrary().{{{camelize_lower rendered_children.name}}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{{underscore param}}}{{/join}}{{/if}});
 {{/indent}}
 {{/curly}});{{/if}}

data/lib/templates/gherkin/scenarios.hbs

@@ -1,3 +1,3 @@
 # To export your project to Gherkin correctly, you can add the option
 # --with-folders when calling hiptest-publisher. It will keep the
-#  HipTest folders hierarchy of your project.
+# folders hierarchy of your CucumberStudio Test Management project.