SystemSetup Annotation: When are the methods run?

The SystemSetup annotation is used to run import data, synchronize catalogues, migrate CMS components and execute Java code during every project or essential data creation step.

In past versions the essential and project data steps weren't run during the initialization of the junit tenant. This prevented the import of test data for the integration tests if you weren't using the Areco deployment script manager as patch system. To get an updated picture of the current situation, I ran a test on the latest SAP hybris versions and here are the results:

SystemSetup.Process	INIT			UPDATE			ALL			.
SystemSetup.Type	ESSENTIAL	PROJECT	ALL	ESSENTIAL	PROJECT	ALL	ESSENTIAL	PROJECT	ALL	What Hybris impexes are imported?
ant initialize -Dtenant=master	Called once with extension arecosystemsetuptest, process INIT and type ESSENTIAL	Called once with extension arecosystemsetuptest, process INIT and type PROJECT	Called twice with extension arecosystemsetuptest, process INIT and type ESSENTIAL and with extension arecosystemsetuptest, process INIT and type PROJECT	No call			Called once with extension arecosystemsetuptest, process INIT and type ESSENTIAL	Called once with extension arecosystemsetuptest, process INIT and type PROJECT	Called twice with extension arecosystemsetuptest, process INIT and type ESSENTIAL and with extension arecosystemsetuptest, process INIT and type PROJECT	Project and essential scripts
ant initialize -Dtenant=junit	No call									None
ant yunitinit	No call									None
ant updatesystem -Dtenant=master1)	No call			Called once with extension arecosystemsetuptest, process UPDATE and type ESSENTIAL	Called once with extension arecosystemsetuptest, process UPDATE and type PROJECT	Called twice with extension arecosystemsetuptest, process UPDATE and type ESSENTIAL and with extension arecosystemsetuptest, process UPDATE and type PROJECT	Called once with extension arecosystemsetuptest, process UPDATE and type ESSENTIAL	Called once with extension arecosystemsetuptest, process UPDATE and type PROJECT	Called twice with extension arecosystemsetuptest, process INIT and type ESSENTIAL and with extension arecosystemsetuptest, process INIT and type PROJECT	Project and essential scripts
ant updatesystem -Dtenant=junit2)	1	2	3	4	5	6	7	8	9
On HAC, initialize of the master tenant	1	2	3	4	5	6	7	8	9
On HAC, initialize of the master yunit	1	2	3	4	5	6	7	8	9
On HAC, update running system of the master tenant	1	2	3	4	5	6	7	8	9
On HAC, update running system of the master yunit	1	2	3	4	5	6	7	8	9

I created a new extension based on the templa yempty and added the property “initialpassword.admin=nimda” to the local.properies. Then I create a class for the test and annotated at class level with:

@SystemSetup(extension = "ALL_EXTENSIONS")
public class SystemSetupAnnotationCallsTest {

Each method contains the following code for all possible combinations of process and type:

@SystemSetup(process = SystemSetup.Process.UPDATE, type = SystemSetup.Type.ESSENTIAL)
public void logUpdateEssential(final SystemSetupContext hybrisContext) {
  LOG.error(String.format("Called Update Essential with extension %s, process %s and type %s", hybrisContext.getExtensionName(), hybrisContext.getProcess(), hybrisContext.getType()));
}

I ran all ant commands and process on HAC and I analysed the log afterwards:

ant initialize -Dtenant=master | tee initializeMaster.log | grep SystemSetupAnnotationCallsTest

– Based on SAP hybris 1905