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 <[email protected]>

Author: rashedkvm

app/actions/app_create.rb

@@ -16,6 +16,7 @@ def initialize(user_audit_info)
 
     def create(message, lifecycle)
       app = nil
+      warnings = []
       AppModel.db.transaction do
         app = AppModel.create(
           name: message.name,
@@ -24,6 +25,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)
@@ -43,10 +45,14 @@ def create(message, lifecycle)
         )
       end
 
+      app.instance_variable_set(:@stack_warnings, warnings)
+
       app
     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 +80,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

@@ -53,8 +53,13 @@ def update(app, message, lifecycle)
         end
       end
 
+      warnings = validate_stack_state(app, message, lifecycle)
+      app.instance_variable_set(:@stack_warnings, warnings)
+
       app
-    rescue Sequel::ValidationFailed => e
+    rescue Sequel::ValidationFailed,
+           StackStateValidator::DisabledStackError,
+           StackStateValidator::RestrictedStackError => e
       raise InvalidApp.new(e.message)
     end
 
@@ -81,5 +86,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/v2/app_create.rb

@@ -46,6 +46,9 @@ def create(request_attrs)
           @access_validator.validate_access(:create, process, request_attrs)
         end
 
+        warnings = validate_stack_state(request_attrs)
+        process.instance_variable_set(:@stack_warnings, warnings)
+
         process
       end
 
@@ -106,6 +109,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_update.rb

@@ -39,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
 
@@ -184,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

@@ -358,6 +358,8 @@ def create
       creator = V2::AppCreate.new(access_validator: self)
       process = creator.create(request_attrs)
 
+      process.stack_warnings&.each { |warning| add_warning(warning) }
+
       @app_event_repository.record_app_create(
         process,
         process.space,

app/controllers/v3/apps_controller.rb

@@ -107,6 +107,8 @@ def create
       }
     )
 
+    add_warning_headers(app.stack_warnings) if app.stack_warnings&.any?
+
     render status: :created, json: Presenters::V3::AppPresenter.new(app)
   rescue AppCreate::InvalidApp => e
     unprocessable!(e.message)
@@ -134,6 +136,8 @@ def update
       }
     )
 
+    add_warning_headers(app.stack_warnings) if app.stack_warnings&.any?
+
     render status: :ok, json: Presenters::V3::AppPresenter.new(app)
   rescue AppUpdate::DropletNotFound
     droplet_not_found!

app/models/runtime/app_model.rb

@@ -11,6 +11,8 @@ class AppModel < Sequel::Model(:apps)
     DEFAULT_CONTAINER_USER = 'vcap'.freeze
     DEFAULT_DOCKER_CONTAINER_USER = 'root'.freeze
 
+    attr_reader :stack_warnings
+
     many_to_many :routes, join_table: :route_mappings, left_key: :app_guid, left_primary_key: :guid, right_primary_key: :guid, right_key: :route_guid
     one_to_many :route_mappings, class: 'VCAP::CloudController::RouteMappingModel', key: :app_guid, primary_key: :guid
     one_to_many :service_bindings, key: :app_guid, primary_key: :guid

app/models/runtime/process_model.rb

@@ -22,6 +22,8 @@ class ProcessModel < Sequel::Model(:processes) # rubocop:disable Metrics/ClassLe
 
     extend IntegerArraySerializer
 
+    attr_reader :stack_warnings
+
     def after_initialize
       self.instances        ||= db_schema[:instances][:default].to_i
       self.memory           ||= Config.config.get(:default_app_memory)

app/presenters/v3/app_presenter.rb

@@ -45,6 +45,8 @@ def to_hash
             links: build_links
           }
 
+          hash[:warnings] = app_warnings if app_warnings
+
           @decorators.reduce(hash) { |memo, d| d.decorate(memo, [app]) }
         end
 
@@ -74,6 +76,12 @@ def build_links
 
           links.delete_if { |_, v| v.nil? }
         end
+
+        def app_warnings
+          return nil unless app.stack_warnings&.any?
+
+          app.stack_warnings.map { |warning| { detail: warning } }
+        end
       end
     end
   end

app/presenters/v3/build_presenter.rb

@@ -15,7 +15,7 @@ def associated_resources
         end
 
         def to_hash
-          {
+          hash = {
             guid: build.guid,
             created_at: build.created_at,
             updated_at: build.updated_at,
@@ -30,7 +30,6 @@ def to_hash
             },
             package: { guid: build.package_guid },
             droplet: droplet,
-            warnings: build_warnings,
             created_by: {
               guid: build.created_by_user_guid,
               name: build.created_by_user_name,
@@ -43,6 +42,10 @@ def to_hash
             },
             links: build_links
           }
+
+          hash[:warnings] = build_warnings if build_warnings
+
+          hash
         end
 
         private