From 4595134a3b57a262c7630c7b5551c9c8c7b62c50 Mon Sep 17 00:00:00 2001 From: maxonfjvipon Date: Fri, 18 Aug 2023 18:27:50 +0300 Subject: [PATCH 1/5] feat(#1708): verify mojo + tests --- .../java/org/eolang/maven/VerifyMojo.java | 38 ++++++ .../test/java/org/eolang/maven/FakeMaven.java | 10 +- .../java/org/eolang/maven/VerifyMojoTest.java | 116 ++++++++++++++++++ 3 files changed, 160 insertions(+), 4 deletions(-) create mode 100644 eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java create mode 100644 eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java new file mode 100644 index 0000000000..adf00c834e --- /dev/null +++ b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java @@ -0,0 +1,38 @@ +/* + * The MIT License (MIT) + * + * Copyright (c) 2016-2023 Objectionary.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package org.eolang.maven; + +import java.io.IOException; + +/** + * Mojo that checks errors and warnings after "assemble" phase. + */ +public final class VerifyMojo extends SafeMojo { + @Override + void exec() throws IOException { + throw new UnsupportedOperationException( + "The VerifyMojo is not implemented yet" + ); + } +} diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/FakeMaven.java b/eo-maven-plugin/src/test/java/org/eolang/maven/FakeMaven.java index 310ff30442..8e1ef21fc6 100644 --- a/eo-maven-plugin/src/test/java/org/eolang/maven/FakeMaven.java +++ b/eo-maven-plugin/src/test/java/org/eolang/maven/FakeMaven.java @@ -615,15 +615,17 @@ public Iterator> iterator() { } /** - * Replaces versions as tags with versions as compound hashes. + * Check errors and warnings. * - * @since 0.29.5 + * @since 0.31.0 */ - static final class Versions implements Iterable> { + static final class Verify implements Iterable> { @Override public Iterator> iterator() { return Arrays.>asList( - ParseMojo.class + ParseMojo.class, + OptimizeMojo.class, + VerifyMojo.class ).iterator(); } } diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java b/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java new file mode 100644 index 0000000000..ecf380c309 --- /dev/null +++ b/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java @@ -0,0 +1,116 @@ +/* + * The MIT License (MIT) + * + * Copyright (c) 2016-2023 Objectionary.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package org.eolang.maven; + +import java.nio.file.Path; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +/** + * Test cases for {@link VerifyMojo}. + */ +public class VerifyMojoTest { + + @Test + @Disabled + void doesNotFailWithNoErrorsAndWarnings(@TempDir final Path temp) { + Assertions.assertDoesNotThrow( + () -> new FakeMaven(temp) + .withHelloWorld() + .execute(new FakeMaven.Verify()), + "Correct program should not have failed, but it does" + ); + } + + @Test + @Disabled + void detectsErrorsSuccessfully(@TempDir final Path temp) { + Assertions.assertThrows( + IllegalStateException.class, + () -> new FakeMaven(temp) + .withProgram( + "+package f\n", + "[] > main", + " QQ.io.stdout", + " \"Hello world\"" + ) + .execute(new FakeMaven.Verify()), + "Program with noname attributes should have failed or error, but it didn't" + ); + } + + @Test + @Disabled + void detectsWarningWithCorrespondingFlag(@TempDir final Path temp) { + Assertions.assertThrows( + IllegalStateException.class, + () -> new FakeMaven(temp) + .withProgram( + "+package f\n", + "[] > main", + " [] > @", + " \"Hello world\" > @" + ) + .with("failOnWarning", true) + .execute(new FakeMaven.Verify()), + "Program with sparse decorated object should have failed on warning, but it didn't" + ); + } + + @Test + @Disabled + void doesNotDetectWarningWithoutCorrespondingFlag(@TempDir final Path temp) { + Assertions.assertDoesNotThrow( + () -> new FakeMaven(temp) + .withProgram( + "+package f\n", + "[] > main", + " [] > @", + " \"Hello world\" > @" + ) + .with("failOnWarning", false) + .execute(new FakeMaven.Verify()), + "Program with sparse decorated object should not have failed on warning without flag, but it does" + ); + } + + @Test + @Disabled + void detectsCriticalError(@TempDir final Path temp) { + Assertions.assertThrows( + IllegalStateException.class, + () -> new FakeMaven(temp) + .withProgram( + "+package f\n", + "[] > main", + " [] > name", + " [] > name" + ) + .execute(new FakeMaven.Verify()), + "Program with duplicate names should have failed on critical error, but it didn't" + ); + } +} From b52ed62dd8ece5f453568953801ce503c5e0f0ce Mon Sep 17 00:00:00 2001 From: maxonfjvipon Date: Fri, 18 Aug 2023 18:33:38 +0300 Subject: [PATCH 2/5] feat(#1708): todo --- .../java/org/eolang/maven/VerifyMojo.java | 24 +++++++++++++++++++ .../java/org/eolang/maven/VerifyMojoTest.java | 2 ++ 2 files changed, 26 insertions(+) diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java index adf00c834e..683bb31c64 100644 --- a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java +++ b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java @@ -23,12 +23,36 @@ */ package org.eolang.maven; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; + import java.io.IOException; /** * Mojo that checks errors and warnings after "assemble" phase. + * + * @since 0.31.0 + * @todo #1708:30min Implement VerifyMojo. VerifyMojo should check all errors + * and critical errors in xmir after {@link AssembleMojo} is finished. Also if + * {@code failOnWarning} flag is set to true - mojo should check warnings. When + * mojo is implemented - need to remove "failOnError" flag from + * {@link OptimizeMojo} and put "verify" step right after "assemble" in all + * pom.xml files */ public final class VerifyMojo extends SafeMojo { + /** + * Whether we should fail on warning. + * + * @checkstyle MemberNameCheck (10 lines) + */ + @SuppressWarnings("PMD.ImmutableField") + @Parameter( + property = "eo.failOnWarning", + required = true, + defaultValue = "false" + ) + private boolean failOnWarning; + @Override void exec() throws IOException { throw new UnsupportedOperationException( diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java b/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java index ecf380c309..4e52e0e7d7 100644 --- a/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java +++ b/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java @@ -31,6 +31,8 @@ /** * Test cases for {@link VerifyMojo}. + * + * @since 0.31.0 */ public class VerifyMojoTest { From 05f01bd9cfb07468ba459cb463e0411ef1d978be Mon Sep 17 00:00:00 2001 From: maxonfjvipon Date: Fri, 18 Aug 2023 18:34:30 +0300 Subject: [PATCH 3/5] feat(#1708): mojo --- .../src/main/java/org/eolang/maven/VerifyMojo.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java index 683bb31c64..cf9ca29bef 100644 --- a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java +++ b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java @@ -23,6 +23,7 @@ */ package org.eolang.maven; +import org.apache.maven.plugins.annotations.LifecyclePhase; import org.apache.maven.plugins.annotations.Mojo; import org.apache.maven.plugins.annotations.Parameter; @@ -39,6 +40,11 @@ * {@link OptimizeMojo} and put "verify" step right after "assemble" in all * pom.xml files */ +@Mojo( + name = "verify", + defaultPhase = LifecyclePhase.PROCESS_SOURCES, + threadSafe = true +) public final class VerifyMojo extends SafeMojo { /** * Whether we should fail on warning. From cb268b8e45bdcf36d55d206e653bf835e33b71c5 Mon Sep 17 00:00:00 2001 From: maxonfjvipon Date: Fri, 18 Aug 2023 18:37:09 +0300 Subject: [PATCH 4/5] feat(#1708): checkstyle --- .../src/main/java/org/eolang/maven/VerifyMojo.java | 6 +++--- .../src/test/java/org/eolang/maven/VerifyMojoTest.java | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java index cf9ca29bef..73480aaec0 100644 --- a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java +++ b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java @@ -23,12 +23,11 @@ */ package org.eolang.maven; +import java.io.IOException; import org.apache.maven.plugins.annotations.LifecyclePhase; import org.apache.maven.plugins.annotations.Mojo; import org.apache.maven.plugins.annotations.Parameter; -import java.io.IOException; - /** * Mojo that checks errors and warnings after "assemble" phase. * @@ -49,7 +48,8 @@ public final class VerifyMojo extends SafeMojo { /** * Whether we should fail on warning. * - * @checkstyle MemberNameCheck (10 lines) + * @checkstyle MemberNameCheck (11 lines) + * @checkstyle UnusedPrivateField (10 lines) */ @SuppressWarnings("PMD.ImmutableField") @Parameter( diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java b/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java index 4e52e0e7d7..b9759ac2e2 100644 --- a/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java +++ b/eo-maven-plugin/src/test/java/org/eolang/maven/VerifyMojoTest.java @@ -34,7 +34,7 @@ * * @since 0.31.0 */ -public class VerifyMojoTest { +class VerifyMojoTest { @Test @Disabled From 074b5b2c4cff13aecb582f6fa05d6a4f513733e1 Mon Sep 17 00:00:00 2001 From: maxonfjvipon Date: Fri, 18 Aug 2023 18:49:12 +0300 Subject: [PATCH 5/5] feat(#1708): unused field --- .../src/main/java/org/eolang/maven/VerifyMojo.java | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java index 73480aaec0..e583b207b0 100644 --- a/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java +++ b/eo-maven-plugin/src/main/java/org/eolang/maven/VerifyMojo.java @@ -49,7 +49,6 @@ public final class VerifyMojo extends SafeMojo { * Whether we should fail on warning. * * @checkstyle MemberNameCheck (11 lines) - * @checkstyle UnusedPrivateField (10 lines) */ @SuppressWarnings("PMD.ImmutableField") @Parameter( @@ -62,7 +61,10 @@ public final class VerifyMojo extends SafeMojo { @Override void exec() throws IOException { throw new UnsupportedOperationException( - "The VerifyMojo is not implemented yet" + String.format( + "The VerifyMojo is not implemented yet, failOnWarning is %s", + this.failOnWarning + ) ); } }