@google-cloud/cloud-run-mcp 1.5.0 → 1.6.0

package/test/need-gcp/workflows/deployment-workflows.test.js

@@ -0,0 +1,100 @@
+/*
+Copyright 2025 Google LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import fs from 'fs/promises';
+import assert from 'node:assert';
+import { test, describe, before, after } from 'node:test';
+import path from 'path';
+
+import { deploy, deployImage } from '../../../lib/deployment/deployer.js';
+import {
+  cleanupProject,
+  setSourceDeployProjectPermissions,
+  setupProject,
+} from '../test-helpers.js';
+
+describe('Deployment workflows', () => {
+  let projectId;
+
+  before(async () => {
+    try {
+      projectId = await setupProject();
+      await setSourceDeployProjectPermissions(projectId);
+    } catch (err) {
+      console.error('Error during project creation and setup:', err);
+      throw err;
+    }
+  });
+
+  test('Scenario-1: Starting deployment of hello image...', async () => {
+    const configImageDeploy = {
+      projectId: projectId,
+      serviceName: 'hello-scenario',
+      region: 'europe-west1',
+      imageUrl: 'gcr.io/cloudrun/hello',
+    };
+    await deployImage(configImageDeploy);
+
+    console.log('Scenario-1: Deployment completed.');
+  });
+
+  test('Scenario-2: Starting deployment with invalid files...', async () => {
+    const configFailingBuild = {
+      projectId: projectId,
+      serviceName: 'example-failing-app',
+      region: 'europe-west1',
+      files: [
+        {
+          filename: 'main.txt',
+          content:
+            'This is not a valid application source file and should cause a build failure.',
+        },
+      ],
+    };
+    await assert.rejects(
+      deploy(configFailingBuild),
+      { message: /ERROR: failed to detect: no buildpacks participating/ },
+      'Deployment should have failed with a buildpack detection error'
+    );
+  });
+
+  test('Scenario-3: Starting deployment of Go app with file content...', async () => {
+    const mainGoContent = await fs.readFile(
+      path.resolve('example-sources-to-deploy/main.go'),
+      'utf-8'
+    );
+    const goModContent = await fs.readFile(
+      path.resolve('example-sources-to-deploy/go.mod'),
+      'utf-8'
+    );
+    const configGoWithContent = {
+      projectId: projectId,
+      serviceName: 'example-go-app-content',
+      region: 'europe-west1',
+      files: [
+        { filename: 'main.go', content: mainGoContent },
+        { filename: 'go.mod', content: goModContent },
+      ],
+    };
+    await deploy(configGoWithContent);
+    console.log('Scenario-3: Deployment completed.');
+  });
+
+  after(async () => {
+    // Clean up: delete the project created for tests
+    cleanupProject(projectId);
+  });
+});

package/tools/register-tools.js

@@ -15,9 +15,16 @@ limitations under the License.
 */
 
 import { z } from 'zod';
-import { listProjects, createProjectAndAttachBilling } from '../lib/gcp-projects.js';
-import { listServices, getService, getServiceLogs } from '../lib/cloud-run-services.js';
-import { deploy, deployImage } from '../lib/cloud-run-deploy.js';
+import {
+  listProjects,
+  createProjectAndAttachBilling,
+} from '../lib/cloud-api/projects.js';
+import {
+  listServices,
+  getService,
+  getServiceLogs,
+} from '../lib/cloud-api/run.js';
+import { deploy, deployImage } from '../lib/deployment/deployer.js';
 
 function createProgressCallback(sendNotification) {
   return (progress) => {
@@ -111,7 +118,7 @@ function registerCreateProjectTool(server, options) {
           content: [
             {
               type: 'text',
-              text: `Successfully created GCP project with ID "${result.projectId}". You can now use this project ID for deployments.`,
+              text: result.billingMessage,
             },
           ],
         };
@@ -134,19 +141,15 @@ function registerListServicesTool(server, options) {
   server.registerTool(
     'list_services',
     {
-      description: 'Lists Cloud Run services in a given project and region.',
+      description: 'Lists all Cloud Run services in a given project.',
       inputSchema: {
         project: z
           .string()
           .describe('Google Cloud project ID')
           .default(options.defaultProjectId),
-        region: z
-          .string()
-          .describe('Region where the services are located')
-          .default(options.defaultRegion),
       },
     },
-    gcpTool(options.gcpCredentialsAvailable, async ({ project, region }) => {
+    gcpTool(options.gcpCredentialsAvailable, async ({ project }) => {
       if (typeof project !== 'string') {
         return {
           content: [
@@ -157,29 +160,29 @@ function registerListServicesTool(server, options) {
           ],
         };
       }
-
       try {
-        const services = await listServices(project, region);
-        const serviceList = services
-          .map((s) => {
-            const serviceName = s.name.split('/').pop();
-            return `- ${serviceName} (URL: ${s.uri})`;
-          })
-          .join('\n');
-        return {
-          content: [
-            {
-              type: 'text',
-              text: `Services in project ${project} (location ${region}):\n${serviceList}`,
-            },
-          ],
-        };
+        const allServices = await listServices(project);
+        const content = [];
+        for (const region of Object.keys(allServices)) {
+          const serviceList = allServices[region];
+          const servicesText = serviceList
+            .map((s) => {
+              const serviceName = s.name.split('/').pop();
+              return `- ${serviceName} (URL: ${s.uri})`;
+            })
+            .join('\n');
+          content.push({
+            type: 'text',
+            text: `Services in project ${project} (location ${region}):\n${servicesText}`,
+          });
+        }
+        return { content };
       } catch (error) {
         return {
           content: [
             {
               type: 'text',
-              text: `Error listing services for project ${project} (region ${region}): ${error.message}`,
+              text: `Error listing services for project ${project}: ${error.message}`,
             },
           ],
         };
@@ -209,53 +212,56 @@ function registerGetServiceTool(server, options) {
           .default(options.defaultServiceName),
       },
     },
-    gcpTool(options.gcpCredentialsAvailable, async ({ project, region, service }) => {
-      if (typeof project !== 'string') {
-        return {
-          content: [
-            { type: 'text', text: 'Error: Project ID must be provided.' },
-          ],
-        };
-      }
-      if (typeof service !== 'string') {
-        return {
-          content: [
-            { type: 'text', text: 'Error: Service name must be provided.' },
-          ],
-        };
-      }
-      try {
-        const serviceDetails = await getService(project, region, service);
-        if (serviceDetails) {
+    gcpTool(
+      options.gcpCredentialsAvailable,
+      async ({ project, region, service }) => {
+        if (typeof project !== 'string') {
           return {
             content: [
-              {
-                type: 'text',
-                text: `Name: ${service}\nRegion: ${region}\nProject: ${project}\nURL: ${serviceDetails.uri}\nLast deployed by: ${serviceDetails.lastModifier}`,
-              },
+              { type: 'text', text: 'Error: Project ID must be provided.' },
+            ],
+          };
+        }
+        if (typeof service !== 'string') {
+          return {
+            content: [
+              { type: 'text', text: 'Error: Service name must be provided.' },
             ],
           };
-        } else {
+        }
+        try {
+          const serviceDetails = await getService(project, region, service);
+          if (serviceDetails) {
+            return {
+              content: [
+                {
+                  type: 'text',
+                  text: `Name: ${service}\nRegion: ${region}\nProject: ${project}\nURL: ${serviceDetails.uri}\nLast deployed by: ${serviceDetails.lastModifier}`,
+                },
+              ],
+            };
+          } else {
+            return {
+              content: [
+                {
+                  type: 'text',
+                  text: `Service ${service} not found in project ${project} (region ${region}).`,
+                },
+              ],
+            };
+          }
+        } catch (error) {
           return {
             content: [
               {
                 type: 'text',
-                text: `Service ${service} not found in project ${project} (region ${region}).`,
+                text: `Error getting service ${service} in project ${project} (region ${region}): ${error.message}`,
               },
             ],
           };
         }
-      } catch (error) {
-        return {
-          content: [
-            {
-              type: 'text',
-              text: `Error getting service ${service} in project ${project} (region ${region}): ${error.message}`,
-            },
-          ],
-        };
       }
-    })
+    )
   );
 }
 
@@ -281,46 +287,49 @@ function registerGetServiceLogTool(server, options) {
           .default(options.defaultServiceName),
       },
     },
-    gcpTool(options.gcpCredentialsAvailable, async ({ project, region, service }) => {
-      let allLogs = [];
-      let requestOptions;
-      try {
-        do {
-          // Fetch a page of logs
-          const response = await getServiceLogs(
-            project,
-            region,
-            service,
-            requestOptions
-          );
+    gcpTool(
+      options.gcpCredentialsAvailable,
+      async ({ project, region, service }) => {
+        let allLogs = [];
+        let requestOptions;
+        try {
+          do {
+            // Fetch a page of logs
+            const response = await getServiceLogs(
+              project,
+              region,
+              service,
+              requestOptions
+            );
 
-          if (response.logs) {
-            allLogs.push(response.logs);
-          }
+            if (response.logs) {
+              allLogs.push(response.logs);
+            }
 
-          // Set the requestOptions incl pagintion token for the next iteration
+            // Set the requestOptions incl pagintion token for the next iteration
 
-          requestOptions = response.requestOptions;
-        } while (requestOptions); // Continue as long as there is a next page token
-        return {
-          content: [
-            {
-              type: 'text',
-              text: allLogs.join('\n'),
-            },
-          ],
-        };
-      } catch (error) {
-        return {
-          content: [
-            {
-              type: 'text',
-              text: `Error getting Logs for service ${service} in project ${project} (region ${region}): ${error.message}`,
-            },
-          ],
-        };
+            requestOptions = response.requestOptions;
+          } while (requestOptions); // Continue as long as there is a next page token
+          return {
+            content: [
+              {
+                type: 'text',
+                text: allLogs.join('\n'),
+              },
+            ],
+          };
+        } catch (error) {
+          return {
+            content: [
+              {
+                type: 'text',
+                text: `Error getting Logs for service ${service} in project ${project} (region ${region}): ${error.message}`,
+              },
+            ],
+          };
+        }
       }
-    })
+    )
   );
 }
 

package/tools/tools.js

@@ -27,10 +27,7 @@ import {
   registerDeployContainerImageTool,
 } from './register-tools.js';
 
-export const registerTools = (
-  server,
-  options = {}
-) => {
+export const registerTools = (server, options = {}) => {
   registerListProjectsTool(server, options);
   registerCreateProjectTool(server, options);
   registerListServicesTool(server, options);
@@ -41,10 +38,7 @@ export const registerTools = (
   registerDeployContainerImageTool(server, options);
 };
 
-export const registerToolsRemote = (
-  server,
-  options = {}
-) => {
+export const registerToolsRemote = (server, options = {}) => {
   // For remote, use the same registration functions but with effective project/region passed in options
   registerListServicesTool(server, options);
   registerGetServiceTool(server, options);
@@ -52,4 +46,3 @@ export const registerToolsRemote = (
   registerDeployFileContentsTool(server, options);
   registerDeployContainerImageTool(server, options);
 };
-