Add doc, example and tests

sid88in · Feb 25, 2019 · 177701f · 177701f
1 parent 54c8bdd
commit 177701f
Show file tree

Hide file tree

Showing 3 changed files with 102 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -129,6 +129,7 @@ custom:
         name: # data source name
         description: 'Lambda DataSource'
         config:
+          functionName: graphql # The function name in your serverless.yml. Ignore if lambdaFunctionArn is provided.
           lambdaFunctionArn: { Fn::GetAtt: [GraphqlLambdaFunction, Arn] } # Where GraphqlLambdaFunction is the lambda function cloudformation resource created by serverless for the serverless function named graphql
           serviceRoleArn: { Fn::GetAtt: [AppSyncLambdaServiceRole, Arn] } # Where AppSyncLambdaServiceRole is an IAM role defined in Resources
           iamRoleStatements: # custom IAM Role statements for this DataSource. Ignored if `serviceRoleArn` is present. Auto-generated if both `serviceRoleArn` and `iamRoleStatements` are omitted

diff --git a/example/serverless.yml b/example/serverless.yml
@@ -98,8 +98,9 @@ custom:
       - type: AWS_LAMBDA
         name: Lambda_MeInfo
         description: 'Lambda DataSource'
-        config:
-          lambdaFunctionArn: { Fn::GetAtt: [GraphqlLambdaFunction, Arn] }
+        config: # Either of functionName or lambdaFunctionArn mus tbe provided. When both are present, lambdaFunctionArn is used.
+          functionName: graphql
+          lambdaFunctionArn: { Fn::GetAtt: [GraphqlLambdaFunction, Arn] } #
           serviceRoleArn: { Fn::GetAtt: [AppSyncLambdaServiceRole, Arn] }
 
 

diff --git a/index.test.js b/index.test.js
@@ -1,12 +1,18 @@
 const Serverless = require('serverless/lib/Serverless');
 const ServerlessAppsyncPlugin = require('.');
+const AwsProvider = require('serverless/lib/plugins/aws/provider/awsProvider.js');
 
 let serverless;
 let plugin;
 let config;
 
 beforeEach(() => {
   serverless = new Serverless();
+  const options = {
+      stage: 'dev',
+      region: 'us-east-1',
+    };
+  serverless.setProvider('aws', new AwsProvider(serverless, options));
   plugin = new  ServerlessAppsyncPlugin(serverless, {});
   config = {
     name: 'api',
@@ -97,6 +103,97 @@ describe("appsync config", () => {
     const role = plugin.getCloudWatchLogsRole(config);
     expect(role).toEqual({});
   });
+
+  test("Datasource generates lambdaFunctionArn from functionName", () => {
+
+    Object.assign(
+      config,
+      {
+        dataSources: [
+          {
+            type: 'AWS_LAMBDA',
+            name: 'lambdaSource',
+            description: 'lambdaSource Desc',
+            config: {
+              functionName: "myFunc",
+              serviceRoleArn: "arn:aws:iam::123456789012:role/service-role/myLambdaRole",
+            }
+          },
+        ],
+      },
+    );
+
+    const dataSources = plugin.getDataSourceResources(config);
+    expect(dataSources).toEqual({
+      "GraphQlDslambdaSource":
+        {
+          "Type": "AWS::AppSync::DataSource",
+          "Properties": {
+            Type: 'AWS_LAMBDA',
+            "ApiId": {
+              "Fn::GetAtt": [
+                "GraphQlApi",
+                "ApiId",
+              ],
+            },
+            Name: 'lambdaSource',
+            ServiceRoleArn: "arn:aws:iam::123456789012:role/service-role/myLambdaRole",
+            Description: 'lambdaSource Desc',
+            LambdaConfig: {
+              LambdaFunctionArn: {
+                "Fn::GetAtt": ["MyFuncLambdaFunction", "Arn"]
+              },
+            }
+          },
+        },
+    });
+  });
+
+  test("Datasource uses lambdaFunctionArn when provided", () => {
+
+    Object.assign(
+      config,
+      {
+        dataSources: [
+          {
+            type: 'AWS_LAMBDA',
+            name: 'lambdaSource',
+            description: 'lambdaSource Desc',
+            config: {
+              functionName: "myDummyFunc",
+              lambdaFunctionArn: {"Fn::GetAtt": ["MyFuncLambdaFunction", "Arn"]},
+              serviceRoleArn: "arn:aws:iam::123456789012:role/service-role/myLambdaRole",
+            }
+          },
+        ],
+      },
+    );
+
+    const dataSources = plugin.getDataSourceResources(config);
+    expect(dataSources).toEqual({
+      "GraphQlDslambdaSource":
+        {
+          "Type": "AWS::AppSync::DataSource",
+          "Properties": {
+            Type: 'AWS_LAMBDA',
+            "ApiId": {
+              "Fn::GetAtt": [
+                "GraphQlApi",
+                "ApiId",
+              ],
+            },
+            Name: 'lambdaSource',
+            ServiceRoleArn: "arn:aws:iam::123456789012:role/service-role/myLambdaRole",
+            Description: 'lambdaSource Desc',
+            LambdaConfig: {
+              LambdaFunctionArn: {
+                "Fn::GetAtt": ["MyFuncLambdaFunction", "Arn"]
+              },
+            }
+          },
+        },
+    });
+  });
 
 });
 
@@ -579,5 +676,5 @@ describe("iamRoleStatements", () => {
     const roles = plugin.getDataSourceIamRolesResouces(config);
     expect(roles).toEqual({});
   });
-  
+
 });