chore: add atlas tests (#83)

Author: fmenezes

.github/workflows/code_health.yaml

@@ -20,6 +20,20 @@ jobs:
       - name: Run style check
         run: npm run check
 
+  check-generate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Run style check
+        run: npm run generate
+
   run-tests:
     strategy:
       matrix:
@@ -29,12 +43,6 @@ jobs:
     steps:
       - uses: GitHubSecurityLab/actions-permissions/monitor@v1
         if: matrix.os != 'windows-latest'
-      - name: Install keyring deps on Ubuntu
-        if: matrix.os == 'ubuntu-latest'
-        run: |
-          sudo apt update -y
-          sudo apt install -y gnome-keyring libdbus-1-dev
-
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
@@ -43,6 +51,10 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Run tests
+        env:
+          MDB_MCP_API_CLIENT_ID: ${{ secrets.TEST_ATLAS_CLIENT_ID }}
+          MDB_MCP_API_CLIENT_SECRET: ${{ secrets.TEST_ATLAS_CLIENT_SECRET }}
+          MDB_MCP_API_BASE_URL: ${{ vars.TEST_ATLAS_BASE_URL }}
         run: npm test
       - name: Coveralls GitHub Action
         uses: coverallsapp/[email protected]

README.md

@@ -98,12 +98,14 @@ You may experiment asking `Can you connect to my mongodb instance?`.
 
 #### MongoDB Atlas Tools
 
-- `atlas-list-clusters` - Lists MongoDB Atlas clusters
+- `atlas-list-orgs` - Lists MongoDB Atlas organizations
 - `atlas-list-projects` - Lists MongoDB Atlas projects
+- `atlas-create-project` - Creates a new MongoDB Atlas project
+- `atlas-list-clusters` - Lists MongoDB Atlas clusters
 - `atlas-inspect-cluster` - Inspect a specific MongoDB Atlas cluster
 - `atlas-create-free-cluster` - Create a free MongoDB Atlas cluster
-- `atlas-create-access-list` - Configure IP/CIDR access list for MongoDB Atlas clusters
 - `atlas-inspect-access-list` - Inspect IP/CIDR ranges with access to MongoDB Atlas clusters
+- `atlas-create-access-list` - Configure IP/CIDR access list for MongoDB Atlas clusters
 - `atlas-list-db-users` - List MongoDB Atlas database users
 - `atlas-create-db-user` - List MongoDB Atlas database users
 

jest.config.js

@@ -3,6 +3,7 @@ export default {
     preset: "ts-jest/presets/default-esm",
     testEnvironment: "node",
     extensionsToTreatAsEsm: [".ts"],
+    testTimeout: 3600000, // 3600 seconds
     moduleNameMapper: {
         "^(\\.{1,2}/.*)\\.js$": "$1", // Map .js to real paths for ESM
     },

package-lock.json

@@ -2,18 +2,22 @@ import fs from "fs/promises";
 import { OpenAPIV3_1 } from "openapi-types";
 import argv from "yargs-parser";
 
-function findParamFromRef(ref: string, openapi: OpenAPIV3_1.Document): OpenAPIV3_1.ParameterObject {
+function findObjectFromRef<T>(obj: T | OpenAPIV3_1.ReferenceObject, openapi: OpenAPIV3_1.Document): T {
+    const ref = (obj as OpenAPIV3_1.ReferenceObject).$ref;
+    if (ref === undefined) {
+        return obj as T;
+    }
     const paramParts = ref.split("/");
     paramParts.shift(); // Remove the first part which is always '#'
-    let param: any = openapi; // eslint-disable-line @typescript-eslint/no-explicit-any
+    let foundObj: any = openapi; // eslint-disable-line @typescript-eslint/no-explicit-any
     while (true) {
         const part = paramParts.shift();
         if (!part) {
             break;
         }
-        param = param[part];
+        foundObj = foundObj[part];
     }
-    return param;
+    return foundObj as T;
 }
 
 async function main() {
@@ -32,6 +36,7 @@ async function main() {
         operationId: string;
         requiredParams: boolean;
         tag: string;
+        hasResponseBody: boolean;
     }[] = [];
 
     const openapi = JSON.parse(specFile) as OpenAPIV3_1.Document;
@@ -44,13 +49,27 @@ async function main() {
             }
 
             let requiredParams = !!operation.requestBody;
+            let hasResponseBody = false;
+            for (const code in operation.responses) {
+                try {
+                    const httpCode = parseInt(code, 10);
+                    if (httpCode >= 200 && httpCode < 300) {
+                        const response = operation.responses[code];
+                        const responseObject = findObjectFromRef(response, openapi);
+                        if (responseObject.content) {
+                            for (const contentType in responseObject.content) {
+                                const content = responseObject.content[contentType];
+                                hasResponseBody = !!content.schema;
+                            }
+                        }
+                    }
+                } catch {
+                    continue;
+                }
+            }
 
             for (const param of operation.parameters || []) {
-                const ref = (param as OpenAPIV3_1.ReferenceObject).$ref as string | undefined;
-                let paramObject: OpenAPIV3_1.ParameterObject = param as OpenAPIV3_1.ParameterObject;
-                if (ref) {
-                    paramObject = findParamFromRef(ref, openapi);
-                }
+                const paramObject = findObjectFromRef(param, openapi);
                 if (paramObject.in === "path") {
                     requiredParams = true;
                 }
@@ -61,27 +80,45 @@ async function main() {
                 method: method.toUpperCase(),
                 operationId: operation.operationId || "",
                 requiredParams,
+                hasResponseBody,
                 tag: operation.tags[0],
             });
         }
     }
 
     const operationOutput = operations
         .map((operation) => {
-            const { operationId, method, path, requiredParams } = operation;
+            const { operationId, method, path, requiredParams, hasResponseBody } = operation;
             return `async ${operationId}(options${requiredParams ? "" : "?"}: FetchOptions<operations["${operationId}"]>) {
-    const { data } = await this.client.${method}("${path}", options);
-    return data;
-}
+    ${hasResponseBody ? `const { data } = ` : ``}await this.client.${method}("${path}", options);
+    ${
+        hasResponseBody
+            ? `return data;
+`
+            : ``
+    }}
 `;
         })
         .join("\n");
 
     const templateFile = (await fs.readFile(file, "utf8")) as string;
-    const output = templateFile.replace(
-        /\/\/ DO NOT EDIT\. This is auto-generated code\.\n.*\/\/ DO NOT EDIT\. This is auto-generated code\./g,
-        operationOutput
-    );
+    const templateLines = templateFile.split("\n");
+    let outputLines: string[] = [];
+    let addLines = true;
+    for (const line of templateLines) {
+        if (line.includes("DO NOT EDIT. This is auto-generated code.")) {
+            addLines = !addLines;
+            outputLines.push(line);
+            if (!addLines) {
+                outputLines.push(operationOutput);
+            }
+            continue;
+        }
+        if (addLines) {
+            outputLines.push(line);
+        }
+    }
+    const output = outputLines.join("\n");
 
     await fs.writeFile(file, output, "utf8");
 }

scripts/apply.ts

@@ -22,14 +22,19 @@ function filterOpenapi(openapi: OpenAPIV3_1.Document): OpenAPIV3_1.Document {
         "listOrganizations",
         "getProject",
         "createProject",
+        "deleteProject",
         "listClusters",
         "getCluster",
         "createCluster",
+        "deleteCluster",
         "listClustersForAllProjects",
         "createDatabaseUser",
+        "deleteDatabaseUser",
         "listDatabaseUsers",
         "listProjectIpAccessLists",
         "createProjectIpAccessList",
+        "deleteProjectIpAccessList",
+        "listOrganizationProjects",
     ];
 
     const filteredPaths = {};

scripts/filter.ts

@@ -117,8 +117,8 @@ export class ApiClient {
     }
 
     // DO NOT EDIT. This is auto-generated code.
-    async listOrganizations(options?: FetchOptions<operations["listOrganizations"]>) {
-        const { data } = await this.client.GET("/api/atlas/v2/orgs", options);
+    async listClustersForAllProjects(options?: FetchOptions<operations["listClustersForAllProjects"]>) {
+        const { data } = await this.client.GET("/api/atlas/v2/clusters", options);
         return data;
     }
 
@@ -132,16 +132,29 @@ export class ApiClient {
         return data;
     }
 
-    async listClustersForAllProjects(options?: FetchOptions<operations["listClustersForAllProjects"]>) {
-        const { data } = await this.client.GET("/api/atlas/v2/clusters", options);
-        return data;
+    async deleteProject(options: FetchOptions<operations["deleteProject"]>) {
+        await this.client.DELETE("/api/atlas/v2/groups/{groupId}", options);
     }
 
     async getProject(options: FetchOptions<operations["getProject"]>) {
         const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}", options);
         return data;
     }
 
+    async listProjectIpAccessLists(options: FetchOptions<operations["listProjectIpAccessLists"]>) {
+        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/accessList", options);
+        return data;
+    }
+
+    async createProjectIpAccessList(options: FetchOptions<operations["createProjectIpAccessList"]>) {
+        const { data } = await this.client.POST("/api/atlas/v2/groups/{groupId}/accessList", options);
+        return data;
+    }
+
+    async deleteProjectIpAccessList(options: FetchOptions<operations["deleteProjectIpAccessList"]>) {
+        await this.client.DELETE("/api/atlas/v2/groups/{groupId}/accessList/{entryValue}", options);
+    }
+
     async listClusters(options: FetchOptions<operations["listClusters"]>) {
         const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/clusters", options);
         return data;
@@ -152,13 +165,12 @@ export class ApiClient {
         return data;
     }
 
-    async listProjectIpAccessLists(options: FetchOptions<operations["listProjectIpAccessLists"]>) {
-        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/accessList", options);
-        return data;
+    async deleteCluster(options: FetchOptions<operations["deleteCluster"]>) {
+        await this.client.DELETE("/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", options);
     }
 
-    async createProjectIpAccessList(options: FetchOptions<operations["createProjectIpAccessList"]>) {
-        const { data } = await this.client.POST("/api/atlas/v2/groups/{groupId}/accessList", options);
+    async getCluster(options: FetchOptions<operations["getCluster"]>) {
+        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", options);
         return data;
     }
 
@@ -172,9 +184,19 @@ export class ApiClient {
         return data;
     }
 
-    async getCluster(options: FetchOptions<operations["getCluster"]>) {
-        const { data } = await this.client.GET("/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", options);
+    async deleteDatabaseUser(options: FetchOptions<operations["deleteDatabaseUser"]>) {
+        await this.client.DELETE("/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}", options);
+    }
+
+    async listOrganizations(options?: FetchOptions<operations["listOrganizations"]>) {
+        const { data } = await this.client.GET("/api/atlas/v2/orgs", options);
         return data;
     }
+
+    async listOrganizationProjects(options: FetchOptions<operations["listOrganizationProjects"]>) {
+        const { data } = await this.client.GET("/api/atlas/v2/orgs/{orgId}/groups", options);
+        return data;
+    }
+
     // DO NOT EDIT. This is auto-generated code.
 }