Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,9 @@ Genmodels are not uploaded; they are generated from the metamodels. The pipeline
(`model`, `consistency`, `vsum`), with a smoke test that creates and reloads the VSUM and compiles the constraints.
5. Runs `mvn clean verify`.

The generated VSUM registers the VitruvOCL constraints at the virtual model, so its Vitruv server lists,
validates, and manages them under `/vsum/constraints`, and validates them after every change propagation.

Invalid inputs are rejected with `400` before Maven runs (`VSUM_INPUT_ERROR`, `VSUM_METAMODEL_ERROR`,
`VSUM_REACTIONS_ERROR`). Failed Maven builds are classified by their output, so that only problems of the
uploads are reported as such:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,11 @@
@ConfigurationProperties(prefix = "setup.vsum")
public class VsumBuildProperties {

/** Maven executable used to build the generated project. */
private String mavenCommand = "mvn";
/** Maven executable used to build the generated project; {@code mvn.cmd} on Windows. */
private String mavenCommand =
System.getProperty("os.name", "").toLowerCase(java.util.Locale.ROOT).startsWith("windows")
? "mvn.cmd"
: "mvn";

/** Additional Maven arguments, e.g. {@code -s settings.xml}. */
private List<String> mavenArguments = new ArrayList<>();
Expand Down Expand Up @@ -67,24 +70,33 @@ public class VsumBuildProperties {

// Vitruvius is released per repository, so the artifact groups can have different versions.

/** Version of the Vitruv-Change artifacts ({@code tools.vitruv.change.*}). */
private String vitruvChangeVersion = "4.0.1";
/**
* Version of the Vitruv-Change artifacts ({@code tools.vitruv.change.*}). It must provide the raw
* value of UUIDs, which the Vitruv server returns for violating elements.
*/
private String vitruvChangeVersion = "4.0.2-SNAPSHOT";

/** Version of the Vitruv framework artifacts ({@code tools.vitruv.framework.*}). */
private String vitruvFrameworkVersion = "4.0.1";
/**
* Version of the Vitruv framework artifacts ({@code tools.vitruv.framework.*}). It must provide
* the constraint SPI ({@code tools.vitruv.framework.vsum.constraints}).
*/
private String vitruvFrameworkVersion = "4.0.2-SNAPSHOT";

/** Version of the Vitruv-DSLs artifacts ({@code tools.vitruv.dsls.*}, e.g. Reactions). */
private String vitruvDslsVersion = "4.0.0";

/** Version of the Vitruv-Server artifacts ({@code tools.vitruv.server.*}). */
private String vitruvServerVersion = "4.0.0";
/**
* Version of the Vitruv-Server artifacts ({@code tools.vitruv.server.*}). It must provide the
* constraint endpoints ({@code /vsum/constraints}).
*/
private String vitruvServerVersion = "4.0.1-SNAPSHOT";

/**
* Version of VitruvOCL. It has no release yet, so a timestamped snapshot is pinned instead of
* {@code 0.1.0-SNAPSHOT}, which changes whenever a new snapshot is published. Snapshots are
* removed from the snapshot repository after a while; the Docker image keeps its copy.
* Version of VitruvOCL ({@code tools.vitruv:tools.vitruv.vitruvocl.language} from the
* VitruviusOCL repository). It has no release yet; pin a timestamped snapshot once one is
* published, so that builds do not change whenever a new snapshot is published.
*/
private String vitruvoclVersion = "0.1.0-20261029.094026-91";
private String vitruvoclVersion = "0.1.0-SNAPSHOT";

/** Version of {@code org.eclipse.emf.common}. */
private String emfCommonVersion = "2.46.0";
Expand Down
1 change: 0 additions & 1 deletion src/main/resources/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ spring.servlet.multipart.max-file-size=50MB
spring.servlet.multipart.max-request-size=200MB

# VSUM build (see VsumBuildProperties for all options)
setup.vsum.maven-command=mvn
setup.vsum.build-timeout=15m
setup.vsum.max-concurrent-builds=2
# offline builds with the Maven repository of the Docker image (see Dockerfile)
Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/templates/vsum/rootPom.ftl
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@
</dependency>
<!-- VitruvOCL is versioned independently from the Vitruvius core -->
<dependency>
<groupId>tools.vitruv.dsls</groupId>
<artifactId>vitruvocl-language</artifactId>
<groupId>tools.vitruv</groupId>
<artifactId>tools.vitruv.vitruvocl.language</artifactId>
<version>${vitruvocl.version}</version>
</dependency>

Expand Down
168 changes: 89 additions & 79 deletions src/main/resources/templates/vsum/vsumMain.ftl
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,36 @@ import java.io.InputStream;
</#if>
import java.io.UncheckedIOException;
<#if constraintResources?has_content>
import java.nio.file.Files;
import java.nio.charset.StandardCharsets;
</#if>
import java.nio.file.Path;
<#if constraintResources?has_content>
import java.nio.file.StandardCopyOption;
</#if>
import java.util.ArrayList;
import java.util.Collection;
<#if constraintResources?has_content>
import java.util.LinkedHashMap;
</#if>
import java.util.List;
<#if constraintResources?has_content>
import java.util.Map;
</#if>
import java.util.Scanner;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.xmi.impl.XMIResourceFactoryImpl;
<#if constraintResources?has_content>
import tools.vitruv.change.atomic.uuid.Uuid;
import tools.vitruv.change.composite.description.PropagatedChange;
import tools.vitruv.change.composite.description.VitruviusChange;
import tools.vitruv.change.composite.propagation.ChangePropagationListener;
</#if>
import tools.vitruv.change.propagation.ChangePropagationSpecification;
import tools.vitruv.change.testutils.TestUserInteraction;
<#if constraintResources?has_content>
import tools.vitruv.dsls.vitruvocl.pipeline.BatchValidationResult;
import tools.vitruv.dsls.vitruvocl.pipeline.ConstraintResult;
import tools.vitruv.dsls.vitruvocl.pipeline.VitruvOCL;
import tools.vitruv.dsls.vitruvocl.vitruv.VitruvOclConstraintChecker;
</#if>
import tools.vitruv.framework.remote.server.VitruvServer;
import tools.vitruv.framework.views.ViewType;
import tools.vitruv.framework.views.ViewTypeFactory;
import tools.vitruv.framework.vsum.VirtualModelBuilder;
<#if constraintResources?has_content>
import tools.vitruv.framework.vsum.constraints.ConstraintValidationListener.Trigger;
import tools.vitruv.framework.vsum.constraints.ConstraintValidationReport;
import tools.vitruv.framework.vsum.constraints.ConstraintValidationResult;
import tools.vitruv.framework.vsum.constraints.InvalidConstraintException;
</#if>
import tools.vitruv.framework.vsum.internal.InternalVirtualModel;

/**
Expand Down Expand Up @@ -95,9 +96,19 @@ public class [=vsumMainClass] {
new TestUserInteraction.ResultProvider(new TestUserInteraction()))
.withChangePropagationSpecifications(createChangePropagationSpecifications())
.withViewTypes(createViewTypes())
<#if constraintResources?has_content>
// the Vitruv server lists, validates and manages the constraints via REST
.withConstraintChecker(createConstraintChecker())
.withConstraintValidationAfterPropagation(true)
</#if>
.buildAndInitialize();
<#if constraintResources?has_content>
registerConstraintEvaluation(vsum);
vsum.addConstraintValidationListener(
(report, trigger) -> {
if (trigger == Trigger.PROPAGATION) {
reportViolations(report);
}
});
</#if>
return vsum;
}
Expand Down Expand Up @@ -133,86 +144,85 @@ public class [=vsumMainClass] {
}
<#if constraintResources?has_content>

/** Evaluates all constraints after every change propagation and reports violations. */
static void registerConstraintEvaluation(InternalVirtualModel vsum) {
VitruvOCL.registerVSUM(vsum);
vsum.addChangePropagationListener(
new ChangePropagationListener() {
@Override
public void startedChangePropagation(VitruviusChange<Uuid> changeToPropagate) {
// constraints are evaluated once all reactions have been executed
}

@Override
public void finishedChangePropagation(Iterable<PropagatedChange> propagatedChanges) {
for (String resource : CONSTRAINT_RESOURCES) {
BatchValidationResult result = evaluateConstraints(resource);
result
.getViolatedConstraints()
.forEach(
violation ->
System.err.println(
"[OCL VIOLATION] "
+ violation.getConstraint()
+ ": "
+ violation.getWarningsSummary()));
if (!result.allSucceeded()) {
System.err.println("[OCL ERROR] " + resource + ":\n" + describeFailures(result));
}
}
}
});
/**
* Creates the checker of the VitruvOCL constraints of this VSUM.
*
* @return the checker of all constraint resources
* @throws IllegalArgumentException if a constraint resource cannot be parsed, described as by
* {@link #describeFailures}
*/
static VitruvOclConstraintChecker createConstraintChecker() {
for (String resource : CONSTRAINT_RESOURCES) {
try {
VitruvOclConstraintChecker.fromClasspath(resource);
} catch (InvalidConstraintException e) {
List<String> lines = readResource(resource).lines().toList();
Map<String, List<String>> errors = new LinkedHashMap<>();
e.getDiagnostics()
.forEach(
diagnostic ->
errors
.computeIfAbsent(
diagnostic.line() >= 1 && diagnostic.line() <= lines.size()
? lines.get(diagnostic.line() - 1).strip()
: resource,
line -> new ArrayList<>())
.add(
diagnostic.line()
+ ":"
+ diagnostic.column()
+ " "
+ diagnostic.message()));
throw new IllegalArgumentException(describeFailures(resource, errors), e);
}
}
return VitruvOclConstraintChecker.fromClasspath(CONSTRAINT_RESOURCES.toArray(String[]::new));
}

/**
* Evaluates the constraints of a classpath resource against the registered VSUM.
* Describes constraints of a resource that cannot be evaluated, in the form the setup service
* attributes to the uploaded constraint file.
*
* @param resource classpath resource of an {@code .ocl} file
* @return the evaluation result
* @param resource the classpath resource of the constraints
* @param errors the errors per constraint (its source or the faulty line)
* @return the description
*/
static BatchValidationResult evaluateConstraints(String resource) {
try {
Path file = Files.createTempFile("constraints", ".ocl");
try (InputStream input =
[=vsumMainClass].class.getClassLoader().getResourceAsStream(resource)) {
if (input == null) {
throw new IllegalStateException("Constraint resource not found: " + resource);
}
Files.copy(input, file, StandardCopyOption.REPLACE_EXISTING);
return VitruvOCL.evaluateConstraints(file);
} finally {
Files.deleteIfExists(file);
}
static String describeFailures(String resource, Map<String, List<String>> errors) {
StringBuilder description =
new StringBuilder("Constraints in " + resource + " cannot be evaluated:\n");
errors.forEach(
(constraint, constraintErrors) -> {
description.append("- ").append(constraint.replaceAll("\\s+", " ")).append('\n');
constraintErrors.forEach(error -> description.append(" ").append(error).append('\n'));
});
return description.toString();
}

private static String readResource(String resource) {
try (InputStream input =
[=vsumMainClass].class.getClassLoader().getResourceAsStream(resource)) {
return input == null ? "" : new String(input.readAllBytes(), StandardCharsets.UTF_8);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}

/**
* Describes the constraints that could not be compiled or evaluated.
* Reports the constraints violated after a change propagation. The Vitruv server offers the
* full results, including the violating elements, under {@code /vsum/constraints/validate}.
*
* @param result an evaluation result
* @return one entry per failed constraint with its errors
* @param report the validation result of all constraints
*/
static String describeFailures(BatchValidationResult result) {
StringBuilder description = new StringBuilder();
for (ConstraintResult failure : result.getFailedConstraints()) {
description
.append("- ")
.append(failure.getConstraint().strip().replaceAll("\\s+", " "))
.append('\n');
failure
.getCompilerErrors()
static void reportViolations(ConstraintValidationReport report) {
for (ConstraintValidationResult result : report.getUnsatisfiedResults()) {
String id = result.descriptor().id();
result
.violations()
.forEach(
error ->
description.append(
String.format(
" %d:%d %s%n", error.getLine(), error.getColumn(), error.getMessage())));
failure
.getFileErrors()
.forEach(error -> description.append(" ").append(error.getMessage()).append('\n'));
violation ->
System.err.println("[OCL VIOLATION] " + id + ": " + violation.message()));
result.errors().forEach(error -> System.err.println("[OCL ERROR] " + id + ": " + error));
}
return description.toString();
}
</#if>
}
4 changes: 2 additions & 2 deletions src/main/resources/templates/vsum/vsumPom.ftl
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@

<!-- VitruvOCL: cross-model constraint language and evaluator -->
<dependency>
<groupId>tools.vitruv.dsls</groupId>
<artifactId>vitruvocl-language</artifactId>
<groupId>tools.vitruv</groupId>
<artifactId>tools.vitruv.vitruvocl.language</artifactId>
</dependency>
</#if>

Expand Down
34 changes: 26 additions & 8 deletions src/main/resources/templates/vsum/vsumTest.ftl
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,17 @@ import java.nio.file.Path;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
<#if constraintResources?has_content>
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.List;
import java.util.stream.Collectors;
import org.junit.jupiter.api.Assertions;
import tools.vitruv.dsls.vitruvocl.pipeline.BatchValidationResult;
import tools.vitruv.dsls.vitruvocl.vitruv.VitruvOclConstraintChecker;
import tools.vitruv.framework.vsum.constraints.ConstraintDescriptor;
import tools.vitruv.framework.vsum.constraints.ConstraintStatus;
import tools.vitruv.framework.vsum.constraints.ConstraintValidationReport;
import tools.vitruv.framework.vsum.constraints.ConstraintValidationResult;
import tools.vitruv.framework.vsum.internal.InternalVirtualModel;
</#if>

Expand All @@ -27,15 +36,24 @@ class [=vsumMainClass]Test {
void constraintsCanBeEvaluated(@TempDir Path storageFolder) throws IOException {
InternalVirtualModel vsum = [=vsumMainClass].createVirtualModel(storageFolder);
try {
Assertions.assertEquals(
[=vsumMainClass].createConstraintChecker().getConstraints().size(),
vsum.getConstraints().size(),
"the VSUM registers all constraints");
ConstraintValidationReport report = vsum.validateConstraints();
for (String resource : [=vsumMainClass].CONSTRAINT_RESOURCES) {
BatchValidationResult result = [=vsumMainClass].evaluateConstraints(resource);
Set<String> ids =
VitruvOclConstraintChecker.fromClasspath(resource).getConstraints().stream()
.map(ConstraintDescriptor::id)
.collect(Collectors.toSet());
Map<String, List<String>> errors = new LinkedHashMap<>();
for (ConstraintValidationResult result : report.results()) {
if (result.status() == ConstraintStatus.ERROR && ids.contains(result.descriptor().id())) {
errors.put(result.descriptor().source(), result.errors());
}
}
Assertions.assertTrue(
result.allSucceeded(),
() ->
"Constraints in "
+ resource
+ " cannot be evaluated:\n"
+ [=vsumMainClass].describeFailures(result));
errors.isEmpty(), () -> [=vsumMainClass].describeFailures(resource, errors));
}
} finally {
vsum.dispose();
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/vsum-sample/constraints.ocl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
-- VitruviusOCL Constraint File for the Methodologist Template
--
-- This file defines cross-model consistency constraints between model and model2.
-- Constraints are evaluated against the VSUM via VitruvOCL.evaluateConstraints(path).
-- The generated VSUM registers the constraints, so its Vitruv server lists and validates them.
--
-- Syntax notes (OCL#):
-- - context <Namespace>::<Metaclass> inv <ConstraintName>:
Expand Down
Loading
Loading