hiptest-publisher 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f43b16fba8918586730a65e4312b062c36b0b68d
-  data.tar.gz: 996e1d9199c1e7163557a5625dad39f6d5a375d7
+  metadata.gz: f219529aaf89fce834dfffb2683f81de8a6c9eff
+  data.tar.gz: 401d0ddd19ec7883ade57f1522a44f2c846f1b12
 SHA512:
-  metadata.gz: 79fb761dc2208ec15cccc08020853418088972797be6934cf96a2dea547ee35dc846a72eb614ad1b341ceb6d798c3ecb815bf05cf68d4d8118177400232155c3
-  data.tar.gz: adca0ee51d099c0c2664aaf50b94c3531d44f549dbba800253ac893b0b46df94a8bfa35491f765b166e63f16714b79b7670cdb10efaa64605b6fafc242317755
+  metadata.gz: 7c79aba51a8f5fdee28125451b77ef75c1376d9211e809a7dc9e079b4e6ed3d36d87cb35aec33c568bd9d1980c429d273184e4f631f7411a39599ae20f2f5a7c
+  data.tar.gz: fbee9b6f63416cf08e764464bdeda95bf6e1ebf5ad245755e6d528339db650215f4cb0e8ddfd28f31d8452d3d191f4abb471a5e1011fd7931a891ccc65ac922e

data/lib/hiptest-publisher.rb

@@ -36,9 +36,12 @@ module Hiptest
 
     def run
       normalize_cli_options!
-      if CliOptionsChecker.new(@cli_options, reporter).bad_arguments?
+      begin
+        CliOptionsChecker.new(@cli_options, reporter).check!
+      rescue CliOptionError => e
+        puts e.message
         exit 1 if @exit_on_bad_arguments
-        return
+        raise
       end
 
       if @cli_options.only == 'list'

data/lib/hiptest-publisher/cli_options_checker.rb

@@ -1,107 +1,105 @@
+require 'pathname'
 
-
-
-class CliOptionsChecker
-  attr_reader :reporter, :cli_options
-  def initialize(cli_options, reporter)
-    @cli_options = cli_options
-    @reporter = reporter
+module Hiptest
+  class CliOptionError < StandardError
   end
 
-  def bad_arguments?
-    # ensure config file was readable if specified
-    begin
-      ParseConfig.new(cli_options.config) if present?(cli_options.config)
-    rescue Errno::EACCES => err
-      puts "Error with --config: the file \"#{cli_options.config}\" does not exist or is not readable"
-      return true
+  class CliOptionsChecker
+    attr_reader :reporter, :cli_options
+    def initialize(cli_options, reporter)
+      @cli_options = cli_options
+      @reporter = reporter
     end
 
-    if cli_options.only == 'list'
-      return
-    end
+    def check!
+      # ensure config file was readable if specified
+      begin
+        ParseConfig.new(cli_options.config) if present?(cli_options.config)
+      rescue Errno::EACCES => err
+        raise CliOptionError, "Error with --config: the file \"#{cli_options.config}\" does not exist or is not readable"
+      end
 
-    unless cli_options.push.nil? || cli_options.push.empty?
-      return
-    end
+      if cli_options.only == 'list'
+        return
+      end
 
-    # secret token
-    if missing?(cli_options.token) || empty?(cli_options.token)
-      puts "Missing argument --token: you must specify project secret token with --token=<project-token>"
-      puts ""
-      puts "The project secret token can be found on Hiptest in the settings section, under"
-      puts "'Publication settings'. It is a sequence of numbers uniquely identifying your"
-      puts "project."
-      puts ""
-      puts "Note that settings section is available only to administrators of the project."
-      return true
-    end
+      unless cli_options.push.nil? || cli_options.push.empty?
+        return
+      end
 
-    unless numeric?(cli_options.token)
-      puts "Invalid format --token=\"#{@cli_options.token}\": the project secret token must be numeric"
-      return true
-    end
+      # secret token
+      if missing?(cli_options.token) || empty?(cli_options.token)
+        raise CliOptionError, [
+          "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",
+          "'Publication settings'. It is a sequence of numbers uniquely identifying your",
+          "project.",
+          "",
+          "Note that settings section is available only to administrators of the project.",
+        ].join("\n")
+      end
 
-    # output directory
-    parent = first_existing_parent(cli_options.output_directory)
-    if !parent.writable?
-      if parent.realpath === Pathname.new(cli_options.output_directory).cleanpath
-        puts "Error with --output-directory: the directory \"#{@cli_options.output_directory}\" is not writable"
-      else
-        puts "Error with --output-directory: the directory \"#{@cli_options.output_directory}\" can not be created because \"#{parent.realpath}\" is not writable"
+      unless numeric?(cli_options.token)
+        raise CliOptionError, "Invalid format --token=\"#{@cli_options.token}\": the project secret token must be numeric"
       end
-      return true
-    elsif !parent.directory?
-      puts "Error with --output-directory: the file \"#{@cli_options.output_directory}\" is not a directory"
-      return true
-    end
 
-    # actionwords signature file
-    if cli_options.actionwords_diff || cli_options.aw_deleted || cli_options.aw_created || cli_options.aw_renamed || cli_options.aw_signature_changed
-      actionwords_signature_file = Pathname.new(cli_options.output_directory).join("actionwords_signature.yaml")
-      if actionwords_signature_file.directory?
-        puts "Bad Action Words signature file: the file \"#{actionwords_signature_file.realpath}\" is a directory"
-        return true
-      elsif !actionwords_signature_file.exist?
-        full_path = File.expand_path(cli_options.output_directory)
-        puts "Missing Action Words signature file: the file \"actionwords_signature.yaml\" could not be found in directory \"#{full_path}\""
-        puts "Use --actionwords-signature to generate the file \"#{full_path}/actionwords_signature.yaml\""
-        return true
+      # output directory
+      parent = first_existing_parent(cli_options.output_directory)
+      if !parent.writable?
+        if parent.realpath === Pathname.new(cli_options.output_directory).cleanpath
+          raise CliOptionError, "Error with --output-directory: the directory \"#{@cli_options.output_directory}\" is not writable"
+        else
+          raise CliOptionError, "Error with --output-directory: the directory \"#{@cli_options.output_directory}\" can not be created because \"#{parent.realpath}\" is not writable"
+        end
+      elsif !parent.directory?
+        raise CliOptionError, "Error with --output-directory: the file \"#{@cli_options.output_directory}\" is not a directory"
       end
-    end
 
-    # test run id
-    if present?(cli_options.test_run_id) && !numeric?(cli_options.test_run_id)
-      puts "Invalid format --test-run-id=\"#{@cli_options.test_run_id}\": the test run id must be numeric"
-      return true
-    end
+      # actionwords signature file
+      if cli_options.actionwords_diff || cli_options.aw_deleted || cli_options.aw_created || cli_options.aw_renamed || cli_options.aw_signature_changed
+        actionwords_signature_file = Pathname.new(cli_options.output_directory).join("actionwords_signature.yaml")
+        if actionwords_signature_file.directory?
+          raise CliOptionError, "Bad Action Words signature file: the file \"#{actionwords_signature_file.realpath}\" is a directory"
+        elsif !actionwords_signature_file.exist?
+          full_path = File.expand_path(cli_options.output_directory)
+          raise CliOptionError, [
+            "Missing Action Words signature file: the file \"actionwords_signature.yaml\" could not be found in directory \"#{full_path}\"",
+            "Use --actionwords-signature to generate the file \"#{full_path}/actionwords_signature.yaml\"",
+          ].join("\n")
+        end
+      end
 
-    return false
-  end
+      # test run id
+      if present?(cli_options.test_run_id) && !numeric?(cli_options.test_run_id)
+        raise CliOptionError, "Invalid format --test-run-id=\"#{@cli_options.test_run_id}\": the test run id must be numeric"
+      end
+    end
 
-  private
+    private
 
-  def numeric?(arg)
-    arg =~ /^\d*$/
-  end
+    def numeric?(arg)
+      arg =~ /^\d*$/
+    end
 
-  def missing?(arg)
-    arg.nil?
-  end
+    def missing?(arg)
+      arg.nil?
+    end
 
-  def empty?(arg)
-    arg.strip.empty?
-  end
+    def empty?(arg)
+      arg.strip.empty?
+    end
 
-  def present?(arg)
-    arg && !arg.strip.empty?
-  end
+    def present?(arg)
+      arg && !arg.strip.empty?
+    end
 
-  def first_existing_parent(path)
-    pathname = Pathname.new(path)
-    while !pathname.exist?
-      pathname = pathname.parent
+    def first_existing_parent(path)
+      pathname = Pathname.new(path)
+      while !pathname.exist?
+        pathname = pathname.parent
+      end
+      pathname.realpath
     end
-    pathname.realpath
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiptest-publisher
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Hiptest R&D
@@ -108,56 +108,56 @@ dependencies:
   name: ruby-handlebars
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency