feat: windows compatibility for gcloud mcp

.github/workflows/presubmit.yml

@@ -56,9 +56,16 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Run tests
-        run: |
-          npm run test:i
+      - name: Run unit tests
+        run: npm run test:i
+
+      - name: 'Set up Cloud SDK'
+        uses: 'google-github-actions/setup-gcloud@aa5489c8933f4cc7a4f7d45035b3b1440c9c10db' # v3
+        with:
+          version: '>= 530.0.0'
+
+      - name: Run integration tests
+        run: npm run test:integration --workspace packages/gcloud-mcp
 
   coverage:
     if: github.actor != 'dependabot[bot]'

.gitignore

@@ -25,6 +25,7 @@ Thumbs.db
 coverage/
 packages/*/coverage/
 junit.xml
+junit.integration.xml
 packages/*/junit.xml
 
 # Ignore package-lock.json files in subdirectories

packages/gcloud-mcp/package.json

@@ -11,6 +11,7 @@
   "scripts": {
     "build": "tsc --noemit && node build.js",
     "test": "vitest run",
+    "test:integration": "vitest run --config vitest.config.integration.ts",
     "start": "node dist/bundle.js",
     "lint": "prettier --check . && eslint . --max-warnings 0",
     "fix": "prettier --write . && eslint . --fix",

packages/gcloud-mcp/src/gcloud-executor.ts

@@ -0,0 +1,116 @@
+/**
+ * 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
+ *
+ *	http://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 * as child_process from 'child_process';
+import { getWindowsCloudSDKSettingsAsync } from './windows_gcloud_utils.js';
+import * as path from 'path';
+
+export const isWindows = (): boolean => process.platform === 'win32';
+
+export interface GcloudExecutionResult {
+  code: number | null;
+  stdout: string;
+  stderr: string;
+}
+
+export interface GcloudExecutor {
+  execute: (args: string[]) => Promise<GcloudExecutionResult>
+}
+
+export const findExecutable = async (): Promise<GcloudExecutor> => {
+  const executor = await createExecutor();
+  return {
+    execute: async (args: string[]): Promise<GcloudExecutionResult> =>
+        new Promise(async (resolve, reject) => {
+            let stdout = '';
+            let stderr = '';
+
+            const gcloud = executor.execute(args);
+
+            gcloud.stdout.on('data', (data) => {
+            stdout += data.toString();
+            });
+            gcloud.stderr.on('data', (data) => {
+            stderr += data.toString();
+            });
+
+            gcloud.on('close', (code) => {
+            // All responses from gcloud, including non-zero codes.
+            resolve({ code, stdout, stderr });
+            });
+            gcloud.on('error', (err) => {
+            // Process failed to start. gcloud isn't able to be invoked.
+            reject(err);
+            });
+        })
+  }
+}
+
+const isAvailable = (): Promise<boolean> =>
+  new Promise((resolve) => {
+    const which = child_process.spawn(isWindows() ? 'where' : 'which', ['gcloud']);
+    which.on('close', (code) => {
+      resolve(code === 0);
+    });
+    which.on('error', () => {
+      resolve(false);
+    });
+  });
+
+const createExecutor = async () => {
+  if(!await isAvailable()) {
+    throw Error('gcloud executable not found');
+  }
+  if (isWindows()) {
+    return await createWindowsExecutor();
+  }
+  return createDirectExecutor();
+}
+
+/** Creates an executor that directly invokes the gcloud binary on the current PATH. */
+const createDirectExecutor = () => ({
+    execute: (args: string[]) => child_process.spawn('gcloud', args, {
+      stdio: ['ignore', 'pipe', 'pipe'],
+    })
+});
+
+const createWindowsExecutor = async () => {
+    const settings = await getWindowsCloudSDKSettingsAsync();
+
+    if (settings == null || settings.noWorkingPythonFound) {
+        throw Error('no working Python installation found for Windows gcloud execution.');
+    }
+
+    const windowsPathForGcloudPy = path.join(
+          settings.cloudSdkRootDir,
+          'lib',
+          'gcloud.py',
+        );
+
+    const pythonPath = path.normalize(
+        settings.cloudSdkPython,
+    );
+
+    return {
+        execute: (args: string[]) => child_process.spawn(pythonPath, [
+            ...settings.cloudSdkPythonArgsList,
+            windowsPathForGcloudPy,
+            ...args
+        ], {
+            stdio: ['ignore', 'pipe', 'pipe']
+        })
+    }
+}

packages/gcloud-mcp/src/gcloud.integration.test.ts

@@ -0,0 +1,91 @@
+/**
+ * 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
+ *
+ *	http://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 { test, expect, assert } from 'vitest';
+import * as gcloud from './gcloud.js';
+
+test('gcloud is available', async () => {
+  const result = await gcloud.isAvailable();
+  expect(result).toBe(true);
+});
+
+test('can invoke gcloud to lint a command', async () => {
+  const result = await gcloud.lint('compute instances list');
+  assert(result.success);
+  expect(result.parsedCommand).toBe('compute instances list');
+}, 10000);
+
+test('cannot inject a command by appending arguments', async () => {
+  const result = await gcloud.invoke(['config', 'list', '&&', 'echo', 'asdf']);
+  expect(result.stdout).not.toContain('asdf');
+  expect(result.code).toBeGreaterThan(0);
+}, 10000);
+
+test('cannot inject a command by appending command', async () => {
+  const result = await gcloud.invoke(['config', 'list', '&&', 'echo asdf']);
+  expect(result.code).toBeGreaterThan(0);
+}, 10000);
+
+test('cannot inject a command with a final argument', async () => {
+  const result = await gcloud.invoke(['config', 'list', '&& echo asdf']);
+  expect(result.code).toBeGreaterThan(0);
+}, 10000);
+
+test('cannot inject a command with a single argument', async () => {
+  const result = await gcloud.invoke(['config list && echo asdf']);
+  expect(result.code).toBeGreaterThan(0);
+}, 10000);
+
+test('can invoke windows gcloud when there are multiple python args', async () => {
+  // Set the environment variables correctly and then reimport gcloud to force it to reload
+  process.env['CLOUDSDK_PYTHON_ARGS'] = '-S -u -B';
+  const gcloud = await import('./gcloud.js');
+  const result = await gcloud.invoke(['config', 'list']);
+  expect(result.code).toBe(0);
+}, 10000);
+
+test('can invoke windows gcloud when there are 1 python args', async () => {
+  // Set the environment variables correctly and then reimport gcloud to force it to reload
+  process.env['CLOUDSDK_PYTHON_ARGS'] = '-u';
+  const gcloud = await import('./gcloud.js');
+  const result = await gcloud.invoke(['config', 'list']);
+  expect(result.code).toBe(0);
+}, 10000);
+
+test('can invoke windows gcloud when there are no python args', async () => {
+  // Set the environment variables correctly and then reimport gcloud to force it to reload
+  process.env['CLOUDSDK_PYTHON_ARGS'] = '';
+  const gcloud = await import('./gcloud.js');
+  const result = await gcloud.invoke(['config', 'list']);
+  expect(result.code).toBe(0);
+}, 10000);
+
+test('can invoke windows gcloud when site packages are enabled', async () => {
+  // Set the environment variables correctly and then reimport gcloud to force it to reload
+  process.env['CLOUDSDK_PYTHON_SITEPACKAGES'] = '1';
+  const gcloud = await import('./gcloud.js');
+  const result = await gcloud.invoke(['config', 'list']);
+  expect(result.code).toBe(0);
+}, 10000);
+
+test('can invoke windows gcloud when site packages are enabled and python args exists', async () => {
+  // Set the environment variables correctly and then reimport gcloud to force it to reload
+  process.env['CLOUDSDK_PYTHON_SITEPACKAGES'] = '1';
+  process.env['CLOUDSDK_PYTHON_ARGS'] = '-u';
+  const gcloud = await import('./gcloud.js');
+  const result = await gcloud.invoke(['config', 'list']);
+  expect(result.code).toBe(0);
+}, 10000);