Fix ignored unique constraint error name (#4648)

* Fix ignored unique constraint error name

Also add tests to ensure that `ignored_unique_constraint_violation_errors` is set correctly.

* Add shared example for ignored_unique_constraint_violation_errors

This iterates through all constraints that are listed as 'ignorable' and
checks if they actually exist in the database - either as a primary key
constraint or as an index.

* Use 'ignored_unique_constraint_violation_errors' shared example

---------

Co-authored-by: Philipp Thun <philipp.thun@sap.com>

Author: johha

app/models/runtime/security_group.rb

@@ -12,7 +12,7 @@ class SecurityGroup < Sequel::Model
 
     serialize_attributes :json, :rules
 
-    many_to_many :spaces, ignored_unique_constraint_violation_errors: %w[ignored_unique_constraint_violation_errors]
+    many_to_many :spaces, ignored_unique_constraint_violation_errors: %w[security_groups_spaces_ids]
     many_to_many :staging_spaces,
                  class: 'VCAP::CloudController::Space',
                  join_table: 'staging_security_groups_spaces',

spec/support/shared_examples/models/ignored_unique_constraint_violation_errors.rb

@@ -0,0 +1,33 @@
+RSpec::Matchers.define :have_primary_key_constraint do |table_name, constraint_name|
+  match do |db|
+    !db.fetch('SELECT 1 AS one FROM information_schema.table_constraints ' \
+              "WHERE constraint_type = 'PRIMARY KEY' " \
+              "AND table_name = '#{table_name}' " \
+              "AND constraint_name = '#{constraint_name}';").
+      get(:one).nil?
+  end
+end
+
+RSpec.shared_examples 'ignored_unique_constraint_violation_errors' do |association, db|
+  it 'ignores unique constraint violation errors in the many_to_many relationship definition' do
+    constraint_names = association[:ignored_unique_constraint_violation_errors]
+    table_name = association[:join_table]
+
+    constraint_names.each do |constraint_name|
+      case constraint_name
+      when /_pk$/ # PostgreSQL primary key
+        next unless db.database_type == :postgres
+
+        expect(db).to have_primary_key_constraint(table_name, constraint_name)
+      when /\.PRIMARY$/ # MySQL primary key
+        next unless db.database_type == :mysql
+
+        tn, cn = constraint_name.split('.', 2)
+        expect(tn.to_sym).to equal(table_name)
+        expect(db).to have_primary_key_constraint(tn, cn)
+      else
+        expect(db.indexes(table_name)).to include(constraint_name.to_sym)
+      end
+    end
+  end
+end

spec/unit/models/runtime/domain_spec.rb

@@ -36,6 +36,8 @@ module VCAP::CloudController
           expect(domain.shared_organizations).to include(org)
         end
 
+        include_examples 'ignored_unique_constraint_violation_errors', Domain.association_reflection(:shared_organizations), Domain.db
+
         context 'when the domain is a shared domain' do
           it 'fails validation' do
             domain = Domain.make(owning_organization_id: nil)

spec/unit/models/runtime/route_spec.rb

@@ -113,6 +113,8 @@ module VCAP::CloudController
       it { is_expected.to have_associated :space, associated_instance: ->(route) { Space.make(organization: route.domain.owning_organization) } }
       it { is_expected.to have_associated :route_mappings, associated_instance: ->(route) { RouteMappingModel.make(app: AppModel.make(space: route.space), route: route) } }
 
+      include_examples 'ignored_unique_constraint_violation_errors', Route.association_reflection(:shared_spaces), Route.db
+
       describe 'apps association' do
         let(:space) { Space.make }
         let(:process) { ProcessModelFactory.make(space:) }

spec/unit/models/runtime/security_group_spec.rb

@@ -421,6 +421,8 @@ def build_all_rule(attrs={})
 
           expect { security_group.destroy }.not_to raise_error
         end
+
+        include_examples 'ignored_unique_constraint_violation_errors', SecurityGroup.association_reflection(:spaces), SecurityGroup.db
       end
 
       describe 'staging_spaces' do
@@ -432,6 +434,8 @@ def build_all_rule(attrs={})
 
           expect { security_group.destroy }.not_to raise_error
         end
+
+        include_examples 'ignored_unique_constraint_violation_errors', SecurityGroup.association_reflection(:staging_spaces), SecurityGroup.db
       end
     end
 

spec/unit/models/services/service_instance_spec.rb

@@ -149,6 +149,8 @@ module VCAP::CloudController
               UserProvidedServiceInstance.make(name: 'shared-service', space: space)
             end.to raise_error(Sequel::ValidationFailed, /name unique/)
           end
+
+          include_examples 'ignored_unique_constraint_violation_errors', ManagedServiceInstance.association_reflection(:shared_spaces), ManagedServiceInstance.db
         end
       end
     end