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
13 changed files with 314 additions and 291 deletions
+8
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.
+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())
}
}
+32 -29
View File
@@ -69,26 +69,28 @@ func init() {
})
}
type createBranchArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Branch string `json:"branch" required:"true"`
OldBranch string `json:"old_branch"`
}
func CreateBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
var in createBranchArgs
if err := params.Bind(args, &in); err != nil {
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)
}
branch, err := params.GetString(args, "branch")
if err != nil {
return to.ErrorResult(err)
}
oldBranch, _ := args["old_branch"].(string)
client, err := gitea.ClientFromContext(ctx)
if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
}
_, _, err = client.Repositories.CreateBranch(ctx, in.Owner, in.Repo, gitea_sdk.CreateBranchOption{
BranchName: in.Branch,
OldBranchName: in.OldBranch,
_, _, err = client.Repositories.CreateBranch(ctx, owner, repo, gitea_sdk.CreateBranchOption{
BranchName: branch,
OldBranchName: oldBranch,
})
if err != nil {
return to.ErrorResult(fmt.Errorf("create branch error: %v", err))
@@ -97,22 +99,24 @@ func CreateBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResu
return to.TextResult("Branch Created")
}
type deleteBranchArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Branch string `json:"branch" required:"true"`
}
func DeleteBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
var in deleteBranchArgs
if err := params.Bind(args, &in); err != nil {
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)
}
branch, err := params.GetString(args, "branch")
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))
}
_, _, err = client.Repositories.DeleteRepoBranch(ctx, in.Owner, in.Repo, in.Branch)
_, _, err = client.Repositories.DeleteRepoBranch(ctx, owner, repo, branch)
if err != nil {
return to.ErrorResult(fmt.Errorf("delete branch error: %v", err))
}
@@ -120,14 +124,13 @@ func DeleteBranchFn(ctx context.Context, args map[string]any) (*mcp.CallToolResu
return to.TextResult("Branch Deleted")
}
type listBranchesArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
}
func ListBranchesFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
var in listBranchesArgs
if err := params.Bind(args, &in); err != nil {
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)
}
page, pageSize := params.GetPagination(args, 30)
@@ -141,7 +144,7 @@ func ListBranchesFn(ctx context.Context, args map[string]any) (*mcp.CallToolResu
if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
}
branches, _, err := client.Repositories.ListRepoBranches(ctx, in.Owner, in.Repo, opt)
branches, _, err := client.Repositories.ListRepoBranches(ctx, owner, repo, opt)
if err != nil {
return to.ErrorResult(fmt.Errorf("list branches error: %v", err))
}
+71 -60
View File
@@ -102,28 +102,30 @@ type ContentLine struct {
Content string `json:"content"`
}
type getFileContentArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Ref string `json:"ref"`
Path string `json:"path" required:"true"`
WithLines bool `json:"withLines"`
}
func GetFileContentFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
var in getFileContentArgs
if err := params.Bind(args, &in); err != nil {
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)
}
ref, _ := args["ref"].(string)
filePath, err := params.GetString(args, "path")
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))
}
content, _, err := client.Repositories.GetContents(ctx, in.Owner, in.Repo, in.Ref, in.Path)
content, _, err := client.Repositories.GetContents(ctx, owner, repo, ref, filePath)
if err != nil {
return to.ErrorResult(fmt.Errorf("get file err: %v", err))
}
if in.WithLines {
withLines, _ := args["withLines"].(bool)
if withLines {
rawContent, err := base64.StdEncoding.DecodeString(*content.Content)
if err != nil {
return to.ErrorResult(fmt.Errorf("decode base64 content err: %v", err))
@@ -162,45 +164,49 @@ func GetFileContentFn(ctx context.Context, args map[string]any) (*mcp.CallToolRe
return to.TextResult(slimContents(content))
}
type getDirContentArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Ref string `json:"ref"`
Path string `json:"path" required:"true"`
}
func GetDirContentFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
var in getDirContentArgs
if err := params.Bind(args, &in); err != nil {
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)
}
ref, _ := args["ref"].(string)
filePath, err := params.GetString(args, "path")
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))
}
content, _, err := client.Repositories.ListContents(ctx, in.Owner, in.Repo, in.Ref, in.Path)
content, _, err := client.Repositories.ListContents(ctx, owner, repo, ref, filePath)
if err != nil {
return to.ErrorResult(fmt.Errorf("get dir content err: %v", err))
}
return to.TextResult(slimDirEntries(content))
}
type createOrUpdateFileArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Path string `json:"path" required:"true"`
Content string `json:"content"`
Message string `json:"message"`
BranchName string `json:"branch_name"`
NewBranchName string `json:"new_branch_name"`
SHA string `json:"sha"`
}
func CreateOrUpdateFileFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
var in createOrUpdateFileArgs
if err := params.Bind(args, &in); err != nil {
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)
}
content, _ := args["content"].(string)
message, _ := args["message"].(string)
branchName, _ := args["branch_name"].(string)
newBranchName, _ := args["new_branch_name"].(string)
sha, _ := args["sha"].(string)
client, err := gitea.ClientFromContext(ctx)
if err != nil {
@@ -208,20 +214,20 @@ func CreateOrUpdateFileFn(ctx context.Context, args map[string]any) (*mcp.CallTo
}
fileOpt := gitea_sdk.FileOptions{
Message: in.Message,
BranchName: in.BranchName,
NewBranchName: in.NewBranchName,
Message: message,
BranchName: branchName,
NewBranchName: newBranchName,
}
targetBranch := cmp.Or(in.NewBranchName, in.BranchName)
targetBranch := cmp.Or(newBranchName, branchName)
if in.SHA != "" {
if sha != "" {
// Update existing file
opt := gitea_sdk.UpdateFileOptions{
SHA: in.SHA,
Content: base64.StdEncoding.EncodeToString([]byte(in.Content)),
SHA: sha,
Content: base64.StdEncoding.EncodeToString([]byte(content)),
FileOptions: fileOpt,
}
_, _, err = client.Repositories.UpdateFile(ctx, in.Owner, in.Repo, in.Path, opt)
_, _, err = client.Repositories.UpdateFile(ctx, owner, repo, filePath, opt)
if err != nil {
return to.ErrorResult(fmt.Errorf("update file err: %v", err))
}
@@ -230,42 +236,47 @@ func CreateOrUpdateFileFn(ctx context.Context, args map[string]any) (*mcp.CallTo
// Create new file
opt := gitea_sdk.CreateFileOptions{
Content: base64.StdEncoding.EncodeToString([]byte(in.Content)),
Content: base64.StdEncoding.EncodeToString([]byte(content)),
FileOptions: fileOpt,
}
_, _, err = client.Repositories.CreateFile(ctx, in.Owner, in.Repo, in.Path, opt)
_, _, err = client.Repositories.CreateFile(ctx, owner, repo, filePath, opt)
if err != nil {
return to.ErrorResult(fmt.Errorf("create file err: %v", err))
}
return to.TextResult("Create file success on branch " + targetBranch)
}
type deleteFileArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
Path string `json:"path" required:"true"`
Message string `json:"message"`
BranchName string `json:"branch_name"`
SHA string `json:"sha" required:"true"`
}
func DeleteFileFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
var in deleteFileArgs
if err := params.Bind(args, &in); err != nil {
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)
}
message, _ := args["message"].(string)
branchName, _ := args["branch_name"].(string)
sha, err := params.GetString(args, "sha")
if err != nil {
return to.ErrorResult(err)
}
opt := gitea_sdk.DeleteFileOptions{
FileOptions: gitea_sdk.FileOptions{
Message: in.Message,
BranchName: in.BranchName,
Message: message,
BranchName: branchName,
},
SHA: in.SHA,
SHA: sha,
}
client, err := gitea.ClientFromContext(ctx)
if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
}
_, err = client.Repositories.DeleteFile(ctx, in.Owner, in.Repo, in.Path, opt)
_, err = client.Repositories.DeleteFile(ctx, owner, repo, filePath, opt)
if err != nil {
return to.ErrorResult(fmt.Errorf("delete file err: %v", err))
}
+14 -12
View File
@@ -37,18 +37,20 @@ func init() {
})
}
type getRepoTreeArgs struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
TreeSHA string `json:"tree_sha" required:"true"`
Recursive bool `json:"recursive"`
}
func GetRepoTreeFn(ctx context.Context, args map[string]any) (*mcp.CallToolResult, error) {
var in getRepoTreeArgs
if err := params.Bind(args, &in); err != nil {
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)
}
treeSHA, err := params.GetString(args, "tree_sha")
if err != nil {
return to.ErrorResult(err)
}
recursive, _ := args["recursive"].(bool)
page, pageSize := params.GetPagination(args, 30)
opt := gitea_sdk.ListTreeOptions{
@@ -56,14 +58,14 @@ func GetRepoTreeFn(ctx context.Context, args map[string]any) (*mcp.CallToolResul
Page: page,
PageSize: pageSize,
},
Ref: in.TreeSHA,
Recursive: in.Recursive,
Ref: treeSHA,
Recursive: recursive,
}
client, err := gitea.ClientFromContext(ctx)
if err != nil {
return to.ErrorResult(fmt.Errorf("get gitea client err: %v", err))
}
tree, _, err := client.Git.GetTrees(ctx, in.Owner, in.Repo, opt)
tree, _, err := client.Git.GetTrees(ctx, owner, repo, opt)
if err != nil {
return to.ErrorResult(fmt.Errorf("get repository tree err: %v", err))
}
+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")
}
}
-55
View File
@@ -1,55 +0,0 @@
package params
import (
"encoding/json"
"fmt"
"reflect"
"strings"
)
// Bind decodes args into out, a pointer to a struct, replacing the repeated
// args["x"].(string)/!ok extraction pattern. It round-trips args through JSON
// so JSON numbers land in the correct Go numeric field types.
//
// Struct fields tagged `required:"true"` must be present in args; a missing
// key, or an empty string value for a string field, returns an error naming
// the field's json tag.
func Bind(args map[string]any, out any) error {
v := reflect.ValueOf(out)
if v.Kind() != reflect.Pointer || v.Elem().Kind() != reflect.Struct {
return fmt.Errorf("params.Bind: out must be a pointer to a struct, got %T", out)
}
if err := checkRequiredFields(args, v.Elem().Type()); err != nil {
return err
}
data, err := json.Marshal(args)
if err != nil {
return fmt.Errorf("params.Bind: marshal args: %w", err)
}
if err := json.Unmarshal(data, out); err != nil {
return fmt.Errorf("params.Bind: %w", err)
}
return nil
}
func checkRequiredFields(args map[string]any, t reflect.Type) error {
for field := range t.Fields() {
if field.Tag.Get("required") != "true" {
continue
}
name, _, _ := strings.Cut(field.Tag.Get("json"), ",")
if name == "" || name == "-" {
continue
}
val, ok := args[name]
if !ok {
return fmt.Errorf("%s is required", name)
}
if s, isString := val.(string); isString && s == "" {
return fmt.Errorf("%s is required", name)
}
}
return nil
}
-132
View File
@@ -1,132 +0,0 @@
package params
import (
"strings"
"testing"
)
func TestBind_RequiredFieldsPresent(t *testing.T) {
type args struct {
Owner string `json:"owner" required:"true"`
Repo string `json:"repo" required:"true"`
}
var out args
err := Bind(map[string]any{"owner": "gitea", "repo": "gitea-mcp"}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if out.Owner != "gitea" || out.Repo != "gitea-mcp" {
t.Errorf("Bind() = %+v, want Owner=gitea Repo=gitea-mcp", out)
}
}
func TestBind_RequiredFieldMissing(t *testing.T) {
type args struct {
Owner string `json:"owner" required:"true"`
}
var out args
err := Bind(map[string]any{}, &out)
if err == nil {
t.Fatal("Bind() expected error, got nil")
}
if !strings.Contains(err.Error(), "owner") {
t.Errorf("Bind() error = %v, want mentioning %q", err, "owner")
}
}
func TestBind_RequiredStringFieldEmpty(t *testing.T) {
type args struct {
Owner string `json:"owner" required:"true"`
}
var out args
err := Bind(map[string]any{"owner": ""}, &out)
if err == nil {
t.Fatal("Bind() expected error for empty required string, got nil")
}
}
func TestBind_OptionalFieldDefaultsToZeroValue(t *testing.T) {
type args struct {
Owner string `json:"owner" required:"true"`
OldBranch string `json:"old_branch"`
}
var out args
err := Bind(map[string]any{"owner": "gitea"}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if out.OldBranch != "" {
t.Errorf("Bind() OldBranch = %q, want empty", out.OldBranch)
}
}
func TestBind_NumericConversion(t *testing.T) {
type args struct {
Page int `json:"page"`
PerPage int64 `json:"per_page"`
}
var out args
err := Bind(map[string]any{"page": float64(2), "per_page": float64(40)}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if out.Page != 2 || out.PerPage != 40 {
t.Errorf("Bind() = %+v, want Page=2 PerPage=40", out)
}
}
func TestBind_Boolean(t *testing.T) {
type args struct {
Recursive bool `json:"recursive"`
}
var out args
err := Bind(map[string]any{"recursive": true}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if !out.Recursive {
t.Errorf("Bind() Recursive = false, want true")
}
}
func TestBind_Array(t *testing.T) {
type args struct {
Labels []string `json:"labels"`
IDs []int64 `json:"ids"`
}
var out args
err := Bind(map[string]any{
"labels": []any{"bug", "help wanted"},
"ids": []any{float64(1), float64(2)},
}, &out)
if err != nil {
t.Fatalf("Bind() unexpected error = %v", err)
}
if len(out.Labels) != 2 || out.Labels[0] != "bug" || out.Labels[1] != "help wanted" {
t.Errorf("Bind() Labels = %v, want [bug help wanted]", out.Labels)
}
if len(out.IDs) != 2 || out.IDs[0] != 1 || out.IDs[1] != 2 {
t.Errorf("Bind() IDs = %v, want [1 2]", out.IDs)
}
}
func TestBind_InvalidFieldType(t *testing.T) {
type args struct {
Page int `json:"page"`
}
var out args
err := Bind(map[string]any{"page": "not-a-number"}, &out)
if err == nil {
t.Fatal("Bind() expected error for invalid numeric field, got nil")
}
}
func TestBind_NonPointerRejected(t *testing.T) {
type args struct {
Owner string `json:"owner"`
}
err := Bind(map[string]any{}, args{})
if err == nil {
t.Fatal("Bind() expected error for non-pointer out, got nil")
}
}