fix: Fail early for storage size mismatch in EC2

src/image-builders/aws-image-builder/builder.ts

@@ -321,7 +321,7 @@ export class AwsImageBuilderRunnerImageBuilder extends RunnerImageBuilderBase {
   private infrastructure: imagebuilder.CfnInfrastructureConfiguration | undefined;
   private readonly role: iam.Role;
   private readonly fastLaunchOptions?: FastLaunchOptions;
-  private readonly storageSize?: cdk.Size;
+  public readonly storageSize?: cdk.Size;
   private readonly waitOnDeploy: boolean;
   private readonly dockerSetupCommands: string[];
   private readonly tags: { [key: string]: string };

src/providers/ec2.ts

@@ -25,7 +25,14 @@ import {
   RunnerVersion,
   StorageOptions,
 } from './common';
-import { IRunnerImageBuilder, RunnerImageBuilder, RunnerImageBuilderProps, RunnerImageBuilderType, RunnerImageComponent } from '../image-builders';
+import {
+  AwsImageBuilderRunnerImageBuilder,
+  IRunnerImageBuilder,
+  RunnerImageBuilder,
+  RunnerImageBuilderProps,
+  RunnerImageBuilderType,
+  RunnerImageComponent,
+} from '../image-builders';
 import { MINIMAL_EC2_SSM_SESSION_MANAGER_POLICY_STATEMENT } from '../utils';
 
 // this script is specifically made so `poweroff` is absolutely always called
@@ -391,6 +398,12 @@ export class Ec2RunnerProvider extends BaseProvider implements IRunnerProvider {
     });
     this.ami = this.amiBuilder.bindAmi();
 
+    if (this.amiBuilder instanceof AwsImageBuilderRunnerImageBuilder) {
+      if (this.amiBuilder.storageSize && this.storageSize.toBytes() < this.amiBuilder.storageSize.toBytes()) {
+        throw new Error(`Runner storage size (${this.storageSize.toGibibytes()} GiB) must be at least the same as the image builder storage size (${this.amiBuilder.storageSize.toGibibytes()} GiB)`);
+      }
+    }
+
     if (!this.ami.architecture.instanceTypeMatch(this.instanceType)) {
       throw new Error(`AMI architecture (${this.ami.architecture.name}) doesn't match runner instance type (${this.instanceType} / ${this.instanceType.architecture})`);
     }

test/providers.test.ts

@@ -2,7 +2,7 @@ import * as cdk from 'aws-cdk-lib';
 import { aws_ec2 as ec2, aws_ecs as ecs } from 'aws-cdk-lib';
 import { Match, Template } from 'aws-cdk-lib/assertions';
 import * as autoscaling from 'aws-cdk-lib/aws-autoscaling';
-import { CodeBuildRunnerProvider, EcsRunnerProvider, FargateRunnerProvider, LambdaRunnerProvider } from '../src';
+import { CodeBuildRunnerProvider, Ec2RunnerProvider, EcsRunnerProvider, FargateRunnerProvider, LambdaRunnerProvider } from '../src';
 
 test('CodeBuild provider', () => {
   const app = new cdk.App();
@@ -203,3 +203,42 @@ describe('ECS provider', () => {
     }));
   });
 });
+
+describe('EC2 provider', () => {
+  test('Storage size mismatch', () => {
+    const app = new cdk.App();
+    const stack = new cdk.Stack(app, 'test');
+
+    const vpc = new ec2.Vpc(stack, 'vpc');
+    const sg = new ec2.SecurityGroup(stack, 'sg', { vpc });
+
+    const ib = Ec2RunnerProvider.imageBuilder(stack, 'builder', {
+      vpc: vpc,
+      awsImageBuilderOptions: {
+        storageSize: cdk.Size.gibibytes(50),
+      },
+    });
+
+    expect(() => {
+      new Ec2RunnerProvider(stack, 'provider 1', {
+        vpc: vpc,
+        securityGroups: [sg],
+        imageBuilder: ib,
+      });
+    }).toThrow('Runner storage size (30 GiB) must be at least the same as the image builder storage size (50 GiB)');
+
+    new Ec2RunnerProvider(stack, 'provider 2', {
+      vpc: vpc,
+      securityGroups: [sg],
+      imageBuilder: ib,
+      storageSize: cdk.Size.gibibytes(50),
+    });
+
+    new Ec2RunnerProvider(stack, 'provider 3', {
+      vpc: vpc,
+      securityGroups: [sg],
+      imageBuilder: ib,
+      storageSize: cdk.Size.gibibytes(500),
+    });
+  });
+});