hiptest-publisher 2.4.0 → 3.0.0

data/bin/hiptest-publisher

@@ -16,14 +16,18 @@ require 'ruby_version'
 require 'hiptest-publisher/i18n'
 require 'hiptest-publisher/utils'
 
-# Ensure ruby version >= 2.3
-if RubyVersion < '2.3.0'
-  STDERR.puts(I18n.t('ruby_version.required_version', version: '2.3.0'))
+# Ensure ruby version >= 2.5
+if RubyVersion < '2.5.0'
+  STDERR.puts(I18n.t('ruby_version.required_version', version: '2.5.0'))
   STDERR.puts(I18n.t('ruby_version.current_version', engine: RUBY_ENGINE, version: RUBY_VERSION))
   STDERR.puts(I18n.t('ruby_version.use_more_recent'))
 
-  if RubyVersion.is? 2.2
-    STDERR.puts(I18n.('ruby_version.support_ended', version: '2.2.0', year: '2018', month: '06', day: '20'))
+  if RubyVersion.is? 2.4
+    STDERR.puts(I18n.('ruby_version.support_ended', version: '2.4.0', year: '2020', month: '03', day: '31'))
+  elsif RubyVersion.is? 2.3
+    STDERR.puts(I18n.('ruby_version.support_ended', version: '2.3.0', year: '2019', month: '03', day: '31'))
+  elsif RubyVersion.is? 2.2
+    STDERR.puts(I18n.('ruby_version.support_ended', version: '2.2.0', year: '2018', month: '03', day: '31'))
   elsif RubyVersion.is? 2.1
     STDERR.puts(I18n.('ruby_version.support_ended', version: '2.1.0', year: '2017', month: '04', day: '01'))
   elsif RubyVersion.is? 2.0
@@ -36,7 +40,7 @@ if RubyVersion < '2.3.0'
   exit 1
 end
 
-if RubyVersion < '2.4'
+if RubyVersion < '2.4' # TODO: deprecate ruby 2.5 (eol 2021-03-31)
   STDERR.puts(I18n.t('ruby_version.current_version', engine: RUBY_ENGINE, version: RUBY_VERSION))
   STDERR.puts(I18n.t('ruby_version.deprecation_warning', version: '2.3'))
   STDERR.puts(I18n.t('ruby_version.support_ended', version: '2.3', year: '2019', month: '03', day: '31'))
@@ -45,7 +49,7 @@ end
 require 'hiptest-publisher'
 begin
   require 'pry' # only available in development
-rescue LoadError
+rescue StandardError, LoadError
 end
 
 Hiptest::Publisher.new(ARGV).run

data/config/locales/en.yml

@@ -66,7 +66,7 @@ en:
     up_to_date: Your current install of hiptest-publisher (%{current}) is up-to-date.
   default: default
   errors:
-    api_error: HipTest API returned error %{code}
+    api_error: CucumberStudio API returned error %{code}
     cli_options:
       actionwords_signature_directory: 'Bad Action Words signature file: the file "%{path}" is a directory'
       filter_status_without_test_run: |
@@ -86,7 +86,7 @@ en:
 
         Found: %{incorrect_value}
       invalid_tag_value_list: |
-        %{option} should be a list of comma separated tags in HipTest
+        %{option} should be a list of comma separated tags from CucumberStudio
 
         Found: %{incorrect_value}
       invalid_test_run_id: 'Invalid format --test-run-id="%{test_run_id}": the test run id must be numeric'
@@ -100,7 +100,7 @@ en:
       missing_token: |
         Missing argument --token: you must specify project secret token with --token=<project-token>
 
-        The project secret token can be found on HipTest in the settings section, under
+        The project secret token can be found on CucumberStudio in the settings section, under
         'Test code generation'. It is a sequence of numbers uniquely identifying your
         project.
 
@@ -128,9 +128,9 @@ en:
     no_test_runs: 'No matching test run found: this project does not have any test runs.'
     project_not_found: No project found with this secret token.
     template_not_found: no template with name %{template_name} in dirs %{dirs}
-    test_run_list_unavailable: Cannot get the list of available test runs from HipTest. Try using --test-run-id instead of --test-run-name
+    test_run_list_unavailable: Cannot get the list of available test runs from CucumberStudio. Try using --test-run-id instead of --test-run-name
   exporting_file: Exporting %{name}
-  fetching_data: Fetching data from HipTest
+  fetching_data: Fetching data from CucumberStudio
   using_cached_data: Using cached data from previous export
   caching_data: Caching data
   using_cache: "Using cache: %{full_path}"
@@ -148,7 +148,7 @@ en:
             hiptest-publisher --language=%{language} --only=%{first},%{second}
     description: |2
 
-      Exports tests from HipTest for automation.
+      Exports tests from CucumberStudio for automation.
 
       Specific options:
     header: 'Usage: hiptest-publisher [options]'
@@ -183,9 +183,9 @@ en:
     framework: Test framework to use
     global_failure_on_missing_reports: When there is no results file to push, report a global failure
     help: Show this message
-    http_proxy: 'Specify your http proxy to access Hiptest'
-    keep_filenames: 'Keep the same name as in HipTest for the test files (note: may cause encoding issues)'
-    keep_foldernames: 'Keep the same name as in HipTest for the folders (note: may cause encoding issues)'
+    http_proxy: 'Specify your http proxy to access CucumberStudio'
+    keep_filenames: 'Keep the same name as in CucumberStudio for the test files (note: may cause encoding issues)'
+    keep_foldernames: 'Keep the same name as in CucumberStudio for the folders (note: may cause encoding issues)'
     language: Target language
     languages_help: Show languages and framework options
     leafless_export: Use only last level action word
@@ -195,12 +195,13 @@ en:
     only: Restrict export to given file categories (--only=list to list them)
     output_directory: Output directory
     overriden_templates: Folder for overriden templates
+    overriden_language_configs: Folder for overriden language configs
     parameter_delimiter: Parameter delimiter (for Gherkin based export only)
     parent_folder_tags: 'Export tags from parent folders (note: if set to false, those tags are never rendered. Only available for Gherkin base exports)'
     push: Push a results file to the server
     push_format: Format of the test results (cucumber-json, junit, nunit, robot, tap)
     site: Site to fetch from
-    sort: 'Sorting of tests in output: id will sort them by age, order will keep the same order than in hiptest (only with --with-folders option, will fallback to id otherwise), alpha will sort them by name'
+    sort: 'Sorting of tests in output: id will sort them by age, order will keep the same order as in CucumberStudio (only with --with-folders option, will fallback to id otherwise), alpha will sort them by name'
     split_scenarios: Export each scenario in a single file (except for Gherkin based languages)
     test_run_id: Export data from a test run identified by its id
     test_run_name: Export data from a test run identified by its name
@@ -211,9 +212,9 @@ en:
     with_dataset_names: 'Export dataset name when creating feature files (note: available only for Gherkin-based exports)'
     with_folders: Use folders hierarchy to export files in respective directories
     without: Exclude file categories from import (--only=list to list them)
-    xml_file: XML file to use instead of fetching it from HipTest
-    cache_dir: "Path to the directory to store cache of Hiptest data"
-    cache_duration: "Validity of the Hiptest data cache in seconds"
+    xml_file: XML file to use instead of fetching it from CucumberStudio
+    cache_dir: "Path to the directory to store cache of CucumberStudio data"
+    cache_duration: "Validity of the CucumberStudio data cache in seconds"
     indentation: Customize indentation
   overwrite:
     ask_confirmation: 'File %{path} exists, do you want to overwrite it? [y/N] '

data/lib/config/cucumber-typescript.conf

@@ -1,41 +1,41 @@
-[_common]
-indentation = '    '
-fallback_template = 'empty'
-
-[features]
-node_name = folders
-template_dirs = gherkin/inlined_uids, gherkin, common
-named_filename = '%s.feature'
-indentation = '  '
-renderer_addons = 'GherkinAddon'
-
-[step_definitions]
-node_name = actionwords
-template_dirs = cucumber/typescript, javascript, common
-filename = 'step_definitions.ts'
-naming_convention = 'camelize_lower'
-call_prefix = 'actionwords'
-renderer_addons = 'GherkinAddon'
-
-[step_definitions_library]
-node_name = libraries
-template_dirs = cucumber/typescript, javascript, common
-named_filename = 'steps_%s.ts'
-naming_convention = 'camelize_lower'
-call_prefix = 'actionwords'
-renderer_addons = 'GherkinAddon'
-
-[actionwords]
-template_dirs = typescript, javascript, common
-filename = 'actionwords.ts'
-naming_convention = 'camelize_lower'
-
-
-[library]
-template_dirs =  typescript, javascript, common
-filename = 'actionword_library.ts'
-
-[libraries]
-template_dirs = typescript, javascript, common
-named_filename = '%s_library.ts'
-filename_convention = 'underscore'
+[_common]
+indentation = '    '
+fallback_template = 'empty'
+
+[features]
+node_name = folders
+template_dirs = gherkin/inlined_uids, gherkin, common
+named_filename = '%s.feature'
+indentation = '  '
+renderer_addons = 'GherkinAddon'
+
+[step_definitions]
+node_name = actionwords
+template_dirs = cucumber/typescript, javascript, common
+filename = 'step_definitions.ts'
+naming_convention = 'camelize_lower'
+call_prefix = 'actionwords'
+renderer_addons = 'GherkinAddon'
+
+[step_definitions_library]
+node_name = libraries
+template_dirs = cucumber/typescript, javascript, common
+named_filename = 'steps_%s.ts'
+naming_convention = 'camelize_lower'
+call_prefix = 'actionwords'
+renderer_addons = 'GherkinAddon'
+
+[actionwords]
+template_dirs = typescript, javascript, common
+filename = 'actionwords.ts'
+naming_convention = 'camelize_lower'
+
+
+[library]
+template_dirs =  typescript, javascript, common
+filename = 'actionword_library.ts'
+
+[libraries]
+template_dirs = typescript, javascript, common
+named_filename = '%s_library.ts'
+filename_convention = 'underscore'

data/lib/config/cucumber_legacy-groovy.conf

@@ -0,0 +1,40 @@
+[_common]
+package = 'com.example'
+fallback_template = 'empty'
+indentation = '    '
+dirname_convention = 'underscore'
+filename_convention = 'camelize'
+naming_convention = 'camelize_lower'
+
+[features]
+node_name = folders
+template_dirs = gherkin/inlined_uids, gherkin/java, gherkin, common
+named_filename = '%s.feature'
+indentation = '  '
+renderer_addons = 'GherkinAddon'
+
+[step_definitions]
+node_name = actionwords
+template_dirs = cucumber_legacy/groovy/step-definitions, cucumber/groovy/step-definitions, groovy, java, common
+filename = 'StepDefinitions.groovy'
+call_prefix = 'actionwords'
+renderer_addons = 'GherkinAddon'
+
+[step_definitions_library]
+node_name = libraries
+call_prefix = 'actionwords'
+template_dirs = cucumber_legacy/groovy/step-definitions, cucumber/groovy/step-definitions, groovy, java, common
+named_filename = 'StepDefinitions%s.groovy'
+renderer_addons = 'GherkinAddon'
+
+[actionwords]
+template_dirs = groovy, java, common
+filename = 'Actionwords.groovy'
+
+[library]
+template_dirs = groovy, java, common
+filename = 'ActionwordLibrary.groovy'
+
+[libraries]
+template_dirs = groovy, java, common
+named_filename = '%sLibrary.groovy'

data/lib/config/cucumber_legacy-java.conf

@@ -0,0 +1,24 @@
+[_common]
+package = 'com.example'
+indentation = '    '
+fallback_template = 'empty'
+
+[features]
+node_name = folders
+template_dirs = gherkin/inlined_uids, gherkin/java, gherkin, common
+named_filename = '%s.feature'
+indentation = '  '
+renderer_addons = 'GherkinAddon'
+
+[step_definitions]
+node_name = actionwords
+template_dirs = cucumber_legacy/java, cucumber/java, java, common
+filename = 'StepDefinitions.java'
+naming_convention = 'camelize_lower'
+call_prefix = 'actionwords'
+renderer_addons = 'GherkinAddon'
+
+[actionwords]
+template_dirs = cucumber_legacy/java/actionwords, cucumber/java/actionwords, java, common
+filename = 'Actionwords.java'
+naming_convention = 'camelize_lower'

data/lib/config/{cucumber_expressions-typescript.conf → cucumber_legacy-typescript.conf}

@@ -1,41 +1,41 @@
-[_common]
-indentation = '    '
-fallback_template = 'empty'
-
-[features]
-node_name = folders
-template_dirs = gherkin/inlined_uids, gherkin, common
-named_filename = '%s.feature'
-indentation = '  '
-renderer_addons = 'GherkinAddon'
-
-[step_definitions]
-node_name = actionwords
-template_dirs = cucumber_expressions/typescript, cucumber/typescript, javascript, common
-filename = 'step_definitions.ts'
-naming_convention = 'camelize_lower'
-call_prefix = 'actionwords'
-renderer_addons = 'GherkinAddon'
-
-[step_definitions_library]
-node_name = libraries
-template_dirs = cucumber_expressions/typescript, cucumber/typescript, javascript, common
-named_filename = 'steps_%s.ts'
-naming_convention = 'camelize_lower'
-call_prefix = 'actionwords'
-renderer_addons = 'GherkinAddon'
-
-[actionwords]
-template_dirs = typescript, javascript, common
-filename = 'actionwords.ts'
-naming_convention = 'camelize_lower'
-
-
-[library]
-template_dirs =  typescript, javascript, common
-filename = 'actionword_library.ts'
-
-[libraries]
-template_dirs = typescript, javascript, common
-named_filename = '%s_library.ts'
-filename_convention = 'underscore'
+[_common]
+indentation = '    '
+fallback_template = 'empty'
+
+[features]
+node_name = folders
+template_dirs = gherkin/inlined_uids, gherkin, common
+named_filename = '%s.feature'
+indentation = '  '
+renderer_addons = 'GherkinAddon'
+
+[step_definitions]
+node_name = actionwords
+template_dirs = cucumber_legacy/typescript, cucumber/typescript, javascript, common
+filename = 'step_definitions.ts'
+naming_convention = 'camelize_lower'
+call_prefix = 'actionwords'
+renderer_addons = 'GherkinAddon'
+
+[step_definitions_library]
+node_name = libraries
+template_dirs = cucumber_legacy/typescript, cucumber/typescript, javascript, common
+named_filename = 'steps_%s.ts'
+naming_convention = 'camelize_lower'
+call_prefix = 'actionwords'
+renderer_addons = 'GherkinAddon'
+
+[actionwords]
+template_dirs = typescript, javascript, common
+filename = 'actionwords.ts'
+naming_convention = 'camelize_lower'
+
+
+[library]
+template_dirs =  typescript, javascript, common
+filename = 'actionword_library.ts'
+
+[libraries]
+template_dirs = typescript, javascript, common
+named_filename = '%s_library.ts'
+filename_convention = 'underscore'

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,7 +252,7 @@ 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),
@@ -383,6 +384,7 @@ class NodeRenderingContext
 
   def renderer_addons
     addons = @properties.renderer_addons || ""
+
     addons.split.map do |addon_name|
       Hiptest.const_get(addon_name)
     end
@@ -390,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,
@@ -696,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?