picklesdoc / pickles

The open source living documentation generator
http://www.picklesdoc.com/
Apache License 2.0
461 stars 163 forks source link

Generated cucumber json missing the uri property#609 #618

Closed ghost closed 2 years ago

ghost commented 2 years ago

I'm looking for a way how to pass SpecFlow test results into Jira BDD plugins like Behave.Pro Pickles support Cucumber JSON format, but an outdated version. I failed to use the current report, it is not recognized by Jira plugin Behave.Pro and Cucumber for Jira.

So I decided to update pickles to do the job. There are some other options but I believe Pickles fits perfectly.

This PR updates the Cucumber JSON report to comply with the schema and make it usable with Behave.Pro

Features Cucumber JSON report

Command line runner

Refactoring to launch tests on .Net core

My dev environment is .Net5 on MacOS and Rider, so I made my changes on top of the latest unreleased main branch with .Net core support. Thanks a lot for it, @x97mdr!

There are a lot of changes to file names, paths, and filesystem handling in tests. Mostly it is about avoiding usage of Windows-specific file paths and building the file paths in a platform-independent way. There was a need for few packages updates to work on macOS, leading to additional code changes as well.

I'm able to build and test Pickles using:

dotnet build -c Debug
dotnet test -c Debug --no-build

The Release configuration does not build as it includes ASP.NET project. Test summary: 2021-09-20_13-51-19

One test is red because of the OpenXML package error. I tried to solve it with no success, but believe it is platform-specific.
The contribution guide is Windows and Visual-Studio specific, so I did not follow it in some places. Please let me know if I should change smth in the PR.

ericcmmi commented 2 years ago

Whoa, thanks @andrey-covergo! I had just started working on getting the solution to be able to dev in Mac so your timing is perfect! I've been using Visual Studio for Mac but it's giving me some errors so I'm going to download Rider. If I like that better than Visual Studio Mac I'll go ahead and buy it. Give me a little time to review and I'll get this pulled in. Again, thank you!

ghost commented 2 years ago

@ericcallsynx you are welcome, pickles is an amazing tool crafted with love. It is my pleasure to contribute. This PR is ide-agnostic, everything should work with any IDE like VS, VS Code, VS for Mac, Rider on the respective platform. What kind of errors do you get from VS for Mac?

ericcmmi commented 2 years ago

Approving the PR into this branch and will work on the outstanding unit test failure