cdk-cost-analyzer 0.1.1

package/examples/.cdk-cost-analyzer.yml

@@ -0,0 +1,85 @@
+# Example CDK Cost Analyzer Configuration
+# Place this file at the root of your project as .cdk-cost-analyzer.yml
+
+# Cost thresholds for pipeline enforcement
+thresholds:
+  # Default thresholds applied to all environments
+  default:
+    warning: 50   # USD per month - triggers warning but pipeline passes
+    error: 200    # USD per month - fails pipeline
+  
+  # Environment-specific thresholds
+  environments:
+    production:
+      warning: 25   # Stricter thresholds for production changes
+      error: 100
+    staging:
+      warning: 50
+      error: 200
+    development:
+      warning: 100  # More lenient for development
+      error: 500
+
+# Custom usage assumptions for cost estimation
+# These override the default assumptions used by resource calculators
+usageAssumptions:
+  # S3 bucket assumptions
+  s3:
+    storageGB: 500          # GB of standard storage per month
+    getRequests: 100000     # GET requests per month
+    putRequests: 10000      # PUT requests per month
+  
+  # Lambda function assumptions
+  lambda:
+    invocationsPerMonth: 5000000  # Number of invocations per month
+    averageDurationMs: 500        # Average execution duration in milliseconds
+  
+  # NAT Gateway assumptions
+  natGateway:
+    dataProcessedGB: 500    # GB of data processed per month
+  
+  # Application Load Balancer assumptions
+  alb:
+    newConnectionsPerSecond: 50       # New TCP connections per second
+    activeConnectionsPerMinute: 5000  # Active TCP connections per minute
+    processedBytesGB: 1000            # GB processed per month
+  
+  # Network Load Balancer assumptions
+  nlb:
+    newConnectionsPerSecond: 100      # New TCP/UDP connections per second
+    activeConnectionsPerMinute: 10000 # Active TCP/UDP connections per minute
+    processedBytesGB: 1000            # GB processed per month
+  
+  # VPC Endpoint assumptions (for interface endpoints)
+  vpcEndpoint:
+    dataProcessedGB: 100    # GB of data processed per month
+  
+  # API Gateway assumptions
+  apiGateway:
+    requestsPerMonth: 10000000  # API requests per month
+
+# CDK synthesis configuration (for automatic synthesis)
+synthesis:
+  appPath: ./infrastructure           # Path to CDK application directory
+  outputPath: ./cdk.out              # CDK output directory (default: cdk.out)
+  customCommand: npx cdk synth --all # Optional: custom synthesis command
+  context:                           # CDK context values passed to synthesis
+    environment: production
+    region: eu-central-1
+
+# Resource types to exclude from cost analysis
+# Useful for zero-cost or negligible-cost resources
+exclusions:
+  resourceTypes:
+    - AWS::IAM::Role
+    - AWS::IAM::Policy
+    - AWS::IAM::User
+    - AWS::IAM::Group
+    - AWS::Logs::LogGroup
+    - AWS::CloudWatch::Alarm
+    - AWS::Events::Rule
+
+# Pricing data cache configuration
+cache:
+  enabled: true        # Enable caching of AWS Pricing API data
+  durationHours: 24    # Cache duration in hours

package/examples/.gitlab-ci.yml

@@ -0,0 +1,125 @@
+# Example GitLab CI/CD Pipeline with CDK Cost Analysis
+# Copy this to your project's .gitlab-ci.yml and customize as needed
+
+stages:
+  - build
+  - test
+  - cost-analysis
+  - deploy
+
+variables:
+  AWS_REGION: eu-central-1
+  CDK_APP_PATH: ./infrastructure
+
+# Cache configuration for faster builds
+.node-cache: &node-cache
+  cache:
+    key: ${CI_COMMIT_REF_SLUG}
+    paths:
+      - node_modules/
+      - ${CDK_APP_PATH}/node_modules/
+      - .cdk-cost-analyzer-cache/
+
+# Install dependencies
+install:
+  stage: build
+  image: node:18
+  <<: *node-cache
+  script:
+    - npm ci
+    - cd ${CDK_APP_PATH} && npm ci
+  artifacts:
+    paths:
+      - node_modules/
+      - ${CDK_APP_PATH}/node_modules/
+    expire_in: 1 hour
+
+# Run unit tests
+test:
+  stage: test
+  image: node:18
+  dependencies:
+    - install
+  script:
+    - npm test
+    - cd ${CDK_APP_PATH} && npm test
+
+# Synthesize CDK application
+synthesize:
+  stage: test
+  image: node:18
+  dependencies:
+    - install
+  script:
+    - cd ${CDK_APP_PATH}
+    - npx cdk synth --all
+  artifacts:
+    paths:
+      - ${CDK_APP_PATH}/cdk.out
+    expire_in: 1 hour
+  only:
+    changes:
+      - infrastructure/**/*
+
+# Cost analysis for merge requests
+cost-analysis:
+  stage: cost-analysis
+  image: node:18
+  dependencies:
+    - install
+  <<: *node-cache
+  before_script:
+    # Install CDK Cost Analyzer globally
+    - npm install -g cdk-cost-analyzer
+  script:
+    # Run cost analysis with automatic synthesis
+    - |
+      cdk-cost-analyzer pipeline \
+        --synth \
+        --cdk-app-path ${CDK_APP_PATH} \
+        --region ${AWS_REGION} \
+        --config .cdk-cost-analyzer.yml \
+        --environment ${CI_ENVIRONMENT_NAME:-development} \
+        --format markdown \
+        --post-to-gitlab
+  # Allow pipeline to pass even if error threshold is exceeded
+  # Remove this to strictly enforce thresholds
+  allow_failure:
+    exit_codes: [2]
+  only:
+    - merge_requests
+  only:
+    changes:
+      - infrastructure/**/*
+      - .cdk-cost-analyzer.yml
+
+# Deploy to staging
+deploy:staging:
+  stage: deploy
+  image: node:18
+  dependencies:
+    - install
+    - synthesize
+  script:
+    - cd ${CDK_APP_PATH}
+    - npx cdk deploy --all --require-approval never
+  environment:
+    name: staging
+  only:
+    - develop
+
+# Deploy to production (manual approval required)
+deploy:production:
+  stage: deploy
+  image: node:18
+  dependencies:
+    - install
+    - synthesize
+  script:
+    - cd ${CDK_APP_PATH}
+    - npx cdk deploy --all --require-approval never
+  environment:
+    name: production
+  only:
+    - main
+  when: manual

package/examples/api-usage.js

@@ -0,0 +1,26 @@
+// api-usage.js - Example of programmatic API usage
+const { analyzeCosts } = require('../dist/api');
+const fs = require('fs');
+
+async function test() {
+  const baseTemplate = fs.readFileSync('./simple/base.json', 'utf-8');
+  const targetTemplate = fs.readFileSync('./simple/target.json', 'utf-8');
+  
+  const result = await analyzeCosts({
+    baseTemplate,
+    targetTemplate,
+    region: 'eu-central-1'
+  });
+  
+  console.log('Total Delta:', result.totalDelta);
+  console.log('Currency:', result.currency);
+  console.log('Added Resources:', result.addedResources.length);
+  console.log('Removed Resources:', result.removedResources.length);
+  console.log('Modified Resources:', result.modifiedResources.length);
+  console.log('\nAdded Resources Details:');
+  result.addedResources.forEach(r => {
+    console.log(`  - ${r.logicalId} (${r.type}): ${r.monthlyCost.currency} ${r.monthlyCost.amount.toFixed(2)} [${r.monthlyCost.confidence}]`);
+  });
+}
+
+test().catch(console.error);

package/examples/complex/base.json

@@ -0,0 +1,16 @@
+{
+    "Resources": {
+        "MyBucket": {
+            "Type": "AWS::S3::Bucket",
+            "Properties": {}
+        },
+        "MyFunction": {
+            "Type": "AWS::Lambda::Function",
+            "Properties": {
+                "Runtime": "nodejs18.x",
+                "Handler": "index.handler",
+                "MemorySize": 128
+            }
+        }
+    }
+}

package/examples/complex/target.json

@@ -0,0 +1,29 @@
+{
+  "Resources": {
+    "MyBucket": {
+      "Type": "AWS::S3::Bucket",
+      "Properties": {}
+    },
+    "MyFunction": {
+      "Type": "AWS::Lambda::Function",
+      "Properties": {
+        "Runtime": "nodejs18.x",
+        "Handler": "index.handler",
+        "MemorySize": 512
+      }
+    },
+    "MyInstance": {
+      "Type": "AWS::EC2::Instance",
+      "Properties": {
+        "InstanceType": "t3.medium"
+      }
+    },
+    "MyDatabase": {
+      "Type": "AWS::RDS::DBInstance",
+      "Properties": {
+        "DBInstanceClass": "db.t3.micro",
+        "Engine": "postgres"
+      }
+    }
+  }
+}

package/examples/monorepo/.gitlab-ci.yml

@@ -0,0 +1,251 @@
+# GitLab CI/CD Pipeline for Monorepo with Parallel CDK Cost Analysis
+# This pipeline runs cost analysis in parallel for multiple CDK applications
+
+stages:
+  - build
+  - test
+  - cost-analysis
+  - deploy
+
+variables:
+  AWS_REGION: us-east-1
+  NODE_VERSION: "18"
+
+# Install dependencies for all packages in the workspace
+build:
+  stage: build
+  image: node:${NODE_VERSION}
+  script:
+    - echo "Installing dependencies for all packages..."
+    - npm ci
+  cache:
+    key: ${CI_COMMIT_REF_SLUG}
+    paths:
+      - node_modules/
+      - packages/*/node_modules/
+  artifacts:
+    paths:
+      - node_modules/
+      - packages/*/node_modules/
+    expire_in: 1 hour
+
+# Run tests for all packages in parallel
+test:frontend:
+  stage: test
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  script:
+    - cd packages/frontend-infra
+    - npm test
+  only:
+    - merge_requests
+    - main
+
+test:backend:
+  stage: test
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  script:
+    - cd packages/backend-infra
+    - npm test
+  only:
+    - merge_requests
+    - main
+
+test:data:
+  stage: test
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  script:
+    - cd packages/data-infra
+    - npm test
+  only:
+    - merge_requests
+    - main
+
+# Analyze cost changes for frontend infrastructure
+cost-analysis:frontend:
+  stage: cost-analysis
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  before_script:
+    - npm install -g cdk-cost-analyzer
+    - |
+      if [ -z "$AWS_ACCESS_KEY_ID" ] || [ -z "$AWS_SECRET_ACCESS_KEY" ]; then
+        echo "ERROR: AWS credentials not configured"
+        exit 1
+      fi
+  script:
+    - echo "Analyzing frontend infrastructure cost changes..."
+    - cd packages/frontend-infra
+    - |
+      cdk-cost-analyzer pipeline \
+        --base-branch ${CI_MERGE_REQUEST_TARGET_BRANCH_NAME} \
+        --target-branch ${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME} \
+        --cdk-app-path . \
+        --region ${AWS_REGION} \
+        --format markdown \
+        --post-to-gitlab
+  cache:
+    key: pricing-cache-frontend
+    paths:
+      - .cdk-cost-analyzer-cache/
+  artifacts:
+    paths:
+      - packages/frontend-infra/cost-report.md
+    expire_in: 30 days
+  only:
+    - merge_requests
+  allow_failure: false
+
+# Analyze cost changes for backend infrastructure
+cost-analysis:backend:
+  stage: cost-analysis
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  before_script:
+    - npm install -g cdk-cost-analyzer
+    - |
+      if [ -z "$AWS_ACCESS_KEY_ID" ] || [ -z "$AWS_SECRET_ACCESS_KEY" ]; then
+        echo "ERROR: AWS credentials not configured"
+        exit 1
+      fi
+  script:
+    - echo "Analyzing backend infrastructure cost changes..."
+    - cd packages/backend-infra
+    - |
+      cdk-cost-analyzer pipeline \
+        --base-branch ${CI_MERGE_REQUEST_TARGET_BRANCH_NAME} \
+        --target-branch ${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME} \
+        --cdk-app-path . \
+        --region ${AWS_REGION} \
+        --format markdown \
+        --post-to-gitlab
+  cache:
+    key: pricing-cache-backend
+    paths:
+      - .cdk-cost-analyzer-cache/
+  artifacts:
+    paths:
+      - packages/backend-infra/cost-report.md
+    expire_in: 30 days
+  only:
+    - merge_requests
+  allow_failure: false
+
+# Analyze cost changes for data infrastructure
+cost-analysis:data:
+  stage: cost-analysis
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  before_script:
+    - npm install -g cdk-cost-analyzer
+    - |
+      if [ -z "$AWS_ACCESS_KEY_ID" ] || [ -z "$AWS_SECRET_ACCESS_KEY" ]; then
+        echo "ERROR: AWS credentials not configured"
+        exit 1
+      fi
+  script:
+    - echo "Analyzing data infrastructure cost changes..."
+    - cd packages/data-infra
+    - |
+      cdk-cost-analyzer pipeline \
+        --base-branch ${CI_MERGE_REQUEST_TARGET_BRANCH_NAME} \
+        --target-branch ${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME} \
+        --cdk-app-path . \
+        --region ${AWS_REGION} \
+        --format markdown \
+        --post-to-gitlab
+  cache:
+    key: pricing-cache-data
+    paths:
+      - .cdk-cost-analyzer-cache/
+  artifacts:
+    paths:
+      - packages/data-infra/cost-report.md
+    expire_in: 30 days
+  only:
+    - merge_requests
+  allow_failure: false
+
+# Deploy frontend infrastructure
+deploy:frontend:
+  stage: deploy
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  before_script:
+    - npm install -g aws-cdk
+  script:
+    - cd packages/frontend-infra
+    - echo "Deploying frontend infrastructure..."
+    - cdk deploy --require-approval never
+  only:
+    - main
+  when: manual
+  environment:
+    name: production/frontend
+    action: start
+
+# Deploy backend infrastructure
+deploy:backend:
+  stage: deploy
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  before_script:
+    - npm install -g aws-cdk
+  script:
+    - cd packages/backend-infra
+    - echo "Deploying backend infrastructure..."
+    - cdk deploy --require-approval never
+  only:
+    - main
+  when: manual
+  environment:
+    name: production/backend
+    action: start
+
+# Deploy data infrastructure
+deploy:data:
+  stage: deploy
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  before_script:
+    - npm install -g aws-cdk
+  script:
+    - cd packages/data-infra
+    - echo "Deploying data infrastructure..."
+    - cdk deploy --require-approval never
+  only:
+    - main
+  when: manual
+  environment:
+    name: production/data
+    action: start
+
+# Optional: Deploy all to development environment
+deploy:dev:all:
+  stage: deploy
+  image: node:${NODE_VERSION}
+  dependencies:
+    - build
+  before_script:
+    - npm install -g aws-cdk
+  script:
+    - echo "Deploying all infrastructure to development..."
+    - cd packages/frontend-infra && cdk deploy --require-approval never
+    - cd ../backend-infra && cdk deploy --require-approval never
+    - cd ../data-infra && cdk deploy --require-approval never
+  only:
+    - develop
+  environment:
+    name: development
+    action: start