Fixes #38498 - Add Reboot power operation to Redfish provider

Bug #3073 is caused by 3 things:
1. Foreman core doesn't call BMC proxy's API correctly
   - Changing power state to 'Reboot' via Web GUI calls BMC proxy's 'soft'
     power action
   - Changing power state to 'Reset' via Web GUI calls BMC proxy's 'cycle'
     power action
2. Foreman BMC proxy doesn't support reboot at all BMC provider
3. Foreman BMC proxy doesn't support reset(powerreset) at Redfish provider

2nd & 3rd item are mentioned in #38498. And this PR fixes 2nd item.

For backward compatibility, poweraction_fix_3_17 capability is introduced
to smart proxy at PRs related to #38498. PR related to #3073 adds logic
to determine if smart proxy supports this capability into Foreman core.

Author: vanou

modules/bmc/base.rb

@@ -46,6 +46,10 @@ def powercycle
         raise NotImplementedError.new
       end
 
+      def powerreboot
+        raise NotImplementedError.new
+      end
+
       def bootdevice
         raise NotImplementedError.new
       end

modules/bmc/bmc_api.rb

@@ -163,7 +163,7 @@ class Api < ::Sinatra::Base
     put "/:host/chassis/power/?:action?" do
       # return hint on valid options
       if params[:action].nil?
-        return { :actions => ["on", "off", "cycle", "soft", "reset"] }.to_json
+        return { :actions => ["on", "off", "cycle", "soft", "reset", "reboot"] }.to_json
       end
       bmc_setup
       begin
@@ -178,6 +178,8 @@ class Api < ::Sinatra::Base
             { :action => params[:action], :result => @bmc.poweroff(true) }.to_json
           when "reset"
             { :action => params[:action], :result => @bmc.powerreset }.to_json
+          when "reboot"
+            { :action => params[:action], :result => @bmc.powerreboot }.to_json
           else
             { :error => "The action: #{params[:action]} is not a valid action" }.to_json
         end

modules/bmc/bmc_plugin.rb

@@ -11,6 +11,7 @@ class Plugin < Proxy::Plugin
     capability 'shell'
     capability 'ssh'
     capability -> { Proxy::BMC::IPMI.providers_installed }
+    capability 'poweraction_fix_3_17'
 
     # Load IPMI to ensure the capabilities can be determined
     load_classes do

modules/bmc/redfish.rb

@@ -74,6 +74,10 @@ def powercycle
         poweraction('ForceRestart')
       end
 
+      def powerreboot
+        poweraction('GracefulRestart')
+      end
+
       def poweron
         poweraction('On')
       end

test/bmc/bmc_api_test.rb

@@ -2,6 +2,8 @@
 require 'json'
 require 'bmc/bmc_plugin'
 require 'bmc/bmc_api'
+require 'bmc/redfish'
+require 'test/bmc/redfish_test_helper'
 
 ENV['RACK_ENV'] = 'test'
 
@@ -13,6 +15,7 @@
 
 class BmcApiTest < Test::Unit::TestCase
   include Rack::Test::Methods
+  include RedfishTestHelper
 
   def app
     Proxy::BMC::Api.new
@@ -25,6 +28,7 @@ def setup
     provider ||= ENV["ipmiprovider"] || "ipmitool"
     @args = { 'bmc_provider' => provider, 'blah' => 'test' }
     authorize user, pass
+    mask_redfish_acceess
   end
 
   def test_api_throws_401_error_when_auth_is_not_provided
@@ -572,6 +576,13 @@ def test_api_throws_400_error_when_get_sensors_action_list_execption
     assert_equal 400, last_response.status
   end
 
+  def test_api_calls_redfish_provider_reboot
+    expect = Proxy::BMC::Redfish.any_instance.stubs(:powerreboot)
+    test_args = { 'bmc_provider' => 'redfish' }
+    put "/#{@host}/chassis/power/reboot", test_args
+    assert expect.once
+  end
+
   def test_api_can_pass_options_in_body
     Rubyipmi.stubs(:is_provider_installed?).returns(true)
     args = { 'bmc_provider' => 'freeipmi', :options => {:driver => 'lan20', :privilege => 'USER'} }.to_json

test/bmc/bmc_redfish_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+require 'bmc/bmc_plugin'
+require 'bmc/redfish'
+require 'test/bmc/redfish_test_helper'
+require 'json'
+
+class BmcRedfishTest < Test::Unit::TestCase
+  include RedfishTestHelper
+
+  def setup
+    @host = "host"
+    @protocol = "https"
+    mask_redfish_acceess(protocol: @protocol, host: @host)
+    @args = { :username => "user", :password => "pass", :host => @host }
+    @bmc  = Proxy::BMC::Redfish.new(@args)
+  end
+
+  def test_redfish_provider_reboot
+    stub_request(:post, "#{@protocol}://#{@host}#{SYSTEM_DATA['Actions']['#ComputerSystem.Reset']['target']}").
+      with(body: JSON.generate({ "ResetType" => "GracefulRestart" })).
+      to_return(status: 200, body: JSON.generate({}))
+    assert @bmc.powerreboot
+  end
+end

test/bmc/bmc_test.rb

@@ -56,6 +56,12 @@ def test_should_power_reset
     assert bmc.powerreset
   end
 
+  def test_should_power_reboot
+    assert_raise(NotImplementedError) do
+      bmc.powerreboot
+    end
+  end
+
   def test_should_bootpxe
     Rubyipmi::Ipmitool::Chassis.any_instance.expects(:bootpxe).returns(true)
     bmc.bootpxe

test/bmc/integration_test.rb

@@ -16,7 +16,7 @@ def test_features
     mod = response['bmc']
     refute_nil(mod)
     assert_equal('running', mod['state'], Proxy::LogBuffer::Buffer.instance.info[:failed_modules][:bmc])
-    assert_equal(['redfish', 'shell', 'ssh'], mod['capabilities'])
+    assert_equal(['poweraction_fix_3_17', 'redfish', 'shell', 'ssh'], mod['capabilities'])
 
     assert_equal({}, mod['settings'])
   end
@@ -32,7 +32,7 @@ def test_features_with_freeipmi_installed
     mod = response['bmc']
     refute_nil(mod)
     assert_equal('running', mod['state'], Proxy::LogBuffer::Buffer.instance.info[:failed_modules][:bmc])
-    assert_equal(['freeipmi', 'redfish', 'shell', 'ssh'], mod['capabilities'])
+    assert_equal(['freeipmi', 'poweraction_fix_3_17', 'redfish', 'shell', 'ssh'], mod['capabilities'])
 
     assert_equal({}, mod['settings'])
   end

test/bmc/redfish_test_helper.rb

@@ -0,0 +1,101 @@
+require 'json'
+
+module RedfishTestHelper
+  ROOT_DATA = {
+    "Name" => "Redfish Server Test Mock",
+    "Systems" => {
+      "@odata.id" => "/redfish/v1/Systems",
+    },
+    "Managers" => {
+      "@odata.id" => "/redfish/v1/Managers",
+    },
+    "@odata.id" => "/redfish/v1",
+  }.freeze
+
+  SYSTEMS_DATA = {
+    "@odata.id" => "/redfish/v1/Systems",
+    "Members" => [
+      { "@odata.id" => "/redfish/v1/Systems/TESTSYSTEM" },
+    ],
+  }.freeze
+
+  SYSTEM_DATA = {
+    "@odata.id" => "/redfish/v1/Systems/TESTSYSTEM",
+    "Manufacture" => "Server Vendor",
+    "IndicatorLED" => "Off",
+    "PowerState" => "On",
+    "Boot" => {
+      "BootSourceOverrideTarget" => "Pxe",
+    },
+    "Model" => "TestServer A",
+    "SerialNumber" => "AA645",
+    "AssetTag" => "ax",
+    "Actions" => {
+      "#ComputerSystem.Reset" => {
+        "target" => "/redfish/v1/Systems/TESTSYSTEM/Actions/ComputerSystem.Reset",
+      },
+    },
+  }.freeze
+
+  MANAGERS_DATA = {
+    "@odata.id" => "/redfish/v1/Managers",
+    "Members" => [
+      { "@odata.id" => "/redfish/v1/Managers/TESTBMC" },
+    ],
+  }.freeze
+
+  MANAGER_DATA = {
+    "@odata.id" => "/redfish/v1/Managers/TESTBMC",
+    "FirmwareVersion" => "v1.0.0",
+    "UUID" => "dff64837-f76b-40c2-b1a2-4717a78d828d",
+    "EthernetInterfaces" => {
+      "@odata.id" => "/redfish/v1/Managers/TESTBMC/EthernetInterfaces",
+    },
+  }.freeze
+
+  ETHERNET_INTERFACES_DATA = {
+    "@odata.id" => "/redfish/v1/Managers/TESTBMC/EthernetInterfaces",
+    "Members" => [
+      { "@odata.id" => "/redfish/v1/Managers/TESTBMC/EthernetInterfaces/BMC" },
+    ],
+  }.freeze
+
+  BMC_NIC_DATA = {
+    "@odata.id" => "/redfish/v1/Managers/TESTBMC/EthernetInterfaces/BMC",
+    "MACAddress" => "52:54:00:01:23:45",
+    "IPv4Addresses" => [
+      { "Address" => "192.168.124.123",
+        "Gateway" => "192.168.124.1",
+        "SubnetMask" => "255.255.255.0",
+        "AddressOrigin" => "DHCP" },
+    ],
+    "VLAN" => {
+      "VLANEnable" => true,
+      "VLANId" => 10,
+    },
+  }.freeze
+
+  def mask_redfish_acceess(protocol: "https", host: "host")
+    # root
+    stub_request(:get, "#{protocol}://#{host}#{ROOT_DATA['@odata.id']}").
+      to_return(status: 200, body: JSON.generate(ROOT_DATA))
+    # root.systems
+    stub_request(:get, "#{protocol}://#{host}#{SYSTEMS_DATA['@odata.id']}").
+      to_return(status: 200, body: JSON.generate(SYSTEMS_DATA))
+    # root.system
+    stub_request(:get, "#{protocol}://#{host}#{SYSTEM_DATA['@odata.id']}").
+      to_return(status: 200, body: JSON.generate(SYSTEM_DATA))
+    # root.managers
+    stub_request(:get, "#{protocol}://#{host}#{MANAGERS_DATA['@odata.id']}").
+      to_return(status: 200, body: JSON.generate(MANAGERS_DATA))
+    # root.manager
+    stub_request(:get, "#{protocol}://#{host}#{MANAGER_DATA['@odata.id']}").
+      to_return(status: 200, body: JSON.generate(MANAGER_DATA))
+    # root.manager.ethernetinterfaces
+    stub_request(:get, "#{protocol}://#{host}#{ETHERNET_INTERFACES_DATA['@odata.id']}").
+      to_return(status: 200, body: JSON.generate(ETHERNET_INTERFACES_DATA))
+    # bmcnic
+    stub_request(:get, "#{protocol}://#{host}#{BMC_NIC_DATA['@odata.id']}").
+      to_return(status: 200, body: JSON.generate(BMC_NIC_DATA))
+  end
+end