@SuppressWarnings({
"PMD.SignatureDeclareThrowsException",
"PMD.TooManyMethods",
"PMD.AvoidDuplicateLiterals",
"PMD.LooseCoupling",
"PMD.MoreThanOneLogger"
})
public class BPInstanceConfigTest {
private static final Logger INSTANCE_CONFIG_LOGGER =
Logger.getLogger(BPInstanceConfig.class.getCanonicalName());
private static Level originalLogLevel;
private static final Logger CALLABLE_PUBLISHER_LOGGER =
Logger.getLogger(BPCallablePublisher.class.getCanonicalName());
private static Level publisherOriginalLogLevel;
@BeforeClass
public static void before() {
originalLogLevel = INSTANCE_CONFIG_LOGGER.getLevel();
publisherOriginalLogLevel = CALLABLE_PUBLISHER_LOGGER.getLevel();
INSTANCE_CONFIG_LOGGER.setLevel(Level.OFF);
CALLABLE_PUBLISHER_LOGGER.setLevel(Level.OFF);
}
@AfterClass
public static void after() {
INSTANCE_CONFIG_LOGGER.setLevel(originalLogLevel);
CALLABLE_PUBLISHER_LOGGER.setLevel(publisherOriginalLogLevel);
}
private final AbstractBuild build = Mockito.mock(AbstractBuild.class);
private final BPBuildInfo buildInfo = new BPBuildInfoFactory().createEmpty();
private final IMocksControl mockControl = EasyMock.createStrictControl();
private final BPHostConfigurationAccess mockHostConfigurationAccess =
Mockito.mock(BPHostConfigurationAccess.class);
private final BPHostConfiguration hostConfiguration =
new BPHostConfigurationFactory().create("TEST-CONFIG");
private final ArrayList<BapPublisher> publishers = new ArrayList<BapPublisher>();
@Before
public void setUp() throws Exception {
Mockito.when(mockHostConfigurationAccess.getConfiguration(Mockito.anyString()))
.thenReturn(hostConfiguration);
buildInfo.setBaseDirectory(buildInfo.getCurrentBuildEnv().getBaseDirectory());
buildInfo.setEnvVars(buildInfo.getCurrentBuildEnv().getEnvVars());
buildInfo.setBuildTime(buildInfo.getCurrentBuildEnv().getBuildTime());
}
@Test
public void testPerformReturnsSuccessIfNoExceptionsThrown() throws Exception {
final BPInstanceConfig instanceConfig = createInstanceConfig(publishers, false, false, false);
instanceConfig.setHostConfigurationAccess(mockHostConfigurationAccess);
final BapPublisher mockPublisher = createAndAddMockPublisher(hostConfiguration.getName());
mockPublisher.perform(hostConfiguration, buildInfo);
assertResult(Result.SUCCESS, instanceConfig);
}
@Test
public void testPerformReturnsUnstableAndDoesNotInvokeOtherPublishers() throws Exception {
final BapPublisher mockPub1 = createAndAddMockPublisher(hostConfiguration.getName());
mockPub1.perform(hostConfiguration, buildInfo);
EasyMock.expectLastCall().andThrow(new RuntimeException("Bad stuff here!"));
createAndAddMockPublisher(null);
final BPInstanceConfig instanceConfig = createInstanceConfig(publishers, false, false, false);
instanceConfig.setHostConfigurationAccess(mockHostConfigurationAccess);
assertResult(Result.UNSTABLE, instanceConfig);
}
@Test
public void testPerformReturnsUnstableAndInvokesOtherPublishersWhenContinueOnErrorSet()
throws Exception {
final BapPublisher mockPub1 = createAndAddMockPublisher(hostConfiguration.getName());
mockPub1.perform(hostConfiguration, buildInfo);
EasyMock.expectLastCall().andThrow(new RuntimeException("Bad stuff here!"));
final BapPublisher mockPub2 = createAndAddMockPublisher(hostConfiguration.getName());
mockPub2.perform(hostConfiguration, buildInfo);
final BPInstanceConfig instanceConfig = createInstanceConfig(publishers, true, false, false);
instanceConfig.setHostConfigurationAccess(mockHostConfigurationAccess);
assertResult(Result.UNSTABLE, instanceConfig);
}
@Test
public void testPerformReturnsUnstableWhenNoHostConfigFound() throws Exception {
final BapPublisher mockPublisher = createAndAddMockPublisher(null);
mockPublisher.setEffectiveEnvironmentInBuildInfo(
(AbstractBuild) EasyMock.anyObject(), (BPBuildInfo) EasyMock.anyObject());
EasyMock.expect(mockPublisher.getConfigName()).andReturn(hostConfiguration.getName());
Mockito.reset(mockHostConfigurationAccess);
Mockito.when(mockHostConfigurationAccess.getConfiguration(hostConfiguration.getName()))
.thenReturn(null);
final BPInstanceConfig instanceConfig = createInstanceConfig(publishers, false, false, false);
instanceConfig.setHostConfigurationAccess(mockHostConfigurationAccess);
assertResult(Result.UNSTABLE, instanceConfig);
Mockito.verify(mockHostConfigurationAccess).getConfiguration(hostConfiguration.getName());
}
@Test
public void testPerformReturnsFailureIfFailOnError() throws Exception {
final BapPublisher mockPub1 = createAndAddMockPublisher(hostConfiguration.getName());
mockPub1.perform(hostConfiguration, buildInfo);
EasyMock.expectLastCall().andThrow(new RuntimeException("Bad stuff here!"));
createAndAddMockPublisher(null);
final BPInstanceConfig instanceConfig = createInstanceConfig(publishers, false, true, false);
instanceConfig.setHostConfigurationAccess(mockHostConfigurationAccess);
assertResult(Result.FAILURE, instanceConfig);
}
private BapPublisher createAndAddMockPublisher(final String hostConfigurationName) {
final BapPublisher mockPublisher = mockControl.createMock(BapPublisher.class);
if (hostConfigurationName != null) {
mockPublisher.setEffectiveEnvironmentInBuildInfo(
(AbstractBuild) EasyMock.anyObject(), (BPBuildInfo) EasyMock.anyObject());
EasyMock.expect(mockPublisher.getConfigName()).andReturn(hostConfigurationName);
}
publishers.add(mockPublisher);
return mockPublisher;
}
private void assertResult(final Result expectedResult, final BPInstanceConfig instanceConfig) {
mockControl.replay();
assertEquals(expectedResult, instanceConfig.perform(build, buildInfo));
mockControl.verify();
}
@Test
public void testGiveMasterANodeName() throws Exception {
assertFixNodeName("", "MASTER", "MASTER");
}
@Test
public void testGiveMasterANodeNameWasNull() throws Exception {
assertFixNodeName(null, "MASTER", "MASTER");
}
@Test
public void testDoNotAffectNodeNameIfMasterNodeNameNotSet() throws Exception {
assertFixNodeName("", null, "");
}
@Test
public void testDoNotAffectNodeNameIfMasterNodeNameNotSetNull() throws Exception {
assertFixNodeName(null, "", null);
}
@Test
public void testDoNotAffectNodeNameIfHasValue() throws Exception {
assertFixNodeName("bob", "master", "bob");
}
private void assertFixNodeName(
final String nodeName, final String masterNodeName, final String expectedNodeName)
throws Exception {
assertFixNodeName(
buildInfo.getCurrentBuildEnv().getEnvVars(), nodeName, masterNodeName, expectedNodeName);
}
@Test
public void testGiveMasterANodeNameForPromotion() throws Exception {
assertFixPromotionNodeName("", "MASTER", "MASTER");
}
@Test
public void testGiveMasterANodeNameWasNullForPromotion() throws Exception {
assertFixPromotionNodeName(null, "MASTER", "MASTER");
}
@Test
public void testDoNotAffectNodeNameIfMasterNodeNameNotSetForPromotion() throws Exception {
assertFixPromotionNodeName("", null, "");
}
@Test
public void testDoNotAffectNodeNameIfMasterNodeNameNotSetNullForPromotion() throws Exception {
assertFixPromotionNodeName(null, "", null);
}
@Test
public void testDoNotAffectNodeNameIfHasValueForPromotion() throws Exception {
assertFixPromotionNodeName("bob", "master", "bob");
}
private void assertFixPromotionNodeName(
final String nodeName, final String masterNodeName, final String expectedNodeName)
throws Exception {
final BPBuildEnv target = new BPBuildInfoFactory().createEmptyBuildEnv();
buildInfo.setTargetBuildEnv(target);
assertFixNodeName(target.getEnvVars(), nodeName, masterNodeName, expectedNodeName);
}
private void assertFixNodeName(
final Map<String, String> envVars,
final String nodeName,
final String masterNodeName,
final String expectedNodeName)
throws Exception {
envVars.put(BPBuildInfo.ENV_NODE_NAME, nodeName);
final BPInstanceConfig instanceConfig =
createInstanceConfig(publishers, false, false, false, masterNodeName);
instanceConfig.setHostConfigurationAccess(mockHostConfigurationAccess);
final BapPublisher mockPublisher = createAndAddMockPublisher(hostConfiguration.getName());
mockPublisher.perform(hostConfiguration, buildInfo);
assertResult(Result.SUCCESS, instanceConfig);
assertEquals(expectedNodeName, envVars.get(BPBuildInfo.ENV_NODE_NAME));
}
@Test
public void testDoNotCreateNodeName() throws Exception {
final BPInstanceConfig instanceConfig =
createInstanceConfig(publishers, false, false, false, "master");
instanceConfig.setHostConfigurationAccess(mockHostConfigurationAccess);
final BapPublisher mockPublisher = createAndAddMockPublisher(hostConfiguration.getName());
mockPublisher.perform(hostConfiguration, buildInfo);
assertResult(Result.SUCCESS, instanceConfig);
assertFalse(buildInfo.getCurrentBuildEnv().getEnvVars().containsKey(BPBuildInfo.ENV_NODE_NAME));
}
@Test
public void testParameterizedPublishing() throws Exception {
final String paramName = "PUB_PATTERN";
final ParamPublish paramPublish = new ParamPublish(paramName);
buildInfo.getCurrentBuildEnv().getEnvVars().put(paramName, "Bill|Ted");
final BPInstanceConfig instanceConfig =
createInstanceConfig(publishers, false, false, false, null, paramPublish);
instanceConfig.setHostConfigurationAccess(mockHostConfigurationAccess);
createLabeledPublisher("Bill", true);
createLabeledPublisher("Neo", false);
createLabeledPublisher("Ted", true);
createLabeledPublisher("Trinity", false);
assertResult(Result.SUCCESS, instanceConfig);
}
private BapPublisher createLabeledPublisher(final String label, final boolean expectPerform)
throws Exception {
final BapPublisher mockPublisher = mockControl.createMock(BapPublisher.class);
mockPublisher.setEffectiveEnvironmentInBuildInfo(
(AbstractBuild) EasyMock.anyObject(), (BPBuildInfo) EasyMock.anyObject());
expect(mockPublisher.getLabel()).andReturn(new PublisherLabel(label)).anyTimes();
EasyMock.expect(mockPublisher.getConfigName())
.andReturn(hostConfiguration.getName())
.anyTimes();
if (expectPerform) {
mockPublisher.perform(hostConfiguration, buildInfo);
}
publishers.add(mockPublisher);
return mockPublisher;
}
private BPInstanceConfig createInstanceConfig(
final ArrayList publishers,
final boolean continueOnError,
final boolean failOnError,
final boolean alwaysPublishFromMaster) {
return createInstanceConfig(
publishers, continueOnError, failOnError, alwaysPublishFromMaster, null);
}
private BPInstanceConfig createInstanceConfig(
final ArrayList publishers,
final boolean continueOnError,
final boolean failOnError,
final boolean alwaysPublishFromMaster,
final String masterNodeName) {
return createInstanceConfig(
publishers, continueOnError, failOnError, alwaysPublishFromMaster, masterNodeName, null);
}
private BPInstanceConfig createInstanceConfig(
final ArrayList publishers,
final boolean continueOnError,
final boolean failOnError,
final boolean alwaysPublishFromMaster,
final String masterNodeName,
final ParamPublish paramPublish) {
return new BPInstanceConfig(
publishers,
continueOnError,
failOnError,
alwaysPublishFromMaster,
masterNodeName,
paramPublish);
}
}
