com.trivago.cluecumber.json.pojo.Element Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cluecumber-report-plugin
Show all versions of cluecumber-report-plugin
Plugin for generating clear Cucumber BDD test result reports.
/*
* Copyright 2019 trivago N.V.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.trivago.cluecumber.json.pojo;
import com.google.gson.annotations.SerializedName;
import com.trivago.cluecumber.constants.Status;
import com.trivago.cluecumber.rendering.pages.renderering.RenderingUtils;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
public class Element {
private List before = new ArrayList<>();
private int line;
private String featureName = "";
private String name = "";
private String description = "";
private String id = "";
private List after = new ArrayList<>();
private String type = "";
private String keyword = "";
private List steps = new ArrayList<>();
private List tags = new ArrayList<>();
@SerializedName("start_timestamp")
private String startTimestamp = "";
private transient int featureIndex = 0;
private transient int scenarioIndex = 0;
private transient boolean failOnPendingOrUndefined = false;
public List getTags() {
return tags;
}
public void setTags(final List tags) {
this.tags = tags;
}
public String getStartTimestamp() {
return startTimestamp;
}
public void setStartTimestamp(final String startTimestamp) {
this.startTimestamp = startTimestamp;
}
public ZonedDateTime getStartDateTime() {
return RenderingUtils.convertTimestampToZonedDateTime(startTimestamp);
}
public ZonedDateTime getEndDateTime() {
ZonedDateTime startDateTime = getStartDateTime();
if (startDateTime != null) {
return getStartDateTime().plusNanos(getTotalDuration());
} else {
return null;
}
}
public String getStartDateString() {
return RenderingUtils.convertZonedDateTimeToDateString(getStartDateTime());
}
public String getStartTimeString() {
return RenderingUtils.convertZonedDateTimeToTimeString(getStartDateTime());
}
public String getEndDateString() {
return RenderingUtils.convertZonedDateTimeToDateString(getEndDateTime());
}
public String getEndTimeString() {
return RenderingUtils.convertZonedDateTimeToTimeString(getEndDateTime());
}
public List getBefore() {
return before;
}
public void setBefore(final List before) {
this.before = before;
}
public int getLine() {
return line;
}
public void setLine(final int line) {
this.line = line;
}
public String getName() {
return !name.isEmpty() ? name : "[Unnamed]";
}
public void setName(final String name) {
this.name = name;
}
public String getDescription() {
return description;
}
public void setDescription(final String description) {
this.description = description;
}
public String getId() {
return id;
}
public void setId(final String id) {
this.id = id;
}
public List getAfter() {
return after;
}
public void setAfter(final List after) {
this.after = after;
}
public String getType() {
return type;
}
public void setType(final String type) {
this.type = type;
}
public String getKeyword() {
return keyword;
}
public void setKeyword(final String keyword) {
this.keyword = keyword;
}
public List getSteps() {
return steps;
}
public void setSteps(final List steps) {
this.steps = steps;
}
public boolean isScenario() {
return type.equals("scenario");
}
public boolean isFailed() {
return getStatus() == Status.FAILED;
}
public boolean isPassed() {
return getStatus() == Status.PASSED;
}
public boolean isSkipped() {
return getStatus() == Status.SKIPPED;
}
public Status getStatus() {
int totalSteps = steps.size();
if (totalSteps == 0) {
return Status.SKIPPED;
}
// If any hooks fail, report the scenario as failed
for (ResultMatch beforeHook : before) {
if (beforeHook.isFailed()) {
return Status.FAILED;
}
}
for (ResultMatch afterHook : after) {
if (afterHook.isFailed()) {
return Status.FAILED;
}
}
// If all steps have the same status, return this as the scenario status.
for (Status status : Status.BASIC_STATES) {
int stepsWithCertainStatusCount = 0;
for (Step step : steps) {
if (step.getConsolidatedStatus() == status) {
stepsWithCertainStatusCount++;
}
// If any step hooks fail, report scenario as failed.
for (ResultMatch beforeStepHook : step.getBefore()) {
if (beforeStepHook.isFailed()) {
return Status.FAILED;
}
}
for (ResultMatch afterStepHook : step.getAfter()) {
if (afterStepHook.isFailed()) {
return Status.FAILED;
}
}
}
if (totalSteps == stepsWithCertainStatusCount) {
if (status == Status.SKIPPED) {
if (failOnPendingOrUndefined) {
return Status.FAILED;
}
}
return status;
}
}
// If at least one step passed and the other steps are skipped, return passed (or failed if failOnPendingOrUndefined is true).
if (getTotalNumberOfPassedSteps() >= 0 &&
(getTotalNumberOfSkippedSteps() + getTotalNumberOfPassedSteps()) == getTotalNumberOfSteps()) {
if (failOnPendingOrUndefined) {
return Status.FAILED;
}
return Status.PASSED;
}
// If all steps are skipped return skipped (or failed if failOnPendingOrUndefined is true).
if (getTotalNumberOfSkippedSteps() == totalSteps) {
if (failOnPendingOrUndefined) {
return Status.FAILED;
}
return Status.SKIPPED;
}
return Status.FAILED;
}
public int getScenarioIndex() {
return scenarioIndex;
}
public void setScenarioIndex(final int scenarioIndex) {
this.scenarioIndex = scenarioIndex;
}
public int getTotalNumberOfSteps() {
return getSteps().size();
}
public int getTotalNumberOfPassedSteps() {
return getNumberOfStepsWithStatus(Status.PASSED);
}
public int getTotalNumberOfFailedSteps() {
return getNumberOfStepsWithStatus(Status.FAILED);
}
public int getTotalNumberOfSkippedSteps() {
return getNumberOfStepsWithStatus(Status.SKIPPED);
}
private int getNumberOfStepsWithStatus(final Status status) {
return (int) getSteps().stream().filter(step -> step.getConsolidatedStatus() == status).count();
}
public long getTotalDuration() {
long totalDurationNanoseconds = 0;
for (ResultMatch beforeStep : before) {
totalDurationNanoseconds += beforeStep.getResult().getDuration();
}
for (Step step : steps) {
totalDurationNanoseconds += step.getTotalDuration();
}
for (ResultMatch afterStep : after) {
totalDurationNanoseconds += afterStep.getResult().getDuration();
}
return totalDurationNanoseconds;
}
public String returnTotalDurationString() {
return RenderingUtils.convertNanosecondsToTimeString(getTotalDuration());
}
public boolean hasHooks() {
return getBefore().size() > 0 || getAfter().size() > 0;
}
public boolean hasDocStrings() {
for (Step step : steps) {
if (step.getDocString() != null) {
return true;
}
}
return false;
}
public boolean hasStepHooks() {
for (Step step : steps) {
if (step.getBefore().size() > 0) {
return true;
}
if (step.getAfter().size() > 0) {
return true;
}
}
return false;
}
public List getAllResultMatches() {
List resultMatches = new ArrayList<>(getBefore());
resultMatches.addAll(getSteps());
resultMatches.addAll(getAfter());
return resultMatches;
}
public void setFeatureName(final String featureName) {
this.featureName = featureName;
}
public String getFeatureName() {
return featureName;
}
public void setFeatureIndex(final int featureIndex) {
this.featureIndex = featureIndex;
}
public int getFeatureIndex() {
return featureIndex;
}
public void setFailOnPendingOrUndefined(final boolean failOnPendingOrUndefined) {
this.failOnPendingOrUndefined = failOnPendingOrUndefined;
}
}