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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
target/
.gradle/
.idea/
*.iml
56 changes: 53 additions & 3 deletions src/main/java/com/seleniumboot/migrator/Analyzer.java
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,9 @@ public Report analyze(Path root) throws IOException {
parsed++;
scan(result.getResult().get(), root.relativize(f).toString(), findings, locatorStats);
}
return new Report(files.size(), parsed, unparsable, findings,
BuildFileAnalyzer.detect(root), locatorStats.counts());
List<String> detectedTechnologies = BuildFileAnalyzer.detect(root);
return new Report(files.size(), parsed, unparsable, findings, detectedTechnologies,
recognizedTechnologies(detectedTechnologies), locatorStats.counts());
}

/** Analyze a single pasted source string. */
Expand All @@ -71,7 +72,7 @@ public Report analyzeSource(String source) {
return new Report(1, 0, List.of("<pasted>"), findings);
}
scan(result.getResult().get(), "<pasted>", findings, locatorStats);
return new Report(1, 1, List.of(), findings, List.of(), locatorStats.counts());
return new Report(1, 1, List.of(), findings, List.of(), List.of(), locatorStats.counts());
}

private void scan(CompilationUnit cu, String file, List<Finding> out, LocatorStats locatorStats) {
Expand Down Expand Up @@ -235,4 +236,53 @@ private static boolean isWebDriverType(String type) {
private static boolean isAnnotation(String name, String simpleName) {
return name.equals(simpleName) || name.endsWith("." + simpleName);
}

private static List<String> recognizedTechnologies(List<String> detectedTechnologies) {
boolean testNg = false;
boolean junit4 = false;
boolean junit5 = false;
boolean webDriverManager = false;
boolean extentReports = false;
boolean allure = false;
String seleniumVersion = null;

for (String detected : detectedTechnologies) {
if (!detected.startsWith("Dependency: ")) continue;

String[] coordinates = detected.substring("Dependency: ".length()).split(":", -1);
if (coordinates.length < 2) continue;

String groupId = coordinates[0];
String artifactId = coordinates[1];
String version = coordinates.length > 2 ? coordinates[2] : "";

if (groupId.equals("org.seleniumhq.selenium") && artifactId.equals("selenium-java")) {
seleniumVersion = version;
} else if (groupId.equals("org.testng") && artifactId.equals("testng")) {
testNg = true;
} else if (groupId.equals("junit") && artifactId.equals("junit")) {
junit4 = true;
} else if (groupId.equals("org.junit.jupiter")) {
junit5 = true;
} else if (groupId.equals("io.github.bonigarcia") && artifactId.equals("webdrivermanager")) {
webDriverManager = true;
} else if (groupId.equals("com.aventstack") && artifactId.equals("extentreports")) {
extentReports = true;
} else if (groupId.equals("io.qameta.allure")) {
allure = true;
}
}

List<String> recognized = new ArrayList<>();
if (seleniumVersion != null) {
recognized.add(seleniumVersion.isBlank() ? "Selenium" : "Selenium " + seleniumVersion);
}
if (testNg) recognized.add("TestNG");
if (junit4) recognized.add("JUnit 4");
if (junit5) recognized.add("JUnit 5");
if (webDriverManager) recognized.add("WebDriverManager");
if (extentReports) recognized.add("ExtentReports");
if (allure) recognized.add("Allure");
return List.copyOf(recognized);
}
}
13 changes: 10 additions & 3 deletions src/main/java/com/seleniumboot/migrator/Report.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@
import java.util.TreeMap;

public record Report(int filesFound, int filesParsed, List<String> unparsable, List<Finding> findings,
List<String> detectedTechnologies, Map<String, Long> locatorCounts) {
List<String> detectedTechnologies, List<String> recognizedTechnologies,
Map<String, Long> locatorCounts) {

public Report(int filesFound, int filesParsed, List<String> unparsable, List<Finding> findings) {
this(filesFound, filesParsed, unparsable, findings, List.of(), Map.of());
this(filesFound, filesParsed, unparsable, findings, List.of(), List.of(), Map.of());
}

public Report(int filesFound, int filesParsed, List<String> unparsable, List<Finding> findings,
List<String> detectedTechnologies) {
this(filesFound, filesParsed, unparsable, findings, detectedTechnologies, Map.of());
this(filesFound, filesParsed, unparsable, findings, detectedTechnologies, List.of(), Map.of());
}

public long count(Finding.Status s) {
Expand Down Expand Up @@ -58,6 +59,12 @@ public String render() {
} else {
detectedTechnologies.forEach(technology -> sb.append(" ").append(technology).append('\n'));
}
sb.append("\nRecognized technologies\n");
if (recognizedTechnologies.isEmpty()) {
sb.append(" No supported test technologies detected\n");
} else {
sb.append(" ").append(String.join(", ", recognizedTechnologies)).append('\n');
}
sb.append("\nLocator usage:\n");
if (locatorCounts.isEmpty()) {
sb.append(" None detected\n");
Expand Down
150 changes: 150 additions & 0 deletions src/test/java/com/seleniumboot/migrator/AnalyzerTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,125 @@ void ignoresBuildFilesInGeneratedAndVendorDirectories(@TempDir Path root) throws
assertTrue(output.contains("No supported build descriptor found"));
}

@Test
void detectsMavenAndTechnologies() throws Exception {
Path temp = Files.createTempDirectory("selenium-test");

Files.writeString(temp.resolve("pom.xml"), """
<project>
<dependencies>
<dependency>
<groupId>org.seleniumhq.selenium</groupId>
<artifactId>selenium-java</artifactId>
<version>4.20.0</version>
</dependency>
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>7.10.0</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.10.2</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
</dependency>
<dependency>
<groupId>io.github.bonigarcia</groupId>
<artifactId>webdrivermanager</artifactId>
<version>5.8.0</version>
</dependency>
<dependency>
<groupId>com.aventstack</groupId>
<artifactId>extentreports</artifactId>
<version>5.1.1</version>
</dependency>
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-testng</artifactId>
<version>2.27.0</version>
</dependency>
</dependencies>
</project>
""");

var report = new Analyzer().analyze(temp);

assertTrue(report.render().contains("Maven"));
assertTrue(report.render().contains("Selenium 4.20.0"));
assertTrue(report.render().contains("TestNG"));
assertTrue(report.render().contains("JUnit 5"));
assertTrue(report.render().contains("WebDriverManager"));
assertEquals(List.of("Selenium 4.20.0", "TestNG", "JUnit 4", "JUnit 5",
"WebDriverManager", "ExtentReports", "Allure"), report.recognizedTechnologies());
}

@Test
void recognizesOnlyDirectDependenciesAndDeduplicatesModules(@TempDir Path root) throws Exception {
Files.writeString(root.resolve("pom.xml"), """
<project>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.10.2</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>7.10.0</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<dependencies>
<dependency>
<groupId>com.aventstack</groupId>
<artifactId>extentreports</artifactId>
<version>5.1.1</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
""");

Path module = Files.createDirectories(root.resolve("module"));
Files.writeString(module.resolve("pom.xml"), """
<project>
<dependencies>
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>7.10.0</version>
</dependency>
<dependency>
<groupId>org.seleniumhq.selenium</groupId>
<artifactId>selenium-java</artifactId>
<version>4.20.0</version>
</dependency>
</dependencies>
</project>
""");

var report = new Analyzer().analyze(root);

assertEquals(List.of("Selenium 4.20.0", "TestNG"), report.recognizedTechnologies());
assertEquals(1, report.detectedTechnologies().stream()
.filter(dependency -> dependency.equals("Dependency: org.testng:testng:7.10.0"))
.count());
}

@Test
void allAutoFindingsHaveFullConfidence() {
var report = new Analyzer().analyzeSource("""
Expand Down Expand Up @@ -261,6 +380,37 @@ void waitForElement() {
.count());
}

@Test
void rejectsDoctypeInMavenBuildFile(@TempDir Path root) throws Exception {
Path secret = Files.writeString(root.resolve("external.txt"), "must-not-be-read");
Files.writeString(root.resolve("pom.xml"), """
<!DOCTYPE project [<!ENTITY xxe SYSTEM "%s">]>
<project>
<dependencies>
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>&xxe;</version>
</dependency>
</dependencies>
</project>
""".formatted(secret.toUri()));

String output = new Analyzer().analyze(root).render();

assertTrue(output.contains("Build system: Maven (could not parse pom.xml)"));
assertFalse(output.contains("must-not-be-read"));
}

@Test
void missingPomIsNotDetected() throws Exception {
Path temp = Files.createTempDirectory("selenium-test");

var report = new Analyzer().analyze(temp);

assertTrue(report.render().contains("No supported build descriptor found"));
}

@Test
void countsSeleniumLocatorUsageAndKeepsFullConfidence() {
var report = new Analyzer().analyzeSource("""
Expand Down