KaneAI - World’s First E2E Software Testing Agent.Book a Demo 
How to use getDescription method of com.tngtech.jgiven.report.model.ScenarioModel class
Best JGiven code snippet using com.tngtech.jgiven.report.model.ScenarioModel.getDescription
Source:ScenarioModelBuilder.java 
...108 currentStep = stepModel;109 }110 StepModel createStepModel(Method paramMethod, List<NamedArgument> arguments, InvocationMode mode) {111 StepModel stepModel = new StepModel();112 stepModel.setName(getDescription(paramMethod));113 ExtendedDescription extendedDescriptionAnnotation = paramMethod.getAnnotation(ExtendedDescription.class);114 if (extendedDescriptionAnnotation != null) {115 stepModel.setExtendedDescription(extendedDescriptionAnnotation.value());116 }117 List<NamedArgument> nonHiddenArguments =118 filterHiddenArguments(arguments, paramMethod.getParameterAnnotations());119 ParameterFormattingUtil parameterFormattingUtil = new ParameterFormattingUtil(configuration);120 List<ObjectFormatter<?>> formatters =121 parameterFormattingUtil.getFormatter(paramMethod.getParameterTypes(), getNames(arguments),122 paramMethod.getParameterAnnotations());123 new StepFormatter(stepModel.getName(), nonHiddenArguments, formatters).buildFormattedWords()124 .forEach(sentenceBuilder::addWord);125 stepModel.setWords(sentenceBuilder.getWords());126 sentenceBuilder.clear();127 stepModel.setStatus(mode.toStepStatus());128 return stepModel;129 }130 private List<NamedArgument> filterHiddenArguments(List<NamedArgument> arguments,131 Annotation[][] parameterAnnotations) {132 List<NamedArgument> result = Lists.newArrayList();133 for (int i = 0; i < parameterAnnotations.length; i++) {134 if (!AnnotationUtil.isHidden(parameterAnnotations[i])) {135 result.add(arguments.get(i));136 }137 }138 return result;139 }140 @Override141 public void introWordAdded(String value) {142 sentenceBuilder.addIntroWord(value);143 }144 private void addToSentence(String value, boolean joinToPreviousWord, boolean joinToNextWord) {145 if (!sentenceBuilder.hasWords() && currentStep != null && joinToPreviousWord) {146 currentStep.getLastWord().addSuffix(value);147 } else {148 sentenceBuilder.addWord(value, joinToPreviousWord, joinToNextWord);149 }150 }151 private void addStepComment(List<NamedArgument> arguments) {152 if (arguments == null || arguments.size() != 1) {153 throw new JGivenWrongUsageException("A step comment method must have exactly one parameter.");154 }155 if (!(arguments.get(0).getValue() instanceof String)) {156 throw new JGivenWrongUsageException("The step comment method parameter must be a string.");157 }158 if (currentStep == null) {159 throw new JGivenWrongUsageException("A step comment must be added after the corresponding step, "160 + "but no step has been executed yet.");161 }162 stepCommentUpdated((String) arguments.get(0).getValue());163 }164 @Override165 public void stepCommentUpdated(String comment) {166 currentStep.setComment(comment);167 }168 private ScenarioCaseModel getCurrentScenarioCase() {169 if (scenarioCaseModel == null) {170 scenarioStarted("A Scenario");171 }172 return scenarioCaseModel;173 }174 private void incrementDiscrepancy() {175 int discrepancyOnCurrentLayer = discrepancyOnLayer.pop();176 discrepancyOnCurrentLayer++;177 discrepancyOnLayer.push(discrepancyOnCurrentLayer);178 }179 private void decrementDiscrepancy() {180 if (discrepancyOnLayer.peek() > 0) {181 int discrepancyOnCurrentLayer = discrepancyOnLayer.pop();182 discrepancyOnCurrentLayer--;183 discrepancyOnLayer.push(discrepancyOnCurrentLayer);184 }185 }186 @Override187 public void stepMethodInvoked(Method method, List<NamedArgument> arguments, InvocationMode mode,188 boolean hasNestedSteps) {189 if (method.isAnnotationPresent(IntroWord.class)) {190 introWordAdded(getDescription(method));191 incrementDiscrepancy();192 } else if (method.isAnnotationPresent(FillerWord.class)) {193 FillerWord fillerWord = method.getAnnotation(FillerWord.class);194 addToSentence(getDescription(method), fillerWord.joinToPreviousWord(), fillerWord.joinToNextWord());195 incrementDiscrepancy();196 } else if (method.isAnnotationPresent(StepComment.class)) {197 addStepComment(arguments);198 incrementDiscrepancy();199 } else {200 addTags(method.getAnnotations());201 addTags(method.getDeclaringClass().getAnnotations());202 addStepMethod(method, arguments, mode, hasNestedSteps);203 }204 }205 public void setMethodName(String methodName) {206 scenarioModel.setTestMethodName(methodName);207 }208 public void setArguments(List<String> arguments) {209 scenarioCaseModel.setExplicitArguments(arguments);210 }211 public void setParameterNames(List<String> parameterNames) {212 scenarioModel.setExplicitParameters(removeUnderlines(parameterNames));213 }214 private static List<String> removeUnderlines(List<String> parameterNames) {215 List<String> result = Lists.newArrayListWithCapacity(parameterNames.size());216 for (String paramName : parameterNames) {217 result.add(WordUtil.fromSnakeCase(paramName));218 }219 return result;220 }221 private String getDescription(Method paramMethod) {222 if (paramMethod.isAnnotationPresent(Hidden.class)) {223 return "";224 }225 Description description = paramMethod.getAnnotation(Description.class);226 if (description != null) {227 return description.value();228 }229 As as = paramMethod.getAnnotation(As.class);230 AsProvider provider = as != null231 ? ReflectionUtil.newInstance(as.provider())232 : new DefaultAsProvider();233 return provider.as(as, paramMethod);234 }235 public void setStatus(ExecutionStatus status) {...
Source:ReportModel.java
...38 visitor.visitEnd(this);39 }40 private List<ScenarioModel> sortByDescription() {41 List<ScenarioModel> sorted = Lists.newArrayList(getScenarios());42 sorted.sort(Comparator.comparing(self -> self.getDescription().toLowerCase()));43 return sorted;44 }45 public ScenarioModel getLastScenarioModel() {46 return getScenarios().get(getScenarios().size() - 1);47 }48 public Optional<ScenarioModel> findScenarioModel(String scenarioDescription) {49 for (ScenarioModel model : getScenarios()) {50 if (model.getDescription().equals(scenarioDescription)) {51 return Optional.of(model);52 }53 }54 return Optional.empty();55 }56 public StepModel getFirstStepModelOfLastScenario() {57 return getLastScenarioModel().getCase(0).getStep(0);58 }59 public synchronized void addScenarioModel(ScenarioModel currentScenarioModel) {60 scenarios.add(copyModelToKeepOriginalIsolatedInItsThread(currentScenarioModel));61 }62 private ScenarioModel copyModelToKeepOriginalIsolatedInItsThread(ScenarioModel currentScenarioModel) {63 return new ScenarioModel(currentScenarioModel);64 }65 public String getSimpleClassName() {66 return Iterables.getLast(Splitter.on('.').split(getClassName()));67 }68 public String getDescription() {69 return description;70 }71 public void setDescription(String description) {72 this.description = description;73 }74 public String getClassName() {75 return className;76 }77 public void setClassName(String className) {78 this.className = className;79 }80 public List<ScenarioModel> getScenarios() {81 return scenarios;82 }83 public void setScenarios(List<ScenarioModel> scenarios) {84 this.scenarios = scenarios;85 }86 public String getPackageName() {87 int index = this.className.lastIndexOf('.');88 if (index == -1) {89 return "";90 }91 return this.className.substring(0, index);92 }93 public List<ScenarioModel> getFailedScenarios() {94 return getScenariosWithStatus(ExecutionStatus.FAILED);95 }96 public List<ScenarioModel> getPendingScenarios() {97 return getScenariosWithStatus(ExecutionStatus.SCENARIO_PENDING, ExecutionStatus.SOME_STEPS_PENDING);98 }99 public List<ScenarioModel> getScenariosWithStatus(ExecutionStatus first, ExecutionStatus... rest) {100 EnumSet<ExecutionStatus> stati = EnumSet.of(first, rest);101 List<ScenarioModel> result = Lists.newArrayList();102 for (ScenarioModel m : scenarios) {103 ExecutionStatus executionStatus = m.getExecutionStatus();104 if (stati.contains(executionStatus)) {105 result.add(m);106 }107 }108 return result;109 }110 public synchronized void addTag(Tag tag) {111 this.tagMap.put(tag.toIdString(), tag);112 }113 public synchronized void addTags(Iterable<Tag> tags) {114 tags.forEach(this::addTag);115 }116 public synchronized Tag getTagWithId(String tagId) {117 Tag tag = this.tagMap.get(tagId);118 AssertionUtil.assertNotNull(tag, "Could not find tag with id " + tagId);119 return tag;120 }121 public synchronized Map<String, Tag> getTagMap() {122 return tagMap;123 }124 public synchronized void setTagMap(Map<String, Tag> tagMap) {125 this.tagMap = tagMap;126 }127 public synchronized void addScenarioModelOrMergeWithExistingOne(ScenarioModel scenarioModel) {128 Optional<ScenarioModel> existingScenarioModel = findScenarioModel(scenarioModel.getDescription());129 if (existingScenarioModel.isPresent()) {130 AssertionUtil.assertTrue(scenarioModel.getScenarioCases().size() == 1,131 "ScenarioModel has more than one case");132 existingScenarioModel.get().addCase(scenarioModel.getCase(0));133 existingScenarioModel.get().addDurationInNanos(scenarioModel.getDurationInNanos());134 } else {135 addScenarioModel(scenarioModel);136 }137 }138 public synchronized void setTestClass(Class<?> testClass) {139 AssertionUtil.assertTrue(className == null || testClass.getName().equals(className),140 "Test class of the same report model was set to different values. 1st value: " + className141 + ", 2nd value: " + testClass.getName());142 setClassName(testClass.getName());...
Source:WhenHtml5App.java
...37 }38 public SELF scenario_$_is_expanded( int scenarioNr ) {39 ScenarioModel scenarioModel = getScenarioModel( scenarioNr );40 webDriver.findElement( By.xpath( "//h4[contains(text(),'" +41 WordUtil.capitalize( scenarioModel.getDescription() ) + "')]" ) )42 .click();43 return self();44 }45 private ScenarioModel getScenarioModel( int scenarioNr ) {46 return reportModels.get( 0 ).getScenarios().get( scenarioNr - 1 );47 }48 public SELF the_page_of_scenario_$_is_opened( int scenarioNr ) throws MalformedURLException {49 ScenarioModel scenarioModel = getScenarioModel( scenarioNr );50 url_$_is_opened( "#/scenario/"51 + scenarioModel.getClassName()52 + "/" + scenarioModel.getTestMethodName() );53 return self();54 }55 @AfterStage...
getDescription
Using AI Code Generation
1package com.tngtech.jgiven.report.model;2import com.tngtech.jgiven.report.model.DescriptionModel;3import com.tngtech.jgiven.report.model.ScenarioModel;4public class ScenarioModelGetDescription {5 public static void main(String[] args) {6 ScenarioModel scenarioModel = new ScenarioModel();7 DescriptionModel descriptionModel = new DescriptionModel();8 scenarioModel.setDescription(descriptionModel);9 System.out.println(scenarioModel.getDescription());10 }11}12package com.tngtech.jgiven.report.model;13import com.tngtech.jgiven.report.model.DescriptionModel;14import com.tngtech.jgiven.report.model.ScenarioModel;15public class ScenarioModelGetDescription {16 public static void main(String[] args) {17 ScenarioModel scenarioModel = new ScenarioModel();18 DescriptionModel descriptionModel = new DescriptionModel();19 scenarioModel.setDescription(descriptionModel);20 System.out.println(scenarioModel.getDescription());21 }22}23package com.tngtech.jgiven.report.model;24import com.tngtech.jgiven.report.model.DescriptionModel;25import com.tngtech.jgiven.report.model.ScenarioModel;26public class ScenarioModelGetDescription {27 public static void main(String[] args) {28 ScenarioModel scenarioModel = new ScenarioModel();29 DescriptionModel descriptionModel = new DescriptionModel();30 scenarioModel.setDescription(descriptionModel);31 System.out.println(scenarioModel.getDescription());32 }33}34package com.tngtech.jgiven.report.model;35import com.tngtech.jgiven.report.model.DescriptionModel;36import com.tngtech.jgiven.report.model.ScenarioModel;37public class ScenarioModelGetDescription {38 public static void main(String[] args) {39 ScenarioModel scenarioModel = new ScenarioModel();40 DescriptionModel descriptionModel = new DescriptionModel();41 scenarioModel.setDescription(descriptionModel);42 System.out.println(scenarioModel.getDescription());43 }44}
getDescription
Using AI Code Generation
1package com.tngtech.jgiven.report.model;2import com.tngtech.jgiven.report.model.ScenarioModel;3import com.tngtech.jgiven.report.model.ScenarioModel;4public class ScenarioModelGetDescription {5public static void main(String[] args) {6ScenarioModel s = new ScenarioModel();7s.setDescription("This is a scenario");8System.out.println(s.getDescription());9}10}
getDescription
Using AI Code Generation
1package com.tngtech.jgiven.report.model;2import com.tngtech.jgiven.report.model.ScenarioModel;3import com.tngtech.jgiven.report.model.Description;4public class ScenarioModelGetDescription {5 public static void main(String[] args) {6 ScenarioModel scenarioModel = new ScenarioModel();7 scenarioModel.setDescription("Description");8 System.out.println(scenarioModel.getDescription());9 }10}
getDescription
Using AI Code Generation
1package com.tngtech.jgiven.impl.util;2import com.tngtech.jgiven.impl.util.ReflectionUtil;3import com.tngtech.jgiven.report.model.ReportModel;4import com.tngtech.jgiven.report.model.ScenarioModel;5import java.lang.reflect.InvocationTargetException;6import java.lang.reflect.Method;7import java.util.List;8public class GetDescription {9 public static void main(String[] args) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException {10 ReportModel reportModel = new ReportModel();11 List<ScenarioModel> scenarioModel = reportModel.getScenarios();12 ScenarioModel scenario = scenarioModel.get(0);13 Method method = ReflectionUtil.getMethod(ScenarioModel.class, "getDescription");14 String description = (String) method.invoke(scenario);15 System.out.println(description);16 }17}18package com.tngtech.jgiven.report.model;19import com.tngtech.jgiven.annotation.Description;20import com.tngtech.jgiven.impl.util.ReflectionUtil;21import com.tngtech.jgiven.report.model.NamedArgument;22import com.tngtech.jgiven.report.model.NamedArgumentList;23import java.lang.reflect.Method;24import java.util.ArrayList;25import java.util.List;26import java.util.Map;27public class ScenarioModel extends NamedArgumentList {28 private String description;29 private String descriptionHtml;30 private String descriptionText;31 private String descriptionMarkdown;32 private List<NamedArgument> descriptionArguments;33 public ScenarioModel() {34 this.descriptionArguments = new ArrayList();35 }36 public String getDescription() {37 return this.description;38 }39 public void setDescription(String description) {40 this.description = description;41 }42 public void setDescription(Description description) {43 this.description = description.value();44 this.descriptionHtml = description.html();45 this.descriptionText = description.text();46 this.descriptionMarkdown = description.markdown();47 this.descriptionArguments = this.createArguments(description);48 }49 private List<NamedArgument> createArguments(Description description) {50 Method[] var2 = description.getClass().getMethods();51 int var3 = var2.length;52 for(int var4 = 0; var4 < var3; ++var4) {53 Method method = var2[var4];54 if (ReflectionUtil.isGetter(method)) {55 try {
getDescription
Using AI Code Generation
1package com.tngtech.jgiven.report.model;2import com.tngtech.jgiven.impl.ScenarioModelBuilder;3public class ScenarioModelGetDescription {4 public static void main(String[] args) {5 ScenarioModelBuilder scenarioModelBuilder = new ScenarioModelBuilder();6 ScenarioModel scenarioModel = scenarioModelBuilder.build();7 System.out.println(scenarioModel.getDescription());8 }9}10package com.tngtech.jgiven.report.model;11import com.tngtech.jgiven.impl.ScenarioModelBuilder;12public class ScenarioModelGetDescription {13 public static void main(String[] args) {14 ScenarioModelBuilder scenarioModelBuilder = new ScenarioModelBuilder();15 ScenarioModel scenarioModel = scenarioModelBuilder.build();16 System.out.println(scenarioModel.getDescription());17 }18}19package com.tngtech.jgiven.report.model;20import com.tngtech.jgiven.impl.ScenarioModelBuilder;21public class ScenarioModelGetDescription {22 public static void main(String[] args) {23 ScenarioModelBuilder scenarioModelBuilder = new ScenarioModelBuilder();24 ScenarioModel scenarioModel = scenarioModelBuilder.build();25 System.out.println(scenarioModel.getDescription());26 }27}28package com.tngtech.jgiven.report.model;29import com.tngtech.jgiven.impl.ScenarioModelBuilder;30public class ScenarioModelGetDescription {31 public static void main(String[] args) {32 ScenarioModelBuilder scenarioModelBuilder = new ScenarioModelBuilder();33 ScenarioModel scenarioModel = scenarioModelBuilder.build();34 System.out.println(scenarioModel.getDescription());35 }36}37package com.tngtech.jgiven.report.model;38import com.tngtech.jgiven.impl.ScenarioModelBuilder;39public class ScenarioModelGetDescription {40 public static void main(String[] args) {41 ScenarioModelBuilder scenarioModelBuilder = new ScenarioModelBuilder();42 ScenarioModel scenarioModel = scenarioModelBuilder.build();43 System.out.println(scenarioModel.getDescription());
getDescription
Using AI Code Generation
1package com.tngtech.jgiven.report.model;2import com.tngtech.jgiven.annotation.Description;3import com.tngtech.jgiven.report.model.ScenarioModel;4import com.tngtech.jgiven.report.model.ScenarioModelBuilder;5import org.junit.Test;6public class ScenarioModelTest {7 public void testScenarioModel() {8 ScenarioModel scenarioModel = new ScenarioModelBuilder().setDescription("This is a test description").build();9 String description = scenarioModel.getDescription();10 System.out.println(description);11 }12}
getDescription
Using AI Code Generation
1package com.tngtech.jgiven.report.model;2import com.tngtech.jgiven.report.model.ScenarioModel;3import com.tngtech.jgiven.report.model.Tag;4public class ScenarioModelGetDescription {5 public static void main(String[] args) {6 ScenarioModel scenario = new ScenarioModel();7 scenario.setDescription("This is a sample description");8 System.out.println("Description: " + scenario.getDescription());9 }10}
getDescription
Using AI Code Generation
1package com.tngtech.jgiven.report.model;2import java.io.IOException;3import java.util.ArrayList;4import java.util.List;5import org.junit.Test;6import com.tngtech.jgiven.impl.ScenarioModelBuilder;7import com.tngtech.jgiven.impl.ScenarioModelBuilder.ScenarioModel;8import com.tngtech.jgiven.report.model.Word;9public class ScenarioModelTest {10 public void testGetDescription() throws IOException {11 ScenarioModelBuilder builder = new ScenarioModelBuilder();12 ScenarioModel model = builder.buildScenarioModel(ScenarioModelTest.class, "testGetDescription");13 List<Word> description = model.getDescription();14 System.out.println(description);15 }16}17package com.tngtech.jgiven.report.model;18import java.io.IOException;19import java.util.ArrayList;20import java.util.List;21import org.junit.Test;22import com.tngtech.jgiven.impl.ScenarioModelBuilder;23import com.tngtech.jgiven.impl.ScenarioModelBuilder.ScenarioModel;24import com.tngtech.jgiven.report.model.Word;25public class ScenarioModelTest {26 public void testGetDescription() throws IOException {27 ScenarioModelBuilder builder = new ScenarioModelBuilder();28 ScenarioModel model = builder.buildScenarioModel(ScenarioModelTest.class, "testGetDescription");29 List<Word> description = model.getDescription();30 System.out.println(description);31 }32}33package com.tngtech.jgiven.report.model;34import java.io.IOException;35import java.util.ArrayList;36import java.util.List;37import org.junit.Test;38import com.tngtech.jgiven.impl.ScenarioModelBuilder;39import com.tngtech.jgiven.impl.ScenarioModelBuilder.ScenarioModel;40import com.tngtech.jgiven.report.model.Word;41public class ScenarioModelTest {42 public void testGetDescription() throws IOException {43 ScenarioModelBuilder builder = new ScenarioModelBuilder();44 ScenarioModel model = builder.buildScenarioModel(ScenarioModelTest.class, "testGetDescription");45 List<Word> description = model.getDescription();46 System.out.println(description);47 }48}
Automation Testing Tutorials
Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run JGiven automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Most used method in ScenarioModel
- ScenarioModel
- accept
- addCase
- getExecutionStatus
- calculateExecutionStatus
- getCase
- addTag
- addTags
- addParameterNames
- setExplicitParameters
- getExplicitParameters
- getScenarioCases
- getTagIds
- isCasesAsTable
- setCasesAsTable
- clearCases
- getDurationInNanos
- setDurationInNanos
- addDurationInNanos
- setDerivedParameters
- addDerivedParameter
- getDerivedParameters
- getClassName
- setClassName
- getTestMethodName
- setTestMethodName
- getDescription
- setDescription
- setTagIds
- setExtendedDescription
- getExtendedDescription
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
