Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ require (
github.com/charmbracelet/glamour v0.10.0
github.com/charmbracelet/lipgloss v1.1.1-0.20250404203927-76690c660834
github.com/cli/cli/v2 v2.93.0
github.com/cli/go-gh/v2 v2.16.1
github.com/cli/go-gh/v2 v2.16.2
github.com/cli/shurcooL-graphql v0.0.4
github.com/muesli/termenv v0.16.0
github.com/spf13/cobra v1.10.2
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ github.com/cli/browser v1.3.0 h1:LejqCrpWr+1pRqmEPDGnTZOjsMe7sehifLynZJuqJpo=
github.com/cli/browser v1.3.0/go.mod h1:HH8s+fOAxjhQoBUAsKuPCbqUuxZDhQ2/aD+SzsEfBTk=
github.com/cli/cli/v2 v2.93.0 h1:B2ZvEAbFaATbeH+vjZdXBL0wxCk0sedaprvrKGh/VZo=
github.com/cli/cli/v2 v2.93.0/go.mod h1:I9qEbkL3Zq1j8soXKh7yjJasP2HdpwzI531bjJXoXBI=
github.com/cli/go-gh/v2 v2.16.1 h1:t8s29LToBmYjXeDXUnK7Wdm7NkYSyzGZK3t4Doa6GX0=
github.com/cli/go-gh/v2 v2.16.1/go.mod h1:OaJTFtHJapQq670h/3L0vqm4NwZGoJmSAVctWiY+3pQ=
github.com/cli/go-gh/v2 v2.16.2 h1:Qsb8GsS4QQWjupxcMutrj5tl2cJs6HubyDM0xQ4qsII=
github.com/cli/go-gh/v2 v2.16.2/go.mod h1:OaJTFtHJapQq670h/3L0vqm4NwZGoJmSAVctWiY+3pQ=
github.com/cli/safeexec v1.0.1 h1:e/C79PbXF4yYTN/wauC4tviMxEV13BwljGj0N9j+N00=
github.com/cli/safeexec v1.0.1/go.mod h1:Z/D4tTN8Vs5gXYHDCbaM1S/anmEDnJb1iW0+EJ5zx3Q=
github.com/cli/shurcooL-graphql v0.0.4 h1:6MogPnQJLjKkaXPyGqPRXOI2qCsQdqNfUY1QSJu2GuY=
Expand Down
117 changes: 117 additions & 0 deletions internal/config/repo_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
package config
Comment thread
williammartin marked this conversation as resolved.

import (
"encoding/json"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"runtime"
"strings"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestMain(m *testing.M) {
runFakeSSHIfRequested()
os.Exit(m.Run())
}

func TestRepoResolvesRemoteUsingSSHHostAlias(t *testing.T) {
// Given ssh maps github.com-work to github.com
stubSSH(t, map[string]string{"github.com-work": "github.com"})
// And github.com is a known host
t.Setenv("GH_CONFIG_DIR", t.TempDir())
t.Setenv("GH_HOST", "github.com")
t.Setenv("GH_REPO", "")
// And origin uses the alias
dir := t.TempDir()
runGit(t, dir, "init", "-q")
runGit(t, dir, "remote", "add", "origin", "git@github.com-work:org/repo.git")
t.Chdir(dir)

// When the repository is resolved
config := &Config{}
repo, err := config.Repo()

// Then it is the GitHub repository behind the alias
require.NoError(t, err)
assert.Equal(t, "github.com", repo.Host)
assert.Equal(t, "org", repo.Owner)
assert.Equal(t, "repo", repo.Name)
}

func runGit(t *testing.T, dir string, args ...string) {
t.Helper()
out, err := exec.Command("git", append([]string{"-C", dir}, args...)...).CombinedOutput()
require.NoError(t, err, "git %v: %s", args, out)
}

// The fake ssh below is adapted from github.com/cli/go-gh/v2 internal/testutils/ssh_stub.go
// Maybe go-gh can export a similar ssh stub for testing purposes, but for now we include our own.

const fakeSSHHostnamesEnv = "GH_STACK_TEST_FAKE_SSH_HOSTNAMES"

// stubSSH puts a fake ssh first on PATH. Its `ssh -G HOST` reports hostnames[HOST], or HOST itself
// when unmapped, like ssh without a matching config. The fake is the running test binary, so
// TestMain must call runFakeSSHIfRequested.
func stubSSH(t *testing.T, hostnames map[string]string) {
t.Helper()
encoded, err := json.Marshal(hostnames)
require.NoError(t, err, "encoding fake ssh hostnames")
dir := t.TempDir()
name := "ssh"
if runtime.GOOS == "windows" {
name += ".exe"
}
copyTestBinary(t, filepath.Join(dir, name))
t.Setenv(fakeSSHHostnamesEnv, string(encoded))
t.Setenv("PATH", dir+string(os.PathListSeparator)+os.Getenv("PATH"))
}

// runFakeSSHIfRequested acts as `ssh -G` and exits when this test binary was started as the fake
// ssh installed by stubSSH. Otherwise it returns.
func runFakeSSHIfRequested() {
if strings.TrimSuffix(filepath.Base(os.Args[0]), ".exe") != "ssh" {
return
}
encoded, ok := os.LookupEnv(fakeSSHHostnamesEnv)
if !ok {
return
}
var hostnames map[string]string
if err := json.Unmarshal([]byte(encoded), &hostnames); err != nil {
fmt.Fprintf(os.Stderr, "fake ssh: decoding hostnames: %v\n", err)
os.Exit(1)
}
args := os.Args[1:]
if len(args) != 2 || args[0] != "-G" {
fmt.Fprintf(os.Stderr, "fake ssh: unexpected arguments %q\n", args)
os.Exit(1)
}
host := args[1]
hostname, mapped := hostnames[host]
if !mapped {
hostname = host
}
fmt.Printf("hostname %s\n", hostname)
os.Exit(0)
}

func copyTestBinary(t *testing.T, dst string) {
t.Helper()
src, err := os.Executable()
require.NoError(t, err, "locating test binary")
in, err := os.Open(src)
require.NoError(t, err, "opening test binary")
defer in.Close()
out, err := os.OpenFile(dst, os.O_CREATE|os.O_WRONLY, 0o755)
require.NoError(t, err, "creating fake ssh")
_, err = io.Copy(out, in)
closeErr := out.Close()
require.NoError(t, err, "copying test binary")
require.NoError(t, closeErr, "closing fake ssh")
}
Loading