Coverage Report

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

Classes in this File

0/108

0/34

 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: org.apache.maven.plugin.announcement.AnnouncementMailMojo.html 816595 2012-05-08 12:43:00Z hboutemy $
  * @goal announcement-mail
  * @execute goal="announcement-generate"
  */
 public class AnnouncementMailMojo
     extends AbstractAnnouncementMojo
 {
     //=========================================
     // announcement-mail goal fields
     //=========================================
 
     /**
      * @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;
 
     /**
      * The username used to send the email.
      *
      * @parameter expression="${changes.username}"
      */
     private String username;
 
     /**
      * The password used to send the email.
      *
      * @parameter expression="${changes.password}"
      */
     private String password;
 
     /**
      * 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 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;
 
     /**
      * 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;
 
 
     /**
      * Recipient email address.
      *
      * @parameter
      * @required
      */
     private List toAddresses;
 
     /**
      * Possible senders.
      *
      * @parameter expression="${project.developers}"
      * @required
      * @readonly
      */
     private List from;
 
     /**
      * Directory which contains the template for announcement email.
      *
      * @parameter expression="${project.build.directory}/announcement"
      * @required
      */
     private File templateOutputDirectory;
 
     /**
      * The Velocity template used to format the announcement.
      *
      * @parameter default-value="announcement.vm" expression="${changes.template}"
      * @required
      */
     private String template;
 
     /**
      * Mail content type to use.
      * @parameter default-value="text/plain"
      * @required
      * @since 2.1
      */
     private String mailContentType;
 
     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 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 String getSubject()
     {
         return subject;
     }
 
     public void setSubject( String subject )
     {
         this.subject = subject;
     }
 
     public List getFrom()
     {
         return from;
     }
 
     public void setFrom( List from )
     {
         this.from = from;
     }
 
     public MavenProject getProject()
     {
         return project;
     }
 
     public void setProject( MavenProject project )
     {
         this.project = project;
     }
 
     public List getToAddresses()
     {
         return toAddresses;
     }
 
     public void setToAddresses( List toAddresses )
     {
         this.toAddresses = toAddresses;
     }
 
     public String getFromDeveloperId()
     {
         return fromDeveloperId;
     }
 
     public void setFromDeveloperId( String fromDeveloperId )
     {
         this.fromDeveloperId = fromDeveloperId;
     }
 
 
     public String getUsername()
     {
         return username;
     }
 
     public void setUsername( String username )
     {
         this.username = username;
     }
 
     public String getPassword()
     {
         return password;
     }
 
     public void setPassword( String password )
     {
         this.password = password;
     }
 
     public boolean isSslMode()
     {
         return sslMode;
     }
 
     public void setSslMode( boolean sslMode )
     {
         this.sslMode = sslMode;
     }
 
     public MailSender getMailSender()
     {
         return mailSender;
     }
 
     public void setMailSender( MailSender mailSender )
     {
         this.mailSender = mailSender;
     }
 
     public File getTemplateOutputDirectory()
     {
         return templateOutputDirectory;
     }
 
     public void setTemplateOutputDirectory( File templateOutputDirectory )
     {
         this.templateOutputDirectory = templateOutputDirectory;
     }
 
     public String getTemplate()
     {
         return template;
     }
 
     public void setTemplate( String template )
     {
         this.template = template;
     }
 }

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