mirror of
https://gitea.com/gitea/gitea-mcp.git
synced 2026-08-27 02:27:45 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4e62d158cb |
@@ -31,5 +31,7 @@ USER nonroot:nonroot
|
||||
|
||||
LABEL org.opencontainers.image.version="${VERSION}"
|
||||
LABEL org.opencontainers.image.source="https://gitea.com/gitea/gitea-mcp"
|
||||
LABEL org.opencontainers.image.title="Gitea MCP Server"
|
||||
LABEL org.opencontainers.image.description="Model Context Protocol server connecting Gitea instances to MCP clients, published as docker.gitea.com/gitea-mcp-server."
|
||||
|
||||
CMD ["/app/gitea-mcp"]
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
|
||||
Download a binary from the [releases page](https://gitea.com/gitea/gitea-mcp/releases) and put it in your `PATH`, use the `docker.gitea.com/gitea-mcp-server` image, or build from source into `$GOPATH/bin` with `make` and Go 1.26 or later:
|
||||
|
||||
> The published Docker image is `docker.gitea.com/gitea-mcp-server`, which does not match the `gitea-mcp` repository name. This is a known mismatch, tracked in [issue #181](https://gitea.com/gitea/gitea-mcp/issues/181); the image name stays as-is for now to avoid breaking existing installs. See [docs/adr/docker-image-naming.md](docs/adr/docker-image-naming.md) for details.
|
||||
|
||||
```bash
|
||||
git clone https://gitea.com/gitea/gitea-mcp.git
|
||||
cd gitea-mcp
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
|
||||
可从 [发布页面](https://gitea.com/gitea/gitea-mcp/releases) 下载二进制文件并放入 `PATH`,或使用 `docker.gitea.com/gitea-mcp-server` 镜像,也可用 `make` 和 Go 1.26 及以上从源码构建到 `$GOPATH/bin`:
|
||||
|
||||
> 已发布的 Docker 镜像名为 `docker.gitea.com/gitea-mcp-server`,与 `gitea-mcp` 仓库名不一致。这是 [issue #181](https://gitea.com/gitea/gitea-mcp/issues/181) 中记录的已知不一致,为避免破坏现有安装,镜像名暂不改动。详见 [docs/adr/docker-image-naming.md](docs/adr/docker-image-naming.md)。
|
||||
|
||||
```bash
|
||||
git clone https://gitea.com/gitea/gitea-mcp.git
|
||||
cd gitea-mcp
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
|
||||
可從 [發布頁面](https://gitea.com/gitea/gitea-mcp/releases) 下載二進位檔並放入 `PATH`,或使用 `docker.gitea.com/gitea-mcp-server` 映像檔,也可用 `make` 與 Go 1.26 以上從原始碼建置到 `$GOPATH/bin`:
|
||||
|
||||
> 已發布的 Docker 映像檔名稱為 `docker.gitea.com/gitea-mcp-server`,與 `gitea-mcp` 倉庫名稱不一致。這是 [issue #181](https://gitea.com/gitea/gitea-mcp/issues/181) 中記錄的已知不一致,為避免破壞現有安裝,映像檔名稱暫不變更。詳見 [docs/adr/docker-image-naming.md](docs/adr/docker-image-naming.md)。
|
||||
|
||||
```bash
|
||||
git clone https://gitea.com/gitea/gitea-mcp.git
|
||||
cd gitea-mcp
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# Docker image naming mismatch (issue #181)
|
||||
|
||||
## Current state
|
||||
|
||||
The project repository is `gitea.com/gitea/gitea-mcp`, but the Docker image is
|
||||
published as `docker.gitea.com/gitea-mcp-server`. This mismatch was raised in
|
||||
[issue #181](https://gitea.com/gitea/gitea-mcp/issues/181).
|
||||
|
||||
## Maintainers' direction
|
||||
|
||||
Per the issue discussion, the maintainers' preferred long-term name is
|
||||
`gitea/mcp-server`, matching the naming scheme used by `gitea/act_runner`
|
||||
(published as a `runner`-style short name) and by comparable projects such as
|
||||
`github/github-mcp-server`. The name `mcp-server` was preferred over
|
||||
`gitea-mcp-server` because the repository is primarily run as a local client
|
||||
process, not a traditional long-running server.
|
||||
|
||||
## Decision
|
||||
|
||||
No rename has happened yet; the discussion was explicitly left open in the
|
||||
issue. The current image name, `docker.gitea.com/gitea-mcp-server`, remains in
|
||||
use so that existing user configurations and documentation keep working.
|
||||
`org.opencontainers.image.title` and `org.opencontainers.image.description`
|
||||
labels were added to the `Dockerfile` to make the image self-describing
|
||||
regardless of the tag it is published under.
|
||||
|
||||
If the image is renamed in the future, update the `docker.gitea.com/gitea-mcp-server`
|
||||
references across `README.md`, `README.zh-cn.md` and `README.zh-tw.md` together
|
||||
with this document.
|
||||
@@ -22,6 +22,38 @@ var readmeAccessLabels = map[string]map[string]string{
|
||||
"../README.zh-tw.md": {"讀取": "read", "寫入": "write"},
|
||||
}
|
||||
|
||||
// publishedDockerImage is the image name published for this project. See
|
||||
// docs/adr/docker-image-naming.md for why it differs from the repository name.
|
||||
const publishedDockerImage = "docker.gitea.com/gitea-mcp-server"
|
||||
|
||||
// dockerImageReference matches any docker.gitea.com/<name> image reference so
|
||||
// stray typos or partial renames in the README files can be caught.
|
||||
var dockerImageReference = regexp.MustCompile(`docker\.gitea\.com/[a-zA-Z0-9._-]+`)
|
||||
|
||||
// TestReadmeDockerImageReferencesAreConsistent ensures every README mentions
|
||||
// the same, currently published Docker image name. A partial rename, where
|
||||
// one example is updated but another is missed, would otherwise leave users
|
||||
// copying a command that pulls a nonexistent image.
|
||||
func TestReadmeDockerImageReferencesAreConsistent(t *testing.T) {
|
||||
for _, path := range []string{"../README.md", "../README.zh-cn.md", "../README.zh-tw.md"} {
|
||||
t.Run(filepath.Base(path), func(t *testing.T) {
|
||||
content, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
references := dockerImageReference.FindAllString(string(content), -1)
|
||||
if len(references) == 0 {
|
||||
t.Fatalf("no docker.gitea.com image reference found in %s", path)
|
||||
}
|
||||
for _, ref := range references {
|
||||
if ref != publishedDockerImage {
|
||||
t.Errorf("found image reference %q in %s, want %q", ref, path, publishedDockerImage)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// toolInfo is what TestReadmeToolTables tracks per tool, both as registered
|
||||
// in code and as documented in a README, so the two can be compared.
|
||||
type toolInfo struct {
|
||||
|
||||
+32
-29
@@ -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
@@ -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
@@ -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))
|
||||
}
|
||||
|
||||
@@ -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
|
||||
}
|
||||
@@ -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")
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user