Fix up all parameters

Author: etgottli

GitHubMilestones.ps1

@@ -29,7 +29,7 @@ function Get-GitHubMilestone
         How to sort the results, either due_on or completeness. Default: due_on
 
     .PARAMETER Direction
-        How to list the results, either asc or desc. Ignored without the sort parameter.
+        How to list the results, either asc or desc. Ignored without the sort parameter. Default: asc
 
     .PARAMETER State
         Only milestones with this state are returned, either open, closed, or all. Default: open
@@ -70,11 +70,11 @@ function Get-GitHubMilestone
         [Parameter(ParameterSetName='RepositoryUri')]
         [Parameter(ParameterSetName='RepositoryElements')]
         [ValidateSet('open', 'closed', 'all')]
-        [DateTime] $State,
+        [string] $State,
 
         [Parameter(ParameterSetName='RepositoryUri')]
         [Parameter(ParameterSetName='RepositoryElements')]
-        [ValidateSet('created', 'updated')]
+        [ValidateSet('due_on', 'completeness')]
         [string] $Sort,
 
         [Parameter(ParameterSetName='RepositoryUri')]
@@ -229,11 +229,6 @@ function New-GitHubMilestone
     $OwnerName = $elements.ownerName
     $RepositoryName = $elements.repositoryName
 
-    if ($null -ne $Due_On)
-    {
-        $DueOnFormattedTime = $Due_On.ToUniversalTime().ToString('o')
-    }
-
     $telemetryProperties = @{
         'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
         'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
@@ -246,17 +241,18 @@ function New-GitHubMilestone
 
     if ($PSBoundParameters.ContainsKey('State'))
     {
-        $hashBody += "state=$State"
+        $hashBody.add('state', $State)
     }
 
     if ($PSBoundParameters.ContainsKey('Description'))
     {
-        $hashBody += "description=$Description"
+        $hashBody.add('description', $Description)
     }
 
-    if ($PSBoundParameters.ContainsKey('Due_On'))
+    if ($PSBoundParameters.ContainsKey('Due_On') -and $null -ne $Due_On)
     {
-        $hashBody += "due_on=$DueOnFormattedTime"
+        $DueOnFormattedTime = $Due_On.ToUniversalTime().ToString('o')
+        $hashBody.add('due_on', $DueOnFormattedTime)
     }
 
     $params = @{
@@ -277,7 +273,7 @@ function Set-GitHubMilestone
 {
 <#
     .DESCRIPTION
-        Set an existing milestone for the given repository
+        Update an existing milestone for the given repository
 
         The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
 
@@ -370,11 +366,6 @@ function Set-GitHubMilestone
     $OwnerName = $elements.ownerName
     $RepositoryName = $elements.repositoryName
 
-    if ($null -ne $Due_On)
-    {
-        $DueOnFormattedTime = $Due_On.ToUniversalTime().ToString('o')
-    }
-
     $telemetryProperties = @{
         'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
         'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
@@ -388,17 +379,18 @@ function Set-GitHubMilestone
 
     if ($PSBoundParameters.ContainsKey('State'))
     {
-        $hashBody += "state=$State"
+        $hashBody.add('state', $State)
     }
 
     if ($PSBoundParameters.ContainsKey('Description'))
     {
-        $hashBody += "description=$Description"
+        $hashBody.add('description', $Description)
     }
 
-    if ($PSBoundParameters.ContainsKey('Due_On'))
+    if ($PSBoundParameters.ContainsKey('Due_On') -and $null -ne $Due_On)
     {
-        $hashBody += "due_on=$DueOnFormattedTime"
+        $DueOnFormattedTime = $Due_On.ToUniversalTime().ToString('o')
+        $hashBody.add('due_on', $DueOnFormattedTime)
     }
 
     $params = @{

Tests/GitHubMilestones.tests.ps1

@@ -82,6 +82,9 @@ try
         defaultMilestoneTitle1 = "This is a test milestone title #1."
         defaultMilestoneTitle2 = "This is a test milestone title #2."
         defaultEditedMilestoneTitle = "This is an edited milestone title."
+        defaultMilestoneDescription = "This is a test milestone description."
+        defaultEditedMilestoneDescription = "This is an edited milestone description."
+        defaultMilestoneDueOn = Get-Date -Date "2023-10-09T00:00:00"
     }.GetEnumerator() | ForEach-Object {
         Set-Variable -Force -Scope Script -Option ReadOnly -Visibility Private -Name $_.Key -Value $_.Value
     }
@@ -90,16 +93,24 @@ try
         $repo = New-GitHubRepository -RepositoryName ([Guid]::NewGuid().Guid) -AutoInit
 
         Context 'For creating a new milestone' {
-            $newMilestone = New-GitHubMilestone -Uri $repo.svn_url -Title $defaultMilestoneTitle1
+            $newMilestone = New-GitHubMilestone -Uri $repo.svn_url -Title $defaultMilestoneTitle1 -State "closed" -Due_On $defaultMilestoneDueOn
             $existingMilestone = Get-GitHubMilestone -Uri $repo.svn_url -MilestoneNumber $newMilestone.number
 
             It "Should have the expected title text" {
                 $existingMilestone.title | Should be $defaultMilestoneTitle1
             }
+
+            It "Should have the expected state" {
+                $existingMilestone.state | Should be "closed"
+            }
+
+            It "Should have the expected due_on date" {
+                Get-Date -Date $existingMilestone.due_on | Should be $defaultMilestoneDueOn
+            }
         }
 
         Context 'For getting milestones from a repo' {
-            $existingMilestones = @(Get-GitHubMilestone -Uri $repo.svn_url)
+            $existingMilestones = @(Get-GitHubMilestone -Uri $repo.svn_url -State "closed")
 
             It 'Should have the expected number of milestones' {
                 $existingMilestones.Count | Should be 1
@@ -111,20 +122,22 @@ try
         }
 
         Context 'For editing a milestone' {
-            $newMilestone = New-GitHubMilestone -Uri $repo.svn_url -Title $defaultMilestoneTitle2
-            $editedMilestone = Set-GitHubMilestone -Uri $repo.svn_url -MilestoneNumber $newMilestone.number -Title $defaultEditedMilestoneTitle
+            $newMilestone = New-GitHubMilestone -Uri $repo.svn_url -Title $defaultMilestoneTitle2 -Description $defaultMilestoneDescription
+            $editedMilestone = Set-GitHubMilestone -Uri $repo.svn_url -MilestoneNumber $newMilestone.number -Title $defaultEditedMilestoneTitle -Description $defaultEditedMilestoneDescription
 
-            It 'Should have a title that is not equal to the original title' {
+            It 'Should have a title/description that is not equal to the original title/description' {
                 $editedMilestone.title | Should not be $newMilestone.title
+                $editedMilestone.description | Should not be $newMilestone.description
             }
 
             It 'Should have the edited content' {
                 $editedMilestone.title | Should be $defaultEditedMilestoneTitle
+                $editedMilestone.description | Should be $defaultEditedMilestoneDescription
             }
         }
 
         Context 'For getting milestones from a repository and deleting them' {
-            $existingMilestones = @(Get-GitHubMilestone -Uri $repo.svn_url)
+            $existingMilestones = @(Get-GitHubMilestone -Uri $repo.svn_url -State "all" -Sort "completeness" -Direction "desc")
 
             It 'Should have the expected number of milestones' {
                 $existingMilestones.Count | Should be 2