hiptest-publisher 0.13.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3b168dc9c0b80b37eb6ecfda66e3c1febeac5e3
-  data.tar.gz: d446c3ee48325ae4ae22bca977816951e1ef487e
+  metadata.gz: 6a3a011230146c49dd11289311b1adb4c1f3ec07
+  data.tar.gz: 5af587b772286fdd2dda10b763ba57f16064589e
 SHA512:
-  metadata.gz: 78c58933a727d82d28223a4be77f2d4c270ba9b1f7b815303ab7769ebabcbfc03e5e6ff8055fc44b149f650fe49d3e5ded41f97edc56e355cceed225b3682272
-  data.tar.gz: af43ccc77d54009d6429ad124a93ed7f02ba956118f9d0a60bd97d09665d3ad965ce6e78b0ecca780cb88c5756af1e5b65270549a167dacebd8a8c64cce19cf7
+  metadata.gz: e3c8541ccec13d9c02f1160dbc1bfd1d5a985e0c01821dbbd0847d922356d766bd3c7dab148788b9acd4b6d2080e1e2ad2dfba4954399cc11ae221bbc3e704a7
+  data.tar.gz: 48da00daa178db580278ff93c4c94bcd723903b7cb8e4b19fee23685335dc26c94b22d7d2580c85ac0c788bdaae0eafa5914e4eb02e3c834671354a21ada66dd

data/lib/hiptest-publisher.rb

@@ -5,6 +5,7 @@ require 'yaml'
 
 require 'hiptest-publisher/formatters/reporter'
 require 'hiptest-publisher/cli_options_checker'
+require 'hiptest-publisher/client'
 require 'hiptest-publisher/string'
 require 'hiptest-publisher/utils'
 require 'hiptest-publisher/options_parser'
@@ -24,12 +25,12 @@ module Hiptest
     def initialize(args, listeners: nil, exit_on_bad_arguments: true)
       @reporter = Reporter.new(listeners)
       @cli_options = OptionsParser.parse(args, reporter)
+      @client = Hiptest::Client.new(@cli_options, reporter)
       # pass false to prevent hiptest-publisher from exiting, useful when used embedded
       @exit_on_bad_arguments = exit_on_bad_arguments
     end
 
     def run
-      puts "URL: #{make_url(@cli_options)}".white if @cli_options.verbose
       begin
         CliOptionsChecker.new(@cli_options, reporter).check!
       rescue CliOptionError => e
@@ -43,16 +44,12 @@ module Hiptest
         return
       end
 
-      if push?(@cli_options)
+      if @cli_options.push?
         post_results
         return
       end
 
-      if @cli_options.xml_file
-        xml = IO.read(@cli_options.xml_file)
-      else
-        xml = fetch_xml_file
-      end
+      xml = get_xml_file
       return if xml.nil?
 
       @project = get_project(xml)
@@ -70,17 +67,32 @@ module Hiptest
       export
     end
 
+    def get_xml_file
+      if @cli_options.xml_file
+        IO.read(@cli_options.xml_file)
+      else
+        fetch_xml_file
+      end
+    end
+
     def fetch_xml_file
-      with_status_message "Fetching data from Hiptest" do
-        fetch_project_export(@cli_options)
+      reporter.with_status_message "Fetching data from Hiptest" do
+        @client.fetch_project_export
+      end
+    rescue ClientError => err
+      # This should not be an error that needs reporting to an exception monitoring app
+      puts err.message.yellow
+      if @exit_on_bad_arguments == false # means we are embedded in hiptest-publisher
+        raise
       end
     rescue Exception => err
-      puts "Unable to open the file, please check that the token is correct".red
+      puts ("An error has occured, sorry for the inconvenience.\n" +
+        "Try running the command again with --verbose for detailed output").red
       reporter.dump_error(err)
     end
 
     def get_project(xml)
-      with_status_message "Extracting data" do
+      reporter.with_status_message "Extracting data" do
         parser = Hiptest::XMLParser.new(xml, reporter)
         return parser.build_project
       end
@@ -89,7 +101,7 @@ module Hiptest
     end
 
     def write_to_file(path, message)
-      with_status_message "#{message}: #{path}" do
+      reporter.with_status_message "#{message}: #{path}" do
         mkdirs_for(path)
         File.open(path, 'w') do |file|
           file.write(yield)
@@ -137,7 +149,7 @@ module Hiptest
 
     def show_actionwords_diff
       old = nil
-      with_status_message "Loading previous definition" do
+      reporter.with_status_message "Loading previous definition" do
         old = YAML.load_file("#{@cli_options.output_directory}/actionwords_signature.yaml")
       end
 
@@ -239,7 +251,7 @@ module Hiptest
     def export
       return if @project.nil?
 
-      with_status_message "Analyzing data" do
+      reporter.with_status_message "Analyzing data" do
         @language_config = LanguageConfigParser.new(@cli_options)
         Hiptest::Nodes::ParentAdder.add(@project)
         Hiptest::Nodes::ParameterTypeAdder.add(@project)
@@ -273,11 +285,11 @@ module Hiptest
 
     def post_results
       response = nil
-      with_status_message "Posting #{@cli_options.push} to #{@cli_options.site}" do
-        response = push_results(@cli_options)
+      reporter.with_status_message "Posting #{@cli_options.push} to #{@cli_options.site}" do
+        response = @client.push_results
       end
       passed_count = JSON.parse(response.body)['test_import'].size
-      with_status_message "#{pluralize(passed_count, "test")} imported" do
+      reporter.with_status_message "#{pluralize(passed_count, "test")} imported" do
         if @cli_options.verbose
           JSON.parse(response.body)['test_import'].each do |imported_test|
             puts "  Test '#{imported_test['name']}' imported"

data/lib/hiptest-publisher/cli_options_checker.rb

@@ -22,7 +22,7 @@ module Hiptest
 
       check_secret_token
 
-      if push?(cli_options)
+      if cli_options.push?
         check_push_file
       else
         check_output_directory

data/lib/hiptest-publisher/client.rb

@@ -0,0 +1,115 @@
+require 'json'
+require 'net/http'
+require 'uri'
+
+require_relative 'formatters/reporter'
+
+module Hiptest
+
+  class ClientError < StandardError
+  end
+
+  class Client
+    attr_reader :cli_options
+
+    def initialize(cli_options, reporter = nil)
+      @cli_options = cli_options
+      @reporter = reporter || NullReporter.new
+    end
+
+    def url
+      if cli_options.push?
+        "#{cli_options.site}/import_test_results/#{cli_options.token}/#{cli_options.push_format}"
+      elsif test_run_id
+        "#{base_publication_path}/test_run/#{test_run_id}"
+      else
+        "#{base_publication_path}/#{cli_options.leafless_export ? 'leafless_tests' : 'project'}"
+      end
+    end
+
+    def fetch_project_export
+      response = send_get_request(url)
+      response.body
+    end
+
+    def available_test_runs
+      @available_test_runs ||= begin
+        response = send_get_request("#{base_publication_path}/test_runs")
+        json_response = JSON.parse(response.body)
+        json_response["test_runs"]
+      end
+    end
+
+    def push_results
+      # Code from: https://github.com/nicksieger/multipart-post
+      uploaded = {}
+      Dir.glob(cli_options.push.gsub('\\', '/')).each_with_index do |filename, index|
+        uploaded["file-#{filename.normalize}"] = UploadIO.new(File.new(filename), "text", filename)
+      end
+
+      uri = URI.parse(url)
+      send_request(Net::HTTP::Post::Multipart.new(uri, uploaded))
+    end
+
+    private
+
+    def test_run_id
+      return unless cli_options.test_run_id? || cli_options.test_run_name?
+
+      if cli_options.test_run_id?
+        key = "id"
+        searched_value = cli_options.test_run_id
+      elsif cli_options.test_run_name?
+        key = "name"
+        searched_value = cli_options.test_run_name
+      end
+
+      matching_test_run = available_test_runs.find { |test_run| test_run[key] == searched_value }
+      if matching_test_run.nil?
+        raise ClientError, no_matching_test_runs_error_message
+      end
+      matching_test_run["id"]
+    end
+
+    def no_matching_test_runs_error_message
+      if available_test_runs.empty?
+        "No matching test run found: this project does not have any test runs."
+      else
+        "No matching test run found. Available test runs for this project are:\n" +
+            columnize_test_runs(available_test_runs)
+      end
+    end
+
+    def columnize_test_runs(test_runs)
+      lines = []
+      lines << ["ID", "Name"]
+      lines << ["--", "----"]
+      lines += test_runs.map { |tr| [tr["id"].to_s, tr["name"]] }
+      first_column_width = lines.map { |line| line[0].length }.max
+      lines.map! { |line| "  #{line[0].ljust(first_column_width)}  #{line[1]}" }
+      lines.join("\n")
+    end
+
+    def base_publication_path
+      "#{cli_options.site}/publication/#{cli_options.token}"
+    end
+
+    def send_get_request(url)
+      uri = URI.parse(url)
+      response = send_request(Net::HTTP::Get.new(uri))
+      if response.code_type == Net::HTTPNotFound
+        raise ClientError, "No project found with this secret token."
+      end
+      response
+    end
+
+    def send_request(request)
+      request["User-Agent"] = "Ruby/hiptest-publisher"
+      use_ssl = request.uri.scheme == "https"
+      Net::HTTP.start(request.uri.hostname, request.uri.port, use_ssl: use_ssl, :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+        @reporter.show_verbose_message("Request sent to: #{request.uri}")
+        http.request(request)
+      end
+    end
+  end
+end

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

@@ -5,6 +5,8 @@ class ConsoleFormatter
 
   def initialize(verbose)
     @verbose = verbose
+    @immediate_verbose = true
+    @verbose_messages = []
   end
 
   def dump_error(error, message = nil)
@@ -23,4 +25,43 @@ class ConsoleFormatter
     puts message.yellow
     options.each { |k, v| puts " - #{k}: #{v.inspect}" }
   end
+
+  def show_verbose_message(message)
+    return unless verbose
+    if @immediate_verbose
+      STDOUT.print "#{message}\n"
+    else
+      @verbose_messages << message
+    end
+  end
+
+  def show_status_message(message, status=nil)
+    status_icon = " "
+    output = STDOUT
+
+    if status == :success
+      status_icon = "v".green
+    elsif status == :failure
+      status_icon = "x".red
+      output = STDERR
+    end
+    if status
+      @immediate_verbose = true
+      cursor_offset = ""
+    else
+      return unless $stdout.tty?
+      rows, columns = IO.console.winsize
+      return if columns == 0
+      @immediate_verbose = false
+      vertical_offset = (4 + message.length) / columns
+      cursor_offset = "\r\e[#{vertical_offset + 1}A"
+    end
+
+    output.print "[#{status_icon}] #{message}#{cursor_offset}\n"
+
+    if @immediate_verbose && !@verbose_messages.empty?
+      @verbose_messages.each { |message| show_verbose_message(message) }
+      @verbose_messages.clear
+    end
+  end
 end

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

@@ -17,6 +17,21 @@ class Reporter
     notify(:show_options, options, message)
   end
 
+  def show_verbose_message(message)
+    notify(:show_verbose_message, message)
+  end
+
+  def with_status_message(message, &blk)
+    notify(:show_status_message, message)
+    status = :success
+    yield
+  rescue
+    status = :failure
+    raise
+  ensure
+    notify(:show_status_message, message, status)
+  end
+
   def notify(message, *args)
     @listeners.each do |listener|
       listener.send(message, *args)

data/lib/hiptest-publisher/options_parser.rb

@@ -76,6 +76,18 @@ class CliOptions < OpenStruct
     actionwords_diff || aw_deleted || aw_created || aw_renamed || aw_signature_changed || aw_definition_changed
   end
 
+  def push?
+    option_present?(push)
+  end
+
+  def test_run_id?
+    option_present?(test_run_id)
+  end
+
+  def test_run_name?
+    option_present?(test_run_name)
+  end
+
   def language_framework
     if framework.empty?
       language
@@ -119,6 +131,12 @@ class CliOptions < OpenStruct
       return delta
     end
   end
+
+  private
+
+  def option_present?(value)
+    value && !value.empty?
+  end
 end
 
 class OptionsParser
@@ -150,7 +168,8 @@ class OptionsParser
       Option.new(nil, 'filename-pattern=PATTERN', nil, String, "Filename pattern (containing %s)", :filename_pattern),
       Option.new('c', 'config-file=PATH', nil, String, "Configuration file", :config),
       Option.new(nil, 'overriden-templates=PATH', '', String, "Folder for overriden templates", :overriden_templates),
-      Option.new(nil, 'test-run-id=ID', '', String, "Export data from a test run", :test_run_id),
+      Option.new(nil, 'test-run-id=ID', '', String, "Export data from a test run identified by its id", :test_run_id),
+      Option.new(nil, 'test-run-name=NAME', '', String, "Export data from a test run identified by its name", :test_run_name),
       Option.new(nil, 'only=CATEGORIES', nil, String, "Restrict export to given file categories (--only=list to list them)", :only),
       Option.new('x', 'xml-file=PROJECT_XML', nil, String, "XML file to use instead of fetching it from Hiptest", :xml_file),
       Option.new(nil, 'tests-only', false, nil, "(deprecated) alias for --only=tests", :tests_only),

data/lib/hiptest-publisher/utils.rb

@@ -1,6 +1,5 @@
 require 'colorize'
 require 'io/console'
-require 'open-uri'
 require 'openssl'
 require 'net/http/post/multipart'
 require 'pathname'
@@ -35,79 +34,6 @@ def singularize(name)
   name.to_s.chomp("s")
 end
 
-def make_url(options)
-  if push?(options)
-    "#{options.site}/import_test_results/#{options.token}/#{options.push_format}"
-  else
-    base_url = "#{options.site}/publication/#{options.token}"
-    if options.test_run_id.nil? || options.test_run_id.empty?
-      "#{base_url}/#{options.leafless_export ? 'leafless_tests' : 'project'}"
-    else
-      "#{base_url}/test_run/#{options.test_run_id}"
-    end
-  end
-end
-
-def fetch_project_export(options)
-  url = make_url(options)
-
-  open(url, "User-Agent" => 'Ruby/hiptest-publisher', :ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE)
-end
-
-def show_status_message(message, status=nil)
-  status_icon = " "
-  output = STDOUT
-
-  if status == :success
-    status_icon = "v".green
-  elsif status == :failure
-    status_icon = "x".red
-    output = STDERR
-  end
-  if status
-    cursor_offset = ""
-  else
-    return unless $stdout.tty?
-    rows, columns = IO.console.winsize
-    return if columns == 0
-    vertical_offset = (4 + message.length) / columns
-    cursor_offset = "\r\e[#{vertical_offset + 1}A"
-  end
-
-  output.print "[#{status_icon}] #{message}#{cursor_offset}\n"
-end
-
-def with_status_message(message, &blk)
-  show_status_message message
-  status = :success
-  yield
-rescue
-  status = :failure
-  raise
-ensure
-  show_status_message message, status
-end
-
-def push?(options)
-  options.push && !options.push.empty?
-end
-
-def push_results(options)
-  # Code from: https://github.com/nicksieger/multipart-post
-  url = URI.parse(make_url(options))
-  use_ssl = (url.scheme == 'https')
-  uploaded = {}
-
-  Dir.glob(options.push.gsub('\\', '/')).each_with_index do |filename, index|
-    uploaded["file-#{filename.normalize}"] = UploadIO.new(File.new(filename), "text", filename)
-  end
-
-  req = Net::HTTP::Post::Multipart.new(url.path, uploaded)
-  response = Net::HTTP.start(url.host, url.port, :use_ssl => use_ssl, :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
-    http.request(req)
-  end
-end
-
 def clean_path(path)
   Pathname.new(path).cleanpath.to_s
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiptest-publisher
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Hiptest R&D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -261,6 +261,7 @@ files:
 - lib/hiptest-publisher/actionword_indexer.rb
 - lib/hiptest-publisher/call_arguments_adder.rb
 - lib/hiptest-publisher/cli_options_checker.rb
+- lib/hiptest-publisher/client.rb
 - lib/hiptest-publisher/formatters/console_formatter.rb
 - lib/hiptest-publisher/formatters/reporter.rb
 - lib/hiptest-publisher/gherkin_adder.rb
@@ -595,7 +596,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Export your tests from Hiptest into executable tests.