Stack management (#4712)

* Stack Management - DB Migration

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

* Stack Management - Model update and Unit Test

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

* Expose stack state through V3 API endpoints only
**V2 API endpoints must not expose or accept state parameter.**

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

* Add Stack States in API documentation

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

* Additional validation and tests for v3/stacks API

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

* Standalone Stack State Validator - State Logic class

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

* Stack state validation
and integration into app creation and build workflows.

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

* V2 API stack validation and tests

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

* Add deprecation warning in build create

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

* Update stck state validation error and warning messages

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

* Stack state validation when creating and updating apps via V2 and V3 APIs
Sets warnings in the response hash when there are warnings

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

* Removes stack_warnings from the models.
Actions own their warnings and Controllers set  warnings → headers

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

* Describe stack states in API doc

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

* Adds warning when changing default stack state
Polishing based on review comments

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

* Added warning for restaging app on restricted stack

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

---------

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

Author: rashedkvm

app/actions/app_create.rb

@@ -9,6 +9,8 @@ class AppCreate
 
     class InvalidApp < StandardError; end
 
+    attr_reader :warnings
+
     def initialize(user_audit_info)
       @user_audit_info = user_audit_info
       @logger = Steno.logger('cc.action.app_create')
@@ -24,6 +26,7 @@ def create(message, lifecycle)
         )
 
         lifecycle.create_lifecycle_data_model(app)
+        @warnings = validate_stack_state(app, lifecycle)
         validate_buildpacks_are_ready(app)
 
         MetadataUpdate.update(app, message)
@@ -47,6 +50,8 @@ def create(message, lifecycle)
     rescue Sequel::ValidationFailed => e
       v3_api_error!(:UniquenessError, e.message) if e.errors.on(%i[space_guid name])
 
+      raise InvalidApp.new(e.message)
+    rescue StackStateValidator::DisabledStackError, StackStateValidator::RestrictedStackError => e
       raise InvalidApp.new(e.message)
     end
 
@@ -74,5 +79,17 @@ def validate_buildpacks_are_ready(app)
         end
       end
     end
+
+    def validate_stack_state(app, lifecycle)
+      return [] if lifecycle.type == Lifecycles::DOCKER
+
+      stack_name = app.lifecycle_data.try(:stack)
+      return [] unless stack_name
+
+      stack = Stack.find(name: stack_name)
+      return [] unless stack
+
+      StackStateValidator.validate_for_new_app!(stack)
+    end
   end
 end

app/actions/app_update.rb

@@ -7,6 +7,8 @@ class AppUpdate
     class DropletNotFound < StandardError; end
     class InvalidApp < StandardError; end
 
+    attr_reader :warnings
+
     def initialize(user_audit_info, manifest_triggered: false, runners: nil)
       @user_audit_info = user_audit_info
       @logger = Steno.logger('cc.action.app_update')
@@ -53,8 +55,12 @@ def update(app, message, lifecycle)
         end
       end
 
+      @warnings = validate_stack_state(app, message, lifecycle)
+
       app
-    rescue Sequel::ValidationFailed => e
+    rescue Sequel::ValidationFailed,
+           StackStateValidator::DisabledStackError,
+           StackStateValidator::RestrictedStackError => e
       raise InvalidApp.new(e.message)
     end
 
@@ -81,5 +87,19 @@ def validate_not_changing_lifecycle_type!(app, lifecycle)
     def existing_environment_variables_for(app)
       app.environment_variables.nil? ? {} : app.environment_variables.symbolize_keys
     end
+
+    def validate_stack_state(app, message, lifecycle)
+      return [] if lifecycle.type == Lifecycles::DOCKER
+      return [] unless message.requested?(:lifecycle) && message.buildpack_data.requested?(:stack)
+
+      stack = Stack.find(name: message.buildpack_data.stack)
+      return [] unless stack
+
+      if app.builds_dataset.count.zero?
+        StackStateValidator.validate_for_new_app!(stack)
+      else
+        StackStateValidator.validate_for_restaging!(stack)
+      end
+    end
   end
 end

app/actions/build_create.rb

@@ -25,7 +25,7 @@ class LogRateLimitOrgQuotaExceeded < BuildError
     class StagingInProgress < BuildError
     end
 
-    attr_reader :staging_response
+    attr_reader :staging_response, :warnings
 
     def initialize(user_audit_info: UserAuditInfo.from_context(SecurityContext),
                    memory_limit_calculator: QuotaValidatingStagingMemoryCalculator.new,
@@ -41,6 +41,7 @@ def initialize(user_audit_info: UserAuditInfo.from_context(SecurityContext),
 
     def create_and_stage(package:, lifecycle:, metadata: nil, start_after_staging: false)
       logger.info("creating build for package #{package.guid}")
+      @warnings = validate_stack_state!(lifecycle, package.app)
       staging_in_progress! if package.app.staging_in_progress?
       raise InvalidPackage.new('Cannot stage package whose state is not ready.') if package.state != PackageModel::READY_STATE
 
@@ -179,5 +180,29 @@ def stagers
     def staging_in_progress!
       raise StagingInProgress
     end
+
+    def validate_stack_state!(lifecycle, app)
+      return [] if lifecycle.type == Lifecycles::DOCKER
+
+      stack = Stack.find(name: lifecycle.staging_stack)
+      return [] unless stack
+
+      warnings = if first_build_for_app?(app)
+                   StackStateValidator.validate_for_new_app!(stack)
+                 else
+                   StackStateValidator.validate_for_restaging!(stack)
+                 end
+      warnings.each { |warning| logger.warn(warning) }
+      warnings
+    rescue StackStateValidator::DisabledStackError, StackStateValidator::RestrictedStackError => e
+      raise CloudController::Errors::ApiError.new_from_details(
+        'StackValidationFailed',
+        e.message
+      )
+    end
+
+    def first_build_for_app?(app)
+      app.builds_dataset.count.zero?
+    end
   end
 end

app/actions/stack_create.rb

@@ -12,7 +12,8 @@ def initialize(user_audit_info)
     def create(message)
       stack = VCAP::CloudController::Stack.create(
         name: message.name,
-        description: message.description
+        description: message.description,
+        state: message.state
       )
 
       MetadataUpdate.update(stack, message)

app/actions/stack_update.rb

@@ -12,10 +12,11 @@ def initialize(user_audit_info)
 
     def update(stack, message)
       stack.db.transaction do
+        stack.update(state: message.state) if message.requested?(:state)
         MetadataUpdate.update(stack, message)
         Repositories::StackEventRepository.new.record_stack_update(stack, @user_audit_info, message.audit_hash)
       end
-      @logger.info("Finished updating metadata on stack #{stack.guid}")
+      @logger.info("Finished updating stack #{stack.guid}")
 
       stack
     rescue Sequel::ValidationFailed => e

app/actions/v2/app_create.rb

@@ -1,6 +1,8 @@
 module VCAP::CloudController
   module V2
     class AppCreate
+      attr_reader :warnings
+
       def initialize(access_validator:)
         @access_validator = access_validator
       end
@@ -46,6 +48,8 @@ def create(request_attrs)
           @access_validator.validate_access(:create, process, request_attrs)
         end
 
+        @warnings = validate_stack_state(request_attrs)
+
         process
       end
 
@@ -106,6 +110,18 @@ def validate_package_exists!(process, request_attrs)
 
         raise CloudController::Errors::ApiError.new_from_details('AppPackageInvalid', 'bits have not been uploaded')
       end
+
+      def validate_stack_state(request_attrs)
+        return [] if request_attrs.key?('docker_image')
+
+        stack_name = get_stack_name(request_attrs['stack_guid'])
+        stack = Stack.find(name: stack_name)
+        return [] unless stack
+
+        StackStateValidator.validate_for_new_app!(stack)
+      rescue StackStateValidator::DisabledStackError, StackStateValidator::RestrictedStackError => e
+        raise CloudController::Errors::ApiError.new_from_details('StackValidationFailed', e.message)
+      end
     end
   end
 end

app/actions/v2/app_stage.rb

@@ -1,8 +1,11 @@
 module VCAP::CloudController
   module V2
     class AppStage
+      attr_reader :warnings
+
       def initialize(stagers:)
         @stagers = stagers
+        @warnings = []
       end
 
       def stage(process)
@@ -25,6 +28,9 @@ def stage(process)
           lifecycle: lifecycle,
           start_after_staging: true
         )
+
+        @warnings = build_creator.warnings || []
+
         TelemetryLogger.v2_emit(
           'create-build',
           {

app/actions/v2/app_update.rb

@@ -4,9 +4,12 @@
 module VCAP::CloudController
   module V2
     class AppUpdate
+      attr_reader :warnings
+
       def initialize(access_validator:, stagers:)
         @access_validator = access_validator
         @stagers          = stagers
+        @warnings         = []
       end
 
       def update(app, process, request_attrs)
@@ -36,6 +39,7 @@ def update(app, process, request_attrs)
           prepare_to_stage(app) if staging_necessary?(process, request_attrs)
         end
 
+        validate_stack_state(app, request_attrs)
         stage(process) if staging_necessary?(process, request_attrs)
       end
 
@@ -116,7 +120,9 @@ def prepare_to_stage(app)
       end
 
       def stage(process)
-        V2::AppStage.new(stagers: @stagers).stage(process)
+        app_stage = V2::AppStage.new(stagers: @stagers)
+        app_stage.stage(process)
+        @warnings = app_stage.warnings
       end
 
       def start_or_stop(app, request_attrs)
@@ -179,6 +185,23 @@ def staging_necessary?(process, request_attrs)
       def v2_api_staging_disabled?
         !!VCAP::CloudController::Config.config.get(:temporary_disable_v2_staging)
       end
+
+      def validate_stack_state(app, request_attrs)
+        return unless request_attrs.key?('stack_guid')
+        return if request_attrs.key?('docker_image')
+
+        stack = Stack.find(guid: request_attrs['stack_guid'])
+        return unless stack
+
+        stack_warnings = if app.builds_dataset.count.zero?
+                           StackStateValidator.validate_for_new_app!(stack)
+                         else
+                           StackStateValidator.validate_for_restaging!(stack)
+                         end
+        @warnings.concat(stack_warnings)
+      rescue StackStateValidator::DisabledStackError, StackStateValidator::RestrictedStackError => e
+        raise CloudController::Errors::ApiError.new_from_details('StackValidationFailed', e.message)
+      end
     end
   end
 end

app/controllers/runtime/apps_controller.rb

@@ -294,6 +294,7 @@ def update(guid)
 
       updater = V2::AppUpdate.new(access_validator: self, stagers: @stagers)
       updater.update(app, process, request_attrs)
+      updater.warnings.each { |warning| add_warning(warning) }
 
       after_update(process)
 
@@ -357,6 +358,8 @@ def create
       creator = V2::AppCreate.new(access_validator: self)
       process = creator.create(request_attrs)
 
+      creator.warnings&.each { |warning| add_warning(warning) }
+
       @app_event_repository.record_app_create(
         process,
         process.space,

app/controllers/runtime/restages_controller.rb

@@ -35,7 +35,10 @@ def restage(guid)
         process.app.update(droplet_guid: nil)
         AppStart.start_without_event(process.app, create_revision: false)
       end
-      V2::AppStage.new(stagers: @stagers).stage(process)
+
+      app_stage = V2::AppStage.new(stagers: @stagers)
+      app_stage.stage(process)
+      app_stage.warnings.each { |warning| add_warning(warning) }
 
       @app_event_repository.record_app_restage(process, UserAuditInfo.from_context(SecurityContext))