This repository has been archived by the owner on Nov 22, 2022. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 163
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #332 from profclems/fix-lookpath
Ensure only $PATH is searched when switching to external commands
- Loading branch information
Showing
14 changed files
with
276 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// +build !windows | ||
|
||
package execext | ||
|
||
import "os/exec" | ||
|
||
// LookPath searches for an executable named file in the directories named by | ||
// the PATH environment variable. | ||
// If file contains a slash, it is tried directly and the PATH is not consulted. | ||
// The result may be an absolute path or a path relative to the current directory. | ||
func LookPath(file string) (string, error) { | ||
return exec.LookPath(file) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
package execext | ||
|
||
import ( | ||
"errors" | ||
"os" | ||
"os/exec" | ||
"path/filepath" | ||
"runtime" | ||
"strings" | ||
"testing" | ||
) | ||
|
||
func winExecutable(s string) string { | ||
if runtime.GOOS == "windows" { | ||
return s | ||
} | ||
return "" | ||
} | ||
|
||
func TestLookPath(t *testing.T) { | ||
root, wderr := os.Getwd() | ||
if wderr != nil { | ||
t.Fatal(wderr) | ||
} | ||
defaultPath := os.Getenv("PATH") | ||
paths := []string{ | ||
filepath.Join(root, "testdata", "nonexist"), | ||
filepath.Join(root, "testdata", "PATH"), | ||
} | ||
os.Setenv("PATH", strings.Join(paths, string(filepath.ListSeparator))) | ||
|
||
if err := os.Chdir(filepath.Join(root, "testdata", "cwd")); err != nil { | ||
t.Fatal(err) | ||
} | ||
|
||
testCases := []struct { | ||
desc string | ||
pathext string | ||
arg string | ||
wants string | ||
wantErr bool | ||
}{ | ||
{ | ||
desc: "has extension", | ||
pathext: "", | ||
arg: "git.exe", | ||
wants: filepath.Join(root, "testdata", "PATH", "git.exe"), | ||
wantErr: false, | ||
}, | ||
{ | ||
desc: "has path", | ||
pathext: "", | ||
arg: filepath.Join("..", "PATH", "git"), | ||
wants: filepath.Join("..", "PATH", "git"+winExecutable(".exe")), | ||
wantErr: false, | ||
}, | ||
{ | ||
desc: "no extension", | ||
pathext: "", | ||
arg: "git", | ||
wants: filepath.Join(root, "testdata", "PATH", "git"+winExecutable(".exe")), | ||
wantErr: false, | ||
}, | ||
{ | ||
desc: "has path+extension", | ||
pathext: "", | ||
arg: filepath.Join("..", "PATH", "git.bat"), | ||
wants: filepath.Join("..", "PATH", "git.bat"), | ||
wantErr: false, | ||
}, | ||
{ | ||
desc: "no extension, PATHEXT", | ||
pathext: ".com;.bat", | ||
arg: "git", | ||
wants: filepath.Join(root, "testdata", "PATH", "git"+winExecutable(".bat")), | ||
wantErr: false, | ||
}, | ||
{ | ||
desc: "has extension, PATHEXT", | ||
pathext: ".com;.bat", | ||
arg: "git.exe", | ||
wants: filepath.Join(root, "testdata", "PATH", "git.exe"), | ||
wantErr: false, | ||
}, | ||
{ | ||
desc: "no extension, not found", | ||
pathext: "", | ||
arg: "ls", | ||
wants: "", | ||
wantErr: true, | ||
}, | ||
{ | ||
desc: "has extension, not found", | ||
pathext: "", | ||
arg: "ls.exe", | ||
wants: "", | ||
wantErr: true, | ||
}, | ||
{ | ||
desc: "no extension, PATHEXT, not found", | ||
pathext: ".com;.bat", | ||
arg: "ls", | ||
wants: "", | ||
wantErr: true, | ||
}, | ||
{ | ||
desc: "has extension, PATHEXT, not found", | ||
pathext: ".com;.bat", | ||
arg: "ls.exe", | ||
wants: "", | ||
wantErr: true, | ||
}, | ||
} | ||
for _, tC := range testCases { | ||
t.Run(tC.desc, func(t *testing.T) { | ||
os.Setenv("PATHEXT", tC.pathext) | ||
got, err := LookPath(tC.arg) | ||
|
||
if tC.wantErr != (err != nil) { | ||
t.Errorf("expects error: %v, got: %v", tC.wantErr, err) | ||
} | ||
if err != nil && !errors.Is(err, exec.ErrNotFound) { | ||
t.Errorf("expected exec.ErrNotFound; got %#v", err) | ||
} | ||
if got != tC.wants { | ||
t.Errorf("expected result %q, got %q", tC.wants, got) | ||
} | ||
}) | ||
} | ||
_ = os.Setenv("PATH", defaultPath) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
// Copyright (c) 2009 The Go Authors. All rights reserved. | ||
// | ||
// Redistribution and use in source and binary forms, with or without | ||
// modification, are permitted provided that the following conditions are | ||
// met: | ||
// | ||
// * Redistributions of source code must retain the above copyright | ||
// notice, this list of conditions and the following disclaimer. | ||
// * Redistributions in binary form must reproduce the above | ||
// copyright notice, this list of conditions and the following disclaimer | ||
// in the documentation and/or other materials provided with the | ||
// distribution. | ||
// * Neither the name of Google Inc. nor the names of its | ||
// contributors may be used to endorse or promote products derived from | ||
// this software without specific prior written permission. | ||
// | ||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
||
// EXTENDED: | ||
// This package provides an alternative LookPath function to avoid accidentally | ||
// executing matching binaries in the current directory on windows | ||
package execext | ||
|
||
import ( | ||
"os" | ||
"os/exec" | ||
"path/filepath" | ||
"strings" | ||
) | ||
|
||
func chkStat(file string) error { | ||
d, err := os.Stat(file) | ||
if err != nil { | ||
return err | ||
} | ||
if d.IsDir() { | ||
return os.ErrPermission | ||
} | ||
return nil | ||
} | ||
|
||
func hasExt(file string) bool { | ||
i := strings.LastIndex(file, ".") | ||
if i < 0 { | ||
return false | ||
} | ||
return strings.LastIndexAny(file, `:\/`) < i | ||
} | ||
|
||
func findExecutable(file string, exts []string) (string, error) { | ||
if len(exts) == 0 { | ||
return file, chkStat(file) | ||
} | ||
if hasExt(file) { | ||
if chkStat(file) == nil { | ||
return file, nil | ||
} | ||
} | ||
for _, e := range exts { | ||
if f := file + e; chkStat(f) == nil { | ||
return f, nil | ||
} | ||
} | ||
return "", os.ErrNotExist | ||
} | ||
|
||
// LookPath searches for an executable named file in the | ||
// directories named by the PATH environment variable. | ||
// If file contains a slash, it is tried directly and the PATH is not consulted. | ||
// LookPath also uses PATHEXT environment variable to match | ||
// a suitable candidate. | ||
// The result may be an absolute path or a path relative to the current directory. | ||
func LookPath(file string) (string, error) { | ||
var exts []string | ||
x := os.Getenv(`PATHEXT`) | ||
if x != "" { | ||
for _, e := range strings.Split(strings.ToLower(x), `;`) { | ||
if e == "" { | ||
continue | ||
} | ||
if e[0] != '.' { | ||
e = "." + e | ||
} | ||
exts = append(exts, e) | ||
} | ||
} else { | ||
exts = []string{".com", ".exe", ".bat", ".cmd"} | ||
} | ||
|
||
if strings.ContainsAny(file, `:\/`) { | ||
if f, err := findExecutable(file, exts); err == nil { | ||
return f, nil | ||
} else { | ||
return "", &exec.Error{file, err} | ||
} | ||
} | ||
// EXTENDED: this is the only part removed to avoid searching for executables in the | ||
// current directory | ||
// Check https://github.com/golang/go/issues/38736 | ||
// if f, err := findExecutable(filepath.Join(".", file), exts); err == nil { | ||
// return f, nil | ||
// } | ||
path := os.Getenv("path") | ||
for _, dir := range filepath.SplitList(path) { | ||
if f, err := findExecutable(filepath.Join(dir, file), exts); err == nil { | ||
return f, nil | ||
} | ||
} | ||
return "", &exec.Error{file, exec.ErrNotFound} | ||
} |
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.