fixes #84 & removes --quiet (#87)

- `Invoke-Git` - Set `$TimeOut` to Milliseconds (issue 84) - `git` commands no longer use `--quiet` to populate returned object.
dsccommunity · Jul 6, 2021 · 1420a68 · 1420a68
1 parent c75f492
commit 1420a68
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -48,12 +48,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Converted to public function.
   - Updated to use `System.Diagnostics.Process` for improved error handling.
   - Returns object, allowing caller to process result.
+  - `git` commands no longer use `--quiet` to populate returned object.
 
 ### Fixed
 
 - `Publish_GitHub_Wiki_Content`
   - Output message if `$GitHubToken` not specified which skips this task.
     Fixes [Issue 75](https://github.com/dsccommunity/DscResource.DocGenerator/issues/75)
+- `Invoke-Git`
+  - Set `$TimeOut` to Milliseconds
+    Fixes [Issue 84](https://github.com/dsccommunity/DscResource.DocGenerator/issues/84)
 
 ## [0.8.3] - 2021-04-10
 

diff --git a/source/Public/Invoke-Git.ps1 b/source/Public/Invoke-Git.ps1
@@ -9,7 +9,7 @@
         The path to the git working directory.
 
     .PARAMETER Timeout
-        Seconds to wait for process to exit.
+        Milliseconds to wait for process to exit.
 
     .PARAMETER Arguments
         The arguments to pass to the Git executable.
@@ -20,9 +20,9 @@
         Invokes the Git executable to clone the specified repository to the working directory.
 
     .EXAMPLE
-        Invoke-Git -WorkingDirectory 'C:\SomeDirectory' -Arguments @( 'status' ) -TimeOut 10
+        Invoke-Git -WorkingDirectory 'C:\SomeDirectory' -Arguments @( 'status' ) -TimeOut 10000
 
-        Invokes the Git executable to return the status while having a 10 second timeout.
+        Invokes the Git executable to return the status while having a 10000 millisecond timeout.
 #>
 
 function Invoke-Git
@@ -37,7 +37,7 @@ function Invoke-Git
 
         [Parameter(Mandatory = $false)]
         [System.Int32]
-        $TimeOut = 120,
+        $TimeOut = 120000,
 
         [Parameter(ValueFromRemainingArguments = $true)]
         [System.String[]]

diff --git a/source/Public/Publish-WikiContent.ps1 b/source/Public/Publish-WikiContent.ps1
@@ -116,7 +116,7 @@ function Publish-WikiContent
         Write-Verbose -Message ($script:localizedData.CloneWikiGitRepoMessage -f $WikiRepoName)
 
         $gitCloneResult = Invoke-Git -WorkingDirectory $tempPath.FullName `
-                            -Arguments @( 'clone', $wikiRepoName, $tempPath, '--quiet' )
+                            -Arguments @( 'clone', $wikiRepoName, $tempPath )
 
         if ($gitCloneResult.ExitCode -eq 0)
         {
@@ -152,7 +152,7 @@ function Publish-WikiContent
             Write-Verbose -Message ($localizedData.CommitAndTagRepoChangesMessage -f $ModuleVersion)
 
             $gitCommitResult = Invoke-Git -WorkingDirectory $tempPath.FullName `
-                                    -Arguments @( 'commit', '--message', "`"$($localizedData.UpdateWikiCommitMessage -f $ModuleVersion)`"", '--quiet' )
+                                    -Arguments @( 'commit', '--message', "`"$($localizedData.UpdateWikiCommitMessage -f $ModuleVersion)`"" )
 
             if ($gitCommitResult.ExitCode -eq 0)
             {
@@ -162,10 +162,10 @@ function Publish-WikiContent
                 Write-Verbose -Message $localizedData.PushUpdatedRepoMessage
 
                 $null = Invoke-Git -WorkingDirectory $tempPath.FullName `
-                            -Arguments @( 'push', 'origin', '--quiet' )
+                            -Arguments @( 'push', 'origin' )
 
                 $null = Invoke-Git -WorkingDirectory $tempPath.FullName `
-                            -Arguments @( 'push', 'origin', $ModuleVersion, '--quiet' )
+                            -Arguments @( 'push', 'origin', $ModuleVersion )
 
                 Write-Verbose -Message $localizedData.PublishWikiContentCompleteMessage
             }

diff --git a/tests/unit/public/Publish-WikiContent.Tests.ps1 b/tests/unit/public/Publish-WikiContent.Tests.ps1
@@ -109,8 +109,7 @@ InModuleScope $script:moduleName {
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'commit' -and
                     $Arguments[1] -eq '--message' -and
-                    $Arguments[2] -eq "`"$($localizedData.UpdateWikiCommitMessage -f $mockPublishWikiContentParameters.ModuleVersion)`"" -and
-                    $Arguments[3] -eq '--quiet'
+                    $Arguments[2] -eq "`"$($localizedData.UpdateWikiCommitMessage -f $mockPublishWikiContentParameters.ModuleVersion)`""
                 } -Exactly -Times 0 -Scope It
 
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
@@ -123,15 +122,13 @@ InModuleScope $script:moduleName {
 
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'push' -and
-                    $Arguments[1] -eq 'origin' -and
-                    $Arguments[2] -eq '--quiet'
+                    $Arguments[1] -eq 'origin'
                 } -Exactly -Times 0 -Scope It
 
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'push' -and
                     $Arguments[1] -eq 'origin' -and
-                    $Arguments[2] -eq $mockPublishWikiContentParameters.ModuleVersion -and
-                    $Arguments[3] -eq '--quiet'
+                    $Arguments[2] -eq $mockPublishWikiContentParameters.ModuleVersion
                 } -Exactly -Times 0 -Scope It
 
                 Assert-MockCalled -CommandName Remove-Item -Exactly -Times 1 -Scope It
@@ -216,8 +213,7 @@ InModuleScope $script:moduleName {
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'commit' -and
                     $Arguments[1] -eq '--message' -and
-                    $Arguments[2] -eq "`"$($localizedData.UpdateWikiCommitMessage -f $mockPublishWikiContentParameters.ModuleVersion)`"" -and
-                    $Arguments[3] -eq '--quiet'
+                    $Arguments[2] -eq "`"$($localizedData.UpdateWikiCommitMessage -f $mockPublishWikiContentParameters.ModuleVersion)`""
                 } -Exactly -Times 1 -Scope It
 
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
@@ -231,14 +227,13 @@ InModuleScope $script:moduleName {
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'push' -and
                     $Arguments[1] -eq 'origin' -and
-                    $Arguments[2] -eq '--quiet'
+                    $Arguments[2] -eq $null
                 } -Exactly -Times 1 -Scope It
 
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'push' -and
                     $Arguments[1] -eq 'origin' -and
-                    $Arguments[2] -eq $mockPublishWikiContentParameters.ModuleVersion -and
-                    $Arguments[3] -eq '--quiet'
+                    $Arguments[2] -eq $mockPublishWikiContentParameters.ModuleVersion
                 } -Exactly -Times 1 -Scope It
 
                 Assert-MockCalled -CommandName Remove-Item -Exactly -Times 1 -Scope It
@@ -270,8 +265,7 @@ InModuleScope $script:moduleName {
                 } -ParameterFilter {
                         $Arguments[0] -eq 'commit' -and
                         $Arguments[1] -eq '--message' -and
-                        $Arguments[2] -eq "`"$($localizedData.UpdateWikiCommitMessage -f $ModuleVersion)`"" -and
-                        $Arguments[3] -eq '--quiet'
+                        $Arguments[2] -eq "`"$($localizedData.UpdateWikiCommitMessage -f $ModuleVersion)`""
                     }
             }
 
@@ -337,8 +331,7 @@ InModuleScope $script:moduleName {
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'commit' -and
                     $Arguments[1] -eq '--message' -and
-                    $Arguments[2] -eq "`"$($localizedData.UpdateWikiCommitMessage -f $mockPublishWikiContentParameters.ModuleVersion)`"" -and
-                    $Arguments[3] -eq '--quiet'
+                    $Arguments[2] -eq "`"$($localizedData.UpdateWikiCommitMessage -f $mockPublishWikiContentParameters.ModuleVersion)`""
                 } -Exactly -Times 1 -Scope It
 
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
@@ -351,15 +344,13 @@ InModuleScope $script:moduleName {
 
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'push' -and
-                    $Arguments[1] -eq 'origin' -and
-                    $Arguments[2] -eq '--quiet'
+                    $Arguments[1] -eq 'origin'
                 } -Exactly -Times 0 -Scope It
 
                 Assert-MockCalled -CommandName Invoke-Git -ParameterFilter {
                     $Arguments[0] -eq 'push' -and
                     $Arguments[1] -eq 'origin' -and
-                    $Arguments[2] -eq $mockPublishWikiContentParameters.ModuleVersion -and
-                    $Arguments[3] -eq '--quiet'
+                    $Arguments[2] -eq $mockPublishWikiContentParameters.ModuleVersion
                 } -Exactly -Times 0 -Scope It
 
                 Assert-MockCalled -CommandName Remove-Item -Exactly -Times 1 -Scope It