Expose stack state through V3 API endpoints only

**V2 API endpoints must not expose or accept state parameter.**

Signed-off-by: Rashed Kamal <[email protected]>

Author: rashedkvm

app/actions/stack_create.rb

@@ -6,7 +6,8 @@ class Error < ::StandardError
     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

@@ -9,6 +9,7 @@ def initialize
 
     def update(stack, message)
       stack.db.transaction do
+        stack.update(state: message.state) if message.requested?(:state)
         MetadataUpdate.update(stack, message)
       end
       @logger.info("Finished updating metadata on stack #{stack.guid}")

app/messages/stack_create_message.rb

@@ -1,10 +1,18 @@
 require 'messages/metadata_base_message'
+require 'models/helpers/stack_states'
 
 module VCAP::CloudController
   class StackCreateMessage < MetadataBaseMessage
-    register_allowed_keys %i[name description]
+    register_allowed_keys %i[name description state]
 
     validates :name, presence: true, length: { maximum: 250 }
     validates :description, length: { maximum: 250 }
+    validates :state, inclusion: { in: StackStates::VALID_STATES, message: "must be one of #{StackStates::VALID_STATES.join(', ')}" }, allow_nil: true
+
+    def state
+      return @state if defined?(@state)
+
+      @state = requested?(:state) ? super : StackStates::DEFAULT_STATE
+    end
   end
 end

app/messages/stack_update_message.rb

@@ -1,9 +1,11 @@
 require 'messages/metadata_base_message'
+require 'models/helpers/stack_states'
 
 module VCAP::CloudController
   class StackUpdateMessage < MetadataBaseMessage
-    register_allowed_keys []
+    register_allowed_keys [:state]
 
     validates_with NoAdditionalKeysValidator
+    validates :state, inclusion: { in: StackStates::VALID_STATES, message: "must be one of #{StackStates::VALID_STATES.join(', ')}" }, allow_nil: true
   end
 end

app/models/helpers/stack_states.rb

@@ -0,0 +1,17 @@
+module VCAP::CloudController
+  class StackStates
+    STACK_ACTIVE = 'ACTIVE'.freeze
+    STACK_RESTRICTED = 'RESTRICTED'.freeze
+    STACK_DEPRECATED = 'DEPRECATED'.freeze
+    STACK_DISABLED = 'DISABLED'.freeze
+
+    DEFAULT_STATE = STACK_ACTIVE
+
+    VALID_STATES = [
+      STACK_ACTIVE,
+      STACK_RESTRICTED,
+      STACK_DEPRECATED,
+      STACK_DISABLED
+    ].freeze
+  end
+end

app/models/runtime/stack.rb

@@ -1,5 +1,6 @@
 require 'models/helpers/process_types'
 require 'models/helpers/stack_config_file'
+require 'models/helpers/stack_states'
 
 module VCAP::CloudController
   class Stack < Sequel::Model
@@ -10,18 +11,6 @@ class MissingDefaultStackError < StandardError
     class AppsStillPresentError < StandardError
     end
 
-    STACK_ACTIVE = 'ACTIVE'.freeze
-    STACK_RESTRICTED = 'RESTRICTED'.freeze
-    STACK_DEPRECATED = 'DEPRECATED'.freeze
-    STACK_DISABLED = 'DISABLED'.freeze
-
-    VALID_STATES = [
-      STACK_ACTIVE,
-      STACK_RESTRICTED,
-      STACK_DEPRECATED,
-      STACK_DISABLED
-    ].freeze
-
     # NOTE: that "apps" here returns processes for v2 meta-reasons
     many_to_many :apps,
                  class: 'VCAP::CloudController::ProcessModel',
@@ -55,7 +44,7 @@ def around_save
     def validate
       validates_presence :name
       validates_unique :name
-      validates_includes VALID_STATES, :state, allow_nil: true
+      validates_includes StackStates::VALID_STATES, :state, allow_nil: true
     end
 
     def before_destroy
@@ -111,20 +100,21 @@ def self.populate_from_hash(hash)
         create(hash.slice('name', 'description', 'build_rootfs_image', 'run_rootfs_image'))
       end
     end
+
     def active?
-      state == STACK_ACTIVE
+      state == StackStates::STACK_ACTIVE
     end
 
     def deprecated?
-      state == STACK_DEPRECATED
+      state == StackStates::STACK_DEPRECATED
     end
 
     def restricted?
-      state == STACK_RESTRICTED
+      state == StackStates::STACK_RESTRICTED
     end
 
     def disabled?
-      state == STACK_DISABLED
+      state == StackStates::STACK_DISABLED
     end
 
     def can_stage_new_app?

app/presenters/v3/stack_presenter.rb

@@ -12,6 +12,7 @@ def to_hash
         updated_at: stack.updated_at,
         name: stack.name,
         description: stack.description,
+        state: stack.state,
         run_rootfs_image: stack.run_rootfs_image,
         build_rootfs_image: stack.build_rootfs_image,
         default: stack.default?,

spec/migrations/20251117123719_add_state_to_stacks_spec.rb

@@ -39,7 +39,7 @@
         run_migration
         %w[ACTIVE DEPRECATED RESTRICTED DISABLED].each do |state|
           expect do
-            db[:stacks].insert(guid:SecureRandom.uuid, name: "stack-#{state.downcase}", description: "A #{state} stack", state: state)
+            db[:stacks].insert(guid: SecureRandom.uuid, name: "stack-#{state.downcase}", description: "A #{state} stack", state: state)
           end.not_to raise_error
           expect(db[:stacks].first(name: "stack-#{state.downcase}")[:state]).to eq(state)
         end

spec/request/stacks_spec.rb

@@ -26,6 +26,7 @@
               'run_rootfs_image' => stack1.run_rootfs_image,
               'build_rootfs_image' => stack1.build_rootfs_image,
               'guid' => stack1.guid,
+              'state' => 'ACTIVE',
               'default' => false,
               'metadata' => { 'labels' => {}, 'annotations' => {} },
               'created_at' => iso8601,
@@ -42,6 +43,7 @@
               'run_rootfs_image' => stack2.run_rootfs_image,
               'build_rootfs_image' => stack2.build_rootfs_image,
               'guid' => stack2.guid,
+              'state' => 'ACTIVE',
               'default' => true,
               'metadata' => { 'labels' => {}, 'annotations' => {} },
               'created_at' => iso8601,
@@ -122,6 +124,7 @@
                   'run_rootfs_image' => stack1.run_rootfs_image,
                   'build_rootfs_image' => stack1.build_rootfs_image,
                   'guid' => stack1.guid,
+                  'state' => 'ACTIVE',
                   'default' => false,
                   'metadata' => { 'labels' => {}, 'annotations' => {} },
                   'created_at' => iso8601,
@@ -138,6 +141,7 @@
                   'run_rootfs_image' => stack2.run_rootfs_image,
                   'build_rootfs_image' => stack2.build_rootfs_image,
                   'guid' => stack2.guid,
+                  'state' => 'ACTIVE',
                   'default' => true,
                   'metadata' => { 'labels' => {}, 'annotations' => {} },
                   'created_at' => iso8601,
@@ -177,6 +181,7 @@
                   'run_rootfs_image' => stack1.run_rootfs_image,
                   'build_rootfs_image' => stack1.build_rootfs_image,
                   'guid' => stack1.guid,
+                  'state' => 'ACTIVE',
                   'default' => false,
                   'metadata' => { 'labels' => {}, 'annotations' => {} },
                   'created_at' => iso8601,
@@ -193,6 +198,7 @@
                   'run_rootfs_image' => stack3.run_rootfs_image,
                   'build_rootfs_image' => stack3.build_rootfs_image,
                   'guid' => stack3.guid,
+                  'state' => 'ACTIVE',
                   'default' => false,
                   'metadata' => { 'labels' => {}, 'annotations' => {} },
                   'created_at' => iso8601,
@@ -232,6 +238,7 @@
                   'run_rootfs_image' => stack2.run_rootfs_image,
                   'build_rootfs_image' => stack2.build_rootfs_image,
                   'guid' => stack2.guid,
+                  'state' => 'ACTIVE',
                   'default' => true,
                   'metadata' => { 'labels' => {}, 'annotations' => {} },
                   'created_at' => iso8601,
@@ -287,6 +294,7 @@
                     'run_rootfs_image' => stack1.run_rootfs_image,
                     'build_rootfs_image' => stack1.build_rootfs_image,
                     'guid' => stack1.guid,
+                    'state' => 'ACTIVE',
                     'default' => false,
                     'metadata' => {
                       'labels' => {
@@ -323,6 +331,7 @@
         'run_rootfs_image' => stack.run_rootfs_image,
         'build_rootfs_image' => stack.build_rootfs_image,
         'guid' => stack.guid,
+        'state' => 'ACTIVE',
         'default' => false,
         'metadata' => { 'labels' => {}, 'annotations' => {} },
         'created_at' => iso8601,
@@ -670,6 +679,7 @@
             }
           },
           'guid' => created_stack.guid,
+          'state' => 'ACTIVE',
           'created_at' => iso8601,
           'updated_at' => iso8601,
           'links' => {
@@ -734,6 +744,7 @@
             }
           },
           'guid' => stack.guid,
+          'state' => 'ACTIVE',
           'created_at' => iso8601,
           'updated_at' => iso8601,
           'links' => {