step.repositories.LocalRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of step-plans-base-artefacts Show documentation
The newest version!
/*******************************************************************************
 * Copyright (C) 2020, exense GmbH
 *
 * This file is part of STEP
 *
 * STEP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * STEP 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with STEP.  If not, see .
 ******************************************************************************/
package step.repositories;

import step.artefacts.CallPlan;
import step.artefacts.TestCase;
import step.artefacts.TestSet;
import step.artefacts.handlers.PlanLocator;
import step.artefacts.handlers.SelectorHelper;
import step.core.accessors.AbstractOrganizableObject;
import step.core.artefacts.AbstractArtefact;
import step.core.artefacts.reports.ReportNodeStatus;
import step.core.dynamicbeans.DynamicJsonObjectResolver;
import step.core.dynamicbeans.DynamicJsonValueResolver;
import step.core.execution.ExecutionContext;
import step.core.objectenricher.ObjectPredicate;
import step.core.plans.Plan;
import step.core.plans.PlanAccessor;
import step.core.repositories.*;
import step.expressions.ExpressionHandler;

import java.util.List;
import java.util.Map;
import java.util.Set;

public class LocalRepository extends AbstractRepository {

	private final PlanAccessor planAccessor;
	private final PlanLocator planLocator;

	public LocalRepository(PlanAccessor planAccessor, ExpressionHandler expressionHandler) {
		super(Set.of(RepositoryObjectReference.PLAN_ID));
		this.planAccessor = planAccessor;
		DynamicJsonObjectResolver dynamicJsonObjectResolver = new DynamicJsonObjectResolver(new DynamicJsonValueResolver(expressionHandler));
		SelectorHelper selectorHelper = new SelectorHelper(dynamicJsonObjectResolver);
		planLocator = new PlanLocator(planAccessor, selectorHelper);
	}

	@Override
	public ArtefactInfo getArtefactInfo(Map repositoryParameters) throws Exception {
		String planId = getPlanId(repositoryParameters);
		Plan plan = planAccessor.get(planId);

		ArtefactInfo info = new ArtefactInfo();
		info.setName(plan.getAttributes()!=null?plan.getAttributes().get(AbstractOrganizableObject.NAME):null);
		info.setType(AbstractArtefact.getArtefactName(plan.getRoot().getClass()));
		return info;
	}

	@Override
	public TestSetStatusOverview getTestSetStatusOverview(Map repositoryParameters, ObjectPredicate objectPredicate) throws Exception {
		TestSetStatusOverview testSetStatusOverview = new TestSetStatusOverview();

		String planId = getPlanId(repositoryParameters);
		Plan plan = planAccessor.get(planId);

		AbstractArtefact rootArtefact = plan.getRoot();

		if(rootArtefact instanceof TestSet) {
			// Perform a very basic parsing of the artefact tree to get a list of test cases referenced
			// in this test set. Only direct children of the root node are considered
			List children = rootArtefact.getChildren();
			children.forEach(child->{
				if(child instanceof TestCase) {
					addTestRunStatus(testSetStatusOverview.getRuns(), child);
				} else if(child instanceof CallPlan) {
					Plan referencedPlan = planLocator.selectPlan((CallPlan)child, objectPredicate, null);
					if (referencedPlan != null) {
						AbstractArtefact root = referencedPlan.getRoot();
						if (root instanceof TestCase) {
							addTestRunStatus(testSetStatusOverview.getRuns(), root);
						}
					}
				}
			});
		}
		return testSetStatusOverview;
	}

	private static String getPlanId(Map repositoryParameters) {
		return repositoryParameters.get(RepositoryObjectReference.PLAN_ID);
	}

	private void addTestRunStatus(List testRunStatusList, AbstractArtefact abstractArtefact) {
		testRunStatusList.add(new TestRunStatus(abstractArtefact.getId().toString(),
				abstractArtefact.getAttributes().get(AbstractOrganizableObject.NAME), ReportNodeStatus.NORUN));
	}

	@Override
	public ImportResult importArtefact(ExecutionContext context, Map repositoryParameters)
			throws Exception {
		ImportResult importResult = new ImportResult();
		String planId = getPlanId(context.getExecutionParameters().getRepositoryObject().getRepositoryParameters());
		Plan plan = context.getPlanAccessor().get(planId);
		if(plan == null) {
			importResult.setErrors(List.of("The plan with id '" + planId + "' does not exist. It may have been deleted."));
			importResult.setSuccessful(false);
		} else {
			importResult.setPlanId(planId);
			importResult.setSuccessful(true);
		}
		return importResult;
	}

	@Override
	public void exportExecution(ExecutionContext context, Map repositoryParameters) throws Exception {
		// The local repository doesn't perform any export
	}
}