Merge pull request #370 from rkeithhill/rkeithhill/is291-fix-bare-repo

rkeithhill · web-flow · commit 87e68322f733 · 2017-01-25T19:53:24.000-07:00
Fix Get-GitDirectory to work in bare repo.
diff --git a/GitUtils.ps1 b/GitUtils.ps1
@@ -1,12 +1,53 @@
 # Inspired by Mark Embling
 # http://www.markembling.info/view/my-ideal-powershell-prompt-with-git-integration
 
+<#
+.SYNOPSIS
+    Gets the path to the current repository's .git dir.
+.DESCRIPTION
+    Gets the path to the current repository's .git dir.  Or if the repository
+    is a bare repository, the root directory of the bare repository.
+.EXAMPLE
+    PS C:\GitHub\posh-git\tests> Get-GitDirectory
+    Returns C:\GitHub\posh-git\.git
+.INPUTS
+    None.
+.OUTPUTS
+    System.String
+#>
 function Get-GitDirectory {
-    if ($Env:GIT_DIR) {
-        $Env:GIT_DIR
+    $pathInfo = Microsoft.PowerShell.Management\Get-Location
+    if (!$pathInfo -or ($pathInfo.Provider.Name -ne 'FileSystem')) {
+        $null
+    }
+    elseif ($Env:GIT_DIR) {
+        $Env:GIT_DIR -replace '\\|/', [System.IO.Path]::DirectorySeparatorChar
     }
     else {
-        Get-LocalOrParentPath .git
+        $currentDir = Get-Item $pathInfo -Force
+        while ($currentDir) {
+            $gitDirPath = Join-Path $currentDir.FullName .git
+            if (Test-Path -LiteralPath $gitDirPath -PathType Container) {
+                return $gitDirPath
+            }
+
+            $headPath = Join-Path $currentDir.FullName HEAD
+            if (Test-Path -LiteralPath $headPath -PathType Leaf) {
+                $refsPath = Join-Path $currentDir.FullName refs
+                $objsPath = Join-Path $currentDir.FullName objects
+                if ((Test-Path -LiteralPath $refsPath -PathType Container) -and
+                    (Test-Path -LiteralPath $objsPath -PathType Container)) {
+
+                    $bareDir = Invoke-Utf8ConsoleCommand { git rev-parse --git-dir 2>$null }
+                    if ($bareDir -and (Test-Path -LiteralPath $bareDir -PathType Container)) {
+                        $resolvedBareDir = (Resolve-Path $bareDir).Path
+                        return $resolvedBareDir
+                    }
+                }
+            }
+
+            $currentDir = $currentDir.Parent
+        }
     }
 }
 
@@ -147,7 +188,7 @@ function Get-GitStatus($gitDir = (Get-GitDirectory)) {
         $filesUnmerged = New-Object System.Collections.Generic.List[string]
         $stashCount = 0
 
-        if($settings.EnableFileStatus -and !$(InDisabledRepository)) {
+        if($settings.EnableFileStatus -and !$(InDotGitOrBareRepoDir $gitDir) -and !$(InDisabledRepository)) {
             if ($settings.EnableFileStatusFromCache -eq $null) {
                 $settings.EnableFileStatusFromCache = (Get-Module GitStatusCachePoshClient) -ne $null
             }
@@ -290,6 +331,17 @@ function InDisabledRepository {
     return $false
 }
 
+function InDotGitOrBareRepoDir([string][ValidateNotNullOrEmpty()]$GitDir) {
+    # A UNC path has no drive so it's better to use the ProviderPath e.g. "\\server\share".
+    # However for any path with a drive defined, it's better to use the Path property.
+    # In this case, ProviderPath is "\LocalMachine\My"" whereas Path is "Cert:\LocalMachine\My".
+    # The latter is more desirable.
+    $pathInfo = Microsoft.PowerShell.Management\Get-Location
+    $currentPath = if ($pathInfo.Drive) { $pathInfo.Path } else { $pathInfo.ProviderPath }
+    $res = $currentPath.StartsWith($GitDir, (Get-PathStringComparison))
+    $res
+}
+
 function Enable-GitColors {
     Write-Warning 'Enable-GitColors is Obsolete and will be removed in a future version of posh-git.'
 }
diff --git a/Utils.ps1 b/Utils.ps1
@@ -1,6 +1,12 @@
 # Need this variable as long as we support PS v2
 $ModuleBasePath = Split-Path $MyInvocation.MyCommand.Path -Parent
 
+# Store error records generated by stderr output when invoking an executable
+# This can be accessed from the user's session by executing:
+# PS> $m = Get-Module posh-git
+# PS> & $m Get-Variable invokeErrors -ValueOnly
+$invokeErrors = New-Object System.Collections.ArrayList 256
+
 # General Utility Functions
 
 function Invoke-NullCoalescing {
@@ -21,12 +27,26 @@ Set-Alias ?? Invoke-NullCoalescing -Force
 
 function Invoke-Utf8ConsoleCommand([ScriptBlock]$cmd) {
     $currentEncoding = [Console]::OutputEncoding
+    $errorCount = $global:Error.Count
     try {
+        # A native executable that writes to stderr AND has its stderr redirected will generate non-terminating
+        # error records if the user has set $ErrorActionPreference to Stop. Override that value in this scope.
+        $ErrorActionPreference = 'Continue'
         [Console]::OutputEncoding = [Text.Encoding]::UTF8
         & $cmd
     }
     finally {
         [Console]::OutputEncoding = $currentEncoding
+
+        # Clear out stderr output that was added to the $Error collection, putting those errors in a module variable
+        if ($global:Error.Count -gt $errorCount) {
+            $numNewErrors = $global:Error.Count - $errorCount
+            $invokeErrors.InsertRange(0, $global:Error.GetRange(0, $numNewErrors))
+            if ($invokeErrors.Count -gt 256) {
+                $invokeErrors.RemoveRange(256, ($invokeErrors.Count - 256))
+            }
+            $global:Error.RemoveRange(0, $numNewErrors)
+        }
     }
 }
 
@@ -163,23 +183,6 @@ function Get-PathStringComparison {
     }
 }
 
-function Get-LocalOrParentPath($path) {
-    $checkIn = Get-Item -Force .
-    if ($checkIn.PSProvider.Name -ne 'FileSystem') {
-        return $null
-    }
-    while ($null -ne $checkIn) {
-        $pathToTest = [System.IO.Path]::Combine($checkIn.fullname, $path)
-        if (Test-Path -LiteralPath $pathToTest) {
-            return $pathToTest
-        }
-        else {
-            $checkIn = $checkIn.parent
-        }
-    }
-    return $null
-}
-
 function Get-PSModulePath {
     $modulePaths = $Env:PSModulePath -split ';'
     $modulePaths
diff --git a/posh-git.psd1 b/posh-git.psd1
@@ -28,6 +28,7 @@ FunctionsToExport = @(
     'Write-GitStatus',
     'Write-Prompt',
     'Write-VcsStatus',
+    'Get-GitBranch',
     'Get-GitStatus',
     'Enable-GitColors',
     'Get-GitDirectory',
diff --git a/posh-git.psm1 b/posh-git.psm1
@@ -125,6 +125,7 @@ $exportModuleMemberParams = @{
         'Write-GitStatus',
         'Write-Prompt',
         'Write-VcsStatus',
+        'Get-GitBranch',
         'Get-GitStatus',
         'Enable-GitColors',
         'Get-GitDirectory',
diff --git a/test/Get-GitBranch.Tests.ps1 b/test/Get-GitBranch.Tests.ps1
@@ -0,0 +1,16 @@
+. $PSScriptRoot\Shared.ps1
+
+Describe 'Get-GitBranch Tests' {
+    Context 'Get-GitBranch GIT_DIR Tests' {
+        It 'Returns GIT_DIR! when in .git dir of the repo' {
+            $repoRoot = (Resolve-Path $PSScriptRoot\..).Path
+            Set-Location $repoRoot\.git -ErrorAction Stop
+            Get-GitBranch | Should BeExactly 'GIT_DIR!'
+        }
+        It 'Returns correct path when in a child folder of the .git dir of the repo' {
+            $repoRoot = (Resolve-Path $PSScriptRoot\..).Path
+            Set-Location $repoRoot\.git\hooks -ErrorAction Stop
+            Get-GitBranch | Should BeExactly 'GIT_DIR!'
+        }
+    }
+}
diff --git a/test/Get-GitDirectory.Tests.ps1 b/test/Get-GitDirectory.Tests.ps1
@@ -0,0 +1,69 @@
+. $PSScriptRoot\Shared.ps1
+
+Describe 'Get-GitDiretory Tests' {
+    Context "Test normal repository" {
+        BeforeAll {
+            $origPath = Get-Location
+        }
+        AfterAll {
+            Set-Location $origPath
+        }
+
+        It 'Returns $null for not a Git repo' {
+            Set-Location $env:windir
+            Get-GitDirectory | Should BeNullOrEmpty
+        }
+        It 'Returns $null for not a filesystem path' {
+            Set-Location Cert:\CurrentUser
+            Get-GitDirectory | Should BeNullOrEmpty
+        }
+        It 'Returns correct path when in the root of repo' {
+            $repoRoot = (Resolve-Path $PSScriptRoot\..).Path
+            Set-Location $repoRoot
+            Get-GitDirectory | Should BeExactly (MakeNativePath $repoRoot\.git)
+        }
+        It 'Returns correct path when under a child folder of the root of repo' {
+            $repoRoot = (Resolve-Path $PSScriptRoot\..).Path
+            Set-Location $PSScriptRoot
+            Get-GitDirectory | Should BeExactly (Join-Path $repoRoot .git)
+        }
+    }
+
+    Context "Test bare repository" {
+        BeforeAll {
+            $origPath = Get-Location
+            $temp = [System.IO.Path]::GetTempPath()
+            $bareRepoName = "test.git"
+            $bareRepoPath = Join-Path $temp $bareRepoName
+            if (Test-Path $bareRepoPath) {
+                Remove-Item $bareRepoPath -Recurse -Force
+            }
+            git init --bare $bareRepoPath
+        }
+        AfterAll {
+            Set-Location $origPath
+            if (Test-Path $bareRepoPath) {
+                Remove-Item $bareRepoPath -Recurse -Force
+            }
+        }
+
+        It 'Returns correct path when in the root of bare repo' {
+            Set-Location $bareRepoPath
+            Get-GitDirectory | Should BeExactly (MakeNativePath $bareRepoPath)
+        }
+        It 'Returns correct path when under a child folder of the root of bare repo' {
+            Set-Location $bareRepoPath\hooks -ErrorVariable Stop
+            MakeNativePath (Get-GitDirectory) | Should BeExactly $bareRepoPath
+        }
+    }
+
+    Context "Test GIT_DIR environment variable" {
+        AfterAll {
+            Remove-Item Env:\GIT_DIR -ErrorAction SilentlyContinue
+        }
+        It 'Returns the value in GIT_DIR env var' {
+            $env:GIT_DIR = 'C:\xyzzy\posh-git\.git'
+            Get-GitDirectory | Should BeExactly $env:GIT_DIR
+        }
+    }
+}
diff --git a/test/Get-GitStatus.Tests.ps1 b/test/Get-GitStatus.Tests.ps1
