Coverage Report

Coverage Report - com.jcabi.beanstalk.maven.plugin.AbstractBeanstalkMojo

Classes in this File

Line Coverage

Branch Coverage

Complexity

AbstractBeanstalkMojo

15%

7/44

1/12

 /**
  * Copyright (c) 2012-2013, JCabi.com
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met: 1) Redistributions of source code must retain the above
  * copyright notice, this list of conditions and the following
  * disclaimer. 2) Redistributions in binary form must reproduce the above
  * copyright notice, this list of conditions and the following
  * disclaimer in the documentation and/or other materials provided
  * with the distribution. 3) Neither the name of the jcabi.com nor
  * the names of its contributors may be used to endorse or promote
  * products derived from this software without specific prior written
  * permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 package com.jcabi.beanstalk.maven.plugin;
 
 import com.amazonaws.auth.AWSCredentials;
 import com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk;
 import com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalkClient;
 import com.amazonaws.services.s3.AmazonS3Client;
 import com.jcabi.aspects.Tv;
 import com.jcabi.log.Logger;
 import java.io.File;
 import java.util.concurrent.TimeUnit;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.settings.Settings;
 import org.jfrog.maven.annomojo.annotations.MojoParameter;
 import org.slf4j.impl.StaticLoggerBinder;
 
 /**
  * Abstract MOJO for this plugin.
  *
  * @author Yegor Bugayenko (yegor@tpc2.com)
  * @version $Id$
  * @since 0.7.1
  * @checkstyle ClassDataAbstractionCoupling (500 lines)
  */
 abstract class AbstractBeanstalkMojo extends AbstractMojo {
 
     /**
      * Setting.xml.
      */
     @MojoParameter(
         expression = "${settings}",
         required = true,
         readonly = true,
         description = "Maven settings.xml reference"
     )
     private transient Settings settings;
 
     /**
      * Shall we skip execution?
      */
     @MojoParameter(
         defaultValue = "false",
         required = false,
         description = "Skips execution"
     )
     private transient boolean skip;
 
     /**
      * Server ID to deploy to.
      */
     @MojoParameter(
         defaultValue = "aws.amazon.com",
         required = false,
         description = "ID of the server to deploy to, from settings.xml"
     )
     private transient String server;
 
     /**
      * Application name (also the name of environment and CNAME).
      */
     @MojoParameter(
         required = true,
         description = "EBT application name, environment name, and CNAME"
     )
     private transient String name;
 
     /**
      * S3 bucket.
      */
     @MojoParameter(
         required = true,
         description = "Amazon S3 bucket name where to upload WAR file"
     )
     private transient String bucket;
 
     /**
      * S3 key name.
      */
     @MojoParameter(
         required = true,
         description = "Amazon S3 bucket key where to upload WAR file"
     )
     private transient String key;
 
     /**
      * Template name.
      */
     @MojoParameter(
         required = true,
         description = "Amazon Elastic Beanstalk configuration template name"
     )
     private transient String template;
 
     /**
      * WAR file to deploy.
      * @checkstyle LineLength (3 lines)
      */
     @MojoParameter(
         defaultValue = "${project.build.directory}/${project.build.finalName}.war",
         required = false,
         description = "Location of .WAR file to deploy"
     )
     private transient File war;
 
     /**
      * Set skip option.
      * @param skp Shall we skip execution?
      */
     public void setSkip(final boolean skp) {
         this.skip = skp;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void execute() throws MojoFailureException {
         StaticLoggerBinder.getSingleton().setMavenLog(this.getLog());
         if (this.skip) {
             Logger.info(this, "execution skipped because of 'skip' option");
             return;
         }
         if (!this.war.exists()) {
             throw new MojoFailureException(
                 String.format("WAR file '%s' doesn't exist", this.war)
             );
         }
         final AWSCredentials creds = new ServerCredentials(
             this.settings,
             this.server
         );
         final AWSElasticBeanstalk ebt = new AWSElasticBeanstalkClient(creds);
         try {
             this.exec(
                 new Application(ebt, this.name),
                 new OverridingVersion(
                     ebt,
                     this.name,
                     new Bundle.Safe(
                         new OverridingBundle(
                             new AmazonS3Client(creds),
                             this.bucket,
                             this.key,
                             this.war
                         )
                     )
                 ),
                 this.template
             );
         } catch (DeploymentException ex) {
             throw new MojoFailureException("failed to deploy", ex);
         } finally {
             ebt.shutdown();
         }
     }
 
     /**
      * Deploy using this EBT client.
      * @param app Application to deploy to
      * @param version Version to deploy
      * @param tmpl Template to use
      */
     protected abstract void exec(final Application app,
         final Version version, final String tmpl);
 
     /**
      * Report when environment is failed.
      * @param env The environment
      */
     protected void postMortem(final Environment env) {
         Logger.error(this, "Failed to deploy to '%s'", env);
         if (!env.terminated()) {
             Logger.error(
                 this,
                 "TAIL report should explain the cause of failure:"
             );
             this.log(env.tail().split("\n"));
         }
         Logger.error(this, "Latest EBT events (in reverse order):");
         this.log(env.events());
         env.terminate();
     }
 
     /**
      * Log all lines from the collection.
      * @param lines All lines to log
      */
     private void log(final String[] lines) {
         for (String line : lines) {
             Logger.info(this, ">> %s", line);
         }
     }
 
     /**
      * Wait for green status.
      * @param env The environment
      * @return TRUE if green
      */
     protected boolean isGreen(final Environment env) {
         boolean green = env.green();
         final long start = System.currentTimeMillis();
         while (!green) {
             final long age = System.currentTimeMillis() - start;
             if (age > TimeUnit.MINUTES.toMillis(Tv.FIFTEEN)) {
                 Logger.warn(this, "Waiting for %[ms]s, time to give up", age);
                 break;
             }
             Logger.warn(
                 this,
                 "%s is not GREEN yet, let's wait another 15 second...", env
             );
             try {
                 TimeUnit.SECONDS.sleep(Tv.FIFTEEN);
             } catch (InterruptedException ex) {
                 Thread.currentThread().interrupt();
                 throw new DeploymentException(ex);
             }
             green = env.green();
         }
         return green;
     }
 
 }

1		/**
2		* Copyright (c) 2012-2013, JCabi.com
3		* All rights reserved.
4		*
5		* Redistribution and use in source and binary forms, with or without
6		* modification, are permitted provided that the following conditions
7		* are met: 1) Redistributions of source code must retain the above
8		* copyright notice, this list of conditions and the following
9		* disclaimer. 2) Redistributions in binary form must reproduce the above
10		* copyright notice, this list of conditions and the following
11		* disclaimer in the documentation and/or other materials provided
12		* with the distribution. 3) Neither the name of the jcabi.com nor
13		* the names of its contributors may be used to endorse or promote
14		* products derived from this software without specific prior written
15		* permission.
16		*
17		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19		* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20		* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21		* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22		* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23		* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24		* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26		* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27		* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28		* OF THE POSSIBILITY OF SUCH DAMAGE.
29		*/
30		package com.jcabi.beanstalk.maven.plugin;
31
32		import com.amazonaws.auth.AWSCredentials;
33		import com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk;
34		import com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalkClient;
35		import com.amazonaws.services.s3.AmazonS3Client;
36		import com.jcabi.aspects.Tv;
37		import com.jcabi.log.Logger;
38		import java.io.File;
39		import java.util.concurrent.TimeUnit;
40		import org.apache.maven.plugin.AbstractMojo;
41		import org.apache.maven.plugin.MojoFailureException;
42		import org.apache.maven.settings.Settings;
43		import org.jfrog.maven.annomojo.annotations.MojoParameter;
44		import org.slf4j.impl.StaticLoggerBinder;
45
46		/**
47		* Abstract MOJO for this plugin.
48		*
49		* @author Yegor Bugayenko (yegor@tpc2.com)
50		* @version $Id$
51		* @since 0.7.1
52		* @checkstyle ClassDataAbstractionCoupling (500 lines)
53		*/
54	2	abstract class AbstractBeanstalkMojo extends AbstractMojo {
55
56		/**
57		* Setting.xml.
58		*/
59		@MojoParameter(
60		expression = "${settings}",
61		required = true,
62		readonly = true,
63		description = "Maven settings.xml reference"
64		)
65		private transient Settings settings;
66
67		/**
68		* Shall we skip execution?
69		*/
70		@MojoParameter(
71		defaultValue = "false",
72		required = false,
73		description = "Skips execution"
74		)
75		private transient boolean skip;
76
77		/**
78		* Server ID to deploy to.
79		*/
80		@MojoParameter(
81		defaultValue = "aws.amazon.com",
82		required = false,
83		description = "ID of the server to deploy to, from settings.xml"
84		)
85		private transient String server;
86
87		/**
88		* Application name (also the name of environment and CNAME).
89		*/
90		@MojoParameter(
91		required = true,
92		description = "EBT application name, environment name, and CNAME"
93		)
94		private transient String name;
95
96		/**
97		* S3 bucket.
98		*/
99		@MojoParameter(
100		required = true,
101		description = "Amazon S3 bucket name where to upload WAR file"
102		)
103		private transient String bucket;
104
105		/**
106		* S3 key name.
107		*/
108		@MojoParameter(
109		required = true,
110		description = "Amazon S3 bucket key where to upload WAR file"
111		)
112		private transient String key;
113
114		/**
115		* Template name.
116		*/
117		@MojoParameter(
118		required = true,
119		description = "Amazon Elastic Beanstalk configuration template name"
120		)
121		private transient String template;
122
123		/**
124		* WAR file to deploy.
125		* @checkstyle LineLength (3 lines)
126		*/
127		@MojoParameter(
128		defaultValue = "${project.build.directory}/${project.build.finalName}.war",
129		required = false,
130		description = "Location of .WAR file to deploy"
131		)
132		private transient File war;
133
134		/**
135		* Set skip option.
136		* @param skp Shall we skip execution?
137		*/
138		public void setSkip(final boolean skp) {
139	2	this.skip = skp;
140	2	}
141
142		/**
143		* {@inheritDoc}
144		*/
145		@Override
146		public void execute() throws MojoFailureException {
147	2	StaticLoggerBinder.getSingleton().setMavenLog(this.getLog());
148	2	if (this.skip) {
149	2	Logger.info(this, "execution skipped because of 'skip' option");
150	2	return;
151		}
152	0	if (!this.war.exists()) {
153	0	throw new MojoFailureException(
154		String.format("WAR file '%s' doesn't exist", this.war)
155		);
156		}
157	0	final AWSCredentials creds = new ServerCredentials(
158		this.settings,
159		this.server
160		);
161	0	final AWSElasticBeanstalk ebt = new AWSElasticBeanstalkClient(creds);
162		try {
163	0	this.exec(
164		new Application(ebt, this.name),
165		new OverridingVersion(
166		ebt,
167		this.name,
168		new Bundle.Safe(
169		new OverridingBundle(
170		new AmazonS3Client(creds),
171		this.bucket,
172		this.key,
173		this.war
174		)
175		)
176		),
177		this.template
178		);
179	0	} catch (DeploymentException ex) {
180	0	throw new MojoFailureException("failed to deploy", ex);
181		} finally {
182	0	ebt.shutdown();
183	0	}
184	0	}
185
186		/**
187		* Deploy using this EBT client.
188		* @param app Application to deploy to
189		* @param version Version to deploy
190		* @param tmpl Template to use
191		*/
192		protected abstract void exec(final Application app,
193		final Version version, final String tmpl);
194
195		/**
196		* Report when environment is failed.
197		* @param env The environment
198		*/
199		protected void postMortem(final Environment env) {
200	0	Logger.error(this, "Failed to deploy to '%s'", env);
201	0	if (!env.terminated()) {
202	0	Logger.error(
203		this,
204		"TAIL report should explain the cause of failure:"
205		);
206	0	this.log(env.tail().split("\n"));
207		}
208	0	Logger.error(this, "Latest EBT events (in reverse order):");
209	0	this.log(env.events());
210	0	env.terminate();
211	0	}
212
213		/**
214		* Log all lines from the collection.
215		* @param lines All lines to log
216		*/
217		private void log(final String[] lines) {
218	0	for (String line : lines) {
219	0	Logger.info(this, ">> %s", line);
220		}
221	0	}
222
223		/**
224		* Wait for green status.
225		* @param env The environment
226		* @return TRUE if green
227		*/
228		protected boolean isGreen(final Environment env) {
229	0	boolean green = env.green();
230	0	final long start = System.currentTimeMillis();
231	0	while (!green) {
232	0	final long age = System.currentTimeMillis() - start;
233	0	if (age > TimeUnit.MINUTES.toMillis(Tv.FIFTEEN)) {
234	0	Logger.warn(this, "Waiting for %[ms]s, time to give up", age);
235	0	break;
236		}
237	0	Logger.warn(
238		this,
239		"%s is not GREEN yet, let's wait another 15 second...", env
240		);
241		try {
242	0	TimeUnit.SECONDS.sleep(Tv.FIFTEEN);
243	0	} catch (InterruptedException ex) {
244	0	Thread.currentThread().interrupt();
245	0	throw new DeploymentException(ex);
246	0	}
247	0	green = env.green();
248	0	}
249	0	return green;
250		}
251
252		}