@Test
public void shouldGetAPresenterWithLabelAndRelevantBuildPlansAndPipelineNameAndId()
throws Exception {
StageJsonPresentationModel presenter =
new StageJsonPresentationModel(pipeline, stage, null, new Agents());
Map json = presenter.toJson();
new JsonTester(json)
.shouldContain(
"{ 'pipelineName' : 'pipeline',"
+ " 'stageName' : 'stage',"
+ " 'builds' : ["
+ " { 'name' : 'job-that-will-fail' },"
+ " { 'name' : 'job-that-will-pass' },"
+ " { 'name' : 'scheduledBuild' }"
+ " ],"
+ " 'current_label' : '"
+ pipeline.getLabel()
+ "', "
+ " 'pipelineCounter' : '"
+ pipeline.getCounter()
+ "', "
+ " 'pipelineCounterOrLabel' : '"
+ pipeline.getIdentifier().instanceIdentifier()
+ "', "
+ " 'id' : '1' "
+ "}");
assertFalse(
"JSON shouldn't contain last_successful_label",
json.toString().contains("last_successful_label"));
}
@Before
public void setUp() {
MaterialRevisions materialRevisions = multipleModifications();
stage =
StageMother.withOneScheduledBuild("stage", "job-that-will-fail", "job-that-will-pass", 1);
modifications = BuildCause.createWithModifications(materialRevisions, "");
pipeline = new Pipeline("pipeline", PipelineLabel.COUNT_TEMPLATE, modifications, stage);
stage.setIdentifier(new StageIdentifier(pipeline, stage));
for (JobInstance job : stage.getJobInstances()) {
job.setIdentifier(new JobIdentifier(pipeline, stage, job));
}
pipeline.setId(PIPELINE_ID);
pipeline.updateCounter(9);
}
@Test
public void shouldReturnLastSuccesfulLabel() throws Exception {
StageIdentifier successfulStage =
new StageIdentifier(pipeline.getName(), 1, "LABEL:1", stage.getName(), "1");
StageJsonPresentationModel presenter =
new StageJsonPresentationModel(pipeline, stage, successfulStage, new Agents());
Map json = presenter.toJson();
new JsonTester(json)
.shouldContain(
"{ 'last_successful_label' : 'LABEL:1', 'last_successful_stage_locator' : '"
+ String.format("%s/%s/%s/%s", pipeline.getName(), "1", stage.getName(), "1")
+ "' }");
}
@Test
public void shouldGetAPresenterWithLabelAndRelevantBuildPlans() throws Exception {
DurationBeans durations =
new DurationBeans(
new DurationBean(stage.getJobInstances().getByName("job-that-will-fail").getId(), 12L));
StageJsonPresentationModel presenter =
new StageJsonPresentationModel(
pipeline, stage, null, new Agents(), durations, new TrackingTool());
Map json = presenter.toJson();
new JsonTester(json)
.shouldContain(
"{ 'stageName' : 'stage',"
+ " 'builds' : ["
+ " { 'name' : 'job-that-will-fail', 'last_build_duration' : '12' },"
+ " { 'name' : 'job-that-will-pass' }, "
+ " { 'name' : 'scheduledBuild' }"
+ " ],"
+ " 'current_label' : '"
+ pipeline.getLabel()
+ "',"
+ " 'id' : '1' "
+ "}");
assertFalse(
"JSON shouldn't contain last_successful_label",
json.toString().contains("last_successful_label"));
}
@Test
public void shouldUpdateScmConfigurationOfPluggableScmMaterialsOnPipeline() {
String jobName = "job-one";
PipelineConfig pipelineConfig =
setupPipelineWithScmMaterial("pipeline_with_pluggable_scm_mat", "stage", jobName);
final Pipeline previousSuccessfulBuildWithOlderScmConfig =
simulateSuccessfulPipelineRun(pipelineConfig);
PipelineConfig updatedPipelineConfig =
configHelper.updatePipeline(
pipelineConfig.name(),
new GoConfigFileHelper.Updater<PipelineConfig>() {
@Override
public void update(PipelineConfig config) {
PluggableSCMMaterialConfig materialConfig =
(PluggableSCMMaterialConfig) config.materialConfigs().first();
materialConfig
.getSCMConfig()
.getConfiguration()
.getProperty("password")
.setConfigurationValue(new ConfigurationValue("new_value"));
}
});
final long jobId = rerunJob(jobName, pipelineConfig, previousSuccessfulBuildWithOlderScmConfig);
Pipeline loadedPipeline =
(Pipeline)
transactionTemplate.execute(
new TransactionCallback() {
public Object doInTransaction(TransactionStatus status) {
return loader.pipelineWithPasswordAwareBuildCauseByBuildId(jobId);
}
});
MaterialRevisions revisions = loadedPipeline.getBuildCause().getMaterialRevisions();
Configuration updatedConfiguration =
((PluggableSCMMaterial)
revisions
.findRevisionFor(updatedPipelineConfig.materialConfigs().first())
.getMaterial())
.getScmConfig()
.getConfiguration();
assertThat(updatedConfiguration.size(), is(2));
assertThat(
updatedConfiguration.getProperty("password").getConfigurationValue(),
is(new ConfigurationValue("new_value")));
}
private Pipeline createAndLoadModifyOneFilePipeline(PipelineConfig pipelineConfig) {
MaterialConfigs expandedConfigs =
materialExpansionService.expandMaterialConfigsForScheduling(
pipelineConfig.materialConfigs());
MaterialRevisions materialRevisions =
ModificationsMother.modifyOneFile(
MaterialsMother.createMaterialsFromMaterialConfigs(expandedConfigs));
Pipeline building = PipelineMother.buildingWithRevisions(pipelineConfig, materialRevisions);
Pipeline pipeline = dbHelper.savePipelineWithMaterials(building);
final long jobId = pipeline.getStages().get(0).getJobInstances().get(0).getId();
return (Pipeline)
transactionTemplate.execute(
new TransactionCallback() {
public Object doInTransaction(TransactionStatus status) {
return loader.pipelineWithPasswordAwareBuildCauseByBuildId(jobId);
}
});
}
@Test
public void shouldLoadPipelineAlongwithBuildCauseHavingMaterialPasswordsPopulated() {
PipelineConfig pipelineConfig =
PipelineConfigMother.pipelineConfig(
"last",
new StageConfig(
new CaseInsensitiveString("stage"), new JobConfigs(new JobConfig("job-one"))));
pipelineConfig.materialConfigs().clear();
SvnMaterial onDirOne =
MaterialsMother.svnMaterial("google.com", "dirOne", "loser", "boozer", false, "**/*.html");
P4Material onDirTwo =
MaterialsMother.p4Material(
"host:987654321", "zoozer", "secret", "through-the-window", true);
onDirTwo.setFolder("dirTwo");
pipelineConfig.addMaterialConfig(onDirOne.config());
pipelineConfig.addMaterialConfig(onDirTwo.config());
configHelper.addPipeline(pipelineConfig);
Pipeline building = PipelineMother.building(pipelineConfig);
Pipeline pipeline = dbHelper.savePipelineWithMaterials(building);
final long jobId = pipeline.getStages().get(0).getJobInstances().get(0).getId();
Pipeline loadedPipeline =
(Pipeline)
transactionTemplate.execute(
new TransactionCallback() {
public Object doInTransaction(TransactionStatus status) {
return loader.pipelineWithPasswordAwareBuildCauseByBuildId(jobId);
}
});
MaterialRevisions revisions = loadedPipeline.getBuildCause().getMaterialRevisions();
assertThat(
((SvnMaterial) revisions.findRevisionFor(onDirOne).getMaterial()).getPassword(),
is("boozer"));
assertThat(
((P4Material) revisions.findRevisionFor(onDirTwo).getMaterial()).getPassword(),
is("secret"));
}
@Test
public void shouldLoadShallowCloneFlagForGitMaterialsBaseOnTheirOwnPipelineConfig()
throws IOException {
GitTestRepo testRepo = new GitTestRepo();
PipelineConfig shallowPipeline =
PipelineConfigMother.pipelineConfig(
"shallowPipeline",
new StageConfig(
new CaseInsensitiveString("stage"), new JobConfigs(new JobConfig("job-one"))));
shallowPipeline.materialConfigs().clear();
shallowPipeline.addMaterialConfig(
new GitMaterialConfig(testRepo.projectRepositoryUrl(), null, true));
configHelper.addPipeline(shallowPipeline);
PipelineConfig fullPipeline =
PipelineConfigMother.pipelineConfig(
"fullPipeline",
new StageConfig(
new CaseInsensitiveString("stage"), new JobConfigs(new JobConfig("job-one"))));
fullPipeline.materialConfigs().clear();
fullPipeline.addMaterialConfig(
new GitMaterialConfig(testRepo.projectRepositoryUrl(), null, false));
configHelper.addPipeline(fullPipeline);
Pipeline shallowPipelineInstance = createAndLoadModifyOneFilePipeline(shallowPipeline);
MaterialRevisions shallowRevisions =
shallowPipelineInstance.getBuildCause().getMaterialRevisions();
assertThat(
((GitMaterial) shallowRevisions.getRevisions().get(0).getMaterial()).isShallowClone(),
is(true));
Pipeline fullPipelineInstance = createAndLoadModifyOneFilePipeline(fullPipeline);
MaterialRevisions fullRevisions = fullPipelineInstance.getBuildCause().getMaterialRevisions();
assertThat(
((GitMaterial) fullRevisions.getRevisions().get(0).getMaterial()).isShallowClone(),
is(false));
}
@Test
public void shouldEscapeBuildCauseMessage() throws Exception {
String userWithHtmlCharacters = "<user>";
pipeline.setBuildCause(
BuildCause.createManualForced(
materialRevisions(userWithHtmlCharacters),
new Username(new CaseInsensitiveString(userWithHtmlCharacters))));
StageJsonPresentationModel presenter =
new StageJsonPresentationModel(pipeline, stage, null, new Agents());
JsonTester jsonTester = new JsonTester(presenter.toJson());
String expected = StringEscapeUtils.escapeHtml(userWithHtmlCharacters);
jsonTester.shouldContain("{'buildCause':'Forced by " + expected + "'}");
}
@Test // if other materials have expansion concept at some point, add more tests here
public void shouldSetPasswordForExpandedSvnMaterial() {
PipelineConfig pipelineConfig =
PipelineConfigMother.pipelineConfig(
"last",
new StageConfig(
new CaseInsensitiveString("stage"), new JobConfigs(new JobConfig("job-one"))));
pipelineConfig.materialConfigs().clear();
SvnMaterialConfig materialConfig = svnRepo.materialConfig();
materialConfig.setConfigAttributes(
Collections.singletonMap(SvnMaterialConfig.CHECK_EXTERNALS, String.valueOf(true)));
materialConfig.setPassword("boozer");
pipelineConfig.addMaterialConfig(materialConfig);
configHelper.addPipeline(pipelineConfig);
Pipeline loadedPipeline = createAndLoadModifyOneFilePipeline(pipelineConfig);
MaterialRevisions revisions = loadedPipeline.getBuildCause().getMaterialRevisions();
assertThat(revisions.getRevisions().size(), is(2));
assertThat(
((SvnMaterial) revisions.getRevisions().get(0).getMaterial()).getPassword(), is("boozer"));
assertThat(
((SvnMaterial) revisions.getRevisions().get(1).getMaterial()).getPassword(), is("boozer"));
}
private long rerunJob(
String jobName,
PipelineConfig pipelineConfig,
Pipeline previousSuccessfulBuildWithOlderPackageConfig) {
Stage stage =
instanceFactory.createStageForRerunOfJobs(
previousSuccessfulBuildWithOlderPackageConfig.getFirstStage(),
asList(jobName),
new DefaultSchedulingContext(),
pipelineConfig.getFirstStageConfig(),
new TimeProvider(),
configHelper.getGoConfigDao().md5OfConfigFile());
stage = stageService.save(previousSuccessfulBuildWithOlderPackageConfig, stage);
return stage.getFirstJob().getId();
}
@Test
public void shouldSetAServerHealthMessageWhenMaterialForPipelineWithBuildCauseIsNotFound()
throws IllegalArtifactLocationException, IOException {
PipelineConfig pipelineConfig =
PipelineConfigMother.pipelineConfig(
"last",
new StageConfig(
new CaseInsensitiveString("stage"), new JobConfigs(new JobConfig("job-one"))));
pipelineConfig.materialConfigs().clear();
SvnMaterialConfig onDirOne =
MaterialConfigsMother.svnMaterialConfig(
"google.com", "dirOne", "loser", "boozer", false, "**/*.html");
final P4MaterialConfig onDirTwo =
MaterialConfigsMother.p4MaterialConfig(
"host:987654321", "zoozer", "secret", "through-the-window", true);
onDirTwo.setConfigAttributes(Collections.singletonMap(ScmMaterialConfig.FOLDER, "dirTwo"));
pipelineConfig.addMaterialConfig(onDirOne);
pipelineConfig.addMaterialConfig(onDirTwo);
configHelper.addPipeline(pipelineConfig);
Pipeline building = PipelineMother.building(pipelineConfig);
final Pipeline pipeline = dbHelper.savePipelineWithMaterials(building);
CruiseConfig cruiseConfig = configHelper.currentConfig();
PipelineConfig cfg = cruiseConfig.pipelineConfigByName(new CaseInsensitiveString("last"));
cfg.removeMaterialConfig(cfg.materialConfigs().get(1));
configHelper.writeConfigFile(cruiseConfig);
assertThat(
serverHealthService.filterByScope(HealthStateScope.forPipeline("last")).size(), is(0));
final long jobId = pipeline.getStages().get(0).getJobInstances().get(0).getId();
Date currentTime = new Date(System.currentTimeMillis() - 1);
Pipeline loadedPipeline =
(Pipeline)
transactionTemplate.execute(
new TransactionCallback() {
public Object doInTransaction(TransactionStatus status) {
Pipeline loadedPipeline = null;
try {
loadedPipeline = loader.pipelineWithPasswordAwareBuildCauseByBuildId(jobId);
fail(
"should not have loaded pipeline with build-cause as one of the necessary materials was not found");
} catch (Exception e) {
assertThat(e, is(instanceOf(StaleMaterialsOnBuildCause.class)));
assertThat(
e.getMessage(),
is(
"Cannot load job 'last/"
+ pipeline.getCounter()
+ "/stage/1/job-one' because material "
+ onDirTwo
+ " was not found in config."));
}
return loadedPipeline;
}
});
assertThat(loadedPipeline, is(nullValue()));
JobInstance reloadedJobInstance = jobInstanceService.buildById(jobId);
assertThat(reloadedJobInstance.getState(), is(JobState.Completed));
assertThat(reloadedJobInstance.getResult(), is(JobResult.Failed));
assertThat(
serverHealthService
.filterByScope(HealthStateScope.forJob("last", "stage", "job-one"))
.size(),
is(1));
ServerHealthState error =
serverHealthService
.filterByScope(HealthStateScope.forJob("last", "stage", "job-one"))
.get(0);
assertThat(
error,
is(
ServerHealthState.error(
"Cannot load job 'last/"
+ pipeline.getCounter()
+ "/stage/1/job-one' because material "
+ onDirTwo
+ " was not found in config.",
"Job for pipeline 'last/"
+ pipeline.getCounter()
+ "/stage/1/job-one' has been failed as one or more material configurations were either changed or removed.",
HealthStateType.general(HealthStateScope.forJob("last", "stage", "job-one")))));
DateTime expiryTime = (DateTime) ReflectionUtil.getField(error, "expiryTime");
assertThat(expiryTime.toDate().after(currentTime), is(true));
assertThat(
expiryTime.toDate().before(new Date(System.currentTimeMillis() + 5 * 60 * 1000 + 1)),
is(true));
String logText =
FileUtil.readToEnd(consoleService.findConsoleArtifact(reloadedJobInstance.getIdentifier()));
assertThat(
logText,
containsString(
"Cannot load job 'last/"
+ pipeline.getCounter()
+ "/stage/1/job-one' because material "
+ onDirTwo
+ " was not found in config."));
assertThat(
logText,
containsString(
"Job for pipeline 'last/"
+ pipeline.getCounter()
+ "/stage/1/job-one' has been failed as one or more material configurations were either changed or removed."));
}
