All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Errors output inside jobs would throw unintentional errors during parsing.
- Remove extraneous close comment bracket.
- Fix error in Publish when an unexpected result was returned.
- Added aliases for constrained endpoint compatibility.
- Publish-Jojoba can now take a list of properties to output to the display.
- $jojobaBatch is now stored and retrieved properly within the caller module.
- Timestamp is now in UTC. This makes a lot of sense for me because I aggregate the test data to a central repository, and tests can run on machines that are in different timezones. In that architecture the preferred way to determine "what is the most recent test" is to use UTC as a baseline.
- When a function in a module is using Jojoba a $jojobaBatch variable will be inserted into the module state for reuse of runspaces. This makes functions way faster than creating runspaces every time. If the module is reloaded, the variable is lost, and so a new variable and set of runspaces are created. If you don't like this behaviour, you can still specify JojobaBatch manually. You can also modify the PSBoundParameters in the begin {} block of functions to insert a random GUID which will generate a fresh runspace. Functions which are not in modules always use a fresh runspace.
- Improve module load time.
- Changelog syntax passes VS Code markdown linter.
- Speech isn't attempted if the required sound services are not running. A warning will be issued instead.
- Default JojobaThrottle maxes out at 8 for servers with more cores. This is because allocating so many threads is more inefficient than limiting them.
- Updated internal structure and version bump for PowerShell Gallery.
- Files converted to BOM-less TAB-less UTF-8.
- Jenkin's JUnit parsing in xUnit became more strict which caused all tests to start failing. This moves around the location of some attributes in the XML to meet the standard and get Jenkins going again. I plan to make some more improvements later (adding error blocks for critical failures).
- Module was not loading properly if installed from Install-Module because of a pattern match in the Jojoba.psm1 which was intended to prevent loading of *.Tests.ps1 etc but was being triggered by dots in the version number in the full path.
- If you only have a single ValueFromPipeline parameter per parameter set, this no longer needs a name or alias of InputObject. If you have multiple variables meeting this definition you can use InputObject to decide which one to use.
- Verbose now passes only to the
Start-Jojobascriptblock code. If you want to see verbose output from Jojoba and PoshRSJob use-JojobaVerboseinstead. - Updated very old entries in the CHANGELOG.
- Where objects are output into the Data section of a test, they are formatted
with
Format-ListandOut-String. Now Out-String is limited to a width of up to 12 characters less than the terminal width, so when it is displayed on screen inside the test case (which is also formatted withFormat-List) it will wrap correctly. If there's no known terminal width then nothing changes. This won't work for nested tests though.
Write-JojobaPropertywould fail if called twice on the same property.Write-JojobaSkipwould skip a test even if it had already failed. Now a Skip will always log its message but will not overwrite a previous Fail result.
- Order of test case properties changed for better readability.
- Test case properties Message and Data may now be $null instead of empty strings. This helps when writing it to a database.
- Removed blank lines from the top and bottom of test results for readability.
Publish-Jojoba -JojobaCallbackallows use of$PSDefaultParameterValues(and other methods) to automatically send all test results to a function for storage.
- Initial Pester tests and AppVeyor integration.
- Host colouring of tests.
- Logo.
- VS Code workspace.
- Old
$Jojobaparameters should now be removed from the function header as they are picked up in another way. Functions now require a ValueFromPipeline parameter with a name or alias of InputObject, and ValueFromRemainingArguments parameter of any name. - Jojoba no longer outputs objects to the pipeline by default. It can be
made to occur with
-JojobaPassThru. Host output can be silenced with-JojobaQuiet. Write-JojobaAbortreplaced withWrite-JojobaFail -CriticalFailure. Also these critical failures now return normal test results, with$LASTEXITCODE = 1and an extra terminatingWrite-Errorat the end of the pipeline. Previously only aWrite-Errorwas returned and no results.
- Test output now populates as tests complete rather than after all tests have completed.
- Underlying RSJobs now have the same name as the InputObject parameter. This
makes it easier if you were to Ctrl-C to cancel a function which uses Jojoba
and has hung, and then use
Get-RSJobto see which jobs are stalled, and immediately determine what was the input that caused the hang.
Write-JojobaAbortfunction aborts a test case with a hard exception that is not rolled into a test case, it just exits raw. This is to indicate a serious problem with test processing.Write-JojobaPropertyfunction can add custom properties to the test case and takes a hashtable as input.
- Errors in
$JojobaCallbackcalls will change a test case result to Fail and add messages to the Data section.
- Fast load function for the module. It was causing problems with jobs and under high concurrency.
Publish-Jojobanow uses a progress bar, provided byWait-RSJob.- Fast load function for the module.
- Strings passed to caller functions can now contain ' marks.
- Jenkins BUILD_URL detection switched for JENKINS_SERVER_COOKIE as it is more reliable.
- Jenkins will now be auto-detected through the existence of the environment variable BUILD_URL. When this is found the Jojoba.xml will be generated. The existing switch still exists if you'd like to generate xml outside of Jenkins.
$JojobaBatchparameters MUST now be defined as:[string] $JojobaBatch = [System.Guid]::NewGuid().ToString()This is because there is a delay on ScriptProperty being evaluated when it is used as a parameter, and is breaking under high concurrency load.
- Test case Message section is now resistant to $null objects in the pipeline.
- Objects which are output as per normal inside your function will now be
converted with
Select-Object -Property *so that all bits are visible in the test case.
- Added missing dependency for the Disposable module.
Write-JojobaXmlnow takes a -PassThru switch to pass the input object onwards, but it probably shouldn't be used.
- If a
Write-JojobaCallbackfunction was defined this would be called with the test case after completion so it could be written to disk. Instead the name of the function to be called can be specified in a $JojobaCallback parameter on the function that uses Start-Jojoba. Whatever name is defined here will be called with one test case object at a time. - The
$JojobaBatchparameter on the caller should be a [string] instead of a [guid].
Write-JojobaDatahas been removed and its usage has been included inline toStart-Jojoba.
Write-JojobaXmlhas better error handling for empty sections.
Out-JojobaSpeechfunction.Start-Jojobacan be called from a function script as well as a module.
- The Suite of a test class will be the name of a script, if it's called from a script instead of from a module. If no Suite can be determined it will be set to "Jojoba" because the unit test format doesn't allow it to be blank.
Publish-Jojobasets $global:LASTEXITCODE instead of $LASTEXITCODE so that results propagate to the caller shell and Jenkins properly.
- Reduced ScriptAnalyzer warnings by removing common abbreviations.
- Function parameters of
-Parallelchanged to-JojobaThrottle. - Function parameters of
-Jenkinschanged to-JojobaJenkins.
Write-JojobaFailwrites the correct error message now.Start-RSJobnow imports the correct -Verbose flag from the caller.
Start-Jojobafunction is used in the process {} block of a function to execute one job per pipeline input.Publish-Jojobafunction is used in the end {} block of a function to wait for RSJobs to exit and collate their data.Write-JojobaDatafunction to set a test case data section (internally).Write-JojobaFailfunction to set a test case result to Fail.Write-JojobaSkipfunction to set a test case result to Skip.Write-JojobaXmlfunction used inside Publish-Jojoba to convert a test case to JUnit format XML for Jenkins.