hammer_cli_foreman 0.18.2 → 0.19.0

data/lib/hammer_cli_foreman/openid_connect.rb

@@ -0,0 +1,68 @@
+require 'net/http'
+require 'uri'
+module HammerCLIForeman
+  class OpenidConnect
+    def initialize(url, oidc_client_id)
+      @url = url
+      @oidc_client_id = oidc_client_id
+    end
+
+    def get_token(username, password)
+      uri = URI.parse(@url)
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = 'application/x-www-form-urlencoded'
+      request.set_form_data(
+        'username' => username,
+        'password' => password,
+        'grant_type' => 'password',
+        'client_id' => @oidc_client_id
+      )
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |https|
+        https.request(request)
+      end
+      json_response = JSON.parse(response.body)
+      if json_response.is_a?(Hash)
+        json_response['access_token']
+      else
+        raise _("Invalid access token response.")
+        nil
+      end
+    rescue JSON::ParserError => e
+      raise _('Invalid access token')
+      nil
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+        Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+      raise _("Failed to recieve acess token, please check your connectivity with OpenID provider: %s") % e
+      nil
+    end
+
+    def get_token_via_2fa(code, oidc_redirect_uri)
+      uri = URI.parse(@url)
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = 'application/x-www-form-urlencoded'
+      request.set_form_data(
+        'client_id' => @oidc_client_id,
+        'code' => code,
+        'grant_type' => 'authorization_code',
+        'redirect_uri' => oidc_redirect_uri
+      )
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |https|
+        https.request(request)
+      end
+      json_response = JSON.parse(response.body)
+      if json_response.is_a?(Hash)
+        json_response['access_token']
+      else
+        raise _("Invalid access token response.")
+        nil
+      end
+    rescue JSON::ParserError => e
+      raise _('Invalid access token')
+      nil
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+        Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+      raise _("Failed to recieve acess token, please check your connectivity with OpenID provider: %s") % e
+      nil
+    end
+  end
+end

data/lib/hammer_cli_foreman/organization.rb

@@ -13,7 +13,7 @@ module HammerCLIForeman
         field :id, _("Id")
         field :title, _("Title")
         field :name, _("Name")
-        field :description, _("Description")
+        field :description, _("Description"), Fields::Text
       end
 
       build_options

data/lib/hammer_cli_foreman/output/formatters.rb

@@ -1,8 +1,8 @@
 module HammerCLIForeman::Output
   module Formatters
     class ReferenceFormatter < HammerCLI::Output::Formatters::FieldFormatter
-      def tags
-        [:flat]
+      def required_features
+        %i[serialized]
       end
 
       # Parameters:
@@ -51,8 +51,8 @@ module HammerCLIForeman::Output
     end
 
     class StructuredReferenceFormatter < HammerCLI::Output::Formatters::FieldFormatter
-      def tags
-        [:data]
+      def required_features
+        %i[structured]
       end
 
       # Parameters:
@@ -103,4 +103,3 @@ module HammerCLIForeman::Output
     HammerCLI::Output::Output.register_formatter(StructuredReferenceFormatter.new, :Template)
   end
 end
-

data/lib/hammer_cli_foreman/partition_table.rb

@@ -18,6 +18,7 @@ module HammerCLIForeman
 
     class InfoCommand < HammerCLIForeman::InfoCommand
       output ListCommand.output_definition do
+        field :description, _('Description'), Fields::Text
         field :locked, _("Locked"), Fields::Boolean
         HammerCLIForeman::References.operating_systems(self)
         HammerCLIForeman::References.timestamps(self)

data/lib/hammer_cli_foreman/ping.rb

@@ -0,0 +1,24 @@
+module HammerCLIForeman
+  class PingCommand < HammerCLIForeman::Command
+      resource :ping
+
+      class ForemanCommand < HammerCLIForeman::Command
+        action :ping
+        command_name 'foreman'
+
+        output do
+          from 'foreman' do
+            field :database, _('database'), Fields::Label do
+              field :active, _('Status')
+              field :duration_ms, _('Server Response')
+            end
+          end
+        end
+
+        extend_with(HammerCLIForeman::CommandExtensions::Ping.new)
+      end
+
+    self.default_subcommand = 'foreman'
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman/report_template.rb

@@ -14,6 +14,7 @@ module HammerCLIForeman
 
     class InfoCommand < HammerCLIForeman::InfoCommand
       output ListCommand.output_definition do
+        field :description, _('Description'), Fields::Text
         field :locked, _("Locked"), Fields::Boolean
         field :default, _("Default"), Fields::Boolean
         HammerCLIForeman::References.timestamps(self)
@@ -162,7 +163,7 @@ module HammerCLIForeman
     end
 
     class CreateCommand < HammerCLIForeman::CreateCommand
-      option ['--interactive', '-i'], :flag, _('Open empty template in an $EDITOR. Upload the result')
+      option ['-i', '--interactive'], :flag, _('Open empty template in an $EDITOR. Upload the result')
       option "--file", "LAYOUT", _("Path to a file that contains the report template content"),
         :attribute_name => :option_template, :format => HammerCLI::Options::Normalizers::File.new
 
@@ -187,7 +188,7 @@ module HammerCLIForeman
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-      option ['--interactive', '-i'], :flag, _('Dump existing template and open it in an $EDITOR. Update with the result')
+      option ['-i', '--interactive'], :flag, _('Dump existing template and open it in an $EDITOR. Update with the result')
       option '--file', 'REPORT', _("Path to a file that contains the report template content"), :attribute_name => :option_template,
         :format => HammerCLI::Options::Normalizers::File.new
 

data/lib/hammer_cli_foreman/sessions.rb

@@ -0,0 +1,92 @@
+require 'uri'
+module HammerCLIForeman
+  class Sessions
+
+    STORAGE_DIR = File.expand_path('~/.hammer/sessions/')
+
+    def self.get(url)
+      raise _('Sessions are not enabled, please check your Hammer settings.') unless enabled?
+
+      unless File.exist?(storage)
+        FileUtils.mkdir_p(storage, mode: 0700)
+      end
+      unless configured?(url)
+        warn _('Using session auth with invalid permissions on session files is not recommended.')
+      end
+      HammerCLIForeman::Session.new(session_file(url))
+    end
+
+    def self.storage
+      STORAGE_DIR
+    end
+
+    def self.enabled?
+      HammerCLI::Settings.get(:foreman, :use_sessions)
+    end
+
+    def self.session_file(url)
+      raise _('The url is empty. Session can not be created.') if url.nil? || url.empty?
+
+      uri = URI.parse(url)
+      File.join(storage, "#{uri.scheme}_#{uri.host}")
+    rescue URI::InvalidURIError
+      raise _('The url (%s) is not a valid URL. Session can not be created.') % url
+    end
+
+    def self.configured?(url)
+      ensure_mode(storage, '40700') && ensure_mode(session_file(url), '100600')
+    end
+
+    def self.ensure_mode(file, expected_mode)
+      return true unless File.exist?(file)
+
+      mode = File.stat(file).mode.to_s(8)
+      if mode != expected_mode
+        warn _("Invalid permissions for %{file}: %{mode}, expected %{expected_mode}.") % {
+          :mode => mode,
+          :expected_mode => expected_mode,
+          :file => file
+        }
+        false
+      else
+        true
+      end
+    end
+  end
+
+  class Session
+    attr_accessor :id, :user_name, :auth_type
+
+    def initialize(session_path)
+      @session_path = File.expand_path(session_path)
+      if File.exist?(@session_path) && !File.zero?(@session_path)
+        session_data = JSON.parse(File.read(@session_path))
+        @id = session_data['id']
+        @user_name = session_data['user_name']
+        @auth_type = session_data['auth_type']
+      end
+    rescue JSON::ParserError
+      warn _('Invalid session data. Resetting the session.')
+    end
+
+    def store
+      File.open(@session_path,"w") do |f|
+        f.write({
+          id: id,
+          auth_type: auth_type,
+          user_name: user_name
+        }.to_json)
+      end
+      File.chmod(0600, @session_path)
+    end
+
+    def destroy
+      @id = nil
+      store
+    end
+
+    def valid?
+      !id.nil? && !id.empty?
+    end
+  end
+end

data/lib/hammer_cli_foreman/status.rb

@@ -0,0 +1,53 @@
+module HammerCLIForeman
+  class StatusCommand < HammerCLIForeman::Command
+    resource :ping
+
+    class ForemanCommand < HammerCLIForeman::Command
+      action :statuses
+      command_name 'foreman'
+
+      output do
+        from 'foreman' do
+          field :version, _('Version')
+          from 'api' do
+            field :version, _('API Version')
+          end
+          field :database, _('Database'), Fields::Label do
+            field :active, _('Status')
+            field :duration_ms, _('Server Response')
+          end
+          collection :plugins, _('Plugins') do
+            field :name, _('Name')
+            field :version, _('Version')
+          end
+          collection :smart_proxies, _('Smart Proxies') do
+            field :name, _('Name')
+            field :version, _('Version')
+            field :status, _('Status')
+            collection :features, _('Features'), hide_blank: true do
+              field :name, _('Name')
+              field :version, _('Version')
+            end
+            collection :failed_features, _('Failed features'), hide_blank: true do
+              field :name, _('Name')
+              field :error, _('Error')
+            end
+          end
+          collection :compute_resources, _('Compute Resources') do
+            field :name, _('Name')
+            field :status, _('Status')
+            collection :errors, _('Errors'), hide_blank: true do
+              field nil, nil
+            end
+          end
+        end
+      end
+
+      extend_with(HammerCLIForeman::CommandExtensions::Ping.new(only: :data))
+      extend_with(HammerCLIForeman::CommandExtensions::Status.new(only: :data))
+    end
+
+    self.default_subcommand = 'foreman'
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman/subnet.rb

@@ -37,6 +37,7 @@ module HammerCLIForeman
         field :mask, _("Network Mask")
         field :vlanid, _("VLAN ID")
         field :boot_mode, _("Boot Mode")
+        field :gateway, _("Gateway Address")
       end
 
       build_options

data/lib/hammer_cli_foreman/template.rb

@@ -52,6 +52,7 @@ module HammerCLIForeman
     class InfoCommand < HammerCLIForeman::InfoCommand
 
       output ListCommand.output_definition do
+        field :description, _('Description'), Fields::Text
         field :locked, _("Locked"), Fields::Boolean
         HammerCLIForeman::References.operating_systems(self)
         HammerCLIForeman::References.taxonomies(self)

data/lib/hammer_cli_foreman/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForeman
   def self.version
-    @version ||= Gem::Version.new "0.18.2"
+    @version ||= Gem::Version.new "0.19.0"
   end
 end

data/lib/hammer_cli_foreman.rb

@@ -20,6 +20,7 @@ module HammerCLIForeman
   require 'hammer_cli_foreman/dependency_resolver'
   require 'hammer_cli_foreman/option_sources'
   require 'hammer_cli_foreman/logger'
+  require 'hammer_cli_foreman/sessions'
 
   begin
     require 'hammer_cli_foreman/command_extensions'
@@ -168,6 +169,13 @@ module HammerCLIForeman
       'HammerCLIForeman::ConfigGroup', 'hammer_cli_foreman/config_group'
     )
 
+    HammerCLI::MainCommand.lazy_subcommand('ping', _("Get the status of the server and/or it's subcomponents"),
+      'HammerCLIForeman::PingCommand', 'hammer_cli_foreman/ping'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('status', _("Get the complete status of the server and/or it's subcomponents"),
+      'HammerCLIForeman::StatusCommand', 'hammer_cli_foreman/status'
+    )
   rescue => e
     handler = HammerCLIForeman::ExceptionHandler.new(:context => {}, :adapter => :base)
     handler.handle_exception(e)