@nbakka/mcp-appium 2.0.53 → 2.0.54

package/lib/server.js

@@ -580,11 +580,11 @@ tool(
 
 
 // ----------------------
-// TOOL 2: Upload PDF to OpenAI with Jira Info
+// TOOL: Generate Manual Test Cases from PDF + JIRA
 // ----------------------
 tool(
   "upload_pdf_to_openai",
-  "Upload a PDF to OpenAI API along with Jira summary & description",
+  "Generate manual test cases by analyzing PDF design with JIRA requirements",
   {
     jiraSummary: zod_1.z.string().describe("Jira issue summary"),
     jiraDescription: zod_1.z.string().describe("Jira issue description"),
@@ -601,28 +601,277 @@ tool(
 
       const client = new OpenAI({ apiKey: openaiKey });
 
-      // Read PDF file
-      const pdfData = await fs.readFile(pdfPath);
+      // Validate file exists
+      if (!await fs.access(pdfPath).then(() => true).catch(() => false)) {
+        throw new Error(`PDF file not found at path: ${pdfPath}`);
+      }
+
+      const stats = await fs.stat(pdfPath);
+      const fileName = path.basename(pdfPath);
 
-      // Upload file to OpenAI
+      console.log(`📄 Processing ${fileName} for test case generation...`);
+
+      // Upload PDF to OpenAI
       const fileUpload = await client.files.create({
-        file: new Blob([pdfData], { type: "application/pdf" }),
+        file: fs.createReadStream(pdfPath),
         purpose: "assistants"
       });
 
-      // Create a random prompt with Jira details
-      const prompt = `Analyze this design based on Jira details:\n\nSummary: ${jiraSummary}\nDescription: ${jiraDescription}\n\nProvide suggestions and insights.`;
+      console.log(`✅ PDF uploaded: ${fileUpload.id}`);
+
+      // Create specialized assistant for test case generation
+      const assistant = await client.beta.assistants.create({
+        name: "Manual Test Case Generator",
+        instructions: `You are an expert QA engineer specializing in creating comprehensive manual test cases.
+        You analyze design documents and requirements to generate detailed, actionable test cases that cover:
+        - Functional testing scenarios
+        - UI/UX validation tests
+        - Edge cases and negative scenarios
+        - Cross-browser/device compatibility tests
+        - Accessibility testing scenarios`,
+        model: "gpt-4o", // Best model for complex reasoning
+        tools: [{ type: "file_search" }],
+        tool_resources: {
+          file_search: {
+            vector_stores: [{
+              file_ids: [fileUpload.id]
+            }]
+          }
+        }
+      });
+
+      // Create comprehensive test case generation prompt
+      const testCasePrompt = `
+**JIRA REQUIREMENTS:**
+**Summary:** ${jiraSummary}
+**Description:** ${jiraDescription}
+
+**TASK:** Generate comprehensive manual test cases based on the attached PDF design and above JIRA requirements.
+
+**OUTPUT FORMAT REQUIRED:**
+Please structure your response as follows:
+
+## MANUAL TEST CASES
+
+### 1. FUNCTIONAL TEST CASES
+**TC-F-001: [Test Case Title]**
+- **Objective:** What this test validates
+- **Preconditions:** Setup required before testing
+- **Test Steps:**
+  1. Step 1 action
+  2. Step 2 action
+  3. Step 3 action
+- **Expected Result:** What should happen
+- **Priority:** High/Medium/Low
+
+### 2. UI/UX TEST CASES
+**TC-UI-001: [Test Case Title]**
+[Same format as above]
+
+### 3. EDGE CASE & NEGATIVE TEST CASES
+**TC-E-001: [Test Case Title]**
+[Same format as above]
+
+### 4. COMPATIBILITY TEST CASES
+**TC-C-001: [Test Case Title]**
+[Same format as above]
+
+### 5. ACCESSIBILITY TEST CASES
+**TC-A-001: [Test Case Title]**
+[Same format as above]
+
+**IMPORTANT GUIDELINES:**
+1. Create 15-25 test cases total covering all aspects
+2. Reference specific UI elements from the PDF design
+3. Include both positive and negative test scenarios
+4. Consider different user roles if applicable
+5. Include performance and usability aspects
+6. Make test steps specific and actionable
+7. Consider mobile/responsive design if shown in PDF
+8. Include data validation test cases
+9. Cover error handling scenarios
+10. Include integration testing if multiple components interact
+
+Generate detailed test cases now based on the PDF design and JIRA requirements.
+`;
+
+      // Create thread and run analysis
+      const thread = await client.beta.threads.create({
+        messages: [
+          {
+            role: "user",
+            content: testCasePrompt
+          }
+        ]
+      });
+
+      console.log(`🔄 Generating test cases...`);
+
+      const run = await client.beta.threads.runs.create(thread.id, {
+        assistant_id: assistant.id,
+      });
+
+      // Wait for completion with progress tracking
+      let runStatus = await client.beta.threads.runs.retrieve(thread.id, run.id);
+      let attempts = 0;
+      const maxAttempts = 60; // 60 seconds for complex test case generation
+
+      while (runStatus.status !== 'completed' && attempts < maxAttempts) {
+        if (runStatus.status === 'failed') {
+          throw new Error(`Test case generation failed: ${runStatus.last_error?.message}`);
+        }
+
+        if (attempts % 5 === 0) {
+          console.log(`⏳ Still generating... (${attempts}s elapsed)`);
+        }
+
+        await new Promise(resolve => setTimeout(resolve, 1000));
+        runStatus = await client.beta.threads.runs.retrieve(thread.id, run.id);
+        attempts++;
+      }
+
+      if (runStatus.status !== 'completed') {
+        throw new Error('Test case generation timed out after 60 seconds');
+      }
+
+      // Get the generated test cases
+      const messages = await client.beta.threads.messages.list(thread.id);
+      const testCases = messages.data
+        .filter(msg => msg.role === 'assistant')
+        .map(msg => msg.content[0]?.text?.value)
+        .join('\n\n');
+
+      // Parse and structure the response
+      const testCaseCount = (testCases.match(/\*\*TC-/g) || []).length;
+
+      // Clean up assistant
+      try {
+        await client.beta.assistants.del(assistant.id);
+      } catch (cleanupError) {
+        console.warn('⚠️ Assistant cleanup failed:', cleanupError.message);
+      }
+
+      // Save test cases to file for easy reference
+      const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
+      const outputFileName = `test_cases_${timestamp.substring(0, 19)}.md`;
+      const outputPath = path.join(path.dirname(pdfPath), outputFileName);
+
+      const fileContent = `# Manual Test Cases
+Generated on: ${new Date().toLocaleString()}
+
+## Source Information
+- **JIRA Summary:** ${jiraSummary}
+- **JIRA Description:** ${jiraDescription}
+- **Design File:** ${fileName}
+- **Total Test Cases:** ${testCaseCount}
+
+---
+
+${testCases}
+
+---
+
+## Test Execution Notes
+- Execute test cases in the order listed
+- Log defects with screenshots when issues found
+- Update test results in your test management tool
+- Verify on multiple browsers/devices for compatibility tests
+`;
+
+      await fs.writeFile(outputPath, fileContent, 'utf-8');
+
+      console.log(`✅ Test cases generated and saved!`);
 
       return {
-        message: "✅ PDF uploaded to OpenAI successfully!",
-        fileId: fileUpload.id,
-        promptUsed: prompt
+        success: true,
+        message: `✅ Successfully generated ${testCaseCount} manual test cases!`,
+        results: {
+          testCases: testCases,
+          summary: {
+            totalTestCases: testCaseCount,
+            categories: [
+              "Functional Test Cases",
+              "UI/UX Test Cases",
+              "Edge Case & Negative Test Cases",
+              "Compatibility Test Cases",
+              "Accessibility Test Cases"
+            ],
+            generatedFrom: {
+              jiraSummary: jiraSummary,
+              designFile: fileName,
+              fileSize: `${(stats.size / 1024).toFixed(2)} KB`
+            }
+          },
+          outputs: {
+            savedToFile: outputPath,
+            fileName: outputFileName,
+            generatedAt: new Date().toISOString()
+          },
+          execution: {
+            processingTime: `${attempts} seconds`,
+            model: "gpt-4o",
+            pdfAnalyzed: true
+          }
+        }
       };
+
     } catch (err) {
-      return `❌ Error uploading PDF to OpenAI: ${err.message}`;
+      console.error("❌ Test Case Generation Error:", err);
+
+      let errorMessage = "❌ Failed to generate test cases: ";
+
+      if (err.message?.includes('quota')) {
+        errorMessage += "OpenAI quota exceeded. Check billing.";
+      } else if (err.message?.includes('timeout')) {
+        errorMessage += "Generation took too long. Try with smaller PDF.";
+      } else if (err.message?.includes('file')) {
+        errorMessage += "PDF processing error. Check file format.";
+      } else if (err.message?.includes('API key')) {
+        errorMessage += "Invalid OpenAI API key.";
+      } else {
+        errorMessage += err.message || "Unknown error occurred.";
+      }
+
+      return {
+        success: false,
+        message: errorMessage,
+        error: {
+          message: err.message,
+          timestamp: new Date().toISOString(),
+          attempted: {
+            jiraSummary: jiraSummary,
+            pdfPath: pdfPath
+          }
+        },
+        troubleshooting: [
+          "Verify OpenAI API key in ~/Desktop/openai.json",
+          "Check PDF file exists and is readable",
+          "Ensure sufficient OpenAI credits",
+          "Try with smaller PDF if timeout occurs"
+        ]
+      };
     }
   }
 );
+
+// ----------------------
+// USAGE EXAMPLE
+// ----------------------
+
+/*
+const result = await tools.uploadPdfToOpenai({
+  jiraSummary: "User Login Page Implementation",
+  jiraDescription: "Create a responsive login page with email/password fields, remember me checkbox, forgot password link, and social login options. Must support mobile and desktop views.",
+  pdfPath: "/path/to/login-design.pdf"
+});
+
+// Expected Output:
+// - 15-25 detailed manual test cases
+// - Categories: Functional, UI/UX, Edge Cases, Compatibility, Accessibility
+// - Saved to markdown file for easy reference
+// - Structured format ready for test management tools
+*/
+
     return server;
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nbakka/mcp-appium",
-  "version": "2.0.53",
+  "version": "2.0.54",
   "description": "Appium MCP",
   "engines": {
     "node": ">=18"