Coverage Report

Coverage Report - org.apache.maven.plugin.announcement.AnnouncementMailMojo

Classes in this File

Line Coverage

Branch Coverage

Complexity

AnnouncementMailMojo

0/108

0/34

1,867

 package org.apache.maven.plugin.announcement;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.
  */
 
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.FileReader;
 import java.io.IOException;
 import java.util.Iterator;
 import java.util.List;
 
 import org.apache.maven.model.Developer;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.announcement.mailsender.ProjectJavamailMailSender;
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.logging.Logger;
 import org.codehaus.plexus.logging.console.ConsoleLogger;
 import org.codehaus.plexus.mailsender.MailMessage;
 import org.codehaus.plexus.mailsender.MailSenderException;
 import org.codehaus.plexus.util.IOUtil;
 
 /**
  * Goal which sends an announcement through email.
  *
  * @author aramirez@exist.com
  * @version $Id$
  * @goal announcement-mail
  * @execute goal="announcement-generate"
  * @since 2.0-beta-2
  * @threadSafe
  */
 public class AnnouncementMailMojo
     extends AbstractAnnouncementMojo
 {
     //=========================================
     // announcement-mail goal fields
     //=========================================
 
     /**
      * Possible senders.
      *
      * @parameter expression="${project.developers}"
      * @required
      * @readonly
      */
     private List from;
 
     /**
      * The id of the developer sending the announcement mail. Only used if the <tt>mailSender</tt>
      * attribute is not set. In this case, this should match the id of one of the developers in
      * the pom. If a matching developer is not found, then the first developer in the pom will be
      * used.
      *
      * @parameter expression="${changes.fromDeveloperId}"
      */
     private String fromDeveloperId;
 
     /**
      * Mail content type to use.
      * @parameter default-value="text/plain"
      * @required
      * @since 2.1
      */
     private String mailContentType;
 
     /**
      * Defines the sender of the announcement if the list of developer is empty or
      * if the sender is not a member of the development team.
      *
      * @parameter expression="${changes.mailSender}"
      */
     private MailSender mailSender;
 
     /**
      * The password used to send the email.
      *
      * @parameter expression="${changes.password}"
      */
     private String password;
 
     /**
      * @parameter expression="${project}"
      * @readonly
      */
     private MavenProject project;
 
     /**
      * Smtp Server.
      *
      * @parameter expression="${changes.smtpHost}"
      * @required
      */
     private String smtpHost;
 
     /**
      * Port.
      *
      * @parameter default-value="25" expression="${changes.smtpPort}"
      * @required
      */
     private int smtpPort;
 
     /**
      * If the email should be sent in SSL mode.
      *
      * @parameter default-value="false" expression="${changes.sslMode}"
      */
     private boolean sslMode;
 
 
     /**
      * Subject for the email.
      *
      * @parameter default-value="[ANNOUNCEMENT] - ${project.name} ${project.version} released" expression="${changes.subject}"
      * @required
      */
     private String subject;
 
     /**
      * The Velocity template used to format the announcement.
      *
      * @parameter default-value="announcement.vm" expression="${changes.template}"
      * @required
      */
     private String template;
 
     /**
      * Directory which contains the template for announcement email.
      *
      * @parameter expression="${project.build.directory}/announcement"
      * @required
      */
     private File templateOutputDirectory;
 
     /**
      * Recipient email address.
      *
      * @parameter
      * @required
      */
     private List toAddresses;
 
     /**
      * The username used to send the email.
      *
      * @parameter expression="${changes.username}"
      */
     private String username;
 
     private ProjectJavamailMailSender mailer = new ProjectJavamailMailSender();
 
     public void execute()
         throws MojoExecutionException
     {
         // Run only at the execution root
         if ( runOnlyAtExecutionRoot && !isThisTheExecutionRoot() )
         {
             getLog().info( "Skipping the announcement mail in this project because it's not the Execution Root" );
         }
         else
         {
             File templateFile = new File( templateOutputDirectory, template );
 
             ConsoleLogger logger = new ConsoleLogger( Logger.LEVEL_INFO, "base" );
 
             if ( getLog().isDebugEnabled() )
             {
                 logger.setThreshold( Logger.LEVEL_DEBUG );
             }
 
             mailer.enableLogging( logger );
 
             mailer.setSmtpHost( getSmtpHost() );
 
             mailer.setSmtpPort( getSmtpPort() );
 
             mailer.setSslMode( sslMode );
 
             if ( username != null )
             {
                 mailer.setUsername( username );
             }
 
             if ( password != null )
             {
                 mailer.setPassword( password );
             }
 
             mailer.initialize();
 
             if ( getLog().isDebugEnabled() )
             {
                 getLog().debug( "fromDeveloperId: " + getFromDeveloperId() );
             }
 
             if ( templateFile.isFile() )
             {
                 getLog().info( "Connecting to Host: " + getSmtpHost() + ":" + getSmtpPort() );
 
                 sendMessage();
             }
             else
             {
                 throw new MojoExecutionException( "Announcement template " + templateFile + " not found..." );
             }
         }
     }
 
     /**
      * Send the email.
      *
      * @throws MojoExecutionException if the mail could not be sent
      */
     protected void sendMessage()
         throws MojoExecutionException
     {
         File templateFile = new File( templateOutputDirectory, template );
         String email = "";
         final MailSender ms = getActualMailSender();
         final String fromName = ms.getName();
         final String fromAddress = ms.getEmail();
         if ( fromAddress == null || fromAddress.equals( "" ) )
         {
             throw new MojoExecutionException( "Invalid mail sender: name and email is mandatory (" + ms + ")." );
         }
         getLog().info( "Using this sender for email announcement: " + fromAddress + " < " + fromName + " > " );
         try
         {
             MailMessage mailMsg = new MailMessage();
             mailMsg.setSubject( getSubject() );
             mailMsg.setContent( IOUtil.toString( readAnnouncement( templateFile ) ) );
             mailMsg.setContentType( this.mailContentType );
             mailMsg.setFrom( fromAddress, fromName );
             final Iterator it = getToAddresses().iterator();
             while ( it.hasNext() )
             {
                 email = it.next().toString();
                 getLog().info( "Sending mail to " + email + "..." );
                 mailMsg.addTo( email, "" );
 
             }
             mailer.send( mailMsg );
             getLog().info( "Sent..." );
         }
         catch ( IOException ioe )
         {
             throw new MojoExecutionException( "Failed to send email.", ioe );
         }
         catch ( MailSenderException e )
         {
             throw new MojoExecutionException( "Failed to send email < " + email + " >", e );
         }
     }
 
     /**
      * Read the announcement generated file.
      *
      * @param file the file to be read
      * @return fileReader Return the FileReader
      * @throws MojoExecutionException if the file could not be found
      */
     protected FileReader readAnnouncement( File file )
         throws MojoExecutionException
     {
         FileReader fileReader;
         try
         {
             fileReader = new FileReader( file );
         }
         catch ( FileNotFoundException fnfe )
         {
             throw new MojoExecutionException( "File not found. " + file );
         }
         return fileReader;
     }
 
     /**
      * Returns the identify of the mail sender according to the plugin's configuration:
      * <ul>
      * <li>if the <tt>mailSender</tt> parameter is set, it is returned</li>
      * <li>if no <tt>fromDeveloperId</tt> is set, the first developer in the list is returned</li>
      * <li>if a <tt>fromDeveloperId</tt> is set, the developer with that id is returned</li>
      * <li>if the developers list is empty or if the specified id does not exist, an exception is thrown</li>
      * </ul>
      *
      * @return the mail sender to use
      * @throws MojoExecutionException if the mail sender could not be retrieved
      */
     protected MailSender getActualMailSender()
         throws MojoExecutionException
     {
         if ( mailSender != null && mailSender.getEmail() != null )
         {
             return mailSender;
         }
         else if ( from == null || from.isEmpty() )
         {
             throw new MojoExecutionException(
                 "The <developers> section in your pom should not be empty. Add a <developer> entry or set the "
                     + "mailSender parameter." );
         }
         else if ( fromDeveloperId == null )
         {
             final Developer dev = (Developer) from.get( 0 );
             return new MailSender( dev.getName(), dev.getEmail() );
         }
         else
         {
             final Iterator it = from.iterator();
             while ( it.hasNext() )
             {
                 Developer developer = (Developer) it.next();
 
                 if ( fromDeveloperId.equals( developer.getId() ) )
                 {
                     return new MailSender( developer.getName(), developer.getEmail() );
                 }
             }
             throw new MojoExecutionException(
                 "Missing developer with id '" + fromDeveloperId + "' in the <developers> section in your pom." );
         }
     }
 
     //================================
     // announcement-mail accessors
     //================================
 
     public List getFrom()
     {
         return from;
     }
 
     public void setFrom( List from )
     {
         this.from = from;
     }
 
     public String getFromDeveloperId()
     {
         return fromDeveloperId;
     }
 
     public void setFromDeveloperId( String fromDeveloperId )
     {
         this.fromDeveloperId = fromDeveloperId;
     }
 
     public MailSender getMailSender()
     {
         return mailSender;
     }
 
     public void setMailSender( MailSender mailSender )
     {
         this.mailSender = mailSender;
     }
 
     public String getPassword()
     {
         return password;
     }
 
     public void setPassword( String password )
     {
         this.password = password;
     }
 
     public MavenProject getProject()
     {
         return project;
     }
 
     public void setProject( MavenProject project )
     {
         this.project = project;
     }
 
     public String getSmtpHost()
     {
         return smtpHost;
     }
 
     public void setSmtpHost( String smtpHost )
     {
         this.smtpHost = smtpHost;
     }
 
     public int getSmtpPort()
     {
         return smtpPort;
     }
 
     public void setSmtpPort( int smtpPort )
     {
         this.smtpPort = smtpPort;
     }
 
     public boolean isSslMode()
     {
         return sslMode;
     }
 
     public void setSslMode( boolean sslMode )
     {
         this.sslMode = sslMode;
     }
 
     public String getSubject()
     {
         return subject;
     }
 
     public void setSubject( String subject )
     {
         this.subject = subject;
     }
 
     public String getTemplate()
     {
         return template;
     }
 
     public void setTemplate( String template )
     {
         this.template = template;
     }
 
     public File getTemplateOutputDirectory()
     {
         return templateOutputDirectory;
     }
 
     public void setTemplateOutputDirectory( File templateOutputDirectory )
     {
         this.templateOutputDirectory = templateOutputDirectory;
     }
 
     public List getToAddresses()
     {
         return toAddresses;
     }
 
     public void setToAddresses( List toAddresses )
     {
         this.toAddresses = toAddresses;
     }
 
     public String getUsername()
     {
         return username;
     }
 
     public void setUsername( String username )
     {
         this.username = username;
     }
 }

1		package org.apache.maven.plugin.announcement;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import java.io.File;
23		import java.io.FileNotFoundException;
24		import java.io.FileReader;
25		import java.io.IOException;
26		import java.util.Iterator;
27		import java.util.List;
28
29		import org.apache.maven.model.Developer;
30		import org.apache.maven.plugin.MojoExecutionException;
31		import org.apache.maven.plugin.announcement.mailsender.ProjectJavamailMailSender;
32		import org.apache.maven.project.MavenProject;
33		import org.codehaus.plexus.logging.Logger;
34		import org.codehaus.plexus.logging.console.ConsoleLogger;
35		import org.codehaus.plexus.mailsender.MailMessage;
36		import org.codehaus.plexus.mailsender.MailSenderException;
37		import org.codehaus.plexus.util.IOUtil;
38
39		/**
40		* Goal which sends an announcement through email.
41		*
42		* @author aramirez@exist.com
43		* @version $Id$
44		* @goal announcement-mail
45		* @execute goal="announcement-generate"
46		* @since 2.0-beta-2
47		* @threadSafe
48		*/
49	0	public class AnnouncementMailMojo
50		extends AbstractAnnouncementMojo
51		{
52		//=========================================
53		// announcement-mail goal fields
54		//=========================================
55
56		/**
57		* Possible senders.
58		*
59		* @parameter expression="${project.developers}"
60		* @required
61		* @readonly
62		*/
63		private List from;
64
65		/**
66		* The id of the developer sending the announcement mail. Only used if the <tt>mailSender</tt>
67		* attribute is not set. In this case, this should match the id of one of the developers in
68		* the pom. If a matching developer is not found, then the first developer in the pom will be
69		* used.
70		*
71		* @parameter expression="${changes.fromDeveloperId}"
72		*/
73		private String fromDeveloperId;
74
75		/**
76		* Mail content type to use.
77		* @parameter default-value="text/plain"
78		* @required
79		* @since 2.1
80		*/
81		private String mailContentType;
82
83		/**
84		* Defines the sender of the announcement if the list of developer is empty or
85		* if the sender is not a member of the development team.
86		*
87		* @parameter expression="${changes.mailSender}"
88		*/
89		private MailSender mailSender;
90
91		/**
92		* The password used to send the email.
93		*
94		* @parameter expression="${changes.password}"
95		*/
96		private String password;
97
98		/**
99		* @parameter expression="${project}"
100		* @readonly
101		*/
102		private MavenProject project;
103
104		/**
105		* Smtp Server.
106		*
107		* @parameter expression="${changes.smtpHost}"
108		* @required
109		*/
110		private String smtpHost;
111
112		/**
113		* Port.
114		*
115		* @parameter default-value="25" expression="${changes.smtpPort}"
116		* @required
117		*/
118		private int smtpPort;
119
120		/**
121		* If the email should be sent in SSL mode.
122		*
123		* @parameter default-value="false" expression="${changes.sslMode}"
124		*/
125		private boolean sslMode;
126
127
128		/**
129		* Subject for the email.
130		*
131		* @parameter default-value="[ANNOUNCEMENT] - ${project.name} ${project.version} released" expression="${changes.subject}"
132		* @required
133		*/
134		private String subject;
135
136		/**
137		* The Velocity template used to format the announcement.
138		*
139		* @parameter default-value="announcement.vm" expression="${changes.template}"
140		* @required
141		*/
142		private String template;
143
144		/**
145		* Directory which contains the template for announcement email.
146		*
147		* @parameter expression="${project.build.directory}/announcement"
148		* @required
149		*/
150		private File templateOutputDirectory;
151
152		/**
153		* Recipient email address.
154		*
155		* @parameter
156		* @required
157		*/
158		private List toAddresses;
159
160		/**
161		* The username used to send the email.
162		*
163		* @parameter expression="${changes.username}"
164		*/
165		private String username;
166
167	0	private ProjectJavamailMailSender mailer = new ProjectJavamailMailSender();
168
169		public void execute()
170		throws MojoExecutionException
171		{
172		// Run only at the execution root
173	0	if ( runOnlyAtExecutionRoot && !isThisTheExecutionRoot() )
174		{
175	0	getLog().info( "Skipping the announcement mail in this project because it's not the Execution Root" );
176		}
177		else
178		{
179	0	File templateFile = new File( templateOutputDirectory, template );
180
181	0	ConsoleLogger logger = new ConsoleLogger( Logger.LEVEL_INFO, "base" );
182
183	0	if ( getLog().isDebugEnabled() )
184		{
185	0	logger.setThreshold( Logger.LEVEL_DEBUG );
186		}
187
188	0	mailer.enableLogging( logger );
189
190	0	mailer.setSmtpHost( getSmtpHost() );
191
192	0	mailer.setSmtpPort( getSmtpPort() );
193
194	0	mailer.setSslMode( sslMode );
195
196	0	if ( username != null )
197		{
198	0	mailer.setUsername( username );
199		}
200
201	0	if ( password != null )
202		{
203	0	mailer.setPassword( password );
204		}
205
206	0	mailer.initialize();
207
208	0	if ( getLog().isDebugEnabled() )
209		{
210	0	getLog().debug( "fromDeveloperId: " + getFromDeveloperId() );
211		}
212
213	0	if ( templateFile.isFile() )
214		{
215	0	getLog().info( "Connecting to Host: " + getSmtpHost() + ":" + getSmtpPort() );
216
217	0	sendMessage();
218		}
219		else
220		{
221	0	throw new MojoExecutionException( "Announcement template " + templateFile + " not found..." );
222		}
223		}
224	0	}
225
226		/**
227		* Send the email.
228		*
229		* @throws MojoExecutionException if the mail could not be sent
230		*/
231		protected void sendMessage()
232		throws MojoExecutionException
233		{
234	0	File templateFile = new File( templateOutputDirectory, template );
235	0	String email = "";
236	0	final MailSender ms = getActualMailSender();
237	0	final String fromName = ms.getName();
238	0	final String fromAddress = ms.getEmail();
239	0	if ( fromAddress == null \|\| fromAddress.equals( "" ) )
240		{
241	0	throw new MojoExecutionException( "Invalid mail sender: name and email is mandatory (" + ms + ")." );
242		}
243	0	getLog().info( "Using this sender for email announcement: " + fromAddress + " < " + fromName + " > " );
244		try
245		{
246	0	MailMessage mailMsg = new MailMessage();
247	0	mailMsg.setSubject( getSubject() );
248	0	mailMsg.setContent( IOUtil.toString( readAnnouncement( templateFile ) ) );
249	0	mailMsg.setContentType( this.mailContentType );
250	0	mailMsg.setFrom( fromAddress, fromName );
251	0	final Iterator it = getToAddresses().iterator();
252	0	while ( it.hasNext() )
253		{
254	0	email = it.next().toString();
255	0	getLog().info( "Sending mail to " + email + "..." );
256	0	mailMsg.addTo( email, "" );
257
258		}
259	0	mailer.send( mailMsg );
260	0	getLog().info( "Sent..." );
261		}
262	0	catch ( IOException ioe )
263		{
264	0	throw new MojoExecutionException( "Failed to send email.", ioe );
265		}
266	0	catch ( MailSenderException e )
267		{
268	0	throw new MojoExecutionException( "Failed to send email < " + email + " >", e );
269	0	}
270	0	}
271
272		/**
273		* Read the announcement generated file.
274		*
275		* @param file the file to be read
276		* @return fileReader Return the FileReader
277		* @throws MojoExecutionException if the file could not be found
278		*/
279		protected FileReader readAnnouncement( File file )
280		throws MojoExecutionException
281		{
282		FileReader fileReader;
283		try
284		{
285	0	fileReader = new FileReader( file );
286		}
287	0	catch ( FileNotFoundException fnfe )
288		{
289	0	throw new MojoExecutionException( "File not found. " + file );
290	0	}
291	0	return fileReader;
292		}
293
294		/**
295		* Returns the identify of the mail sender according to the plugin's configuration:
296		* <ul>
297		* <li>if the <tt>mailSender</tt> parameter is set, it is returned</li>
298		* <li>if no <tt>fromDeveloperId</tt> is set, the first developer in the list is returned</li>
299		* <li>if a <tt>fromDeveloperId</tt> is set, the developer with that id is returned</li>
300		* <li>if the developers list is empty or if the specified id does not exist, an exception is thrown</li>
301		* </ul>
302		*
303		* @return the mail sender to use
304		* @throws MojoExecutionException if the mail sender could not be retrieved
305		*/
306		protected MailSender getActualMailSender()
307		throws MojoExecutionException
308		{
309	0	if ( mailSender != null && mailSender.getEmail() != null )
310		{
311	0	return mailSender;
312		}
313	0	else if ( from == null \|\| from.isEmpty() )
314		{
315	0	throw new MojoExecutionException(
316		"The <developers> section in your pom should not be empty. Add a <developer> entry or set the "
317		+ "mailSender parameter." );
318		}
319	0	else if ( fromDeveloperId == null )
320		{
321	0	final Developer dev = (Developer) from.get( 0 );
322	0	return new MailSender( dev.getName(), dev.getEmail() );
323		}
324		else
325		{
326	0	final Iterator it = from.iterator();
327	0	while ( it.hasNext() )
328		{
329	0	Developer developer = (Developer) it.next();
330
331	0	if ( fromDeveloperId.equals( developer.getId() ) )
332		{
333	0	return new MailSender( developer.getName(), developer.getEmail() );
334		}
335	0	}
336	0	throw new MojoExecutionException(
337		"Missing developer with id '" + fromDeveloperId + "' in the <developers> section in your pom." );
338		}
339		}
340
341		//================================
342		// announcement-mail accessors
343		//================================
344
345		public List getFrom()
346		{
347	0	return from;
348		}
349
350		public void setFrom( List from )
351		{
352	0	this.from = from;
353	0	}
354
355		public String getFromDeveloperId()
356		{
357	0	return fromDeveloperId;
358		}
359
360		public void setFromDeveloperId( String fromDeveloperId )
361		{
362	0	this.fromDeveloperId = fromDeveloperId;
363	0	}
364
365		public MailSender getMailSender()
366		{
367	0	return mailSender;
368		}
369
370		public void setMailSender( MailSender mailSender )
371		{
372	0	this.mailSender = mailSender;
373	0	}
374
375		public String getPassword()
376		{
377	0	return password;
378		}
379
380		public void setPassword( String password )
381		{
382	0	this.password = password;
383	0	}
384
385		public MavenProject getProject()
386		{
387	0	return project;
388		}
389
390		public void setProject( MavenProject project )
391		{
392	0	this.project = project;
393	0	}
394
395		public String getSmtpHost()
396		{
397	0	return smtpHost;
398		}
399
400		public void setSmtpHost( String smtpHost )
401		{
402	0	this.smtpHost = smtpHost;
403	0	}
404
405		public int getSmtpPort()
406		{
407	0	return smtpPort;
408		}
409
410		public void setSmtpPort( int smtpPort )
411		{
412	0	this.smtpPort = smtpPort;
413	0	}
414
415		public boolean isSslMode()
416		{
417	0	return sslMode;
418		}
419
420		public void setSslMode( boolean sslMode )
421		{
422	0	this.sslMode = sslMode;
423	0	}
424
425		public String getSubject()
426		{
427	0	return subject;
428		}
429
430		public void setSubject( String subject )
431		{
432	0	this.subject = subject;
433	0	}
434
435		public String getTemplate()
436		{
437	0	return template;
438		}
439
440		public void setTemplate( String template )
441		{
442	0	this.template = template;
443	0	}
444
445		public File getTemplateOutputDirectory()
446		{
447	0	return templateOutputDirectory;
448		}
449
450		public void setTemplateOutputDirectory( File templateOutputDirectory )
451		{
452	0	this.templateOutputDirectory = templateOutputDirectory;
453	0	}
454
455		public List getToAddresses()
456		{
457	0	return toAddresses;
458		}
459
460		public void setToAddresses( List toAddresses )
461		{
462	0	this.toAddresses = toAddresses;
463	0	}
464
465		public String getUsername()
466		{
467	0	return username;
468		}
469
470		public void setUsername( String username )
471		{
472	0	this.username = username;
473	0	}
474		}