Fixes #39067 - rebuild only if host powered off

Author: sbernhard

app/controllers/api/v2/hosts_controller.rb

@@ -298,6 +298,10 @@ def facts
       param :id, :identifier_dottable, :required => true
       param :only, Array, :desc => N_("Limit rebuild steps, valid steps are %{host_rebuild_steps}")
       def rebuild_config
+        if @host.rebuild_requires_poweroff
+          return render_error :custom_error, :status => :unprocessable_entity, :locals => { :message => _('Host must be powered off to initiate "Build".') }
+        end
+
         result = @host.recreate_config(params[:only])
         failures = result.reject { |key, value| value }.keys.map { |k| _(k) }
         if failures.empty?

app/models/host/managed.rb

@@ -500,6 +500,13 @@ def self.registered_provision_methods
     Foreman::Plugin.all.map(&:provision_methods).inject(:merge) || {}
   end
 
+  def rebuild_requires_poweroff
+    method_name = "#{provision_method}_rebuild_requires_poweroff"
+    return false unless respond_to?(method_name)
+
+    public_send(method_name)
+  end
+
   def self.valid_rebuild_only_values
     if Host::Managed.respond_to?(:rebuild_methods)
       Nic::Managed.rebuild_methods.values + Host::Managed.rebuild_methods.values

app/views/api/v2/hosts/main.json.rabl

@@ -13,7 +13,7 @@ attributes :ip, :ip6, :last_report, :mac, :realm_id, :realm_name,
   :sp_mac, :sp_ip, :sp_name, :domain_id, :domain_name, :architecture_id, :architecture_name, :operatingsystem_id, :operatingsystem_name,
   :subnet_id, :subnet_name, :subnet6_id, :subnet6_name, :sp_subnet_id, :ptable_id, :ptable_name, :medium_id, :medium_name, :pxe_loader,
   :build, :comment, :disk, :initiated_at, :installed_at, :model_id, :hostgroup_id, :owner_id, :owner_name, :owner_type, :creator_id, :creator,
-  :enabled, :managed, :use_image, :image_file, :uuid,
+  :enabled, :managed, :use_image, :image_file, :uuid, :rebuild_requires_poweroff,
   :compute_resource_id, :compute_resource_name,
   :compute_profile_id, :compute_profile_name, :capabilities, :provision_method,
   :certname, :image_id, :image_name, :created_at, :updated_at,

test/controllers/api/v2/hosts_controller_test.rb

@@ -603,6 +603,23 @@ def test_rebuild_config_pessimistic
     assert_response 422
   end
 
+  def test_rebuild_config_but_dont_requires_poweroff
+    Host.any_instance.expects(:recreate_config).returns({ "TFTP" => true })
+    Host.any_instance.expects(:rebuild_requires_poweroff).returns(false)
+    host = FactoryBot.create(:host)
+    post :rebuild_config, params: { :id => host.to_param }, session: set_session_user
+    assert_response :success
+  end
+
+  def test_rebuild_config_but_requires_poweroff
+    Host.any_instance.expects(:recreate_config).returns({ "TFTP" => true })
+    Host.any_instance.expects(:provision_method).returns("bootdisk")
+    Host.any_instance.expects(:bootdisk_rebuild_requires_poweroff).returns(true)
+    host = FactoryBot.create(:host)
+    post :rebuild_config, params: { :id => host.to_param }, session: set_session_user
+    assert_response 422
+  end
+
   def test_rebuild_tftp_config
     Host.any_instance.expects(:recreate_config).returns({ "TFTP" => true })
     host = FactoryBot.create(:host)

webpack/assets/javascripts/react_app/components/HostDetails/ActionsBar/actions.js

@@ -6,7 +6,7 @@ import { openConfirmModal } from '../../ConfirmModal';
 import { APIActions } from '../../../redux/API';
 import { HOST_DETAILS_KEY } from '../consts';
 import { selectAPIResponse } from '../../../redux/API/APISelectors';
-import { POWER_REQURST_KEY } from '../DetailsCard/PowerStatus/constants';
+import { POWER_REQUEST_KEY } from '../DetailsCard/PowerStatus/constants';
 
 export const deleteHost = (
   hostName,
@@ -106,6 +106,6 @@ export const cancelBuild = (hostId, hostName) => dispatch => {
 };
 
 export const isHostTurnOn = store => {
-  const { state } = selectAPIResponse(store, POWER_REQURST_KEY);
+  const { state } = selectAPIResponse(store, POWER_REQUEST_KEY);
   return state === 'on';
 };

webpack/assets/javascripts/react_app/components/HostDetails/ActionsBar/index.js

@@ -45,6 +45,7 @@ const ActionsBar = ({
   hostName,
   computeId,
   isBuild,
+  buildRequiresPowerOff,
   permissions: {
     destroy_hosts: canDestroy,
     create_hosts: canCreate,
@@ -90,7 +91,14 @@ const ActionsBar = ({
       onClick={buildHandler}
       key="build"
       component="button"
-      isDisabled={!canBuild}
+      description={
+        canBuild && !isBuild && buildRequiresPowerOff && isHostActive
+          ? __('Host must be powered off to initiate "Build".')
+          : ''
+      }
+      isDisabled={
+        !canBuild || (!isBuild && buildRequiresPowerOff && isHostActive)
+      }
       icon={
         <Icon>
           <BuildIcon />
@@ -232,6 +240,7 @@ ActionsBar.propTypes = {
   computeId: PropTypes.number,
   permissions: PropTypes.object,
   isBuild: PropTypes.bool,
+  buildRequiresPowerOff: PropTypes.bool,
 };
 ActionsBar.defaultProps = {
   hostId: undefined,
@@ -245,6 +254,7 @@ ActionsBar.defaultProps = {
     build_hosts: false,
   },
   isBuild: false,
+  buildRequiresPowerOff: false,
 };
 
 export default ActionsBar;

webpack/assets/javascripts/react_app/components/HostDetails/DetailsCard/PowerStatus/actions.js

@@ -1,10 +1,10 @@
 import { translate as __, sprintf } from '../../../../common/I18n';
 import { put } from '../../../../redux/API';
-import { POWER_REQURST_KEY, SUPPORTED_POWER_STATES } from './constants';
+import { POWER_REQUEST_KEY, SUPPORTED_POWER_STATES } from './constants';
 
 export const changeHostPower = (state, hostID) =>
   put({
-    key: POWER_REQURST_KEY,
+    key: POWER_REQUEST_KEY,
     params: { power_action: state },
     url: `/api/hosts/${hostID}/power`,
     errorToast: err => sprintf(__('an error occurred: %s'), err),

webpack/assets/javascripts/react_app/components/HostDetails/DetailsCard/PowerStatus/constants.js

@@ -1,7 +1,7 @@
 import { translate as __ } from '../../../../common/I18n';
 
-export const POWER_REQURST_KEY = 'HOST_TOGGLE_POWER';
-export const POWER_REQUEST_OPTIONS = { key: POWER_REQURST_KEY, params: { timeout: 30 } };
+export const POWER_REQUEST_KEY = 'HOST_TOGGLE_POWER';
+export const POWER_REQUEST_OPTIONS = { key: POWER_REQUEST_KEY, params: { timeout: 30 } };
 export const BASE_POWER_STATES = { off: __('Off'), on: __('On') };
 export const BMC_POWER_STATES = { reboot: __('Reboot'), reset: __('Reset'), soft: __('Soft'), cycle: __('Cycle') };
 export const SUPPORTED_POWER_STATES = {

webpack/assets/javascripts/react_app/components/HostDetails/index.js

@@ -216,6 +216,7 @@ const HostDetails = ({
                   hostName={response.name}
                   permissions={response.permissions}
                   isBuild={response.build}
+                  buildRequiresPowerOff={response.rebuild_requires_poweroff}
                 />
               </FlexItem>
             </Flex>