Skip to content

Commit

Permalink
Version 2.21.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkrombauts committed Jul 14, 2020
1 parent 4346ea4 commit 263cfc9
Show file tree
Hide file tree
Showing 327 changed files with 51,492 additions and 3,546 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ reports/
merged/
test/
Documentation-*/
Output/
#Output/

#nCrunch files
*.crunchproject.local.xml
Expand Down
52 changes: 48 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,63 @@ Features in Experimental are subject to change and removal without being conside

This document is formatted according to the principles of [Keep A CHANGELOG](http://keepachangelog.com).

## Unreleased
## [2.21.0] - 2020-07-14

### Added

- First Draft of the MarkDown output format. Expect some rough edges here. ([237](https://github.com/picklesdoc/pickles/issues/237)) (by [@darrencomeau](https://github.com/darrencomeau))

### Fixed

- Improve performance of VS Test results file parsing ([586](https://github.com/picklesdoc/pickles/pull/586)) (by [@tlecomte](https://github.com/tlecomte))
- Fix matching of scenario outline with duplicate values with VsTest ([542](https://github.com/picklesdoc/pickles/pull/542)) (by [@rik-smeets](https://github.com/rik-smeets) and [@jvandertil](https://github.com/jvandertil))

## [2.20.1] - 2018-10-17

### Fixed

- Javascript error in dhtml doc ([553](https://github.com/picklesdoc/pickles/issues/553)) (by [@dirkrombauts](https://github.com/dirkrombauts))

## [2.20.0] - 2018-10-09

### Added

- Pickles GUI: Generate equivalent PowerShell or Windows Console command line ([90](https://github.com/picklesdoc/pickles/issues/90)) (by [@magicmonty](https://github.com/magicmonty))

### Fixed

- Inconclusive marker shown when generating doc without test results ([545](https://github.com/picklesdoc/pickles/issues/545)) (by [@dirkrombauts](https://github.com/dirkrombauts))
- Remove requirement for hardcoded 'Index.html' in featureSearch.js ([541](https://github.com/picklesdoc/pickles/pull/541)) (by [@szaliszali](https://github.com/szaliszali))
- Exception in XUnit2ScenarioOutlineExampleMatcher ([548](https://github.com/picklesdoc/pickles/issues/548)) (by [@magicmonty](https://github.com/magicmonty))

## [2.19.0] - 2018-07-20

### Added

- Hide Tags from Living Documentation ([516](https://github.com/picklesdoc/pickles/pull/516)) (by [@spacehole1](https://github.com/spacehole1))
- Exclude Feature Files that have no included scenarios ([453](https://github.com/picklesdoc/pickles/issues/453)) (by [@janosmagyar](https://github.com/janosmagyar))

### Fixed

- Scenario Outline special characters workaround ([509](https://github.com/picklesdoc/pickles/pull/509)) (by [@DominikBaran](https://github.com/DominikBaran))
- Fix example matching for VSTest ([528](https://github.com/picklesdoc/pickles/pull/528)) (by [@jvandertil](https://github.com/jvandertil))

## [2.18.2] - 2018-04-28

### Changed

### Deprecated
- Updated several external libraries

### Removed
### Fixed

- Problem with Chocolatey Deployment

## [2.18.1] - 2018-04-20

### Fixed

### Security
- More robust scenario outline example mapping by using code from SpecFlow ([519](https://github.com/picklesdoc/pickles/pull/519)) (by [@dirkrombauts](https://github.com/dirkrombauts), based on an idea by [@janosmagyar](https://github.com/janosmagyar))
- Only the table of the examples in a scenario outline should have test results ([515](https://github.com/picklesdoc/pickles/pull/515)) (by [@spacehole1](https://github.com/spacehole1))

## [2.20.1] - 2018-10-17

Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Pickles is a volunteer effort. We encourage you to pitch in!

- Fork the `Pickles` repository
- Create your code
- Send a pull request.
- Send a pull request

### To Contribute to the Test Results Providers
### To Contribute to the Test Result Providers

If you find a bug in a Test Result Provider and want to contribute towards fixing it, start of by adding a scenario or feature file that shows off the bug to the test harness solution in the `test-harness` directory.. Add the scenario to the projects of each test result provider: it is quite likely that the same bug will occur across several test result providers. Don't forget the Cucumber and CucumberJS providers: it's easy to overlook them because they are not in the visual studio solution.
If you find a bug in a test result provider and want to contribute towards fixing it, start of by adding a scenario or feature file that shows off the bug to the test harness solution in the `test-harness` directory. Add the scenario to the projects of each test result provider: it is quite likely that the same bug will occur across several test result providers. Don't forget the Cucumber and CucumberJS providers: it's easy to overlook them because they are not in the visual studio solution.

Implement the automation layer in .NET, Ruby and JS if you are able. If you create your scenarios so that they use only steps from the other feature files, then you will most likely not need this step.

Expand All @@ -26,15 +26,15 @@ Once you're done, send a pull request.

#### Setting up the Test Harness

the `test-harness` directory contains the scenarios from which test results are derived to test the parsing of test results in Pickles
The `test-harness` directory contains the scenarios from which test results are derived to test the parsing of test results in Pickles.

##### .NET Code

The .NET code is found in `./TestHarness/TestHarness.sln` solution. You will need [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/) in order to open the solution; the free Community version is fine. Remember to restore the NuGet packages before you compile.

##### Cucumber/Ruby Code

In order to generate the thest output of the Cucumber features, you need to install the following software:
In order to generate the test output of the Cucumber features, you need to install the following software:

- [Ruby](http://rubyinstaller.org/downloads): use the stable 2.2.x version
- Install Cucumber by opening an admin-enabled command line window in the directory where you cloned this repository, and running these gem commands:
Expand All @@ -61,14 +61,14 @@ In order to generate the test output of the CucumberJS features, you need to ins

## To Request a Feature

- Create an issue.
- Create an issue

## To Ask a Question

- Create an issue.
- Create an issue

## To Report a Bug

- Create an issue
- Describe steps to reproduce the bug
- If at all possible, attach feature file(s) that cause the bug. In most cases you can remove the steps from the scenarios in order to protect your intellectual property.
- If at all possible, attach feature file(s) that cause the bug. In most cases you can remove the steps from the scenarios in order to protect your intellectual property
10 changes: 6 additions & 4 deletions CreateTestResults.ps1
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Write-Host "Remember to build the solution first!"

# NUnit2
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\NUnit.Runners.2.6.4\tools\nunit-console.exe" -ArgumentList "$PSScriptRoot\test-harness\nunit\bin\Debug\nunitHarness.dll", "/result=$PSScriptRoot\results-example-nunit.xml" -NoNewWindow -Wait
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\NUnit.Runners.2.7.0\tools\nunit-console.exe" -ArgumentList "$PSScriptRoot\test-harness\nunit\bin\Debug\nunitHarness.dll", "/result=$PSScriptRoot\results-example-nunit.xml" -NoNewWindow -Wait

# NUnit 2 with NUnit3 runner
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\NUnit.ConsoleRunner.3.6.0\tools\nunit3-console.exe" -ArgumentList "$PSScriptRoot\test-harness\nunit\bin\Debug\nunitHarness.dll", "/result=$PSScriptRoot\results-example-nunit2-with-nunit3-runner.xml" -NoNewWindow -Wait
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\NUnit.ConsoleRunner.3.9.0\tools\nunit3-console.exe" -ArgumentList "$PSScriptRoot\test-harness\nunit\bin\Debug\nunitHarness.dll", "/result=$PSScriptRoot\results-example-nunit2-with-nunit3-runner.xml" -NoNewWindow -Wait

# NUnit 3
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\NUnit.ConsoleRunner.3.6.0\tools\nunit3-console.exe" -ArgumentList "$PSScriptRoot\test-harness\nunit3\bin\Debug\nunit3Harness.dll", "/result=$PSScriptRoot\results-example-nunit3.xml" -NoNewWindow -Wait
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\NUnit.ConsoleRunner.3.9.0\tools\nunit3-console.exe" -ArgumentList "$PSScriptRoot\test-harness\nunit3\bin\Debug\nunit3Harness.dll", "/result=$PSScriptRoot\results-example-nunit3.xml" -NoNewWindow -Wait

# SpecRun
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\SpecRun.Runner.1.2.0\tools\specrun.exe" -ArgumentList "run default.srprofile", "/baseFolder:$PSScriptRoot\test-harness\SpecRun\bin\Debug", "/log:specrun.log", "/report:$PSScriptRoot\results-example-specrun.html" -NoNewWindow -Wait
Expand All @@ -16,7 +16,7 @@ Start-Process -FilePath "$PSScriptRoot\test-harness\packages\SpecRun.Runner.1.2.
Start-Process -FilePath "$PSScriptRoot\test-harness\packagesNonNuget\xunit.runner\xunit.console.clr4.exe" -ArgumentList "$PSScriptRoot\test-harness\xunit\bin\Debug\xunitHarness.dll", "/xml $PSScriptRoot\results-example-xunit.xml" -NoNewWindow -Wait

# XUnit 2
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\xunit.runner.console.2.1.0\tools\xunit.console.exe" -ArgumentList "$PSScriptRoot\test-harness\xunit2\bin\Debug\xunit2Harness.dll", "-xml $PSScriptRoot\results-example-xunit2.xml", "-parallel none" -NoNewWindow -Wait
Start-Process -FilePath "$PSScriptRoot\test-harness\packages\xunit.runner.console.2.4.0\tools\net452\xunit.console.exe" -ArgumentList "$PSScriptRoot\test-harness\xunit2\bin\Debug\xunit2Harness.dll", "-xml $PSScriptRoot\results-example-xunit2.xml", "-parallel none" -NoNewWindow -Wait

# MSTest
$MSTest = Get-ChildItem -Path "${env:ProgramFiles(x86)}\Microsoft Visual Studio\2017" -Recurse | Where-Object { $_.Name -eq "MSTest.exe" } | Select-Object -First 1
Expand All @@ -35,6 +35,8 @@ Set-Location $PSScriptRoot
# CucumberJS
Set-Location -Path "$PSScriptRoot\test-harness\CucumberJS"
& "$PSScriptRoot\node_modules\.bin\cucumber-js" --format json:"$PSScriptRoot\results-example-cucumberjs-json.json"
Write-Host "Waiting for CucumberJS to finish. You might need to increase the sleep time as the test suite increases."
Start-Sleep -s 2
Set-Location $PSScriptRoot

# VSTest
Expand Down
Loading

0 comments on commit 263cfc9

Please sign in to comment.