MaterialDatabaseDependencyUpdaterTest.java example

Explorer
gocd-master
/*
 * Copyright 2017 ThoughtWorks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.thoughtworks.go.server.materials;

import java.util.ArrayList;
import java.util.List;

import com.thoughtworks.go.config.CaseInsensitiveString;
import com.thoughtworks.go.config.materials.SubprocessExecutionContext;
import com.thoughtworks.go.config.materials.dependency.DependencyMaterial;
import com.thoughtworks.go.domain.MaterialRevision;
import com.thoughtworks.go.domain.MaterialRevisions;
import com.thoughtworks.go.domain.Stage;
import com.thoughtworks.go.domain.StageIdentifier;
import com.thoughtworks.go.domain.StageResult;
import com.thoughtworks.go.domain.Stages;
import com.thoughtworks.go.domain.materials.Material;
import com.thoughtworks.go.domain.materials.Modification;
import com.thoughtworks.go.server.cache.GoCache;
import com.thoughtworks.go.server.dao.DatabaseAccessHelper;
import com.thoughtworks.go.server.dao.DependencyMaterialSourceDao;
import com.thoughtworks.go.server.persistence.MaterialRepository;
import com.thoughtworks.go.server.service.MaterialExpansionService;
import com.thoughtworks.go.server.service.MaterialService;
import com.thoughtworks.go.server.transaction.TransactionTemplate;
import com.thoughtworks.go.server.util.Pagination;
import com.thoughtworks.go.serverhealth.HealthStateScope;
import com.thoughtworks.go.serverhealth.HealthStateType;
import com.thoughtworks.go.serverhealth.ServerHealthService;
import com.thoughtworks.go.serverhealth.ServerHealthState;
import com.thoughtworks.go.util.ReflectionUtil;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import static org.hamcrest.core.Is.is;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.when;
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {
        "classpath:WEB-INF/applicationContext-global.xml",
        "classpath:WEB-INF/applicationContext-dataLocalAccess.xml",
        "classpath:WEB-INF/applicationContext-acegi-security.xml"
})
public class MaterialDatabaseDependencyUpdaterTest {
    @Autowired private DatabaseAccessHelper dbHelper;
    @Autowired protected MaterialRepository materialRepository;
    @Autowired private GoCache goCache;
    @Autowired private TransactionTemplate transactionTemplate;
    @Autowired private MaterialService materialService;
    @Autowired private LegacyMaterialChecker legacyMaterialChecker;
    @Autowired private SubprocessExecutionContext subprocessExecutionContext;
    @Autowired private MaterialExpansionService materialExpansionService;

    protected MaterialDatabaseUpdater updater;
    protected Material material;
    private DependencyMaterialSourceDao dependencyMaterialSourceDao;
    private ServerHealthService healthService;
    private DependencyMaterialUpdater dependencyMaterialUpdater;
    private ScmMaterialUpdater scmMaterialUpdater;

    @Before
    public void setUp() throws Exception {
        dbHelper.onSetUp();
        goCache.clear();
        dependencyMaterialSourceDao = Mockito.mock(DependencyMaterialSourceDao.class);
        healthService = Mockito.mock(ServerHealthService.class);
        dependencyMaterialUpdater = new DependencyMaterialUpdater(dependencyMaterialSourceDao, materialRepository);
        scmMaterialUpdater = new ScmMaterialUpdater(materialRepository, legacyMaterialChecker, subprocessExecutionContext, materialService);
        updater = new MaterialDatabaseUpdater(materialRepository, healthService, transactionTemplate, dependencyMaterialUpdater, scmMaterialUpdater, null, null, materialExpansionService);
    }

    @After
    public void tearDown() throws Exception {
        dbHelper.onTearDown();
    }

    @Test
    public void shouldCreateEntriesForCompletedPipelines() throws Exception {
        DependencyMaterial dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));

        stubStageServiceGetHistory(null, stages(9));

        updater.updateMaterial(dependencyMaterial);

        List<Modification> modification = materialRepository.findLatestModification(dependencyMaterial).getMaterialRevision(0).getModifications();

        assertThat(modification.size(), is(1));
        assertThat(modification.get(0).getRevision(), is("pipeline-name/9/stage-name/0"));
        assertThat(modification.get(0).getPipelineLabel(), is("LABEL-9"));
    }

    @Test
    public void shouldUpdateServerHealthIfCheckFails() throws Exception {
        DependencyMaterial dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));

        RuntimeException runtimeException = new RuntimeException("Description of error");
        Mockito.when(dependencyMaterialSourceDao.getPassedStagesByName(new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name")),
                Pagination.pageStartingAt(0, null, MaterialDatabaseUpdater.STAGES_PER_PAGE)))
                .thenThrow(runtimeException);

        try {
            updater.updateMaterial(dependencyMaterial);
            fail("should have thrown exception " + runtimeException.getMessage());
        } catch (Exception e) {
            assertSame(e, runtimeException);
        }

        HealthStateType scope = HealthStateType.general(HealthStateScope.forMaterial(dependencyMaterial));
        ServerHealthState state = ServerHealthState.error("Modification check failed for material: pipeline-name", "Description of error", scope);
        Mockito.verify(healthService).update(state);
    }

    @Test
    public void shouldClearServerHealthIfCheckSucceeds() throws Exception {
        DependencyMaterial dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));

        Mockito.when(dependencyMaterialSourceDao.getPassedStagesByName(new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name")),
                Pagination.pageStartingAt(0, null, MaterialDatabaseUpdater.STAGES_PER_PAGE)))
                .thenReturn(new ArrayList<>());

        updater.updateMaterial(dependencyMaterial);

        Mockito.verify(healthService).removeByScope(HealthStateScope.forMaterial(dependencyMaterial));
    }

    @Test
    public void shouldReturnNoNewModificationsIfNoNewPipelineHasBennCompleted() throws Exception {
        DependencyMaterial dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));

        stubStageServiceGetHistory(null, stages(9));
        updater.updateMaterial(dependencyMaterial);

        List<Modification> modification = materialRepository.findLatestModification(dependencyMaterial).getMaterialRevision(0).getModifications();

        stubStageServiceGetHistoryAfter(dependencyMaterial, 9, stages());

        updater.updateMaterial(dependencyMaterial);

        List<Modification> newModifications = materialRepository.findModificationsSince(dependencyMaterial, new MaterialRevision(dependencyMaterial, modification));

        assertThat(newModifications.size(), is(0));
    }

    private void stubStageServiceGetHistoryAfter(DependencyMaterial material, int pipelineCounter, Stages... stageses) {
        if(material == null){
            material = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));
        }
        StageIdentifier identifier = new StageIdentifier(String.format("%s/%s/%s/0", material.getPipelineName().toString(), pipelineCounter, material.getStageName().toString()));
        for (int i = 0; i < stageses.length; i++) {
            Stages stages = stageses[i];
            List<Modification> mods = new ArrayList<>();
            for (Stage stage : stages) {
                StageIdentifier id = stage.getIdentifier();
                mods.add(new Modification(stage.completedDate(), id.stageLocator(), id.getPipelineLabel(), stage.getPipelineId()));
            }
            Mockito.when(dependencyMaterialSourceDao.getPassedStagesAfter(identifier.stageLocator(),
                    material,
                    Pagination.pageStartingAt(i * MaterialDatabaseUpdater.STAGES_PER_PAGE, null, MaterialDatabaseUpdater.STAGES_PER_PAGE)
            )).thenReturn(mods);
        }
        when(dependencyMaterialSourceDao.getPassedStagesAfter(identifier.stageLocator(),
                material,
                Pagination.pageStartingAt(MaterialDatabaseUpdater.STAGES_PER_PAGE * stageses.length, null, MaterialDatabaseUpdater.STAGES_PER_PAGE)
        )).thenReturn(new ArrayList<>());
    }

    @Test
    public void shouldReturnNoNewModificationsIfPipelineHasNeverBeenScheduled() throws Exception {
        DependencyMaterial dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));

        stubStageServiceGetHistory(null);
        updater.updateMaterial(dependencyMaterial);

        MaterialRevisions materialRevisions = materialRepository.findLatestModification(dependencyMaterial);

        assertThat("materialRevisions.isEmpty()", materialRevisions.isEmpty(), is(true));
    }

    @Test
    public void shouldReturnLatestPipelineIfThereHasBeenANewOne() throws Exception {
        DependencyMaterial dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));

        stubStageServiceGetHistory(null, stages(9));
        updater.updateMaterial(dependencyMaterial);

        List<Modification> modification = materialRepository.findLatestModification(dependencyMaterial).getMaterialRevision(0).getModifications();

        stubStageServiceGetHistoryAfter(null, 9, stages(10));
        updater.updateMaterial(dependencyMaterial);

        List<Modification> newModifications = materialRepository.findModificationsSince(dependencyMaterial, new MaterialRevision(dependencyMaterial, modification));

        assertThat(newModifications.size(), is(1));
        assertThat(newModifications.get(0).getRevision(), is("pipeline-name/10/stage-name/0"));
        assertThat(newModifications.get(0).getPipelineLabel(), is("LABEL-10"));
    }

    @Test
    public void shouldInsertAllHistoricRunsOfUpstreamStageTheFirstTime() throws Exception {
        DependencyMaterial dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));

        stubStageServiceGetHistory(null, stages(9, 10, 11), stages(12, 13));

        updater.updateMaterial(dependencyMaterial);

        for (Integer revision : new int[]{9, 10, 11, 12, 13}) {
            String stageLocator = String.format("pipeline-name/%s/stage-name/0", revision);
            Modification modification = materialRepository.findModificationWithRevision(dependencyMaterial, stageLocator);
            assertThat(modification.getRevision(), is(stageLocator));
            assertThat(modification.getPipelineLabel(), is(String.format("LABEL-%s", revision)));
        }
    }

    @Test
    public void shouldUpdateMaterialCorrectlyIfCaseOfPipelineNameIsDifferentInConfigurationOfDependencyMaterial() throws Exception {

        DependencyMaterial dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("PIPEline-name"), new CaseInsensitiveString("STAge-name"));
        stubStageServiceGetHistory(dependencyMaterial, stages(1));

        // create the material instance
        updater.updateMaterial(dependencyMaterial);

        stubStageServiceGetHistoryAfter(dependencyMaterial, 1, stages(2));

        // update first time & should mark cache as updated
        updater.updateMaterial(dependencyMaterial);

        Stage stage = stage(3);
        ReflectionUtil.setField(stage, "result", StageResult.Passed);

        // update subsequently should hit database
        updater.updateMaterial(dependencyMaterial);

        Mockito.verify(dependencyMaterialSourceDao, times(2)).getPassedStagesAfter(any(String.class), any(DependencyMaterial.class), any(Pagination.class));
        Mockito.verify(dependencyMaterialSourceDao, times(2)).getPassedStagesByName(any(DependencyMaterial.class), any(Pagination.class));
    }

    private Stages stages(int... pipelineCounters) {
        Stages stages = new Stages();
        for (int counter : pipelineCounters) {
            stages.add(stage(counter));
        }
        return stages;
    }

    private Stage stage(int pipelineCounter) {
        Stage stage = new Stage();
        stage.setIdentifier(new StageIdentifier("pipeline-name", pipelineCounter, "LABEL-" + pipelineCounter, "stage-name", "0"));
        return stage;
    }

    private void stubStageServiceGetHistory(DependencyMaterial dependencyMaterial, Stages... stageses) {
        if(material == null) {
            dependencyMaterial = new DependencyMaterial(new CaseInsensitiveString("pipeline-name"), new CaseInsensitiveString("stage-name"));
        }
        for (int i = 0; i < stageses.length; i++) {
            ArrayList<Modification> mods = new ArrayList<>();
            for (Stage stage : stageses[i]) {
                StageIdentifier id = stage.getIdentifier();
                mods.add(new Modification(stage.completedDate(), id.stageLocator(), id.getPipelineLabel(), stage.getPipelineId()));
            }
            Mockito.when(dependencyMaterialSourceDao.getPassedStagesByName(dependencyMaterial,
                    Pagination.pageStartingAt(i * MaterialDatabaseUpdater.STAGES_PER_PAGE, null, MaterialDatabaseUpdater.STAGES_PER_PAGE)))
                    .thenReturn(mods);
        }
        Mockito.when(dependencyMaterialSourceDao.getPassedStagesByName(dependencyMaterial,
                Pagination.pageStartingAt(MaterialDatabaseUpdater.STAGES_PER_PAGE * stageses.length, null, MaterialDatabaseUpdater.STAGES_PER_PAGE)
        )).thenReturn(new ArrayList<>());
    }
}