My First Open Source Contribution - Part 2
Picking up right where I left off yesterday Crap again I’ve not done any testing, I have come too far now not to keep going. I took a look at their guide for writing tests. Come on seriously?
Ok, well I will just have to figure it out, ah of course there is a Tests folder, and it contains New-JiraIssue.tests.ps1 and it is Pester, of course it is! Sweet I can do this.
The test looks well written, clear mocking of all the external function calls, phew that could have stopped me in my tracks because I really haven’t looked at the code in this function. I have only been working with the parameters so far. I see there is one behaviour test written already, so I’ll probably start here.
Context "Behavior testing" {
It "Creates an issue in JIRA" {
{ New-JiraIssue @newParams } | Should Not Throw
# The String in the ParameterFilter is made from the keywords
# we should expect to see in the JSON that should be sent,
# including the summary provided in the test call above.
Assert-MockCalled -CommandName Invoke-JiraMethod -ModuleName JiraPS -Times 1 -Scope It -ParameterFilter { $Method -eq 'Post' -and $URI -like "$jiraServer/rest/api/*/issue" }
}
}
Above is the test for how the function currently works and what I’ve changed adds a new way to feed the function from the pipeline. I wrote the following test reusing the already working code for mocking and the parameters etc.
It "Creates an issue in JIRA from pipeline" {
{ $pipelineParams | New-JiraIssue } | Should Not Throw
# The String in the ParameterFilter is made from the keywords
# we should expect to see in the JSON that should be sent,
# including the summary provided in the test call above.
Assert-MockCalled -CommandName Invoke-JiraMethod -ModuleName JiraPS -Times 1 -Scope It -ParameterFilter { $Method -eq 'Post' -and $URI -like "$jiraServer/rest/api/*/issue" }
}
Time to run the tests and see what happens.
This is awesome, that’s my test passing – tick.
Next up documentation, do I need to write documentation? I guess I do, and there is Docs folder and there is already a New-JiraIssue.md helpfile, this is actually easier than I expected – the benefit of contributing to an existing project is that a lot of the work has already been done or there would be nothing to contribute to. I found the bit in the help file with the examples and copy paste changed to cover the new use case, my new functionality that I added to this project #satifaction. Documentation – tick.
Right it is getting late now and the end is in sight, I create the PR, this PR. That’s me done, I leave it to the JiraPS team to review and I’ll see what happens. I get an email a couple of hours later suggesting a couple of minor changes which I put through and my fix was merged into the Development branch.
I’ll definitely continue to contribute to opensource projects, I’ve been bitten by the bug. The JiraPS project will be a good place to start – I’ve already learned a bit from looking at the well written code of the module. It validated the approach we’ve taken in work on our own module, the pester-tests, the documentation, heck even the naming conventions.
Thanks for reading. Conor
Opensource