POM validator #1183
+464
−18
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| /* | ||
| * Copyright (c) 2018-2025, NWO-I CWI and Swat.engineering | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * | ||
| * 1. Redistributions of source code must retain the above copyright notice, | ||
| * this list of conditions and the following disclaimer. | ||
| * | ||
| * 2. Redistributions in binary form must reproduce the above copyright notice, | ||
| * this list of conditions and the following disclaimer in the documentation | ||
| * and/or other materials provided with the distribution. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| * POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
| package org.rascalmpl.vscode.lsp.xml; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.nio.file.Path; | ||
| import java.util.Properties; | ||
|
|
||
| import org.rascalmpl.util.maven.Artifact; | ||
| import org.rascalmpl.util.maven.MavenParser; | ||
| import org.rascalmpl.util.maven.ModelResolutionError; | ||
| import org.rascalmpl.util.maven.Scope; | ||
|
|
||
| import io.usethesource.vallang.IBool; | ||
| import io.usethesource.vallang.ISourceLocation; | ||
| import io.usethesource.vallang.IString; | ||
| import io.usethesource.vallang.IValueFactory; | ||
|
|
||
| public class PomAnalyzer { | ||
| private IValueFactory vf; | ||
|
|
||
| public PomAnalyzer(IValueFactory vf) { | ||
| this.vf = vf; | ||
| } | ||
|
|
||
| IBool hasDependency(ISourceLocation pomLoc, String groupId, String artifactId) { | ||
| try { | ||
| var mavenParser = new MavenParser(Path.of(pomLoc.getURI())); | ||
| var rootProject = mavenParser.parseProject(); | ||
| var resolvedDependencies = rootProject.resolveDependencies(Scope.COMPILE, mavenParser); | ||
| return vf.bool(resolvedDependencies.stream() | ||
| .map(Artifact::getCoordinate) | ||
| .filter(a -> a.getGroupId().equals(groupId) && a.getArtifactId().equals(artifactId)) | ||
| .findAny() | ||
| .isPresent()); | ||
| } catch (ModelResolutionError e) { | ||
| return vf.bool(false); | ||
| } | ||
| } | ||
|
|
||
| public IBool hasRascalDependency(ISourceLocation pomLoc) { | ||
| return hasDependency(pomLoc, "org.rascalmpl", "rascal"); | ||
| } | ||
|
|
||
| public IBool hasRascalLspDependency(ISourceLocation pomLoc) { | ||
| return hasDependency(pomLoc, "org.rascalmpl", "rascal-lsp"); | ||
| } | ||
|
|
||
| public IString getCurrentRascalLspVersion() { | ||
| var specificationVersion = PomAnalyzer.class.getPackage().getSpecificationVersion(); | ||
| if (specificationVersion != null) { | ||
| return vf.string(specificationVersion); | ||
| } | ||
|
|
||
| try (InputStream prop = PomAnalyzer.class.getClassLoader().getResourceAsStream("project.properties")) { | ||
| if (prop != null) { | ||
| Properties properties = new Properties(); | ||
| properties.load(prop); | ||
| var version = properties.getProperty("rascal.lsp.version"); | ||
| if (version != null) { | ||
| return vf.string(version); | ||
| } | ||
| } | ||
| } catch (IOException e) { | ||
| // Fall through | ||
| } | ||
|
|
||
| var fallbackVersion = "2.22.5"; | ||
| return vf.string(fallbackVersion); | ||
|
rodinaarssen marked this conversation as resolved.
Outdated
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| @license{ | ||
| Copyright (c) 2018-2025, NWO-I CWI and Swat.engineering | ||
| All rights reserved. | ||
|
|
||
| Redistribution and use in source and binary forms, with or without | ||
| modification, are permitted provided that the following conditions are met: | ||
|
|
||
| 1. Redistributions of source code must retain the above copyright notice, | ||
| this list of conditions and the following disclaimer. | ||
|
|
||
| 2. Redistributions in binary form must reproduce the above copyright notice, | ||
| this list of conditions and the following disclaimer in the documentation | ||
| and/or other materials provided with the distribution. | ||
|
|
||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| POSSIBILITY OF SUCH DAMAGE. | ||
| } | ||
| module lang::rascal::tests::pom::PomAnalyzerTests | ||
|
|
||
| import IO; | ||
| import String; | ||
| import analysis::diff::edits::TextEdits; | ||
| import lang::xml::PomAnalyzer; | ||
|
|
||
| public str pomWithRascal = "\<?xml version=\"1.0\" encoding=\"UTF-8\"?\> | ||
| '\<project xmlns=\"http://maven.apache.org/POM/4.0.0\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" | ||
| 'xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd\"\> | ||
| ' \<modelVersion\>4.0.0\</modelVersion\> | ||
| ' | ||
| ' \<groupId\>org.rascalmpl\</groupId\> | ||
| ' \<artifactId\>test-lib\</artifactId\> | ||
| ' \<version\>0.1.0-SNAPSHOT\</version\> | ||
| ' | ||
| ' \<dependencies\> | ||
| ' \<dependency\> | ||
| ' \<groupId\>org.rascalmpl\</groupId\> | ||
| ' \<artifactId\>rascal\</artifactId\> | ||
| ' \<version\>0.43.0-RC14\</version\> | ||
| ' \</dependency\> | ||
| ' \</dependencies\> | ||
| '\</project\>"; | ||
|
|
||
| public str pomWithoutDependencies = "\<?xml version=\"1.0\" encoding=\"UTF-8\"?\> | ||
| '\<project xmlns=\"http://maven.apache.org/POM/4.0.0\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" | ||
| 'xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd\"\> | ||
| ' \<modelVersion\>4.0.0\</modelVersion\> | ||
| ' | ||
| ' \<groupId\>org.rascalmpl\</groupId\> | ||
| ' \<artifactId\>test-lib\</artifactId\> | ||
| ' \<version\>0.1.0-SNAPSHOT\</version\> | ||
| ' | ||
| '\</project\>"; | ||
|
|
||
| public str pomWithEmptyDependenciesBlock = "\<?xml version=\"1.0\" encoding=\"UTF-8\"?\> | ||
| '\<project xmlns=\"http://maven.apache.org/POM/4.0.0\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" | ||
| 'xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd\"\> | ||
| ' \<modelVersion\>4.0.0\</modelVersion\> | ||
| ' | ||
| ' \<groupId\>org.rascalmpl\</groupId\> | ||
| ' \<artifactId\>test-lib\</artifactId\> | ||
| ' \<version\>0.1.0-SNAPSHOT\</version\> | ||
| ' | ||
| ' \<dependencies\> | ||
| ' \</dependencies\> | ||
| '\</project\>"; | ||
|
|
||
| public str pomWithNonEmptyDependenciesBlock = "\<?xml version=\"1.0\" encoding=\"UTF-8\"?\> | ||
| '\<project xmlns=\"http://maven.apache.org/POM/4.0.0\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" | ||
| 'xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd\"\> | ||
| ' \<modelVersion\>4.0.0\</modelVersion\> | ||
| ' | ||
| ' \<groupId\>org.rascalmpl\</groupId\> | ||
| ' \<artifactId\>test-lib\</artifactId\> | ||
| ' \<version\>0.1.0-SNAPSHOT\</version\> | ||
| ' | ||
| ' \<dependencies\> | ||
| ' \<dependency\> | ||
| ' \<groupId\>org.rascalmpl\<groupId\> | ||
| ' \<artifactId\>vallang\</artifactId\> | ||
| ' \<version\>0.15.1\</version\> | ||
| ' \</dependency\> | ||
| ' \</dependencies\> | ||
| '\</project\>"; | ||
|
|
||
| // `Path.of` does not like `memory` or plain `tmp` locations | ||
| public loc pomLoc = resolveLocation(|tmp:///rascal-pomxml-test/pom.xml|); | ||
|
|
||
| test bool testPomWithRascal() { | ||
| writeFile(pomLoc, pomWithRascal); | ||
| return hasRascalDependency(pomLoc); | ||
| } | ||
|
|
||
| test bool testPomWithoutDependencies() { | ||
| writeFile(pomLoc, pomWithoutDependencies); | ||
| if (hasRascalDependency(pomLoc)) { | ||
| return false; | ||
| } | ||
| edit = addRascalDependency(pomLoc); | ||
| newline = inferNewline(pomLoc); | ||
| expectedLoc = pomLoc(381 + 7 * size(newline),0,<8,35>,<8,35>); | ||
| return replace(expectedLoc, / <newline><newline> \<dependencies\><newline> \<dependency\><newline> \<groupId\>org.rascalmpl\<\/groupId\><newline> \<artifactId\>rascal\<\/artifactId\><newline> \<version\>[^\<]*\<\/version\><newline> \<\/dependency\><newline> \<\/dependencies\>/) := edit; | ||
| } | ||
|
|
||
| test bool testPomWithEmptyDependenciesBlock() { | ||
| writeFile(pomLoc, pomWithEmptyDependenciesBlock); | ||
| if (hasRascalDependency(pomLoc)) { | ||
| return false; | ||
| } | ||
| edit = addRascalDependency(pomLoc); | ||
| newline = inferNewline(pomLoc); | ||
| expectedLoc = pomLoc(383 + 9 * size(newline),31 + size(newline),<10,2>,<11,17>); | ||
| return replace(expectedLoc, /\<dependencies\><newline> \<dependency\><newline> \<groupId\>org.rascalmpl\<\/groupId\><newline> \<artifactId\>rascal\<\/artifactId\><newline> \<version\>[^\<]*\<\/version\><newline> \<\/dependency\><newline> \<\/dependencies\>/) := edit; | ||
| } | ||
|
|
||
| test bool testPomWithNonEmptyDependenciesBlock() { | ||
| writeFile(pomLoc, pomWithNonEmptyDependenciesBlock); | ||
| if (hasRascalDependency(pomLoc)) { | ||
| return false; | ||
| } | ||
| edit = addRascalDependency(pomLoc); | ||
| newline = inferNewline(pomLoc); | ||
| expectedLoc = pomLoc(397 + 10 * size(newline),0,<11,0>,<11,0>); | ||
| return replace(expectedLoc, / \<dependency\><newline> \<groupId\>org.rascalmpl\<\/groupId\><newline> \<artifactId\>rascal\<\/artifactId\><newline> \<version\>[^\<]*\<\/version\><newline> \<\/dependency\><newline>/) := edit; | ||
| } | ||
|
|
||
| test bool testAddRascalLspDependency() { | ||
| writeFile(pomLoc, pomWithNonEmptyDependenciesBlock); | ||
| if (hasRascalLspDependency(pomLoc)) { | ||
| return false; | ||
| } | ||
| edit = addRascalLspDependency(pomLoc); | ||
| newline = inferNewline(pomLoc); | ||
| expectedLoc = pomLoc(397 + 10 * size(newline),0,<11,0>,<11,0>); | ||
| return replace(expectedLoc, / \<dependency\><newline> \<groupId\>org.rascalmpl\<\/groupId\><newline> \<artifactId\>rascal-lsp\<\/artifactId\><newline> \<version\>[^\<]*\<\/version\><newline> \<\/dependency\><newline>/) := edit; | ||
| } | ||
|
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.