Skip to content

Commit

Permalink
Merge pull request #390 from sparrowV/master
Browse files Browse the repository at this point in the history 
ISSUE-389 # fix retry report issue
  • Loading branch information
@authorjapps
authorjapps authored May 16, 2020
2 parents 8212e72 + 6c62c65 commit 838ee34
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 33 deletions.
4 changes: 4 additions & 0 deletions core/src/main/java/org/jsmart/zerocode/core/domain/reports/ZeroCodeExecResult.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ public List<ZeroCodeReportStep> getSteps() {
return steps;
}

public void setSteps(List<ZeroCodeReportStep> steps) {
this.steps = steps;
}

@Override
public String toString() {
return "ZeroCodeExecResult{" +
Expand Down
6 changes: 6 additions & 0 deletions core/src/main/java/org/jsmart/zerocode/core/domain/reports/ZeroCodeReportStep.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ public ZeroCodeReportStep(
this.customLog = customLog;
}


public ZeroCodeReportStep(String correlationId,String result){
this(null,null,null,null,correlationId,null,null,null,null,result,null,null,null,null);
}


public Integer getLoop() {
return loop;
}
Expand Down
85 changes: 52 additions & 33 deletions core/src/main/java/org/jsmart/zerocode/core/report/ZeroCodeReportGeneratorImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
import org.jsmart.zerocode.core.domain.builders.ZeroCodeChartKeyValueArrayBuilder;
import org.jsmart.zerocode.core.domain.builders.ZeroCodeChartKeyValueBuilder;
import org.jsmart.zerocode.core.domain.builders.ZeroCodeCsvReportBuilder;
import org.jsmart.zerocode.core.domain.reports.ZeroCodeExecResult;
import org.jsmart.zerocode.core.domain.reports.ZeroCodeReport;
import org.jsmart.zerocode.core.domain.reports.ZeroCodeReportStep;
import org.jsmart.zerocode.core.domain.reports.chart.HighChartColumnHtml;
import org.jsmart.zerocode.core.domain.reports.csv.ZeroCodeCsvReport;
import org.slf4j.Logger;
Expand All @@ -28,10 +30,7 @@
import java.io.IOException;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;
import java.util.*;
import java.util.stream.Collectors;

import static java.util.Collections.emptyList;
Expand Down Expand Up @@ -82,10 +81,26 @@ public ZeroCodeReportGeneratorImpl(ObjectMapper mapper) {
this.mapper = mapper;
}

/**
* Gets unique steps from a scenario. In case of retries, the steps have same correlation id and if
* one of the retries is successful, we include it in the result(not the one which failed).
* In a normal case(without retry), both PASS and FAIL will be included as usual.
* @param steps
* @return
*/
List<ZeroCodeReportStep> getUniqueSteps(List<ZeroCodeReportStep> steps){
Map<String,ZeroCodeReportStep> result = new HashMap<>();
steps.forEach(step->{
result.merge(step.getCorrelationId(), step,
(s1, s2) -> RESULT_PASS.equals(s1.getResult()) ? s1 : s2);
});
return new ArrayList<>(result.values());
}

@Override
public void generateExtentReport() {

if(interactiveHtmlReportDisabled){
if (interactiveHtmlReportDisabled) {
return;
}

Expand All @@ -100,22 +115,22 @@ public void generateExtentReport() {
test.assignCategory(DEFAULT_REGRESSION_CATEGORY);

test.assignAuthor(optionalAuthor(thisScenario.getScenarioName()));

thisScenario.getSteps().forEach(thisStep -> {
List<ZeroCodeReportStep> thisScenarioUniqueSteps = getUniqueSteps(thisScenario.getSteps());
thisScenarioUniqueSteps.forEach(thisStep -> {
test.getModel().setStartTime(utilDateOf(thisStep.getRequestTimeStamp()));
test.getModel().setEndTime(utilDateOf(thisStep.getResponseTimeStamp()));

final Status testStatus = thisStep.getResult().equals(RESULT_PASS) ? Status.PASS : Status.FAIL;

ExtentTest step = test.createNode(thisStep.getName(), TEST_STEP_CORRELATION_ID + " " + thisStep.getCorrelationId());
if(testStatus.equals(Status.PASS)) {
step.pass(thisStep.getResult());
}else {
step.info(MarkupHelper.createCodeBlock(thisStep.getOperation() + "\t" + thisStep.getUrl()));
step.info(MarkupHelper.createCodeBlock(thisStep.getRequest(), CodeLanguage.JSON));

if (testStatus.equals(Status.PASS)) {
step.pass(thisStep.getResult());
} else {
step.info(MarkupHelper.createCodeBlock(thisStep.getOperation() + "\t" + thisStep.getUrl()));
step.info(MarkupHelper.createCodeBlock(thisStep.getRequest(), CodeLanguage.JSON));
step.info(MarkupHelper.createCodeBlock(thisStep.getResponse(), CodeLanguage.JSON));
step.fail(MarkupHelper.createCodeBlock("Reason:\n" + thisStep.getAssertions()));
step.fail(MarkupHelper.createCodeBlock("Reason:\n" + thisStep.getAssertions()));
}
extentReports.flush();
});
Expand All @@ -133,13 +148,13 @@ public void linkToSpikeChartIfEnabled() {
// (might be disabled by current runner)
// Then it's good to link it to that spike report.
// ------------------------------------------------
if(spikeChartReportEnabled || spikeChartFileName != null){
if (spikeChartReportEnabled || spikeChartFileName != null) {
final String reportName = getReportName();

String linkCodeToTargetSpikeChartHtml =
String.format("<code>&nbsp;&nbsp;<a href='%s' style=\"color: #006; background: #ff6;\"> %s </a></code>",
spikeChartFileName,
LINK_LABEL_NAME);
spikeChartFileName,
LINK_LABEL_NAME);

ExtentReportsFactory.reportName(reportName + linkCodeToTargetSpikeChartHtml);
}
Expand All @@ -148,33 +163,33 @@ public void linkToSpikeChartIfEnabled() {
protected String optionalAuthor(String scenarioName) {
String authorName = substringBetween(scenarioName, AUTHOR_MARKER, AUTHOR_MARKER);

if(authorName == null){
if (authorName == null) {
authorName = substringBetween(scenarioName, AUTHOR_MARKER, ",");
}

if(authorName == null){
if (authorName == null) {
authorName = substringBetween(scenarioName, AUTHOR_MARKER, " ");
}

if(authorName == null){
if (authorName == null) {
authorName = scenarioName.substring(scenarioName.lastIndexOf(AUTHOR_MARKER) + AUTHOR_MARKER.length());
}

if(scenarioName.lastIndexOf(AUTHOR_MARKER) == -1 || StringUtils.isEmpty(authorName)){
if (scenarioName.lastIndexOf(AUTHOR_MARKER) == -1 || StringUtils.isEmpty(authorName)) {
authorName = ANONYMOUS_AUTHOR;
}

return authorName;
}

protected String onlyScenarioName(String scenarioName) {
int index = scenarioName.indexOf(AUTHOR_MARKER);
if(index == -1) {
return scenarioName;
}else {
return scenarioName.substring(0, index -1);
}

int index = scenarioName.indexOf(AUTHOR_MARKER);
if (index == -1) {
return scenarioName;
} else {
return scenarioName.substring(0, index - 1);
}
}

@Override
Expand All @@ -198,7 +213,7 @@ public void generateHighChartReport() {
/*
* Generate: Spike Chart using HighChart
*/
if(spikeChartReportEnabled){
if (spikeChartReportEnabled) {
HighChartColumnHtml highChartColumnHtml = convertCsvRowsToHighChartData(zeroCodeCsvFlattenedRows);
generateHighChartReport(highChartColumnHtml);
}
Expand Down Expand Up @@ -331,7 +346,11 @@ public List<ZeroCodeReport> readZeroCodeReportsByPath(String reportsFolder) {
}
})
.collect(Collectors.toList());

for (ZeroCodeReport zeroCodeReport : scenarioReports) {
for (ZeroCodeExecResult zeroCodeExecResult : zeroCodeReport.getResults()) {
zeroCodeExecResult.setSteps(getUniqueSteps(zeroCodeExecResult.getSteps()));
}
}
return scenarioReports;
}

Expand All @@ -342,7 +361,7 @@ public static List<String> getAllEndPointFilesFrom(String folderName) {
return name.endsWith(".json");
});

if(files == null || files.length == 0){
if (files == null || files.length == 0) {

LOGGER.error("\n\t\t\t************\nNow files were found in folder:{}, hence could not proceed. " +
"\n(If this was intentional, then you can safely ignore this error)" +
Expand Down
41 changes: 41 additions & 0 deletions core/src/test/java/org/jsmart/zerocode/core/report/ZeroCodeReportGeneratorImplTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,21 @@

import com.fasterxml.jackson.databind.ObjectMapper;
import org.jsmart.zerocode.core.di.provider.ObjectMapperProvider;
import org.jsmart.zerocode.core.domain.reports.ZeroCodeReportStep;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;

import java.util.ArrayList;
import java.util.List;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.Is.is;
import static org.jsmart.zerocode.core.constants.ZeroCodeReportConstants.RESULT_FAIL;
import static org.jsmart.zerocode.core.constants.ZeroCodeReportConstants.RESULT_PASS;
import static org.junit.Assert.assertEquals;

public class ZeroCodeReportGeneratorImplTest {

Expand Down Expand Up @@ -76,4 +83,38 @@ public void testAuthorJiraStyle() throws Exception {

}

@Test
public void testGettingUniqueStepsForMultipleRetries(){
List<ZeroCodeReportStep> steps = new ArrayList<ZeroCodeReportStep>(){
{
add(new ZeroCodeReportStep("testCorrelationId",RESULT_PASS));
add(new ZeroCodeReportStep("testCorrelationId",RESULT_FAIL));
}
};
List<ZeroCodeReportStep> uniqueSteps = zeroCodeReportGenerator.getUniqueSteps(steps);
assertEquals(uniqueSteps.size() , 1);
assertEquals(uniqueSteps.get(0).getResult(),RESULT_PASS);
}

@Test
public void testGettingUniqueStepsForNoRetries(){
List<ZeroCodeReportStep> steps = new ArrayList<ZeroCodeReportStep>(){
{
add(new ZeroCodeReportStep("testCorrelationId1",RESULT_PASS));
add(new ZeroCodeReportStep("testCorrelationId2",RESULT_FAIL));
add(new ZeroCodeReportStep("testCorrelationId3",RESULT_FAIL));
}
};
List<ZeroCodeReportStep> uniqueSteps = zeroCodeReportGenerator.getUniqueSteps(steps);
assertEquals(uniqueSteps.size() , 3);
assertEquals(uniqueSteps.stream().filter(step->step.getResult().equals(RESULT_PASS)).count(),1);
assertEquals(uniqueSteps.stream().filter(step->step.getResult().equals(RESULT_FAIL)).count(),2);

assertThat(uniqueSteps.get(0).getCorrelationId(),is("testCorrelationId3")); // order different to original
assertThat(uniqueSteps.get(1).getCorrelationId(),is("testCorrelationId1")); // order different to original
assertThat(uniqueSteps.get(2).getCorrelationId(),is("testCorrelationId2")); // order different to original

// order different to original: Not really an issue, as the CSV can be sorted ACS or DESC by a an external tool
}

}

0 comments on commit 838ee34

Please sign in to comment.