Coverage Report

Coverage Report - org.apache.maven.report.projectinfo.CimReport

Classes in this File

Line Coverage

Branch Coverage

Complexity

CimReport

100 %

7/7

N/A

3,429

CimReport$CimRenderer

16 %

10/59

3 %

1/28

3,429

 package org.apache.maven.report.projectinfo;
 
 /*
  * 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 org.apache.maven.doxia.sink.Sink;
 import org.apache.maven.model.CiManagement;
 import org.apache.maven.model.Model;
 import org.apache.maven.model.Notifier;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.codehaus.plexus.i18n.I18N;
 import org.codehaus.plexus.util.StringUtils;
 
 import java.util.List;
 import java.util.Locale;
 
 /**
  * Generates the Project Continuous Integration System report.
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton </a>
  * @version $Id: CimReport.java 1359783 2012-07-10 16:57:48Z tchemit $
  * @since 2.0
  */
 @Mojo( name = "cim" )
 public class CimReport
     extends AbstractProjectInfoReport
 {
     // ----------------------------------------------------------------------
     // Public methods
     // ----------------------------------------------------------------------
 
     @Override
     public void executeReport( Locale locale )
     {
         CimRenderer r = new CimRenderer( getSink(), getProject().getModel(), getI18N( locale ), locale );
 
         r.render();
     }
 
     /** {@inheritDoc} */
     public String getOutputName()
     {
         return "integration";
     }
 
     @Override
     protected String getI18Nsection()
     {
         return "cim";
     }
 
     // ----------------------------------------------------------------------
     // Private
     // ----------------------------------------------------------------------
 
     /**
      * Internal renderer class
      */
     private static class CimRenderer
         extends AbstractProjectInfoRenderer
     {
         private Model model;
 
         CimRenderer( Sink sink, Model model, I18N i18n, Locale locale )
         {
             super( sink, i18n, locale );
 
             this.model = model;
         }
 
         @Override
         protected String getI18Nsection()
         {
             return "cim";
         }
 
         @Override
         public void renderBody()
         {
             CiManagement cim = model.getCiManagement();
             if ( cim == null )
             {
                 startSection( getTitle() );
 
                 paragraph( getI18nString( "nocim" ) );
 
                 endSection();
 
                 return;
             }
 
             String system = cim.getSystem();
             String url = cim.getUrl();
             List<Notifier> notifiers = cim.getNotifiers();
 
             // Overview
             startSection( getI18nString( "overview.title" ) );
 
             sink.paragraph();
             if ( isCimSystem( system, "anthill" ) )
             {
                 linkPatternedText( getI18nString( "anthill.intro" ) );
             }
             else if ( isCimSystem( system, "buildforge" ) )
             {
                 linkPatternedText( getI18nString( "buildforge.intro" ) );
             }
             else if ( isCimSystem( system, "continuum" ) )
             {
                 linkPatternedText( getI18nString( "continuum.intro" ) );
             }
             else if ( isCimSystem( system, "cruisecontrol" ) )
             {
                 linkPatternedText( getI18nString( "cruisecontrol.intro" ) );
             }
             else if ( isCimSystem( system, "hudson" ) )
             {
                 linkPatternedText( getI18nString( "hudson.intro" ) );
             }
             else if ( isCimSystem( system, "jenkins" ) )
             {
                 linkPatternedText( getI18nString( "jenkins.intro" ) );
             }
             else if ( isCimSystem( system, "luntbuild" ) )
             {
                 linkPatternedText( getI18nString( "luntbuild.intro" ) );
             }
             else
             {
                 linkPatternedText( getI18nString( "general.intro" ) );
             }
             sink.paragraph_();
 
             endSection();
 
             // Access
             startSection( getI18nString( "access" ) );
 
             if ( !StringUtils.isEmpty( url ) )
             {
                 paragraph( getI18nString( "url" ) );
 
                 verbatimLink( url, url );
             }
             else
             {
                 paragraph( getI18nString( "nourl" ) );
             }
 
             endSection();
 
             // Notifiers
             startSection( getI18nString( "notifiers.title" ) );
 
             if ( notifiers == null || notifiers.isEmpty() )
             {
                 paragraph( getI18nString( "notifiers.nolist" ) );
             }
             else
             {
                 sink.paragraph();
                 sink.text( getI18nString( "notifiers.intro" ) );
                 sink.paragraph_();
 
                 startTable();
 
                 String type = getI18nString( "notifiers.column.type" );
                 String address = getI18nString( "notifiers.column.address" );
                 String configuration = getI18nString( "notifiers.column.configuration" );
 
                 tableHeader( new String[]{type, address, configuration} );
 
                 for ( Notifier notifier : notifiers )
                 {
                     tableRow( new String[]{notifier.getType(),
                         createLinkPatternedText( notifier.getAddress(), notifier.getAddress() ),
                         propertiesToString( notifier.getConfiguration() )} );
                 }
 
                 endTable();
             }
 
             endSection();
         }
 
         /**
          * Checks if a CIM system is bugzilla, continuum...
          *
          * @param connection
          * @param cim
          * @return true if the CIM system is bugzilla, continuum..., false otherwise.
          */
         private boolean isCimSystem( String connection, String cim )
         {
             if ( StringUtils.isEmpty( connection ) )
             {
                 return false;
             }
 
             if ( StringUtils.isEmpty( cim ) )
             {
                 return false;
             }
 
             return connection.toLowerCase( Locale.ENGLISH ).startsWith( cim.toLowerCase( Locale.ENGLISH ) );
         }
     }
 }

1		package org.apache.maven.report.projectinfo;
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 org.apache.maven.doxia.sink.Sink;
23		import org.apache.maven.model.CiManagement;
24		import org.apache.maven.model.Model;
25		import org.apache.maven.model.Notifier;
26		import org.apache.maven.plugins.annotations.Mojo;
27		import org.codehaus.plexus.i18n.I18N;
28		import org.codehaus.plexus.util.StringUtils;
29
30		import java.util.List;
31		import java.util.Locale;
32
33		/**
34		* Generates the Project Continuous Integration System report.
35		*
36		* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton </a>
37		* @version $Id: CimReport.java 1359783 2012-07-10 16:57:48Z tchemit $
38		* @since 2.0
39		*/
40		@Mojo( name = "cim" )
41	1	public class CimReport
42		extends AbstractProjectInfoReport
43		{
44		// ----------------------------------------------------------------------
45		// Public methods
46		// ----------------------------------------------------------------------
47
48		@Override
49		public void executeReport( Locale locale )
50		{
51	1	CimRenderer r = new CimRenderer( getSink(), getProject().getModel(), getI18N( locale ), locale );
52
53	1	r.render();
54	1	}
55
56		/** {@inheritDoc} */
57		public String getOutputName()
58		{
59	2	return "integration";
60		}
61
62		@Override
63		protected String getI18Nsection()
64		{
65	1	return "cim";
66		}
67
68		// ----------------------------------------------------------------------
69		// Private
70		// ----------------------------------------------------------------------
71
72		/**
73		* Internal renderer class
74		*/
75	1	private static class CimRenderer
76		extends AbstractProjectInfoRenderer
77		{
78		private Model model;
79
80		CimRenderer( Sink sink, Model model, I18N i18n, Locale locale )
81		{
82	1	super( sink, i18n, locale );
83
84	1	this.model = model;
85	1	}
86
87		@Override
88		protected String getI18Nsection()
89		{
90	3	return "cim";
91		}
92
93		@Override
94		public void renderBody()
95		{
96	1	CiManagement cim = model.getCiManagement();
97	1	if ( cim == null )
98		{
99	1	startSection( getTitle() );
100
101	1	paragraph( getI18nString( "nocim" ) );
102
103	1	endSection();
104
105	1	return;
106		}
107
108	0	String system = cim.getSystem();
109	0	String url = cim.getUrl();
110	0	List<Notifier> notifiers = cim.getNotifiers();
111
112		// Overview
113	0	startSection( getI18nString( "overview.title" ) );
114
115	0	sink.paragraph();
116	0	if ( isCimSystem( system, "anthill" ) )
117		{
118	0	linkPatternedText( getI18nString( "anthill.intro" ) );
119		}
120	0	else if ( isCimSystem( system, "buildforge" ) )
121		{
122	0	linkPatternedText( getI18nString( "buildforge.intro" ) );
123		}
124	0	else if ( isCimSystem( system, "continuum" ) )
125		{
126	0	linkPatternedText( getI18nString( "continuum.intro" ) );
127		}
128	0	else if ( isCimSystem( system, "cruisecontrol" ) )
129		{
130	0	linkPatternedText( getI18nString( "cruisecontrol.intro" ) );
131		}
132	0	else if ( isCimSystem( system, "hudson" ) )
133		{
134	0	linkPatternedText( getI18nString( "hudson.intro" ) );
135		}
136	0	else if ( isCimSystem( system, "jenkins" ) )
137		{
138	0	linkPatternedText( getI18nString( "jenkins.intro" ) );
139		}
140	0	else if ( isCimSystem( system, "luntbuild" ) )
141		{
142	0	linkPatternedText( getI18nString( "luntbuild.intro" ) );
143		}
144		else
145		{
146	0	linkPatternedText( getI18nString( "general.intro" ) );
147		}
148	0	sink.paragraph_();
149
150	0	endSection();
151
152		// Access
153	0	startSection( getI18nString( "access" ) );
154
155	0	if ( !StringUtils.isEmpty( url ) )
156		{
157	0	paragraph( getI18nString( "url" ) );
158
159	0	verbatimLink( url, url );
160		}
161		else
162		{
163	0	paragraph( getI18nString( "nourl" ) );
164		}
165
166	0	endSection();
167
168		// Notifiers
169	0	startSection( getI18nString( "notifiers.title" ) );
170
171	0	if ( notifiers == null \|\| notifiers.isEmpty() )
172		{
173	0	paragraph( getI18nString( "notifiers.nolist" ) );
174		}
175		else
176		{
177	0	sink.paragraph();
178	0	sink.text( getI18nString( "notifiers.intro" ) );
179	0	sink.paragraph_();
180
181	0	startTable();
182
183	0	String type = getI18nString( "notifiers.column.type" );
184	0	String address = getI18nString( "notifiers.column.address" );
185	0	String configuration = getI18nString( "notifiers.column.configuration" );
186
187	0	tableHeader( new String[]{type, address, configuration} );
188
189	0	for ( Notifier notifier : notifiers )
190		{
191	0	tableRow( new String[]{notifier.getType(),
192		createLinkPatternedText( notifier.getAddress(), notifier.getAddress() ),
193		propertiesToString( notifier.getConfiguration() )} );
194		}
195
196	0	endTable();
197		}
198
199	0	endSection();
200	0	}
201
202		/**
203		* Checks if a CIM system is bugzilla, continuum...
204		*
205		* @param connection
206		* @param cim
207		* @return true if the CIM system is bugzilla, continuum..., false otherwise.
208		*/
209		private boolean isCimSystem( String connection, String cim )
210		{
211	0	if ( StringUtils.isEmpty( connection ) )
212		{
213	0	return false;
214		}
215
216	0	if ( StringUtils.isEmpty( cim ) )
217		{
218	0	return false;
219		}
220
221	0	return connection.toLowerCase( Locale.ENGLISH ).startsWith( cim.toLowerCase( Locale.ENGLISH ) );
222		}
223		}
224		}