Merge pull request #2 from fishwww-ww/feature/mongodb-template

feat(template): add mongodb protocol template

Author: gitlayzer

README.md

@@ -20,7 +20,7 @@ Sealtun 是一款面向 **Sealos Cloud** 和 **Kubernetes** 用户的本地隧
 - 📊 **状态、诊断与工作台**：`doctor <tunnel-id>`、`inspect --remote`、`logs`、`events`、`metrics` 和 `dashboard` 可定位本地端口、daemon、远端 Pod、Service、Ingress 与证书问题，也可在本地工作台中管理隧道。
 - 🧭 **引导与自动修复**：`init` 可根据登录状态和本地监听端口推荐命令/YAML；`resources`、`watch` 与 `doctor --fix --dry-run` 可帮助理解和保守修复隧道状态。
 - 🔌 **集群内服务访问**：Linux 下 `sudo sealtun connect` 可直接访问 Service FQDN、Service ClusterIP 和 Pod IP 的 TCP 流量，无需 SOCKS 或客户端代理配置。
-- 🧩 **协议模板**：`template https|ssh|tcp|mysql|postgres|redis|mqtt` 可生成直接命令和 `sealtun.yaml` 示例。
+- 🧩 **协议模板**：`template https|ssh|tcp|mysql|postgres|redis|mongodb|mqtt` 可生成直接命令和 `sealtun.yaml` 示例。
 - 🧾 **声明式配置**：`apply -f sealtun.yaml` 可用 YAML 声明隧道，并以稳定名称幂等创建或更新；`export` 可把本地 session 导出回 YAML。
 - 🌐 **深度适配 Sealos**：原生使用 Sealos Cloud 的域名、证书和 Kubernetes 资源能力。
 
@@ -482,9 +482,10 @@ sealtun template https --name web --port 3000 --domain app.example.com
 sealtun template ssh
 sealtun template postgres
 sealtun template redis --name cache
+sealtun template mongodb
 ```
 
-模板会同时输出一次性 `sealtun expose` 命令和可提交到项目内的 `sealtun.yaml` 片段。`mysql`、`postgres`、`redis`、`mqtt` 模板默认走通用 TCP 四层入口；HTTPS 模板才支持自定义域名和访问控制。
+模板会同时输出一次性 `sealtun expose` 命令和可提交到项目内的 `sealtun.yaml` 片段。`mysql`、`postgres`、`redis`、`mongodb`、`mqtt` 模板默认走通用 TCP 四层入口；HTTPS 模板才支持自定义域名和访问控制。
 
 ### 9. 声明式配置
 创建 `sealtun.yaml`：

README_EN.md

@@ -20,7 +20,7 @@ Sealtun is a local tunnel CLI for **Sealos Cloud** and **Kubernetes** users. It
 - 📊 **Status, Diagnostics, and Workbench**: Use `doctor <tunnel-id>`, `inspect --remote`, `logs`, `events`, `metrics`, and `dashboard` to diagnose local ports, daemon state, remote Pods, Services, Ingresses, and certificates, or manage tunnels from the local workbench.
 - 🧭 **Guided UX and Safe Fixes**: Use `init` for first-run command/YAML recommendations, and `resources`, `watch`, or `doctor --fix --dry-run` to understand and conservatively repair tunnel state.
 - 🔌 **Cluster Service Access**: On Linux, `sudo sealtun connect` lets TCP clients directly reach Service FQDNs, Service ClusterIPs, and Pod IPs without SOCKS or client-side proxy config.
-- 🧩 **Protocol Templates**: Use `template https|ssh|tcp|mysql|postgres|redis|mqtt` to generate commands and `sealtun.yaml` examples.
+- 🧩 **Protocol Templates**: Use `template https|ssh|tcp|mysql|postgres|redis|mongodb|mqtt` to generate commands and `sealtun.yaml` examples.
 - 🧾 **Declarative Config**: Use `apply -f sealtun.yaml` to declare tunnels in YAML and create or update them with stable names; use `export` to turn local sessions back into YAML.
 - 🌐 **Optimized for Sealos**: Native support for Sealos Cloud domains, certificates, and Kubernetes resources.
 
@@ -482,9 +482,10 @@ sealtun template https --name web --port 3000 --domain app.example.com
 sealtun template ssh
 sealtun template postgres
 sealtun template redis --name cache
+sealtun template mongodb
 ```
 
-Templates print both a one-shot `sealtun expose` command and a `sealtun.yaml` snippet. `mysql`, `postgres`, `redis`, and `mqtt` templates default to generic TCP L4 entries; only HTTPS templates support custom domains and access controls.
+Templates print both a one-shot `sealtun expose` command and a `sealtun.yaml` snippet. `mysql`, `postgres`, `redis`, `mongodb`, and `mqtt` templates default to generic TCP L4 entries; only HTTPS templates support custom domains and access controls.
 
 ### 9. Declarative config
 Create `sealtun.yaml`:

cmd/dashboard.go

@@ -1633,6 +1633,7 @@ var dashboardHTML = template.Must(template.New("dashboard").Parse(`<!doctype htm
       mysql: { name: "mysql", port: 3306, protocol: "tcp" },
       postgres: { name: "postgres", port: 5432, protocol: "tcp" },
       redis: { name: "redis", port: 6379, protocol: "tcp" },
+      mongodb: { name: "mongodb", port: 27017, protocol: "tcp" },
       mqtt: { name: "mqtt", port: 1883, protocol: "tcp" }
     };
 

cmd/dashboard_test.go

@@ -188,6 +188,33 @@ func TestDashboardDiscoverReturnsProviderResults(t *testing.T) {
 	}
 }
 
+func TestDashboardDiscoverReturnsMongoDBHint(t *testing.T) {
+	previous := dashboardPortDiscoverer
+	dashboardPortDiscoverer = fakePortDiscoverer{items: []discoverItem{{Port: 27017, Address: "127.0.0.1", PID: 123, ProcessName: "mongod"}}}
+	t.Cleanup(func() { dashboardPortDiscoverer = previous })
+
+	req := httptest.NewRequest(http.MethodGet, "/api/discover?limit=1", nil)
+	req.Header.Set("X-Sealtun-Dashboard-Token", "secret")
+	rec := httptest.NewRecorder()
+	dashboardServer{token: "secret"}.serveAPI(rec, req)
+
+	if rec.Code != http.StatusOK {
+		t.Fatalf("expected 200, got %d body=%s", rec.Code, rec.Body.String())
+	}
+	var payload dashboardAPIResponse
+	if err := json.Unmarshal(rec.Body.Bytes(), &payload); err != nil {
+		t.Fatal(err)
+	}
+	data, ok := payload.Data.([]interface{})
+	if !ok || len(data) != 1 {
+		t.Fatalf("expected one discovery item, got %#v", payload.Data)
+	}
+	item, ok := data[0].(map[string]interface{})
+	if !ok || item["templateHint"] != "mongodb" || item["protocolHint"] != "tcp" {
+		t.Fatalf("unexpected discovery payload: %#v", payload.Data)
+	}
+}
+
 func TestDashboardWatchRequiresToken(t *testing.T) {
 	t.Parallel()
 

cmd/discover.go

@@ -139,6 +139,8 @@ func applyPortHints(item discoverItem) discoverItem {
 		item.ProtocolHint, item.TemplateHint, item.Confidence = tunnelprotocol.TCP, "postgres", 0.95
 	case 6379:
 		item.ProtocolHint, item.TemplateHint, item.Confidence = tunnelprotocol.TCP, "redis", 0.95
+	case 27017:
+		item.ProtocolHint, item.TemplateHint, item.Confidence = tunnelprotocol.TCP, "mongodb", 0.95
 	case 1883:
 		item.ProtocolHint, item.TemplateHint, item.Confidence = tunnelprotocol.TCP, "mqtt", 0.95
 	default:

cmd/discover_test.go

@@ -24,6 +24,7 @@ func TestDiscoverLocalPortsAppliesProtocolTemplateHints(t *testing.T) {
 		{Port: 3306, Address: "127.0.0.1"},
 		{Port: 5432, Address: "127.0.0.1"},
 		{Port: 6379, Address: "127.0.0.1"},
+		{Port: 27017, Address: "127.0.0.1"},
 		{Port: 1883, Address: "127.0.0.1"},
 		{Port: 3000, Address: "127.0.0.1"},
 	}})
@@ -54,6 +55,9 @@ func TestDiscoverLocalPortsAppliesProtocolTemplateHints(t *testing.T) {
 			t.Fatalf("unexpected hint for %d: %#v", port, item)
 		}
 	}
+	if item, ok := got[27017]; !ok || item.ProtocolHint != "tcp" || item.TemplateHint != "mongodb" || item.Command == "" {
+		t.Fatalf("unexpected mongodb hint: %#v", item)
+	}
 }
 
 func TestDiscoverLocalPortsFiltersAndLimits(t *testing.T) {

cmd/init.go

@@ -79,7 +79,7 @@ func init() {
 	rootCmd.AddCommand(initCmd)
 	initCmd.Flags().BoolVar(&initOpts.JSON, "json", false, "Output onboarding recommendation as JSON")
 	initCmd.Flags().BoolVar(&initOpts.Apply, "apply", false, "Create the recommended tunnel")
-	initCmd.Flags().StringVar(&initOpts.Protocol, "protocol", "auto", "Recommended protocol: auto, https, ssh, tcp, mysql, postgres, redis, or mqtt")
+	initCmd.Flags().StringVar(&initOpts.Protocol, "protocol", "auto", "Recommended protocol: auto, https, ssh, tcp, mysql, postgres, redis, mongodb, or mqtt")
 	initCmd.Flags().IntVar(&initOpts.Port, "port", 0, "Local port to use for the recommendation")
 	initCmd.Flags().StringVar(&initOpts.Name, "name", "", "Tunnel name for the generated sealtun.yaml")
 	initCmd.Flags().StringVar(&initOpts.Domain, "domain", "", "Custom domain for an HTTPS recommendation")
@@ -139,7 +139,7 @@ func initRecommendationFromOptions(opts initOptions, ports []discoverItem) (init
 	}
 	spec, ok := protocolTemplateSpec(kind)
 	if !ok {
-		return initRecommendation{}, fmt.Errorf("unsupported protocol %q; use auto, https, ssh, tcp, mysql, postgres, redis, or mqtt", opts.Protocol)
+		return initRecommendation{}, fmt.Errorf("unsupported protocol %q; use auto, https, ssh, tcp, mysql, postgres, redis, mongodb, or mqtt", opts.Protocol)
 	}
 	templateKind := canonicalInitTemplateKind(kind, spec)
 	if explicitKind && opts.Port == 0 {

cmd/init_test.go

@@ -90,6 +90,15 @@ func TestInitExplicitProtocolUsesTemplatePortUnlessPortProvided(t *testing.T) {
 	if rec.Template != "postgres" || rec.Protocol != "tcp" || rec.LocalPort != 5432 {
 		t.Fatalf("explicit postgres should use template default, got %#v", rec)
 	}
+
+	rec, err = initRecommendationFromOptions(initOptions{Protocol: "mongodb"}, []discoverItem{{Port: 1082, TemplateHint: "https", ProtocolHint: "https"}})
+	if err != nil {
+		t.Fatal(err)
+	}
+	if rec.Template != "mongodb" || rec.Protocol != "tcp" || rec.LocalPort != 27017 {
+		t.Fatalf("explicit mongodb should use template default, got %#v", rec)
+	}
+
 	rec, err = initRecommendationFromOptions(initOptions{Protocol: "postgres", Port: 15432}, []discoverItem{{Port: 1082, TemplateHint: "https", ProtocolHint: "https"}})
 	if err != nil {
 		t.Fatal(err)

cmd/template.go

@@ -25,7 +25,7 @@ var templatePort int
 var templateDomain string
 
 var templateCmd = &cobra.Command{
-	Use:          "template [https|ssh|tcp|mysql|postgres|redis|mqtt]",
+	Use:          "template [https|ssh|tcp|mysql|postgres|redis|mongodb|mqtt]",
 	Short:        "Generate protocol-specific Sealtun command and YAML templates",
 	Args:         cobra.ExactArgs(1),
 	SilenceUsage: true,
@@ -56,7 +56,7 @@ func buildProtocolTemplate(kind, name string, port int, domain string) (*protoco
 	kind = strings.ToLower(strings.TrimSpace(kind))
 	spec, ok := protocolTemplateSpec(kind)
 	if !ok {
-		return nil, fmt.Errorf("unsupported template %q; use https, ssh, tcp, mysql, postgres, redis, or mqtt", kind)
+		return nil, fmt.Errorf("unsupported template %q; use https, ssh, tcp, mysql, postgres, redis, mongodb, or mqtt", kind)
 	}
 	if name == "" {
 		name = spec.name
@@ -133,6 +133,8 @@ func protocolTemplateSpec(kind string) (templateSpec, bool) {
 		return templateSpec{name: "postgres", port: 5432, protocol: tunnelprotocol.TCP, description: "Expose a local PostgreSQL service over raw TCP."}, true
 	case "redis":
 		return templateSpec{name: "redis", port: 6379, protocol: tunnelprotocol.TCP, description: "Expose a local Redis service over raw TCP."}, true
+	case "mongodb":
+		return templateSpec{name: "mongodb", port: 27017, protocol: tunnelprotocol.TCP, description: "Expose a local MongoDB service over raw TCP."}, true
 	case "mqtt":
 		return templateSpec{name: "mqtt", port: 1883, protocol: tunnelprotocol.TCP, description: "Expose a local MQTT broker over raw TCP."}, true
 	default:

cmd/template_test.go

@@ -21,6 +21,24 @@ func TestBuildProtocolTemplateForPostgres(t *testing.T) {
 	}
 }
 
+func TestBuildProtocolTemplateForMongoDB(t *testing.T) {
+	tmpl, err := buildProtocolTemplate("mongodb", "", 0, "")
+	if err != nil {
+		t.Fatalf("buildProtocolTemplate returned error: %v", err)
+	}
+	if tmpl.Protocol != "tcp" || tmpl.Name != "mongodb" || tmpl.LocalPort != 27017 {
+		t.Fatalf("unexpected mongodb template: %#v", tmpl)
+	}
+	if !strings.Contains(tmpl.Command, "sealtun expose 27017 --protocol tcp") {
+		t.Fatalf("unexpected command: %s", tmpl.Command)
+	}
+	for _, want := range []string{"name: mongodb", "protocol: tcp", "localPort: 27017"} {
+		if !strings.Contains(tmpl.Config, want) {
+			t.Fatalf("expected %q in YAML, got:\n%s", want, tmpl.Config)
+		}
+	}
+}
+
 func TestBuildProtocolTemplateForHTTPSDomain(t *testing.T) {
 	tmpl, err := buildProtocolTemplate("https", "api", 8080, "API.Example.COM.")
 	if err != nil {
@@ -39,6 +57,11 @@ func TestBuildProtocolTemplateRejectsDomainForTCP(t *testing.T) {
 	if err == nil || !strings.Contains(err.Error(), "only supported for https") {
 		t.Fatalf("expected tcp domain rejection, got %v", err)
 	}
+
+	_, err = buildProtocolTemplate("mongodb", "", 0, "db.example.com")
+	if err == nil || !strings.Contains(err.Error(), "only supported for https") {
+		t.Fatalf("expected mongodb domain rejection, got %v", err)
+	}
 }
 
 func TestBuildProtocolTemplateRejectsUnknownKind(t *testing.T) {