added defensive environment variable checks where appropriate, remove…

…d some debugging
DFE-Digital · May 2, 2024 · b649708 · b649708
1 parent e7b415e
commit b649708
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 14 deletions.
diff --git a/Contentful-Schema/utils/create-initial-migration-version.js b/Contentful-Schema/utils/create-initial-migration-version.js
@@ -1,20 +1,35 @@
 import contentful from 'contentful-management';
+import chalk from 'chalk';
+import core from '@actions/core';
 
-console.log('space id: ', process.env.SPACE_ID);
+const red = chalk.bold.red;
+const managementToken = process.env.MANAGEMENT_TOKEN;
+const spaceId = process.env.SPACE_ID;
+const contentfulAlias = process.env.ENVIRONMENT;
+
+try {
+    if (!managementToken) throw new Error("Environment variable MANAGEMENT_TOKEN not set");
+    if (!spaceId) throw new Error("Environment variable SPACE_ID not set");
+    if (!contentfulAlias) throw new Error("Environment variable ENVIRONMENT not set");
+}
+catch (e) {
+    core.setFailed(red(e));
+    process.exit();
+}
 
 var client = contentful.createClient(
-    { accessToken: process.env.MANAGEMENT_TOKEN },
+    { accessToken: managementToken },
     { type: 'plain' }
 );
 
 const newMigrationVersionEntry = await client.entry.create ({
-    environmentId: process.env.ENVIRONMENT,
-    spaceId: process.env.SPACE_ID,
+    environmentId: contentfulAlias,
+    spaceId: spaceId,
     contentTypeId: 'migrationVersion'
 }, {})
 
 await client.entry.publish({
-    environmentId: process.env.ENVIRONMENT,
-    spaceId: process.env.SPACE_ID,
+    environmentId: contentfulAlias,
+    spaceId: spaceId,
     entryId: newMigrationVersionEntry.sys.id
 }, newMigrationVersionEntry);
diff --git a/Contentful-Schema/utils/get-environment-version.js b/Contentful-Schema/utils/get-environment-version.js
@@ -3,11 +3,24 @@ import chalk from 'chalk';
 import core from '@actions/core';
 
 const red = chalk.bold.red;
+const spaceId = process.env.SPACE_ID;
+const contentfulAlias = process.env.ENVIRONMENT;
+const deliveryKey = process.env.DELIVERY_KEY;
+
+try {
+    if (!deliveryKey) throw new Error("Environment variable DELIVERY_KEY not set");
+    if (!spaceId) throw new Error("Environment variable SPACE_ID not set");
+    if (!contentfulAlias) throw new Error("Environment variable ENVIRONMENT not set");
+}
+catch (e) {
+    core.setFailed(red(e));
+    process.exit();
+}
 
 var client = contentful.createClient({
-    accessToken: process.env.DELIVERY_KEY,
-    space: process.env.SPACE_ID,
-    environment: process.env.ENVIRONMENT
+    accessToken: deliveryKey,
+    space: spaceId,
+    environment: contentfulAlias
 });
 
 client.getEntries({ content_type: 'migrationVersion' }).then(entries => {

diff --git a/Contentful-Schema/utils/get-required-migrations.js b/Contentful-Schema/utils/get-required-migrations.js
@@ -13,7 +13,7 @@ const isMigration = filename => {
 try {
     await access(migrationsDir);
 }
-  catch (error) {
+catch (error) {
     core.setFailed(chalk.red("Migrations directory doesn't exist"));
     process.exit();
 }

diff --git a/Contentful-Schema/utils/set-environment-version.js b/Contentful-Schema/utils/set-environment-version.js
@@ -2,10 +2,23 @@ import contentful from 'contentful-management';
 import core from '@actions/core';
 import chalk from 'chalk';
 
+const red = chalk.bold.red;
 const managementToken = process.env.MANAGEMENT_TOKEN;
 const stagingEnvironment = process.env.STAGING_ENVIRONMENT;
 const spaceId = process.env.SPACE_ID;
 const migrationFilename = process.env.MIGRATION_FILENAME
+
+try {
+    if (!managementToken) throw new Error("Environment variable MANAGEMENT_TOKEN not set");
+    if (!stagingEnvironment) throw new Error("Environment variable STAGING_ENVIRONMENT not set");
+    if (!spaceId) throw new Error("Environment variable SPACE_ID not set");
+    if (!migrationFilename) throw new Error("Environment variable MIGRATION_FILENAME not set");
+}
+catch (e) {
+    core.setFailed(red(e));
+    process.exit();
+}
+
 const newVersion = parseInt(migrationFilename.split('-')[0]);
 
 var client = contentful.createClient(
@@ -22,7 +35,7 @@ var entries = await client.entry.getMany({
 });
 
 if (entries.total !== 1) {
-    core.setFailed (chalk.red('Migration version record missing or not unique'));
+    core.setFailed (red('Migration version record missing or not unique'));
     process.exit();
 }
 

diff --git a/Contentful-Schema/utils/verify-space-capacity.js b/Contentful-Schema/utils/verify-space-capacity.js
@@ -5,6 +5,18 @@ const managementToken = process.env.MANAGEMENT_TOKEN;
 const spaceId = process.env.SPACE_ID;
 const spaceCapacity = process.env.SPACE_CAPACITY;
 
+const red = chalk.bold.red;
+
+try {
+    if (!managementToken) throw new Error("Environment variable MANAGEMENT_TOKEN not set");
+    if (!spaceId) throw new Error("Environment variable SPACE_ID not set");
+    if (!spaceCapacity) throw new Error("Environment variable SPACE_CAPACITY not set");
+}
+catch (e) {
+    core.setFailed(red(e));
+    process.exit();
+}
+
 const client = contentful.createClient({
     accessToken: managementToken
 }, { type: 'plain' })
@@ -13,11 +25,9 @@ const environments = await client.environment.getMany({
     spaceId: spaceId
 });
 
-console.log('total environments: ' + environments.items.length);
 const actualEnvironments = environments.items.filter(obj => !("aliasedEnvironment" in obj.sys));
 const environmentsInUse = actualEnvironments.length;
-console.log('actual environments: ' + environmentsInUse);
-console.log('space capacity: ' + spaceCapacity);
+
 if (environmentsInUse >= spaceCapacity) {
     core.setFailed('Contentful space has insufficient environment capacity.  Configured max capacity is ' + spaceCapacity + ', current environment count is ' + environmentsInUse);
 }