hiptest-publisher 1.31.0 → 3.0.0

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

@@ -5,26 +5,35 @@ require 'hiptest-publisher/utils'
 class ConsoleFormatter
   attr_reader :verbose
 
-  def initialize(verbose)
+  def initialize(verbose, color: nil)
     @verbose = verbose
+    @color = color.nil? ? tty? : color
     @immediate_verbose = true
     @verbose_messages = []
   end
 
   def dump_error(error, message = nil)
     return unless verbose
-    puts message.blue if message
+    puts colorize(message, :blue) if message
     line = "-" * 80
-    puts line.yellow
-    puts "#{error.class.name}: #{error.message}".red
-    puts "#{error.backtrace.map {|l| "  #{l}\n"}.join}".yellow
-    puts line.yellow
+    puts colorize(line, :yellow)
+    puts colorize("#{error.class.name}: #{error.message}", :red)
+    puts colorize("#{error.backtrace.map {|l| "  #{l}\n"}.join}", :yellow)
+    puts colorize(line, :yellow)
+  end
+
+  def show_error(message)
+    STDOUT.print colorize(message, :yellow)
+  end
+
+  def show_failure(message)
+    STDOUT.print(colorize(message, :red))
   end
 
   def show_options(options, message = nil)
     return unless verbose
     message ||= I18n.t(:verbose_header, version: hiptest_publisher_version)
-    puts message.yellow
+    puts colorize(message, :yellow)
     options.each { |k, v| puts " - #{k}: #{v.inspect}" }
   end
 
@@ -42,18 +51,19 @@ class ConsoleFormatter
     output = STDOUT
 
     if status == :success
-      status_icon = "v".green
+      status_icon = colorize("v", :green)
     elsif status == :warning
-      status_icon = "?".yellow
+      status_icon = colorize("?", :yellow)
     elsif status == :failure
-      status_icon = "x".red
+      status_icon = colorize("x", :red)
       output = STDERR
     end
     if status
       @immediate_verbose = true
       cursor_offset = ""
     else
-      return unless $stdout.tty?
+      return unless tty?
+      return if IO.console.nil?
       rows, columns = IO.console.winsize
       return if columns == 0
       @immediate_verbose = false
@@ -68,4 +78,24 @@ class ConsoleFormatter
       @verbose_messages.clear
     end
   end
+
+  def ask(question)
+    return unless tty?
+    STDOUT.print "[#{colorize('?', :yellow)}] #{question}"
+    return $stdin.gets.chomp.downcase.strip
+  end
+
+  def colored?
+    @color
+  end
+
+  private
+
+  def tty?
+    $stdout.tty?
+  end
+
+  def colorize(txt, color)
+    colored? ? txt.send(color) : txt
+  end
 end

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

@@ -11,6 +11,14 @@ class Reporter
     notify(:dump_error, error, message)
   end
 
+  def show_error(message)
+    notify(:show_error, message)
+  end
+
+  def show_failure(message)
+    notify(:show_failure, message)
+  end
+
   def show_options(options, message = nil)
     notify(:show_options, options, message)
   end
@@ -48,6 +56,12 @@ class Reporter
     end
     nil
   end
+
+  def ask(question)
+    askable_listener = @listeners.find { |l| l.respond_to?(:ask) }
+    return nil if askable_listener.nil?
+    return askable_listener.ask(question)
+  end
 end
 
 class NullReporter

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

@@ -114,6 +114,10 @@ class CliOptions < OpenStruct
     option_present?(test_run_name)
   end
 
+  def test_run?
+    test_run_id? || test_run_name?
+  end
+
   def language_framework
     if framework.empty?
       language
@@ -132,10 +136,15 @@ class CliOptions < OpenStruct
       "--#{key.to_s.gsub('_', '-')}=#{self[key]}"
     end.compact
 
-    return "hiptest-publisher #{args.join(' ')}".strip
+    "hiptest-publisher #{args.join(' ')}".strip
+  end
+
+  def uids_not_set_yet?
+    !__cli_args.include?(:uids) && !__config_args.include?(:uids)
   end
 
   def normalize!(reporter = nil)
+    self.uids = true if test_run? && uids_not_set_yet?
     self.no_uids = !uids # silent normalization
     modified_options = self.clone
     if actionwords_only
@@ -194,6 +203,7 @@ class OptionsParser
     {
       'Ruby' => ['Rspec', 'MiniTest'],
       'Cucumber' => ['Ruby', 'Java', 'Javascript', 'Groovy', 'TypeScript'],
+      'Cucumber_Legacy' => ['Java', 'Groovy', 'TypeScript'],
       'Java' => ['JUnit', 'Test NG', 'Espresso'],
       'Python' => ['Unittest'],
       'Robot Framework' => [''],
@@ -205,7 +215,8 @@ class OptionsParser
       'Behave' => [''],
       'Behat' => [''],
       'Groovy' => ['Spock'],
-      'JBehave' => ['']
+      'JBehave' => [''],
+      'Swift' => ['XCTest']
     }
   end
 
@@ -218,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),
@@ -240,14 +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, 'sort=[id,order,alpha]', 'order', String, I18n.t('options.sort'), :sort),
-      Option.new(nil, '[no-]uids', true, nil, I18n.t('options.uids'), :uids),
+      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),
       Option.new(nil, 'parameter-delimiter=DELIMITER', '"', EmptiableString, I18n.t('options.parameter_delimiter'), :parameter_delimiter),
       Option.new(nil, 'with-dataset-names', false, nil, I18n.t('options.with_dataset_names'), :with_dataset_names),
@@ -263,12 +275,20 @@ class OptionsParser
       Option.new(nil, 'meta=META', '', String, I18n.t('options.meta'), :meta),
       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('v', 'verbose', false, nil, I18n.t('options.verbose'), :verbose)
+      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(nil, 'indentation=INDENTATION', nil, EmptiableString, I18n.t('options.indentation'), :indent)
     ]
   end
 
   def self.default_cache_directory
-    File.join(Dir.home, '.hiptest-publisher', 'cache')
+    home_dir =  begin
+                  Dir.home
+                rescue
+                  '.'
+                end
+
+    File.join(home_dir, '.hiptest-publisher', 'cache')
   end
 
   def self.parse(args, reporter)
@@ -294,7 +314,7 @@ class OptionsParser
 
     args << "--help" if args.empty?
     opt_parser.parse!(args)
-    reporter.add_listener(ConsoleFormatter.new(options.verbose))
+    reporter.add_listener(ConsoleFormatter.new(options.verbose, color: options.color))
     FileConfigParser.update_options(options, reporter)
 
     reporter.show_options(options.marshal_dump)
@@ -364,6 +384,7 @@ class NodeRenderingContext
 
   def renderer_addons
     addons = @properties.renderer_addons || ""
+
     addons.split.map do |addon_name|
       Hiptest.const_get(addon_name)
     end
@@ -371,11 +392,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,
@@ -555,6 +577,7 @@ class LanguageGroupConfig
   end
 
   def indentation
+    return @user_params[:indent] unless @user_params[:indent].nil?
     @language_group_params[:indentation] || '  '
   end
 
@@ -676,7 +699,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/renderer_addons/gherkin_addon.rb

@@ -14,6 +14,14 @@ module Hiptest
       super(call)
     end
 
+    def walk_actionword(aw)
+      parameters = aw.children[:parameters]
+      aw.chunks = replace_parameter_value_with_type(aw.chunks, parameters)
+      aw.extra_inlined_parameters = replace_parameter_value_with_type(aw.extra_inlined_parameters, parameters)
+
+      super(aw)
+    end
+
     def walk_folder(folder)
       @rendered_children[:ancestor_tags] = ancestor_tags(folder)
 
@@ -34,5 +42,18 @@ module Hiptest
       ancestor_tags = folder.ancestors.map { |f| f.children[:tags] }.flatten.uniq
       ancestor_tags.map { |t| Hiptest::Renderer.render(t, @context) }
     end
+
+    def replace_parameter_value_with_type(collection, parameters)
+      collection.map do |obj|
+        if obj[:is_parameter]
+          parameter = parameters.find { |parameter| parameter.children[:name] == obj[:name] }
+          obj[:typed_value] = parameter ? "{#{parameter.type.downcase}}" : "{}"
+        else
+          obj[:typed_value] = obj[:value]
+        end
+
+        obj
+      end
+    end
   end
 end

data/lib/templates/common/_gherkin_typed_pattern.hbs

@@ -0,0 +1 @@
+{{#strip}}{{#each chunks as |treated_chunk|}}{{treated_chunk.typed_value}}{{/each}}{{#each extra_inlined_parameters as |param|}} {{param.typed_value}}{{/each}}{{/strip}}

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}}