hiptest-publisher 2.0.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 36283085bf8b4776b1a854fed8a9dc0c96d7e84a
-  data.tar.gz: 040bc62f36aaa7b1aa54b354ba205ce4bc2660d6
+SHA256:
+  metadata.gz: 5bcc0cd663f5ba7411031e5f8db901bd7229fe6d88a7deb815cbfc82dde9e8ea
+  data.tar.gz: 165c9da7b30f07d0eeacbdaef4aae5fefa9146533ee826898971d646ecc6adcf
 SHA512:
-  metadata.gz: 88d3eba37283240cd6632fef52cdc0bd55fda0544428bf29b92cc648760e0ef59c06bbfecf863773e6bbba626f08d17de4d6efec4aabfe07a4cb93e93dec7e80
-  data.tar.gz: f8d676bc23cc00e1428c64b9f1f41b33c269feffbfe0afd3f27c6ba353bfd4d27fee1024eddf2bd568d53526a6f63e9be531504a694ca492b18727a6c9083b77
+  metadata.gz: 824256833f21ff08a6693ca63a5d5d40f1d15e54b9a6df78152d98bc94ac9f5fc67b04b0c371b6f2ac3d24ef9e0e3d454d680c4de4fe3ca7972f50e5ec6753a2
+  data.tar.gz: 9b58353c5f481931ca91ed563cff619d4738589a0c35bea5f3cfb7bf53324719999bc718697001e2d83623f2854e0251af76a4a14bb9e8328846d7a215194755

data/README.md

@@ -55,13 +55,24 @@ 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)
+ - Behat
+ - Behave
+ - CSharp (NUnit)
+ - Cucumber (Groovy / Java / Javascript / Ruby / TypeScript)
+ - Cucumber Expressions (TypeScript)*
+ - Groovy (Spock)
+ - Java (Espresso / JUnit / TestNg)
+ - JavaScript (CodeceptJS / Jasmine / Mocha / Protractor / QUnit)
+ - JBehave
+ - PHP (PHPUnit / UnitTest)
+ - Python (UnitTest)
  - Robot Framework
+ - Ruby (MiniTest / RSpec)
  - Selenium IDE
- - Javascript (qUnit / Jasmine)
+ - SpecFlow
+ - Swift (XCTest)
+
+*Cucumber Expressions is standard Cucumber syntax that makes use of [Cucumber Expressions](https://cucumber.io/docs/cucumber/cucumber-expressions/)
 
 You can specify the output language and framework in the command line, for example:
 
@@ -148,6 +159,7 @@ Specific options:
         --not-recursive              Used in conjunction with filter-on-folder-ids or filter-on-folder-name: only exports those folders, not their children (default: false)
         --check-version              Check if a new release of hiptest-publisher is available (default: false)
         --force                      Force overwrite of existing files (do not apply to test files) (default: false)
+        --[no-]color                 Force [un]use of ANSI color in text output
     -v, --verbose                    Run verbosely (default: false)
     -H, --languages-help             Show languages and framework options
     -h, --help                       Show this message

data/config/locales/en.yml

@@ -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
@@ -205,7 +206,7 @@ en:
     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
@@ -213,6 +214,7 @@ en:
     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"
+    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_expressions-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_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'

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

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,18 @@ 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?
       rows, columns = IO.console.winsize
       return if columns == 0
       @immediate_verbose = false
@@ -68,4 +77,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/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,18 +203,20 @@ class OptionsParser
     {
       'Ruby' => ['Rspec', 'MiniTest'],
       'Cucumber' => ['Ruby', 'Java', 'Javascript', 'Groovy', 'TypeScript'],
+      'Cucumber_Expressions' => ['TypeScript'],
       'Java' => ['JUnit', 'Test NG', 'Espresso'],
       'Python' => ['Unittest'],
       'Robot Framework' => [''],
       'Selenium IDE' => [''],
       'Javascript' => ['qUnit', 'Jasmine', 'Mocha', 'Protractor', 'CodeceptJS'],
       'CSharp' => ['NUnit'],
-      'PHP' => ['PHPUnit'],
+      'PHP' => ['PHPUnit', 'UnitTest'],
       'SpecFlow' => [''],
       'Behave' => [''],
       'Behat' => [''],
       'Groovy' => ['Spock'],
-      'JBehave' => ['']
+      'JBehave' => [''],
+      'Swift' => ['XCTest']
     }
   end
 
@@ -247,7 +258,7 @@ class OptionsParser
       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 +274,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 +313,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)
@@ -555,6 +574,7 @@ class LanguageGroupConfig
   end
 
   def indentation
+    return @user_params[:indent] unless @user_params[:indent].nil?
     @language_group_params[:indentation] || '  '
   end
 

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_expressions/typescript/actionword.hbs

@@ -0,0 +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}}
+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/typescript/libraryactionword.hbs

@@ -0,0 +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}}
+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/groovy/_scenario.hbs

@@ -1,5 +1,5 @@
 {{#if has_datasets?}}
-@Unroll("{{{ escape_double_quotes rendered_children.name }}} #hiptestUid")
+@Unroll("{{{ escape_double_quotes rendered_children.name }}}{{#if context.uids}} #hiptestUid{{/if}}")
 {{/if}}def "{{{ escape_double_quotes rendered_children.name }}}{{#if rendered_children.uid}} (uid:{{{  rendered_children.uid}}}){{/if}}"() {{#curly}}{{#indent}}{{> desc}}{{#unless has_annotations?}}{{#unless is_empty?}}
 expect:{{/unless}}{{/unless}}
 {{> steps}}{{#if has_datasets?}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiptest-publisher
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.4.0
 platform: ruby
 authors:
 - HipTest R&D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -259,6 +259,7 @@ files:
 - lib/config/cucumber-javascript.conf
 - lib/config/cucumber-ruby.conf
 - lib/config/cucumber-typescript.conf
+- lib/config/cucumber_expressions-typescript.conf
 - lib/config/groovy-spock.conf
 - lib/config/java-espresso.conf
 - lib/config/java-junit.conf
@@ -326,6 +327,7 @@ files:
 - lib/templates/behave/libraryactionword.hbs
 - lib/templates/behave/nullliteral.hbs
 - lib/templates/common/_gherkin_pattern.hbs
+- lib/templates/common/_gherkin_typed_pattern.hbs
 - lib/templates/common/booleanliteral.hbs
 - lib/templates/common/dataset.hbs
 - lib/templates/common/datatable.hbs
@@ -391,6 +393,8 @@ files:
 - lib/templates/cucumber/typescript/actionwords.hbs
 - lib/templates/cucumber/typescript/library.hbs
 - lib/templates/cucumber/typescript/libraryactionword.hbs
+- lib/templates/cucumber_expressions/typescript/actionword.hbs
+- lib/templates/cucumber_expressions/typescript/libraryactionword.hbs
 - lib/templates/gherkin/_call.hbs
 - lib/templates/gherkin/_gherkin_text.hbs
 - lib/templates/gherkin/_scenario.hbs
@@ -749,7 +753,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Export your tests from HipTest into executable tests.