Skip to content

Commit 9d7039d

Browse files
baevbaev
committed
rename allure
1 parent 9dd042e commit 9d7039d

8 files changed

Lines changed: 55 additions & 57 deletions

File tree

allure-java-commons/src/main/java/io/qameta/allure/Allure.java renamed to allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
import java.io.ByteArrayInputStream;
1515
import java.io.InputStream;
1616
import java.nio.file.Paths;
17-
import java.util.HashMap;
1817
import java.util.LinkedList;
1918
import java.util.List;
2019
import java.util.Map;
@@ -31,11 +30,11 @@
3130
/**
3231
* @author charlie (Dmitry Baev).
3332
*/
34-
public class Allure {
33+
public class AllureLifecycle {
3534

36-
private static final Logger LOGGER = LoggerFactory.getLogger(Allure.class);
35+
private static final Logger LOGGER = LoggerFactory.getLogger(AllureLifecycle.class);
3736

38-
public static final Allure LIFECYCLE = new Allure();
37+
public static final AllureLifecycle INSTANCE = new AllureLifecycle();
3938

4039
private final Map<String, Object> storage = new ConcurrentHashMap<>();
4140

@@ -44,11 +43,11 @@ public class Allure {
4443

4544
private AllureResultsWriter writer;
4645

47-
public Allure(AllureResultsWriter writer) {
46+
public AllureLifecycle(AllureResultsWriter writer) {
4847
this.writer = writer;
4948
}
5049

51-
public Allure() {
50+
public AllureLifecycle() {
5251
this(getDefaultWriter());
5352
}
5453

‎allure-java-commons/src/main/java/io/qameta/allure/aspects/AttachmentsAspects.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.qameta.allure.aspects;
22

3-
import io.qameta.allure.Allure;
3+
import io.qameta.allure.AllureLifecycle;
44
import io.qameta.allure.Attachment;
55
import org.aspectj.lang.JoinPoint;
66
import org.aspectj.lang.annotation.AfterReturning;
@@ -19,7 +19,7 @@
1919
@Aspect
2020
public class AttachmentsAspects {
2121

22-
private static Allure ALLURE = Allure.LIFECYCLE;
22+
private static AllureLifecycle ALLURE = AllureLifecycle.INSTANCE;
2323

2424
/**
2525
* Pointcut for things annotated with {@link Attachment}

‎allure-java-commons/src/main/java/io/qameta/allure/aspects/StepsAspects.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.qameta.allure.aspects;
22

3-
import io.qameta.allure.Allure;
3+
import io.qameta.allure.AllureLifecycle;
44
import io.qameta.allure.Step;
55
import io.qameta.allure.model.Parameter;
66
import io.qameta.allure.model.Status;
@@ -28,7 +28,7 @@
2828
@Aspect
2929
public class StepsAspects {
3030

31-
private static Allure ALLURE = Allure.LIFECYCLE;
31+
private static AllureLifecycle ALLURE = AllureLifecycle.INSTANCE;
3232

3333
@Pointcut("@annotation(io.qameta.allure.Step)")
3434
public void withStepAnnotation() {
@@ -67,7 +67,7 @@ public void stepStop() {
6767
/**
6868
* For tests only
6969
*/
70-
public static void setAllure(Allure allure) {
70+
public static void setAllure(AllureLifecycle allure) {
7171
StepsAspects.ALLURE = allure;
7272
}
7373

‎allure-junit4/src/main/java/io/qameta/allure/junit4/AllureJunit4.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.qameta.allure.junit4;
22

3-
import io.qameta.allure.Allure;
3+
import io.qameta.allure.AllureLifecycle;
44
import io.qameta.allure.model.Label;
55
import io.qameta.allure.model.TestResult;
66
import io.qameta.allure.model.TestResultContainer;
@@ -46,7 +46,7 @@ public void testStarted(Description description) throws Exception {
4646
String id = getHistoryId(description);
4747
String testGroupId = getSuiteUuid(description.getClassName());
4848

49-
Allure.LIFECYCLE.scheduleTestCase(testGroupId, new TestResult()
49+
AllureLifecycle.INSTANCE.scheduleTestCase(testGroupId, new TestResult()
5050
.withUuid(uuid)
5151
.withHistoryId(id)
5252
.withName(description.getMethodName())
@@ -61,12 +61,12 @@ public void testStarted(Description description) throws Exception {
6161

6262
@Override
6363
public void testFinished(Description description) throws Exception {
64-
// AllureOld.LIFECYCLE.closeTestCase();
64+
// AllureOld.INSTANCE.closeTestCase();
6565
}
6666

6767
@Override
6868
public void testFailure(Failure failure) throws Exception {
69-
// AllureOld.LIFECYCLE.setTestCaseStatus(of(failure.getException()));
69+
// AllureOld.INSTANCE.setTestCaseStatus(of(failure.getException()));
7070
}
7171

7272
@Override
@@ -80,11 +80,11 @@ public void testIgnored(Description description) throws Exception {
8080
private void createTestGroups(String parentUuid, List<Description> descriptions) {
8181
descriptions.forEach(description -> {
8282
String uuid = getSuiteUuid(description.getClassName());
83-
Allure.LIFECYCLE.startTestContainer(parentUuid, new TestResultContainer()
83+
AllureLifecycle.INSTANCE.startTestContainer(parentUuid, new TestResultContainer()
8484
.withUuid(uuid)
8585
.withName(description.getDisplayName())
8686
);
87-
Allure.LIFECYCLE.writeTestContainer(uuid);
87+
AllureLifecycle.INSTANCE.writeTestContainer(uuid);
8888

8989
description.getChildren().forEach(child ->
9090
createTestGroups(uuid, description.getChildren())

‎allure-junit4/src/main/java/io/qameta/allure/junit4/aspects/FixturesAspects.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
@Aspect
1515
public class FixturesAspects {
1616

17-
//private static AllureOld ALLURE = AllureOld.LIFECYCLE;
17+
//private static AllureOld ALLURE = AllureOld.INSTANCE;
1818

1919
@Pointcut("@annotation(org.junit.Before)")
2020
public void withBeforeAnnotation() {

‎allure-testng/src/main/java/io/qameta/allure/testng/AllureTestNg.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.qameta.allure.testng;
22

3-
import io.qameta.allure.Allure;
3+
import io.qameta.allure.AllureLifecycle;
44
import io.qameta.allure.Flaky;
55
import io.qameta.allure.Muted;
66
import io.qameta.allure.ResultsUtils;
@@ -82,17 +82,17 @@ public class AllureTestNg implements ISuiteListener, ITestListener, IInvokedMeth
8282
private final ThreadLocal<String> currentExecutable
8383
= InheritableThreadLocal.withInitial(() -> UUID.randomUUID().toString());
8484

85-
private Allure lifecycle;
85+
private AllureLifecycle lifecycle;
8686

87-
public AllureTestNg(Allure lifecycle) {
87+
public AllureTestNg(AllureLifecycle lifecycle) {
8888
this.lifecycle = lifecycle;
8989
}
9090

9191
public AllureTestNg() {
92-
this.lifecycle = Allure.LIFECYCLE;
92+
this.lifecycle = AllureLifecycle.INSTANCE;
9393
}
9494

95-
public Allure getLifecycle() {
95+
public AllureLifecycle getLifecycle() {
9696
return lifecycle;
9797
}
9898

‎allure-testng/src/test/java/io/qameta/allure/test/FeatureCombinationsTest.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.qameta.allure.test;
22

3-
import io.qameta.allure.Allure;
3+
import io.qameta.allure.AllureLifecycle;
44
import io.qameta.allure.aspects.StepsAspects;
55
import io.qameta.allure.model.ExecutableItem;
66
import io.qameta.allure.model.FixtureResult;
@@ -42,16 +42,15 @@ public class FeatureCombinationsTest {
4242
items.stream().allMatch(item -> item.getSteps().size() == 1),
4343
"All items should have a step attached");
4444

45-
private AllureTestNg adapter;
4645
private TestNG testNg;
4746
private AllureResultsWriterStub results;
4847

4948
@BeforeMethod
5049
public void prepare() {
5150
results = new AllureResultsWriterStub();
52-
final Allure lifecycle = new Allure(results);
51+
final AllureLifecycle lifecycle = new AllureLifecycle(results);
5352
StepsAspects.setAllure(lifecycle);
54-
adapter = new AllureTestNg(lifecycle);
53+
AllureTestNg adapter = new AllureTestNg(lifecycle);
5554
testNg = new TestNG(false);
5655
testNg.addListener((ITestNGListener) adapter);
5756
}

‎allure-testng/src/test/java/io/qameta/allure/test/ListenerTest.java‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.qameta.allure.test;
22

3-
import io.qameta.allure.Allure;
3+
import io.qameta.allure.AllureLifecycle;
44
import io.qameta.allure.model.Label;
55
import io.qameta.allure.model.TestResult;
66
import io.qameta.allure.model.TestResultContainer;
@@ -36,7 +36,7 @@
3636
public class ListenerTest {
3737

3838
private static final String STRING_PARAMETER = "String parameter";
39-
private Allure allure;
39+
private AllureLifecycle lifecycle;
4040
private AllureTestNg allureTestNg;
4141
private static final String ALLURE_UUID_KEY = "ALLURE_UUID";
4242
private static final String RESULT_UUID = "Result uuid";
@@ -51,8 +51,8 @@ public class ListenerTest {
5151

5252
@BeforeMethod
5353
public void prepare() {
54-
allure = mock(Allure.class, withSettings().verboseLogging());
55-
allureTestNg = new AllureTestNg(allure);
54+
lifecycle = mock(AllureLifecycle.class, withSettings().verboseLogging());
55+
allureTestNg = new AllureTestNg(lifecycle);
5656
}
5757

5858
@Test
@@ -62,7 +62,7 @@ public void suiteStart() {
6262
allureTestNg.onStart(isuite);
6363

6464
ArgumentCaptor<TestResultContainer> suite = ArgumentCaptor.forClass(TestResultContainer.class);
65-
verify(allure).startTestContainer(suite.capture());
65+
verify(lifecycle).startTestContainer(suite.capture());
6666
assertThat(suite.getValue())
6767
.extracting(TestResultContainer::getName).contains(SUITE_NAME);
6868
}
@@ -73,9 +73,9 @@ public void suiteFinish() {
7373
when(iSuite.getAttribute(ALLURE_UUID_KEY)).thenReturn(SUITE_UUID);
7474
allureTestNg.onFinish(iSuite);
7575

76-
InOrder order = inOrder(allure);
77-
order.verify(allure).stopTestContainer(SUITE_UUID);
78-
order.verify(allure).writeTestContainer(SUITE_UUID);
76+
InOrder order = inOrder(lifecycle);
77+
order.verify(lifecycle).stopTestContainer(SUITE_UUID);
78+
order.verify(lifecycle).writeTestContainer(SUITE_UUID);
7979
}
8080

8181
@Test
@@ -89,7 +89,7 @@ public void contextStart() {
8989

9090
allureTestNg.onStart(iContext);
9191
ArgumentCaptor<TestResultContainer> contextContainer = ArgumentCaptor.forClass(TestResultContainer.class);
92-
verify(allure).startTestContainer(eq(SUITE_UUID), contextContainer.capture());
92+
verify(lifecycle).startTestContainer(eq(SUITE_UUID), contextContainer.capture());
9393
assertThat(contextContainer.getValue())
9494
.extracting(TestResultContainer::getUuid).contains(CONTAINER_UUID);
9595
assertThat(contextContainer.getValue())
@@ -102,9 +102,9 @@ public void contextFinish() {
102102
when(iContext.getAttribute(ALLURE_UUID_KEY)).thenReturn(CONTAINER_UUID);
103103

104104
allureTestNg.onFinish(iContext);
105-
InOrder order = inOrder(allure);
106-
order.verify(allure).stopTestContainer(CONTAINER_UUID);
107-
order.verify(allure).writeTestContainer(CONTAINER_UUID);
105+
InOrder order = inOrder(lifecycle);
106+
order.verify(lifecycle).stopTestContainer(CONTAINER_UUID);
107+
order.verify(lifecycle).writeTestContainer(CONTAINER_UUID);
108108
}
109109

110110
private Method parameterizedMethod(String parameter) {
@@ -148,8 +148,8 @@ public void testStart() throws NoSuchMethodException {
148148
mockTestStart();
149149

150150
ArgumentCaptor<TestResult> result = ArgumentCaptor.forClass(TestResult.class);
151-
InOrder order = inOrder(allure);
152-
order.verify(allure).scheduleTestCase(eq(CONTAINER_UUID), result.capture());
151+
InOrder order = inOrder(lifecycle);
152+
order.verify(lifecycle).scheduleTestCase(eq(CONTAINER_UUID), result.capture());
153153
TestResult value = result.getValue();
154154
List<Label> labels = value.getLabels();
155155
List<io.qameta.allure.model.Parameter> parameters = value.getParameters();
@@ -158,54 +158,54 @@ public void testStart() throws NoSuchMethodException {
158158
.hasSize(1)
159159
.extracting(io.qameta.allure.model.Parameter::getValue)
160160
.containsOnly(TEST_METHOD_PARAMETERS);
161-
order.verify(allure).startTestCase(value.getUuid());
161+
order.verify(lifecycle).startTestCase(value.getUuid());
162162
}
163163

164164
@Test
165165
public void testSuccess() throws NoSuchMethodException {
166166
mockTestStart();
167167
ArgumentCaptor<TestResult> result = ArgumentCaptor.forClass(TestResult.class);
168-
verify(allure).scheduleTestCase(eq(CONTAINER_UUID), result.capture());
168+
verify(lifecycle).scheduleTestCase(eq(CONTAINER_UUID), result.capture());
169169

170170
ITestResult iResult = mock(ITestResult.class);
171171
allureTestNg.onTestSuccess(iResult);
172-
InOrder order = inOrder(allure);
172+
InOrder order = inOrder(lifecycle);
173173
final String uuid = result.getValue().getUuid();
174-
order.verify(allure).updateTestCase(eq(uuid), any());
175-
order.verify(allure).stopTestCase(uuid);
176-
order.verify(allure).writeTestCase(uuid);
174+
order.verify(lifecycle).updateTestCase(eq(uuid), any());
175+
order.verify(lifecycle).stopTestCase(uuid);
176+
order.verify(lifecycle).writeTestCase(uuid);
177177
}
178178

179179
@Test
180180
public void testFailure() throws NoSuchMethodException {
181181
mockTestStart();
182182
ArgumentCaptor<TestResult> result = ArgumentCaptor.forClass(TestResult.class);
183-
verify(allure).scheduleTestCase(eq(CONTAINER_UUID), result.capture());
183+
verify(lifecycle).scheduleTestCase(eq(CONTAINER_UUID), result.capture());
184184

185185
ITestResult iResult = mock(ITestResult.class);
186186
when(iResult.getThrowable()).thenReturn(new Throwable("Cause"));
187187

188188
allureTestNg.onTestFailure(iResult);
189-
InOrder order = inOrder(allure);
189+
InOrder order = inOrder(lifecycle);
190190
final String uuid = result.getValue().getUuid();
191-
order.verify(allure).updateTestCase(eq(uuid), any());
192-
order.verify(allure).stopTestCase(uuid);
193-
order.verify(allure).writeTestCase(uuid);
191+
order.verify(lifecycle).updateTestCase(eq(uuid), any());
192+
order.verify(lifecycle).stopTestCase(uuid);
193+
order.verify(lifecycle).writeTestCase(uuid);
194194
}
195195

196196
@Test
197197
public void testSkipped() throws NoSuchMethodException {
198198
mockTestStart();
199199
ArgumentCaptor<TestResult> result = ArgumentCaptor.forClass(TestResult.class);
200-
verify(allure).scheduleTestCase(eq(CONTAINER_UUID), result.capture());
200+
verify(lifecycle).scheduleTestCase(eq(CONTAINER_UUID), result.capture());
201201

202202
ITestResult iResult = mock(ITestResult.class);
203203

204204
allureTestNg.onTestSkipped(iResult);
205-
InOrder order = inOrder(allure);
205+
InOrder order = inOrder(lifecycle);
206206
final String uuid = result.getValue().getUuid();
207-
order.verify(allure).updateTestCase(eq(uuid), any());
208-
order.verify(allure).stopTestCase(uuid);
209-
order.verify(allure).writeTestCase(uuid);
207+
order.verify(lifecycle).updateTestCase(eq(uuid), any());
208+
order.verify(lifecycle).stopTestCase(uuid);
209+
order.verify(lifecycle).writeTestCase(uuid);
210210
}
211211
}

0 commit comments

Comments
 (0)