cdk-cost-analyzer 0.1.1

package/examples/single-stack/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "cdk-cost-analyzer-single-stack-example",
+  "version": "1.0.0",
+  "description": "Single-stack CDK application example with cost analysis",
+  "bin": {
+    "single-stack": "bin/app.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w",
+    "test": "jest",
+    "cdk": "cdk",
+    "synth": "cdk synth",
+    "deploy": "cdk deploy",
+    "diff": "cdk diff"
+  },
+  "keywords": [
+    "aws",
+    "cdk",
+    "cost-analysis",
+    "example"
+  ],
+  "author": "ANWB",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.2",
+    "aws-cdk": "^2.1100.2",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.2"
+  },
+  "dependencies": {
+    "aws-cdk-lib": "^2.233.0",
+    "constructs": "^10.4.2"
+  }
+}

package/examples/single-stack/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": [
+      "es2020"
+    ],
+    "declaration": true,
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": false,
+    "inlineSourceMap": true,
+    "inlineSources": true,
+    "experimentalDecorators": true,
+    "strictPropertyInitialization": false,
+    "typeRoots": [
+      "./node_modules/@types"
+    ],
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true
+  },
+  "exclude": [
+    "node_modules",
+    "cdk.out"
+  ]
+}

package/package.json

@@ -0,0 +1,139 @@
+{
+  "name": "cdk-cost-analyzer",
+  "description": "Analyze AWS CDK infrastructure changes and provide cost impact summaries",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/buildinginthecloud/cdk-cost-analyzer.git"
+  },
+  "bin": {
+    "cdk-cost-analyzer": "dist/cli/index.js"
+  },
+  "scripts": {
+    "build": "npx projen build",
+    "bump": "npx projen bump",
+    "ci:local": "npx projen ci:local",
+    "clobber": "npx projen clobber",
+    "compile": "npx projen compile",
+    "default": "npx projen default",
+    "eject": "npx projen eject",
+    "eslint": "npx projen eslint",
+    "install:act": "npx projen install:act",
+    "lint": "npx projen lint",
+    "package": "npx projen package",
+    "post-compile": "npx projen post-compile",
+    "post-upgrade": "npx projen post-upgrade",
+    "pre-compile": "npx projen pre-compile",
+    "prepare": "npx projen prepare",
+    "release": "npx projen release",
+    "test": "npx projen test",
+    "test:silent": "npx projen test:silent",
+    "test:watch": "npx projen test:watch",
+    "unbump": "npx projen unbump",
+    "upgrade": "npx projen upgrade",
+    "validate:workflows": "npx projen validate:workflows",
+    "watch": "npx projen watch",
+    "projen": "npx projen"
+  },
+  "author": {
+    "name": "Yvo van Zee",
+    "email": "yvo@buildinginthecloud.com",
+    "organization": false
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^2",
+    "@types/jest": "^30.0.0",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.10.1",
+    "@typescript-eslint/eslint-plugin": "^8",
+    "@typescript-eslint/parser": "^8",
+    "commit-and-tag-version": "^12",
+    "constructs": "^10.0.0",
+    "eslint": "^9",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "fast-check": "^3.23.1",
+    "husky": "^9.0.0",
+    "jest": "^30.2.0",
+    "jest-junit": "^16",
+    "lint-staged": "^15.0.0",
+    "projen": "^0.98.28",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.2"
+  },
+  "dependencies": {
+    "@aws-sdk/client-pricing": "^3.705.0",
+    "commander": "^12.1.0",
+    "js-yaml": "^4.1.0"
+  },
+  "keywords": [
+    "analysis",
+    "aws",
+    "cdk",
+    "cloudformation",
+    "cost"
+  ],
+  "engines": {
+    "node": ">= 20.0.0"
+  },
+  "main": "dist/api/index.js",
+  "license": "MIT",
+  "homepage": "https://github.com/buildinginthecloud/cdk-cost-analyzer",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.1.1",
+  "bugs": {
+    "url": "https://github.com/buildinginthecloud/cdk-cost-analyzer/issues"
+  },
+  "jest": {
+    "coverageProvider": "v8",
+    "testTimeout": 30000,
+    "forceExit": true,
+    "detectOpenHandles": true,
+    "testMatch": [
+      "<rootDir>/@(src|test)/**/*(*.)@(spec|test).ts?(x)",
+      "<rootDir>/@(src|test)/**/__tests__/**/*.ts?(x)",
+      "<rootDir>/@(projenrc)/**/*(*.)@(spec|test).ts?(x)",
+      "<rootDir>/@(projenrc)/**/__tests__/**/*.ts?(x)"
+    ],
+    "clearMocks": true,
+    "collectCoverage": true,
+    "coverageReporters": [
+      "json",
+      "lcov",
+      "clover",
+      "cobertura",
+      "text"
+    ],
+    "coverageDirectory": "coverage",
+    "coveragePathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "watchPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "reporters": [
+      "default",
+      [
+        "jest-junit",
+        {
+          "outputDirectory": "test-reports"
+        }
+      ]
+    ],
+    "transform": {
+      "^.+\\.[t]sx?$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.dev.json"
+        }
+      ]
+    }
+  },
+  "types": "dist/api/index.d.ts",
+  "//": "~~ Generated by projen. To modify, edit .projenrc.ts and run \"npx projen\"."
+}

package/test-cdk-project/README-COMPUTE.md

@@ -0,0 +1,141 @@
+# CDK Cost Analyzer - EC2 & RDS Test
+
+This test demonstrates the CDK Cost Analyzer with compute resources (EC2 and RDS).
+
+## Test Scenario
+
+### Base Stack (Current)
+- S3 Bucket
+- Lambda Function (128MB)
+
+### Target Stack (Proposed)
+- S3 Bucket (unchanged)
+- Lambda Function (512MB) - **MODIFIED**
+- VPC with public and isolated subnets - **NEW**
+- EC2 Instance (t3.medium) - **NEW**
+- RDS PostgreSQL Database (db.t3.micro) - **NEW**
+
+## Cost Analysis Results
+
+```
+Total Cost Delta: +$69.62/month
+
+Key Resources:
+- EC2 t3.medium: $36.43/month
+- RDS db.t3.micro (PostgreSQL): $26.94/month
+- Lambda upgrade (128MB → 512MB): +$6.25/month
+
+Supporting Infrastructure (no direct cost):
+- VPC, Subnets, Route Tables, Internet Gateway
+- Security Groups, IAM Roles
+- RDS Subnet Group, Secrets Manager
+```
+
+## Usage
+
+### Synthesize Templates
+
+```bash
+# Base stack
+AWS_PROFILE=dev npx cdk synth \
+  -a "node app-with-compute.js" \
+  -c stack=base \
+  -o cdk.out.compute.base
+
+# Target stack
+AWS_PROFILE=dev npx cdk synth \
+  -a "node app-with-compute.js" \
+  -c stack=target \
+  -o cdk.out.compute.target
+```
+
+### Analyze Costs
+
+```bash
+# Text format
+AWS_PROFILE=dev node ../dist/cli/index.js \
+  cdk.out.compute.base/ComputeStack.template.json \
+  cdk.out.compute.target/ComputeStack.template.json \
+  --region eu-central-1
+
+# Markdown format (for GitLab MR)
+AWS_PROFILE=dev node ../dist/cli/index.js \
+  cdk.out.compute.base/ComputeStack.template.json \
+  cdk.out.compute.target/ComputeStack.template.json \
+  --region eu-central-1 \
+  --format markdown
+```
+
+## Key Insights
+
+### Costs Calculated
+✅ **EC2 Instance**: Accurate monthly cost based on instance type and region
+✅ **RDS Database**: Accurate monthly cost including instance and storage
+✅ **Lambda Functions**: Cost based on memory allocation and default assumptions
+
+### Resources Identified (No Direct Cost)
+- VPC and networking components (subnets, route tables, IGW)
+- Security groups and IAM roles
+- RDS subnet groups
+- Secrets Manager secrets
+
+### Cost Assumptions
+- **EC2**: 730 hours/month (24/7), on-demand pricing, Linux OS
+- **RDS**: 730 hours/month, 20GB storage, single-AZ, PostgreSQL 15
+- **Lambda**: 1M invocations/month, 1s average duration
+
+## Real-World Application
+
+This demonstrates how the tool would work in a typical infrastructure change:
+
+1. **Developer proposes changes** in a merge request
+2. **CI/CD pipeline synthesizes** both base and target CDK stacks
+3. **Cost analyzer runs** and generates a report
+4. **Report is posted** as a comment on the GitLab MR
+5. **Team reviews** the cost impact before approving
+
+## Example GitLab CI/CD Integration
+
+```yaml
+cost-analysis:
+  stage: validate
+  image: node:18
+  before_script:
+    - npm install -g aws-cdk cdk-cost-analyzer
+  script:
+    # Synthesize current main branch
+    - git fetch origin main
+    - git checkout origin/main
+    - cdk synth -o cdk.out.base
+    
+    # Synthesize MR branch
+    - git checkout $CI_COMMIT_SHA
+    - cdk synth -o cdk.out.target
+    
+    # Analyze cost difference
+    - |
+      cdk-cost-analyzer \
+        cdk.out.base/YourStack.template.json \
+        cdk.out.target/YourStack.template.json \
+        --region eu-central-1 \
+        --format markdown > cost-report.md
+    
+    # Post to MR (using GitLab API)
+    - |
+      curl --request POST \
+        --header "PRIVATE-TOKEN: $GITLAB_TOKEN" \
+        --data-urlencode "body@cost-report.md" \
+        "$CI_API_V4_URL/projects/$CI_PROJECT_ID/merge_requests/$CI_MERGE_REQUEST_IID/notes"
+  only:
+    - merge_requests
+  variables:
+    AWS_REGION: eu-central-1
+```
+
+## Benefits
+
+1. **Early Cost Visibility**: See cost impact before deployment
+2. **Informed Decisions**: Team can discuss expensive changes
+3. **Cost Optimization**: Identify opportunities to reduce costs
+4. **Compliance**: Ensure changes stay within budget constraints
+5. **Documentation**: Automatic cost documentation in MR history

package/test-cdk-project/README.md

@@ -0,0 +1,95 @@
+# CDK Cost Analyzer - Test Project
+
+This is a test CDK project to demonstrate the CDK Cost Analyzer functionality.
+
+## Project Structure
+
+- `app.js` - CDK application with two stacks (base and target)
+- `cdk.out.base/` - Synthesized CloudFormation template for base stack
+- `cdk.out.target/` - Synthesized CloudFormation template for target stack
+
+## Stacks
+
+### Base Stack (Current Infrastructure)
+- S3 Bucket
+- Lambda Function (128MB memory)
+
+### Target Stack (Proposed Changes)
+- S3 Bucket (unchanged)
+- Lambda Function (upgraded to 512MB) - **MODIFIED**
+- New Lambda Function (256MB) - **NEW**
+- New S3 Bucket - **NEW**
+
+## Usage
+
+### 1. Synthesize CDK Templates
+
+```bash
+# Synthesize base stack
+AWS_PROFILE=dev npx cdk synth -c stack=base -o cdk.out.base --quiet
+
+# Synthesize target stack
+AWS_PROFILE=dev npx cdk synth -c stack=target -o cdk.out.target --quiet
+```
+
+### 2. Analyze Cost Impact
+
+```bash
+# From the parent directory
+AWS_PROFILE=dev node dist/cli/index.js \
+  test-cdk-project/cdk.out.base/TestStack.template.json \
+  test-cdk-project/cdk.out.target/TestStack.template.json \
+  --region eu-central-1
+```
+
+### 3. Get Markdown Output (for GitLab MR)
+
+```bash
+AWS_PROFILE=dev node dist/cli/index.js \
+  test-cdk-project/cdk.out.base/TestStack.template.json \
+  test-cdk-project/cdk.out.target/TestStack.template.json \
+  --region eu-central-1 \
+  --format markdown
+```
+
+## Expected Results
+
+```
+Total Cost Delta: +$12.82/month
+
+Added Resources:
+- MyNewFunction: $4.17/month (Lambda 256MB)
+- MyNewBucket: $2.40/month (S3 bucket)
+
+Modified Resources:
+- MyFunction: $2.08 → $8.33 (+$6.25) (Lambda 128MB → 512MB)
+```
+
+## Integration with GitLab CI/CD
+
+You can integrate this into your GitLab pipeline:
+
+```yaml
+cost-analysis:
+  stage: validate
+  script:
+    - npm install -g cdk-cost-analyzer
+    - cdk synth -c stack=base -o cdk.out.base
+    - cdk synth -c stack=target -o cdk.out.target
+    - |
+      cdk-cost-analyzer \
+        cdk.out.base/TestStack.template.json \
+        cdk.out.target/TestStack.template.json \
+        --region eu-central-1 \
+        --format markdown > cost-report.md
+    - cat cost-report.md
+  artifacts:
+    reports:
+      markdown: cost-report.md
+```
+
+## Notes
+
+- Uses AWS account `585008061383` (dev) in `eu-central-1`
+- Requires AWS credentials configured via `AWS_PROFILE=dev`
+- IAM roles show as $0.00 (no direct cost, but included in report)

package/test-cdk-project/app-with-compute.js

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+const cdk = require('aws-cdk-lib');
+const { Stack } = require('aws-cdk-lib');
+const ec2 = require('aws-cdk-lib/aws-ec2');
+const s3 = require('aws-cdk-lib/aws-s3');
+const lambda = require('aws-cdk-lib/aws-lambda');
+const rds = require('aws-cdk-lib/aws-rds');
+
+// Base Stack - Current infrastructure
+class BaseStack extends Stack {
+  constructor(scope, id, props) {
+    super(scope, id, props);
+
+    // Simple S3 bucket
+    new s3.Bucket(this, 'MyBucket', {
+      removalPolicy: cdk.RemovalPolicy.DESTROY,
+    });
+
+    // Lambda function with 128MB
+    new lambda.Function(this, 'MyFunction', {
+      runtime: lambda.Runtime.NODEJS_18_X,
+      handler: 'index.handler',
+      code: lambda.Code.fromInline('exports.handler = async () => ({ statusCode: 200 });'),
+      memorySize: 128,
+    });
+  }
+}
+
+// Target Stack - Proposed changes with EC2 and RDS
+class TargetStack extends Stack {
+  constructor(scope, id, props) {
+    super(scope, id, props);
+
+    // Keep the S3 bucket
+    new s3.Bucket(this, 'MyBucket', {
+      removalPolicy: cdk.RemovalPolicy.DESTROY,
+    });
+
+    // Upgrade Lambda to 512MB (MODIFIED)
+    new lambda.Function(this, 'MyFunction', {
+      runtime: lambda.Runtime.NODEJS_18_X,
+      handler: 'index.handler',
+      code: lambda.Code.fromInline('exports.handler = async () => ({ statusCode: 200 });'),
+      memorySize: 512,
+    });
+
+    // Create VPC for EC2 and RDS
+    const vpc = new ec2.Vpc(this, 'MyVPC', {
+      maxAzs: 2,
+      natGateways: 0,
+      subnetConfiguration: [
+        {
+          name: 'Public',
+          subnetType: ec2.SubnetType.PUBLIC,
+        },
+        {
+          name: 'Isolated',
+          subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
+        },
+      ],
+    });
+
+    // Add EC2 instance (NEW)
+    new ec2.Instance(this, 'MyInstance', {
+      vpc,
+      vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC },
+      instanceType: ec2.InstanceType.of(ec2.InstanceClass.T3, ec2.InstanceSize.MEDIUM),
+      machineImage: ec2.MachineImage.latestAmazonLinux2023(),
+    });
+
+    // Add RDS database (NEW)
+    new rds.DatabaseInstance(this, 'MyDatabase', {
+      engine: rds.DatabaseInstanceEngine.postgres({
+        version: rds.PostgresEngineVersion.VER_15,
+      }),
+      instanceType: ec2.InstanceType.of(ec2.InstanceClass.T3, ec2.InstanceSize.MICRO),
+      vpc,
+      vpcSubnets: { subnetType: ec2.SubnetType.PRIVATE_ISOLATED },
+      allocatedStorage: 20,
+      removalPolicy: cdk.RemovalPolicy.DESTROY,
+      deletionProtection: false,
+    });
+  }
+}
+
+const app = new cdk.App();
+
+// Synthesize based on context
+const stackType = app.node.tryGetContext('stack') || 'base';
+
+const env = {
+  account: '585008061383',
+  region: 'eu-central-1',
+};
+
+if (stackType === 'base') {
+  new BaseStack(app, 'ComputeStack', { env });
+} else {
+  new TargetStack(app, 'ComputeStack', { env });
+}
+
+app.synth();

package/test-cdk-project/app.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+const cdk = require('aws-cdk-lib');
+const { Stack } = require('aws-cdk-lib');
+const ec2 = require('aws-cdk-lib/aws-ec2');
+const s3 = require('aws-cdk-lib/aws-s3');
+const lambda = require('aws-cdk-lib/aws-lambda');
+const rds = require('aws-cdk-lib/aws-rds');
+
+// Base Stack - Current infrastructure
+class BaseStack extends Stack {
+  constructor(scope, id, props) {
+    super(scope, id, props);
+
+    // Simple S3 bucket
+    new s3.Bucket(this, 'MyBucket', {
+      bucketName: 'my-test-bucket-base',
+      removalPolicy: cdk.RemovalPolicy.DESTROY,
+    });
+
+    // Lambda function with 128MB
+    new lambda.Function(this, 'MyFunction', {
+      runtime: lambda.Runtime.NODEJS_18_X,
+      handler: 'index.handler',
+      code: lambda.Code.fromInline('exports.handler = async () => ({ statusCode: 200 });'),
+      memorySize: 128,
+    });
+  }
+}
+
+// Target Stack - Proposed changes
+class TargetStack extends Stack {
+  constructor(scope, id, props) {
+    super(scope, id, props);
+
+    // Keep the S3 bucket
+    new s3.Bucket(this, 'MyBucket', {
+      bucketName: 'my-test-bucket-base',
+      removalPolicy: cdk.RemovalPolicy.DESTROY,
+    });
+
+    // Upgrade Lambda to 512MB (MODIFIED)
+    new lambda.Function(this, 'MyFunction', {
+      runtime: lambda.Runtime.NODEJS_18_X,
+      handler: 'index.handler',
+      code: lambda.Code.fromInline('exports.handler = async () => ({ statusCode: 200 });'),
+      memorySize: 1024,
+    });
+
+    // Add another Lambda function (NEW)
+    new lambda.Function(this, 'MyNewFunction', {
+      runtime: lambda.Runtime.NODEJS_18_X,
+      handler: 'index.handler',
+      code: lambda.Code.fromInline('exports.handler = async () => ({ statusCode: 200 });'),
+      memorySize: 2560,
+    });
+
+    // Add another S3 bucket (NEW)
+    new s3.Bucket(this, 'MyNewBucket', {
+      bucketName: 'my-test-bucket-new',
+      removalPolicy: cdk.RemovalPolicy.DESTROY,
+    });
+  }
+}
+
+const app = new cdk.App();
+
+// Synthesize based on context
+const stackType = app.node.tryGetContext('stack') || 'base';
+
+const env = {
+  account: '585008061383',
+  region: 'eu-central-1'
+};
+
+if (stackType === 'base') {
+  new BaseStack(app, 'TestStack', { env });
+} else {
+  new TargetStack(app, 'TestStack', { env });
+}
+
+app.synth();

package/test-cdk-project/cdk-compute.json

@@ -0,0 +1,3 @@
+{
+  "app": "node app-with-compute.js"
+}

package/test-cdk-project/cdk.context.json

@@ -0,0 +1,7 @@
+{
+  "availability-zones:account=585008061383:region=eu-central-1": [
+    "eu-central-1a",
+    "eu-central-1b",
+    "eu-central-1c"
+  ]
+}

package/test-cdk-project/cdk.json

@@ -0,0 +1,3 @@
+{
+  "app": "node app.js"
+}

package/test-cdk-project/cdk.out/TestStack.assets.json

@@ -0,0 +1,21 @@
+{
+  "version": "48.0.0",
+  "files": {
+    "fef4e5534aeeda5c83d0ba81f82463fe8d00a64e197ca90e146f1a90694b23e2": {
+      "displayName": "TestStack Template",
+      "source": {
+        "path": "TestStack.template.json",
+        "packaging": "file"
+      },
+      "destinations": {
+        "585008061383-eu-central-1-c1c9545d": {
+          "bucketName": "cdk-hnb659fds-assets-585008061383-eu-central-1",
+          "objectKey": "fef4e5534aeeda5c83d0ba81f82463fe8d00a64e197ca90e146f1a90694b23e2.json",
+          "region": "eu-central-1",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::585008061383:role/cdk-hnb659fds-file-publishing-role-585008061383-eu-central-1"
+        }
+      }
+    }
+  },
+  "dockerImages": {}
+}