AmazonCloudFormationWaitStackStatusTask.java

/*
 * Copyright 2015-2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package jp.classmethod.aws.gradle.cloudformation;

import java.util.Arrays;
import java.util.List;

import lombok.Getter;
import lombok.Setter;

import org.gradle.api.GradleException;
import org.gradle.api.internal.ConventionTask;
import org.gradle.api.tasks.TaskAction;

import com.amazonaws.AmazonServiceException;
import com.amazonaws.services.cloudformation.AmazonCloudFormation;
import com.amazonaws.services.cloudformation.model.DescribeStacksRequest;
import com.amazonaws.services.cloudformation.model.DescribeStacksResult;
import com.amazonaws.services.cloudformation.model.Stack;

public class AmazonCloudFormationWaitStackStatusTask extends ConventionTask {
	
	@Getter
	@Setter
	private String stackName;
	
	@Getter
	@Setter
	private List<String> successStatuses = Arrays.asList(
			"CREATE_COMPLETE",
			"UPDATE_COMPLETE",
			"DELETE_COMPLETE");
	
	@Getter
	@Setter
	private List<String> waitStatuses = Arrays.asList(
			"CREATE_IN_PROGRESS",
			"ROLLBACK_IN_PROGRESS",
			"DELETE_IN_PROGRESS",
			"UPDATE_IN_PROGRESS",
			"UPDATE_COMPLETE_CLEANUP_IN_PROGRESS",
			"UPDATE_ROLLBACK_IN_PROGRESS",
			"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS");
	
	@Getter
	@Setter
	private int loopTimeout = 900; // sec
	
	@Getter
	@Setter
	private int loopWait = 10; // sec
	
	@Getter
	@Setter
	private boolean found;
	
	@Getter
	@Setter
	private String lastStatus;
	
	
	public AmazonCloudFormationWaitStackStatusTask() {
		setDescription("Wait cfn stack for specific status.");
		setGroup("AWS");
	}
	
	@TaskAction
	public void waitStackForStatus() throws InterruptedException {
		// to enable conventionMappings feature
		String stackName = getStackName();
		List<String> successStatuses = getSuccessStatuses();
		List<String> waitStatuses = getWaitStatuses();
		int loopTimeout = getLoopTimeout();
		int loopWait = getLoopWait();
		
		if (stackName == null) {
			throw new GradleException("stackName is not specified");
		}
		
		AmazonCloudFormationPluginExtension ext =
				getProject().getExtensions().getByType(AmazonCloudFormationPluginExtension.class);
		AmazonCloudFormation cfn = ext.getClient();
		
		long start = System.currentTimeMillis();
		while (true) {
			if (System.currentTimeMillis() > start + (loopTimeout * 1000)) {
				throw new GradleException("Timeout");
			}
			try {
				DescribeStacksResult describeStackResult = cfn.describeStacks(new DescribeStacksRequest()
					.withStackName(stackName));
				Stack stack = describeStackResult.getStacks().get(0);
				if (stack == null) {
					throw new GradleException("stack " + stackName + " is not exists");
				}
				found = true;
				lastStatus = stack.getStackStatus();
				if (successStatuses.contains(lastStatus)) {
					getLogger().info("Status of stack {} is now {}.", stackName, lastStatus);
					printOutputs(stack);
					break;
				} else if (waitStatuses.contains(lastStatus)) {
					getLogger().info("Status of stack {} is {}...", stackName, lastStatus);
					Thread.sleep(loopWait * 1000);
				} else {
					// fail if not contains in successStatus or waitStatus
					throw new GradleException(
							"Status of stack " + stackName + " is " + lastStatus + ".  It seems to be failed.");
				}
			} catch (AmazonServiceException e) {
				if (found) {
					break;
				} else {
					throw new GradleException("Fail to describe stack: " + stackName, e);
				}
			}
		}
	}
	
	private void printOutputs(Stack stack) {
		getLogger().info("==== Outputs ====");
		stack.getOutputs().stream()
			.forEach(o -> getLogger().info("{} ({}) = {}", o.getOutputKey(), o.getDescription(), o.getOutputValue()));
	}
}