Add flag for logging stack outputs (#10)

* Add flag for logging stack outputs * Change output logical name to match output
yaorg · Apr 24, 2017 · c38dc02 · c38dc02
1 parent ed3d757
commit c38dc02
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 9 deletions.
diff --git a/gradle.properties b/gradle.properties
@@ -1,3 +1,3 @@
 group=com.fieldju
 artifactId=gradle-aws-sam-deployer-plugin
-version=1.5.2
+version=1.6.0
diff --git a/...est/groovy/com/fieldju/gradle/plugins/lambdasam/tasks/DeploySamTaskIntegrationTest.groovy b/...est/groovy/com/fieldju/gradle/plugins/lambdasam/tasks/DeploySamTaskIntegrationTest.groovy
@@ -99,6 +99,7 @@ class DeploySamTaskIntegrationTest {
                     Foo: 'bar'
             ]
             forceUploads = true
+            logStackOutputs = true
         }
 
         project.evaluate()

diff --git a/...u/gradle/plugins/lambdasam/tasks/MultiRegionPackageAndDeploySamTaskIntegrationTest.groovy b/...u/gradle/plugins/lambdasam/tasks/MultiRegionPackageAndDeploySamTaskIntegrationTest.groovy
@@ -108,6 +108,7 @@ class MultiRegionPackageAndDeploySamTaskIntegrationTest {
         task.parameterOverrides = [
                 Foo: 'bar'
         ]
+        task.logStackOutputs = true
 
         MultiRegionPackageAndDeploySamTask testTask = project.tasks.getByName('testTask') as MultiRegionPackageAndDeploySamTask
         testTask.taskAction()

diff --git a/src/integration-test/resources/application.yaml b/src/integration-test/resources/application.yaml
@@ -48,4 +48,8 @@ Resources:
                   - logs:CreateLogGroup
                   - logs:CreateLogStream
                   - logs:PutLogEvents
-                Resource: "*"
+                Resource: "*"
+Outputs:
+  LambdaRoleArn:
+    Description: Role Arn
+    Value: !GetAtt LambdaRole.Arn
diff --git a/src/main/groovy/com/fieldju/gradle/plugins/lambdasam/AwsSamDeployerExtension.groovy b/src/main/groovy/com/fieldju/gradle/plugins/lambdasam/AwsSamDeployerExtension.groovy
@@ -1,7 +1,5 @@
 package com.fieldju.gradle.plugins.lambdasam
 
-import org.gradle.api.GradleException
-
 class AwsSamDeployerExtension {
 
     String region
@@ -13,6 +11,7 @@ class AwsSamDeployerExtension {
     Map<String, String> tokenArtifactMap = [:]
     Map<String, String> parameterOverrides = [:]
     boolean forceUploads = false
+    boolean logStackOutputs = false
 
 
     @Override
@@ -27,6 +26,7 @@ class AwsSamDeployerExtension {
                 ", tokenArtifactMap=" + tokenArtifactMap +
                 ", parameterOverrides=" + parameterOverrides +
                 ", forceUploads=" + forceUploads +
+                ", logStackOutputs=" + logStackOutputs +
                 '}';
     }
 }
diff --git a/src/main/groovy/com/fieldju/gradle/plugins/lambdasam/AwsSamDeployerPlugin.groovy b/src/main/groovy/com/fieldju/gradle/plugins/lambdasam/AwsSamDeployerPlugin.groovy
@@ -42,6 +42,7 @@ class AwsSamDeployerPlugin implements Plugin<Project> {
             deploySamTask.region = extension.getRegion()
             deploySamTask.stackName = extension.getStackName()
             deploySamTask.parameterOverrides = extension.parameterOverrides
+            deploySamTask.logStackOutputs = extension.logStackOutputs
 
             PackageSamTask packageSamTask = project.tasks.getByName(TaskDefinitions.PACKAGE_SAM_TASK.name) as PackageSamTask
             packageSamTask.region = extension.getRegion()

diff --git a/...in/groovy/com/fieldju/gradle/plugins/lambdasam/services/PackageAndDeployTaskHelper.groovy b/...in/groovy/com/fieldju/gradle/plugins/lambdasam/services/PackageAndDeployTaskHelper.groovy
@@ -22,7 +22,8 @@ class PackageAndDeployTaskHelper {
                           List<String> regions,
                           String stackName,
                           Map<String, Map<String, String>> regionToParameterOverridesMap,
-                          boolean executeChangeSet) {
+                          boolean executeChangeSet,
+                          boolean logStackOutputs) {
 
         regions.each { String region ->
             Map<String, String> parameterOverrides
@@ -52,6 +53,9 @@ class PackageAndDeployTaskHelper {
 
             logger.lifecycle("Creating and executing changeset for ${templatePath} with stackname ${stackName} in region ${region} with overrides ${parameterOverrides}")
             deployer.deployStack(stackName, calculatedTemplatePath, parameterOverrides, executeChangeSet)
+            if (logStackOutputs) {
+                deployer.logOutputs(stackName)
+            }
         }
     }
 
@@ -121,7 +125,8 @@ class PackageAndDeployTaskHelper {
                               String stackName,
                               String templatePath,
                               Map<String, String> parameterOverrides,
-                              boolean executeChangeSet) {
+                              boolean executeChangeSet,
+                              boolean logStackOutputs) {
 
         if (StringUtils.isBlank(stackName)) {
             throw new GradleException("stackName cannot be blank")
@@ -135,5 +140,8 @@ class PackageAndDeployTaskHelper {
         )
 
         deployer.deployStack(stackName, templatePath, parameterOverrides, executeChangeSet)
+        if (logStackOutputs) {
+            deployer.logOutputs(stackName)
+        }
     }
 }
diff --git a/...om/fieldju/gradle/plugins/lambdasam/services/cloudformation/CloudFormationDeployer.groovy b/...om/fieldju/gradle/plugins/lambdasam/services/cloudformation/CloudFormationDeployer.groovy
@@ -9,6 +9,7 @@ import com.amazonaws.services.cloudformation.model.DescribeChangeSetResult
 import com.amazonaws.services.cloudformation.model.DescribeStacksRequest
 import com.amazonaws.services.cloudformation.model.ExecuteChangeSetRequest
 import com.amazonaws.services.cloudformation.model.ExecuteChangeSetResult
+import com.amazonaws.services.cloudformation.model.Output
 import com.amazonaws.services.cloudformation.model.Parameter
 import com.amazonaws.services.cloudformation.model.TemplateParameter
 import com.amazonaws.services.cloudformation.model.ValidateTemplateRequest
@@ -295,4 +296,25 @@ class CloudFormationDeployer {
     class ChangeSetMetadata {
         String name, type
     }
+
+    private List<Output> getStackOutputs(String stackName) {
+        def res = amazonCloudFormation.describeStacks(new DescribeStacksRequest().withStackName(stackName))
+        if (res.stacks.size() == 1) {
+            def stack = res.stacks.get(0)
+            return stack.outputs
+        } else {
+            logger.warn("Failed to describe stack: ${stackName}, AWS returned ${res.stacks.size()} stacks with that name.")
+            return []
+        }
+    }
+
+    public void logOutputs(String stackName) {
+        def outputs = getStackOutputs(stackName)
+        logger.lifecycle("The stack: ${stackName} has the following stack outputs")
+        outputs.each { output ->
+            logger.lifecycle("key: ${output.outputKey}")
+            logger.lifecycle("value: ${output.outputValue}")
+            logger.lifecycle("description: ${output.description}")
+        }
+    }
 }
diff --git a/src/main/groovy/com/fieldju/gradle/plugins/lambdasam/tasks/DeploySamTask.groovy b/src/main/groovy/com/fieldju/gradle/plugins/lambdasam/tasks/DeploySamTask.groovy
@@ -23,6 +23,9 @@ class DeploySamTask extends SamTask {
     @Input
     boolean executeChangeSet = true
 
+    @Input
+    boolean logStackOutputs = false
+
     DeploySamTask() {
         group = TASK_GROUP
     }
@@ -35,6 +38,6 @@ class DeploySamTask extends SamTask {
         def calculatedTemplatePath = templatePath ? templatePath : "${project.buildDir.absolutePath}${File.separator}sam${File.separator}sam-deploy-${region}.yaml"
 
         PackageAndDeployTaskHelper helper = new PackageAndDeployTaskHelper(logger)
-        helper.deployProcessedTemplate(region, stackName, calculatedTemplatePath, parameterOverrides, executeChangeSet)
+        helper.deployProcessedTemplate(region, stackName, calculatedTemplatePath, parameterOverrides, executeChangeSet, logStackOutputs)
     }
 }
diff --git a/src/main/groovy/com/fieldju/gradle/plugins/lambdasam/tasks/MultiRegionDeploySamTask.groovy b/src/main/groovy/com/fieldju/gradle/plugins/lambdasam/tasks/MultiRegionDeploySamTask.groovy
@@ -28,6 +28,9 @@ class MultiRegionDeploySamTask extends DefaultTask {
     @Input
     boolean executeChangeSet = true
 
+    @Input
+    boolean logStackOutputs = false
+
     @TaskAction
     void taskAction() {
         // Groovy Strings and GStrings don't work together in collections because hashCode() produces different hashes
@@ -39,6 +42,6 @@ class MultiRegionDeploySamTask extends DefaultTask {
         PackageAndDeployTaskHelper helper = new PackageAndDeployTaskHelper(logger)
         //noinspection GroovyAssignabilityCheck
         helper.multiRegionDeploy(templatePath, regionTemplatePathMap, regions,
-                stackName, regionToParameterOverridesMap, executeChangeSet)
+                stackName, regionToParameterOverridesMap, executeChangeSet, logStackOutputs)
     }
 }
diff --git a/...oovy/com/fieldju/gradle/plugins/lambdasam/tasks/MultiRegionPackageAndDeploySamTask.groovy b/...oovy/com/fieldju/gradle/plugins/lambdasam/tasks/MultiRegionPackageAndDeploySamTask.groovy
@@ -45,6 +45,9 @@ class MultiRegionPackageAndDeploySamTask extends DefaultTask {
     @Input
     boolean executeChangeSet = true
 
+    @Input
+    boolean logStackOutputs = false
+
     @TaskAction
     void taskAction() {
         // Groovy Strings and GStrings don't work together in collections because hashCode() produces different hashes
@@ -77,7 +80,7 @@ class MultiRegionPackageAndDeploySamTask extends DefaultTask {
                 calculatedParameterOverrides = regionToParameterOverridesMap."${region}"
             }
 
-            helper.deployProcessedTemplate(region, stackName, processedTemplatePath, calculatedParameterOverrides, executeChangeSet)
+            helper.deployProcessedTemplate(region, stackName, processedTemplatePath, calculatedParameterOverrides, executeChangeSet, logStackOutputs)
         }
     }