Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight (#4402)

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Fix error message to be more descriptive

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Fix Rubocop errors

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Only update the error message for rolling deployments based on code review

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Revert changes that affect all actions since we only want to update rolling reployments

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Fix rubocop errors

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Update error message for space_app_instance_limit_exceeded

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Fix Rubocop errors

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Cleanup for Rubocop errors

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Update error message for org errors during rolling deployment

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Fix merge issues

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Fix Rubocop error

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Update from code review comments and cleanup

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Revert unintended change

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Fix rubocop errors

* Improve error messaging for creating a Deployment that will violate quotas with high max-in-flight

Rename method and remove unnecessary raise

Author: nookala

app/actions/deployment_create.rb

@@ -83,9 +83,27 @@ def create(app:, user_audit_info:, message:)
 
         deployment
       rescue RevisionResolver::NoUpdateRollback, Sequel::ValidationFailed, AppStart::InvalidApp => e
-        error = DeploymentCreate::Error.new(e.message)
+        raise enhanced_deployment_create_error(e, app)
+      end
+
+      def enhanced_deployment_create_error(e, app)
+        space_quota_errors = %w[space_quota_exceeded space_app_instance_limit_exceeded]
+        org_quota_errors = %w[quota_exceeded app_instance_limit_exceeded]
+        space_error_msg = " for space #{app.space.name}. This space's quota may not be large enough to support rolling deployments or your configured max-in-flight."
+        org_error_msg_1 = " for organization #{app.organization.name}. "
+        org_error_msg_2 = "This organization's quota may not be large enough to support rolling deployments or your configured max-in-flight."
+        org_error_msg = org_error_msg_1 + org_error_msg_2
+        error_message = e.message
+
+        if space_quota_errors.any? { |substring| e.message.include?(substring) }
+          error_message += space_error_msg
+        elsif org_quota_errors.any? { |substring| e.message.include?(substring) }
+          error_message += org_error_msg
+        end
+
+        error = DeploymentCreate::Error.new(error_message)
         error.set_backtrace(e.backtrace)
-        raise error
+        error
       end
 
       def create_deployment_process(app, deployment_guid, revision, process_instances)

spec/unit/actions/deployment_create_spec.rb

@@ -605,6 +605,18 @@ module VCAP::CloudController
               end
             end
 
+            context 'when the app fails to start due to space errors' do
+              before do
+                allow(VCAP::CloudController::AppStart).to receive(:start).and_raise(VCAP::CloudController::AppStart::InvalidApp.new('memory space_quota_exceeded'))
+              end
+
+              it 'raises a DeploymentCreate::Error' do
+                error_msg_1 = "memory space_quota_exceeded for space #{app.space.name}. "
+                error_msg_2 = "This space's quota may not be large enough to support rolling deployments or your configured max-in-flight."
+                expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, error_msg_1 + error_msg_2)
+              end
+            end
+
             context 'uses the web_instances from the message' do
               # stopped apps come up immediately and don't go through the deployment updater
               let(:web_instances) { 12 }
@@ -637,7 +649,9 @@ module VCAP::CloudController
                   let(:web_instances) { 11 }
 
                   it 'throws an error' do
-                    expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, 'memory quota_exceeded')
+                    error_msg_1 = "memory quota_exceeded for organization #{app.organization.name}. "
+                    error_msg_2 = "This organization's quota may not be large enough to support rolling deployments or your configured max-in-flight."
+                    expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, error_msg_1 + error_msg_2)
                   end
                 end
 
@@ -683,7 +697,9 @@ module VCAP::CloudController
                   let(:memory_in_mb) { 4000 }
 
                   it 'throws an error' do
-                    expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, 'memory quota_exceeded')
+                    error_msg_1 = "memory quota_exceeded for organization #{app.organization.name}. "
+                    error_msg_2 = "This organization's quota may not be large enough to support rolling deployments or your configured max-in-flight."
+                    expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, error_msg_1 + error_msg_2)
                   end
                 end
 
@@ -717,16 +733,6 @@ module VCAP::CloudController
                 expect(deployment.canary_steps).to eq([{ 'instance_weight' => 40 }, { 'instance_weight' => 80 }])
               end
             end
-
-            context 'when the app fails to start' do
-              before do
-                allow(VCAP::CloudController::AppStart).to receive(:start).and_raise(VCAP::CloudController::AppStart::InvalidApp.new('memory quota_exceeded'))
-              end
-
-              it 'raises a DeploymentCreate::Error' do
-                expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, 'memory quota_exceeded')
-              end
-            end
           end
         end
 
@@ -880,7 +886,9 @@ module VCAP::CloudController
                 let(:web_instances) { 11 }
 
                 it 'throws an error' do
-                  expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, 'memory quota_exceeded')
+                  error_msg_1 = "memory quota_exceeded for organization #{app.organization.name}. "
+                  error_msg_2 = "This organization's quota may not be large enough to support rolling deployments or your configured max-in-flight."
+                  expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, error_msg_1 + error_msg_2)
                 end
               end
 
@@ -935,7 +943,9 @@ module VCAP::CloudController
                 let(:memory_in_mb) { 4000 }
 
                 it 'throws an error' do
-                  expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, 'memory quota_exceeded')
+                  error_msg_1 = "memory quota_exceeded for organization #{app.organization.name}. "
+                  error_msg_2 = "This organization's quota may not be large enough to support rolling deployments or your configured max-in-flight."
+                  expect { DeploymentCreate.create(app:, message:, user_audit_info:) }.to raise_error(DeploymentCreate::Error, error_msg_1 + error_msg_2)
                 end
               end