Add optional description field to App configs

src/packages/gcp/apps.ts

@@ -284,6 +284,11 @@ function createLoadBalancer(
  * Deploys static files to GCS bucket with a backend bucket (for use in load balancer)
  */
 export interface StaticWebAppArgs {
+	/**
+	 * An optional description of this resource
+	 */
+	description?: pulumi.Input<string>;
+
 	/**
 	 * Path to the directory containing static files
 	 */
@@ -497,6 +502,11 @@ export class StaticWebApp extends pulumi.ComponentResource {
  * Configuration for Cloud Run backend service
  */
 export interface CloudRunServiceArgs {
+	/**
+	 * An optional description of this resource
+	 */
+	description?: pulumi.Input<string>;
+
 	/**
 	 * GCP project and common options
 	 */
@@ -1228,6 +1238,11 @@ export class CloudRunService extends pulumi.ComponentResource {
  * Combines a static frontend with a Cloud Run backend
  */
 export interface FullStackAppArgs {
+	/**
+	 * An optional description of this resource
+	 */
+	description?: pulumi.Input<string>;
+
 	/**
 	 * Load balancer configuration (domain, SSL, IPs, DNS)
 	 */

tests/integration/cloudrun-with-db.test.ts

@@ -1,4 +1,6 @@
 import { describe, it, expect, afterAll } from 'vitest';
+import * as pulumi from '@pulumi/pulumi';
+import type { CloudRunServiceArgs } from '../../src/packages/gcp/apps';
 import { deployStack, destroyStack, type StackOutputs } from '../helpers/pulumi';
 
 describe('CloudRunService with Database', function() {
@@ -54,3 +56,21 @@ describe('CloudRunService with Database', function() {
 		await destroyStack('examples/cloudrun-with-db', stackName);
 	}, 1_800_000); // 30 min timeout for destroy (Cloud SQL teardown is slow)
 });
+
+describe('CloudRunServiceArgs description field', () => {
+	const baseArgs = {
+		gcp: { project: 'my-project' },
+		region: 'us-central1' as const,
+		image: { uri: 'gcr.io/my-project/my-image:latest' }
+	};
+
+	it('accepts pulumi.Input<string> and pulumi.Output<string>', () => {
+		const withInput: CloudRunServiceArgs = { ...baseArgs, description: 'my service' };
+		const withOutput: CloudRunServiceArgs = { ...baseArgs, description: pulumi.output('my service') };
+		const withoutDescription: CloudRunServiceArgs = { ...baseArgs };
+
+		expect(withInput.description).toBeDefined();
+		expect(withOutput.description).toBeDefined();
+		expect(withoutDescription.description).toBeUndefined();
+	});
+});

tests/integration/fullstack-app.test.ts

@@ -1,4 +1,6 @@
 import { describe, it, expect, afterAll } from 'vitest';
+import * as pulumi from '@pulumi/pulumi';
+import type { FullStackAppArgs } from '../../src/packages/gcp/apps';
 import { deployStack, destroyStack, fetchWithRetry, type StackOutputs } from '../helpers/pulumi';
 
 const domain = process.env.TEST_DOMAIN || 'fullstack.pulumi-components-test-zone.test.keeta.com';
@@ -101,3 +103,25 @@ describe('FullStackApp', function() {
 		await destroyStack('examples/fullstack-app', stackName);
 	}, 1_800_000);
 });
+
+describe('FullStackAppArgs description field', () => {
+	const baseArgs = {
+		loadBalancer: { domain: 'app.example.com', ssl: { domains: ['app.example.com'] } },
+		frontend: { staticFilesPath: './dist' },
+		backend: {
+			gcp: { project: 'my-project' },
+			region: 'us-central1' as const,
+			image: { uri: 'gcr.io/my-project/my-image:latest' }
+		}
+	};
+
+	it('accepts pulumi.Input<string> and pulumi.Output<string>', () => {
+		const withInput: FullStackAppArgs = { ...baseArgs, description: 'my app' };
+		const withOutput: FullStackAppArgs = { ...baseArgs, description: pulumi.output('my app') };
+		const withoutDescription: FullStackAppArgs = { ...baseArgs };
+
+		expect(withInput.description).toBeDefined();
+		expect(withOutput.description).toBeDefined();
+		expect(withoutDescription.description).toBeUndefined();
+	});
+});

tests/integration/static-webapp.test.ts

@@ -1,4 +1,6 @@
 import { describe, it, expect, afterAll } from 'vitest';
+import * as pulumi from '@pulumi/pulumi';
+import type { StaticWebAppArgs } from '../../src/packages/gcp/apps';
 import { deployStack, destroyStack, type StackOutputs } from '../helpers/pulumi';
 
 describe('StaticWebApp', function() {
@@ -30,3 +32,15 @@ describe('StaticWebApp', function() {
 		await destroyStack('examples/static-webapp', stackName);
 	}, 1_800_000); // 30 min timeout for destroy
 });
+
+describe('StaticWebAppArgs description field', () => {
+	it('accepts pulumi.Input<string> and pulumi.Output<string>', () => {
+		const withInput: StaticWebAppArgs = { staticFilesPath: './dist', description: 'my app' };
+		const withOutput: StaticWebAppArgs = { staticFilesPath: './dist', description: pulumi.output('my app') };
+		const withoutDescription: StaticWebAppArgs = { staticFilesPath: './dist' };
+
+		expect(withInput.description).toBeDefined();
+		expect(withOutput.description).toBeDefined();
+		expect(withoutDescription.description).toBeUndefined();
+	});
+});