Skip to content

Improve the error message. #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 16, 2021
Merged

Improve the error message. #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion boat-maven-plugin/src/main/java/com/backbase/oss/boat/BundleMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,13 @@ String versionFileName(String originalFileName, OpenAPI openAPI) throws MojoExec
if (openApiVersion == null) {
throw new MojoExecutionException("Configured to use version in filename, but no version set.");
}
String majorFromFileName = originalFileName.replaceAll("^(.*api-v)([0-9]+)(\\.yaml$)", "$2");
if (!openApiVersion.matches("^\\d\\..*")) {
throw new MojoExecutionException(
"Version should be semver (or at least have a recognisable major version), but found '" + openApiVersion
+ "' (string starts with number and dot: 2.0.0, 2.blabla, 2.3.4.5.6.234234)");
}
String majorFromVersion = openApiVersion.substring(0, openApiVersion.indexOf("."));
String majorFromFileName = originalFileName.replaceAll("^(.*api-v)([0-9]+)(\\.yaml$)", "$2");
if (!majorFromFileName.equals(majorFromVersion)) {
throw new MojoExecutionException("Invalid version " + openApiVersion + " in file " + originalFileName);
}
Expand Down
18 changes: 16 additions & 2 deletions boat-maven-plugin/src/test/java/com/backbase/oss/boat/BundleMojoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.function.Executable;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
Expand Down Expand Up @@ -110,10 +111,23 @@ void testInvalidVersionInApi() {

OpenAPI openAPI = new OpenAPI();
openAPI.setInfo(new Info());
assertThrows(MojoExecutionException.class, () ->
mojo.versionFileName("payment-order-client-api-v2.yaml", createOpenApiWithVersion("3.0.0")));
assertThrowsMojoExecutionExceptionWithMessage(
() -> mojo.versionFileName("payment-order-client-api-v2.yaml", createOpenApiWithVersion("3.0.0")),
"Invalid version 3.0.0 in file payment-order-client-api-v2.yaml");
assertThrowsMojoExecutionExceptionWithMessage(
() -> mojo.versionFileName("payment-order-client-api-v2.yaml", createOpenApiWithVersion("v2.0")),
"Version should be semver (or at least have a recognisable major version), but found 'v2.0'");
assertThrowsMojoExecutionExceptionWithMessage(
() -> mojo.versionFileName("payment-order-client-api-v2.yaml", createOpenApiWithVersion("2dada")),
"Version should be semver (or at least have a recognisable major version), but found '2dada'");

}

private void assertThrowsMojoExecutionExceptionWithMessage(Executable executable, String message) {
MojoExecutionException thrown = assertThrows(MojoExecutionException.class, executable);
assertTrue(thrown.getMessage().startsWith(message), "Expected message '" + message + "' but got '"
+ thrown.getMessage() + "'");
}

private OpenAPI createOpenApiWithVersion(String version) {
OpenAPI openAPI = new OpenAPI();
Expand Down