hammer_cli 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed76c22f08106cd7634ad1fed540dcf36fd1c5df
-  data.tar.gz: 9940232f3680440d7e8b86d6f102d1d03c87c8ba
+  metadata.gz: 33dccc5b0fb15f01c5a3b6bfb10f948b537d2a0d
+  data.tar.gz: 00204183081d15fd58aca9ec50bb82f57592720c
 SHA512:
-  metadata.gz: 5d48b14bfa16dc4ecbf0cc41e6acd97984597ac2ffca027220b9f01dd7139f35bb1c040b99a44669ecca0e229c90a4017513779150d9019c6d8e8d6383c8386e
-  data.tar.gz: d57b562879af67ef096b18e5010ca0ac158b6ee692275aeb4e26aaebfbdb5ec70ee46e82ec28f1e2f2e76754189d9946b032c4ce82211e8207c27d40e2870fc7
+  metadata.gz: cb778be8424eb378b46240b7903e30ebd40a1ff721091caf11d8ccbf7673e619a495a5f65e6227a49066e563a8a9bae04e19d9c637aa96f2fc510749d0eb3976
+  data.tar.gz: a0cb9c725c76a3a640b91ff36f75b5b745179749651a32c50ce7e957bbf2a680df966a4011d1ca72afed9638846b3e8714d8978ea6609c8edbc27bf0effbb9ff

data/doc/installation.md

@@ -56,7 +56,7 @@ with descriptions.
 
 ### Plugins
 
-Plugins are disabled by default. To enable plugin create configuration file in ```cli.modules.d``` and add```:enable_plugin: true``` in it.
+Plugins are disabled by default. To enable plugin create configuration file in ```cli.modules.d``` and add```:enable_module: true``` in it.
 Plugin specific configuration must be nested under plugin's name (without the ```hammer_cli_``` prefix).
 
 In the example we assume the gem ```hammer_cli_foreman``` with the Foreman plugin is installed. Then the plugin configuration

data/doc/release_notes.md

@@ -1,6 +1,12 @@
 Release notes
 =============
 
+### 0.6.0 (2016-02-25)
+* Enable vertical formatting for lists ([#13874](http://projects.theforeman.org/issues/13874))
+* Support for command testing moved to core ([#4118](http://projects.theforeman.org/issues/4118))
+* Remove psych require from Gemfile ([#12797](http://projects.theforeman.org/issues/12797))
+* Configuration doc on how to enable a plugin ([#13438](http://projects.theforeman.org/issues/13438))
+
 ### 0.5.1 (2015-12-15)
 * Minor release to fix wrongly packaged gem
 

data/lib/hammer_cli/output/formatters.rb

@@ -93,6 +93,7 @@ module HammerCLI::Output
     end
 
     class ListFormatter < FieldFormatter
+      INDENT = "  "
 
       def tags
         [:flat]
@@ -100,7 +101,12 @@ module HammerCLI::Output
 
       def format(list, field_params={})
         if list.is_a? Array
-          list.join(", ")
+          separator = field_params.fetch(:separator, ', ')
+          new_line = field_params.fetch(:on_new_line, false)
+
+          list = list.join(separator)
+          list ="\n#{list.indent_with(INDENT)}" if new_line
+          list
         elsif list
           list.to_s
         else

data/lib/hammer_cli/testing/command_assertions.rb

@@ -0,0 +1,119 @@
+module HammerCLI
+  module Testing
+    module CommandAssertions
+      class CommandExpectation
+        include MiniTest::Assertions
+
+        attr_accessor :expected_out, :expected_err, :expected_exit_code
+
+        def initialize(expected_out="", expected_err="", expected_exit_code=0)
+          @expected_out = expected_out
+          @expected_err = expected_err
+          @expected_exit_code = expected_exit_code
+        end
+
+        def assert_match(actual_result)
+          assert_equal_or_match @expected_err, actual_result.err
+          assert_equal_or_match @expected_out, actual_result.out
+          assert_exit_code_equal @expected_exit_code, actual_result.exit_code
+        end
+      end
+
+      class CommandRunResult
+        def initialize(out="", err="", exit_code=0)
+          @out = out
+          @err = err
+          @exit_code = exit_code
+        end
+        attr_accessor :out, :err, :exit_code
+      end
+
+      def run_cmd(options, context={}, cmd_class=HammerCLI::MainCommand)
+        result = CommandRunResult.new
+        result.out, result.err = capture_io do
+          result.exit_code = cmd_class.run('hammer', options, context)
+        end
+        result
+      end
+
+      def exit_code_map
+        return @exit_code_map unless @exit_code_map.nil?
+
+        hammer_exit_codes = HammerCLI.constants.select{|c| c.to_s.start_with?('EX_')}
+        @exit_code_map = hammer_exit_codes.inject({}) do |code_map, code|
+          code_map.update(HammerCLI.const_get(code) => code)
+        end
+      end
+
+      def assert_exit_code_equal(expected_code, actual_code)
+        expected_info = "#{exit_code_map[expected_code]} (#{expected_code})"
+        actual_info = "#{exit_code_map[actual_code]} (#{actual_code})"
+
+        msg = "The exit code was expected to be #{expected_info}, but it was #{actual_info}"
+        assert(expected_code == actual_code, msg)
+      end
+
+      def assert_cmd(expectation, actual_result)
+        expectation.assert_match(actual_result)
+      end
+
+      def assert_equal_or_match(expected, actual)
+        case expected
+        when String
+          assert_equal(expected, actual)
+        when MatcherBase
+          expected.assert_match(actual)
+        else
+          msg = actual
+          assert_match(expected, actual, msg)
+        end
+      end
+
+      def usage_error(command, message, heading=nil)
+        command = (['hammer'] + command).join(' ')
+        if heading.nil?
+          ["Error: #{message}",
+           "",
+           "See: '#{command} --help'",
+           ""].join("\n")
+        else
+          ["#{heading}:",
+           "  Error: #{message}",
+           "  ",
+           "  See: '#{command} --help'",
+           ""].join("\n")
+        end
+      end
+
+      def common_error(command, message, heading=nil)
+        command = (['hammer'] + command).join(' ')
+        if heading.nil?
+          ["Error: #{message}",
+           ""].join("\n")
+        else
+          ["#{heading}:",
+           "  Error: #{message}",
+           ""].join("\n")
+        end
+      end
+
+      def usage_error_result(command, message, heading=nil)
+        expected_result = CommandExpectation.new
+        expected_result.expected_err = usage_error(command, message, heading)
+        expected_result.expected_exit_code = HammerCLI::EX_USAGE
+        expected_result
+      end
+
+      def common_error_result(command, message, heading=nil)
+        expected_result = CommandExpectation.new
+        expected_result.expected_err = common_error(command, message, heading)
+        expected_result.expected_exit_code = HammerCLI::EX_SOFTWARE
+        expected_result
+      end
+
+      def success_result(message)
+        CommandExpectation.new(message)
+      end
+    end
+  end
+end

data/lib/hammer_cli/testing/data_helpers.rb

@@ -0,0 +1,19 @@
+module HammerCLI
+  module Testing
+    module DataHelpers
+      def load_json(file_path, test_file_context=nil)
+        unless test_file_context.nil?
+          file_path = File.join(File.dirname(test_file_context), file_path)
+        end
+        JSON.parse(File.read(file_path))
+      end
+
+      def load_yaml(file_path, test_file_context=nil)
+        unless test_file_context.nil?
+          file_path = File.join(File.dirname(test_file_context), file_path)
+        end
+        YAML.load(File.read(file_path))
+      end
+    end
+  end
+end

data/lib/hammer_cli/testing/output_matchers.rb

@@ -0,0 +1,105 @@
+module HammerCLI
+  module Testing
+    module OutputMatchers
+      class MatcherBase
+        include MiniTest::Assertions
+
+        def initialize(expected="")
+          @expected = expected
+        end
+
+        def assert_match(actual)
+          assert_equal(@expected, actual)
+        end
+      end
+
+      class FieldMatcher < MatcherBase
+        def initialize(label, value)
+          @expected = FieldMatcher.matcher(label, value)
+        end
+
+        def assert_match(actual)
+          message = "Regex /#{@expected.source}/ didn't match the output:\n#{actual}"
+          assert(@expected =~ actual, message)
+        end
+
+        def self.matcher(label, value)
+          Regexp.new(Regexp.quote(label) + ':[ ]+' + Regexp.quote(value))
+        end
+      end
+
+      class OutputMatcher < MatcherBase
+        attr_accessor :expected_lines
+
+        def initialize(expected="", options={})
+          @expected_lines = expected.is_a?(Array) ? expected : [expected]
+          @ignore_whitespace = options.fetch(:ignore_whitespace, true)
+        end
+
+        def assert_match(actual)
+          if @ignore_whitespace
+            expected_lines = strip_lines(@expected_lines)
+            actual = strip_lines(actual.split("\n")).join("\n")
+          else
+            expected_lines = @expected_lines
+          end
+          expected_lines = expected_lines.join("\n")
+
+          message = "Output didn't contain expected lines:\n" + diff(expected_lines, actual)
+          assert(actual.include?(expected_lines), message)
+        end
+
+        protected
+
+        def strip_lines(lines)
+          lines.map(&:rstrip)
+        end
+      end
+
+      class IndexMatcher < MatcherBase
+        def initialize(expected=[])
+          @line_matchers = []
+          expected.each do |line_expectation|
+            @line_matchers << IndexLineMatcher.new(line_expectation)
+          end
+        end
+
+        def assert_match(actual)
+          @line_matchers.each do |matcher|
+            matcher.assert_match(actual)
+          end
+        end
+      end
+
+      class IndexLineMatcher < MatcherBase
+        def initialize(expected=[])
+          @expected_values = expected
+        end
+
+        def assert_match(actual)
+          message = [
+            "Regex didn't match the output.",
+            "Expected regex:",
+            line_regexp.source,
+            "Expected fields:",
+            @expected_values.join(' | '),
+            "Actual output:",
+            actual
+          ].join("\n")
+
+          assert(line_regexp =~ actual, message)
+        end
+
+        protected
+
+        def line_regexp
+          re = @expected_values.map do |column|
+            Regexp.quote(column)
+          end.join('[ ]*\|[ ]*')
+          Regexp.new("[ ]*#{re}[ ]*")
+        end
+      end
+
+    end
+  end
+end

data/lib/hammer_cli/version.rb

@@ -1,5 +1,5 @@
 module HammerCLI
   def self.version
-    @version ||= Gem::Version.new '0.5.1'
+    @version ||= Gem::Version.new '0.6.0'
   end
 end

data/locale/de/hammer-cli.edit.po

@@ -5,7 +5,7 @@
 # Translators:
 # Christina Gurski <Gurski_christina@yahoo.de>, 2015
 # Dominic Cleal <dominic@cleal.org>, 2014
-# Ettore Atalan <atalanttore@googlemail.com>, 2014-2015
+# Ettore Atalan <atalanttore@googlemail.com>, 2014-2016
 # simon11 <simon.stieger.98@live.de>, 2014
 # simon11 <simon.stieger.98@live.de>, 2014
 # Ulrich Habel <rhaen@pkgbox.de>, 2014
@@ -14,8 +14,8 @@ msgstr ""
 "Project-Id-Version: Foreman\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2015-12-08 08:56+0000\n"
-"PO-Revision-Date: 2015-12-11 09:09+0000\n"
-"Last-Translator: Lukáš Zapletal\n"
+"PO-Revision-Date: 2016-01-17 22:48+0000\n"
+"Last-Translator: Ettore Atalan <atalanttore@googlemail.com>\n"
 "Language-Team: German (http://www.transifex.com/foreman/foreman/language/de/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -65,35 +65,35 @@ msgstr ""
 
 #: ../lib/hammer_cli/defaults.rb:82
 msgid "Defaults management"
-msgstr ""
+msgstr "Standardeinstellungsverwaltung"
 
 #: ../lib/hammer_cli/defaults_commands.rb:25
 msgid "List all the providers"
-msgstr ""
+msgstr "Alle Anbieter auflisten"
 
 #: ../lib/hammer_cli/defaults_commands.rb:37
 msgid "Provider"
-msgstr ""
+msgstr "Anbieter"
 
 #: ../lib/hammer_cli/defaults_commands.rb:38
 msgid "Supported defaults"
-msgstr ""
+msgstr "Unterstützte Standardeinstellungen"
 
 #: ../lib/hammer_cli/defaults_commands.rb:39
 msgid "Description"
-msgstr ""
+msgstr "Beschreibung"
 
 #: ../lib/hammer_cli/defaults_commands.rb:56
 msgid "List all the default parameters"
-msgstr ""
+msgstr "Alle Standardparameter auflisten"
 
 #: ../lib/hammer_cli/defaults_commands.rb:67
 msgid "Parameter"
-msgstr ""
+msgstr "Parameter"
 
 #: ../lib/hammer_cli/defaults_commands.rb:68
 msgid "Value"
-msgstr ""
+msgstr "Wert"
 
 #: ../lib/hammer_cli/defaults_commands.rb:86
 msgid "Delete a default param"
@@ -101,19 +101,19 @@ msgstr ""
 
 #: ../lib/hammer_cli/defaults_commands.rb:87
 msgid "The name of the default option"
-msgstr ""
+msgstr "Der Name der Standardoption"
 
 #: ../lib/hammer_cli/defaults_commands.rb:103
 msgid "Add a default parameter to config"
-msgstr ""
+msgstr "Standardparameter zur Konfiguration hinzufügen"
 
 #: ../lib/hammer_cli/defaults_commands.rb:104
 msgid "The name of the default option (e.g. organization_id)."
-msgstr ""
+msgstr "Der Name der Standardoption (z.B. organization_id)."
 
 #: ../lib/hammer_cli/defaults_commands.rb:105
 msgid "The value for the default option"
-msgstr ""
+msgstr "Der Wert für die Standardoption"
 
 #: ../lib/hammer_cli/defaults_commands.rb:106
 msgid ""
@@ -145,7 +145,7 @@ msgstr ""
 
 #: ../lib/hammer_cli/defaults_commands.rb:147
 msgid "%{param} was deleted successfully."
-msgstr ""
+msgstr "%{param} wurde erfolgreich gelöscht."
 
 #: ../lib/hammer_cli/defaults_commands.rb:151
 msgid "You must specify value or a provider name, cant specify both."

data/locale/de/hammer-cli.po

@@ -12,7 +12,7 @@
 # hpeters <hpeters@redhat.com>, 2015. #zanata
 msgid ""
 msgstr ""
-"Project-Id-Version: hammer-cli 0.4.0\n"
+"Project-Id-Version: hammer-cli 0.6.0\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2015-04-27 11:50+0000\n"
 "Last-Translator: hpeters <hpeters@redhat.com>\n"

data/locale/en/hammer-cli.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: hammer-cli 0.4.0\n"
+"Project-Id-Version: hammer-cli 0.6.0\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2014-03-04 16:38+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

data/locale/en_GB/hammer-cli.edit.po

@@ -9,8 +9,8 @@ msgstr ""
 "Project-Id-Version: Foreman\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2015-12-08 08:56+0000\n"
-"PO-Revision-Date: 2015-12-11 09:09+0000\n"
-"Last-Translator: Lukáš Zapletal\n"
+"PO-Revision-Date: 2015-12-15 15:11+0000\n"
+"Last-Translator: Andi Chandler <andi@gowling.com>\n"
 "Language-Team: English (United Kingdom) (http://www.transifex.com/foreman/foreman/language/en_GB/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -56,99 +56,99 @@ msgstr "no value provided"
 
 #: ../lib/hammer_cli/defaults.rb:72
 msgid "Couldn't create %s please create the path before defaults are enabled."
-msgstr ""
+msgstr "Couldn't create %s please create the path before defaults are enabled."
 
 #: ../lib/hammer_cli/defaults.rb:82
 msgid "Defaults management"
-msgstr ""
+msgstr "Defaults management"
 
 #: ../lib/hammer_cli/defaults_commands.rb:25
 msgid "List all the providers"
-msgstr ""
+msgstr "List all the providers"
 
 #: ../lib/hammer_cli/defaults_commands.rb:37
 msgid "Provider"
-msgstr ""
+msgstr "Provider"
 
 #: ../lib/hammer_cli/defaults_commands.rb:38
 msgid "Supported defaults"
-msgstr ""
+msgstr "Supported defaults"
 
 #: ../lib/hammer_cli/defaults_commands.rb:39
 msgid "Description"
-msgstr ""
+msgstr "Description"
 
 #: ../lib/hammer_cli/defaults_commands.rb:56
 msgid "List all the default parameters"
-msgstr ""
+msgstr "List all the default parameters"
 
 #: ../lib/hammer_cli/defaults_commands.rb:67
 msgid "Parameter"
-msgstr ""
+msgstr "Parameter"
 
 #: ../lib/hammer_cli/defaults_commands.rb:68
 msgid "Value"
-msgstr ""
+msgstr "Value"
 
 #: ../lib/hammer_cli/defaults_commands.rb:86
 msgid "Delete a default param"
-msgstr ""
+msgstr "Delete a default param"
 
 #: ../lib/hammer_cli/defaults_commands.rb:87
 msgid "The name of the default option"
-msgstr ""
+msgstr "The name of the default option"
 
 #: ../lib/hammer_cli/defaults_commands.rb:103
 msgid "Add a default parameter to config"
-msgstr ""
+msgstr "Add a default parameter to config"
 
 #: ../lib/hammer_cli/defaults_commands.rb:104
 msgid "The name of the default option (e.g. organization_id)."
-msgstr ""
+msgstr "The name of the default option (e.g. organisation_id)."
 
 #: ../lib/hammer_cli/defaults_commands.rb:105
 msgid "The value for the default option"
-msgstr ""
+msgstr "The value for the default option"
 
 #: ../lib/hammer_cli/defaults_commands.rb:106
 msgid ""
 "The name of the provider providing the value. For list available providers "
 "see `hammer defaults providers`."
-msgstr ""
+msgstr "The name of the provider providing the value. For list available providers see `hammer defaults providers`."
 
 #: ../lib/hammer_cli/defaults_commands.rb:134
 msgid ""
 "Added %{key_val} default-option with value that will be generated from the "
 "server."
-msgstr ""
+msgstr "Added %{key_val} default-option with value that will be generated from the server."
 
 #: ../lib/hammer_cli/defaults_commands.rb:135
 msgid "Added %{key_val} default-option with value %{val_val}."
-msgstr ""
+msgstr "Added %{key_val} default-option with value %{val_val}."
 
 #: ../lib/hammer_cli/defaults_commands.rb:139
 msgid ""
 "\"Provider #{namespace} was not found. See `hammer defaults providers` for "
 "available providers.\""
-msgstr ""
+msgstr "\"Provider #{namespace} was not found. See `hammer defaults providers` for available providers.\""
 
 #: ../lib/hammer_cli/defaults_commands.rb:143
 msgid ""
 "The param name is not supported by provider. See `hammer defaults providers`"
 " for supported params."
-msgstr ""
+msgstr "The param name is not supported by provider. See `hammer defaults providers` for supported params."
 
 #: ../lib/hammer_cli/defaults_commands.rb:147
 msgid "%{param} was deleted successfully."
-msgstr ""
+msgstr "%{param} was deleted successfully."
 
 #: ../lib/hammer_cli/defaults_commands.rb:151
 msgid "You must specify value or a provider name, cant specify both."
-msgstr ""
+msgstr "You must specify value or a provider name, cant specify both."
 
 #: ../lib/hammer_cli/defaults_commands.rb:155
 msgid "Couldn't find the requested param in %s."
-msgstr ""
+msgstr "Couldn't find the requested param in %s."
 
 #: ../lib/hammer_cli/exception_handler.rb:62
 msgid "Error: %s"
@@ -324,7 +324,7 @@ msgstr "value must be a combination of '%s'"
 
 #: ../lib/hammer_cli/options/option_definition.rb:56
 msgid "Warning: Option %{option} is deprecated. %{message}"
-msgstr ""
+msgstr "Warning: Option %{option} is deprecated. %{message}"
 
 #: ../lib/hammer_cli/options/option_definition.rb:80
 msgid "Can be specified multiple times. "

data/locale/en_GB/hammer-cli.po

@@ -6,7 +6,7 @@
 # Andi Chandler <andi@gowling.com>, 2015
 msgid ""
 msgstr ""
-"Project-Id-Version: hammer-cli 0.4.0\n"
+"Project-Id-Version: hammer-cli 0.6.0\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2015-08-30 02:01+0000\n"
 "Last-Translator: Andi Chandler <andi@gowling.com>\n"

data/locale/es/hammer-cli.po

@@ -8,7 +8,7 @@
 # gguerrer <gguerrer@redhat.com>, 2015. #zanata
 msgid ""
 msgstr ""
-"Project-Id-Version: hammer-cli 0.4.0\n"
+"Project-Id-Version: hammer-cli 0.6.0\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2015-04-27 06:26+0000\n"
 "Last-Translator: gguerrer <gguerrer@redhat.com>\n"