enhancements to integration test (#188)

add prompts, resources and instructions to integration test

Author: nader-ziada

test/integration_test.go

@@ -5,6 +5,7 @@ import (
 	. "github.com/onsi/gomega"
 
 	"context"
+	"encoding/json"
 	"fmt"
 	"net/http"
 	"net/http/httptest"
@@ -41,10 +42,13 @@ var _ = Describe("Basic Integration", Ordered, func() {
 			go func() {
 				defer GinkgoRecover()
 				mcpServer := &mcpfile.MCPServer{
-					Name:    mcpConfig.Name,
-					Version: mcpConfig.Version,
-					Runtime: mcpConfig.Runtime,
-					Tools:   mcpConfig.Tools,
+					Name:         mcpConfig.Name,
+					Version:      mcpConfig.Version,
+					Runtime:      mcpConfig.Runtime,
+					Instructions: mcpConfig.Instructions,
+					Tools:        mcpConfig.Tools,
+					Prompts:      mcpConfig.Prompts,
+					Resources:    mcpConfig.Resources,
 				}
 				err := mcpserver.RunServer(ctx, mcpServer)
 				if err != nil && !strings.Contains(err.Error(), "Server closed") {
@@ -103,9 +107,11 @@ var _ = Describe("Basic Integration", Ordered, func() {
 				transport := &mcp.StreamableClientTransport{
 					Endpoint: mcpServerURL,
 				}
-				var err error
-				session, err = client.Connect(context.Background(), transport, nil)
-				Expect(err).NotTo(HaveOccurred())
+				Eventually(func() error {
+					var err error
+					session, err = client.Connect(context.Background(), transport, nil)
+					return err
+				}, 2*time.Second, 100*time.Millisecond).Should(Succeed())
 			})
 
 			AfterEach(func() {
@@ -121,6 +127,13 @@ var _ = Describe("Basic Integration", Ordered, func() {
 				Expect(initResult.ServerInfo).NotTo(BeNil())
 			})
 
+			It("should return server instructions", func() {
+				By("verifying instructions are present")
+				initResult := session.InitializeResult()
+				Expect(initResult).NotTo(BeNil())
+				Expect(initResult.Instructions).To(Equal("This is a test HTTP server with tools, prompts, and resources for integration testing."))
+			})
+
 			It("should list available tools", func() {
 				By("listing tools")
 				toolsResult, err := session.ListTools(context.Background(), &mcp.ListToolsParams{})
@@ -148,6 +161,53 @@ var _ = Describe("Basic Integration", Ordered, func() {
 				Expect(ok).To(BeTrue())
 				Expect(textResult.Text).To(MatchJSON(`{"users": [{"name": "John Doe", "email": "john@test_company.com"}]}`))
 			})
+
+			It("should list available prompts", func() {
+				By("listing prompts")
+				promptsResult, err := session.ListPrompts(context.Background(), &mcp.ListPromptsParams{})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(promptsResult.Prompts).To(HaveLen(1))
+				Expect(promptsResult.Prompts[0].Name).To(Equal("greeting_prompt"))
+			})
+
+			It("should successfully call prompts", func() {
+				By("calling prompt")
+				ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+				defer cancel()
+
+				result, err := session.GetPrompt(ctx, &mcp.GetPromptParams{
+					Name: "greeting_prompt",
+					Arguments: map[string]string{
+						"userName": "Alice",
+					},
+				})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(result).NotTo(BeNil())
+				Expect(result.Messages).To(HaveLen(1))
+				Expect(result.Messages[0].Content.(*mcp.TextContent).Text).To(ContainSubstring("Hello, Alice"))
+			})
+
+			It("should list available resources", func() {
+				By("listing resources")
+				resourcesResult, err := session.ListResources(context.Background(), &mcp.ListResourcesParams{})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(resourcesResult.Resources).To(HaveLen(1))
+				Expect(resourcesResult.Resources[0].Name).To(Equal("server_info"))
+			})
+
+			It("should successfully read resources", func() {
+				By("reading resource")
+				ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+				defer cancel()
+
+				result, err := session.ReadResource(ctx, &mcp.ReadResourceParams{
+					URI: fmt.Sprintf("%s/server/info", backendServer.URL),
+				})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(result).NotTo(BeNil())
+				Expect(result.Contents).To(HaveLen(1))
+				Expect(result.Contents[0].Text).To(MatchJSON(`{"server":"test-server","version":"1.0","status":"running"}`))
+			})
 		})
 	})
 
@@ -171,10 +231,12 @@ var _ = Describe("Basic Integration", Ordered, func() {
 			go func() {
 				defer GinkgoRecover()
 				mcpServer := &mcpfile.MCPServer{
-					Name:    mcpConfig.Name,
-					Version: mcpConfig.Version,
-					Runtime: mcpConfig.Runtime,
-					Tools:   mcpConfig.Tools,
+					Name:      mcpConfig.Name,
+					Version:   mcpConfig.Version,
+					Runtime:   mcpConfig.Runtime,
+					Tools:     mcpConfig.Tools,
+					Prompts:   mcpConfig.Prompts,
+					Resources: mcpConfig.Resources,
 				}
 				err := mcpserver.RunServer(ctx, mcpServer)
 				if err != nil && !strings.Contains(err.Error(), "Server closed") {
@@ -193,7 +255,7 @@ var _ = Describe("Basic Integration", Ordered, func() {
 			}
 		})
 
-		Describe("CLI Tool Execution", func() {
+		Describe("CLI Commands Execution", func() {
 			var (
 				client  *mcp.Client
 				session *mcp.ClientSession
@@ -210,9 +272,12 @@ var _ = Describe("Basic Integration", Ordered, func() {
 				transport := &mcp.StreamableClientTransport{
 					Endpoint: fmt.Sprintf("http://localhost:%d/mcp", mcpServerPort),
 				}
-				var err error
-				session, err = client.Connect(context.Background(), transport, nil)
-				Expect(err).NotTo(HaveOccurred())
+
+				Eventually(func() error {
+					var err error
+					session, err = client.Connect(context.Background(), transport, nil)
+					return err
+				}, 2*time.Second, 100*time.Millisecond).Should(Succeed())
 			})
 
 			AfterEach(func() {
@@ -240,13 +305,86 @@ var _ = Describe("Basic Integration", Ordered, func() {
 				Expect(ok).To(BeTrue())
 				Expect(textResult.Text).NotTo(BeEmpty())
 			})
+
+			It("should list available prompts", func() {
+				By("listing prompts")
+				promptsResult, err := session.ListPrompts(context.Background(), &mcp.ListPromptsParams{})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(promptsResult.Prompts).To(HaveLen(1))
+				Expect(promptsResult.Prompts[0].Name).To(Equal("greeting_prompt"))
+			})
+
+			It("should execute CLI prompt invocation successfully", func() {
+				By("calling CLI prompt")
+				ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+				defer cancel()
+
+				result, err := session.GetPrompt(ctx, &mcp.GetPromptParams{
+					Name: "greeting_prompt",
+					Arguments: map[string]string{
+						"userName": "Bob",
+					},
+				})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(result).NotTo(BeNil())
+				Expect(result.Messages).To(HaveLen(1))
+				Expect(result.Messages[0].Content.(*mcp.TextContent).Text).To(ContainSubstring("Hello, Bob"))
+			})
+
+			It("should list available resources", func() {
+				By("listing resources")
+				resourcesResult, err := session.ListResources(context.Background(), &mcp.ListResourcesParams{})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(resourcesResult.Resources).To(HaveLen(1))
+				Expect(resourcesResult.Resources[0].Name).To(Equal("server_info"))
+			})
+
+			It("should read CLI resource invocation successfully", func() {
+				By("reading CLI resource")
+				ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+				defer cancel()
+
+				result, err := session.ReadResource(ctx, &mcp.ReadResourceParams{
+					URI: "file://tmp/server-info.json",
+				})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(result).NotTo(BeNil())
+				Expect(result.Contents).To(HaveLen(1))
+				Expect(result.Contents[0].URI).To(Equal("file://tmp/server-info.json"))
+				Expect(result.Contents[0].Text).To(Equal("test-server-cli-server version 1.0 running\n"))
+			})
 		})
 	})
 })
 
 func createMockBackendServerIntegration() *httptest.Server {
 	By("creating mock backend server")
 	return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path == "/server/info" {
+			w.Header().Set("Content-Type", "application/json")
+			_, err := fmt.Fprintln(w, `{"server":"test-server","version":"1.0","status":"running"}`)
+			Expect(err).NotTo(HaveOccurred())
+			return
+		}
+		if r.URL.Path == "/prompts/greeting_prompt" && r.Method == "POST" {
+			// Read and parse the request body to extract userName
+			var requestBody map[string]interface{}
+			if err := json.NewDecoder(r.Body).Decode(&requestBody); err == nil {
+				if userName, ok := requestBody["userName"].(string); ok {
+					w.Header().Set("Content-Type", "application/json")
+					response := fmt.Sprintf(`{"message":"Hello, %s! Welcome to our system."}`, userName)
+					_, err := fmt.Fprintln(w, response)
+					Expect(err).NotTo(HaveOccurred())
+					return
+				}
+			}
+			// Fallback response if userName not found
+			w.Header().Set("Content-Type", "application/json")
+			_, err := fmt.Fprintln(w, `{"message":"Hello! Welcome to our system."}`)
+			Expect(err).NotTo(HaveOccurred())
+			return
+		}
+		// Default response for user endpoints
 		_, err := fmt.Fprintln(w, `{"users": [{"name": "John Doe", "email": "john@test_company.com"}]}`)
 		Expect(err).NotTo(HaveOccurred())
 	}))
@@ -259,6 +397,7 @@ func createBasicTestMCPConfig(backendURL string, port int) *mcpfile.MCPFile {
 mcpFileVersion: 0.1.0
 name: test-server
 version: "1.0"
+instructions: "This is a test HTTP server with tools, prompts, and resources for integration testing."
 runtime:
   streamableHttpConfig:
     port: %d
@@ -280,7 +419,31 @@ tools:
       http:
         url: "%s/{companyName}/users"
         method: GET
-`, port, backendURL)
+prompts:
+  - name: greeting_prompt
+    description: Generate a greeting message for a user
+    inputSchema:
+      type: object
+      properties:
+        userName:
+          type: string
+          description: Name of the user to greet
+      required:
+        - userName
+    invocation:
+      http:
+        method: POST
+        url: "%s/prompts/greeting_prompt"
+resources:
+  - name: server_info
+    description: Information about the server
+    uri: "%s/server/info"
+    mimeType: "application/json"
+    invocation:
+      http:
+        url: "%s/server/info"
+        method: GET
+`, port, backendURL, backendURL, backendURL, backendURL)
 
 	tmpfile, err := os.CreateTemp("", "mcp-basic-*.yaml")
 	Expect(err).NotTo(HaveOccurred())
@@ -331,6 +494,28 @@ tools:
     invocation:
       cli:
         command: "ls -la {path}"
+prompts:
+  - name: greeting_prompt
+    description: Generate a greeting message for a user
+    inputSchema:
+      type: object
+      properties:
+        userName:
+          type: string
+          description: Name of the user to greet
+      required:
+        - userName
+    invocation:
+      cli:
+        command: "echo 'Hello, {userName}! Welcome to our system.'"
+resources:
+  - name: server_info
+    description: Information about the server
+    uri: "file://tmp/server-info.json"
+    mimeType: "text/plain"
+    invocation:
+      cli:
+        command: "echo 'test-server-cli-server version 1.0 running'"
 `, port)
 
 	tmpfile, err := os.CreateTemp("", "mcp-cli-*.yaml")