Skip to content

Make database cleaner active record seeded deletion start/clean more threadsafe #9672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2025
Merged

Make database cleaner active record seeded deletion start/clean more threadsafe #9672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c06eafa
Make start/clean more threadsafe
jrafanie Oct 17, 2025
d1d4cbe
Revert "Rollback the tenant test changes due to timing issue failures"
jrafanie Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 27 additions & 60 deletions cypress/e2e/ui/Settings/Application-Settings/tenant.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,6 @@ function resetParentTenantForm() {
);
}

// TODO: Aside from test that validates deletion, replace with a more reliable cleanup mechanism when ready
Copy link
Member Author

@jrafanie jrafanie Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes in is this file are reverts of #9684

function deleteAccordionItems(accordionsToDelete) {
cy.get(`#${ACCESS_CONTROL_ACCORDION_ITEM_ID} li.list-group-item`).each(
(item) => {
Expand Down Expand Up @@ -261,28 +260,6 @@ function editQuotasTable(quotaName = ALLOCATED_STORAGE_QUOTA, quotaValue) {
});
}

function rollbackQuotas() {
cy.toolbar(CONFIG_TOOLBAR_BUTTON, MANAGE_QUOTAS_CONFIG_OPTION);
let quotaDisabled = false;
cy.get('#rbac_details .miq-data-table table tbody tr').each((row) => {
const quotaValueInputWrapper = row.find('div.bx--text-input-wrapper');
const isEnabled = !quotaValueInputWrapper.hasClass(
'bx--text-input-wrapper--readonly'
);
if (isEnabled) {
quotaDisabled = true;
cy.wrap(row).find('span.bx--toggle__switch').click();
}
});
// Save the form only if any quotas are reverted to disabled.
cy.then(() => {
if (quotaDisabled) {
// Saving the form
saveFormWithOptionalFlashCheck({ assertFlashMessage: false });
}
});
}

describe('Automate Tenant form operations: Settings > Application Settings > Access Control > Tenants', () => {
beforeEach(() => {
cy.login();
Expand All @@ -301,6 +278,10 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
cy.toolbar(CONFIG_TOOLBAR_BUTTON, EDIT_TENANT_CONFIG_OPTION);
});

afterEach(() => {
confirmUiNavigation(() => resetParentTenantForm());
});

it('Validate Edit tenant form elements', () => {
validateFormElements();
});
Expand All @@ -325,27 +306,27 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
);
saveFormWithOptionalFlashCheck({ apiMethod: 'PUT' });
});
});

describe('Validate Add Project to parent tenant', () => {
afterEach(() => {
confirmUiNavigation(() => resetParentTenantForm());
cy.appDbState('restore');
});
});

describe('Validate Add Project to parent tenant', () => {
it('Validate Add Project function', () => {
addProjectToTenant();
});

afterEach(() => {
confirmUiNavigation(() => deleteAccordionItems([PROJECT_NAME_VALUE]));
});
});

describe('Validate Manage Quotas in parent tenant', () => {
beforeEach(() => {
cy.toolbar(CONFIG_TOOLBAR_BUTTON, MANAGE_QUOTAS_CONFIG_OPTION);
});

afterEach(() => {
cy.appDbState('restore');
});

it('Validate Reset & Cancel buttons in Manage Quotas form', () => {
cy.getFormFooterButtonByTypeWithText({
buttonText: RESET_BUTTON_TEXT,
Expand All @@ -360,10 +341,6 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
editQuotasTable(ALLOCATED_STORAGE_QUOTA, '10');
saveFormWithOptionalFlashCheck();
});

afterEach(() => {
confirmUiNavigation(() => rollbackQuotas());
});
});
});

Expand All @@ -373,6 +350,10 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
cy.toolbar(CONFIG_TOOLBAR_BUTTON, ADD_CHILD_TENANT_CONFIG_OPTION);
});

afterEach(() => {
cy.appDbState('restore');
});

it('Validate Add child tenant form elements', () => {
validateFormElements(false);
});
Expand Down Expand Up @@ -415,12 +396,6 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
);
cancelFormWithOptionalFlashCheck(false);
});

afterEach(() => {
confirmUiNavigation(() =>
deleteAccordionItems([INITIAL_CHILD_TENANT_NAME])
);
});
});

describe('Validate Edit child tenant', () => {
Expand All @@ -429,6 +404,10 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
cy.toolbar(CONFIG_TOOLBAR_BUTTON, EDIT_TENANT_CONFIG_OPTION);
});

afterEach(() => {
cy.appDbState('restore');
});

it('Validate Edit child tenant form elements', () => {
validateFormElements();
cancelFormWithOptionalFlashCheck();
Expand All @@ -454,20 +433,17 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
);
saveFormWithOptionalFlashCheck({ apiMethod: 'PUT' });
});

afterEach(() => {
deleteAccordionItems([
INITIAL_CHILD_TENANT_NAME,
EDITED_TENANT_NAME_VALUE,
]);
});
});

describe('Validate Add Project to child tenant', () => {
beforeEach(() => {
createAndSelectChildTenant();
});

afterEach(() => {
cy.appDbState('restore');
});

it('Validate Add Project function', () => {
addProjectToTenant();
});
Expand All @@ -477,13 +453,6 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
deleteAccordionItems([INITIAL_CHILD_TENANT_NAME]);
cy.expect_flash(flashClassMap.error, FLASH_MESSAGE_CANT_DELETE);
});

afterEach(() => {
confirmUiNavigation(() => {
deleteAccordionItems([PROJECT_NAME_VALUE]);
deleteAccordionItems([INITIAL_CHILD_TENANT_NAME]);
});
});
});

describe('Validate Manage Quotas in child tenant', () => {
Expand All @@ -492,6 +461,10 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
cy.toolbar(CONFIG_TOOLBAR_BUTTON, MANAGE_QUOTAS_CONFIG_OPTION);
});

afterEach(() => {
cy.appDbState('restore');
});

it('Validate Reset & Cancel buttons in Manage Quotas form', () => {
cy.getFormFooterButtonByTypeWithText({
buttonText: RESET_BUTTON_TEXT,
Expand All @@ -506,12 +479,6 @@ describe('Automate Tenant form operations: Settings > Application Settings > Acc
editQuotasTable(ALLOCATED_VM_QUOTA, '10');
saveFormWithOptionalFlashCheck();
});

afterEach(() => {
confirmUiNavigation(() => {
deleteAccordionItems([INITIAL_CHILD_TENANT_NAME]);
});
});
});
});
});
16 changes: 12 additions & 4 deletions lib/extensions/database_cleaner-activerecord-seeded_deletion.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
require 'database_cleaner-active_record'
require 'thread'

module DatabaseCleaner
module ActiveRecord
# SeededDeletion is a strategy that deletes all records from tables except those that existed before it was instantiated
# This is useful for tests that need the seeded data to be present.
class SeededDeletion < Deletion
# Class level mutex for thread safety around start/clean actions.
@mutex = Mutex.new

def clean
connection.transaction(:requires_new => true) do
# Use a transaction isolation to prevent other threads
# from modifying the tables during deletion
connection.transaction(:requires_new => true, :isolation => :read_committed) do
Copy link
Member Author

@jrafanie jrafanie Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switched to read_committed... it seems to prevent the errors we were seeing locally.

super
end
end
Expand All @@ -17,12 +23,14 @@ def start
end

def self.table_max_id_cache
@table_max_id_cache ||= {}
# wrap the cache initialization in a mutex to ensure thread safety
@mutex.synchronize { @table_max_id_cache ||= {} }
end

# Memoize the maximum ID for each class table with non-zero number of rows
def self.table_max_id_cache=(table_id_hash)
@table_max_id_cache ||= table_id_hash
@mutex.synchronize do
@table_max_id_cache = table_id_hash
Copy link
Member

@Fryguy Fryguy Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be cleaner as

Suggested change
@table_max_id_cache = table_id_hash
@table_max_id_cache ||= {}
@table_max_id_cache.replace(table_id_hash)

The reason is that if anyone has a reference to the "old" hash from the getter, then this would update that existing reference instead of creating a new one. Not a huge deal, but is a little safer.

end
end

delegate :table_max_id_cache, to: :class
Expand Down