[WIP] Add Attribute Constraints (validation) support for GenericObjectDefinition by putmanoj · Pull Request #23654 · ManageIQ/manageiq

putmanoj · 2025-11-17T16:43:05Z

Summary

This PR implements comprehensive attribute constraint validation for GenericObjectDefinition, enabling developers to define validation rules for property attributes. The implementation supports all existing attribute types (boolean, integer, float, string, datetime, time) plus newly added Hash and Array types.

Changes

Core Features

Constraint Types - 12 validation constraint types:

required - Marks attribute as mandatory
min/max - Numeric range validation (integer, float, datetime, time)
min_length/max_length - String length validation
enum - Enumerated value validation (integer, string)
format - Regex pattern validation (string)
default - Default value assignment (all types)
min_items/max_items - Array size validation
unique_items - Array uniqueness validation
required_keys/allowed_keys - Hash key validation

Hash and Array Types - New attribute types with JSON storage:

Stored as JSONB in PostgreSQL
Type-specific constraints
Full validation support

Default Values - Automatic default value application:

Applied in before_validation callback
Type-safe casting using TYPE_MAP
Works with all attribute types

Import/Export - Full YAML serialization support:

Constraints preserved in import/export
Comprehensive test coverage
Example YAML file included

Usage Example

# Define a GenericObjectDefinition with constraints
definition = GenericObjectDefinition.create!(
  :name => 'ProductDefinition',
  :properties => {
    :attributes => {
      :product_name => :string,
      :price => :float,
      :status => :string,
      :settings => :hash,
      :tags => :array
    },
    :attribute_constraints => {
      :product_name => {
        :required => true,
        :min_length => 3,
        :max_length => 100
      },
      :price => {
        :required => true,
        :min => 0.0,
        :max => 999999.99
      },
      :status => {
        :enum => ['active', 'inactive', 'pending'],
        :default => 'pending'
      },
      :settings => {
        :required_keys => ['theme'],
        :allowed_keys => ['theme', 'language', 'timezone'],
        :default => {'theme' => 'light'}
      },
      :tags => {
        :min_items => 1,
        :max_items => 10,
        :unique_items => true
      }
    }
  }
)

# Create a GenericObject (defaults applied automatically)
product = GenericObject.create!(
  :generic_object_definition => definition,
  :name => 'Product1',
  :product_name => 'Widget',
  :price => 99.99,
  :tags => ['electronics', 'featured']
  # status and settings get default values
)

# Validation is enforced
invalid = GenericObject.new(
  :generic_object_definition => definition,
  :name => 'Product2',
  :product_name => 'AB',  # Fails min_length validation
  :price => -10.0         # Fails min validation
)
invalid.valid? # => false
invalid.errors.full_messages
# => ["Product name is too short (minimum is 3 characters)",
#     "Price must be greater than or equal to 0.0"]

API Changes

GenericObjectDefinition

New Methods:

add_property_attribute_constraint(name, constraint_type, value) # Add a constraint
delete_property_attribute_constraint(name, constraint_type) # Remove a constraint
property_attribute_constraints(name) # Get constraints for an attribute

Enhanced Methods:

add_property_attribute(name, type, constraints: {}) # Now accepts constraints parameter

Example:

definition = GenericObjectDefinition.create!(:name => 'MyDefinition')

# Add attribute with constraints
definition.add_property_attribute(
  :product_name,
  :string,
  :constraints => {
    :required => true,
    :min_length => 3,
    :max_length => 100
  }
)

# Add individual constraint
definition.add_property_attribute_constraint(:product_name, :format, /\A[A-Z]/)

# Get constraints
definition.property_attribute_constraints(:product_name)
# => {:required=>true, :min_length=>3, :max_length=>100, :format=>/\A[A-Z]/}

# Delete constraint
definition.delete_property_attribute_constraint(:product_name, :format)

GenericObject

New Validations:

Validates all defined constraints on save
Applies default values before validation
Provides clear error messages for violations

Constraint Reference

Constraint	Applicable Types	Description	Example
required	All	Attribute must be present	:required: true
default	All	Default value if not provided	:default: "pending"
min	integer, float, datetime, time	Minimum value	:min: 0
max	integer, float, datetime, time	Maximum value	:max: 100
min_length	string	Minimum string length	:min_length: 3
max_length	string	Maximum string length	:max_length: 100
enum	integer, string	Allowed values	:enum: [1, 2, 3]
format	string	Regex pattern	:format: /\A[A-Z]+\z/
min_items	array	Minimum array size	:min_items: 1
max_items	array	Maximum array size	:max_items: 10
unique_items	array	Array values must be unique	:unique_items: true
required_keys	hash	Keys that must be present	:required_keys: [theme]
allowed_keys	hash	Keys that are permitted	:allowed_keys: [theme, lang]

Backward Compatibility

✅ Fully backward compatible - Existing GenericObjectDefinitions without constraints continue to work unchanged. Constraints are optional and only enforced when defined.

Benefits

Data Integrity - Ensures GenericObject data meets requirements
Type Safety - Prevents invalid data types and values
Developer Experience - Clear validation errors guide usage
Flexibility - Supports wide range of validation scenarios
Extensibility - Easy to add new constraint types
Import/Export - Full YAML support for constraint definitions

Checklist

Issues : #23625

…traints

…te_constraints

agrare · 2025-11-17T17:40:40Z

app/models/generic_object_definition.rb

+    props = properties.symbolize_keys
+
+    properties[:attribute_constraints] = props[:attribute_constraints].each_with_object({}) do |(name, constraints), hash|
+      hash[name.to_s] = constraints
+    end


Is this just properties.deep_symbolize_keys!?

well, stringify_keys!, but yes.

agrare · 2025-11-17T17:42:31Z

app/models/generic_object_definition.rb

  end

+  def validate_property_attribute_constraints
+    properties[:attribute_constraints].each do |attr_name, constraints|


Is it possible for properties[:attribute_constraints] to be nil here for existing generic_object_definitions unless we're also doing a data migration?

agrare · 2025-11-17T17:47:07Z

app/models/generic_object_definition.rb

+      errors.add(:properties, "constraint 'enum' contains duplicate values for attribute [#{attr_name}]")
+    end
+
+    # Existing type validation continues...


Probably not a necessary comment

agrare · 2025-11-17T17:48:31Z

spec/lib/task_helpers/exports/generic_object_definitions_spec.rb

+    before do
+      @god = FactoryBot.create(


Better to use let(:generic_object_definition) (or let!(:...) if you need it to be eagerly defined) rather than introducing an instance variable in the spec context.

agrare · 2025-11-17T17:51:45Z

spec/lib/task_helpers/imports/generic_object_definitions_spec.rb

+        :attribute_constraints => {},
        :associations => {'cloud_tenant' => 'CloudTenant'},
        :methods      => ['kick', 'laugh_at', 'punch', 'parseltongue']


Going to want to align the => here (assume rubocop will warn about it if it hasn't already)

agrare · 2025-11-17T17:55:53Z

This looks great @putmanoj safe to say you can take it out of Draft and let specs run I think unless you are waiting on something else.

agrare · 2025-11-17T17:56:49Z

The mixture of strings and symbols looks weird and pretty fragile, but it looks like that is the way the existing code is as well and is required to be that way

Fryguy · 2025-11-17T22:46:35Z

app/models/generic_object.rb

  end
+
+  def apply_default_values
+    return unless generic_object_definition


I'm not sure how this line can happen, because you have to create a generic object from a generic object definition. I think we can remove it.

Fryguy · 2025-11-17T22:49:43Z

app/models/generic_object.rb

+      if properties[attr_name].nil? && attr_constraints.key?(:default)
+        default_value = attr_constraints[:default]
+        # Type cast the default value
+        if property_attribute_defined?(attr_name)
+          properties[attr_name] = type_cast(attr_name, default_value)
+        end
+      end


I wonder if there's a way to dry this up relative to _property_setter.

Fryguy · 2025-11-17T22:53:55Z

app/models/generic_object_definition.rb

+    :min_length    => [:string],
+    :max_length    => [:string],
+    :enum          => [:integer, :string],
+    :format        => [:string],


format is a weird name for a regex type. can we call it regex?

Actually, in context it looks fine, I think. WDYT, @agrare ?

Fryguy · 2025-11-17T22:55:47Z

app/models/generic_object_definition.rb

+  end
+
+  def validate_enum_constraint(attr_name, attr_type, value)
+    unless value.is_a?(Array) && value.any?


Minor but this is hard to read. Prefer:

Suggested change

unless value.is_a?(Array) && value.any?

if value.is_a?(Array) && value.empty?

Fryguy · 2025-11-17T22:56:57Z

spec/lib/task_helpers/imports/data/generic_object_definitions/god_with_attr_constraints.yaml

+      - apply_discount
+      - validate_stock
+
+# Made with Bob


You can remove this :)

Fryguy · 2025-11-17T22:58:14Z

spec/lib/task_helpers/exports/generic_object_definitions_spec.rb

      expect(god2_yaml.first["GenericObjectDefinition"]["description"]).to eq(nil)
      expect(god2_yaml.first["GenericObjectDefinition"]["properties"]).to eq(
-        :attributes => {}, :associations => {}, :methods => []
+        :attributes => {}, :attribute_constraints=>{}, :associations => {}, :methods => []


Style nit

Suggested change

:attributes => {}, :attribute_constraints=>{}, :associations => {}, :methods => []

:attributes => {}, :attribute_constraints => {}, :associations => {}, :methods => []

Fryguy · 2025-11-17T23:00:17Z

spec/models/generic_object_definition_spec.rb

+            :attribute_constraints => {:name => "invalid"}
+          }
+        )
+        expect { testdef.save! }.to raise_error(ActiveRecord::RecordInvalid, /constraints for attribute .* must be a hash/)


I think this error message test could be more explicit...I would expect something like

Suggested change

expect { testdef.save! }.to raise_error(ActiveRecord::RecordInvalid, /constraints for attribute .* must be a hash/)

expect { testdef.save! }.to raise_error(ActiveRecord::RecordInvalid, /constraints for attribute "name" must be a hash/)

Fryguy · 2025-11-17T23:01:21Z

spec/models/generic_object_definition_spec.rb

+            :attribute_constraints => {:flag => {:min_length => 5}}
+          }
+        )
+        expect { testdef.save! }.to raise_error(ActiveRecord::RecordInvalid, /constraint .* is not applicable to attribute type/)


Same here with the error message.

Fryguy · 2025-11-17T23:01:43Z

spec/models/generic_object_definition_spec.rb

+            :attribute_constraints => {:name => {:invalid_constraint => true}}
+          }
+        )
+        expect { testdef.save! }.to raise_error(ActiveRecord::RecordInvalid, /invalid constraint type/)


This should probably list for which property the constraint is invalid.

miq-bot · 2026-01-03T11:58:56Z

Checked commits putmanoj/manageiq@8fd6167~...0439acd with ruby 3.1.7, rubocop 1.56.3, haml-lint 0.64.0, and yamllint
6 files checked, 77 offenses detected

app/models/generic_object.rb

app/models/generic_object_definition.rb

spec/lib/task_helpers/exports/generic_object_definitions_spec.rb

❗ - Line 31, Col 50 - Layout/SpaceAroundOperators - Surrounding space missing for operator =>.
❗ - Line 63, Col 49 - Style/NumericLiterals - Use underscores(_) as thousands separator and separate every 3 digits with them.
❗ - Line 75, Col 1 - Layout/TrailingWhitespace - Trailing whitespace detected.
❗ - Line 80, Col 1 - Layout/TrailingWhitespace - Trailing whitespace detected.
❗ - Line 87, Col 77 - Style/NumericLiterals - Use underscores(_) as thousands separator and separate every 3 digits with them.

spec/lib/task_helpers/imports/generic_object_definitions_spec.rb

spec/models/generic_object_spec.rb

❗ - Line 414, Col 71 - Style/NumericLiterals - Use underscores(_) as thousands separator and separate every 3 digits with them.
❗ - Line 562, Col 41 - Style/NumericLiterals - Use underscores(_) as thousands separator and separate every 3 digits with them.
❗ - Line 882, Col 1 - Layout/TrailingWhitespace - Trailing whitespace detected.

MANOJ PUTHRAN added 7 commits November 15, 2025 20:33

add attribute_constraints property for adding attribute rules or cons…

8fd6167

…traints

Add validation for attribute_constraints in GenericObjectDefinition

b9a8ffc

add spec for attribute_constraints in GenericObjectDefinition

16c0509

add spec for import & export of GenericObjectDefinitions with attribu…

d4db261

…te_constraints

add attribute constraint validation in GenericObject

a5326b3

add 'default' value constraint, for non-require attributes

48f4a09

add two new attributes types: Hash and Array

0439acd

agrare reviewed Nov 17, 2025

View reviewed changes

Fryguy reviewed Nov 17, 2025

View reviewed changes

Fryguy assigned Fryguy and agrare Nov 19, 2025

Fryguy added the enhancement label Nov 19, 2025

miq-bot added the wip label Dec 5, 2025

	unless value.is_a?(Array) && value.any?
	if value.is_a?(Array) && value.empty?

	:attributes => {}, :attribute_constraints=>{}, :associations => {}, :methods => []
	:attributes => {}, :attribute_constraints => {}, :associations => {}, :methods => []

	expect { testdef.save! }.to raise_error(ActiveRecord::RecordInvalid, /constraints for attribute .* must be a hash/)
	expect { testdef.save! }.to raise_error(ActiveRecord::RecordInvalid, /constraints for attribute "name" must be a hash/)

Conversation

putmanoj commented Nov 17, 2025

Summary

Changes

Core Features

Constraint Types - 12 validation constraint types:

Hash and Array Types - New attribute types with JSON storage:

Default Values - Automatic default value application:

Import/Export - Full YAML serialization support:

Usage Example

API Changes

GenericObjectDefinition

New Methods:

Enhanced Methods:

Example:

GenericObject

New Validations:

Constraint Reference

Backward Compatibility

Benefits

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agrare commented Nov 17, 2025

Uh oh!

agrare commented Nov 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Fryguy Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

miq-bot commented Jan 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Fryguy Nov 17, 2025 •

edited

Loading