Fixes #38498 - Fix incorrect Cycle power operation in Redfish provider

Bug #38498 mentions 3 power operation bugs in Redfish provider.
This PR fixes wrong implementation of Cycle power operatoin:
When user pushes Cycle button, Redfish provider does ForceRestart
instead of PowerCycle.

This PR makes powercycle method does 'PowerCycle'.

Co-Authored-By: Vanou Ishii <[email protected]>, Yusuke Hirota
<[email protected]>

Author: hiroshi-ikuta

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_16'
 
     # Load IPMI to ensure the capabilities can be determined
     load_classes do

modules/bmc/redfish.rb

@@ -71,7 +71,7 @@ def poweroff(soft = false)
       end
 
       def powercycle
-        poweraction('ForceRestart')
+        poweraction('PowerCycle')
       end
 
       def poweron

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_cycle
+    expect = Proxy::BMC::Redfish.any_instance.stubs(:powercycle)
+    test_args = { 'bmc_provider' => 'redfish' }
+    put "/#{@host}/chassis/power/cycle", 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_cycle
+    stub_request(:post, "#{@protocol}://#{@host}#{SYSTEM_DATA['Actions']['#ComputerSystem.Reset']['target']}").
+      with(body: JSON.generate({"ResetType" => "PowerCycle"})).
+      to_return(status: 200, body: JSON.generate({}))
+    assert @bmc.powercycle
+  end
+end

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_16', '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_16', '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