feat: add env var file support (#34)

* feat: add env var file support

* update readme

* review feedback

Author: bharathkkb

.github/workflows/deploy-cf-it.yml

@@ -140,6 +140,7 @@ jobs:
         credentials: ${{ secrets.DEPLOY_CF_SA_KEY_JSON }}
         event_trigger_type: providers/cloud.pubsub/eventTypes/topic.publish
         event_trigger_resource: ${{ secrets.DEPLOY_CF_EVENT_PUBSUB_TOPIC }}
+        env_vars_file: './tests/env-var-files/test.good.yaml'
     - uses: actions/setup-node@master
       with:
         node-version: 12.x

README.md

@@ -65,6 +65,8 @@ steps:
   `KEY1=VALUE1,KEY2=VALUE2`. All existing environment variables will be
   removed, even if this parameter is not passed.
 
+- `env_vars_file`: (Optional) Path to a local YAML file with definitions for all environment variables. An example env_vars_file can be found [here](tests/env-var-files/test.good.yaml). Only one of env_vars or env_vars_file can be specified.
+
 - `source_dir`: (Optional) Source directory for the function. Defaults to current directory.
 
 - `project_id`: (Optional) ID of the Google Cloud project. If provided, this

action.yaml

@@ -53,7 +53,12 @@ inputs:
 
   env_vars:
     description: |-
-      List of key-value pairs to set as environment variables in the form KEY1=VALUE1,KEY2=VALUE2.
+      List of key-value pairs to set as environment variables in the form KEY1=VALUE1,KEY2=VALUE2. Only one of env_vars or env_vars_file can be specified.
+    required: false
+  
+  env_vars_file:
+    description: |-
+      Path to a local YAML file with definitions for all environment variables. Only one of env_vars or env_vars_file can be specified.
     required: false
 
   entry_point:

package-lock.json

@@ -36,8 +36,9 @@
     "archiver": "^5.0.0",
     "fs": "0.0.1-security",
     "gaxios": "^3.1.0",
+    "google-auth-library": "^6.0.6",
     "googleapis": "^58.0.0",
-    "google-auth-library": "^6.0.6"
+    "yaml": "^1.10.0"
   },
   "devDependencies": {
     "@types/chai": "^4.2.12",

package.json

@@ -15,6 +15,8 @@
  */
 
 import { cloudfunctions_v1 } from 'googleapis';
+import fs from 'fs';
+import YAML from 'yaml';
 
 export type EnvVar = {
   [key: string]: string;
@@ -45,6 +47,7 @@ export type CloudFunctionOptions = {
   description?: string;
   sourceDir?: string;
   envVars?: string;
+  envVarsFile?: string;
   entryPoint?: string;
   runtime: string;
   availableMemoryMb?: number;
@@ -108,12 +111,23 @@ export class CloudFunction {
       ? opts.availableMemoryMb
       : null;
 
+    // Only one of  envVars and envVarsFile should be set
+    if (opts?.envVars && opts?.envVarsFile) {
+      throw new Error(
+        'Only one of env_vars or env_vars_file can be specified.',
+      );
+    }
+
     // Parse env vars
     let envVars;
     if (opts?.envVars) {
       envVars = this.parseEnvVars(opts.envVars);
       request.environmentVariables = envVars;
     }
+    if (opts?.envVarsFile) {
+      envVars = this.parseEnvVarsFile(opts.envVarsFile);
+      request.environmentVariables = envVars;
+    }
 
     this.request = request;
     this.name = opts.name;
@@ -149,4 +163,23 @@ export class CloudFunction {
     });
     return envVars;
   }
+
+  /**
+   * Read and parse an env var file.
+   *
+   * @param envVarsFile env var file path.
+   * @returns map of type {KEY1:VALUE1}
+   */
+  protected parseEnvVarsFile(envVarFilePath: string): EnvVar {
+    const content = fs.readFileSync(envVarFilePath, 'utf-8');
+    const yamlContent = YAML.parse(content) as EnvVar;
+    for (const [key, val] of Object.entries(yamlContent)) {
+      if (typeof key !== 'string' || typeof val !== 'string') {
+        throw new Error(
+          `env_vars_file yaml must contain only key/value pair of strings. Error parsing key ${key} of type ${typeof key} with value ${val} of type ${typeof val}`,
+        );
+      }
+    }
+    return yamlContent;
+  }
 }

src/cloudFunction.ts

@@ -28,6 +28,7 @@ async function run(): Promise<void> {
     const availableMemoryMb = core.getInput('memory_mb');
     const region = core.getInput('region') || 'us-central1';
     const envVars = core.getInput('env_vars');
+    const envVarsFile = core.getInput('env_vars_file');
     const entryPoint = core.getInput('entry_point');
     const sourceDir = core.getInput('source_dir');
     const vpcConnector = core.getInput('vpc_connector');
@@ -50,6 +51,7 @@ async function run(): Promise<void> {
       availableMemoryMb: +availableMemoryMb,
       entryPoint,
       envVars,
+      envVarsFile,
       timeout,
       maxInstances: +maxInstances,
       eventTriggerType,

src/main.ts

@@ -78,6 +78,41 @@ describe('CloudFunction', function () {
     );
   });
 
+  it('creates a http function with envVarsFile', function () {
+    const envVarsFile = 'tests/env-var-files/test.good.yaml';
+    const cf = new CloudFunction({ name, runtime, parent, envVarsFile });
+    expect(cf.request.name).equal(`${parent}/functions/${name}`);
+    expect(cf.request.environmentVariables?.KEY1).equal('VALUE1');
+    expect(cf.request.environmentVariables?.KEY2).equal('VALUE2');
+    expect(cf.request.environmentVariables?.JSONKEY).equal('{"bar":"baz"}');
+  });
+
+  it('throws an error with bad envVarsFile', function () {
+    const envVarsFile = 'tests/env-var-files/test.bad.yaml';
+    expect(function () {
+      new CloudFunction({ name, runtime, parent, envVarsFile });
+    }).to.throw(
+      'env_vars_file yaml must contain only key/value pair of strings. Error parsing key KEY2 of type string with value VALUE2,VALUE3 of type object',
+    );
+  });
+
+  it('throws an error with nonexistent envVarsFile', function () {
+    const envVarsFile = 'tests/env-var-files/test.nonexistent.yaml';
+    expect(function () {
+      new CloudFunction({ name, runtime, parent, envVarsFile });
+    }).to.throw(
+      "ENOENT: no such file or directory, open 'tests/env-var-files/test.nonexistent.yaml",
+    );
+  });
+
+  it('throws an error with both envVarsFile and envVars specified', function () {
+    const envVarsFile = 'tests/env-var-files/test.good.yaml';
+    const envVars = 'KEY1=VALUE1,KEY2=VALUE2';
+    expect(function () {
+      new CloudFunction({ name, runtime, parent, envVarsFile, envVars });
+    }).to.throw('Only one of env_vars or env_vars_file can be specified.');
+  });
+
   it('creates an event function', function () {
     const eventTriggerType = 'fooType';
     const eventTriggerResource = 'barResource';

tests/cloudFunction.test.ts

@@ -141,4 +141,37 @@ describe('CloudFunction', function () {
     const deleteFunc = await client.delete(updatedHttpFunc.functionPath);
     expect(deleteFunc.done).to.eq(true);
   });
+
+  it('can deploy CF with envVarFile', async function () {
+    if (!credentials) {
+      this.skip();
+    }
+    const client = new CloudFunctionClient(region, {
+      credentials: credentials,
+      projectId: project,
+    });
+    const newHttpFunc = new CloudFunction({
+      name: `http-envfile-${name}`,
+      parent: client.parent,
+      sourceDir: testNodeFuncDir,
+      runtime: 'nodejs10',
+      envVarsFile: 'tests/env-var-files/test.good.yaml',
+      entryPoint: 'helloWorld',
+    });
+    const result = await client.deploy(newHttpFunc);
+    // expect function to be deployed without error
+    expect(result).to.not.eql(null);
+    expect(result.done).to.eq(true);
+    expect(result).to.not.have.property('error');
+    expect(result.response?.httpsTrigger.url).to.not.be.null;
+    // expect to have the correct env vars from env var file
+    expect(result.response?.environmentVariables.KEY1).to.eq('VALUE1');
+    expect(result.response?.environmentVariables.KEY2).to.eq('VALUE2');
+    expect(result.response?.environmentVariables.JSONKEY).to.eq(
+      '{"bar":"baz"}',
+    );
+    // expect function to be deleted without error
+    const deleteFunc = await client.delete(newHttpFunc.functionPath);
+    expect(deleteFunc.done).to.eq(true);
+  });
 });

tests/cloudFunctionClient.test.ts

@@ -0,0 +1,4 @@
+ KEY1: VALUE1
+ KEY2:
+  - VALUE2
+  - VALUE3