Merge pull request #24 from purple-technology/f/env-vars

Author: bboure

README.md

@@ -46,18 +46,19 @@ Serverless: GraphiQl: http://localhost:20002
 
 Put options under `custom.appsync-simulator` in your `serverless.yml` file
 
-| option                   | default               | description                                                                                                                    |
-| ------------------------ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| apiKey                   | `0123456789`          | When using `API_KEY` as authentication type, the key to authenticate to the endpoint.                                          |
-| port                     | 20002                 | AppSync operations port                                                                                                        |
-| wsPort                   | 20003                 | AppSync subscriptions port                                                                                                     |
-| location                 | . (base directory)    | Location of the lambda functions handlers.                                                                                     |
-| refMap | {}        | A mapping of [resource resolutions](#resource-cloudformation-functions-resolution) for the `Ref` function |
-| getAttMap | {}        | A mapping of [resource resolutions](#resource-cloudformation-functions-resolution) for the `GetAtt` function |
-| dynamoDb.endpoint        | http://localhost:8000 | Dynamodb endpoint. Specify it if you're not using serverless-dynamodb-local. Otherwise, port is taken from dynamodb-local conf |
-| dynamoDb.region          | localhost             | Dynamodb region. Specify it if you're connecting to a remote Dynamodb intance.                                                 |
-| dynamoDb.accessKeyId     | DEFAULT_ACCESS_KEY    | AWS Access Key ID to access DynamoDB                                                                                           |
-| dynamoDb.secretAccessKey | DEFAULT_SECRET        | AWS Secret Key to access DynamoDB |
+| option                   | default               | description                                                                                                                                                         |
+|--------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| apiKey                   | `0123456789`          | When using `API_KEY` as authentication type, the key to authenticate to the endpoint.                                                                               |
+| port                     | 20002                 | AppSync operations port                                                                                                                                             |
+| wsPort                   | 20003                 | AppSync subscriptions port                                                                                                                                          |
+| location                 | . (base directory)    | Location of the lambda functions handlers.                                                                                                                          |
+| lambda.loadLocalEnv      | false                 | If `true`, all environment variables (`$ env`) will be accessible from the resolver function. Read more in section [Environment variables](#environment-variables). |
+| refMap                   | {}                    | A mapping of [resource resolutions](#resource-cloudformation-functions-resolution) for the `Ref` function                                                           |
+| getAttMap                | {}                    | A mapping of [resource resolutions](#resource-cloudformation-functions-resolution) for the `GetAtt` function                                                        |
+| dynamoDb.endpoint        | http://localhost:8000 | Dynamodb endpoint. Specify it if you're not using serverless-dynamodb-local. Otherwise, port is taken from dynamodb-local conf                                      |
+| dynamoDb.region          | localhost             | Dynamodb region. Specify it if you're connecting to a remote Dynamodb intance.                                                                                      |
+| dynamoDb.accessKeyId     | DEFAULT_ACCESS_KEY    | AWS Access Key ID to access DynamoDB                                                                                                                                |
+| dynamoDb.secretAccessKey | DEFAULT_SECRET        | AWS Secret Key to access DynamoDB                                                                                                                                   |
 
 Example:
 
@@ -147,6 +148,21 @@ dataSources:
                 - DomainEndpoint
 ````
 
+## Environment variables
+
+```yaml
+custom:
+  appsync-simulator:
+    lambda:
+      loadLocalEnv: true
+```
+
+If `true`, all environment variables (`$ env`) will be accessible from the resolver function.
+
+If `false`, only environment variables defined in `serverless.yml` will be accessible from the resolver function.
+
+> _Note: `serverless.yml` environment variables have higher priority than local environment variables.  Thus some of your local environment variables, could get overridden by environment variables from `serverless.yml`._
+
 ## Limitations
 
 This plugin only tries to resolve the following parts of the yml tree:

src/getAppSyncConfig.js

@@ -76,6 +76,7 @@ export default function getAppSyncConfig(context, appSyncConfig) {
             fileName: path.join(context.options.location, fileName),
             event: payload,
             environment: {
+              ...(context.options.lambda.loadLocalEnv === true ? process.env : {}),
               ...context.serverless.service.provider.environment,
               ...func.environment,
             },

src/index.js

@@ -129,6 +129,9 @@ class ServerlessAppSyncSimulator {
         port: 20002,
         wsPort: 20003,
         location: '.',
+        lambda: {
+          loadLocalEnv: false,
+        },
         refMap: {},
         getAttMap: {},
         dynamoDb: {