Merge pull request #620 from rr3khan/fix/gitea-xdg-config-home

fix: Gittea write config to XDG_CONFIG_HOME when set

Author: scottisloud

plugins/gitea/personal_access_token.go

@@ -3,6 +3,7 @@ package gitea
 import (
 	"context"
 	"os"
+	"path/filepath"
 
 	"github.com/1Password/shell-plugins/sdk"
 	"github.com/1Password/shell-plugins/sdk/importer"
@@ -14,11 +15,16 @@ import (
 )
 
 func ConfigPath() string {
+	// tea's config resolver honors XDG_CONFIG_HOME on macOS; os.UserConfigDir does not.
+	if xdgConfigHome := os.Getenv("XDG_CONFIG_HOME"); xdgConfigHome != "" {
+		return filepath.Join(xdgConfigHome, "tea", "config.yml")
+	}
+
 	configDir, err := os.UserConfigDir()
 	if err != nil {
 		return "~/.config/tea/config.yml"
 	}
-	return configDir + "/tea/config.yml"
+	return filepath.Join(configDir, "tea", "config.yml")
 }
 
 func PersonalAccessToken() schema.CredentialType {

plugins/gitea/personal_access_token_test.go

@@ -1,13 +1,43 @@
 package gitea
 
 import (
+	"os"
+	"path/filepath"
 	"testing"
 
 	"github.com/1Password/shell-plugins/sdk"
 	"github.com/1Password/shell-plugins/sdk/plugintest"
 	"github.com/1Password/shell-plugins/sdk/schema/fieldname"
 )
 
+func TestConfigPath(t *testing.T) {
+	t.Run("honors XDG_CONFIG_HOME when set", func(t *testing.T) {
+		// tea reads its config from $XDG_CONFIG_HOME/tea/config.yml via
+		// github.com/adrg/xdg, so the plugin must write to the same place.
+		xdgConfigHome := filepath.Join(t.TempDir(), "xdg")
+		t.Setenv("XDG_CONFIG_HOME", xdgConfigHome)
+
+		want := filepath.Join(xdgConfigHome, "tea", "config.yml")
+		if got := ConfigPath(); got != want {
+			t.Errorf("ConfigPath() = %q, want %q", got, want)
+		}
+	})
+
+	t.Run("falls back to os.UserConfigDir when XDG_CONFIG_HOME is unset", func(t *testing.T) {
+		t.Setenv("XDG_CONFIG_HOME", "")
+
+		configDir, err := os.UserConfigDir()
+		if err != nil {
+			t.Skipf("os.UserConfigDir() unavailable: %v", err)
+		}
+
+		want := filepath.Join(configDir, "tea", "config.yml")
+		if got := ConfigPath(); got != want {
+			t.Errorf("ConfigPath() = %q, want %q", got, want)
+		}
+	})
+}
+
 func TestPersonalAccessTokenProvisioner(t *testing.T) {
 	plugintest.TestProvisioner(t, PersonalAccessToken().DefaultProvisioner, map[string]plugintest.ProvisionCase{
 		"default": {
@@ -27,6 +57,28 @@ func TestPersonalAccessTokenProvisioner(t *testing.T) {
 	})
 }
 
+func TestPersonalAccessTokenProvisionerHonorsXDGConfigHome(t *testing.T) {
+	xdgConfigHome := filepath.Join(t.TempDir(), "xdg")
+	t.Setenv("XDG_CONFIG_HOME", xdgConfigHome)
+
+	plugintest.TestProvisioner(t, PersonalAccessToken().DefaultProvisioner, map[string]plugintest.ProvisionCase{
+		"xdg config path": {
+			ItemFields: map[sdk.FieldName]string{
+				fieldname.Token:       "oyyfsny27bgphldmhvffxhhlmqvdkzjrfslrsj9f",
+				fieldname.HostAddress: "https://git.example.com",
+				fieldname.User:        "example",
+			},
+			ExpectedOutput: sdk.ProvisionOutput{
+				Files: map[string]sdk.OutputFile{
+					filepath.Join(xdgConfigHome, "tea", "config.yml"): {
+						Contents: []byte(plugintest.LoadFixture(t, "config.yml")),
+					},
+				},
+			},
+		},
+	})
+}
+
 func TestPersonalAccessTokenImporter(t *testing.T) {
 	plugintest.TestImporter(t, PersonalAccessToken().Importer, map[string]plugintest.ImportCase{
 
@@ -55,3 +107,34 @@ func TestPersonalAccessTokenImporter(t *testing.T) {
 		},
 	})
 }
+
+func TestPersonalAccessTokenImporterHonorsXDGConfigHome(t *testing.T) {
+	xdgConfigHome := filepath.Join(t.TempDir(), "xdg")
+	t.Setenv("XDG_CONFIG_HOME", xdgConfigHome)
+
+	plugintest.TestImporter(t, PersonalAccessToken().Importer, map[string]plugintest.ImportCase{
+		"xdg config file": {
+			Files: map[string]string{
+				filepath.Join(xdgConfigHome, "tea", "config.yml"): plugintest.LoadFixture(t, "import_config.yml"),
+			},
+			ExpectedCandidates: []sdk.ImportCandidate{
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.Token:       "oyyfsny27bgphldmhvffxhhlmqvdkzjrfslrsj9f",
+						fieldname.HostAddress: "https://git.example.com",
+						fieldname.User:        "example",
+					},
+					NameHint: "git.example.com",
+				},
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.Token:       "enjkarzu2ca5ffcnvzaczxncuczeoq9utlpqqrzs",
+						fieldname.HostAddress: "https://gitea.com",
+						fieldname.User:        "example@example.com",
+					},
+					NameHint: "gitea.com",
+				},
+			},
+		},
+	})
+}