hiptest-publisher 0.19.4 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 335199b99a05d67e984b7c9034456256cfb28a43
-  data.tar.gz: de795a4dc8c5f3336ae89fb365389de0d61e8e21
+  metadata.gz: 8be16d9ad9975911593e440094b5493c38370870
+  data.tar.gz: 233ff80ce6528326b565f8cbf799b0fbd7839507
 SHA512:
-  metadata.gz: c97d19437570083b65c6e9497244e200275d9bbe92387b6eb7c7daca0fe72173304d1754c764ee5a974c92e4bfe21076403074add56669106c9e56c4081d5f6f
-  data.tar.gz: 0ebdec3002083308fc98954858903dbe7e1a357fe8c25723b65cebf088f230f4fbe75f72ea788294a65c6e64812319f96878bdfac013615902f03ff96daf78aa
+  metadata.gz: ca2d5fbc8cc85e4dafd7b19e0b8399a686aec32269d460b304037eea9d9868a9879526c2a97958177c335a3a5d58908488f415c204ffd69f42807178cc16b389
+  data.tar.gz: b56d092ec517cc1e23a0e6df5c7af0d54fb1b42af551225621072a58a5e0cde7c2229bf224ccb2703f760de49c08d3100189ce42afa00ceb2d1f8a6457de1f9e

data/README.md

@@ -126,6 +126,11 @@ Specific options:
         --[no-]uids                  Export UIDs (note: can be disabled only for Gherkin-based exports, may cause issue when pushing results back) (default: true)
         --keep-filenames             Keep the same name as in Hiptest for the test files (note: may cause encoding issues) (default: false)
         --keep-foldernames           Keep the same name as in Hiptest for the folders (note: may cause encoding issues) (default: false)
+        --filter-on-scenario-ids     Filter on scenario ids (use commas to separate ids when fetching multiple scenarios)
+        --filter-on-folder-ids       Filter on folder ids (use commas to separate ids when fetching multiple folders)
+        --filter-on-scenario-name    Filter on scenario name (only one name is accepted)
+        --filter-on-folder-name      Filter on folder name (only one name is accepted)
+        --filter-on-tags             Filter on scenarios and folder tags (use commas to separate tags when using multiple tags)
     -v, --verbose                    Run verbosely (default: false)
     -H, --languages-help             Show languages and framework options
     -h, --help                       Show this message

data/lib/hiptest-publisher/cli_options_checker.rb

@@ -21,6 +21,7 @@ module Hiptest
       end
 
       check_secret_token
+      check_filters
 
       if cli_options.push?
         check_push_file
@@ -41,6 +42,36 @@ module Hiptest
       end
     end
 
+    def check_filters
+      filters = [
+        cli_options.filter_on_scenario_ids,
+        cli_options.filter_on_folder_ids,
+        cli_options.filter_on_scenario_name,
+        cli_options.filter_on_folder_name,
+        cli_options.filter_on_tags
+      ].reject {|opt| absent?(opt) }
+
+      return if filters.empty?
+
+      if filters.size > 1
+        raise CliOptionError, [
+          "You specified multiple filters for the export.",
+          "",
+          "Only one filter can be applied."
+        ].join("\n")
+      end
+
+      if present?(cli_options.test_run_id) || present?(cli_options.test_run_name)
+        raise CliOptionError, [
+          "Filtering can not be applied when exporting from a test run"
+        ].join("\n")
+      end
+
+      check_numeric_list(:filter_on_scenario_ids)
+      check_numeric_list(:filter_on_folder_ids)
+      check_tag_list(:filter_on_tags)
+    end
+
     def check_secret_token
       if absent?(cli_options.xml_file)
         if absent?(cli_options.token)
@@ -127,6 +158,36 @@ module Hiptest
       end
     end
 
+    def check_numeric_list(option_name)
+      value = cli_options.send(option_name)
+      return if absent?(value)
+
+       value.split(',').each do |val|
+          next if numeric?(val.strip)
+
+          raise CliOptionError, [
+            "#{option_name} should be a list of comma separated numeric values",
+            "",
+            "Found: #{val.strip.inspect}"
+          ].join("\n")
+       end
+    end
+
+    def check_tag_list(option_name)
+      value = cli_options.send(option_name)
+      return if absent?(value)
+
+      value.split(',').each do |val|
+          next if tag_compatible?(val.strip)
+
+          raise CliOptionError, [
+            "#{option_name} should be a list of comma separated tags in Hiptest",
+            "",
+            "Found: #{val.strip.inspect}"
+          ].join("\n")
+      end
+    end
+
     def check_language_and_only
       if present?(cli_options.language)
         begin
@@ -153,7 +214,7 @@ module Hiptest
     private
 
     def numeric?(arg)
-      arg =~ /^\d*$/
+      arg =~ /\A\d*\z/
     end
 
     def missing?(arg)
@@ -172,6 +233,10 @@ module Hiptest
       !absent?(arg)
     end
 
+    def tag_compatible?(value)
+      value =~ /\A[a-zA-Z0-9_-]*(:[a-zA-Z0-9_-]*)?\z/
+    end
+
     def formatted_categories(categories)
       formatted_categories = categories.map(&:inspect)
       if formatted_categories.length == 1

data/lib/hiptest-publisher/client.rb

@@ -23,10 +23,28 @@ module Hiptest
       elsif test_run_id
         "#{base_publication_path}/test_run/#{test_run_id}"
       else
-        "#{base_publication_path}/#{cli_options.leafless_export ? 'leafless_tests' : 'project'}"
+        "#{base_publication_path}/#{cli_options.leafless_export ? 'leafless_tests' : 'project'}#{project_export_filters}"
       end
     end
 
+    def project_export_filters
+      mapping = {
+        filter_on_scenario_ids: 'filter_scenario_ids',
+        filter_on_folder_ids: 'filter_folder_ids',
+        filter_on_scenario_name: 'filter_scenario_name',
+        filter_on_folder_name: 'filter_folder_name',
+        filter_on_tags: 'filter_tags'
+      }
+
+      options = mapping.map do |key, filter_name|
+        value = @cli_options.send(key)
+        next if value.nil? || value.empty?
+
+        "#{filter_name}=#{value}"
+      end.compact
+      return options.empty? ? '' : "?#{options.first}"
+    end
+
     def fetch_project_export
       response = send_get_request(url)
       if response.code_type == Net::HTTPNotFound

data/lib/hiptest-publisher/options_parser.rb

@@ -198,6 +198,11 @@ class OptionsParser
       Option.new(nil, '[no-]uids', true, nil, 'Export UIDs (note: can be disabled only for Gherkin-based exports, may cause issue when pushing results back)', :uids),
       Option.new(nil, 'keep-filenames', false, nil, "Keep the same name as in Hiptest for the test files (note: may cause encoding issues)", :keep_filenames),
       Option.new(nil, 'keep-foldernames', false, nil, "Keep the same name as in Hiptest for the folders (note: may cause encoding issues)", :keep_foldernames),
+      Option.new(nil, 'filter-on-scenario-ids=IDS', '', String, "Filter on scenario ids (use commas to separate ids when fetching multiple scenarios)", :filter_on_scenario_ids),
+      Option.new(nil, 'filter-on-folder-ids=IDS', '', String, "Filter on folder ids (use commas to separate ids when fetching multiple folders)", :filter_on_folder_ids),
+      Option.new(nil, 'filter-on-scenario-name=NAME', '', String, "Filter on scenario name (only one name is accepted)", :filter_on_scenario_name),
+      Option.new(nil, 'filter-on-folder-name=NAME', '', String, "Filter on folder name (only one name is accepted)", :filter_on_folder_name),
+      Option.new(nil, 'filter-on-tags=TAGS', '', String, "Filter on scenarios and folder tags (use commas to separate tags when using multiple tags)", :filter_on_tags),
       Option.new('v', 'verbose', false, nil, "Run verbosely", :verbose)
     ]
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiptest-publisher
 version: !ruby/object:Gem::Version
-  version: 0.19.4
+  version: 0.20.0
 platform: ruby
 authors:
 - Hiptest R&D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize