hiptest-publisher 1.29.2 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e46a8377ebb5194adc0952ea548e76247f71a935
-  data.tar.gz: 50191888c1dd19ae3118ca0d0857cc81608343b4
+SHA256:
+  metadata.gz: e51e585e6cfddfb427d0ce4d5ccd898d812072b5def6ada9ac19eb2ebfec7b07
+  data.tar.gz: d23a1a44229b281b0ae4a6ab8d561923f35d99fc3bba9cd5ad546217363f2a6a
 SHA512:
-  metadata.gz: af82fded9be8f62cb73c6c02a680bfed6f22a2852dfdc4da225a57d8de4076a634e334bc813d4aefafbed1eaaf16e16e1ca2ab696dd81aa749e3e59a680e9970
-  data.tar.gz: c00061e41e5ef13453fc152b8c51b219da654d442b94e0be10134041250e7f72c3231e52bafd9351a6b19d65579b62dfcd115a35feb7cb6d320ea3b8fd71c652
+  metadata.gz: ecb76a6be315f0ccc199e52708fcd9df128f04d1b3c0d66fd1327d09360b5975d3414887af2950f82ebda04581e0139307a014e7d869cf1a78102d77e23c66ed
+  data.tar.gz: 3cae8f924fefc9bc926a6cee22463f3abfbd9afc917c9ae12d51e3baecd23927ef51d654cafba4f1db7442644a8f9d975f4cf055b6ab9477974f484441ce53bf

data/config/locales/en.yml

@@ -117,6 +117,8 @@ en:
     default: |
       An error has occured, sorry for the inconvenience.
       Try running the command again with --verbose for detailed output
+    export_cache:
+      cache_dir_not_creatable: Unable to create directory %{cache_dir}
     invalid_config_file: cannot find configuration file in "%{hiptest_publisher_path}/lib/config" for language %{language} and framework %{framework}
     invalid_config_file_no_framework: cannot find configuration file in "%{hiptest_publisher_path}/lib/config" for language %{language}
     invalid_node: Invalid node_name %{name} in language group [%{group_name}]
@@ -129,6 +131,9 @@ en:
     test_run_list_unavailable: Cannot get the list of available test runs from HipTest. Try using --test-run-id instead of --test-run-name
   exporting_file: Exporting %{name}
   fetching_data: Fetching data from HipTest
+  using_cached_data: Using cached data from previous export
+  caching_data: Caching data
+  using_cache: "Using cache: %{full_path}"
   help:
     categories:
       title: For language %{language}, available file groups are
@@ -206,6 +211,8 @@ en:
     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"
   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/swift-xctest.conf

@@ -0,0 +1,18 @@
+[_common]
+template_dirs = swift, common
+indentation = '  '
+comment = '//'
+
+[tests]
+filename = 'ProjectUITests.swift'
+named_filename = '%sUITest.swift'
+filename_convention = 'camelize'
+naming_convention = 'camelize'
+call_prefix = 'app'
+comment = '//'
+
+[actionwords]
+filename = 'Actionwords.swift'
+naming_convention = 'camelize'
+call_prefix = 'this'
+comment = '//'

data/lib/hiptest-publisher.rb

@@ -83,9 +83,7 @@ module Hiptest
     end
 
     def fetch_xml_file
-      reporter.with_status_message I18n.t(:fetching_data) do
-        @client.fetch_project_export
-      end
+      @client.fetch_project_export
     rescue ClientError => err
       # This should not be an error that needs reporting to an exception monitoring app
       puts err.message.yellow

data/lib/hiptest-publisher/client.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'net/http'
 require 'uri'
 
+require_relative 'export_cache'
 require_relative 'formatters/reporter'
 
 module Hiptest
@@ -72,11 +73,25 @@ module Hiptest
     end
 
     def fetch_project_export
-      response = send_get_request(url)
-      if response.code_type == Net::HTTPNotFound
-        raise ClientError, I18n.t('errors.project_not_found')
+      cached = export_cache.cache_for(url)
+
+      unless cached.nil?
+        @reporter.with_status_message I18n.t(:using_cached_data) do
+          return cached
+        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)
+
+        return content
       end
-      response.body
     end
 
     def available_test_runs
@@ -108,6 +123,13 @@ module Hiptest
 
     private
 
+    def export_cache
+      @export_cache ||= ExportCache.new(
+        @cli_options.cache_dir,
+        @cli_options.cache_duration,
+        reporter: @reporter)
+    end
+
     def test_run_id
       return unless cli_options.test_run_id? || cli_options.test_run_name?
 

data/lib/hiptest-publisher/export_cache.rb

@@ -0,0 +1,85 @@
+require 'i18n'
+
+require_relative 'formatters/reporter'
+require_relative 'file_writer'
+
+
+module Hiptest
+  class ExportCache
+    def initialize(cache_dir, cache_duration, reporter: nil)
+      @cache_dir = cache_dir
+      @cache_duration = cache_duration
+      @reporter = reporter || Reporter.new
+
+      clear_cache
+    end
+
+    def cache(url, content, date: nil)
+      return if @cache_duration <= 0
+
+      date ||= Time.now
+      filename = "#{Digest::MD5.hexdigest(url)}-#{date.to_i}"
+
+      file_writer.write_to_file(File.join(@cache_dir, filename), I18n.t("caching_data")) { content }
+    end
+
+    def cache_for(url)
+      return if @cache_duration <= 0
+
+      hashed_url = Digest::MD5.hexdigest(url)
+      expiry_date = (Time.now - @cache_duration).to_i
+
+      cached_filename = cached_filenames
+        .select do |filename |
+          filename.start_with?("#{hashed_url}-") && !expired?(filename, expiry_date)
+        end
+        .sort do | f1, f2|
+          timestamp_from_filename(f1) <=> timestamp_from_filename(f2)
+        end
+        .last
+
+      return nil if cached_filename.nil?
+
+      full_path = File.join(@cache_dir, cached_filename)
+      @reporter.show_verbose_message(I18n.t(:using_cache, full_path: full_path))
+      File.read(full_path)
+    end
+
+    def clear_cache
+      expired_files.map do |filename|
+        FileUtils.rm(File.join(@cache_dir, filename))
+      end
+    end
+
+    private
+
+    def file_writer
+      FileWriter.new(@reporter)
+    end
+
+    def expired_files
+      expiry_date = (Time.now - @cache_duration).to_i
+
+      cached_filenames.select do |filename |
+        expired?(filename, expiry_date)
+      end
+    end
+
+    def cached_filenames
+      Dir
+        .entries(@cache_dir)
+        .select { |entry| File.file?(File.join(@cache_dir, entry)) }
+      rescue Errno::ENOENT => err
+        []
+    end
+
+    def expired?(filename, expiry_date)
+      timestamp_from_filename(filename) < expiry_date
+    end
+
+    def timestamp_from_filename(filename)
+      m = filename.match(/\A[a-f0-9]{32}-(\d+)\Z/)
+      m.nil? ? nil : m[1].to_i
+    end
+  end
+end

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

@@ -51,6 +51,10 @@ class Reporter
 end
 
 class NullReporter
+  def with_status_message(message, &blk)
+    yield
+  end
+
   def method_missing(*args)
   end
 end

data/lib/hiptest-publisher/handlebars_helper.rb

@@ -42,9 +42,14 @@ module Hiptest
 
     def register_custom_helpers
       self.class.instance_methods.each do |method_name|
-        next unless method_name.to_s.start_with? 'hh_'
-        @handlebars.register_helper(method_name.to_s.gsub(/hh_/, '')) do |*args|
-          send(method_name, *args)
+        if method_name.to_s.start_with? 'hh_'
+          @handlebars.register_helper(method_name.to_s.gsub(/hh_/, '')) do |*args|
+            send(method_name, *args)
+          end
+        elsif method_name.to_s.start_with? 'as_hh_'
+          @handlebars.register_as_helper(method_name.to_s.gsub(/as_hh_/, '')) do |*args|
+            send(method_name, *args)
+          end
         end
       end
     end
@@ -59,6 +64,10 @@ module Hiptest
     end
 
     def hh_join(context, items, joiner, block, else_block = nil)
+      as_hh_join(context, items, joiner, :this, block, else_block)
+    end
+
+    def as_hh_join(context, items, joiner, name, block, else_block = nil)
       joiner = joiner.to_s
       joiner.gsub!(/\\t/, "\t")
       joiner.gsub!(/\\n/, "\n")
@@ -71,7 +80,7 @@ module Hiptest
         end
 
         items.map do |item|
-          context.with_temporary_context(this: item) do
+          context.with_temporary_context(name => item) do
             block.fn(context)
           end
         end.join(joiner)

data/lib/hiptest-publisher/options_parser.rb

@@ -223,6 +223,8 @@ class OptionsParser
       Option.new(nil, 'only=CATEGORIES', nil, String, I18n.t('options.only'), :only),
       Option.new(nil, 'without=CATEGORIES', nil, String, I18n.t('options.without'), :without),
       Option.new('x', 'xml-file=PROJECT_XML', nil, String, I18n.t('options.xml_file'), :xml_file),
+      Option.new(nil, 'cache-dir=PATH', self.default_cache_directory, String, I18n.t('options.cache_dir'), :cache_dir),
+      Option.new(nil, 'cache-duration=DURATION', 60, Integer, I18n.t('options.cache_duration'), :cache_duration),
       Option.new(nil, 'tests-only', false, nil, I18n.t('options.tests_only'), :tests_only),
       Option.new(nil, 'actionwords-only', false, nil, I18n.t('options.actionwords_only'), :actionwords_only),
       Option.new(nil, 'actionwords-signature', false, nil, I18n.t('options.actionwords_signature'), :actionwords_signature),
@@ -265,6 +267,10 @@ class OptionsParser
     ]
   end
 
+  def self.default_cache_directory
+    File.join(Dir.home, '.hiptest-publisher', 'cache')
+  end
+
   def self.parse(args, reporter)
     options = CliOptions.new
     opt_parser = OptionParser.new do |opts|

data/lib/templates/behat/actionword.hbs

@@ -3,6 +3,6 @@
  * @{{{ rendered_children.gherkin_annotation }}} /{{> gherkin_pattern}}/
  */
 public function {{{ camelize_lower rendered_children.name }}}({{#if has_parameters?}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}){{#curly}}{{#indent}}
-$this->actionwords->{{{ camelize_lower rendered_children.name }}}({{#if has_parameters?}}{{#join raw_parameter_names ', '}}${{{underscore this}}}{{/join}}{{/if}});
+$this->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/behat/actionwords.hbs

@@ -10,7 +10,7 @@ class FeatureContext implements SnippetAcceptingContext {{#curly}}{{#indent}}
 public function __construct() {{#curly}}{{#indent}}
 $this->actionwords = new Actionwords();{{/indent}}
 {{/curly}}
-{{#each rendered_children.actionwords}}
-{{{this}}}{{/each}}{{/indent}}
+{{#each rendered_children.actionwords as |actionword|}}
+{{{actionword}}}{{/each}}{{/indent}}
 {{/curly}}
 ?>

data/lib/templates/behat/library.hbs

@@ -10,7 +10,7 @@ class {{camelize rendered_children.name}}FeatureContext implements SnippetAccept
 public function __construct() {{#curly}}{{#indent}}
 $this->actionwords = new Actionwords();{{/indent}}
 {{/curly}}
-{{#each rendered_children.library_actionwords}}
-{{{this}}}{{/each}}{{/indent}}
+{{#each rendered_children.library_actionwords as |actionword|}}
+{{{actionword}}}{{/each}}{{/indent}}
 {{/curly}}
 ?>

data/lib/templates/behat/libraryactionword.hbs

@@ -3,6 +3,6 @@
  * @{{{ rendered_children.gherkin_annotation }}} /{{> gherkin_pattern}}/
  */
 public function {{{ camelize_lower rendered_children.name }}}({{#if has_parameters?}}{{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}){{#curly}}{{#indent}}
-$this->actionwords->get{{{camelize library_name}}}Library()->{{{ camelize_lower rendered_children.name }}}({{#if has_parameters?}}{{#join raw_parameter_names ', '}}${{{underscore this}}}{{/join}}{{/if}});
+$this->actionwords->get{{{camelize library_name}}}Library()->{{{ camelize_lower rendered_children.name }}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}${{{underscore param}}}{{/join}}{{/if}});
 {{/indent}}
 {{/curly}}{{/if}}

data/lib/templates/behave/actionword.hbs

@@ -1,4 +1,4 @@
 {{#if rendered_children.gherkin_used_annotations}}
-{{#each rendered_children.gherkin_used_annotations}}@{{{downcase this }}}(r'{{#remove_last_character ':'}}{{#escape_single_quotes}}{{#strip_regexp_delimiters}}{{> gherkin_pattern}}{{/strip_regexp_delimiters}}{{/escape_single_quotes}}{{/remove_last_character}}')
+{{#each rendered_children.gherkin_used_annotations as |annotation|}}@{{{downcase annotation }}}(r'{{#remove_last_character ':'}}{{#escape_single_quotes}}{{#strip_regexp_delimiters}}{{> gherkin_pattern}}{{/strip_regexp_delimiters}}{{/escape_single_quotes}}{{/remove_last_character}}')
 {{/each}}def impl(context{{#if has_parameters?}}, {{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}):{{#indent}}
-context.actionwords.{{{ underscore rendered_children.name }}}({{#if has_parameters?}}{{#join raw_parameter_names ', '}}{{#replace "__datatable" "context.table"}}{{#replace "__free_text" "context.text"}}{{{underscore this}}}{{/replace}}{{/replace}}{{/join}}{{/if}}){{/indent}}{{/if}}
+context.actionwords.{{{ underscore rendered_children.name }}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{#replace "__datatable" "context.table"}}{{#replace "__free_text" "context.text"}}{{{underscore param}}}{{/replace}}{{/replace}}{{/join}}{{/if}}){{/indent}}{{/if}}

data/lib/templates/behave/actionwords.hbs

@@ -7,6 +7,6 @@ from behave import *
 #     context.actionwords = Actionwords()
 
 use_step_matcher('re')
-{{#each rendered_children.sorted_actionwords}}
-{{{this}}}
+{{#each rendered_children.sorted_actionwords as |actionword|}}
+{{{ actionword }}}
 {{/each}}

data/lib/templates/behave/library.hbs

@@ -2,6 +2,6 @@ from behave import *
 
 
 use_step_matcher('re')
-{{#each rendered_children.library_actionwords}}
-{{{this}}}
+{{#each rendered_children.library_actionwords as |actionword|}}
+{{{ actionword }}}
 {{/each}}

data/lib/templates/behave/libraryactionword.hbs

@@ -1,4 +1,4 @@
 {{#if rendered_children.gherkin_used_annotations}}
-{{#each rendered_children.gherkin_used_annotations}}@{{{downcase this }}}(r'{{#remove_last_character ':'}}{{#escape_single_quotes}}{{#strip_regexp_delimiters}}{{> gherkin_pattern}}{{/strip_regexp_delimiters}}{{/escape_single_quotes}}{{/remove_last_character}}')
+{{#each rendered_children.gherkin_used_annotations as |annotation|}}@{{{downcase annotation }}}(r'{{#remove_last_character ':'}}{{#escape_single_quotes}}{{#strip_regexp_delimiters}}{{> gherkin_pattern}}{{/strip_regexp_delimiters}}{{/escape_single_quotes}}{{/remove_last_character}}')
 {{/each}}def impl(context{{#if has_parameters?}}, {{{ join rendered_children.parameters_ordered_by_pattern ', '}}}{{/if}}):{{#indent}}
-context.actionwords.get{{capitalize library_name}}Library().{{{ underscore rendered_children.name }}}({{#if has_parameters?}}{{#join raw_parameter_names ', '}}{{#replace "__datatable" "context.table"}}{{#replace "__free_text" "context.text"}}{{{underscore this}}}{{/replace}}{{/replace}}{{/join}}{{/if}}){{/indent}}{{/if}}
+context.actionwords.get{{capitalize library_name}}Library().{{{ underscore rendered_children.name }}}({{#if has_parameters?}}{{#join raw_parameter_names ', ' as |param|}}{{#replace "__datatable" "context.table"}}{{#replace "__free_text" "context.text"}}{{{underscore param}}}{{/replace}}{{/replace}}{{/join}}{{/if}}){{/indent}}{{/if}}

data/lib/templates/common/_gherkin_pattern.hbs

@@ -1 +1 @@
-^{{#strip}}{{#join chunks context.parameter_delimiter}}{{this.value}}{{/join}}{{#each extra_inlined_parameters}} {{context.parameter_delimiter}}{{this.value}}{{context.parameter_delimiter}}{{/each}}{{/strip}}$
+^{{#strip}}{{#join chunks context.parameter_delimiter as |treated_chunk|}}{{treated_chunk.value}}{{/join}}{{#each extra_inlined_parameters as |param|}} {{context.parameter_delimiter}}{{param.value}}{{context.parameter_delimiter}}{{/each}}{{/strip}}$

data/lib/templates/common/datatable.hbs

@@ -1,3 +1,3 @@
-{{#each rendered_children.datasets}}
-{{{this}}}
+{{#each rendered_children.datasets as |dataset|}}
+{{{ dataset }}}
 {{/each}}

data/lib/templates/csharp/_body.hbs

@@ -1,5 +1,5 @@
 {{#indent}}
-{{#each rendered_children.body}}{{{this}}}
+{{#each rendered_children.body as |child|}}{{{child}}}
 {{/each}}
 {{#if has_step?}}throw new NotImplementedException();{{/if}}
 {{/indent}}

data/lib/templates/csharp/actionwords.hbs

@@ -1,8 +1,8 @@
 namespace {{{ context.namespace }}} {{#curly}}{{#indent}}
 
 public class Actionwords {{#curly}}{{#indent}}
-{{#each rendered_children.actionwords}}
-{{{this}}}
+{{#each rendered_children.actionwords as |actionword|}}
+{{{actionword}}}
 {{/each}}
 {{/indent}}
 {{/curly}}

data/lib/templates/csharp/folder.hbs

@@ -14,7 +14,7 @@ protected void SetUp() {{#curly}}{{#indent}}
 {{{ context.call_prefix}}} = new Actionwords();{{/indent}}{{#unless is_empty?}}
 {{> body}}{{/unless}}
 {{/curly}}
-{{#each rendered_children.scenarios}}{{{this}}}
+{{#each rendered_children.scenarios as |scenario|}}{{{scenario}}}
 {{/each}}
 {{/indent}}
 {{/curly}}

data/lib/templates/csharp/ifthen.hbs

@@ -1,7 +1,7 @@
 if ({{{ rendered_children.condition }}}) {{#curly}}
-{{#indent}}{{#each rendered_children.then}}{{{this}}}
+{{#indent}}{{#each rendered_children.then as |then_statement|}}{{{then_statement}}}
 {{/each}}{{/indent}}
 {{#if has_else?}}} else {
-{{#indent}}{{#each rendered_children.else}}{{{this}}}
+{{#indent}}{{#each rendered_children.else as |else_statement|}}{{{else_statement}}}
 {{/each}}{{/indent}}
 {{/if}}{{/curly}}

data/lib/templates/csharp/scenarios.hbs

@@ -12,7 +12,7 @@ public Actionwords {{{ context.call_prefix }}};
 protected void SetUp() {{#curly}}
     {{{ context.call_prefix}}} = new Actionwords();
 {{/curly}}
-{{#each rendered_children.scenarios}}{{{this}}}
+{{#each rendered_children.scenarios as |scenario|}}{{{scenario}}}
 {{/each}}
 {{/indent}}
 {{/curly}}

data/lib/templates/csharp/template.hbs

@@ -1 +1 @@
-{{#join treated_chunks ' + '}}{{#if this.is_variable?}}{{{this.raw.children.name}}}{{else}}"{{{ escape_double_quotes this.raw.children.value }}}"{{/if}}{{else}}""{{/join}}
+{{#join treated_chunks ' + ' as |treated_chunk|}}{{#if treated_chunk.is_variable?}}{{{treated_chunk.raw.children.name}}}{{else}}"{{{ escape_double_quotes treated_chunk.raw.children.value }}}"{{/if}}{{else}}""{{/join}}

data/lib/templates/csharp/tests.hbs

@@ -7,7 +7,7 @@ using NUnit.Framework;
 public class {{{ clear_extension context.filename }}} {{#curly}}
 {{#indent}}
 public Actionwords {{{ context.call_prefix }}} = new Actionwords();
-{{#each rendered_children.tests}}{{{this}}}
+{{#each rendered_children.tests as |test|}}{{{test}}}
 {{/each}}
 {{/indent}}
 {{/curly}}

data/lib/templates/csharp/while.hbs

@@ -1,4 +1,4 @@
 while ({{{ rendered_children.condition }}}) {{#curly}}{{#indent}}
-{{#each rendered_children.body}}{{{this}}}
+{{#each rendered_children.body as |statement|}}{{{statement}}}
 {{/each}}{{/indent}}
 {{/curly}}