beads/internal/github/tracker_test.go
Mike Taylor c2c37605de
fix(github) bd github sync (GitHub issues integration) (#3929)
* fix(github): read github.token from config.yaml in tracker.Init

The github tracker's getConfig() only checked store.GetConfig (Dolt DB)
and the env var, but github.token is a yaml-only secret key and is
never stored in the DB. As a result, `bd github sync` errored with
"GitHub token not configured" even when the token was correctly set
in .beads/config.yaml via `bd config set github.token <token>`.

Mirror the pattern already used by internal/linear/tracker.go and
cmd/bd/github.go:getGitHubConfigValue(): check config.IsYamlOnlyKey
first and read from config.yaml for those keys.

Also adds TestGetConfig_YamlOnlyKeyBypassesStore: constructs a Tracker
with a nil store and verifies getConfig still resolves github.token via
env-var fallback — proof that yaml-only keys no longer deref the store.
Without the fix this test would panic on the nil store.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* test(github): cover yaml-read path for github.token getConfig

The original regression test (TestGetConfig_YamlOnlyKeyBypassesStore)
only proves the env-var fallback path through the yaml-only branch. It
does not assert the primary behavior the PR fixes: that github.token is
actually read from config.yaml when set there.

Add TestGetConfig_YamlOnlyKeyReadsFromYaml: writes a temp .beads/config.yaml
containing github.token, runs config.Initialize (with HOME/XDG isolated
and BEADS_TEST_IGNORE_REPO_CONFIG=1 so only the temp file loads), and
verifies tr.getConfig returns the yaml value with GITHUB_TOKEN unset.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-15 08:47:39 -07:00

346 lines
9.7 KiB
Go

package github
import (
"context"
"os"
"path/filepath"
"strconv"
"testing"
"time"
"github.com/steveyegge/beads/internal/config"
"github.com/steveyegge/beads/internal/tracker"
"github.com/steveyegge/beads/internal/types"
)
func TestRegistered(t *testing.T) {
factory := tracker.Get("github")
if factory == nil {
t.Fatal("github tracker not registered")
}
tr := factory()
if tr.Name() != "github" {
t.Errorf("Name() = %q, want %q", tr.Name(), "github")
}
if tr.DisplayName() != "GitHub" {
t.Errorf("DisplayName() = %q, want %q", tr.DisplayName(), "GitHub")
}
if tr.ConfigPrefix() != "github" {
t.Errorf("ConfigPrefix() = %q, want %q", tr.ConfigPrefix(), "github")
}
}
func TestIsExternalRef(t *testing.T) {
tr := &Tracker{}
tests := []struct {
ref string
want bool
}{
{"https://github.com/org/repo/issues/42", true},
{"https://github.com/team/project/issues/123", true},
{"https://gitlab.com/group/project/-/issues/42", false},
{"https://linear.app/team/issue/PROJ-123", false},
{"", false},
// Shorthand format produced by BuildExternalRef
{"github:681509", true},
{"github:1", true},
{"github:abc", false},
{"github:123/extra", false},
{"github:0", false},
}
for _, tt := range tests {
if got := tr.IsExternalRef(tt.ref); got != tt.want {
t.Errorf("IsExternalRef(%q) = %v, want %v", tt.ref, got, tt.want)
}
}
}
func TestExtractIdentifier(t *testing.T) {
tr := &Tracker{}
tests := []struct {
ref string
want string
}{
{"https://github.com/org/repo/issues/42", "42"},
{"https://github.com/team/project/issues/123", "123"},
{"not-a-url", ""},
// Shorthand format
{"github:681509", "681509"},
{"github:1", "1"},
{"github:abc", ""},
}
for _, tt := range tests {
if got := tr.ExtractIdentifier(tt.ref); got != tt.want {
t.Errorf("ExtractIdentifier(%q) = %q, want %q", tt.ref, got, tt.want)
}
}
}
func TestBuildExternalRef(t *testing.T) {
tr := &Tracker{}
ti := &tracker.TrackerIssue{
URL: "https://github.com/org/repo/issues/42",
Identifier: "42",
}
ref := tr.BuildExternalRef(ti)
if ref != ti.URL {
t.Errorf("BuildExternalRef() = %q, want %q", ref, ti.URL)
}
// Without URL, should use fallback
ti2 := &tracker.TrackerIssue{
Identifier: "42",
}
ref2 := tr.BuildExternalRef(ti2)
if ref2 != "github:42" {
t.Errorf("BuildExternalRef() = %q, want %q", ref2, "github:42")
}
}
func TestFieldMapperStatus(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
if got := m.StatusToBeads("open"); got != types.StatusOpen {
t.Errorf("StatusToBeads(open) = %q, want %q", got, types.StatusOpen)
}
if got := m.StatusToBeads("closed"); got != types.StatusClosed {
t.Errorf("StatusToBeads(closed) = %q, want %q", got, types.StatusClosed)
}
}
func TestFieldMapperPriority(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
if got := m.PriorityToBeads("critical"); got != 0 {
t.Errorf("PriorityToBeads(critical) = %d, want 0", got)
}
if got := m.PriorityToBeads("high"); got != 1 {
t.Errorf("PriorityToBeads(high) = %d, want 1", got)
}
if got := m.PriorityToBeads("low"); got != 3 {
t.Errorf("PriorityToBeads(low) = %d, want 3", got)
}
}
func TestFieldMapperType(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
if got := m.TypeToBeads("bug"); got != types.TypeBug {
t.Errorf("TypeToBeads(bug) = %q, want %q", got, types.TypeBug)
}
if got := m.TypeToBeads("feature"); got != types.TypeFeature {
t.Errorf("TypeToBeads(feature) = %q, want %q", got, types.TypeFeature)
}
if got := m.TypeToBeads("unknown"); got != types.TypeTask {
t.Errorf("TypeToBeads(unknown) = %q, want %q (default)", got, types.TypeTask)
}
}
func TestGitHubToTrackerIssue(t *testing.T) {
now := time.Now()
gh := &Issue{
ID: 100,
Number: 42,
Title: "Fix pipeline",
Body: "CI is broken",
State: "open",
HTMLURL: "https://github.com/org/repo/issues/42",
Labels: []Label{
{Name: "bug"},
{Name: "priority::high"},
},
CreatedAt: &now,
UpdatedAt: &now,
Assignee: &User{ID: 5, Login: "bob"},
}
ti := githubToTrackerIssue(gh)
if ti.ID != "100" {
t.Errorf("ID = %q, want %q", ti.ID, "100")
}
if ti.Identifier != "42" {
t.Errorf("Identifier = %q, want %q", ti.Identifier, "42")
}
if ti.Assignee != "bob" {
t.Errorf("Assignee = %q, want %q", ti.Assignee, "bob")
}
if ti.AssigneeID != strconv.Itoa(5) {
t.Errorf("AssigneeID = %q, want %q", ti.AssigneeID, "5")
}
if ti.Raw != gh {
t.Error("Raw should reference original github.Issue")
}
if len(ti.Labels) != 2 {
t.Errorf("Labels count = %d, want 2", len(ti.Labels))
}
if ti.URL != "https://github.com/org/repo/issues/42" {
t.Errorf("URL = %q, want GitHub URL", ti.URL)
}
}
func TestGitHubToTrackerIssue_ClosedWithTimestamp(t *testing.T) {
now := time.Now()
closedAt := now.Add(-time.Hour)
gh := &Issue{
ID: 200,
Number: 99,
Title: "Closed issue",
State: "closed",
CreatedAt: &now,
UpdatedAt: &now,
ClosedAt: &closedAt,
HTMLURL: "https://github.com/org/repo/issues/99",
}
ti := githubToTrackerIssue(gh)
if ti.CompletedAt == nil {
t.Fatal("CompletedAt is nil for closed issue, want non-nil")
}
if !ti.CompletedAt.Equal(closedAt) {
t.Errorf("CompletedAt = %v, want %v", ti.CompletedAt, closedAt)
}
}
func TestFieldMapperIssueToBeads(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
now := time.Now()
gh := &Issue{
ID: 100,
Number: 42,
Title: "Test issue",
Body: "Test body",
State: "open",
Labels: []Label{
{Name: "type::bug"},
{Name: "priority::high"},
},
CreatedAt: &now,
UpdatedAt: &now,
HTMLURL: "https://github.com/org/repo/issues/42",
}
ti := &tracker.TrackerIssue{
ID: "100",
Identifier: "42",
Title: "Test issue",
Raw: gh,
}
conv := m.IssueToBeads(ti)
if conv == nil {
t.Fatal("IssueToBeads returned nil")
}
if conv.Issue == nil {
t.Fatal("IssueToBeads returned nil issue")
}
if conv.Issue.Title != "Test issue" {
t.Errorf("Issue.Title = %q, want %q", conv.Issue.Title, "Test issue")
}
if conv.Issue.IssueType != types.TypeBug {
t.Errorf("Issue.IssueType = %q, want %q", conv.Issue.IssueType, types.TypeBug)
}
}
func TestFieldMapperIssueToBeads_NilRaw(t *testing.T) {
m := &githubFieldMapper{config: DefaultMappingConfig()}
ti := &tracker.TrackerIssue{
ID: "100",
Raw: nil, // Not a *github.Issue
}
conv := m.IssueToBeads(ti)
if conv != nil {
t.Error("IssueToBeads with nil Raw should return nil")
}
}
// TestGetConfig_YamlOnlyKeyBypassesStore is a regression test for the bug where
// `bd github sync` errored "GitHub token not configured" even though the token
// was set in .beads/config.yaml. The github tracker's getConfig used to read
// every key from the Dolt store, but github.token is a yaml-only secret key
// (never written to the DB). The fix routes yaml-only keys through config.yaml
// and env var, skipping the store entirely.
//
// We verify the store-bypass by passing a nil store: before the fix this would
// panic on the store deref; after the fix it falls through to GITHUB_TOKEN.
func TestGetConfig_YamlOnlyKeyBypassesStore(t *testing.T) {
ctx := context.Background()
tr := &Tracker{store: nil}
t.Run("falls back to env var", func(t *testing.T) {
t.Setenv("GITHUB_TOKEN", "env-token-value")
got := tr.getConfig(ctx, "github.token", "GITHUB_TOKEN")
if got != "env-token-value" {
t.Errorf("getConfig(github.token) = %q, want %q", got, "env-token-value")
}
})
t.Run("returns empty when no value is set", func(t *testing.T) {
t.Setenv("GITHUB_TOKEN", "")
got := tr.getConfig(ctx, "github.token", "GITHUB_TOKEN")
if got != "" {
t.Errorf("getConfig(github.token) = %q, want empty", got)
}
})
}
// TestGetConfig_YamlOnlyKeyReadsFromYaml is the positive case for the fix:
// when github.token is present in .beads/config.yaml, getConfig must return
// that value (and not depend on GITHUB_TOKEN being set). This is the primary
// behavior the PR restores; the BypassesStore test only proves the env-var
// fallback path. Together they cover both branches of the yaml-only handler.
func TestGetConfig_YamlOnlyKeyReadsFromYaml(t *testing.T) {
const wantToken = "yaml-config-token-value"
tmpDir := t.TempDir()
beadsDir := filepath.Join(tmpDir, ".beads")
if err := os.MkdirAll(beadsDir, 0o750); err != nil {
t.Fatalf("mkdir .beads: %v", err)
}
yamlBody := "github.token: \"" + wantToken + "\"\n"
if err := os.WriteFile(filepath.Join(beadsDir, "config.yaml"), []byte(yamlBody), 0o600); err != nil {
t.Fatalf("write config.yaml: %v", err)
}
// Isolate from the developer's environment so we read only the temp yaml.
t.Setenv("GITHUB_TOKEN", "")
t.Setenv("BEADS_DIR", "")
t.Setenv("BEADS_TEST_IGNORE_REPO_CONFIG", "1")
t.Setenv("HOME", filepath.Join(tmpDir, "home"))
t.Setenv("XDG_CONFIG_HOME", filepath.Join(tmpDir, "xdg"))
t.Chdir(tmpDir)
config.ResetForTesting()
t.Cleanup(config.ResetForTesting)
if err := config.Initialize(); err != nil {
t.Fatalf("config.Initialize: %v", err)
}
// Sanity-check that the yaml actually loaded — otherwise a getConfig
// failure could be mistaken for a tracker bug.
if got := config.GetString("github.token"); got != wantToken {
t.Fatalf("config.GetString(github.token) = %q, want %q (yaml not loaded?)", got, wantToken)
}
tr := &Tracker{store: nil}
got := tr.getConfig(context.Background(), "github.token", "GITHUB_TOKEN")
if got != wantToken {
t.Errorf("getConfig(github.token) = %q, want %q (yaml value)", got, wantToken)
}
}
func TestValidate(t *testing.T) {
tr := &Tracker{}
if err := tr.Validate(); err == nil {
t.Error("Validate() on uninitialized tracker should return error")
}
tr.client = &Client{} // Set client
if err := tr.Validate(); err != nil {
t.Errorf("Validate() on initialized tracker returned error: %v", err)
}
}