add examples

baev · baev · commit 20d795988a52 · 2017-05-21T19:44:46.000+03:00
diff --git a/allure-junit5/build.gradle b/allure-junit5/build.gradle
@@ -55,6 +55,10 @@ task spiOffJar(type: Jar, dependsOn: classes) {
     from sourceSets.main.output
 }
 
+configurations {
+    spiOff.extendsFrom(compile)
+}
+
 artifacts {
-    archives spiOffJar
+    spiOff spiOffJar
 }
diff --git a/allure-junit5/src/main/java/io/qameta/allure/junit5/AllureJunit5.java b/allure-junit5/src/main/java/io/qameta/allure/junit5/AllureJunit5.java
@@ -1,8 +1,11 @@
-package io.qameta.allure;
+package io.qameta.allure.junit5;
 
-import io.qameta.allure.util.ResultsUtils;
+import io.qameta.allure.Allure;
+import io.qameta.allure.AllureLifecycle;
 import io.qameta.allure.model.Stage;
+import io.qameta.allure.model.Status;
 import io.qameta.allure.model.TestResult;
+import io.qameta.allure.util.ResultsUtils;
 import org.junit.platform.engine.TestExecutionResult;
 import org.junit.platform.launcher.TestExecutionListener;
 import org.junit.platform.launcher.TestIdentifier;
@@ -46,7 +49,7 @@ public void executionStarted(final TestIdentifier testIdentifier) {
             final TestResult result = new TestResult()
                     .withUuid(uuid)
                     .withName(testIdentifier.getDisplayName())
-                    .withHistoryId(md5(testIdentifier.getUniqueId()))
+                    .withHistoryId(getHistoryId(testIdentifier))
                     .withStage(Stage.RUNNING);
             getLifecycle().scheduleTestCase(result);
             getLifecycle().startTestCase(uuid);
@@ -63,7 +66,7 @@ public void executionFinished(final TestIdentifier testIdentifier, final TestExe
                 switch (testExecutionResult.getStatus()) {
                     case FAILED:
                         testExecutionResult.getThrowable().ifPresent(throwable -> {
-                            result.setStatus(ResultsUtils.getStatus(throwable).orElse(FAILED));
+                            result.setStatus(getStatus(throwable));
                             result.setStatusDetails(ResultsUtils.getStatusDetails(throwable).orElse(null));
                         });
                         break;
@@ -83,6 +86,14 @@ public void executionFinished(final TestIdentifier testIdentifier, final TestExe
         }
     }
 
+    protected Status getStatus(final Throwable throwable) {
+        return ResultsUtils.getStatus(throwable).orElse(FAILED);
+    }
+
+    protected String getHistoryId(final TestIdentifier testIdentifier) {
+        return md5(testIdentifier.getUniqueId());
+    }
+
     private String md5(final String source) {
         final byte[] bytes = getMessageDigest().digest(source.getBytes(UTF_8));
         return new BigInteger(1, bytes).toString(16);
diff --git a/allure-junit5/src/main/services/org.junit.platform.launcher.TestExecutionListener b/allure-junit5/src/main/services/org.junit.platform.launcher.TestExecutionListener
@@ -1 +1 @@
-io.qameta.allure.AllureJunit5
+io.qameta.allure.junit5.AllureJunit5
diff --git a/allure-junit5/src/test/java/io/qameta/allure/junit5/AllureJunit5Test.java b/allure-junit5/src/test/java/io/qameta/allure/junit5/AllureJunit5Test.java
@@ -1,6 +1,5 @@
 package io.qameta.allure.junit5;
 
-import io.qameta.allure.AllureJunit5;
 import io.qameta.allure.AllureLifecycle;
 import io.qameta.allure.aspects.AttachmentsAspects;
 import io.qameta.allure.aspects.StepsAspects;
diff --git a/allure-testng/build.gradle b/allure-testng/build.gradle
@@ -50,6 +50,10 @@ task spiOffJar(type: Jar, dependsOn: classes) {
     from sourceSets.main.output
 }
 
+configurations {
+    spiOff.extendsFrom(compile)
+}
+
 artifacts {
-    archives spiOffJar
+    spiOff spiOffJar
 }
diff --git a/examples/junit5-extended-listener/build.gradle b/examples/junit5-extended-listener/build.gradle
@@ -0,0 +1,39 @@
+description = 'Allure JUnit 5 example'
+
+apply plugin: 'org.junit.platform.gradle.plugin'
+
+configurations {
+    agent
+}
+
+dependencies {
+    agent 'org.aspectj:aspectjweaver'
+
+    testCompile 'org.slf4j:slf4j-simple'
+    testCompile('org.junit.jupiter:junit-jupiter-api')
+    testRuntime('org.junit.jupiter:junit-jupiter-engine')
+    testCompile project(path: ':allure-junit5', configuration: 'spiOff')
+}
+
+junitPlatform {
+    filters {
+        engines {
+            include 'junit-jupiter'
+        }
+        includeClassNamePattern '.*Test'
+    }
+    enableStandardTestTask true
+}
+
+tasks.withType(JavaExec) {
+    if (it.name == 'junitPlatformTest') {
+        doFirst {
+            jvmArgs "-javaagent:${configurations.agent.singleFile}"
+        }
+    }
+}
+
+test {
+    useTestNG()
+}
+
diff --git a/examples/junit5-extended-listener/src/test/java/io/qameta/allure/junit5/CustomListener.java b/examples/junit5-extended-listener/src/test/java/io/qameta/allure/junit5/CustomListener.java
@@ -0,0 +1,20 @@
+package io.qameta.allure.junit5;
+
+import io.qameta.allure.model.Status;
+import org.junit.platform.launcher.TestIdentifier;
+
+/**
+ * @author charlie (Dmitry Baev).
+ */
+public class CustomListener extends AllureJunit5 {
+
+    @Override
+    protected Status getStatus(final Throwable throwable) {
+        return Status.FAILED;
+    }
+
+    @Override
+    protected String getHistoryId(final TestIdentifier testIdentifier) {
+        return null;
+    }
+}
diff --git a/examples/junit5-extended-listener/src/test/java/io/qameta/allure/junit5/Junit5Test.java b/examples/junit5-extended-listener/src/test/java/io/qameta/allure/junit5/Junit5Test.java
@@ -0,0 +1,13 @@
+package io.qameta.allure.junit5;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * @author charlie (Dmitry Baev).
+ */
+public class Junit5Test {
+
+    @Test
+    void junit5Test() {
+    }
+}
diff --git a/examples/junit5-extended-listener/src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener b/examples/junit5-extended-listener/src/test/resources/META-INF/services/org.junit.platform.launcher.TestExecutionListener
@@ -0,0 +1 @@
+io.qameta.allure.junit5.CustomListener
diff --git a/examples/junit5-extended-listener/src/test/resources/allure.properties b/examples/junit5-extended-listener/src/test/resources/allure.properties
@@ -0,0 +1 @@
+allure.results.directory=build/allure-results
diff --git a/examples/junit5/build.gradle b/examples/junit5/build.gradle
@@ -0,0 +1,39 @@
+description = 'Allure JUnit 5 example'
+
+apply plugin: 'org.junit.platform.gradle.plugin'
+
+configurations {
+    agent
+}
+
+dependencies {
+    agent 'org.aspectj:aspectjweaver'
+
+    testCompile 'org.slf4j:slf4j-simple'
+    testCompile('org.junit.jupiter:junit-jupiter-api')
+    testRuntime('org.junit.jupiter:junit-jupiter-engine')
+    testCompile project(':allure-junit5')
+}
+
+junitPlatform {
+    filters {
+        engines {
+            include 'junit-jupiter'
+        }
+        includeClassNamePattern '.*Test'
+    }
+    enableStandardTestTask true
+}
+
+tasks.withType(JavaExec) {
+    if (it.name == 'junitPlatformTest') {
+        doFirst {
+            jvmArgs "-javaagent:${configurations.agent.singleFile}"
+        }
+    }
+}
+
+test {
+    useTestNG()
+}
+
diff --git a/examples/junit5/src/test/java/io/qameta/allure/junit5/Junit5Test.java b/examples/junit5/src/test/java/io/qameta/allure/junit5/Junit5Test.java
@@ -0,0 +1,13 @@
+package io.qameta.allure.junit5;
+
+import org.junit.jupiter.api.Test;
+
+/**
+ * @author charlie (Dmitry Baev).
+ */
+public class Junit5Test {
+
+    @Test
+    void junit5Test() {
+    }
+}
diff --git a/examples/junit5/src/test/resources/allure.properties b/examples/junit5/src/test/resources/allure.properties
@@ -0,0 +1 @@
+allure.results.directory=build/allure-results
diff --git a/examples/testng-extended-listener/build.gradle b/examples/testng-extended-listener/build.gradle
@@ -0,0 +1,24 @@
+description = 'Allure TestNG custom listener example'
+
+configurations {
+    agent
+}
+
+dependencies {
+    agent 'org.aspectj:aspectjweaver'
+
+    testCompile 'org.slf4j:slf4j-simple'
+    testCompile 'org.testng:testng'
+    testCompile project(path: ':allure-testng', configuration: 'spiOff')
+}
+
+test.doFirst {
+    jvmArgs "-javaagent:${configurations.agent.singleFile}"
+}
+
+test {
+    useTestNG {
+        suites 'src/test/resources/testng.xml'
+    }
+}
+
diff --git a/examples/testng-extended-listener/src/test/java/io/qameta/allure/testng/CustomListener.java b/examples/testng-extended-listener/src/test/java/io/qameta/allure/testng/CustomListener.java
@@ -0,0 +1,23 @@
+package io.qameta.allure.testng;
+
+import io.qameta.allure.model.Status;
+
+import java.util.Map;
+
+/**
+ * An example of custom listener that changes broken statuses to failed and disables history.
+ *
+ * @author charlie (Dmitry Baev).
+ */
+public class CustomListener extends AllureTestNg {
+
+    @Override
+    protected Status getStatus(final Throwable throwable) {
+        return Status.FAILED;
+    }
+
+    @Override
+    protected String getHistoryId(final String name, final Map<String, String> parameters) {
+        return null;
+    }
+}
diff --git a/examples/testng-extended-listener/src/test/java/io/qameta/allure/testng/TestNgTest.java b/examples/testng-extended-listener/src/test/java/io/qameta/allure/testng/TestNgTest.java
@@ -0,0 +1,13 @@
+package io.qameta.allure.testng;
+
+import org.testng.annotations.Test;
+
+/**
+ * @author charlie (Dmitry Baev).
+ */
+public class TestNgTest {
+
+    @Test
+    public void testNgTest() throws Exception {
+    }
+}
diff --git a/examples/testng-extended-listener/src/test/resources/allure.properties b/examples/testng-extended-listener/src/test/resources/allure.properties
@@ -0,0 +1 @@
+allure.results.directory=build/allure-results
diff --git a/examples/testng-extended-listener/src/test/resources/testng.xml b/examples/testng-extended-listener/src/test/resources/testng.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+
+<suite name="My suite">
+    <listeners>
+        <listener class-name="io.qameta.allure.testng.CustomListener"/>
+    </listeners>
+    <test name="All">
+        <classes>
+            <class name="io.qameta.allure.testng.TestNgTest" />
+        </classes>
+    </test>
+</suite>
diff --git a/examples/testng/build.gradle b/examples/testng/build.gradle
@@ -0,0 +1,21 @@
+description = 'Allure TestNG example'
+
+configurations {
+    agent
+}
+
+dependencies {
+    agent 'org.aspectj:aspectjweaver'
+
+    testCompile 'org.slf4j:slf4j-simple'
+    testCompile project(':allure-testng')
+}
+
+test.doFirst {
+    jvmArgs "-javaagent:${configurations.agent.singleFile}"
+}
+
+test {
+    useTestNG()
+}
+
diff --git a/examples/testng/src/test/java/io/qameta/allure/testng/TestNgTest.java b/examples/testng/src/test/java/io/qameta/allure/testng/TestNgTest.java
@@ -0,0 +1,13 @@
+package io.qameta.allure.testng;
+
+import org.testng.annotations.Test;
+
+/**
+ * @author charlie (Dmitry Baev).
+ */
+public class TestNgTest {
+
+    @Test
+    public void testNgTest() throws Exception {
+    }
+}
diff --git a/examples/testng/src/test/resources/allure.properties b/examples/testng/src/test/resources/allure.properties
@@ -0,0 +1 @@
+allure.results.directory=build/allure-results
diff --git a/examples/testng/src/test/resources/testng.xml b/examples/testng/src/test/resources/testng.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
+
+<suite name="My suite">
+    <test name="All">
+        <classes>
+            <class name="io.qameta.allure.testng.TestNgTest" />
+        </classes>
+    </test>
+</suite>
diff --git a/gradle/bintray.gradle b/gradle/bintray.gradle
@@ -4,7 +4,7 @@ bintray {
     user = project.hasProperty('bintrayUser') ? project.property('bintrayUser') : System.getenv('BINTRAY_USER')
     key = project.hasProperty('bintrayApiKey') ? project.property('bintrayApiKey') : System.getenv('BINTRAY_API_KEY')
 
-    configurations = ['archives']
+    configurations = ['archives', 'spiOff']
 
     publish = true
     pkg {
diff --git a/settings.gradle b/settings.gradle
@@ -9,3 +9,15 @@ include 'allure-descriptions-javadoc'
 include 'allure-rest-assured'
 include 'allure-retrofit'
 include 'allure-http-attachment'
+
+def examples = [
+        'testng',
+        'testng-extended-listener',
+        'junit5',
+        'junit5-extended-listener'
+]
+
+examples.forEach({
+    include "examples/$it"
+    project(":examples/$it").name = it
+})

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,10 @@ task spiOffJar(type: Jar, dependsOn: classes) {`
`55`	`55`	`from sourceSets.main.output`
`56`	`56`	`}`
`57`	`57`
	`58`	`+configurations {`
	`59`	`+ spiOff.extendsFrom(compile)`
	`60`	`+}`
	`61`	`+`
`58`	`62`	`artifacts {`
`59`		`- archives spiOffJar`
	`63`	`+ spiOff spiOffJar`
`60`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-io.qameta.allure.AllureJunit5`
	`1`	`+io.qameta.allure.junit5.AllureJunit5`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ task spiOffJar(type: Jar, dependsOn: classes) {`
`50`	`50`	`from sourceSets.main.output`
`51`	`51`	`}`
`52`	`52`
	`53`	`+configurations {`
	`54`	`+ spiOff.extendsFrom(compile)`
	`55`	`+}`
	`56`	`+`
`53`	`57`	`artifacts {`
`54`		`- archives spiOffJar`
	`58`	`+ spiOff spiOffJar`
`55`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+allure.results.directory=build/allure-results`