KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > junitx > util > ArchiveSuiteBuilder


1 /*
2  * The JUnit-addons Software License, Version 1.0
3  * (based on the Apache Software License, Version 1.1)
4  *
5  * Copyright (c) 2002-2003 Vladimir R. Bossicard. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if
20  * any, must include the following acknowlegement:
21  * "This product includes software developed by Vladimir R.
22  * Bossicard as well as other contributors
23  * (http://junit-addons.sourceforge.net/)."
24  * Alternately, this acknowlegement may appear in the software itself,
25  * if and wherever such third-party acknowlegements normally appear.
26  *
27  * 4. The name "JUnit-addons" must not be used to endorse or promote
28  * products derived from this software without prior written
29  * permission. For written permission, please contact
30  * vbossica@users.sourceforge.net.
31  *
32  * 5. Products derived from this software may not be called "JUnit-addons"
33  * nor may "JUnit-addons" appear in their names without prior written
34  * permission of the project managers.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ======================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals. For more information on the JUnit-addons Project, please
52  * see <http://junit-addons.sourceforge.net/>.
53  */
54
55 package junitx.util;
56
57 import junit.framework.Test;
58 import junit.framework.TestSuite;
59
60 import java.util.Enumeration JavaDoc;
61 import java.util.List JavaDoc;
62 import java.util.Vector JavaDoc;
63 import java.util.zip.ZipEntry JavaDoc;
64 import java.util.zip.ZipFile JavaDoc;
65
66 /**
67  * Extracts the testcases from a zip or jar achive. Use the
68  * <tt>TestFilter</tt> to specify the pattern of the classes to load.
69  *
70  * <h4>Note</h4>
71  * The <tt>jar</tt> archive is handled like a <tt>zip</tt> archive: information
72  * located in the manifest (like a classpath) are ignored.
73  *
74  * <h4>Examples</h4>
75  *
76  * Returns a suite containing all classes matching the pattern "*Test.class":
77  * <p>
78  * <pre>
79  * ArchiveSuiteBuilder builder = new ArchiveSuiteBuilder();
80  * Test suite = builer.suite("myarchive.zip");
81  * </pre>
82  *
83  * Returns a suite containing <tt>AllTests.class</tt> classes:<p>
84  * <pre>
85  * ArchiveSuiteBuilder builder = new ArchiveSuiteBuilder();
86  * builder.setFilter(new TestFilter() {
87  *
88  * public boolean include(String classpath) {
89  * return super.include(classpath) &&
90  * SimpleTestFilter.getClassName(classpath).equals("AllTests");
91  * }
92  *
93  * });
94  *
95  * Test suite = builer.suite("myjar.jar");
96  * </pre>
97  *
98  * @version $Revision: 1.6 $ $Date: 2003/04/28 05:18:28 $
99  * @author <a HREF="mailto:vbossica@users.sourceforge.net">Vladimir R. Bossicard</a>
100  * @author <a HREF="mailto:pbnaidu@users.sourceforge.net">Naidu Purushotham</a>
101  */
102 public class ArchiveSuiteBuilder
103         extends AbstractSuiteBuilder {
104
105     /**
106      * Constructs an empty <tt>ArchiveSuiteBuilder</tt> object.
107      */
108     public ArchiveSuiteBuilder() {
109         this(null);
110     }
111     
112     /**
113      * Constructs an <tt>ArchiveSuiteBuilder</tt> object with the given filter.
114      */
115     public ArchiveSuiteBuilder(TestFilter filter) {
116         super(filter);
117     }
118     
119     /**
120      * Constructs a <tt>TestSuite</tt> by extracting all test classes from the
121      * given <tt>file</tt> archive.
122      */
123     public Test suite(ZipFile JavaDoc file)
124             throws Exception JavaDoc {
125         TestSuite suite = new TestSuite(file.getName());
126
127         List JavaDoc classnames = browse(file);
128         merge(classnames, suite);
129
130         return suite;
131     }
132
133     /**
134      * Constructs a <tt>TestSuite</tt> by extracting all test classes from an
135      * archive specified by the <tt>filename</tt>.
136      */
137     public Test suite(String JavaDoc filename)
138             throws Exception JavaDoc {
139         ZipFile JavaDoc file = new ZipFile JavaDoc(filename);
140         Test result;
141
142         try {
143             result = suite(file);
144         } finally {
145             file.close();
146         }
147
148         return result;
149     }
150
151     /**
152      * Returns the list of test classes contained in the <tt>ZipFile</tt>.
153      * Method defined for testing only: no support guarantee.
154      *
155      * @see ArchiveSuiteBuilder#isTestClass
156      */
157     protected List JavaDoc browse(ZipFile JavaDoc file) {
158         List JavaDoc result = new Vector JavaDoc();
159         Enumeration JavaDoc entries = file.entries();
160         while (entries.hasMoreElements()) {
161             ZipEntry JavaDoc entry = (ZipEntry JavaDoc) entries.nextElement();
162             if (!entry.isDirectory()) {
163                 if (isTestClass(entry.getName())) {
164                     /* we extract the classname from the path, by removing the '.class' and
165                      * replacing the file separator by a '.'. */
166                     String JavaDoc classname = entry.getName().replace('/', '.');
167                     classname = classname.substring(0, classname.length() - 6);
168                     result.add(classname);
169                 }
170             }
171         }
172         return result;
173     }
174
175 }
176
Popular Tags