Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add new tests to the module #142

Merged
merged 22 commits into from Jun 24, 2017
Merged

Add new tests to the module #142

merged 22 commits into from Jun 24, 2017

Conversation

lipkau
Copy link
Member

@lipkau lipkau commented Jun 23, 2017 •
edited

Description

This branch add tests for:

  • every function must have at least as many examples as it has ParameterSetNames
  • ensures PSJira objects have a custom .ToString() method (common mistake)
  • Use PSScriptAnalyzer to test the code for common practices. The rules with most impact were:
    • $null must be on the lest side when using it in a comparison rule
    • unused variables should be removed rule
    • state changing functions should support ShouldProcess rule

To satisfy these new Tests, this PR also:

  • implements .ToString() to PSJira objects that were missing them
  • removes unused variables
  • enhances the examples in the help of functions
  • added SupportsShouldProcess to state modifying function
  • renamed ConvertTo-Json2 internal functions

Motivation and Context

Enforce a better and more uniform coding style
closes #95

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • I have added Pester Tests that describe what my changes should do.
  • I have updated the documentation accordingly. still to come

lipkau added 21 commits May 22, 2017 16:45
@lipkau
[added] Tests to ensure the cmdlets have a basic help
dff63fb
@lipkau
[fix] updated cmdlet's help
6746cb3 
- still has 17 fails
@lipkau
[fix] updated the code formatting I screwed up in my last commit
b1270b7
@lipkau
Merge branch 'dev' into feature/CmdletTests
ecbd294 
# Conflicts:
#	PSJira/Public/Invoke-JiraIssueTransition.ps1
#	PSJira/Public/New-JiraIssue.ps1
#	PSJira/Public/Set-JiraIssue.ps1
@lipkau
Load each function by itself into the runtime
a41ec30 
recent changes to the dev branch export all functions, including the private ones.
In order to exclude them from these test, the module is unloaded and all functions are dot-sourced into the runtime.
@lipkau
Update Help from functions
89dc69f 
* add missing help blocks
* add examples for every ParameterSet
@lipkau
Added PSScriptAnalyzer to Unit Tests
1f61a71
@lipkau
Rename unapproved verbs
4087d49
@lipkau
Fix $null comparison
72a6164
@lipkau
Remove unused variables
0a2b6d9
@lipkau
Declare SupportsShouldProcess
df031a1
@lipkau
Exclude "PSUseToExportFieldsInManifest" rule for dev branch
bce9c8e
@lipkau
Remove unused valiables
80d9c20
@lipkau
Fix $null comparison
675e77e
@lipkau
Update Unit Test to use common resources
a848395
@lipkau
Add common resources for Unit Tests
c22dc4e
@lipkau
Improve testing for response with errors
0c74d32
@lipkau
Merge remote-tracking branch 'upstream/dev' into feature/CmdletTests
9c61c04 
# Conflicts:
#	PSJira/Public/New-JiraSession.ps1
@lipkau
Add method ToString() to objects
ee91ccf
@lipkau
Add support for ShouldProcess
24ebea6
@lipkau
Remove unused variable
95a8a1b
@lipkau lipkau added this to the v1.3 milestone Jun 23, 2017
@lipkau lipkau self-assigned this Jun 23, 2017
@lipkau lipkau requested review from replicaJunction and Dejulia489 and removed request for replicaJunction June 23, 2017 08:05
@lipkau
Copy link
Member Author

lipkau commented Jun 24, 2017

Merging branch before any review was done.
Please comment here (or open a new issue) for changes/bugs/requests.

@lipkau lipkau merged commit bda7a17 into AtlassianPS:dev Jun 24, 2017
@lipkau lipkau deleted the feature/CmdletTests branch June 24, 2017 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Dejulia489 Dejulia489 Awaiting requested review from Dejulia489

@replicaJunction replicaJunction Awaiting requested review from replicaJunction

Assignees

@lipkau lipkau

Labels
Area:Module Issue:Enhancement Resolution:Fixed
Projects
None yet
Milestone
v2.1
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@lipkau