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
25 changes: 25 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@
<emf.ecore.version>2.43.0</emf.ecore.version>
<emf.ecore.xmi.version>2.41.0</emf.ecore.xmi.version>
<emf.codegen.ecore.version>2.47.0</emf.codegen.ecore.version>
<!-- NeoJoin has no release yet; its snapshots are deployed to the Central snapshot
repository declared below. Without network access, install it locally instead:
./mvnw install -DskipTests in NeoJoin/lang -->
<neojoin.version>0.1.0-SNAPSHOT</neojoin.version>

<sonar.host.url>https://sonarcloud.io</sonar.host.url>
<sonar.organization>vitruv-tools</sonar.organization>
Expand Down Expand Up @@ -76,6 +80,13 @@
<version>${emf.codegen.ecore.version}</version>
</dependency>

<!-- parses and validates the uploaded NeoJoin view definitions before the build -->
<dependency>
<groupId>tools.vitruv</groupId>
<artifactId>tools.vitruv.neojoin.frontend.language</artifactId>
<version>${neojoin.version}</version>
</dependency>

<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
Expand All @@ -99,6 +110,20 @@
</dependency>
</dependencies>

<repositories>
<!-- only for the NeoJoin snapshots; releases still come from Maven Central -->
<repository>
<id>central-snapshots</id>
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>

<build>
<plugins>
<plugin>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ public record VsumBuildRequest(
/** File extension of VitruvOCL constraint files. */
public static final String CONSTRAINTS_EXTENSION = ".ocl";

/** File extension of view files. */
public static final String VIEWS_EXTENSION = ".nj";

/** Makes the lists immutable and rejects {@code null} lists. */
public VsumBuildRequest {
metamodels = List.copyOf(metamodels);
Expand Down Expand Up @@ -60,7 +63,7 @@ public static VsumBuildRequest fromMultipart(
read(metamodelFiles, "metamodel", METAMODEL_EXTENSION),
read(reactionFiles, "reactions", REACTIONS_EXTENSION),
read(constraintFiles, "constraint", CONSTRAINTS_EXTENSION),
read(viewFiles, "view definition", null));
read(viewFiles, "view definition", VIEWS_EXTENSION));
}

private static List<UploadedFile> read(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import tools.vitruv.methodologist.setup.vsum.service.project.ProjectGenerator;
import tools.vitruv.methodologist.setup.vsum.service.project.ProjectLayout;
import tools.vitruv.methodologist.setup.vsum.service.reactions.ReactionsProcessor;
import tools.vitruv.methodologist.setup.vsum.service.views.NeoJoinChecker;
import tools.vitruv.methodologist.setup.vsum.service.views.ViewDefinitionProcessor;

/**
Expand All @@ -48,6 +49,7 @@ public class VsumProjectBuildService {
private final MetamodelProcessor metamodelProcessor;
private final ReactionsProcessor reactionsProcessor;
private final ConstraintsProcessor constraintsProcessor;
private final NeoJoinChecker neoJoinChecker;
private final ViewDefinitionProcessor viewDefinitionProcessor;
private final ProjectGenerator projectGenerator;
private final MavenBuildRunner mavenBuildRunner;
Expand Down Expand Up @@ -131,6 +133,7 @@ ProjectSources generateProject(VsumBuildRequest request, Path projectRoot) throw
reactionsProcessor.process(request.reactions(), metamodels, projectRoot);
List<String> constraintResources =
constraintsProcessor.process(request.constraints(), projectRoot);
neoJoinChecker.check(request.viewDefinitions(), metamodels);
viewDefinitionProcessor.process(request.viewDefinitions(), metamodels, projectRoot);
projectGenerator.generate(projectRoot, metamodels, specifications, constraintResources);
return sources(request, metamodels, constraintResources, projectRoot);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
package tools.vitruv.methodologist.setup.vsum.service;

import java.io.IOException;
import java.util.List;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;
import tools.vitruv.methodologist.setup.exception.MethodologistSetupException;
import tools.vitruv.methodologist.setup.vsum.service.metamodel.GeneratedMetamodel;
import tools.vitruv.methodologist.setup.vsum.service.metamodel.MetamodelProcessor;
import tools.vitruv.methodologist.setup.vsum.service.problem.VsumBuildException;
import tools.vitruv.methodologist.setup.vsum.service.reactions.ReactionsProcessor;
import tools.vitruv.methodologist.setup.vsum.service.views.NeoJoinChecker;

/**
* Checks a VSUM project without building it, so that problems can be shown while it is edited.
Expand All @@ -23,10 +27,12 @@ public class VsumValidationService {

private final MetamodelProcessor metamodelProcessor;
private final ReactionsProcessor reactionsProcessor;
private final NeoJoinChecker neoJoinChecker;

/**
* Checks the project. Like the build, the checks stop at the first stage with problems: reactions
* are only checked once the metamodels are valid.
* and view definitions are only checked once the metamodels are valid, and view definitions once
* the reactions are.
*
* @param request the project, as for a build
* @return the problems the build would report before running Maven
Expand All @@ -35,10 +41,19 @@ public VsumValidationResult validate(VsumBuildRequest request) {
try {
List<GeneratedMetamodel> metamodels = metamodelProcessor.check(request.metamodels());
reactionsProcessor.check(request.reactions(), metamodels);
neoJoinChecker.check(request.viewDefinitions(), metamodels);
return VsumValidationResult.of(List.of());
} catch (VsumBuildException e) {
log.debug("VSUM validation found problems: {}", e.getMessage());
return VsumValidationResult.of(e.getProblems());
} catch (IOException e) {
// the views are checked from temporary files; failing to write them is not a problem of the
// uploads
throw new MethodologistSetupException(
VsumErrorCodes.BUILD_ERROR,
"Failed to validate the VSUM project: " + e.getMessage(),
HttpStatus.INTERNAL_SERVER_ERROR,
e);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
package tools.vitruv.methodologist.setup.vsum.service.views;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.emf.ecore.EValidator;
import org.eclipse.emf.ecore.EcorePackage;
import org.eclipse.emf.ecore.impl.EPackageRegistryImpl;
import org.eclipse.xtext.common.types.TypesPackage;
import org.eclipse.xtext.diagnostics.Severity;
import org.eclipse.xtext.xbase.XbasePackage;
import org.eclipse.xtext.xtype.XtypePackage;
import org.springframework.stereotype.Service;
import tools.vitruv.methodologist.setup.vsum.service.UploadedFile;
import tools.vitruv.methodologist.setup.vsum.service.VsumErrorCodes;
import tools.vitruv.methodologist.setup.vsum.service.metamodel.GeneratedMetamodel;
import tools.vitruv.methodologist.setup.vsum.service.problem.BuildProblem;
import tools.vitruv.methodologist.setup.vsum.service.problem.BuildProblem.Source;
import tools.vitruv.methodologist.setup.vsum.service.problem.Excerpts;
import tools.vitruv.methodologist.setup.vsum.service.problem.VsumBuildException;
import tools.vitruv.neojoin.NeoJoinStandaloneSetup;
import tools.vitruv.neojoin.Parser;
import tools.vitruv.neojoin.ast.AstPackage;

/**
* Checks NeoJoin view definitions before the build: parses and validates each file with NeoJoin
* against the uploaded metamodels, and rejects export names and view-type nsURIs declared in more
* than one file.
*/
@Service
public class NeoJoinChecker {

private static final Pattern EXPORT_PATTERN = Pattern.compile("(?m)^[ \\t]*(export)[ \\t]+");

/**
* Xtext registers NeoJoin's validator globally and keeps the first one, which is bound to the
* metamodels of the first check. Each check replaces it, and checks run one at a time.
*/
private static final Object XTEXT_VALIDATOR_LOCK = new Object();

/** The packages NeoJoin's validator is registered for. */
private static final List<EPackage> VALIDATED_PACKAGES =
List.of(
AstPackage.eINSTANCE,
XbasePackage.eINSTANCE,
XtypePackage.eINSTANCE,
TypesPackage.eINSTANCE);

/**
* Checks the view definitions against the metamodels. Syntax errors, unresolved imports, Xbase
* type errors, and duplicate export names or view-type nsURIs are reported together.
*
* @param viewDefinitions uploaded NeoJoin view definitions
* @param metamodels the processed metamodels the views may import
* @throws VsumBuildException when a view definition is invalid
* @throws IOException when a view definition cannot be written to a temporary file for parsing
*/
public void check(List<UploadedFile> viewDefinitions, List<GeneratedMetamodel> metamodels)
throws IOException {
synchronized (XTEXT_VALIDATOR_LOCK) {
checkExclusively(viewDefinitions, metamodels);
}
}

private void checkExclusively(
List<UploadedFile> viewDefinitions, List<GeneratedMetamodel> metamodels) throws IOException {

// 1. Register available metamodels
EPackage.Registry registry = new EPackageRegistryImpl();
register(EcorePackage.eINSTANCE, registry);

for (GeneratedMetamodel model : metamodels) {
if (model.ePackage() != null) {
register(model.ePackage(), registry);
}
}

// 2. Initialize NeoJoin parser
VALIDATED_PACKAGES.forEach(EValidator.Registry.INSTANCE::remove);
NeoJoinStandaloneSetup setup = new NeoJoinStandaloneSetup(registry);

List<BuildProblem> problems = new ArrayList<>();

Map<String, String> exportOwners = new HashMap<>();
Map<String, String> nsUriOwners = new HashMap<>();

// 3. Parse and validate each uploaded view
for (UploadedFile file : viewDefinitions) {
Parser parser = setup.getParser();
Path path = Files.createTempFile("neojoin-", ".nj");

try {
Files.write(path, file.content());

Parser.Result result = parser.parse(URI.createFileURI(path.toString()));

// 4. Collect NeoJoin validation errors
for (var issue : result.issues()) {
if (issue.getSeverity() == Severity.ERROR) {
problems.add(
BuildProblem.at(
Source.VIEWS,
file.fileName(),
file.text(),
issue.getLineNumber(),
issue.getColumn(),
issue.getMessage()));
}
}

// Handle a failed parse without diagnostics
if (result instanceof Parser.Result.Failure && result.issues().isEmpty()) {
problems.add(
BuildProblem.of(
Source.VIEWS, file.fileName(), "Unable to parse NeoJoin view definition"));
}

// 5. Check duplicates across files
if (result instanceof Parser.Result.Success success) {

String exportName = success.aqr().export().name();

String nsUri = success.aqr().export().uri().toString();

String previousExport = exportOwners.putIfAbsent(exportName, file.fileName());

if (previousExport != null) {
problems.add(
duplicateProblem(
file,
"Duplicate export name '"
+ exportName
+ "' already declared in "
+ previousExport));
}

String previousNsUri = nsUriOwners.putIfAbsent(nsUri, file.fileName());

if (previousNsUri != null) {
problems.add(
duplicateProblem(
file,
"Duplicate view-type nsURI '"
+ nsUri
+ "' already declared in "
+ previousNsUri));
}
}

} finally {
Files.deleteIfExists(path);
}
}

// 6. Reject invalid view definitions
if (!problems.isEmpty()) {
throw new VsumBuildException(
VsumErrorCodes.INPUT_ERROR, "Invalid NeoJoin view definitions:", problems);
}
}

private static void register(EPackage ePackage, EPackage.Registry registry) {

if (ePackage.getNsURI() != null) {
registry.put(ePackage.getNsURI(), ePackage);
}

for (EPackage subpackage : ePackage.getESubpackages()) {
register(subpackage, registry);
}
}

private static BuildProblem duplicateProblem(UploadedFile file, String message) {

String text = file.text();
Matcher matcher = EXPORT_PATTERN.matcher(text);

if (!matcher.find()) {
return BuildProblem.of(Source.VIEWS, file.fileName(), message);
}

int offset = matcher.start(1);

return BuildProblem.at(
Source.VIEWS,
file.fileName(),
text,
Excerpts.lineOf(text, offset),
Excerpts.columnOf(text, offset),
message);
}
}
Loading
Loading