Update stck state validation error and warning messages

Signed-off-by: Rashed Kamal <rashed.kamal@broadcom.com>

Author: rashedkvm

lib/cloud_controller/stack_state_validator.rb

@@ -6,23 +6,27 @@ class RestrictedStackError < StackValidationError; end
     def self.validate_for_new_app!(stack)
       return [] if stack.active?
 
-      raise DisabledStackError.new("Stack '#{stack.name}' is disabled and cannot be used for staging new applications. #{stack.description}") if stack.disabled?
+      raise DisabledStackError.new(build_stack_error(stack, StackStates::STACK_DISABLED)) if stack.disabled?
 
-      raise RestrictedStackError.new("Stack '#{stack.name}' is restricted and cannot be used for staging new applications. #{stack.description}") if stack.restricted?
+      raise RestrictedStackError.new(build_stack_error(stack, StackStates::STACK_RESTRICTED)) if stack.restricted?
 
-      stack.deprecated? ? [build_deprecation_warning(stack)] : []
+      stack.deprecated? ? [build_deprecation_warning(stack, StackStates::STACK_DEPRECATED)] : []
     end
 
     def self.validate_for_restaging!(stack)
       return [] if stack.active? || stack.restricted?
 
-      raise DisabledStackError.new("Stack '#{stack.name}' is disabled and cannot be used for staging new applications. #{stack.description}") if stack.disabled?
+      raise DisabledStackError.new(build_stack_error(stack, StackStates::STACK_DISABLED)) if stack.disabled?
 
-      stack.deprecated? ? [build_deprecation_warning(stack)] : []
+      stack.deprecated? ? [build_deprecation_warning(stack, StackStates::STACK_DEPRECATED)] : []
     end
 
-    def self.build_deprecation_warning(stack)
-      "Stack '#{stack.name}' is deprecated and will be removed in the future. #{stack.description}"
+    def self.build_stack_error(stack, state)
+      "ERROR: Staging failed. The stack '#{stack.name}' is '#{state}' and cannot be used for staging."
+    end
+
+    def self.build_deprecation_warning(stack, state)
+      "WARNING: The stack '#{stack.name}' is '#{state}' and will be removed in the future."
     end
   end
 end

spec/request/builds_spec.rb

@@ -222,8 +222,8 @@
         post '/v3/builds', create_request.to_json, developer_headers
 
         expect(last_response.status).to eq(422)
-        expect(parsed_response['errors'].first['detail']).to include('disabled')
-        expect(parsed_response['errors'].first['detail']).to include('cannot be used for staging new applications')
+        expect(parsed_response['errors'].first['detail']).to include('DISABLED')
+        expect(parsed_response['errors'].first['detail']).to include('cannot be used for staging')
         expect(VCAP::CloudController::BuildModel.count).to eq(0)
       end
     end
@@ -252,7 +252,8 @@
           post '/v3/builds', create_request.to_json, developer_headers
 
           expect(last_response.status).to eq(422)
-          expect(parsed_response['errors'].first['detail']).to include('cannot be used for staging new applications')
+          expect(parsed_response['errors'].first['detail']).to include('cannot be used for staging')
+          expect(parsed_response['errors'].first['detail']).to include('RESTRICTED')
           expect(VCAP::CloudController::BuildModel.count).to eq(0)
         end
       end
@@ -300,18 +301,19 @@
           expect(last_response.status).to eq(201)
           expect(parsed_response['state']).to eq('STAGING')
           expect(parsed_response['warnings']).to be_present
-          expect(parsed_response['warnings'][0]['detail']).to include('deprecated')
-          expect(parsed_response['warnings'][0]['detail']).to include('cflinuxfs3 stack is deprecated')
+          expect(parsed_response['warnings'][0]['detail']).to include('DEPRECATED')
+          expect(parsed_response['warnings'][0]['detail']).to include('cflinuxfs3')
+          expect(parsed_response['warnings'][0]['detail']).to include('WARNING')
         end
 
-        it 'includes warming in response headers' do
+        it 'includes warning in response headers' do
           post '/v3/builds', create_request.to_json, developer_headers
 
           expect(last_response.status).to eq(201)
           expect(last_response.headers['X-Cf-Warnings']).to be_present
           warning = CGI.unescape(last_response.headers['X-Cf-Warnings'])
-          expect(warning).to include('deprecated')
-          expect(warning).to include('cflinuxfs3 stack is deprecated')
+          expect(warning).to include('DEPRECATED')
+          expect(warning).to include('cflinuxfs3')
         end
       end
 
@@ -328,19 +330,19 @@
           expect(last_response.status).to eq(201)
           expect(parsed_response['state']).to eq('STAGING')
           expect(parsed_response['warnings']).to be_present
-          expect(parsed_response['warnings'][0]['detail']).to include('deprecated')
-          expect(parsed_response['warnings'][0]['detail']).to include('cflinuxfs3 stack is deprecated')
+          expect(parsed_response['warnings'][0]['detail']).to include('DEPRECATED')
+          expect(parsed_response['warnings'][0]['detail']).to include('cflinuxfs3')
           expect(app_model.builds_dataset.count).to eq(2)
         end
 
-        it 'includes warming in response headers' do
+        it 'includes warning in response headers' do
           post '/v3/builds', create_request.to_json, developer_headers
 
           expect(last_response.status).to eq(201)
           expect(last_response.headers['X-Cf-Warnings']).to be_present
           warning = CGI.unescape(last_response.headers['X-Cf-Warnings'])
-          expect(warning).to include('deprecated')
-          expect(warning).to include('cflinuxfs3 stack is deprecated')
+          expect(warning).to include('DEPRECATED')
+          expect(warning).to include('cflinuxfs3')
         end
       end
     end

spec/request/v2/apps_spec.rb

@@ -951,7 +951,7 @@
           expect(last_response.status).to eq(422)
           parsed_response = Oj.load(last_response.body)
           expect(parsed_response['error_code']).to eq('CF-StackValidationFailed')
-          expect(parsed_response['description']).to include('disabled')
+          expect(parsed_response['description']).to include('DISABLED')
           expect(parsed_response['description']).to include('cflinuxfs2')
         end
       end
@@ -972,8 +972,8 @@
           expect(last_response.status).to eq(201)
           expect(last_response.headers['X-Cf-Warnings']).to be_present
           decoded_warning = CGI.unescape(last_response.headers['X-Cf-Warnings'])
-          expect(decoded_warning).to include('deprecated')
-          expect(decoded_warning).to include('EOL Dec 2025')
+          expect(decoded_warning).to include('DEPRECATED')
+          expect(decoded_warning).to include('cflinuxfs3')
         end
       end
     end
@@ -1639,10 +1639,9 @@ def make_actual_lrp(instance_guid:, index:, state:, error:, since:)
           expect(last_response.status).to eq(422)
           parsed_response = Oj.load(last_response.body)
           expect(parsed_response['error_code']).to eq('CF-StackValidationFailed')
-          expect(parsed_response['description']).to include('disabled')
+          expect(parsed_response['description']).to include('DISABLED')
           expect(parsed_response['description']).to include('cannot be used for staging')
           expect(parsed_response['description']).to include('cflinuxfs2')
-          expect(parsed_response['description']).to include('Migrate to cflinuxfs4')
         end
 
         it 'does not expose stack state field in error response' do
@@ -1674,7 +1673,7 @@ def make_actual_lrp(instance_guid:, index:, state:, error:, since:)
             expect(last_response.status).to eq(422)
             parsed_response = Oj.load(last_response.body)
             expect(parsed_response['error_code']).to eq('CF-StackValidationFailed')
-            expect(parsed_response['description']).to include('cannot be used for staging new applications')
+            expect(parsed_response['description']).to include('cannot be used for staging')
             expect(parsed_response['description']).to include('cflinuxfs3')
           end
         end
@@ -1716,9 +1715,8 @@ def make_actual_lrp(instance_guid:, index:, state:, error:, since:)
 
           expect(last_response.headers['X-Cf-Warnings']).to be_present
           decoded_warning = CGI.unescape(last_response.headers['X-Cf-Warnings'])
-          expect(decoded_warning).to include('deprecated')
+          expect(decoded_warning).to include('DEPRECATED')
           expect(decoded_warning).to include('cflinuxfs3')
-          expect(decoded_warning).to include('EOL Dec 2025')
         end
 
         it 'does not expose stack state field in response body' do

spec/unit/actions/build_create_spec.rb

@@ -466,8 +466,8 @@ module VCAP::CloudController
             action.create_and_stage(package:, lifecycle:)
           end.to raise_error(CloudController::Errors::ApiError) do |error|
             expect(error.name).to eq('StackValidationFailed')
-            expect(error.message).to include('disabled')
-            expect(error.message).to include('cannot be used for staging new applications')
+            expect(error.message).to include('DISABLED')
+            expect(error.message).to include('cannot be used for staging')
           end
         end
 
@@ -496,7 +496,8 @@ module VCAP::CloudController
               action.create_and_stage(package:, lifecycle:)
             end.to raise_error(CloudController::Errors::ApiError) do |error|
               expect(error.name).to eq('StackValidationFailed')
-              expect(error.message).to include('annot be used for staging new applications')
+              expect(error.message).to include('annot be used for staging')
+              expect(error.message).to include('RESTRICTED')
             end
           end
 

spec/unit/actions/v2/app_stage_spec.rb

@@ -239,9 +239,8 @@ module V2
               action.stage(process)
 
               expect(action.warnings).not_to be_empty
-              expect(action.warnings.first).to include('deprecated')
+              expect(action.warnings.first).to include('DEPRECATED')
               expect(action.warnings.first).to include('cflinuxfs3')
-              expect(action.warnings.first).to include('EOL Dec 2025')
             end
           end
 
@@ -269,7 +268,7 @@ module V2
             it 'raises StackValidationFailed error' do
               expect { action.stage(process) }.to raise_error(CloudController::Errors::ApiError) do |error|
                 expect(error.name).to eq('StackValidationFailed')
-                expect(error.message).to include('disabled')
+                expect(error.message).to include('DISABLED')
                 expect(error.message).to include('cannot be used for staging')
               end
             end
@@ -292,7 +291,8 @@ module V2
 
                 expect { action.stage(process) }.to raise_error(CloudController::Errors::ApiError) do |error|
                   expect(error.name).to eq('StackValidationFailed')
-                  expect(error.message).to include('cannot be used for staging new applications')
+                  expect(error.message).to include('cannot be used for staging')
+                  expect(error.message).to include('RESTRICTED')
                 end
               end
             end

spec/unit/lib/cloud_controller/stack_state_validator_spec.rb

@@ -23,15 +23,14 @@ module VCAP::CloudController
           result = StackStateValidator.validate_for_new_app!(stack)
           expect(result).to be_an(Array)
           expect(result.size).to eq(1)
-          expect(result.first).to include("Stack '#{stack.name}' is deprecated and will be removed in the future. #{stack.description}")
+          expect(result.first).to include("stack '#{stack.name}' is '#{StackStates::STACK_DEPRECATED}' and will be removed in the future")
         end
 
         it 'returns a warning message with stack name' do
           result = StackStateValidator.validate_for_new_app!(stack)
           warning = result.first
           expect(warning).to include(stack.name)
-          expect(warning).to include(stack.description)
-          expect(warning).to include('deprecated')
+          expect(warning).to include('DEPRECATED')
         end
 
         it 'does not raise an error' do
@@ -45,7 +44,7 @@ module VCAP::CloudController
         it 'raise RestrictedStackError' do
           expect do
             StackStateValidator.validate_for_new_app!(stack)
-          end.to raise_error(StackStateValidator::RestrictedStackError, /Stack '#{stack.name}' is restricted and cannot be used for staging new applications./)
+          end.to raise_error(StackStateValidator::RestrictedStackError, /The stack '#{stack.name}' is '#{StackStates::STACK_RESTRICTED}' and cannot be used for staging./)
         end
 
         it 'includes stack name in error message' do
@@ -54,12 +53,6 @@ module VCAP::CloudController
           end.to raise_error(StackStateValidator::RestrictedStackError, /#{stack.name}/)
         end
 
-        it 'includes stack description in error message' do
-          expect do
-            StackStateValidator.validate_for_new_app!(stack)
-          end.to raise_error(StackStateValidator::RestrictedStackError, /#{stack.description}/)
-        end
-
         it 'raises RestrictedStackError which is a StackStateValidator::Error' do
           expect do
             StackStateValidator.validate_for_new_app!(stack)
@@ -73,20 +66,14 @@ module VCAP::CloudController
         it 'returns a disabled error message' do
           expect do
             StackStateValidator.validate_for_new_app!(stack)
-          end.to raise_error(StackStateValidator::DisabledStackError, /Stack '#{stack.name}' is disabled and cannot be used for staging new applications./)
+          end.to raise_error(StackStateValidator::DisabledStackError, /The stack '#{stack.name}' is '#{StackStates::STACK_DISABLED}' and cannot be used for staging./)
         end
 
         it 'includes stack name in error message' do
           expect do
             StackStateValidator.validate_for_new_app!(stack)
           end.to raise_error(StackStateValidator::DisabledStackError, /#{stack.name}/)
         end
-
-        it 'includes stack description in error message' do
-          expect do
-            StackStateValidator.validate_for_new_app!(stack)
-          end.to raise_error(StackStateValidator::DisabledStackError, /#{stack.description}/)
-        end
       end
     end
 
@@ -111,15 +98,14 @@ module VCAP::CloudController
           result = StackStateValidator.validate_for_restaging!(stack)
           expect(result).to be_an(Array)
           expect(result.size).to eq(1)
-          expect(result.first).to include("Stack '#{stack.name}' is deprecated and will be removed in the future. #{stack.description}")
+          expect(result.first).to include("stack '#{stack.name}' is '#{StackStates::STACK_DEPRECATED}' and will be removed in the future")
         end
 
         it 'returns a warning message with stack name' do
           result = StackStateValidator.validate_for_restaging!(stack)
           warning = result.first
           expect(warning).to include(stack.name)
-          expect(warning).to include(stack.description)
-          expect(warning).to include('deprecated')
+          expect(warning).to include('DEPRECATED')
         end
 
         it 'does not raise an error' do
@@ -146,43 +132,36 @@ module VCAP::CloudController
         it 'returns a disabled error message' do
           expect do
             StackStateValidator.validate_for_restaging!(stack)
-          end.to raise_error(StackStateValidator::DisabledStackError, /Stack '#{stack.name}' is disabled and cannot be used for staging new applications./)
+          end.to raise_error(StackStateValidator::DisabledStackError, /The stack '#{stack.name}' is '#{StackStates::STACK_DISABLED}' and cannot be used for staging./)
         end
 
         it 'includes stack name in error message' do
           expect do
             StackStateValidator.validate_for_restaging!(stack)
           end.to raise_error(StackStateValidator::DisabledStackError, /#{stack.name}/)
         end
-
-        it 'includes stack description in error message' do
-          expect do
-            StackStateValidator.validate_for_restaging!(stack)
-          end.to raise_error(StackStateValidator::DisabledStackError, /#{stack.description}/)
-        end
       end
     end
 
     describe '.build_deprecation_warning' do
       let(:stack) { Stack.make(name: 'cflinuxfs3', description: 'End of life December 2025') }
 
       it 'returns formatted warning string' do
-        warning = StackStateValidator.build_deprecation_warning(stack)
+        warning = StackStateValidator.build_deprecation_warning(stack, StackStates::STACK_DEPRECATED)
         expect(warning).to be_a(String)
         expect(warning).to include('cflinuxfs3')
-        expect(warning).to include('deprecated')
-        expect(warning).to include('End of life December 2025')
+        expect(warning).to include('DEPRECATED')
       end
 
       it 'includes stack name when description is empty' do
         stack.description = ''
-        warning = StackStateValidator.build_deprecation_warning(stack)
+        warning = StackStateValidator.build_deprecation_warning(stack, StackStates::STACK_DEPRECATED)
         expect(warning).to include('cflinuxfs3')
       end
 
       it 'handles nil description' do
         stack.description = nil
-        warning = StackStateValidator.build_deprecation_warning(stack)
+        warning = StackStateValidator.build_deprecation_warning(stack, StackStates::STACK_DEPRECATED)
         expect(warning).to include('cflinuxfs3')
       end
     end