inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-06-30 18:15:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged HEAD-BUG-FIX (5.0/Cloud) to HEAD (4.3/Cloud)

Browse Source 
71594: Merged V4.2-BUG-FIX (4.2.3) to HEAD-BUG-FIX (4.3/Cloud)
      70332: Merged V4.1-BUG-FIX (4.1.9) to V4.2-BUG-FIX (4.2.3)
         70292: Merged DEV to V4.1-BUG-FIX (4.1.9)
            60077: Created branch for MNT-10067 work.
            60101: MNT-10067: first commit of a generic SQL script runner.
            Very rough and ready extraction of SchemaBootstrap SQL script execution functionality. Will serve as the basis for the implementation of MNT-10067.
            60147: MNT-10067: added tests for "dialect" placeholder resolution, including overriding of dialects.
            60180: MNT-10067: exception thrown when unable to find SQL script to execute
            60187: MNT-10067: renamed ScriptExecutor to ScriptExecutorImpl to make way for an interface definition.
            60188: MNT-10067: introduced a ScriptExecutor interface.
            60189: MNT-10067: renamed ScriptExecutorTest
            60190: MNT-10067: added ScriptExecutorImplIntegrationTest to repo test suite.
            60194: MNT-10067: a very simple initial implementation of a SQL script runner capable of running multiple scripts in a given
            directory.
            60195: MNT-10067: added integration test for ScriptBundleExecutorImpl.
            60196: MNT-10067: moved ScriptBundleExecutorImplTest to correct source tree.
            60197: MNT-10067: added ScriptBundleExecutorImplIntegrationTest to repo test suite.
            60263: MNT-10067: ScriptBundleExecutor(Impl) now stops executing the main batch of scripts upon failure and runs a post-script.
            60459: MNT-10067: minor change to test data to avoid implying that ScriptBundleExecutor.exec(String, String...) has an always-run
            final script.
            60482: MNT-10067: added integration test for ScriptBundleExecutor.execWithPostScript()
            60483: MNT-10067: committed missing files from r60482
            60488: MNT-10067: set appropriate log levels for log4j
            60620: MNT-10067: added alf_props_xxx clean-up script.
            60623: MNT-10067: minor tidy up of ScriptExecutorImpl (tidy imports, group fields at top of class)
            60625: MNT-10067: further tidy up ScriptExecutorImpl (removed redundant constants, made externally unused public constant private)
            60629: MNT-10067: fix tests broken by introduction of scriptExecutor bean in production code.
            60662: MNT-10067: added tests to check deletion of doubles, serializables and dates.
            61378: MNT-10067 : Cleanup alf_prop_XXX data
            Added MySQL, Oracle DB, MS SQL Server and IBM DB2 scripts.
            63371: MNT-10067: removed the vacuum and analyze statements from the postgresql script.
            63372: MNT-10067: replaced begin and commit statements (PostgreSQL script only) with --BEGIN TXN and --END TXN, handled by the
            script executor.
            63568: MNT-10067 : Cleanup alf_prop_XXX data
            Added start and end transaction marks to the scripts.
            64115: MNT-10067: added Quartz job that by default doesn't fire until 2099 and can be manually invoked over JMX.
            64223: MNT-10067: improved testing for AuditDAOTest and added PropertyValueDAOTest
            64685: MNT-10067: added AttributeServiceTest
            65796: MNT-10067 : Cleanup alf_prop_XXX data
            Implemented a performance test.
            65983: MNT-10067 : Cleanup alf_prop_XXX data
            Reworked the MySQL script.
            Added time measurements for entry creation.
            66116: MNT-10067 : Cleanup alf_prop_XXX data
            For MySQL:
            1) Renamed temp tables.
            2) Split the script into execution and cleanup of temp tables parts.
            67023: MNT-10067 : Cleanup alf_prop_XXX data
            Modified MySQL script to skip null values from alf_prop_unique_ctx.prop1_id.
            67199: MNT-10067 : Cleanup alf_prop_XXX data
            Implemented the latest changes of the script for other DB flavors.
            Removed the MS SQL Server transaction marks.
            67763: MNT-10067 : Cleanup alf_prop_XXX data
            Removed unnecessary temporary index dropping.
            Added additional cleanup before main script execution.
            68710: MNT-10067 : Cleanup alf_prop_XXX data
            Added batch logging.
            Moved clearCaches() statement in PropertyValueDAOImpl.cleanupUnusedValues() to finally block.
            68711: MNT-10067 : Cleanup alf_prop_XXX data
            Added batching for MySQL script.
            69602: MNT-10067 : Cleanup alf_prop_XXX data
            Updated scripts for all DB flavors with batching.
            69768: MNT-10067 : Cleanup alf_prop_XXX data
            Fixed failing ScriptBundleExecutorImplIntegrationTest and ScriptExecutorImplIntegrationTest.
            70058: Sync with latest changes in V4.1-BUG-FIX.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@74691 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Will Abson 2014-06-25 15:26:31 +00:00
parent b703c1de1f
commit 04cead57a6
39 changed files with 2139 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
config/alfresco/attributes-service-context.xml
View File

@ -10,4 +10,30 @@
</property> </property>
</bean> </bean>
<!-- Cleanup job for alf_prop_xxx tables -->
<bean id="propTablesCleanupJobDetail" class="org.springframework.scheduling.quartz.JobDetailBean">
<property name="jobClass">
<value>org.alfresco.repo.attributes.PropTablesCleanupJob</value>
</property>
<property name="jobDataAsMap">
<map>
<entry key="propertyValueDAO">
<ref bean="propertyValueDAO" />
</entry>
</map>
</property>
</bean>
<bean id="propTablesCleanupTrigger" class="org.alfresco.util.CronTriggerBean">
<property name="jobDetail">
<ref bean="propTablesCleanupJobDetail" />
</property>
<property name="scheduler">
<ref bean="schedulerFactory" />
</property>
<property name="cronExpression">
<value>${attributes.propcleaner.cronExpression}</value>
</property>
</bean>
</beans> </beans>

21
config/alfresco/dao/dao-context.xml
View File

@ -175,6 +175,25 @@
<property name="contentStoreCleaner" ref="eagerContentStoreCleaner"/> <property name="contentStoreCleaner" ref="eagerContentStoreCleaner"/>
</bean> </bean>
<bean id="scriptExecutor" class="org.alfresco.repo.domain.schema.script.ScriptBundleExecutorImpl">
<constructor-arg>
<bean class="org.alfresco.repo.domain.schema.script.ScriptExecutorImpl">
<property name="dataSource">
<ref bean="dataSource" />
</property>
<property name="localSessionFactory">
<ref bean="&amp;sessionFactory"></ref> <!-- inject the actual factory, not a session -->
</property>
<property name="dialect">
<ref bean="dialect" />
</property>
<property name="globalProperties">
<ref bean="global-properties" />
</property>
</bean>
</constructor-arg>
</bean>
<bean id="propertyValueDAO" class="org.alfresco.repo.domain.propval.ibatis.PropertyValueDAOImpl"> <bean id="propertyValueDAO" class="org.alfresco.repo.domain.propval.ibatis.PropertyValueDAOImpl">
<property name="sqlSessionTemplate" ref="propertyValueSqlSessionTemplate"/> <property name="sqlSessionTemplate" ref="propertyValueSqlSessionTemplate"/>
<property name="converter"> <property name="converter">
@ -193,6 +212,8 @@
<property name="propertyUniqueContextCache" ref="propertyUniqueContextCache"/> <property name="propertyUniqueContextCache" ref="propertyUniqueContextCache"/>
<property name="scriptExecutor" ref="scriptExecutor"/>
</bean> </bean>
<bean id="auditDAO" class="org.alfresco.repo.domain.audit.ibatis.AuditDAOImpl"> <bean id="auditDAO" class="org.alfresco.repo.domain.audit.ibatis.AuditDAOImpl">

64
config/alfresco/dbscripts/utility/org.hibernate.dialect.MySQLInnoDBDialect/CleanAlfPropTables.sql Normal file
View File

@ -0,0 +1,64 @@
--BEGIN TXN
-- get all active references to alf_prop_root
--FOREACH alf_audit_app.id system.upgrade.clean_alf_prop_tables.batchsize
create table temp_prop_root_ref as select disabled_paths_id as id from alf_audit_app where id >= ${LOWERBOUND} and id <= ${UPPERBOUND};
create index idx_temp_prop_root_ref_id on temp_prop_root_ref(id);
--FOREACH alf_audit_entry.audit_values_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_root_ref select audit_values_id from alf_audit_entry where audit_values_id >= ${LOWERBOUND} and audit_values_id <= ${UPPERBOUND};
--FOREACH alf_prop_unique_ctx.prop1_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_root_ref select prop1_id from alf_prop_unique_ctx where prop1_id is not null and prop1_id >= ${LOWERBOUND} and prop1_id <= ${UPPERBOUND};
-- determine the obsolete entries from alf_prop_root
--FOREACH alf_prop_root.id system.upgrade.clean_alf_prop_tables.batchsize
create table temp_prop_root_abs as select alf_prop_root.id from alf_prop_root left join temp_prop_root_ref on temp_prop_root_ref.id = alf_prop_root.id where temp_prop_root_ref.id is null and alf_prop_root.id >= ${LOWERBOUND} and alf_prop_root.id <= ${UPPERBOUND};
create index idx_temp_prop_root_abs_id on temp_prop_root_abs(id);
-- clear alf_prop_root which cascades DELETE to alf_prop_link
--FOREACH temp_prop_root_abs.id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_root where id in (select id from temp_prop_root_abs where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
-- get all active references to alf_prop_value
--FOREACH alf_prop_value.id system.upgrade.clean_alf_prop_tables.batchsize
create table temp_prop_val_ref as select id from alf_prop_value where id in (select app_name_id from alf_audit_app) and id >= ${LOWERBOUND} and id <= ${UPPERBOUND};
create index idx_temp_prop_val_ref_id on temp_prop_val_ref(id);
--FOREACH alf_audit_entry.audit_user_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select audit_user_id from alf_audit_entry where audit_user_id >= ${LOWERBOUND} and audit_user_id <= ${UPPERBOUND};
--FOREACH alf_prop_link.key_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select key_prop_id from alf_prop_link where key_prop_id >= ${LOWERBOUND} and key_prop_id <= ${UPPERBOUND};
--FOREACH alf_prop_link.value_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select value_prop_id from alf_prop_link where value_prop_id >= ${LOWERBOUND} and value_prop_id <= ${UPPERBOUND};
--FOREACH alf_prop_unique_ctx.value1_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select value1_prop_id from alf_prop_unique_ctx where value1_prop_id >= ${LOWERBOUND} and value1_prop_id <= ${UPPERBOUND};
--FOREACH alf_prop_unique_ctx.value2_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select value2_prop_id from alf_prop_unique_ctx where value2_prop_id >= ${LOWERBOUND} and value2_prop_id <= ${UPPERBOUND};
--FOREACH alf_prop_unique_ctx.value3_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select value3_prop_id from alf_prop_unique_ctx where value3_prop_id >= ${LOWERBOUND} and value3_prop_id <= ${UPPERBOUND};
-- determine the obsolete entries from alf_prop_value
--FOREACH alf_prop_value.id system.upgrade.clean_alf_prop_tables.batchsize
create table temp_prop_val_abs as select apv.id, apv.persisted_type, apv.long_value from alf_prop_value apv left join temp_prop_val_ref on (apv.id = temp_prop_val_ref.id) where temp_prop_val_ref.id is null and apv.id >= ${LOWERBOUND} and apv.id <= ${UPPERBOUND};
create index idx_temp_prop_val_abs_id on temp_prop_val_abs(id);
create index idx_temp_prop_val_abs_per on temp_prop_val_abs(persisted_type, id, long_value);
-- clear the obsolete entries
--FOREACH temp_prop_val_abs.id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_value where id in (select id from temp_prop_val_abs where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
-- find and clear obsoleted string values
create table temp_del_str as select temp_prop_val_abs.long_value as string_id from temp_prop_val_abs left join alf_prop_value apv on (apv.id = temp_prop_val_abs.id) where temp_prop_val_abs.persisted_type in (3,5,6) and apv.id is null;
--FOREACH temp_del_str.string_id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_string_value where id in (select id from temp_del_str where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
-- find and clear obsoleted serialized values
create table temp_del_ser as select temp_prop_val_abs.long_value as string_id from temp_prop_val_abs left join alf_prop_value apv on (apv.id = temp_prop_val_abs.id) where temp_prop_val_abs.persisted_type = 4 and apv.id is null;
--FOREACH temp_del_ser.string_id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_serializable_value where id in (select id from temp_del_ser where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
-- find and clear obsoleted double values
create table temp_del_double as select temp_prop_val_abs.long_value as string_id from temp_prop_val_abs left join alf_prop_value apv on (apv.id = temp_prop_val_abs.id) where temp_prop_val_abs.persisted_type = 2 and apv.id is null;
--FOREACH temp_del_double.string_id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_double_value where id in (select id from temp_del_double where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
--END TXN

12
config/alfresco/dbscripts/utility/org.hibernate.dialect.MySQLInnoDBDialect/CleanAlfPropTablesPostExec.sql Normal file
View File

@ -0,0 +1,12 @@
--BEGIN TXN
-- cleanup temporary structures
drop table temp_prop_root_ref; --(optional)
drop table temp_prop_root_abs; --(optional)
drop table temp_prop_val_ref; --(optional)
drop table temp_prop_val_abs; --(optional)
drop table temp_del_str; --(optional)
drop table temp_del_ser; --(optional)
drop table temp_del_double; --(optional)
--END TXN

63
config/alfresco/dbscripts/utility/org.hibernate.dialect.PostgreSQLDialect/CleanAlfPropTables.sql Normal file
View File

@ -0,0 +1,63 @@
--BEGIN TXN
-- get all active references to alf_prop_root
--FOREACH alf_audit_app.id system.upgrade.clean_alf_prop_tables.batchsize
create temp table temp_prop_root_ref as select disabled_paths_id as id from alf_audit_app where id >= ${LOWERBOUND} and id <= ${UPPERBOUND};
create index idx_temp_prop_root_ref_id on temp_prop_root_ref(id);
--FOREACH alf_audit_entry.audit_values_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_root_ref select audit_values_id from alf_audit_entry where audit_values_id >= ${LOWERBOUND} and audit_values_id <= ${UPPERBOUND};
--FOREACH alf_prop_unique_ctx.prop1_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_root_ref select prop1_id from alf_prop_unique_ctx where prop1_id is not null and prop1_id >= ${LOWERBOUND} and prop1_id <= ${UPPERBOUND};
-- determine the obsolete entries from alf_prop_root
--FOREACH alf_prop_root.id system.upgrade.clean_alf_prop_tables.batchsize
create temp table temp_prop_root_abs as select alf_prop_root.id from alf_prop_root left join temp_prop_root_ref on temp_prop_root_ref.id = alf_prop_root.id where temp_prop_root_ref.id is null and alf_prop_root.id >= ${LOWERBOUND} and alf_prop_root.id <= ${UPPERBOUND};
create index idx_temp_prop_root_abs_id on temp_prop_root_abs(id);
-- clear alf_prop_root which cascades DELETE to alf_prop_link
--FOREACH temp_prop_root_abs.id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_root where id in (select id from temp_prop_root_abs where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
-- get all active references to alf_prop_value
--FOREACH alf_prop_value.id system.upgrade.clean_alf_prop_tables.batchsize
create temp table temp_prop_val_ref as select id from alf_prop_value where id in (select app_name_id from alf_audit_app) and id >= ${LOWERBOUND} and id <= ${UPPERBOUND};
create index idx_temp_prop_val_ref_id on temp_prop_val_ref(id);
--FOREACH alf_audit_entry.audit_user_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select audit_user_id from alf_audit_entry where audit_user_id >= ${LOWERBOUND} and audit_user_id <= ${UPPERBOUND};
--FOREACH alf_prop_link.key_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select key_prop_id from alf_prop_link where key_prop_id >= ${LOWERBOUND} and key_prop_id <= ${UPPERBOUND};
--FOREACH alf_prop_link.value_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select value_prop_id from alf_prop_link where value_prop_id >= ${LOWERBOUND} and value_prop_id <= ${UPPERBOUND};
--FOREACH alf_prop_unique_ctx.value1_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select value1_prop_id from alf_prop_unique_ctx where value1_prop_id >= ${LOWERBOUND} and value1_prop_id <= ${UPPERBOUND};
--FOREACH alf_prop_unique_ctx.value2_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select value2_prop_id from alf_prop_unique_ctx where value2_prop_id >= ${LOWERBOUND} and value2_prop_id <= ${UPPERBOUND};
--FOREACH alf_prop_unique_ctx.value3_prop_id system.upgrade.clean_alf_prop_tables.batchsize
insert into temp_prop_val_ref select value3_prop_id from alf_prop_unique_ctx where value3_prop_id >= ${LOWERBOUND} and value3_prop_id <= ${UPPERBOUND};
-- determine the obsolete entries from alf_prop_value
--FOREACH alf_prop_value.id system.upgrade.clean_alf_prop_tables.batchsize
create temp table temp_prop_val_abs as select apv.id, apv.persisted_type, apv.long_value from alf_prop_value apv left join temp_prop_val_ref on (apv.id = temp_prop_val_ref.id) where temp_prop_val_ref.id is null and apv.id >= ${LOWERBOUND} and apv.id <= ${UPPERBOUND};
create index idx_temp_prop_val_abs_id on temp_prop_val_abs(id);
create index idx_temp_prop_val_abs_per on temp_prop_val_abs(persisted_type, id, long_value);
-- clear the obsolete entries
--FOREACH temp_prop_val_abs.id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_value where id in (select id from temp_prop_val_abs where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
-- find and clear obsoleted string values
create table temp_del_str as select temp_prop_val_abs.long_value as string_id from temp_prop_val_abs left join alf_prop_value apv on (apv.id = temp_prop_val_abs.id) where temp_prop_val_abs.persisted_type in (3,5,6) and apv.id is null;
--FOREACH temp_del_str.string_id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_string_value where id in (select id from temp_del_str where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
-- find and clear obsoleted serialized values
create table temp_del_ser as select temp_prop_val_abs.long_value as string_id from temp_prop_val_abs left join alf_prop_value apv on (apv.id = temp_prop_val_abs.id) where temp_prop_val_abs.persisted_type = 4 and apv.id is null;
--FOREACH temp_del_ser.string_id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_serializable_value where id in (select id from temp_del_ser where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
-- find and clear obsoleted double values
create table temp_del_double as select temp_prop_val_abs.long_value as string_id from temp_prop_val_abs left join alf_prop_value apv on (apv.id = temp_prop_val_abs.id) where temp_prop_val_abs.persisted_type = 2 and apv.id is null;
--FOREACH temp_del_double.string_id system.upgrade.clean_alf_prop_tables.batchsize
delete from alf_prop_double_value where id in (select id from temp_del_double where id >= ${LOWERBOUND} and id <= ${UPPERBOUND});
--END TXN

12
config/alfresco/dbscripts/utility/org.hibernate.dialect.PostgreSQLDialect/CleanAlfPropTablesPostExec.sql Normal file
View File

@ -0,0 +1,12 @@
--BEGIN TXN
-- cleanup temporary structures
drop table temp_prop_root_ref; --(optional)
drop table temp_prop_root_abs; --(optional)
drop table temp_prop_val_ref; --(optional)
drop table temp_prop_val_abs; --(optional)
drop table temp_del_str; --(optional)
drop table temp_del_ser; --(optional)
drop table temp_del_double; --(optional)
--END TXN

6
config/alfresco/repository.properties
View File

@ -1108,4 +1108,8 @@ system.lockTryTimeout.PolicyComponentImpl=${system.lockTryTimeout}
# #
system.patch.surfConfigFolder.deferred=false system.patch.surfConfigFolder.deferred=false
# Default value. i.e. never run. It can be triggered using JMX # Default value. i.e. never run. It can be triggered using JMX
system.patch.surfConfigFolder.cronExpression=* * * * * ? 2099 system.patch.surfConfigFolder.cronExpression=* * * * * ? 2099
# Scheduled job to clean up unused properties from the alf_prop_xxx tables.
# Default setting is for it never to run.
attributes.propcleaner.cronExpression=* * * * * ? 2099

49
source/java/org/alfresco/repo/attributes/PropTablesCleanupJob.java Normal file
View File

@ -0,0 +1,49 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.attributes;
import org.alfresco.repo.domain.propval.PropertyValueDAO;
import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
/**
* Cleanup job to initiate cleaning of unused values from the alf_prop_xxx tables.
*
* @author Matt Ward
*/
public class PropTablesCleanupJob implements Job
{
protected static final Object PROPERTY_VALUE_DAO_KEY = "propertyValueDAO";
@Override
public void execute(JobExecutionContext jobCtx) throws JobExecutionException
{
JobDataMap jobData = jobCtx.getJobDetail().getJobDataMap();
PropertyValueDAO propertyValueDAO = (PropertyValueDAO) jobData.get(PROPERTY_VALUE_DAO_KEY);
if (propertyValueDAO == null)
{
throw new IllegalArgumentException(PROPERTY_VALUE_DAO_KEY + " in job data map was null");
}
propertyValueDAO.cleanupUnusedValues();
}
}

11
source/java/org/alfresco/repo/domain/propval/AbstractPropertyValueDAOImpl.java
View File

@ -1588,4 +1588,15 @@ public abstract class AbstractPropertyValueDAOImpl implements PropertyValueDAO
// This will have put the values into the correct containers // This will have put the values into the correct containers
return result; return result;
} }
protected void clearCaches()
{
propertyClassCache.clear();
propertyDateValueCache.clear();
propertyStringValueCache.clear();
propertyDoubleValueCache.clear();
propertySerializableValueCache.clear();
propertyCache.clear();
propertyValueCache.clear();
}
} }

5
source/java/org/alfresco/repo/domain/propval/PropertyValueDAO.java
View File

@ -362,4 +362,9 @@ public interface PropertyValueDAO
* @throws IllegalArgumentException if rows don't all share the same root property ID * @throws IllegalArgumentException if rows don't all share the same root property ID
*/ */
Serializable convertPropertyIdSearchRows(List<PropertyIdSearchRow> rows); Serializable convertPropertyIdSearchRows(List<PropertyIdSearchRow> rows);
/**
* Remove orphaned properties.
*/
void cleanupUnusedValues();
} }

35
source/java/org/alfresco/repo/domain/propval/ibatis/PropertyValueDAOImpl.java
View File

@ -38,6 +38,7 @@ import org.alfresco.repo.domain.propval.PropertyStringValueEntity;
import org.alfresco.repo.domain.propval.PropertyUniqueContextEntity; import org.alfresco.repo.domain.propval.PropertyUniqueContextEntity;
import org.alfresco.repo.domain.propval.PropertyValueEntity; import org.alfresco.repo.domain.propval.PropertyValueEntity;
import org.alfresco.repo.domain.propval.PropertyValueEntity.PersistedType; import org.alfresco.repo.domain.propval.PropertyValueEntity.PersistedType;
import org.alfresco.repo.domain.schema.script.ScriptBundleExecutor;
import org.alfresco.util.Pair; import org.alfresco.util.Pair;
import org.apache.ibatis.session.ResultContext; import org.apache.ibatis.session.ResultContext;
import org.apache.ibatis.session.ResultHandler; import org.apache.ibatis.session.ResultHandler;
@ -98,11 +99,18 @@ public class PropertyValueDAOImpl extends AbstractPropertyValueDAOImpl
private SqlSessionTemplate template; private SqlSessionTemplate template;
private ScriptBundleExecutor scriptExecutor;
public final void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) public final void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate)
{ {
this.template = sqlSessionTemplate; this.template = sqlSessionTemplate;
} }
public void setScriptExecutor(ScriptBundleExecutor scriptExecutor)
{
this.scriptExecutor = scriptExecutor;
}
//================================ //================================
// 'alf_prop_class' accessors // 'alf_prop_class' accessors
@ -672,4 +680,31 @@ public class PropertyValueDAOImpl extends AbstractPropertyValueDAOImpl
entity.setId(rootPropId); entity.setId(rootPropId);
return template.delete(DELETE_PROPERTY_LINKS_BY_ROOT_ID, entity); return template.delete(DELETE_PROPERTY_LINKS_BY_ROOT_ID, entity);
} }
@Override
public void cleanupUnusedValues()
{
// execute clean up in case of previous failures
scriptExecutor.exec("alfresco/dbscripts/utility/${db.script.dialect}", "CleanAlfPropTablesPostExec.sql");
try
{
scriptExecutor.exec("alfresco/dbscripts/utility/${db.script.dialect}", "CleanAlfPropTables.sql");
}
finally
{
try
{
// execute clean up
scriptExecutor.exec("alfresco/dbscripts/utility/${db.script.dialect}", "CleanAlfPropTablesPostExec.sql");
}
catch (Exception e)
{
if (logger.isErrorEnabled())
{
logger.error("The cleanup failed with an error: ", e);
}
}
clearCaches();
}
}
} }

45
source/java/org/alfresco/repo/domain/schema/script/ScriptBundleExecutor.java Normal file
View File

@ -0,0 +1,45 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.domain.schema.script;
/**
* Executes a set of zero or more SQL scripts.
*
* @author Matt Ward
*/
public interface ScriptBundleExecutor
{
/**
* Runs a bundle of scripts. If any script within the bundle fails, then the rest of the files are not run.
*
* @param dir Directory where the script bundle may be found.
* @param scripts Names of the SQL scripts to run, relative to the specified directory.
*/
void exec(String dir, String... scripts);
/**
* Runs a bundle of scripts. If any script within the bundle fails, then the rest of the files
* are not run, with the exception of postScript - which is always run (a clean-up script for example).
*
* @param dir Directory where the script bundle may be found.
* @param postScript A script that is always run after the other scripts.
* @param scripts Names of the SQL scripts to run, relative to the specified directory.
*/
void execWithPostScript(String dir, String postScript, String... scripts);
}

74
source/java/org/alfresco/repo/domain/schema/script/ScriptBundleExecutorImpl.java Normal file
View File

@ -0,0 +1,74 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.domain.schema.script;
import java.io.File;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* {@link ScriptBundleExecutor} implementation. Uses the supplied {@link ScriptExecutor}
* to invoke multiple SQL scripts in a particular directory.
*
* @author Matt Ward
*/
public class ScriptBundleExecutorImpl implements ScriptBundleExecutor
{
private ScriptExecutor scriptExecutor;
protected Log log = LogFactory.getLog(ScriptBundleExecutorImpl.class);
public ScriptBundleExecutorImpl(ScriptExecutor scriptExecutor)
{
this.scriptExecutor = scriptExecutor;
}
@Override
public void exec(String dir, String... scripts)
{
for (String name : scripts)
{
File file = new File(dir, name);
try
{
scriptExecutor.executeScriptUrl(file.getPath());
}
catch (Throwable e)
{
log.error("Unable to run SQL script: dir=" + dir + ", name="+name, e);
// Do not run any more scripts.
break;
}
}
}
@Override
public void execWithPostScript(String dir, String postScript, String... scripts)
{
try
{
exec(dir, scripts);
}
finally
{
// Always run the post-script.
exec(dir, postScript);
}
}
}

29
source/java/org/alfresco/repo/domain/schema/script/ScriptExecutor.java Normal file
View File

@ -0,0 +1,29 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.domain.schema.script;
/**
* Defines a SQL script executor that executes a single SQL script.
*
* @author Matt Ward
*/
public interface ScriptExecutor
{
void executeScriptUrl(String scriptUrl) throws Exception;
}

597
source/java/org/alfresco/repo/domain/schema/script/ScriptExecutorImpl.java Normal file
View File

@ -0,0 +1,597 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.domain.schema.script;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import javax.sql.DataSource;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.content.filestore.FileContentWriter;
import org.alfresco.service.cmr.repository.ContentWriter;
import org.alfresco.util.LogUtil;
import org.alfresco.util.TempFileProvider;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.hibernate.cfg.Configuration;
import org.hibernate.dialect.Dialect;
import org.hibernate.dialect.MySQLInnoDBDialect;
import org.hibernate.dialect.PostgreSQLDialect;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.orm.hibernate3.LocalSessionFactoryBean;
public class ScriptExecutorImpl implements ScriptExecutor
{
/** The placeholder for the configured <code>Dialect</code> class name: <b>${db.script.dialect}</b> */
private static final String PLACEHOLDER_DIALECT = "\\$\\{db\\.script\\.dialect\\}";
/** The global property containing the default batch size used by --FOREACH */
private static final String PROPERTY_DEFAULT_BATCH_SIZE = "system.upgrade.default.batchsize";
private static final String MSG_EXECUTING_GENERATED_SCRIPT = "schema.update.msg.executing_generated_script";
private static final String MSG_EXECUTING_COPIED_SCRIPT = "schema.update.msg.executing_copied_script";
private static final String MSG_EXECUTING_STATEMENT = "schema.update.msg.executing_statement";
private static final String MSG_OPTIONAL_STATEMENT_FAILED = "schema.update.msg.optional_statement_failed";
private static final String ERR_STATEMENT_FAILED = "schema.update.err.statement_failed";
private static final String ERR_SCRIPT_NOT_FOUND = "schema.update.err.script_not_found";
private static final String ERR_STATEMENT_INCLUDE_BEFORE_SQL = "schema.update.err.statement_include_before_sql";
private static final String ERR_STATEMENT_VAR_ASSIGNMENT_BEFORE_SQL = "schema.update.err.statement_var_assignment_before_sql";
private static final String ERR_STATEMENT_VAR_ASSIGNMENT_FORMAT = "schema.update.err.statement_var_assignment_format";
private static final String ERR_STATEMENT_TERMINATOR = "schema.update.err.statement_terminator";
private static final int DEFAULT_MAX_STRING_LENGTH = 1024;
private static volatile int maxStringLength = DEFAULT_MAX_STRING_LENGTH;
private Dialect dialect;
private ResourcePatternResolver rpr = new PathMatchingResourcePatternResolver(this.getClass().getClassLoader());
private static Log logger = LogFactory.getLog(ScriptExecutorImpl.class);
private LocalSessionFactoryBean localSessionFactory;
private Properties globalProperties;
private ThreadLocal<StringBuilder> executedStatementsThreadLocal = new ThreadLocal<StringBuilder>();
private DataSource dataSource;
/**
* @return Returns the maximum number of characters that a string field can be
*/
public static final int getMaxStringLength()
{
return ScriptExecutorImpl.maxStringLength;
}
/**
* Truncates or returns a string that will fit into the string columns in the schema. Text fields can
* either cope with arbitrarily long text fields or have the default limit, {@link #DEFAULT_MAX_STRING_LENGTH}.
*
* @param value the string to check
* @return Returns a string that is short enough for {@link ScriptExecutorImpl#getMaxStringLength()}
*
* @since 3.2
*/
public static final String trimStringForTextFields(String value)
{
if (value != null && value.length() > maxStringLength)
{
return value.substring(0, maxStringLength);
}
else
{
return value;
}
}
/**
* Sets the previously auto-detected Hibernate dialect.
*
* @param dialect
* the dialect
*/
public void setDialect(Dialect dialect)
{
this.dialect = dialect;
}
public ScriptExecutorImpl()
{
globalProperties = new Properties();
}
public void setLocalSessionFactory(LocalSessionFactoryBean localSessionFactory)
{
this.localSessionFactory = localSessionFactory;
}
public LocalSessionFactoryBean getLocalSessionFactory()
{
return localSessionFactory;
}
public void setDataSource(DataSource dataSource)
{
this.dataSource = dataSource;
}
/**
* Sets the properties map from which we look up some configuration settings.
*
* @param globalProperties
* the global properties
*/
public void setGlobalProperties(Properties globalProperties)
{
this.globalProperties = globalProperties;
}
@Override
public void executeScriptUrl(String scriptUrl) throws Exception
{
Configuration cfg = localSessionFactory.getConfiguration();
Connection connection = dataSource.getConnection();
connection.setAutoCommit(true);
try
{
executeScriptUrl(cfg, connection, scriptUrl);
}
finally
{
connection.close();
}
}
private void executeScriptUrl(Configuration cfg, Connection connection, String scriptUrl) throws Exception
{
Dialect dialect = Dialect.getDialect(cfg.getProperties());
String dialectStr = dialect.getClass().getSimpleName();
InputStream scriptInputStream = getScriptInputStream(dialect.getClass(), scriptUrl);
// check that it exists
if (scriptInputStream == null)
{
throw AlfrescoRuntimeException.create(ERR_SCRIPT_NOT_FOUND, scriptUrl);
}
// write the script to a temp location for future and failure reference
File tempFile = null;
try
{
tempFile = TempFileProvider.createTempFile("AlfrescoSchema-" + dialectStr + "-Update-", ".sql");
ContentWriter writer = new FileContentWriter(tempFile);
writer.putContent(scriptInputStream);
}
finally
{
try { scriptInputStream.close(); } catch (Throwable e) {} // usually a duplicate close
}
// now execute it
String dialectScriptUrl = scriptUrl.replaceAll(PLACEHOLDER_DIALECT, dialect.getClass().getName());
// Replace the script placeholders
executeScriptFile(cfg, connection, tempFile, dialectScriptUrl);
}
/**
* Replaces the dialect placeholder in the resource URL and attempts to find a file for
* it. If not found, the dialect hierarchy will be walked until a compatible resource is
* found. This makes it possible to have resources that are generic to all dialects.
*
* @return The Resource, otherwise null
*/
private Resource getDialectResource(Class dialectClass, String resourceUrl)
{
// replace the dialect placeholder
String dialectResourceUrl = resolveDialectUrl(dialectClass, resourceUrl);
// get a handle on the resource
Resource resource = rpr.getResource(dialectResourceUrl);
if (!resource.exists())
{
// it wasn't found. Get the superclass of the dialect and try again
Class superClass = dialectClass.getSuperclass();
if (Dialect.class.isAssignableFrom(superClass))
{
// we still have a Dialect - try again
return getDialectResource(superClass, resourceUrl);
}
else
{
// we have exhausted all options
return null;
}
}
else
{
// we have a handle to it
return resource;
}
}
/**
* Takes resource URL containing the {@link ScriptExecutorImpl#PLACEHOLDER_DIALECT dialect placeholder text}
* and substitutes the placeholder with the name of the given dialect's class.
* <p/>
* For example:
* <pre>
* resolveDialectUrl(MySQLInnoDBDialect.class, "classpath:alfresco/db/${db.script.dialect}/myfile.xml")
* </pre>
* would give the following String:
* <pre>
* classpath:alfresco/db/org.hibernate.dialect.MySQLInnoDBDialect/myfile.xml
* </pre>
*
* @param dialectClass
* @param resourceUrl
* @return
*/
private String resolveDialectUrl(Class dialectClass, String resourceUrl)
{
return resourceUrl.replaceAll(PLACEHOLDER_DIALECT, dialectClass.getName());
}
/**
* Replaces the dialect placeholder in the script URL and attempts to find a file for
* it. If not found, the dialect hierarchy will be walked until a compatible script is
* found. This makes it possible to have scripts that are generic to all dialects.
*
* @return Returns an input stream onto the script, otherwise null
*/
private InputStream getScriptInputStream(Class dialectClazz, String scriptUrl) throws Exception
{
Resource resource = getDialectResource(dialectClazz, scriptUrl);
if (resource == null)
{
return null;
}
return resource.getInputStream();
}
/**
* @param cfg the Hibernate configuration
* @param connection the DB connection to use
* @param scriptFile the file containing the statements
* @param scriptUrl the URL of the script to report. If this is null, the script
* is assumed to have been auto-generated.
*/
private void executeScriptFile(
Configuration cfg,
Connection connection,
File scriptFile,
String scriptUrl) throws Exception
{
final Dialect dialect = Dialect.getDialect(cfg.getProperties());
StringBuilder executedStatements = executedStatementsThreadLocal.get();
if (executedStatements == null)
{
executedStatements = new StringBuilder(8094);
executedStatementsThreadLocal.set(executedStatements);
}
if (scriptUrl == null)
{
LogUtil.info(logger, MSG_EXECUTING_GENERATED_SCRIPT, scriptFile);
}
else
{
LogUtil.info(logger, MSG_EXECUTING_COPIED_SCRIPT, scriptFile, scriptUrl);
}
InputStream scriptInputStream = new FileInputStream(scriptFile);
BufferedReader reader = new BufferedReader(new InputStreamReader(scriptInputStream, "UTF-8"));
try
{
int line = 0;
// loop through all statements
StringBuilder sb = new StringBuilder(1024);
String fetchVarName = null;
String fetchColumnName = null;
String batchTableName = null;
boolean doBatch = false;
int batchUpperLimit = 0;
int batchSize = 1;
Map<String, Object> varAssignments = new HashMap<String, Object>(13);
// Special variable assignments:
if (dialect instanceof PostgreSQLDialect)
{
// Needs 1/0 for true/false
varAssignments.put("true", "true");
varAssignments.put("false", "false");
varAssignments.put("TRUE", "TRUE");
varAssignments.put("FALSE", "FALSE");
}
else
{
// Needs true/false as strings
varAssignments.put("true", "1");
varAssignments.put("false", "0");
varAssignments.put("TRUE", "1");
varAssignments.put("FALSE", "0");
}
long now = System.currentTimeMillis();
varAssignments.put("now", new Long(now).toString());
varAssignments.put("NOW", new Long(now).toString());
while(true)
{
String sqlOriginal = reader.readLine();
line++;
if (sqlOriginal == null)
{
// nothing left in the file
break;
}
// trim it
String sql = sqlOriginal.trim();
// Check of includes
if (sql.startsWith("--INCLUDE:"))
{
if (sb.length() > 0)
{
// This can only be set before a new SQL statement
throw AlfrescoRuntimeException.create(ERR_STATEMENT_INCLUDE_BEFORE_SQL, (line - 1), scriptUrl);
}
String includedScriptUrl = sql.substring(10, sql.length());
// Execute the script in line
executeScriptUrl(cfg, connection, includedScriptUrl);
}
// Check for variable assignment
else if (sql.startsWith("--ASSIGN:"))
{
if (sb.length() > 0)
{
// This can only be set before a new SQL statement
throw AlfrescoRuntimeException.create(ERR_STATEMENT_VAR_ASSIGNMENT_BEFORE_SQL, (line - 1), scriptUrl);
}
String assignStr = sql.substring(9, sql.length());
String[] assigns = assignStr.split("=");
if (assigns.length != 2 || assigns[0].length() == 0 || assigns[1].length() == 0)
{
throw AlfrescoRuntimeException.create(ERR_STATEMENT_VAR_ASSIGNMENT_FORMAT, (line - 1), scriptUrl);
}
fetchVarName = assigns[0];
fetchColumnName = assigns[1];
continue;
}
// Handle looping control
else if (sql.startsWith("--FOREACH"))
{
// --FOREACH table.column batch.size.property
String[] args = sql.split("[ \\t]+");
int sepIndex;
if (args.length == 3 && (sepIndex = args[1].indexOf('.')) != -1)
{
doBatch = true;
// Select the upper bound of the table column
batchTableName = args[1].substring(0, sepIndex);
String stmt = "SELECT MAX(" + args[1].substring(sepIndex+1) + ") AS upper_limit FROM " + batchTableName;
Object fetchedVal = executeStatement(connection, stmt, "upper_limit", false, line, scriptFile);
if (fetchedVal instanceof Number)
{
batchUpperLimit = ((Number)fetchedVal).intValue();
// Read the batch size from the named property
String batchSizeString = globalProperties.getProperty(args[2]);
// Fall back to the default property
if (batchSizeString == null)
{
batchSizeString = globalProperties.getProperty(PROPERTY_DEFAULT_BATCH_SIZE);
}
batchSize = batchSizeString == null ? 10000 : Integer.parseInt(batchSizeString);
}
}
continue;
}
// Allow transaction delineation
else if (sql.startsWith("--BEGIN TXN"))
{
connection.setAutoCommit(false);
continue;
}
else if (sql.startsWith("--END TXN"))
{
connection.commit();
connection.setAutoCommit(true);
continue;
}
// Check for comments
if (sql.length() == 0 ||
sql.startsWith( "--" ) ||
sql.startsWith( "//" ) ||
sql.startsWith( "/*" ) )
{
if (sb.length() > 0)
{
// we have an unterminated statement
throw AlfrescoRuntimeException.create(ERR_STATEMENT_TERMINATOR, (line - 1), scriptUrl);
}
// there has not been anything to execute - it's just a comment line
continue;
}
// have we reached the end of a statement?
boolean execute = false;
boolean optional = false;
if (sql.endsWith(";"))
{
sql = sql.substring(0, sql.length() - 1);
execute = true;
optional = false;
}
else if (sql.endsWith("(optional)") || sql.endsWith("(OPTIONAL)"))
{
// Get the end of statement
int endIndex = sql.lastIndexOf(';');
if (endIndex > -1)
{
sql = sql.substring(0, endIndex);
execute = true;
optional = true;
}
else
{
// Ends with "(optional)" but there is no semi-colon.
// Just take it at face value and probably fail.
}
}
// Add newline
if (sb.length() > 0)
{
sb.append("\n");
}
// Add leading whitespace for formatting
int whitespaceCount = sqlOriginal.indexOf(sql);
for (int i = 0; i < whitespaceCount; i++)
{
sb.append(" ");
}
// append to the statement being built up
sb.append(sql);
// execute, if required
if (execute)
{
// Now substitute and execute the statement the appropriate number of times
String unsubstituted = sb.toString();
for(int lowerBound = 0; lowerBound <= batchUpperLimit; lowerBound += batchSize)
{
sql = unsubstituted;
// Substitute in the next pair of range parameters
if (doBatch)
{
logger.info("Processing from " + lowerBound + " to " + (lowerBound + batchSize) + " rows of " + batchUpperLimit + " rows from table " + batchTableName + ".");
varAssignments.put("LOWERBOUND", String.valueOf(lowerBound));
varAssignments.put("UPPERBOUND", String.valueOf(lowerBound + batchSize - 1));
}
// Perform variable replacement using the ${var} format
for (Map.Entry<String, Object> entry : varAssignments.entrySet())
{
String var = entry.getKey();
Object val = entry.getValue();
sql = sql.replaceAll("\\$\\{" + var + "\\}", val.toString());
}
// Handle the 0/1 values that PostgreSQL doesn't translate to TRUE
if (this.dialect != null && this.dialect instanceof PostgreSQLDialect)
{
sql = sql.replaceAll("\\$\\{TRUE\\}", "TRUE");
}
else
{
sql = sql.replaceAll("\\$\\{TRUE\\}", "1");
}
if (this.dialect != null && this.dialect instanceof MySQLInnoDBDialect)
{
// note: enable bootstrap on MySQL 5.5 (eg. for auto-generated SQL, such as JBPM)
sql = sql.replaceAll("(?i)TYPE=InnoDB", "ENGINE=InnoDB");
}
Object fetchedVal = executeStatement(connection, sql, fetchColumnName, optional, line, scriptFile);
if (fetchVarName != null && fetchColumnName != null)
{
varAssignments.put(fetchVarName, fetchedVal);
}
}
sb.setLength(0);
fetchVarName = null;
fetchColumnName = null;
batchTableName = null;
doBatch = false;
batchUpperLimit = 0;
batchSize = 1;
}
}
}
finally
{
try { reader.close(); } catch (Throwable e) {}
try { scriptInputStream.close(); } catch (Throwable e) {}
}
}
/**
* Execute the given SQL statement, absorbing exceptions that we expect during
* schema creation or upgrade.
*
* @param fetchColumnName the name of the column value to return
*/
private Object executeStatement(
Connection connection,
String sql,
String fetchColumnName,
boolean optional,
int line,
File file) throws Exception
{
StringBuilder executedStatements = executedStatementsThreadLocal.get();
if (executedStatements == null)
{
throw new IllegalArgumentException("The executedStatementsThreadLocal must be populated");
}
Statement stmt = connection.createStatement();
Object ret = null;
try
{
if (logger.isDebugEnabled())
{
LogUtil.debug(logger, MSG_EXECUTING_STATEMENT, sql);
}
boolean haveResults = stmt.execute(sql);
// Record the statement
executedStatements.append(sql).append(";\n\n");
if (haveResults && fetchColumnName != null)
{
ResultSet rs = stmt.getResultSet();
if (rs.next())
{
// Get the result value
ret = rs.getObject(fetchColumnName);
}
}
}
catch (SQLException e)
{
if (optional)
{
// it was marked as optional, so we just ignore it
LogUtil.debug(logger, MSG_OPTIONAL_STATEMENT_FAILED, sql, e.getMessage(), file.getAbsolutePath(), line);
}
else
{
LogUtil.error(logger, ERR_STATEMENT_FAILED, sql, e.getMessage(), file.getAbsolutePath(), line);
throw e;
}
}
finally
{
try { stmt.close(); } catch (Throwable e) {}
}
return ret;
}
}

2
source/test-java/org/alfresco/Repository01TestSuite.java
View File

@ -419,6 +419,8 @@ public class Repository01TestSuite extends TestSuite
suite.addTest(new JUnit4TestAdapter(org.alfresco.util.CronTriggerBeanSystemTest.class)); suite.addTest(new JUnit4TestAdapter(org.alfresco.util.CronTriggerBeanSystemTest.class));
suite.addTest(new JUnit4TestAdapter(org.alfresco.filesys.auth.cifs.CifsAuthenticatorKerberosTest.class)); suite.addTest(new JUnit4TestAdapter(org.alfresco.filesys.auth.cifs.CifsAuthenticatorKerberosTest.class));
suite.addTest(new JUnit4TestAdapter(org.alfresco.filesys.auth.cifs.CifsAuthenticatorPassthruTest.class)); suite.addTest(new JUnit4TestAdapter(org.alfresco.filesys.auth.cifs.CifsAuthenticatorPassthruTest.class));
suite.addTest(new JUnit4TestAdapter(org.alfresco.repo.domain.schema.script.ScriptExecutorImplIntegrationTest.class));
suite.addTest(new JUnit4TestAdapter(org.alfresco.repo.domain.schema.script.ScriptBundleExecutorImplIntegrationTest.class));
} }
static void tests65(TestSuite suite) static void tests65(TestSuite suite)

60
source/test-java/org/alfresco/repo/attributes/AttributeServiceTest.java
View File

@ -20,13 +20,18 @@ package org.alfresco.repo.attributes;
import java.io.Serializable; import java.io.Serializable;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Date;
import java.util.List; import java.util.List;
import junit.framework.TestCase; import junit.framework.TestCase;
import org.alfresco.repo.domain.propval.PropValGenerator;
import org.alfresco.repo.domain.propval.PropertyValueDAO;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.service.cmr.attributes.AttributeService; import org.alfresco.service.cmr.attributes.AttributeService;
import org.alfresco.service.cmr.attributes.AttributeService.AttributeQueryCallback; import org.alfresco.service.cmr.attributes.AttributeService.AttributeQueryCallback;
import org.alfresco.util.ApplicationContextHelper; import org.alfresco.util.ApplicationContextHelper;
import org.alfresco.util.Pair;
import org.apache.commons.lang.mutable.MutableInt; import org.apache.commons.lang.mutable.MutableInt;
import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContext;
@ -47,12 +52,14 @@ public class AttributeServiceTest extends TestCase
private ApplicationContext ctx; private ApplicationContext ctx;
private AttributeService attributeService; private AttributeService attributeService;
private PropertyValueDAO propertyValueDAO;
@Override @Override
protected void setUp() throws Exception protected void setUp() throws Exception
{ {
ctx = ApplicationContextHelper.getApplicationContext(); ctx = ApplicationContextHelper.getApplicationContext();
attributeService = (AttributeService) ctx.getBean("AttributeService"); attributeService = (AttributeService) ctx.getBean("AttributeService");
propertyValueDAO = (PropertyValueDAO) ctx.getBean("propertyValueDAO");
} }
@Override @Override
@ -132,4 +139,57 @@ public class AttributeServiceTest extends TestCase
assertEquals(2, results.size()); assertEquals(2, results.size());
assertEquals(2, counter.getValue()); assertEquals(2, counter.getValue());
} }
public void testRemoveOrphanedProps()
{
final Serializable[] stringKey = new String[] { "z", "q", "string" };
final Serializable[] doubleKey = new String[] { "z", "q", "double" };
final Serializable[] dateKey = new String[] { "z", "q", "date" };
// Make sure there's nothing left from previous failed test runs etc.
attributeService.removeAttributes(stringKey);
attributeService.removeAttributes(doubleKey);
attributeService.removeAttributes(dateKey);
final PropValGenerator valueGen = new PropValGenerator(propertyValueDAO);
// Create some values
final String stringValue = valueGen.createUniqueString();
attributeService.createAttribute(stringValue, stringKey);
final Double doubleValue = valueGen.createUniqueDouble();
attributeService.createAttribute(doubleValue, doubleKey);
final Date dateValue = valueGen.createUniqueDate();
attributeService.createAttribute(dateValue, dateKey);
// Remove the properties, potentially leaving oprhaned prop values.
attributeService.removeAttributes(stringKey);
attributeService.removeAttributes(doubleKey);
attributeService.removeAttributes(dateKey);
// Check there are some persisted values to delete, otherwise there is no
// need to run the cleanup script in the first place.
assertEquals(stringValue, propertyValueDAO.getPropertyValue(stringValue).getSecond());
assertEquals(doubleValue, propertyValueDAO.getPropertyValue(doubleValue).getSecond());
assertEquals(dateValue, propertyValueDAO.getPropertyValue(dateValue).getSecond());
// Run the cleanup script - should remove the orphaned values.
propertyValueDAO.cleanupUnusedValues();
// Check that the cleanup script removed the orphaned values.
assertPropDeleted(propertyValueDAO.getPropertyValue(stringValue));
assertPropDeleted(propertyValueDAO.getPropertyValue(doubleValue));
assertPropDeleted(propertyValueDAO.getPropertyValue(dateValue));
}
private void assertPropDeleted(Pair<Long, ?> value)
{
if (value != null)
{
String msg = String.format("Property value [%s=%s] should have been deleted by cleanup script.",
value.getSecond().getClass().getSimpleName(), value.getSecond());
fail(msg);
}
}
} }

79
source/test-java/org/alfresco/repo/attributes/PropTablesCleanupJobIntegrationTest.java Normal file
View File

@ -0,0 +1,79 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.attributes;
import static org.junit.Assert.*;
import java.util.Date;
import org.alfresco.repo.domain.propval.PropertyValueDAO;
import org.alfresco.util.ApplicationContextHelper;
import org.alfresco.util.CronTriggerBean;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.quartz.JobDetail;
import org.quartz.SchedulerException;
import org.springframework.context.ApplicationContext;
import com.ibm.icu.util.Calendar;
/**
* Integration tests for the {@link PropTablesCleanupJob} class.
*
* @author Matt Ward
*/
public class PropTablesCleanupJobIntegrationTest
{
private static ApplicationContext ctx;
private CronTriggerBean jobTrigger;
@BeforeClass
public static void setUpClass()
{
ctx = ApplicationContextHelper.getApplicationContext();
}
@Before
public void setUp() throws Exception
{
jobTrigger = ctx.getBean("propTablesCleanupTrigger", CronTriggerBean.class);
}
@Test
public void checkJobWillNeverRunByDefault() throws Exception
{
Date fireTime = jobTrigger.getTrigger().getFireTimeAfter(new Date());
Calendar calendar = Calendar.getInstance();
// Far into the future, we count this as never.
calendar.setTime(fireTime);
assertEquals(2099, calendar.get(Calendar.YEAR));
}
@Test
public void checkJobDetails()
{
JobDetail jobDetail = jobTrigger.getJobDetail();
assertEquals(PropTablesCleanupJob.class, jobDetail.getJobClass());
assertTrue("JobDetail did not contain PropertyValueDAO reference",
jobDetail.getJobDataMap().get("propertyValueDAO") instanceof PropertyValueDAO);
}
}

63
source/test-java/org/alfresco/repo/attributes/PropTablesCleanupJobTest.java Normal file
View File

@ -0,0 +1,63 @@
package org.alfresco.repo.attributes;
import static org.junit.Assert.*;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import org.alfresco.repo.domain.propval.PropertyValueDAO;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.quartz.JobDetail;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
/**
* Tests for the {@link PropTablesCleanupJob} class.
*
* @author Matt Ward
*/
@RunWith(MockitoJUnitRunner.class)
public class PropTablesCleanupJobTest
{
private PropTablesCleanupJob cleanupJob;
private @Mock JobExecutionContext jobCtx;
private @Mock PropertyValueDAO propValueDAO;
private JobDetail jobDetail;
@Before
public void setUp() throws Exception
{
jobDetail = new JobDetail("propTablesCleanupJob", PropTablesCleanupJob.class);
jobDetail.getJobDataMap().put(PropTablesCleanupJob.PROPERTY_VALUE_DAO_KEY, propValueDAO);
cleanupJob = new PropTablesCleanupJob();
when(jobCtx.getJobDetail()).thenReturn(jobDetail);
}
@Test
public void testExecute() throws JobExecutionException
{
cleanupJob.execute(jobCtx);
verify(propValueDAO).cleanupUnusedValues();
}
@Test(expected=IllegalArgumentException.class)
public void testMissingPropertyValueDAO() throws JobExecutionException
{
jobDetail.getJobDataMap().put(PropTablesCleanupJob.PROPERTY_VALUE_DAO_KEY, null);
cleanupJob.execute(jobCtx);
}
@Test(expected=ClassCastException.class)
public void testWrongTypeForPropertyValueDAO() throws JobExecutionException
{
jobDetail.getJobDataMap().put(PropTablesCleanupJob.PROPERTY_VALUE_DAO_KEY, "This is not a PropertyValueDAO");
cleanupJob.execute(jobCtx);
}
}

174
source/test-java/org/alfresco/repo/domain/audit/AuditDAOTest.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright (C) 2005-2010 Alfresco Software Limited. * Copyright (C) 2005-2014 Alfresco Software Limited.
* *
* This file is part of Alfresco * This file is part of Alfresco
* *
@ -23,16 +23,22 @@ import java.io.IOException;
import java.io.Serializable; import java.io.Serializable;
import java.net.URL; import java.net.URL;
import java.util.Collections; import java.util.Collections;
import java.util.Date;
import java.util.HashMap; import java.util.HashMap;
import java.util.LinkedList; import java.util.LinkedList;
import java.util.List;
import java.util.Map; import java.util.Map;
import javax.transaction.UserTransaction;
import junit.framework.TestCase; import junit.framework.TestCase;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.content.transform.AbstractContentTransformerTest; import org.alfresco.repo.content.transform.AbstractContentTransformerTest;
import org.alfresco.repo.domain.audit.AuditDAO.AuditApplicationInfo; import org.alfresco.repo.domain.audit.AuditDAO.AuditApplicationInfo;
import org.alfresco.repo.domain.contentdata.ContentDataDAO; import org.alfresco.repo.domain.contentdata.ContentDataDAO;
import org.alfresco.repo.domain.propval.PropValGenerator;
import org.alfresco.repo.domain.propval.PropertyValueDAO;
import org.alfresco.repo.transaction.RetryingTransactionHelper; import org.alfresco.repo.transaction.RetryingTransactionHelper;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
@ -62,6 +68,7 @@ public class AuditDAOTest extends TestCase
private TransactionService transactionService; private TransactionService transactionService;
private RetryingTransactionHelper txnHelper; private RetryingTransactionHelper txnHelper;
private AuditDAO auditDAO; private AuditDAO auditDAO;
private PropertyValueDAO propertyValueDAO;
@Override @Override
public void setUp() throws Exception public void setUp() throws Exception
@ -71,6 +78,7 @@ public class AuditDAOTest extends TestCase
txnHelper = transactionService.getRetryingTransactionHelper(); txnHelper = transactionService.getRetryingTransactionHelper();
auditDAO = (AuditDAO) ctx.getBean("auditDAO"); auditDAO = (AuditDAO) ctx.getBean("auditDAO");
propertyValueDAO = ctx.getBean(PropertyValueDAO.class);
} }
public void testAuditModel() throws Exception public void testAuditModel() throws Exception
@ -527,4 +535,168 @@ public class AuditDAOTest extends TestCase
return 0; return 0;
} }
} }
/**
* MNT-10067: use a script to delete the orphaned audit data (property values).
*/
public void testScriptCanDeleteOrphanedProps() throws Exception
{
// single test
scriptCanDeleteOrphanedPropsWork(false);
}
private void scriptCanDeleteOrphanedPropsWork(final boolean performance) throws Exception
{
final int iterationStep, maxIterations;
if (performance)
{
iterationStep = 1000;
maxIterations = 1000;
}
else
{
iterationStep = 1;
maxIterations = 1;
}
UserTransaction txn;
for (int i = iterationStep; i <= maxIterations*iterationStep; i+=iterationStep)
{
List<String> stringValues = new LinkedList<String>();
List<Double> doubleValues = new LinkedList<Double>();
List<Date> dateValues = new LinkedList<Date>();
txn = transactionService.getUserTransaction();
long startCreate = System.currentTimeMillis();
txn.begin();
for (int j = 0; j < i; j++)
{
PropValGenerator valueGen = new PropValGenerator(propertyValueDAO);
String stringValue = valueGen.createUniqueString();
stringValues.add(stringValue);
Double doubleValue = valueGen.createUniqueDouble();
doubleValues.add(doubleValue);
Date dateValue = valueGen.createUniqueDate();
dateValues.add(dateValue);
AuditQueryCallbackImpl preDeleteCallback = new AuditQueryCallbackImpl();
AuditQueryCallbackImpl resultsCallback = new AuditQueryCallbackImpl();
AuditApplicationInfo info1 = createAuditApp();
String app1 = info1.getName();
String username = "alexi";
Map<String, Serializable> values = new HashMap<String, Serializable>();
values.put("/a/b/string-" + j, stringValue);
values.put("/a/b/double-" + j, doubleValue);
values.put("/a/b/date-" + j, dateValue);
// TODO: how to deal with Serializable values which cannot be retrieved later in test by value alone?
long now = System.currentTimeMillis();
auditDAO.createAuditEntry(info1.getId(), now, username, values);
auditDAO.findAuditEntries(preDeleteCallback, new AuditQueryParameters(), -1);
assertEquals(1, preDeleteCallback.numEntries(app1));
// Delete audit entries between times - for all applications.
auditDAO.deleteAuditEntries(info1.getId(), null, null);
if (!performance)
{
auditDAO.findAuditEntries(resultsCallback, new AuditQueryParameters(), -1);
assertEquals("All entries should have been deleted from app1", 0, resultsCallback.numEntries(app1));
}
}
txn.commit();
System.out.println("Created values for " + i + " entries in " + (System.currentTimeMillis() - startCreate) + " ms.");
txn = transactionService.getUserTransaction();
txn.begin();
if (!performance)
{
// Check there are some persisted values to delete.
// Unlike PropertyValueDAOTest we're using the getPropertyValue() method here,
// instead of the datatype-specific methods (e.g. getPropertyStringValue()).
// This is because AuditDAO persists an entire map of values resulting in different behaviour
// (i.e. dates are persisted as Serializable)
for (String stringValue : stringValues)
{
assertEquals(stringValue, propertyValueDAO.getPropertyValue(stringValue).getSecond());
}
for (Double doubleValue : doubleValues)
{
assertEquals(doubleValue, propertyValueDAO.getPropertyValue(doubleValue).getSecond());
}
for (Date dateValue : dateValues)
{
assertEquals(dateValue, propertyValueDAO.getPropertyValue(dateValue).getSecond());
}
}
long startDelete = System.currentTimeMillis();
propertyValueDAO.cleanupUnusedValues();
txn.commit();
System.out.println("Cleaned values for " + i + " entries in " + (System.currentTimeMillis() - startDelete) + " ms.");
if (!performance)
{
// Check all the properties have been deleted.
txn = transactionService.getUserTransaction();
txn.begin();
for (String stringValue : stringValues)
{
assertPropDeleted(propertyValueDAO.getPropertyValue(stringValue));
}
for (Double doubleValue : doubleValues)
{
assertPropDeleted(propertyValueDAO.getPropertyValue(doubleValue));
}
for (Date dateValue : dateValues)
{
assertPropDeleted(propertyValueDAO.getPropertyValue(dateValue));
}
txn.commit();
}
}
}
private void assertPropDeleted(Pair<Long, ?> value)
{
if (value != null)
{
String msg = String.format("Property value [%s=%s] should have been deleted by cleanup script.",
value.getSecond().getClass().getSimpleName(), value.getSecond());
fail(msg);
}
}
public void scriptCanDeleteOrphanedPropsPerformance() throws Exception
{
scriptCanDeleteOrphanedPropsWork(true);
}
public static void main(String[] args)
{
try
{
AuditDAOTest test = new AuditDAOTest();
test.setUp();
System.out.println("Press any key to run performance test.");
System.in.read();
test.scriptCanDeleteOrphanedPropsPerformance();
System.out.println("Press any key to shutdown.");
System.in.read();
test.tearDown();
}
catch (Throwable e)
{
e.printStackTrace();
}
finally
{
ApplicationContextHelper.closeApplicationContext();
}
}
} }

186
source/test-java/org/alfresco/repo/domain/propval/PropValGenerator.java Normal file
View File

@ -0,0 +1,186 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.domain.propval;
import static org.junit.Assert.assertNotNull;
import java.io.Serializable;
import java.util.Date;
import java.util.Random;
import java.util.UUID;
import org.alfresco.util.Pair;
/**
* Creates property values suitable for use in testing.
*
* @author Matt Ward
*/
public class PropValGenerator
{
private static final Random rand = new Random();
private final PropertyValueDAO propertyValueDAO;
private final DoubleGen doubleGen = new DoubleGen();
private final DateGen dateGen = new DateGen();
private final SerializableGen serGen = new SerializableGen();
public PropValGenerator(PropertyValueDAO propertyValueDAO)
{
this.propertyValueDAO = propertyValueDAO;
}
public String createUniqueString()
{
// No need to do anything more clever than create a UUID.
return UUID.randomUUID().toString();
}
public Double createUniqueDouble()
{
return doubleGen.getUnusedValue();
}
public Date createUniqueDate()
{
return dateGen.getUnusedValue();
}
public Serializable createUniqueSerializable()
{
return serGen.getUnusedValue();
}
private class DoubleGen extends UniqueValueGenerator<Double>
{
@Override
protected Double createValue()
{
return (Math.pow(2,32)) + (rand.nextDouble() * (Math.pow(2,32) - Math.pow(2,31)));
}
@Override
protected Pair<Long, Double> getExistingValue(Double value)
{
return propertyValueDAO.getPropertyDoubleValue(value);
}
}
private class DateGen extends UniqueValueGenerator<Date>
{
@Override
protected Date createValue()
{
Random rand = new Random();
Date date = new Date(rand.nextLong());
// Dates are stored to day precision, make sure we return the
// same value that will be stored, for comparison in assert statements etc.
Date truncDate = PropertyDateValueEntity.truncateDate(date);
return truncDate;
}
@Override
protected Pair<Long, Date> getExistingValue(Date value)
{
return propertyValueDAO.getPropertyDateValue(value);
}
}
private class SerializableGen extends UniqueValueGenerator<Serializable>
{
@Override
protected Serializable createValue()
{
return new MySerializable();
}
@Override
protected Pair<Long, Serializable> getExistingValue(Serializable value)
{
return propertyValueDAO.getPropertyValue(value);
}
}
private static class MySerializable implements Serializable
{
private static final long serialVersionUID = 1L;
private final Long val;
public MySerializable()
{
val = rand.nextLong();
}
@Override
public int hashCode()
{
final int prime = 31;
int result = 1;
result = prime * result + ((this.val == null) ? 0 : this.val.hashCode());
return result;
}
@Override
public boolean equals(Object obj)
{
if (this == obj) return true;
if (obj == null) return false;
if (getClass() != obj.getClass()) return false;
MySerializable other = (MySerializable) obj;
if (this.val == null)
{
if (other.val != null) return false;
}
else if (!this.val.equals(other.val)) return false;
return true;
}
}
/**
* Generate values that aren't currently in the properties tables. By trying random values
* several times until an unused value is used. This is to help avoid red builds, since the
* assumption by the orphaned property cleanup test is that the properties are not in use
* (otherwise they won't be cleaned up!)
*/
private abstract class UniqueValueGenerator<T>
{
private final int maxTries = 5;
protected abstract T createValue();
protected abstract Pair<Long, T> getExistingValue(T value);
public T getUnusedValue()
{
int tries = 0;
T value = null;
boolean exists = true;
while (exists)
{
if (++tries > maxTries)
{
throw new RuntimeException("Unable to generate unused value in " + maxTries + " tries.");
}
value = createValue();
assertNotNull("Value generator should not generate a null value, but did.", value);
// Make sure the value isn't already present in the properties tables.
exists = (getExistingValue(value) != null);
}
return value;
}
}
}

81
source/test-java/org/alfresco/repo/domain/propval/PropertyValueDAOTest.java
View File

@ -44,6 +44,7 @@ import org.alfresco.util.GUID;
import org.alfresco.util.Pair; import org.alfresco.util.Pair;
import org.junit.experimental.categories.Category; import org.junit.experimental.categories.Category;
import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContext;
import org.springframework.dao.DataIntegrityViolationException;
import org.springframework.extensions.surf.util.ISO8601DateFormat; import org.springframework.extensions.surf.util.ISO8601DateFormat;
/** /**
@ -874,4 +875,84 @@ public class PropertyValueDAOTest extends TestCase
}, false); }, false);
assertEquals("ID-value pair incorrect", v2Pair, pair); assertEquals("ID-value pair incorrect", v2Pair, pair);
} }
/**
* MNT-10067: use a script to delete the orphaned property values.
*/
public void testScriptCanDeleteUnusedProps()
{
PropValGenerator valueGen = new PropValGenerator(propertyValueDAO);
// Find some values to use in the test that aren't already in the property tables.
final String stringValue = valueGen.createUniqueString();
final Double doubleValue = valueGen.createUniqueDouble();
final Date dateValue = valueGen.createUniqueDate();
final Serializable serValue = valueGen.createUniqueSerializable();
// We'll keep a list of the DB IDs of the persisted values so we can later check they've been deleted.
final Map<Object, Long> persistedIDs = new HashMap<Object, Long>();
txnHelper.doInTransaction(new RetryingTransactionCallback<Void>()
{
public Void execute() throws Throwable
{
persistedIDs.put(stringValue, propertyValueDAO.getOrCreatePropertyStringValue(stringValue).getFirst());
persistedIDs.put(doubleValue, propertyValueDAO.getOrCreatePropertyDoubleValue(doubleValue).getFirst());
persistedIDs.put(dateValue, propertyValueDAO.getOrCreatePropertyDateValue(dateValue).getFirst());
persistedIDs.put(serValue, propertyValueDAO.getOrCreatePropertyValue(serValue).getFirst());
return null;
}
});
// Run the clean-up script.
txnHelper.doInTransaction(new RetryingTransactionCallback<Void>()
{
public Void execute() throws Throwable
{
// Check there are some persisted values to delete.
assertEquals(stringValue, propertyValueDAO.getPropertyStringValue(stringValue).getSecond());
assertEquals(doubleValue, propertyValueDAO.getPropertyDoubleValue(doubleValue).getSecond());
assertEquals(dateValue, propertyValueDAO.getPropertyDateValue(dateValue).getSecond());
// Serializable values are the odd-one-out; we can't query for them by value
// and no de-duplication is used during storage.
assertEquals(serValue, propertyValueDAO.getPropertyValueById(persistedIDs.get(serValue)).getSecond());
propertyValueDAO.cleanupUnusedValues();
return null;
}
});
// Check all the properties have been deleted.
txnHelper.doInTransaction(new RetryingTransactionCallback<Void>()
{
public Void execute() throws Throwable
{
assertPropDeleted(propertyValueDAO.getPropertyStringValue(stringValue));
assertPropDeleted(propertyValueDAO.getPropertyDoubleValue(doubleValue));
// TODO: fix date deletion, not currently handled by CleanAlfPropTables.sql
// assertPropDeleted(propertyValueDAO.getPropertyDateValue(dateValue));
// Serializable values cannot be queried by value
try
{
propertyValueDAO.getPropertyValueById(persistedIDs.get(serValue));
fail(String.format("Persisted %s was not deleted, but should have been.",
serValue.getClass().getSimpleName()));
}
catch (DataIntegrityViolationException e)
{
// Good - it was deleted.
}
return null;
}
});
}
private void assertPropDeleted(Pair<Long, ?> value)
{
if (value != null)
{
String msg = String.format("Property value [%s=%s] should have been deleted by cleanup script.",
value.getSecond().getClass().getSimpleName(), value.getSecond());
fail(msg);
}
}
} }

90
source/test-java/org/alfresco/repo/domain/schema/script/ScriptBundleExecutorImplIntegrationTest.java Normal file
View File

@ -0,0 +1,90 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.domain.schema.script;
import static org.junit.Assert.assertEquals;
import java.util.List;
import javax.sql.DataSource;
import org.alfresco.util.ApplicationContextHelper;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.jdbc.core.JdbcTemplate;
/**
* Integration tests for the {@link ScriptBundleExecutorImpl} class.
*
* @author Matt Ward
*/
public class ScriptBundleExecutorImplIntegrationTest
{
private static ApplicationContext ctx;
private ScriptBundleExecutor bundleExecutor;
private DataSource dataSource;
private JdbcTemplate jdbcTmpl;
@BeforeClass
public static void setUpBeforeClass() throws Exception
{
String[] config = new String[] {
"classpath:alfresco/application-context.xml",
"classpath:scriptexec/script-exec-test.xml"
};
ctx = ApplicationContextHelper.getApplicationContext(config);
}
@Before
public void setUp() throws Exception
{
bundleExecutor = ctx.getBean("bundleExecutor", ScriptBundleExecutorImpl.class);
dataSource = ctx.getBean("dataSource", DataSource.class);
jdbcTmpl = new JdbcTemplate(dataSource);
}
@Test
public void canExecuteBundle()
{
bundleExecutor.exec("scriptexec/${db.script.dialect}/bundle", "script_a.sql", "script_b.sql", "script_c.sql");
String select = "select message from alf_test_bundle order by message asc";
List<String> res = jdbcTmpl.queryForList(select, String.class);
assertEquals(2, res.size());
// script_c deleted "script_a message 1"
assertEquals("script_a message 2", res.get(0));
assertEquals("script_b", res.get(1));
}
@Test
public void postScriptIsRunFinallyEvenAfterEarlierFailure()
{
// script_b.sql will fail
bundleExecutor.execWithPostScript("scriptexec/${db.script.dialect}/bundle2",
"post_script.sql", "script_a.sql", "script_b.sql");
String select = "select message from alf_test_bundle2 order by message asc";
List<String> res = jdbcTmpl.queryForList(select, String.class);
assertEquals(1, res.size());
// post_script deleted "script_a message 1"
assertEquals("script_a message 2", res.get(0));
}
}

93
source/test-java/org/alfresco/repo/domain/schema/script/ScriptBundleExecutorImplTest.java Normal file
View File

@ -0,0 +1,93 @@
/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.domain.schema.script;
import static org.junit.Assert.*;
import static org.mockito.Matchers.anyString;
import static org.mockito.Matchers.same;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import org.apache.commons.logging.Log;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InOrder;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.runners.MockitoJUnitRunner;
/**
* Unit tests for the {@link ScriptBundleExecutorImpl} class.
*
* @author Matt Ward
*/
@RunWith(MockitoJUnitRunner.class)
public class ScriptBundleExecutorImplTest
{
// Class under test
private ScriptBundleExecutorImpl bundleExecutor;
private @Mock ScriptExecutor scriptExecutor;
private @Mock Log log;
@BeforeClass
public static void setUpClass() throws Exception
{
}
@Before
public void setUp() throws Exception
{
bundleExecutor = new ScriptBundleExecutorImpl(scriptExecutor);
bundleExecutor.log = log;
}
@Test
public void canExecuteMultipleScripts() throws Exception
{
bundleExecutor.exec("/path/to/script/dir", "one.sql", "two.sql", "three.sql");
InOrder inOrder = Mockito.inOrder(scriptExecutor);
inOrder.verify(scriptExecutor).executeScriptUrl("/path/to/script/dir/one.sql");
inOrder.verify(scriptExecutor).executeScriptUrl("/path/to/script/dir/two.sql");
inOrder.verify(scriptExecutor).executeScriptUrl("/path/to/script/dir/three.sql");
}
@Test
public void willAlwaysRunPostBatchScript() throws Exception
{
// The first of the "main" scripts will fail...
Exception e = new RuntimeException("Script failure!");
doThrow(e).when(scriptExecutor).executeScriptUrl("/path/to/script/dir/work01.sql");
bundleExecutor.execWithPostScript("/path/to/script/dir", "post.sql", "pre.sql", "work01.sql", "work02.sql");
InOrder inOrder = Mockito.inOrder(scriptExecutor);
inOrder.verify(scriptExecutor).executeScriptUrl("/path/to/script/dir/pre.sql");
inOrder.verify(scriptExecutor).executeScriptUrl("/path/to/script/dir/work01.sql");
// work02.sql will NOT be executed, but the post-script will be.
inOrder.verify(scriptExecutor, never()).executeScriptUrl("/path/to/script/dir/work02.sql");
inOrder.verify(scriptExecutor).executeScriptUrl("/path/to/script/dir/post.sql");
verify(log).error(anyString(), same(e));
}
}

158
source/test-java/org/alfresco/repo/domain/schema/script/ScriptExecutorImplIntegrationTest.java Normal file
View File

@ -0,0 +1,158 @@
package org.alfresco.repo.domain.schema.script;
import static org.junit.Assert.assertEquals;
import java.util.List;
import javax.sql.DataSource;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.util.ApplicationContextHelper;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.hibernate.dialect.Dialect;
import org.hibernate.dialect.MySQLInnoDBDialect;
import org.hibernate.dialect.PostgreSQLDialect;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.jdbc.core.JdbcTemplate;
/**
* Integration tests for the {@link ScriptExecutorImpl} class.
*
* @author Matt Ward
*/
public class ScriptExecutorImplIntegrationTest
{
private final static Log log = LogFactory.getLog(ScriptExecutorImplIntegrationTest.class);
private static ApplicationContext ctx;
private ScriptExecutor scriptExecutor;
private DataSource dataSource;
private JdbcTemplate jdbcTmpl;
private Dialect dialect;
@BeforeClass
public static void setUpBeforeClass() throws Exception
{
String[] config = new String[] {
"classpath:alfresco/application-context.xml",
"classpath:scriptexec/script-exec-test.xml"
};
ctx = ApplicationContextHelper.getApplicationContext(config);
}
@Before
public void setUp() throws Exception
{
scriptExecutor = ctx.getBean("simpleScriptExecutor", ScriptExecutorImpl.class);
dataSource = ctx.getBean("dataSource", DataSource.class);
dialect = ctx.getBean("dialect", Dialect.class);
jdbcTmpl = new JdbcTemplate(dataSource);
}
/**
* Check that we can execute a simple script, without any dialect-specific loading.
*
* @throws Exception
*/
@Test
public void canExecuteBasicScript() throws Exception
{
scriptExecutor.executeScriptUrl("scriptexec/basic.sql");
String select = "select textfield from alf_test_script_exec order by textfield asc";
List<String> res = jdbcTmpl.queryForList(select, String.class);
assertEquals(2, res.size());
assertEquals("hello", res.get(0));
assertEquals("world", res.get(1));
}
/**
* Check that a script designed to be run for all varieties of DBMS
* (i.e. in subdirectory org.hibernate.dialect.Dialect) will run
* regardless of specific dialect (e.g. MySQL or PostgreSQL)
*
* @throws Exception
*/
@Test
public void canExecuteGenericDialectScript() throws Exception
{
scriptExecutor.executeScriptUrl("scriptexec/${db.script.dialect}/generic.sql");
String select = "select message from alf_test_script_exec_generic";
List<String> res = jdbcTmpl.queryForList(select, String.class);
assertEquals(1, res.size());
assertEquals("generic", res.get(0));
}
/**
* Test the case of executing a specific (e.g. PostgreSQL) database script
* when no general script is present (therefore no overriding mechanism is required).
*
* @throws Exception
*/
@Test
public void canExecuteSpecificDialectScript() throws Exception
{
scriptExecutor.executeScriptUrl("scriptexec/${db.script.dialect}/specific.sql");
String select = "select message from alf_test_script_exec_specific";
List<String> res = jdbcTmpl.queryForList(select, String.class);
assertEquals(1, res.size());
if (dialect.getClass().equals(MySQLInnoDBDialect.class))
{
assertEquals("mysql", res.get(0));
}
else if (dialect.getClass().equals(PostgreSQLDialect.class))
{
assertEquals("postgresql", res.get(0));
}
else
{
log.warn("No suitable dialect-specific DB script for test canExecuteSpecificDialectScript()");
}
}
/**
* Test the case of executing a specific database script (e.g. PostgreSQL) when
* a more generic script also exists -- the more generic script is not run.
*
* @throws Exception
*/
@Test
public void canExecuteSpecificDialectOverridingGenericScript() throws Exception
{
scriptExecutor.executeScriptUrl("scriptexec/${db.script.dialect}/override.sql");
String select = "select message from alf_test_script_exec_override";
List<String> res = jdbcTmpl.queryForList(select, String.class);
assertEquals(1, res.size());
if (dialect.getClass().equals(MySQLInnoDBDialect.class))
{
assertEquals("mysql", res.get(0));
}
else if (dialect.getClass().equals(PostgreSQLDialect.class))
{
assertEquals("postgresql", res.get(0));
}
else
{
log.warn("No suitable dialect-specific DB script for test canExecuteSpecificDialectOverridingGenericScript()");
}
}
@Test()
public void exceptionThrownWhenNoMatchingScriptFound() throws Exception
{
try
{
scriptExecutor.executeScriptUrl("scriptexec/${db.script.dialect}/non-existent-file.sql");
}
catch (AlfrescoRuntimeException e)
{
assertEquals("schema.update.err.script_not_found", e.getMsgId());
}
}
}

12
source/test-resources/scriptexec/basic.sql Normal file
View File

@ -0,0 +1,12 @@
-- Simple test of the script executor functionality.
drop table alf_test_script_exec; --(optional)
create table alf_test_script_exec
(
textfield VARCHAR(255)
);
insert into alf_test_script_exec (textfield) values ('hello');
insert into alf_test_script_exec (textfield) values ('world');

9
source/test-resources/scriptexec/org.hibernate.dialect.Dialect/bundle/script_a.sql Normal file
View File

@ -0,0 +1,9 @@
drop table alf_test_bundle; --(optional)
create table alf_test_bundle
(
message VARCHAR(255)
);
insert into alf_test_bundle (message) values ('script_a message 1');
insert into alf_test_bundle (message) values ('script_a message 2');

1
source/test-resources/scriptexec/org.hibernate.dialect.Dialect/bundle/script_b.sql Normal file
View File

@ -0,0 +1 @@
insert into alf_test_bundle (message) values ('script_b');

1
source/test-resources/scriptexec/org.hibernate.dialect.Dialect/bundle/script_c.sql Normal file
View File

@ -0,0 +1 @@
delete from alf_test_bundle where message = 'script_a message 1';

1
source/test-resources/scriptexec/org.hibernate.dialect.Dialect/bundle2/post_script.sql Normal file
View File

@ -0,0 +1 @@
delete from alf_test_bundle2 where message = 'script_a message 1';

9
source/test-resources/scriptexec/org.hibernate.dialect.Dialect/bundle2/script_a.sql Normal file
View File

@ -0,0 +1,9 @@
drop table alf_test_bundle2; --(optional)
create table alf_test_bundle2
(
message VARCHAR(255)
);
insert into alf_test_bundle2 (message) values ('script_a message 1');
insert into alf_test_bundle2 (message) values ('script_a message 2');

2
source/test-resources/scriptexec/org.hibernate.dialect.Dialect/bundle2/script_b.sql Normal file
View File

@ -0,0 +1,2 @@
-- Note the deliberate typo - this script MUST fail!
insert int alf_test_bundle2 (message) values ('script_b');

8
source/test-resources/scriptexec/org.hibernate.dialect.Dialect/generic.sql Normal file
View File

@ -0,0 +1,8 @@
drop table alf_test_script_exec_generic; --(optional)
create table alf_test_script_exec_generic
(
message VARCHAR(255)
);
insert into alf_test_script_exec_generic (message) values ('generic');

8
source/test-resources/scriptexec/org.hibernate.dialect.Dialect/override.sql Normal file
View File

@ -0,0 +1,8 @@
drop table alf_test_script_exec_override; --(optional)
create table alf_test_script_exec_override
(
message VARCHAR(255)
);
insert into alf_test_script_exec_override (message) values ('FAILURE! script should not have been run.');

8
source/test-resources/scriptexec/org.hibernate.dialect.MySQLInnoDBDialect/override.sql Normal file
View File

@ -0,0 +1,8 @@
drop table alf_test_script_exec_override; --(optional)
create table alf_test_script_exec_override
(
message VARCHAR(255)
);
insert into alf_test_script_exec_override (message) values ('mysql');

8
source/test-resources/scriptexec/org.hibernate.dialect.MySQLInnoDBDialect/specific.sql Normal file
View File

@ -0,0 +1,8 @@
drop table alf_test_script_exec_specific; --(optional)
create table alf_test_script_exec_specific
(
message VARCHAR(255)
);
insert into alf_test_script_exec_specific (message) values ('mysql');

8
source/test-resources/scriptexec/org.hibernate.dialect.PostgreSQLDialect/override.sql Normal file
View File

@ -0,0 +1,8 @@
drop table alf_test_script_exec_override; --(optional)
create table alf_test_script_exec_override
(
message VARCHAR(255)
);
insert into alf_test_script_exec_override (message) values ('postgresql');

8
source/test-resources/scriptexec/org.hibernate.dialect.PostgreSQLDialect/specific.sql Normal file
View File

@ -0,0 +1,8 @@
drop table alf_test_script_exec_specific; --(optional)
create table alf_test_script_exec_specific
(
message VARCHAR(255)
);
insert into alf_test_script_exec_specific (message) values ('postgresql');

23
source/test-resources/scriptexec/script-exec-test.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="simpleScriptExecutor" class="org.alfresco.repo.domain.schema.script.ScriptExecutorImpl">
<property name="dataSource">
<ref bean="dataSource" />
</property>
<property name="localSessionFactory">
<ref bean="&amp;sessionFactory"></ref> <!-- inject the actual factory, not a session -->
</property>
<property name="dialect">
<ref bean="dialect" />
</property>
<property name="globalProperties">
<ref bean="global-properties" />
</property>
</bean>
<bean id="bundleExecutor" class="org.alfresco.repo.domain.schema.script.ScriptBundleExecutorImpl">
<constructor-arg ref="simpleScriptExecutor"/>
</bean>
</beans>