Adding Cucumber JSON Documentation Builder #413

dgrekov · 2017-01-20T04:25:27Z

Will throw my hat in the ring as well. I took the two previously opened and abandoned pull requests and cleaned them up as well as brought them up to the new solution layout.

All Files are committed, all tests pass.

merging in tests

catching up the repo

# Conflicts: # src/Pickles/.vs/config/applicationhost.config # src/Pickles/Pickles.Test/Pickles.Test.csproj # src/Pickles/Pickles/Pickles.csproj # src/Pickles/Pickles/PicklesModule.cs

…leting successfully

dirkrombauts · 2017-01-20T10:19:55Z

Thank you for your contribution! I will add some review comments to individual lines.

dirkrombauts

Again: thanks for your contribution. In order to keep quality and maintainability high, I requested some changes.

dirkrombauts · 2017-01-20T10:25:38Z

src/Pickles/Pickles.DocumentationBuilders.Cucumber/Properties/AssemblyInfo.cs

@@ -0,0 +1,36 @@
+using System.Reflection;


Please use a minimal AssemblyInfo.cs similar to the other projects, and link the VersionInfo.cs file to the project.

dirkrombauts · 2017-01-20T10:27:27Z

src/Pickles/Pickles.ObjectModel/ObjectModel/Feature.cs

@@ -35,15 +35,15 @@ public Feature()

        public string Description { get; set; }

-        public List<IFeatureElement> FeatureElements { get; }
+        public List<IFeatureElement> FeatureElements { get; private set; }


The private setter is not needed. Please remove it again.

dirkrombauts · 2017-01-20T10:27:32Z

src/Pickles/Pickles.ObjectModel/ObjectModel/Feature.cs


-        public List<Comment> Comments { get; }
+        public List<Comment> Comments { get; private set; }


The private setter is not needed. Please remove it again.

dirkrombauts · 2017-01-20T10:27:36Z

src/Pickles/Pickles.ObjectModel/ObjectModel/Feature.cs


        public Scenario Background { get; private set; }

        public TestResult Result { get; set; }

-        public List<string> Tags { get; }
+        public List<string> Tags { get; private set; }


The private setter is not needed. Please remove it again.

dirkrombauts · 2017-01-20T10:29:08Z

testOutput.ps1

@@ -1,5 +1,5 @@
 $version = $args[0]
-$formats = @("Html", "Dhtml", "Word", "Excel", "JSON")
+$formats = @("Html", "Dhtml", "Word", "Excel", "JSON", "Cucumber")


Please add Cucumber to testRunnerCmd.cmd and testRunnerMsBuild.cmd as well.

Adjusted testRunnerCmd.cmd but did not find where in testRunnerMsBuild.cmd to make the change.

Ah, my mistake - the output formats are defined in testOutput.proj, not in testRunnersMsBuild.cmd. Could you make the change there please?

dgrekov · 2017-01-21T04:05:16Z

Changes made as requested, glad to be of help. Let me know if anything else should be adjusted.

dirkrombauts · 2017-01-23T16:41:35Z

Thanks again for your contribution!

dirkrombauts · 2017-01-23T16:42:32Z

Would you be willing (and have time) to adapt the documentation of Pickles too? It's in the docs repository.

dgrekov · 2017-01-23T16:43:05Z

Sure, let me see if I have some time tonight.

dgrekov · 2017-01-24T02:15:00Z

Done. Please review

dirkrombauts · 2017-01-25T16:08:46Z

Thanks!

dirkrombauts · 2017-01-25T16:09:16Z

Ah, apparently approving the reviews does not automatically merge the pull request :-) I merged it now.

* Fixes hiding topnav when printing. (#411) * Adding Cucumber JSON Documentation Builder (#413) * Adding Cucumber JSON as possible export format * Version * fixing the tests * Fixing unit tests * Separated Cucumber Documentation as separate project * Fixing Build Pipeline * Adding missed build dependency steps * resolved the namespace issues that was preventing the build from completing successfully * Addressing code review comments * adding cucumber output format * Release 2.12.0 (#416) * Adding entries to change log * Bump version (2.12.0) * Version 2.12.0

dirkrombauts · 2017-01-26T18:01:05Z

Released in version 2.12.0.

bitcoder · 2017-02-07T18:19:39Z

Can you please clarify how would you setup SpecFlow to integrate with Pickles, so pickles would output a cucumber json file?
How should the specflow project be configured? Would we have to make specflow output in Nunit XML and then use Pickles to take that XML as input, in order to convert to Cucumber JSON format?

dgrekov · 2017-02-07T19:32:47Z

That's basically it, let me set up a PoC and write back into this chat.

bitcoder · 2017-02-07T19:49:16Z

@dgrekov great, it would be great to have if you can share a working PoC :)

dirkrombauts · 2017-02-08T16:53:55Z

@dgrekov I think I may have found a problem with the Cucumber JSON output: it seems that for scenario outlines, there is no information about the individual examples. Are you experiencing that as well? Am I missing something?

bitcoder · 2017-02-21T13:48:43Z

@dgrekov were you able to set up the PoC? The online documentation is not very clear on having a full end-to-end example. I can provide you a sample .feature file and the c# class that implements the class under test.
Will that help?
The idea was having a project in Visual Studio or Visual Code, or in other words made with .Net, using SpecFlow and where the output is Cucumber JSON file in the end.

dgrekov · 2017-02-23T03:13:14Z

@bitcoder, sorry for the delay, got a little behind at work. Will try for something soon.

dgrekov · 2017-02-23T03:13:41Z

@dirkrombauts let me look into that.

bitcoder · 2017-03-06T15:09:47Z

Hi @dgrekov, were you able to make a working PoC?

dgrekov · 2017-03-06T15:10:56Z

Sorry guys, did not mean to leave you hanging, had a hard sprint wrapping up today. Will work to get a PoC up for you in a few hours.

dgrekov · 2017-03-07T05:17:05Z

Got my PoC working but all of my results are coming back as inconclusive, need to look into the test harness as to see why. This will be a little bit longer.

@bitcoder, you don't need the DLL to make this work. The only thing that is needed is the Feature file directory and the nunit XML result. I will post an example to a repo tomorrow.

bitcoder · 2017-03-08T10:50:04Z

ok @dgrekov, I look forward to see the example :)

dgrekov · 2017-03-09T16:21:40Z

Ok, I found the issue. The standard NUnit (and xUnit) report does not produce step level data, what we need is to tweak the output to include that, I think I have an approach, testing it out and will update you soon.

bitcoder · 2017-04-06T13:33:15Z

Hi @dgrekov , any news about this? Were you able to achieve a working solution?
thanks

bitcoder · 2017-07-13T13:12:21Z

Hi, were you able to solve this or make a PoC with this?

dgrekov · 2017-07-20T21:55:59Z

Apologies, I have been pulled into a different effort and was not able to make much progress on this. The changes needed to take advantage of actual test results was very involved and I do not think I will have time in the near future to finish it. Will post back here if I am able to contribute more.

Julien Grossrieder and others added 11 commits July 20, 2016 08:26

Adding Cucumber JSON as possible export format

6e9ad65

Version

acee1cb

fixing the tests

290491f

Merge pull request #1 from armsteadj1/develop

e4aa6c5

merging in tests

Merge pull request #2 from picklesdoc/develop

036ce29

catching up the repo

Fixing unit tests

2e007b9

Merge commit '036ce29b5ee37c41690b388fe259d3f18be60f3c' into develop

c717d57

# Conflicts: # src/Pickles/.vs/config/applicationhost.config # src/Pickles/Pickles.Test/Pickles.Test.csproj # src/Pickles/Pickles/Pickles.csproj # src/Pickles/Pickles/PicklesModule.cs

Separated Cucumber Documentation as separate project

cd093dc

Fixing Build Pipeline

bb4ff6b

Adding missed build dependency steps

98b95c8

resolved the namespace issues that was preventing the build from comp…

ef91d34

…leting successfully

This was referenced Jan 20, 2017

Adding Cucumber JSON as possible export format #359

Closed

Cucumber w/ Tests #366

Closed

dirkrombauts requested changes Jan 20, 2017

View reviewed changes

Addressing code review comments

3d3d8d7

adding cucumber output format

0d40153

dirkrombauts approved these changes Jan 23, 2017

View reviewed changes

dirkrombauts added the ready-to-be-released label Jan 23, 2017

dirkrombauts merged commit 5769fa5 into picklesdoc:develop Jan 25, 2017

dirkrombauts removed the ready-to-be-released label Jan 26, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Cucumber JSON Documentation Builder #413

Adding Cucumber JSON Documentation Builder #413

dgrekov commented Jan 20, 2017

dirkrombauts commented Jan 20, 2017

dirkrombauts left a comment

dirkrombauts Jan 20, 2017

dgrekov Jan 21, 2017

dirkrombauts Jan 20, 2017

dirkrombauts Jan 20, 2017

dirkrombauts Jan 20, 2017

dirkrombauts Jan 20, 2017

dgrekov Jan 21, 2017

dirkrombauts Jan 23, 2017

dgrekov commented Jan 21, 2017

dirkrombauts commented Jan 23, 2017

dirkrombauts commented Jan 23, 2017

dgrekov commented Jan 23, 2017

dgrekov commented Jan 24, 2017

dirkrombauts commented Jan 25, 2017

dirkrombauts commented Jan 25, 2017

dirkrombauts commented Jan 26, 2017

bitcoder commented Feb 7, 2017

dgrekov commented Feb 7, 2017

bitcoder commented Feb 7, 2017

dirkrombauts commented Feb 8, 2017

bitcoder commented Feb 21, 2017

dgrekov commented Feb 23, 2017

dgrekov commented Feb 23, 2017

bitcoder commented Mar 6, 2017

dgrekov commented Mar 6, 2017

dgrekov commented Mar 7, 2017

bitcoder commented Mar 8, 2017

dgrekov commented Mar 9, 2017

bitcoder commented Apr 6, 2017

bitcoder commented Jul 13, 2017

dgrekov commented Jul 20, 2017


		public List<Comment> Comments { get; }
		public List<Comment> Comments { get; private set; }

Adding Cucumber JSON Documentation Builder #413

Adding Cucumber JSON Documentation Builder #413

Conversation

dgrekov commented Jan 20, 2017

dirkrombauts commented Jan 20, 2017

dirkrombauts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dgrekov commented Jan 21, 2017

dirkrombauts commented Jan 23, 2017

dirkrombauts commented Jan 23, 2017

dgrekov commented Jan 23, 2017

dgrekov commented Jan 24, 2017

dirkrombauts commented Jan 25, 2017

dirkrombauts commented Jan 25, 2017

dirkrombauts commented Jan 26, 2017

bitcoder commented Feb 7, 2017

dgrekov commented Feb 7, 2017

bitcoder commented Feb 7, 2017

dirkrombauts commented Feb 8, 2017

bitcoder commented Feb 21, 2017

dgrekov commented Feb 23, 2017

dgrekov commented Feb 23, 2017

bitcoder commented Mar 6, 2017

dgrekov commented Mar 6, 2017

dgrekov commented Mar 7, 2017

bitcoder commented Mar 8, 2017

dgrekov commented Mar 9, 2017

bitcoder commented Apr 6, 2017

bitcoder commented Jul 13, 2017

dgrekov commented Jul 20, 2017