hiptest-publisher 1.31.0 → 3.0.0

data/bin/hiptest-publisher

@@ -16,13 +16,21 @@ require 'ruby_version'
 require 'hiptest-publisher/i18n'
 require 'hiptest-publisher/utils'
 
-# Ensure ruby version >= 2
-if RubyVersion < '2.1.0'
-  STDERR.puts(I18n.t('ruby_version.required_version', version: '2.1.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.0
+  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
     STDERR.puts(I18n.('ruby_version.support_ended', version: '2.0.0', year: '2016', month: '02', day: '24'))
   elsif RubyVersion.is? '1.9.3'
     STDERR.puts(I18n.('ruby_version.support_ended', version: '1.9.3', year: '2015', month: '02', day: '23'))
@@ -32,16 +40,16 @@ if RubyVersion < '2.1.0'
   exit 1
 end
 
-if RubyVersion < '2.3'
+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.2'))
-  STDERR.puts(I18n.t('ruby_version.support_ended', version: '2.2', year: '2018', month: '03', day: '31'))
+  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'))
 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]'
@@ -168,6 +168,7 @@ en:
     aw_renamed: Output signatures of renamed action words
     aw_signature_changed: Output signatures of action words for which signature changed
     check_version: Check if a new release of hiptest-publisher is available
+    color: Force [un]use of ANSI color in text output
     config: Configuration file
     empty_folders: Export empty folders
     execution_environment: Name of the execution environment
@@ -182,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
@@ -194,25 +195,27 @@ 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
     tests_only: "(deprecated) alias for --only=tests"
     token: Secret token (available in your project settings)
-    uids: 'Export UIDs (note: can be disabled only for Gherkin-based exports, may cause issue when pushing results back)'
+    uids: 'Export UIDs for Gherkin-based exports (note: disabled by default, enabled when specifying test run, disabling it may cause issue when pushing results back into test run)'
     verbose: Run verbosely
     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] '
     warning_message: File %{path} already exists, skipping. Use --force to overwrite it.

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_legacy-typescript.conf

@@ -0,0 +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_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.rb

@@ -83,15 +83,15 @@ 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
-      puts err.message.yellow
+      reporter.show_error(err.message)
       if @exit_on_bad_arguments == false # means we are embedded in hiptest-publisher
         raise
       end
     rescue => err
-      puts I18n.t("errors.default").red
+      reporter.show_failure(I18n.t("errors.default"))
       reporter.dump_error(err)
     end
 
@@ -113,10 +113,8 @@ module Hiptest
       return true unless File.file?(path)
       return true if @cli_options.force_overwrite
 
-      if $stdout.isatty
-        STDOUT.print "\n"
-        STDOUT.print "[#{"?".yellow}] #{I18n.t('overwrite.ask_confirmation', path: path)}"
-        answer = $stdin.gets.chomp.downcase.strip
+      if $stdout.tty?
+        answer = reporter.ask(I18n.t('overwrite.ask_confirmation', path: path))
         return ['y', 'yes'].include?(answer)
       else
         reporter.warning_message(I18n.t('overwrite.warning_message', path: path))

data/lib/hiptest-publisher/client.rb

@@ -21,6 +21,9 @@ module Hiptest
     end
   end
 
+  class AsyncExportUnavailable < StandardError
+  end
+
   class MaximumRedirectionReachedError < StandardError
   end
 
@@ -28,10 +31,12 @@ 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
@@ -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