JavaAgent skip rule

Suszyński Krzysztof · Suszyński Krzysztof · commit cfddc7c8bb75 · 2016-03-30T14:52:33.000+02:00
diff --git a/pom.xml b/pom.xml
@@ -83,6 +83,7 @@
 
         <skipTests/>
         <coveralls.skip>${skipTests}</coveralls.skip>
+        <jacoco.version>0.7.6.201602180812</jacoco.version>
     </properties>
 
     <dependencies>
@@ -169,7 +170,7 @@
                 <plugin>
                     <groupId>org.jacoco</groupId>
                     <artifactId>jacoco-maven-plugin</artifactId>
-                    <version>0.7.6.201602180812</version>
+                    <version>${jacoco.version}</version>
                     <executions>
                         <execution>
                             <id>jacoco-initialize</id>
diff --git a/src/main/java/pl/wavesoftware/eid/ReturnTypesAreNonnullByDefault.java b/src/main/java/pl/wavesoftware/eid/ReturnTypesAreNonnullByDefault.java
@@ -7,7 +7,7 @@
 import java.lang.annotation.RetentionPolicy;
 
 /**
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  * @since 2016-03-26
  */
 @Nonnull
diff --git a/src/main/java/pl/wavesoftware/eid/exceptions/Eid.java b/src/main/java/pl/wavesoftware/eid/exceptions/Eid.java
@@ -15,7 +15,6 @@
  */
 package pl.wavesoftware.eid.exceptions;
 
-import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.io.Serializable;
 import java.util.ArrayList;
@@ -30,7 +29,7 @@
  * <p>
  * Exception identifier for all Eid Runtime Exceptions.
  *
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  */
 public class Eid implements Serializable {
 
@@ -170,7 +169,7 @@ public static String setRefFormat(String refFormat) {
      * @param parameters a parameters for logMessageFormat to by passed to {@link String#format(String, Object...)}
      * @return a formatted message
      */
-    public String makeLogMessage(@Nonnull String logMessageFormat, @Nonnull Object... parameters) {
+    public String makeLogMessage(String logMessageFormat, Object... parameters) {
         String message = String.format(logMessageFormat, parameters);
         return String.format(getMessageFormat(), this.toString(), message);
     }
diff --git a/src/main/java/pl/wavesoftware/eid/exceptions/EidContainer.java b/src/main/java/pl/wavesoftware/eid/exceptions/EidContainer.java
@@ -18,7 +18,7 @@
 /**
  * Indicate that object contains a Eid object
  *
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  */
 public interface EidContainer {
 
diff --git a/src/main/java/pl/wavesoftware/eid/exceptions/EidIllegalArgumentException.java b/src/main/java/pl/wavesoftware/eid/exceptions/EidIllegalArgumentException.java
@@ -23,7 +23,7 @@
  *
  * @see IllegalArgumentException
  * @see EidRuntimeException
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  */
 public class EidIllegalArgumentException extends EidRuntimeException {
 
@@ -85,7 +85,6 @@ public EidIllegalArgumentException(Eid id, String messageFormat, Object... param
     }
 
     /**
-     * @inheritdoc
      * @return {@link IllegalArgumentException} class
      */
     @Override
diff --git a/src/main/java/pl/wavesoftware/eid/exceptions/EidIllegalStateException.java b/src/main/java/pl/wavesoftware/eid/exceptions/EidIllegalStateException.java
@@ -23,7 +23,7 @@
  *
  * @see IllegalStateException
  * @see EidRuntimeException
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  */
 public class EidIllegalStateException extends EidRuntimeException {
 
@@ -85,7 +85,6 @@ public EidIllegalStateException(Eid id, String messageFormat, Object... paramete
     }
 
     /**
-     * @inheritdoc
      * @return {@link IllegalStateException} class
      */
     @Override
diff --git a/src/main/java/pl/wavesoftware/eid/exceptions/EidIndexOutOfBoundsException.java b/src/main/java/pl/wavesoftware/eid/exceptions/EidIndexOutOfBoundsException.java
@@ -23,7 +23,7 @@
  *
  * @see IndexOutOfBoundsException
  * @see EidRuntimeException
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  */
 public class EidIndexOutOfBoundsException extends EidRuntimeException {
 
@@ -85,7 +85,6 @@ public EidIndexOutOfBoundsException(Eid id, String messageFormat, Object... para
     }
 
     /**
-     * @inheritdoc
      * @return {@link IndexOutOfBoundsException} class
      */
     @Override
diff --git a/src/main/java/pl/wavesoftware/eid/exceptions/EidNullPointerException.java b/src/main/java/pl/wavesoftware/eid/exceptions/EidNullPointerException.java
@@ -23,7 +23,7 @@
  *
  * @see NullPointerException
  * @see EidRuntimeException
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  */
 public class EidNullPointerException extends EidRuntimeException {
 
@@ -85,7 +85,6 @@ public EidNullPointerException(Eid id, String messageFormat, Object... parameter
     }
 
     /**
-     * @inheritdoc
      * @return {@link NullPointerException} class
      */
     @Override
diff --git a/src/main/java/pl/wavesoftware/eid/exceptions/EidRuntimeException.java b/src/main/java/pl/wavesoftware/eid/exceptions/EidRuntimeException.java
@@ -34,7 +34,7 @@
  * <p>
  * For convenience use {@link pl.wavesoftware.eid.utils.EidPreconditions}
  *
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  */
 public class EidRuntimeException extends RuntimeException implements EidContainer {
 
diff --git a/src/main/java/pl/wavesoftware/eid/exceptions/package-info.java b/src/main/java/pl/wavesoftware/eid/exceptions/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * @author <a href="mailto:krzysztof.suszynski@coi.gov.pl">Krzysztof Suszynski</a>
+ * @since 29.03.16
+ */
+@javax.annotation.ParametersAreNonnullByDefault
+@pl.wavesoftware.eid.ReturnTypesAreNonnullByDefault
+package pl.wavesoftware.eid.exceptions;
diff --git a/src/main/java/pl/wavesoftware/eid/utils/EidPreconditions.java b/src/main/java/pl/wavesoftware/eid/utils/EidPreconditions.java
@@ -103,7 +103,7 @@
  *     }, "20150718:121521");
  * </code></pre>
  *
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  * @since 0.1.0 (idea imported from Guava Library and COI code)
  */
 public final class EidPreconditions {
diff --git a/src/main/java/pl/wavesoftware/eid/utils/package-info.java b/src/main/java/pl/wavesoftware/eid/utils/package-info.java
@@ -1,5 +1,5 @@
 /**
- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>
  * @since 2016-03-26
  */
 @javax.annotation.ParametersAreNonnullByDefault
diff --git a/src/test/java/pl/wavesoftware/eid/exceptions/EidIT.java b/src/test/java/pl/wavesoftware/eid/exceptions/EidIT.java
@@ -2,6 +2,7 @@
 
 import org.junit.ClassRule;
 import org.junit.Test;
+import org.junit.rules.RuleChain;
 import org.openjdk.jmh.annotations.Benchmark;
 import org.openjdk.jmh.annotations.Mode;
 import org.openjdk.jmh.annotations.Threads;
@@ -13,6 +14,7 @@
 import org.openjdk.jmh.runner.options.TimeValue;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import pl.wavesoftware.testing.JavaAgentSkip;
 import pl.wavesoftware.testing.JmhCleaner;
 
 import java.util.Collection;
@@ -33,7 +35,9 @@ public class EidIT {
     private static final double SPEED_THRESHOLD = 0.75d;
 
     @ClassRule
-    public static JmhCleaner cleaner = new JmhCleaner(EidIT.class);
+    public static RuleChain chain = RuleChain
+        .outerRule(new JmhCleaner(EidIT.class))
+        .around(JavaAgentSkip.ifActive());
 
     @Test
     public void doBenckmarking() throws Exception {
diff --git a/src/test/java/pl/wavesoftware/eid/utils/EidPreconditionsIT.java b/src/test/java/pl/wavesoftware/eid/utils/EidPreconditionsIT.java
@@ -3,6 +3,7 @@
 import com.google.common.base.Preconditions;
 import org.junit.ClassRule;
 import org.junit.Test;
+import org.junit.rules.RuleChain;
 import org.openjdk.jmh.annotations.Benchmark;
 import org.openjdk.jmh.annotations.Mode;
 import org.openjdk.jmh.annotations.Scope;
@@ -19,6 +20,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import pl.wavesoftware.eid.exceptions.EidRuntimeException;
+import pl.wavesoftware.testing.JavaAgentSkip;
 import pl.wavesoftware.testing.JmhCleaner;
 
 import java.lang.annotation.ElementType;
@@ -38,11 +40,13 @@
 public class EidPreconditionsIT {
     private static final int OPERATIONS = 1000;
     private static final double SPEED_THRESHOLD = 0.90;
-    private static final Logger LOG = LoggerFactory.getLogger(EidPreconditionsIT.class);
     private static final double PERCENT = 100;
+    private static final Logger LOG = LoggerFactory.getLogger(EidPreconditionsIT.class);
 
     @ClassRule
-    public static JmhCleaner cleaner = new JmhCleaner(EidPreconditionsIT.class);
+    public static RuleChain chain = RuleChain
+        .outerRule(new JmhCleaner(EidPreconditionsIT.class))
+        .around(JavaAgentSkip.ifActive());
 
     @Test
     public void doBenchmarking() throws RunnerException {
@@ -157,12 +161,12 @@ private void verifySpeedFor(TestCase testCase, Collection<RunResult> results) {
         double guava = getScore(guavaResult);
         double eid = getScore(eidResult);
 
-        double quotient = eid / guava;
+        double ratio = eid / guava;
 
-        LOG.info(String.format("%s: Guava score = %.2f vs Eid score = %.2f ==> quotient: %.2f%%, " +
+        LOG.info(String.format("%s: Guava score = %.2f vs Eid score = %.2f ==> ratio: %.2f%%, " +
             "minimum threshold: %.2f%%",
-            testCase, guava, eid, quotient * PERCENT, SPEED_THRESHOLD * PERCENT));
-        assertThat(quotient).isGreaterThanOrEqualTo(SPEED_THRESHOLD);
+            testCase, guava, eid, ratio * PERCENT, SPEED_THRESHOLD * PERCENT));
+        assertThat(ratio).isGreaterThanOrEqualTo(SPEED_THRESHOLD);
     }
 
     private static double getScore(RunResult result) {
diff --git a/src/test/java/pl/wavesoftware/testing/JavaAgentSkip.java b/src/test/java/pl/wavesoftware/testing/JavaAgentSkip.java
@@ -0,0 +1,60 @@
+package pl.wavesoftware.testing;
+
+import org.junit.Assume;
+import org.junit.rules.TestRule;
+import org.junit.runner.Description;
+import org.junit.runners.model.Statement;
+
+import java.lang.management.ManagementFactory;
+import java.lang.management.RuntimeMXBean;
+import java.util.List;
+
+/**
+ * @author <a href="mailto:krzysztof.suszynski@coi.gov.pl">Krzysztof Suszynski</a>
+ * @since 29.03.16
+ */
+public final class JavaAgentSkip implements TestRule {
+
+    public static final String JAVAAGENT = "-javaagent:";
+    private final boolean ifActive;
+
+    private JavaAgentSkip(boolean ifActive) {
+        this.ifActive = ifActive;
+    }
+
+    public static JavaAgentSkip ifActive() {
+        return new JavaAgentSkip(true);
+    }
+
+    public static JavaAgentSkip ifNotActive() {
+        return new JavaAgentSkip(false);
+    }
+
+    @Override
+    public Statement apply(final Statement base, Description description) {
+        return new Statement() {
+            @Override
+            public void evaluate() throws Throwable {
+                Assume.assumeTrue("Skipping test due to JavaAgentSkip rule that is set to " + ifActive, assumeValue());
+                base.evaluate();
+            }
+        };
+    }
+
+    private boolean assumeValue() {
+        return isAgentThere() != ifActive;
+    }
+
+    private boolean isAgentThere() {
+        RuntimeMXBean runtimeMxBean = ManagementFactory.getRuntimeMXBean();
+        List<String> arguments = runtimeMxBean.getInputArguments();
+        boolean agent = false;
+        for (String argument : arguments) {
+            if (argument.startsWith(JAVAAGENT)) {
+                agent = true;
+                break;
+            }
+        }
+        return agent;
+    }
+}
diff --git a/src/test/java/pl/wavesoftware/testing/JmhCleaner.java b/src/test/java/pl/wavesoftware/testing/JmhCleaner.java
@@ -1,23 +1,20 @@
 package pl.wavesoftware.testing;
 
-import com.google.common.io.Files;
-import java.io.File;
+import org.apache.commons.io.FileUtils;
 import org.junit.Test;
-import org.junit.rules.TestRule;
-import org.junit.runner.Description;
-import org.junit.runners.model.Statement;
+import org.junit.rules.ExternalResource;
 
+import java.io.File;
 import java.io.IOException;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
 import java.net.URISyntaxException;
-import org.apache.commons.io.FileUtils;
 
 /**
  * @author <a href="mailto:krzysztof.suszynski@coi.gov.pl">Krzysztof Suszynski</a>
  * @since 25.03.16
  */
-public class JmhCleaner implements TestRule {
+public class JmhCleaner extends ExternalResource {
     private static final String GENERATED_TEST_SOURCES = "generated-test-sources";
     private static final String TEST_ANNOTATIONS = "test-annotations";
     private final Class<?> testClass;
@@ -41,19 +38,15 @@ private Class<?> validateTestClass(Class<?> testClass) {
         return testClass;
     }
 
-
     @Override
-    public Statement apply(final Statement base, Description description) {
-        return new Statement() {
-            @Override
-            public void evaluate() throws Throwable {
-                try {
-                    base.evaluate();
-                } finally {
-                    cleanup();
-                }
-            }
-        };
+    protected void after() {
+        try {
+            cleanup();
+        } catch (IOException ex) {
+            throw new RuntimeException(ex);
+        } catch (URISyntaxException ex) {
+            throw new RuntimeException(ex);
+        }
     }
 
     private void cleanup() throws IOException, URISyntaxException {

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`/**`
`19`	`19`	`* Indicate that object contains a Eid object`
`20`	`20`	`*`
`21`		`- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>`
	`21`	`+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>`
`22`	`22`	`*/`
`23`	`23`	`public interface EidContainer {`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* @see IllegalArgumentException`
`25`	`25`	`* @see EidRuntimeException`
`26`		`- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>`
	`26`	`+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>`
`27`	`27`	`*/`
`28`	`28`	`public class EidIllegalArgumentException extends EidRuntimeException {`
`29`	`29`
`@@ -85,7 +85,6 @@ public EidIllegalArgumentException(Eid id, String messageFormat, Object... param`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`/**`
`88`		`- * @inheritdoc`
`89`	`88`	`* @return {@link IllegalArgumentException} class`
`90`	`89`	`*/`
`91`	`90`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`* <p>`
`35`	`35`	`* For convenience use {@link pl.wavesoftware.eid.utils.EidPreconditions}`
`36`	`36`	`*`
`37`		`- * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>`
	`37`	`+ * @author <a href="mailto:krzysztof.suszynski@wavesoftware.pl">Krzysztof Suszynski</a>`
`38`	`38`	`*/`
`39`	`39`	`public class EidRuntimeException extends RuntimeException implements EidContainer {`
`40`	`40`