Compare commits

..

1 Commits

Author SHA1 Message Date
Lunny Xiao 6744cab627 feat(gitea): support extra outbound HTTP headers via GITEA_EXTRA_HEADERS
Add a GITEA_EXTRA_HEADERS environment variable that accepts a JSON
object of header name/value pairs (e.g. Cloudflare Access
credentials) and applies them to every outbound request to Gitea,
both the raw pkg/gitea.DoJSON/DoBytes path and the SDK-backed
pkg/gitea.NewClient path, without overriding Authorization,
Content-Type, or Accept.

Co-Authored-By: Codet <codet@commitgo.dev> (GPT-5-Codex)
2026-08-23 23:33:36 -07:00
14 changed files with 198 additions and 354 deletions
+8 -2
View File
@@ -20,6 +20,14 @@ make install
Pass the Gitea host and access token as command-line flags or environment variables, flags take precedence. Run `gitea-mcp --help` for the full list of flags and environment variables. Logs are written to `$HOME/.gitea-mcp/gitea-mcp.log`, add `-d` for debug logging.
Set `GITEA_EXTRA_HEADERS` to a JSON object of header name/value pairs to send with every outbound request to Gitea, for example when Gitea sits behind Cloudflare Access:
```bash
export GITEA_EXTRA_HEADERS='{"CF-Access-Client-Id":"id","CF-Access-Client-Secret":"secret"}'
```
These headers never override `Authorization`, `Content-Type`, or `Accept` set by `gitea-mcp` itself.
### MCP protocol and HTTP transport
The server supports MCP up to `2026-07-28` and negotiates down to the client's version, advertising only the `tools` capability. Tool and Gitea failures return a `tools/call` result with `result.isError: true`, while malformed requests and server faults stay JSON-RPC errors.
@@ -191,8 +199,6 @@ Once configured, try `list all my repositories` in the chat box.
| get_release | release | Read | Get a release by ID |
| get_latest_release | release | Read | Get the latest release |
| list_releases | release | Read | List repository releases |
| search | connector | Read | Search Gitea repositories by keyword for ChatGPT-style connectors |
| fetch | connector | Read | Fetch a file's decoded content and metadata for ChatGPT-style connectors |
> **Note:** Several tools are consolidated, action-based tools, a single tool exposes multiple operations through a `method` parameter. Tools with `Write` access are hidden when the server runs in read-only mode (`-r` / `GITEA_READONLY`), and the exposed tool set can be filtered by scope with `-S` / `--scope` (`GITEA_SCOPES`) and/or by individual tool name with `-O` / `--tools` (`GITEA_TOOLS`).
-2
View File
@@ -191,8 +191,6 @@ Cursor 等客户端可使用 stdio 命令:
| get_release | release | 读取 | 按 ID 获取版本发布 |
| get_latest_release | release | 读取 | 获取最新版本发布 |
| list_releases | release | 读取 | 列出仓库版本发布 |
| search | connector | 读取 | 为 ChatGPT 风格的连接器按关键字搜索 Gitea 仓库 |
| fetch | connector | 读取 | 为 ChatGPT 风格的连接器获取文件的解码内容与元数据 |
> **说明:** 部分工具是聚合的、基于操作的工具,单个工具通过 `method` 参数暴露多个操作。当服务器以只读模式运行时(`-r` / `GITEA_READONLY`),访问为「写入」的工具会被隐藏;可通过 `-S` / `--scope``GITEA_SCOPES`)按范围过滤,或通过 `-O` / `--tools``GITEA_TOOLS`)按工具名称过滤对外暴露的工具集合。
-2
View File
@@ -191,8 +191,6 @@ Cursor 等客戶端可使用 stdio 命令:
| get_release | release | 讀取 | 依 ID 取得版本發布 |
| get_latest_release | release | 讀取 | 取得最新版本發布 |
| list_releases | release | 讀取 | 列出倉庫版本發布 |
| search | connector | 讀取 | 為 ChatGPT 風格的連接器依關鍵字搜尋 Gitea 倉庫 |
| fetch | connector | 讀取 | 為 ChatGPT 風格的連接器取得檔案的解碼內容與中繼資料 |
> **說明:** 部分工具是聚合的、基於操作的工具,單個工具透過 `method` 參數暴露多個操作。當伺服器以唯讀模式執行時(`-r` / `GITEA_READONLY`),存取為「寫入」的工具會被隱藏;可透過 `-S` / `--scope``GITEA_SCOPES`)依範圍過濾,或透過 `-O` / `--tools``GITEA_TOOLS`)依工具名稱過濾對外暴露的工具集合。
+15
View File
@@ -2,9 +2,11 @@ package cmd
import (
"context"
"encoding/json"
"flag"
"fmt"
"io"
"net/http"
"os"
"strconv"
"strings"
@@ -86,6 +88,7 @@ func initFlagSet(fs *flag.FlagSet, args []string, getenv func(string) string, re
fmt.Fprintf(w, " GITEA_ACCESS_TOKEN\tProvide access token\n")
fmt.Fprintf(w, " GITEA_ACCESS_TOKEN_FILE\tPath to a file containing the access token (e.g. a Docker secret)\n")
fmt.Fprintf(w, " GITEA_DEBUG\tSet to 'true' for debug mode\n")
fmt.Fprintf(w, " GITEA_EXTRA_HEADERS\tJSON object of extra HTTP headers to send with Gitea API requests\n")
fmt.Fprintf(w, " GITEA_HOST\tOverride Gitea host URL\n")
fmt.Fprintf(w, " GITEA_INSECURE\tSet to 'true' to ignore TLS errors\n")
fmt.Fprintf(w, " GITEA_MAX_INLINE_ATTACHMENT_BYTES\tOverride inline image attachment size limit in bytes\n")
@@ -164,6 +167,18 @@ func initFlagSet(fs *flag.FlagSet, args []string, getenv func(string) string, re
flagPkg.MaxInlineAttachmentBytes = parsed
}
}
if val := getenv("GITEA_EXTRA_HEADERS"); val != "" {
var headers map[string]string
if err := json.Unmarshal([]byte(val), &headers); err != nil {
fmt.Fprintf(stderr, "invalid GITEA_EXTRA_HEADERS: %v\n", err)
osExit(1)
}
extraHeaders := make(http.Header, len(headers))
for name, value := range headers {
extraHeaders.Set(name, value)
}
flagPkg.ExtraHeaders = extraHeaders
}
}
// normalizeScope trims whitespace, lowercases, and converts internal spaces
+52
View File
@@ -5,6 +5,7 @@ import (
"flag"
"maps"
"slices"
"strings"
"testing"
flagPkg "gitea.com/gitea/gitea-mcp/pkg/flag"
@@ -95,3 +96,54 @@ func TestInitFlagSetScopes(t *testing.T) {
})
}
}
func TestInitFlagSetExtraHeaders(t *testing.T) {
t.Cleanup(func() { flagPkg.ExtraHeaders = nil })
getenv := func(key string) string {
if key == "GITEA_EXTRA_HEADERS" {
return `{"CF-Access-Client-Id":"id","CF-Access-Client-Secret":"secret"}`
}
return ""
}
readFile := func(string) ([]byte, error) { return nil, nil }
fs := flag.NewFlagSet("test", flag.ContinueOnError)
var stderr bytes.Buffer
initFlagSet(fs, []string{}, getenv, readFile, &stderr)
if got := flagPkg.ExtraHeaders.Get("CF-Access-Client-Id"); got != "id" {
t.Errorf("ExtraHeaders[CF-Access-Client-Id] = %q, want %q", got, "id")
}
if got := flagPkg.ExtraHeaders.Get("CF-Access-Client-Secret"); got != "secret" {
t.Errorf("ExtraHeaders[CF-Access-Client-Secret] = %q, want %q", got, "secret")
}
}
func TestInitFlagSetExtraHeadersInvalidJSON(t *testing.T) {
t.Cleanup(func() { flagPkg.ExtraHeaders = nil })
origOsExit := osExit
var exitCode int
osExit = func(code int) { exitCode = code }
t.Cleanup(func() { osExit = origOsExit })
getenv := func(key string) string {
if key == "GITEA_EXTRA_HEADERS" {
return `not-json`
}
return ""
}
readFile := func(string) ([]byte, error) { return nil, nil }
fs := flag.NewFlagSet("test", flag.ContinueOnError)
var stderr bytes.Buffer
initFlagSet(fs, []string{}, getenv, readFile, &stderr)
if exitCode != 1 {
t.Errorf("exitCode = %d, want 1", exitCode)
}
if !strings.Contains(stderr.String(), "GITEA_EXTRA_HEADERS") {
t.Errorf("stderr = %q, want mention of GITEA_EXTRA_HEADERS", stderr.String())
}
}
-159
View File
@@ -1,159 +0,0 @@
// Package connector provides the "search" and "fetch" tools expected by
// ChatGPT-style MCP connectors (https://platform.openai.com/docs/mcp), on
// top of the same Gitea SDK calls the search and file domains already use.
package connector
import (
"context"
"encoding/base64"
"fmt"
"gitea.com/gitea/gitea-mcp/pkg/annotation"
"gitea.com/gitea/gitea-mcp/pkg/gitea"
"gitea.com/gitea/gitea-mcp/pkg/params"
"gitea.com/gitea/gitea-mcp/pkg/to"
"gitea.com/gitea/gitea-mcp/pkg/tool"
gitea_sdk "gitea.dev/sdk"
"github.com/modelcontextprotocol/go-sdk/mcp"
)
// Tool holds the connector tools (scope "connector"): search and fetch.
var Tool = tool.New("connector")
const (
SearchToolName = "search"
FetchToolName = "fetch"
)
var (
SearchTool = tool.NewDefinition(
SearchToolName,
"Search Gitea repositories by keyword. Returns concise entries suitable for ChatGPT-style connectors.",
annotation.ReadOnly("Search"),
tool.String("query", tool.Required(), tool.Description("search keyword")),
tool.String("owner", tool.Description("filter results to repositories owned by this user")),
tool.String("org", tool.Description("filter results to repositories owned by this organization")),
tool.Number("page", tool.Description(params.PageDesc), tool.Default(1)),
tool.Number("per_page", tool.Description(params.PaginationDesc), tool.Default(30)),
)
FetchTool = tool.NewDefinition(
FetchToolName,
"Fetch a file's decoded content and metadata from a Gitea repository. Suitable for ChatGPT-style connectors.",
annotation.ReadOnly("Fetch"),
tool.String("owner", tool.Required(), tool.Description(params.OwnerDesc)),
tool.String("repo", tool.Required(), tool.Description(params.RepoDesc)),
tool.String("path", tool.Required()),
tool.String("ref", tool.Description("branch, tag, or commit SHA")),
)
)
func init() {
Tool.RegisterRead(tool.ServerTool{
Tool: SearchTool,
Handler: SearchFn,
})
Tool.RegisterRead(tool.ServerTool{
Tool: FetchTool,
Handler: FetchFn,
})
}
// SearchFn searches Gitea repositories by keyword, optionally scoped to an
// owner or organization, and returns concise entries.
func SearchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
query, err := params.GetString(args, "query")
if err != nil {
return to.ErrorResult(err)
}
client, err := gitea.ClientFromContext(ctx)
if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
}
ownerName := params.GetOptionalString(args, "owner", "")
if ownerName == "" {
ownerName = params.GetOptionalString(args, "org", "")
}
var ownerID int64
if ownerName != "" {
owner, _, err := client.Users.GetUserInfo(ctx, ownerName)
if err != nil {
return to.ErrorResult(fmt.Errorf("resolve owner %q err: %v", ownerName, err))
}
ownerID = owner.ID
}
page, pageSize := params.GetPagination(args, 30)
opt := gitea_sdk.SearchRepoOptions{
Keyword: query,
OwnerID: ownerID,
ListOptions: gitea_sdk.ListOptions{
Page: page,
PageSize: pageSize,
},
}
repos, _, err := client.Repositories.SearchRepos(ctx, opt)
if err != nil {
return to.ErrorResult(fmt.Errorf("search repos err: %v", err))
}
return to.TextResult(slimSearchResults(repos))
}
// FetchFn fetches a file's content and decodes it, returning the decoded
// content alongside path, sha, size, and encoding metadata.
func FetchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
owner, err := params.GetString(args, "owner")
if err != nil {
return to.ErrorResult(err)
}
repo, err := params.GetString(args, "repo")
if err != nil {
return to.ErrorResult(err)
}
filePath, err := params.GetString(args, "path")
if err != nil {
return to.ErrorResult(err)
}
ref := params.GetOptionalString(args, "ref", "")
client, err := gitea.ClientFromContext(ctx)
if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
}
content, _, err := client.Repositories.GetContents(ctx, owner, repo, ref, filePath)
if err != nil {
return to.ErrorResult(fmt.Errorf("get file err: %v", err))
}
decoded, err := decodeContent(content)
if err != nil {
return to.ErrorResult(err)
}
return to.TextResult(map[string]any{
"path": content.Path,
"sha": content.SHA,
"size": content.Size,
"encoding": stringOrEmpty(content.Encoding),
"content": decoded,
})
}
func decodeContent(c *gitea_sdk.ContentsResponse) (string, error) {
if c.Content == nil {
return "", nil
}
raw, err := base64.StdEncoding.DecodeString(*c.Content)
if err != nil {
return "", fmt.Errorf("decode base64 content err: %v", err)
}
return string(raw), nil
}
func stringOrEmpty(s *string) string {
if s == nil {
return ""
}
return *s
}
-155
View File
@@ -1,155 +0,0 @@
package connector
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
"gitea.com/gitea/gitea-mcp/pkg/flag"
"github.com/modelcontextprotocol/go-sdk/mcp"
)
func withTestServer(t *testing.T, handler http.HandlerFunc) {
t.Helper()
server := httptest.NewServer(handler)
t.Cleanup(server.Close)
origHost, origToken := flag.Host, flag.Token
flag.Host, flag.Token = server.URL, ""
t.Cleanup(func() { flag.Host, flag.Token = origHost, origToken })
}
func resultText(t *testing.T, result *mcp.CallToolResult) string {
t.Helper()
text, ok := result.Content[0].(*mcp.TextContent)
if !ok {
t.Fatalf("result content = %T, want *mcp.TextContent", result.Content[0])
}
return text.Text
}
func TestSearchFnReturnsConciseRepoEntries(t *testing.T) {
withTestServer(t, func(w http.ResponseWriter, r *http.Request) {
if strings.HasSuffix(r.URL.Path, "/version") {
_, _ = w.Write([]byte(`{"version":"1.26.0"}`))
return
}
if !strings.HasSuffix(r.URL.Path, "/repos/search") {
t.Fatalf("unexpected request path %q", r.URL.Path)
}
if q := r.URL.Query().Get("q"); q != "gitea-mcp" {
t.Fatalf("query q = %q, want gitea-mcp", q)
}
_, _ = w.Write([]byte(`{"data":[{"id":42,"name":"gitea-mcp","full_name":"gitea/gitea-mcp","html_url":"https://gitea.com/gitea/gitea-mcp","description":"MCP server"}]}`))
})
result, err := SearchFn(context.Background(), map[string]any{"query": "gitea-mcp"})
if err != nil {
t.Fatalf("SearchFn() error = %v", err)
}
var entries []map[string]any
if err := json.Unmarshal([]byte(resultText(t, result)), &entries); err != nil {
t.Fatalf("unmarshal result: %v", err)
}
if len(entries) != 1 {
t.Fatalf("len(entries) = %d, want 1", len(entries))
}
entry := entries[0]
if entry["id"] != float64(42) {
t.Errorf("id = %v, want 42", entry["id"])
}
if entry["name"] != "gitea-mcp" {
t.Errorf("name = %v, want gitea-mcp", entry["name"])
}
if entry["url"] != "https://gitea.com/gitea/gitea-mcp" {
t.Errorf("url = %v, want the repo html_url", entry["url"])
}
if entry["html_url"] != "https://gitea.com/gitea/gitea-mcp" {
t.Errorf("html_url = %v, want the repo html_url", entry["html_url"])
}
}
func TestSearchFnRequiresQuery(t *testing.T) {
result, err := SearchFn(context.Background(), map[string]any{})
if err != nil {
t.Fatalf("SearchFn() error = %v", err)
}
if !result.IsError {
t.Fatal("SearchFn() result.IsError = false, want true for a missing query")
}
}
func TestSearchFnResolvesOwnerFilterToOwnerID(t *testing.T) {
withTestServer(t, func(w http.ResponseWriter, r *http.Request) {
switch {
case strings.HasSuffix(r.URL.Path, "/version"):
_, _ = w.Write([]byte(`{"version":"1.26.0"}`))
case strings.HasSuffix(r.URL.Path, "/users/octo"):
_, _ = w.Write([]byte(`{"id":7,"login":"octo"}`))
case strings.HasSuffix(r.URL.Path, "/repos/search"):
if uid := r.URL.Query().Get("uid"); uid != "7" {
t.Fatalf("uid = %q, want 7", uid)
}
_, _ = w.Write([]byte(`{"data":[]}`))
default:
t.Fatalf("unexpected request path %q", r.URL.Path)
}
})
if _, err := SearchFn(context.Background(), map[string]any{"query": "demo", "owner": "octo"}); err != nil {
t.Fatalf("SearchFn() error = %v", err)
}
}
func TestFetchFnReturnsDecodedContentAndMetadata(t *testing.T) {
withTestServer(t, func(w http.ResponseWriter, r *http.Request) {
if !strings.Contains(r.URL.Path, "/contents/") {
t.Fatalf("unexpected request path %q", r.URL.Path)
}
_, _ = w.Write([]byte(`{"name":"README.md","path":"README.md","sha":"abc123","type":"file","size":11,"encoding":"base64","content":"aGVsbG8gd29ybGQ="}`))
})
result, err := FetchFn(context.Background(), map[string]any{
"owner": "octo",
"repo": "demo",
"path": "README.md",
})
if err != nil {
t.Fatalf("FetchFn() error = %v", err)
}
var got map[string]any
if err := json.Unmarshal([]byte(resultText(t, result)), &got); err != nil {
t.Fatalf("unmarshal result: %v", err)
}
if got["content"] != "hello world" {
t.Errorf("content = %v, want decoded %q", got["content"], "hello world")
}
if got["path"] != "README.md" {
t.Errorf("path = %v, want README.md", got["path"])
}
if got["sha"] != "abc123" {
t.Errorf("sha = %v, want abc123", got["sha"])
}
if got["size"] != float64(11) {
t.Errorf("size = %v, want 11", got["size"])
}
if got["encoding"] != "base64" {
t.Errorf("encoding = %v, want base64", got["encoding"])
}
}
func TestFetchFnRequiresPath(t *testing.T) {
result, err := FetchFn(context.Background(), map[string]any{"owner": "octo", "repo": "demo"})
if err != nil {
t.Fatalf("FetchFn() error = %v", err)
}
if !result.IsError {
t.Fatal("FetchFn() result.IsError = false, want true for a missing path")
}
}
-29
View File
@@ -1,29 +0,0 @@
package connector
import (
gitea_sdk "gitea.dev/sdk"
)
// slimSearchResult is the concise entry shape ChatGPT-style connectors
// expect from search: an id, a title, and a url to fetch it by.
func slimSearchResult(r *gitea_sdk.Repository) map[string]any {
if r == nil {
return nil
}
return map[string]any{
"id": r.ID,
"name": r.Name,
"full_name": r.FullName,
"description": r.Description,
"url": r.HTMLURL,
"html_url": r.HTMLURL,
}
}
func slimSearchResults(repos []*gitea_sdk.Repository) []map[string]any {
out := make([]map[string]any, 0, len(repos))
for _, r := range repos {
out = append(out, slimSearchResult(r))
}
return out
}
+1 -2
View File
@@ -14,7 +14,6 @@ import (
"time"
"gitea.com/gitea/gitea-mcp/operation/actions"
"gitea.com/gitea/gitea-mcp/operation/connector"
"gitea.com/gitea/gitea-mcp/operation/issue"
"gitea.com/gitea/gitea-mcp/operation/label"
"gitea.com/gitea/gitea-mcp/operation/milestone"
@@ -48,7 +47,7 @@ var (
domainTools = []*tool.Tool{
user.Tool, actions.Tool, repo.Tool, notification.Tool, issue.Tool,
label.Tool, milestone.Tool, packages.Tool, pull.Tool, search.Tool,
version.Tool, wiki.Tool, timetracking.Tool, connector.Tool,
version.Tool, wiki.Tool, timetracking.Tool,
repo.FileTool, repo.BranchTool, repo.TagTool, repo.CommitTool, repo.ReleaseTool,
}
)
+3
View File
@@ -1,5 +1,7 @@
package flag
import "net/http"
var (
Host string
Bind string
@@ -15,4 +17,5 @@ var (
Debug bool
AllowedTools map[string]struct{}
AllowedScopes map[string]struct{}
ExtraHeaders http.Header
)
+27 -1
View File
@@ -30,6 +30,32 @@ func sharedTransport() *http.Transport {
return sharedTrans
}
// extraHeaderTransport injects flag.ExtraHeaders into every request, without
// overriding headers the caller already set (e.g. Authorization, Content-Type,
// Accept). It reads flag.ExtraHeaders on each round trip rather than caching
// it, so tests can change it between requests.
type extraHeaderTransport struct {
base http.RoundTripper
}
func (t *extraHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error) {
headers := flag.ExtraHeaders
if len(headers) == 0 {
return t.base.RoundTrip(req)
}
cloned := req.Clone(req.Context())
for name, values := range headers {
if cloned.Header.Get(name) == "" {
cloned.Header[name] = values
}
}
return t.base.RoundTrip(cloned)
}
func giteaTransport() http.RoundTripper {
return &extraHeaderTransport{base: sharedTransport()}
}
// NewClient returns a cached *gitea.Client keyed by host+token. The SDK's per-client
// version cache and the shared transport let us reuse keep-alive connections
// and avoid the SDK's /api/v1/version preflight on every tool call.
@@ -40,7 +66,7 @@ func NewClient(token string) (*gitea.Client, error) {
}
httpClient := &http.Client{
Transport: sharedTransport(),
Transport: giteaTransport(),
CheckRedirect: checkRedirect,
}
opts := []gitea.ClientOption{
+49
View File
@@ -0,0 +1,49 @@
package gitea
import (
"context"
"net/http"
"net/http/httptest"
"testing"
"gitea.com/gitea/gitea-mcp/pkg/flag"
)
func TestNewClient_SendsExtraHeaders(t *testing.T) {
var gotClientID, gotAuthorization string
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
gotClientID = r.Header.Get("CF-Access-Client-Id")
gotAuthorization = r.Header.Get("Authorization")
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"login":"octocat"}`))
}))
defer srv.Close()
origHost := flag.Host
origExtraHeaders := flag.ExtraHeaders
defer func() {
flag.Host = origHost
flag.ExtraHeaders = origExtraHeaders
}()
flag.Host = srv.URL
flag.ExtraHeaders = http.Header{
"Cf-Access-Client-Id": []string{"client-id"},
"Authorization": []string{"should-not-override"},
}
client, err := NewClient("the-token")
if err != nil {
t.Fatalf("NewClient returned error: %v", err)
}
if _, _, err := client.Users.GetMyUserInfo(context.Background()); err != nil {
t.Fatalf("GetMyUserInfo returned error: %v", err)
}
if gotClientID != "client-id" {
t.Fatalf("CF-Access-Client-Id header = %q, want %q", gotClientID, "client-id")
}
if gotAuthorization != "token the-token" {
t.Fatalf("Authorization header = %q, want %q", gotAuthorization, "token the-token")
}
}
+2 -2
View File
@@ -59,7 +59,7 @@ var (
func restHTTPClient() *http.Client {
restClientOnce.Do(func() {
restClient = &http.Client{
Transport: sharedTransport(),
Transport: giteaTransport(),
Timeout: httpClientTimeout,
CheckRedirect: checkRedirect,
}
@@ -180,7 +180,7 @@ func DoJSON(ctx context.Context, method, path string, query url.Values, body, re
func attachmentHTTPClient(origin *url.URL) *http.Client {
return &http.Client{
Transport: sharedTransport(),
Transport: giteaTransport(),
CheckRedirect: func(req *http.Request, via []*http.Request) error {
if err := checkRedirect(req, via); err != nil {
return err
+41
View File
@@ -62,3 +62,44 @@ func TestDoJSON_LimitsErrorResponseBody(t *testing.T) {
t.Fatalf("expected body length %d, got %d", errBodySnippetSize, len(httpErr.Body))
}
}
func TestDoJSON_SendsExtraHeaders(t *testing.T) {
var gotClientID, gotAuthorization string
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
gotClientID = r.Header.Get("CF-Access-Client-Id")
gotAuthorization = r.Header.Get("Authorization")
w.WriteHeader(http.StatusOK)
_, _ = io.WriteString(w, "{}")
}))
defer srv.Close()
origHost := flag.Host
origToken := flag.Token
origExtraHeaders := flag.ExtraHeaders
defer func() {
flag.Host = origHost
flag.Token = origToken
flag.ExtraHeaders = origExtraHeaders
}()
flag.Host = srv.URL
flag.Token = "the-token"
flag.ExtraHeaders = http.Header{
"Cf-Access-Client-Id": []string{"client-id"},
"Authorization": []string{"should-not-override"},
}
var out map[string]any
status, err := DoJSON(context.Background(), http.MethodGet, "repos/owner/repo", nil, nil, &out)
if err != nil {
t.Fatalf("DoJSON returned error: %v", err)
}
if status != http.StatusOK {
t.Fatalf("expected status %d, got %d", http.StatusOK, status)
}
if gotClientID != "client-id" {
t.Fatalf("CF-Access-Client-Id header = %q, want %q", gotClientID, "client-id")
}
if gotAuthorization != "token the-token" {
t.Fatalf("Authorization header = %q, want %q", gotAuthorization, "token the-token")
}
}