/** * Copyright (c) 2012 BMW Car IT and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html */ package org.jnario.feature.tests.unit.doc; import com.google.inject.Inject; import java.util.Collection; import java.util.Map; import org.eclipse.emf.common.util.EList; import org.eclipse.emf.ecore.EObject; import org.eclipse.emf.ecore.resource.Resource; import org.eclipse.xtend.core.xtend.XtendTypeDeclaration; import org.eclipse.xtend2.lib.StringConcatenation; import org.eclipse.xtext.generator.InMemoryFileSystemAccess; import org.eclipse.xtext.xbase.lib.Extension; import org.eclipse.xtext.xbase.lib.Functions.Function0; import org.eclipse.xtext.xbase.lib.IterableExtensions; import org.jnario.Executable; import org.jnario.feature.doc.FeatureDocGenerator; import org.jnario.feature.feature.Feature; import org.jnario.feature.feature.FeatureFile; import org.jnario.jnario.test.util.FeatureTestCreator; import org.jnario.jnario.test.util.ModelStore; import org.jnario.lib.JnarioIterableExtensions; import org.jnario.lib.Should; import org.jnario.report.Executable2ResultMapping; import org.jnario.report.Failed; import org.jnario.report.SpecExecution; import org.jnario.report.SpecFailure; import org.jnario.runner.CreateWith; import org.jnario.runner.ExampleGroupRunner; import org.jnario.runner.Named; import org.jnario.runner.Order; import org.jnario.runner.Subject; import org.junit.Assert; import org.junit.Test; import org.junit.runner.RunWith; @CreateWith(FeatureTestCreator.class) @Named("FeatureDocGenerator") @RunWith(ExampleGroupRunner.class) @SuppressWarnings("all") public class FeatureDocGeneratorSpec { @Subject public FeatureDocGenerator subject; @Inject @Extension @org.jnario.runner.Extension public ModelStore _modelStore; @Inject InMemoryFileSystemAccess fsa; @Inject Executable2ResultMapping mapping; @Test @Named("generates scenario documentation") @Order(1) public void _generatesScenarioDocumentation() throws Exception { final String actual = this.generateDoc("\r\n\t\t\tpackage test\r\n\r\n\t\t\tFeature: Example Feature\r\n\t\t\t\t\r\n\t\t\t\tThis is a description.\r\n\t\t\t\t\r\n\t\t\t\tScenario: Example Scenario\r\n\t\t\t\t\r\n\t\t\t\t\tString input\r\n\t\t\t\t\r\n\t\t\t\t\tGiven a step with an argument \"something\", another \"argument\" and a multiline string:\r\n\t\t\t\t\t\'\'\'\r\n\t\t\t\t\t\timport java.util.Collections.*;\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\tpublic class Greeter{\r\n\t\t\t\t\t\t\tpublic static void main(String args[]){\r\n\t\t\t\t\t\t\t\tList<String> list = new ArrayList<String>(); // should escape angle brackets\r\n\t\t\t\t\t\t\t\tSysten.out.println(\'Hello World\');\r\n\t\t\t\t\t\t\t}\r\n\t\t\t\t\t\t}\'\'\' \r\n\t\t\t\t\t\tinput = args.first\r\n\t\t\t\t\t\tprintln(args.last)\r\n\t\t\t\t\tWhen I do something that is pending.\r\n\t\t\t\t\t\tAnd something else that is pending\r\n\t\t\t\t\t\tBut this is implemented\r\n\t\t\t\t\t\t\t1 + 1 => 2\r\n\t\t\t\t\tThen it results in \"something else\"\r\n\t\t\t\t\t\tinput + \' else\' => args.first \r\n\t\t"); StringConcatenation _builder = new StringConcatenation(); _builder.append("<p>This is a description.</p>"); _builder.newLine(); _builder.append("<div><h3 class=\"scenario pending\" id=\"Scenario_Example_Scenario\">Scenario: Example Scenario"); _builder.newLine(); _builder.append("</h3>"); _builder.newLine(); _builder.append("<ul>"); _builder.newLine(); _builder.append("<li><span class=\"step notrun\"><p>Given a step with an argument <code>\"something\"</code>, another <code>\"argument\"</code> and a multiline string:</p><pre>import java.util.Collections.*;"); _builder.newLine(); _builder.newLine(); _builder.append("public class Greeter{"); _builder.newLine(); _builder.append(" "); _builder.append("public static void main(String args[]){"); _builder.newLine(); _builder.append(" "); _builder.append("List<String> list = new ArrayList<String>(); // should escape angle brackets"); _builder.newLine(); _builder.append(" "); _builder.append("Systen.out.println(\'Hello World\');"); _builder.newLine(); _builder.append(" "); _builder.append("}"); _builder.newLine(); _builder.append("}</pre></span>"); _builder.newLine(); _builder.append("</li>"); _builder.newLine(); _builder.append("<li><span class=\"step pending\"><p>When I do something that is pending. [PENDING]</p></span>"); _builder.newLine(); _builder.append("</li>"); _builder.newLine(); _builder.append("<li><span class=\"step pending\"><p>And something else that is pending [PENDING]</p></span>"); _builder.newLine(); _builder.append("</li>"); _builder.newLine(); _builder.append("<li><span class=\"step notrun\"><p>But this is implemented</p></span>"); _builder.newLine(); _builder.append("</li>"); _builder.newLine(); _builder.append("<li><span class=\"step notrun\"><p>Then it results in <code>\"something else\"</code></p></span>"); _builder.newLine(); _builder.append("</li>"); _builder.newLine(); _builder.append("</ul>"); _builder.newLine(); _builder.append("</div>"); _builder.newLine(); final String expected = _builder.toString(); Assert.assertEquals(expected, actual); } @Test @Named("Includes failure state in Feature") @Order(2) public void _includesFailureStateInFeature() throws Exception { StringConcatenation _builder = new StringConcatenation(); _builder.append("Feature: Example"); _builder.newLine(); _builder.newLine(); _builder.append("Scenario: A failing Scenario"); _builder.newLine(); _builder.newLine(); _builder.append("Given something"); _builder.newLine(); _builder.append("When something happens "); _builder.newLine(); _builder.append("Then there is an error"); _builder.newLine(); _builder.newLine(); _builder.append("Scenario: Another scnario"); _builder.newLine(); _builder.append("Given something"); _builder.newLine(); _builder.append("\t"); _builder.append("1 + 1 => 2"); _builder.newLine(); _builder.append("Then something else"); _builder.newLine(); _builder.append("\t"); _builder.append("\"\" "); _builder.newLine(); CharSequence _generateDocWithErrors = this.generateDocWithErrors(_builder); org.jnario.lib.Assert.assertTrue("\nExpected \'\'\'\r\n\t\t\tFeature: Example\r\n\t\t\t\r\n\t\t\tScenario: A failing Scenario\r\n\t\t\t\r\n\t\t\tGiven something\r\n\t\t\tWhen something happens \r\n\t\t\tThen there is an error\r\n\t\t\t\r\n\t\t\tScenario: Another scnario\r\n\t\t\tGiven something\r\n\t\t\t\t1 + 1 => 2\r\n\t\t\tThen something else\r\n\t\t\t\t\"\" \r\n\t\t\'\'\'.generateDocWithErrors should contain \"failed\" but" + "\n \'\'\'\r\n\t\t\tFeature: Example\r\n\t\t\t\r\n\t\t\tScenario: A failing Scenario\r\n\t\t\t\r\n\t\t\tGiven something\r\n\t\t\tWhen something happens \r\n\t\t\tThen there is an error\r\n\t\t\t\r\n\t\t\tScenario: Another scnario\r\n\t\t\tGiven something\r\n\t\t\t\t1 + 1 => 2\r\n\t\t\tThen something else\r\n\t\t\t\t\"\" \r\n\t\t\'\'\'.generateDocWithErrors is " + new org.hamcrest.StringDescription().appendValue(_generateDocWithErrors).toString() + "\n \'\'\'\r\n\t\t\tFeature: Example\r\n\t\t\t\r\n\t\t\tScenario: A failing Scenario\r\n\t\t\t\r\n\t\t\tGiven something\r\n\t\t\tWhen something happens \r\n\t\t\tThen there is an error\r\n\t\t\t\r\n\t\t\tScenario: Another scnario\r\n\t\t\tGiven something\r\n\t\t\t\t1 + 1 => 2\r\n\t\t\tThen something else\r\n\t\t\t\t\"\" \r\n\t\t\'\'\' is " + new org.hamcrest.StringDescription().appendValue(_builder).toString() + "\n", Should.<Object>should_contain(_generateDocWithErrors, "failed")); } final String message = new Function0<String>() { public String apply() { StringConcatenation _builder = new StringConcatenation(); _builder.append("Expected result => args.first.toInt but "); _builder.newLine(); _builder.append(" \t\t"); _builder.append("result is <122> "); _builder.newLine(); _builder.append(" \t\t"); _builder.append("args.first.toInt is <120> "); _builder.newLine(); _builder.append(" \t\t"); _builder.append("args.first is \"120\" "); _builder.newLine(); _builder.append(" \t\t"); _builder.append("args is <[120]>"); _builder.newLine(); return _builder.toString(); } }.apply(); public Executable2ResultMapping mappingWithFailures() { final Executable2ResultMapping _function = new Executable2ResultMapping() { public SpecExecution getResult(final Executable it) { String _string = FeatureDocGeneratorSpec.this.message.toString(); StringConcatenation _builder = new StringConcatenation(); _builder.append("java.lang.StringIndexOutOfBoundsException: String index out of range: -1"); _builder.newLine(); _builder.append("\t"); _builder.append("at java.lang.String.substring(String.java:1937)"); _builder.newLine(); _builder.append("\t"); _builder.append("at java.lang.String.substring(String.java:1904)"); _builder.newLine(); _builder.append("\t"); _builder.append("at org.jnario.feature.doc.FeatureDocGenerator$1.apply(FeatureDocGenerator.java:44)"); _builder.newLine(); _builder.append("\t"); _builder.append("at org.jnario.feature.doc.FeatureDocGenerator$1.apply(FeatureDocGenerator.java:1)"); _builder.newLine(); _builder.append("\t"); _builder.append("at org.jnario.doc.HtmlFile.newHtmlFile(HtmlFile.java:21)"); _builder.newLine(); _builder.append("\t"); _builder.append("at org.jnario.feature.doc.FeatureDocGenerator.createHtmlFile(FeatureDocGenerator.java:57)"); _builder.newLine(); _builder.append("\t"); _builder.append("at org.jnario.doc.AbstractDocGenerator$2$1.apply(AbstractDocGenerator.java:88)"); _builder.newLine(); String _string_1 = _builder.toString(); SpecFailure _specFailure = new SpecFailure(_string, "Exception", _string_1); return Failed.failingSpec("org.jnario.Class", "This Feature", 0.3, _specFailure); } }; return this.mapping = _function; } public CharSequence generateDocWithErrors(final CharSequence input) { CharSequence _xblockexpression = null; { final Resource resource = this._modelStore.parseScenario(input); Executable2ResultMapping _mappingWithFailures = this.mappingWithFailures(); this.subject.doGenerate(resource, this.fsa, _mappingWithFailures); Map<String, CharSequence> _files = this.fsa.getFiles(); Collection<CharSequence> _values = _files.values(); _xblockexpression = JnarioIterableExtensions.<CharSequence>first(_values); } return _xblockexpression; } public String generateDoc(final CharSequence input) { final Resource resource = this._modelStore.parseScenario(input); EList<EObject> _contents = resource.getContents(); EObject _head = IterableExtensions.<EObject>head(_contents); final FeatureFile featureFile = ((FeatureFile) _head); EList<XtendTypeDeclaration> _xtendTypes = featureFile.getXtendTypes(); XtendTypeDeclaration _head_1 = IterableExtensions.<XtendTypeDeclaration>head(_xtendTypes); CharSequence _generateContent = this.subject.generateContent(((Feature) _head_1)); return _generateContent.toString(); } }