chore: Ensures that examples compile (#337)

Author: lantoli

.github/workflows/code-health.yml

@@ -80,8 +80,21 @@ jobs:
           echo "::error::Files were changed during build (see build log). If this was triggered from a fork, you will need to update your branch."
           cat .repo.patch
           exit 1
+  check-examples:
+    runs-on: ubuntu-latest
+    permissions: {}
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
+      - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b
+        with:
+          node-version: 18.x
+      - run: yarn install --check-files
+      - run: npm install -g cdk
+      - run: npx projen build
+      - run: npx projen package:js 
+      - run: ./scripts/check-examples.sh
   call-package-workflow:
-    needs: [compile, lint, shellcheck, check-l1-updated]
+    needs: [compile, lint, shellcheck, check-l1-updated, check-examples]
     secrets: inherit
     permissions:
       contents: write

.gitignore

@@ -111,6 +111,7 @@ const common_exclude = [
   "cdk.context.json",
   "yarn-error.log",
   "*.DS_Store",
+  "examples-bin",
 ];
 project.gitignore.exclude(...common_exclude);
 project.npmignore.exclude(

.npmignore

@@ -1,9 +1,9 @@
 // This example creates an alert in Atlas using the L1 resources.
 import * as cdk from 'aws-cdk-lib';
 import { Construct } from 'constructs';
-import { CfnAlertConfiguration, CfnAlertConfigurationPropsEventTypeName, 
-  NotificationViewTypeName,  MetricThresholdViewMetricName, MetricThresholdViewOperator,
-  MetricThresholdViewUnits, MetricThresholdViewMode} from 'awscdk-resources-mongodbatlas';
+import {
+  CfnAlertConfiguration, NotificationViewTypeName, MetricThresholdViewOperator, MetricThresholdViewMode
+} from 'awscdk-resources-mongodbatlas';
 
 interface AtlasStackProps {
   readonly projectId: string;
@@ -21,7 +21,7 @@ export class CdkTestingStack extends cdk.Stack {
     const alert = new CfnAlertConfiguration(this, 'MyAlert', {
       profile: atlasProps.profile,
       projectId: atlasProps.projectId,
-      eventTypeName: CfnAlertConfigurationPropsEventTypeName.OUTSIDE_METRIC_THRESHOLD, 
+      eventTypeName: 'OUTSIDE_METRIC_THRESHOLD',
       notifications: [{
         typeName: NotificationViewTypeName.EMAIL,
         delayMin: 0,
@@ -30,10 +30,10 @@ export class CdkTestingStack extends cdk.Stack {
         intervalMin: 15
       }],
       metricThreshold: {
-        metricName:MetricThresholdViewMetricName.NORMALIZED_SYSTEM_CPU_USER,
+        metricName: 'NORMALIZED_SYSTEM_CPU_USER',
         operator: MetricThresholdViewOperator.GREATER_THAN,
         threshold: 5,
-        units: MetricThresholdViewUnits.RAW,
+        units: 'RAW',
         mode: MetricThresholdViewMode.AVERAGE,
       }
     });

.projenrc.js

@@ -1,6 +1,6 @@
 import * as cdk from "aws-cdk-lib";
 import { Construct } from 'constructs';
-import { CfnApiKey,CfnApiKeyProps,ProjectAssignment,ListOptions} from 'awscdk-resources-mongodbatlas';
+import { CfnApiKey, CfnApiKeyProps, ProjectAssignment, ListOptions } from 'awscdk-resources-mongodbatlas';
 
 const app = new cdk.App();
 
@@ -12,7 +12,7 @@ interface AtlasStackProps {
   readonly projectId: string;
 }
 
-const Roles = ["ORG_MEMBER","ORG_GROUP_CREATOR"]
+const Roles = ["ORG_MEMBER", "ORG_GROUP_CREATOR"]
 export class CdkTestingStack extends cdk.Stack {
   constructor(scope: Construct, id: string, props?: cdk.StackProps) {
     super(scope, id, props);
@@ -23,7 +23,7 @@ export class CdkTestingStack extends cdk.Stack {
       orgId: atlasProps.orgId,
       description: atlasProps.description,
       awsSecretName: atlasProps.awsSecretName,
-      proAssignments: [{
+      projectAssignments: [{
         projectId: atlasProps.projectId,
         "roles": [
           "GROUP_READ_ONLY"
@@ -35,23 +35,23 @@ export class CdkTestingStack extends cdk.Stack {
 
   getContextProps(): AtlasStackProps {
     const projectId = this.node.tryGetContext('projId');
-    if (!projectId){
+    if (!projectId) {
       throw "No context value specified for projId. Please specify via the cdk context."
     }
 
     const orgId = this.node.tryGetContext('orgId');
-    if (!orgId){
+    if (!orgId) {
       throw "No context value specified for projId. Please specify via the cdk context."
     }
     const profile = this.node.tryGetContext('profile') ?? 'default';
     const description = this.node.tryGetContext('description');
     const awsSecretName = this.node.tryGetContext('awsSecretName');
     return {
-        orgId,
-        profile,
-        description,
-        awsSecretName,
-        projectId
+      orgId,
+      profile,
+      description,
+      awsSecretName,
+      projectId
     }
   }
-}
+}

API.md

@@ -1,7 +1,6 @@
-import { CfnCloudBackUpRestoreJobsPropsInstanceType } from './../../src/l1-resources/cloud-backup-restore-jobs/index';
 import * as cdk from 'aws-cdk-lib';
 import { Construct } from 'constructs';
-import { CfnCloudBackUpRestoreJobs, CfnCloudBackUpRestoreJobsPropsDeliveryType } from 'awscdk-resources-mongodbatlas';
+import { CfnCloudBackUpRestoreJobs, CfnCloudBackUpRestoreJobsPropsInstanceType, CfnCloudBackUpRestoreJobsPropsDeliveryType } from 'awscdk-resources-mongodbatlas';
 
 interface AtlasStackProps {
   readonly projId: string;
@@ -18,7 +17,7 @@ export class CdkTestingStack extends cdk.Stack {
 
     const atlasProps = this.getContextProps();
 
-    new CfnCloudBackUpRestoreJobs(this, 'CloudBackupRestoreJobs', {    
+    new CfnCloudBackUpRestoreJobs(this, 'CloudBackupRestoreJobs', {
       instanceName: atlasProps.instanceName,
       instanceType: CfnCloudBackUpRestoreJobsPropsInstanceType.CLUSTER,
       projectId: atlasProps.projId,
@@ -27,14 +26,14 @@ export class CdkTestingStack extends cdk.Stack {
       deliveryType: CfnCloudBackUpRestoreJobsPropsDeliveryType.DOWNLOAD,
       targetClusterName: atlasProps.targetClusterName,
       targetProjectId: atlasProps.targerProjId,
-  
+
     });
 
   }
 
   getContextProps(): AtlasStackProps {
     const projId = this.node.tryGetContext('projId');
-    if (!projId){
+    if (!projId) {
       throw "No context value specified for projId. Please specify via the cdk context."
     }
     const snapshotId = this.node.tryGetContext('snapshotId');

examples/l1-resources/alert-configuration.ts

@@ -5,10 +5,10 @@ import { CfnCloudBackupSchedule } from 'awscdk-resources-mongodbatlas';
 interface AtlasStackProps {
   readonly projId: string;
   readonly profile: string;
-  readonly retentionValue: string;
+  readonly retentionValue: number;
   readonly clusterName: string;
   readonly retentionUnit: string;
-  readonly frequencyInterval: string;
+  readonly frequencyInterval: number;
   readonly frequencyType: string;
   readonly policyId: string;
   readonly replicationSpecId: string;
@@ -53,7 +53,7 @@ export class CdkTestingStack extends cdk.Stack {
 
   getContextProps(): AtlasStackProps {
     const projId = this.node.tryGetContext('projId');
-    if (!projId){
+    if (!projId) {
       throw "No context value specified for projId. Please specify via the cdk context."
     }
     const retentionValue = this.node.tryGetContext('retentionValue');

examples/l1-resources/api-key.ts

@@ -1,11 +1,11 @@
 import * as cdk from 'aws-cdk-lib';
 import { Construct } from 'constructs';
-import { CfnCloudBackupSnapshot,CfnCloudBackupSnapshotPropsInstanceType } from 'awscdk-resources-mongodbatlas';
+import { CfnCloudBackupSnapshot, CfnCloudBackupSnapshotPropsInstanceType } from 'awscdk-resources-mongodbatlas';
 
 interface AtlasStackProps {
   readonly projId: string;
   readonly profile: string;
-  readonly retentionInDays: string;
+  readonly retentionInDays: number;
   readonly clusterName: string;
 }
 
@@ -16,19 +16,19 @@ export class CdkTestingStack extends cdk.Stack {
     const atlasProps = this.getContextProps();
 
     new CfnCloudBackupSnapshot(this, 'CloudBackupSnapshot', {
-        instanceName: atlasProps.clusterName,
-        instanceType: CfnCloudBackupSnapshotPropsInstanceType.CLUSTER,
-        profile: atlasProps.profile,
-        projectId: atlasProps.projId,
-        description: 'Snapshot created with CDK',
-        retentionInDays: atlasProps.retentionInDays,
-      });
+      instanceName: atlasProps.clusterName,
+      instanceType: CfnCloudBackupSnapshotPropsInstanceType.CLUSTER,
+      profile: atlasProps.profile,
+      projectId: atlasProps.projId,
+      description: 'Snapshot created with CDK',
+      retentionInDays: atlasProps.retentionInDays,
+    });
 
   }
 
   getContextProps(): AtlasStackProps {
     const projId = this.node.tryGetContext('projId');
-    if (!projId){
+    if (!projId) {
       throw "No context value specified for projId. Please specify via the cdk context."
     }
     const retentionValue = this.node.tryGetContext('retentionValue');