anttestsetgen

Clover coverage report - anttestsetgen - 1.1

Coverage timestamp: zo jan 4 2004 17:34:16 CET

file stats:	LOC:	272		Methods:	12
	NCLOC:	107		Classes:	1

30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover

Source file

Conditionals

Statements

Methods

TOTAL

TestSet.java

88,9%

95,6%

100%

94,7%

 /*
  * Copyright (C) 2003, Marco Jansen / Contrado Technologies  (http://www.contrado.nl)
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful, but
  * WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * General Public License for more details.
  */
 
 package net.sourceforge.anttestsetgen;
 
 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.Task;
 
 import java.sql.Connection;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.util.ArrayList;
 import java.util.List;
 
 /**
  * A TestSet contains the description of a test set.
  * <p/>
  * A TestSet has the following attributes:
  * - name
  * - rowtoselect
  * <p/>
  * A TestSet has the following subtasks:
  * - Query
  * - Entries
  * 
  * @author <a href="mailto:m.c.jansen.spam at planet.nl">Marco Jansen (Contrado Technologies)</a>
  * @version $Id: TestSet.java,v 1.3 2004/01/04 15:00:18 mcjansen Exp $
  */
 public class TestSet extends Task {
 
   /** Select the first valid row from the result set. */
   public static final String SELECT_FIRST_ROW = "First";
 
   /** Select all valid rows from the result set. */
   public static final String SELECT_ALL = "All";
 
   /** The name of the test set. */
   private String name;
 
   /**
    * The row to select.
    * 
    * @see #SELECT_ALL
    * @see #SELECT_FIRST_ROW
    */
   private String rowtoselect = SELECT_FIRST_ROW;
 
   /** The sql query that should be used to retrieve the property values from the database. */
   private Query query = null;
 
   /** A list with entries that define the mapping from the database results to the propert file. */
   private List entries = new ArrayList();
 
   /** An optional validation class, used perform an additional validation on the results from the database. */
   private Validation validation = null;
 
   /** A list that contains the unique entries. Used to determine if a property file entry already is used. */
   private List uniqueEntriesInTestSet = new ArrayList();
 
   /**
    * Set the name attribute.
    * 
    * @param name The name of the TestSet
    * @see #getName
    */
   public void setName(String name) {
     this.name = name;
   }
 
   /**
    * Retreive the name attribute.
    * 
    * @return A string with the name of the TestSet
    * @see #setName
    */
   public String getName() {
     return AntTestSetGenUtil.requiredCheck("name", name);
   }
 
   /**
    * Set the rowtoselect attribute. This attribute defines which row should be select from the resultset. The attribute
    * can contain the following values:
    * - first
    * - last
    * - random
    * <p/>
    * The default value for this attribute is the first row.
    * 
    * @param rowtoselect Defines which row should be selected from the resultset: the first, the last or a random row.
    * @throws org.apache.tools.ant.BuildException
    *          A BuildException is thrown if rowtoselect contains an invalid value.
    * @see #getRowtoselect
    */
   public void setRowtoselect(String rowtoselect) throws BuildException {
 
     if (rowtoselect == null || SELECT_FIRST_ROW.toUpperCase().equals(rowtoselect.toUpperCase())) {
       this.rowtoselect = SELECT_FIRST_ROW;
     } else if (SELECT_ALL.toUpperCase().equals(rowtoselect.toUpperCase())) {
       this.rowtoselect = SELECT_ALL;
     } else {
       throw new BuildException("Rowtoselect should contain either " + SELECT_FIRST_ROW + " or " + SELECT_ALL);
     }
 
   }
 
   /**
    * Retrieve the rowtoselect attribute.
    * 
    * @return The row that is used from the resultset (The first, the last or a random rowtoselect)
    * @throws org.apache.tools.ant.BuildException
    *          A BuildException is thrown in rowtoselect contains an invalid value.
    * @see #setRowtoselect
    */
   public String getRowtoselect() {
     return rowtoselect;
   }
 
   /**
    * Retrieve a list with all the unique entries in the test set.
    * 
    * @return a list with the names of the unique entries. The elements are of type String
    */
   public List getUniqueEntriesInTestSet() {
     return uniqueEntriesInTestSet;
   }
 
   /**
    * Add a Query to the TestSet. A TestSet should contain only one query. If more queries are added
    * a BuildException is thrown.
    * 
    * @param query The query to added to the TestSet
    * @throws org.apache.tools.ant.BuildException
    *          A BuildException is thrown in more then one queries are added
    * @see #getQuery
    */
   public void addConfiguredQuery(Query query) throws BuildException {
     if (this.query == null) {
       this.query = query;
     } else {
       throw new BuildException("A TestSet should contain only one query.");
     }
   }
 
   /**
    * Retrieve the query from the TestSet. If there are any ant properties, replaced them with their values.
    * 
    * @return The query from the TestSet. If there is no query defined, null is returned.
    * @throws org.apache.tools.ant.BuildException
    *          In case the test set doesn't contain a query.
    * @see #addConfiguredQuery
    */
   public String getQuery() throws BuildException {
     if (query != null) {
       return query.toString();
     } else {
       throw new BuildException("A TestSet should contain a query!");
     }
   }
 
   /**
    * Add an Configured Validation to this TestSet.
    * 
    * @param validation The validation class (required)
    * @throws org.apache.tools.ant.BuildException
    *          In case there already is a validation defined in this testset.
    * @see #getValidation
    */
   public void addConfiguredValidation(Validation validation) throws BuildException {
     if (this.validation == null) {
       this.validation = validation;
     } else {
       throw new BuildException("A TestSet should contain only one validation.");
     }
   }
 
   /**
    * Retrieve the validation class.
    * 
    * @return The validation class
    * @see #addConfiguredValidation
    */
   public Validation getValidation() {
     return validation;
   }
 
   /**
    * Add a entry to the testset.
    * 
    * @param entry A entry that describes how to map a database column on a key in the property file.
    */
   public void addConfiguredEntry(Entry entry) {
     if (!uniqueEntriesInTestSet.contains(entry.getKey())) {
       uniqueEntriesInTestSet.add(entry.getKey());
     } else {
       log(entry.getKey() + " already defined as entry ", Project.MSG_WARN);
     }
     entries.add(entry);
   }
 
   /**
    * Retrieve of the entries of the TestSet. A warning is given if there are no entries.
    * 
    * @return A list with entries of the TestSet. The elements of the list are of type Entry
    * @see Entry
    */
   public List getEntries() {
     if (entries.size() == 0) {
       log("The TestSet " + getName() + " doesn't contain any entries that describes the mapping to the property file", Project.MSG_WARN);
     }
     return entries;
   }
 
   /**
    * Generate a testset.
    * 
    * @param connection An open connection to the database
    */
   public void generateTestSet(Connection connection) {
 
     // Check required fields
     getName();
     getRowtoselect();
     getQuery();
 
     log("rowtoselect set to " + rowtoselect, Project.MSG_VERBOSE);
 
     Statement statement = null;
     ResultSet resultSet = null;
 
     // Execute the query
     log("Generating TestSet " + name, Project.MSG_INFO);
 
     try {
       log("Executing query: " + query, Project.MSG_VERBOSE);
 
       statement = connection.createStatement(ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_READ_ONLY);
       resultSet = statement.executeQuery(query.toString());
 
       for (int i = 0; i < entries.size(); i++) {
         Entry entry = (Entry) entries.get(i);
         entry.processResult(resultSet, this);
       }
 
     } catch (SQLException e) {
       throw new BuildException("Error while executing query for '" + name + "': " + e.getMessage());
 
     } finally {
       if (statement != null) {
         try {
           statement.close();
         } catch (SQLException e) {
           throw new BuildException("Error while closing database connection for test set '" + name + "': " + e.getMessage());
         }
       }
     }
   }
 
 }
 

1		/*
2		* Copyright (C) 2003, Marco Jansen / Contrado Technologies (http://www.contrado.nl)
3		*
4		* This program is free software; you can redistribute it and/or
5		* modify it under the terms of the GNU General Public License as
6		* published by the Free Software Foundation; either version 2 of the
7		* License, or (at your option) any later version.
8		*
9		* This program is distributed in the hope that it will be useful, but
10		* WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12		* General Public License for more details.
13		*/
14
15		package net.sourceforge.anttestsetgen;
16
17		import org.apache.tools.ant.BuildException;
18		import org.apache.tools.ant.Project;
19		import org.apache.tools.ant.Task;
20
21		import java.sql.Connection;
22		import java.sql.ResultSet;
23		import java.sql.SQLException;
24		import java.sql.Statement;
25		import java.util.ArrayList;
26		import java.util.List;
27
28		/**
29		* A TestSet contains the description of a test set.
30		* <p/>
31		* A TestSet has the following attributes:
32		* - name
33		* - rowtoselect
34		* <p/>
35		* A TestSet has the following subtasks:
36		* - Query
37		* - Entries
38		*
39		* @author <a href="mailto:m.c.jansen.spam at planet.nl">Marco Jansen (Contrado Technologies)</a>
40		* @version $Id: TestSet.java,v 1.3 2004/01/04 15:00:18 mcjansen Exp $
41		*/
42		public class TestSet extends Task {
43
44		/** Select the first valid row from the result set. */
45		public static final String SELECT_FIRST_ROW = "First";
46
47		/** Select all valid rows from the result set. */
48		public static final String SELECT_ALL = "All";
49
50		/** The name of the test set. */
51		private String name;
52
53		/**
54		* The row to select.
55		*
56		* @see #SELECT_ALL
57		* @see #SELECT_FIRST_ROW
58		*/
59		private String rowtoselect = SELECT_FIRST_ROW;
60
61		/** The sql query that should be used to retrieve the property values from the database. */
62		private Query query = null;
63
64		/** A list with entries that define the mapping from the database results to the propert file. */
65		private List entries = new ArrayList();
66
67		/** An optional validation class, used perform an additional validation on the results from the database. */
68		private Validation validation = null;
69
70		/** A list that contains the unique entries. Used to determine if a property file entry already is used. */
71		private List uniqueEntriesInTestSet = new ArrayList();
72
73		/**
74		* Set the name attribute.
75		*
76		* @param name The name of the TestSet
77		* @see #getName
78		*/
79	78	public void setName(String name) {
80	78	this.name = name;
81		}
82
83		/**
84		* Retreive the name attribute.
85		*
86		* @return A string with the name of the TestSet
87		* @see #setName
88		*/
89	162	public String getName() {
90	162	return AntTestSetGenUtil.requiredCheck("name", name);
91		}
92
93		/**
94		* Set the rowtoselect attribute. This attribute defines which row should be select from the resultset. The attribute
95		* can contain the following values:
96		* - first
97		* - last
98		* - random
99		* <p/>
100		* The default value for this attribute is the first row.
101		*
102		* @param rowtoselect Defines which row should be selected from the resultset: the first, the last or a random row.
103		* @throws org.apache.tools.ant.BuildException
104		* A BuildException is thrown if rowtoselect contains an invalid value.
105		* @see #getRowtoselect
106		*/
107	78	public void setRowtoselect(String rowtoselect) throws BuildException {
108
109	78	if (rowtoselect == null \|\| SELECT_FIRST_ROW.toUpperCase().equals(rowtoselect.toUpperCase())) {
110	66	this.rowtoselect = SELECT_FIRST_ROW;
111	12	} else if (SELECT_ALL.toUpperCase().equals(rowtoselect.toUpperCase())) {
112	10	this.rowtoselect = SELECT_ALL;
113		} else {
114	2	throw new BuildException("Rowtoselect should contain either " + SELECT_FIRST_ROW + " or " + SELECT_ALL);
115		}
116
117		}
118
119		/**
120		* Retrieve the rowtoselect attribute.
121		*
122		* @return The row that is used from the resultset (The first, the last or a random rowtoselect)
123		* @throws org.apache.tools.ant.BuildException
124		* A BuildException is thrown in rowtoselect contains an invalid value.
125		* @see #setRowtoselect
126		*/
127	526	public String getRowtoselect() {
128	526	return rowtoselect;
129		}
130
131		/**
132		* Retrieve a list with all the unique entries in the test set.
133		*
134		* @return a list with the names of the unique entries. The elements are of type String
135		*/
136	72	public List getUniqueEntriesInTestSet() {
137	72	return uniqueEntriesInTestSet;
138		}
139
140		/**
141		* Add a Query to the TestSet. A TestSet should contain only one query. If more queries are added
142		* a BuildException is thrown.
143		*
144		* @param query The query to added to the TestSet
145		* @throws org.apache.tools.ant.BuildException
146		* A BuildException is thrown in more then one queries are added
147		* @see #getQuery
148		*/
149	76	public void addConfiguredQuery(Query query) throws BuildException {
150	76	if (this.query == null) {
151	74	this.query = query;
152		} else {
153	2	throw new BuildException("A TestSet should contain only one query.");
154		}
155		}
156
157		/**
158		* Retrieve the query from the TestSet. If there are any ant properties, replaced them with their values.
159		*
160		* @return The query from the TestSet. If there is no query defined, null is returned.
161		* @throws org.apache.tools.ant.BuildException
162		* In case the test set doesn't contain a query.
163		* @see #addConfiguredQuery
164		*/
165	78	public String getQuery() throws BuildException {
166	78	if (query != null) {
167	76	return query.toString();
168		} else {
169	2	throw new BuildException("A TestSet should contain a query!");
170		}
171		}
172
173		/**
174		* Add an Configured Validation to this TestSet.
175		*
176		* @param validation The validation class (required)
177		* @throws org.apache.tools.ant.BuildException
178		* In case there already is a validation defined in this testset.
179		* @see #getValidation
180		*/
181	18	public void addConfiguredValidation(Validation validation) throws BuildException {
182	18	if (this.validation == null) {
183	18	this.validation = validation;
184		} else {
185	0	throw new BuildException("A TestSet should contain only one validation.");
186		}
187		}
188
189		/**
190		* Retrieve the validation class.
191		*
192		* @return The validation class
193		* @see #addConfiguredValidation
194		*/
195	288	public Validation getValidation() {
196	288	return validation;
197		}
198
199		/**
200		* Add a entry to the testset.
201		*
202		* @param entry A entry that describes how to map a database column on a key in the property file.
203		*/
204	86	public void addConfiguredEntry(Entry entry) {
205	86	if (!uniqueEntriesInTestSet.contains(entry.getKey())) {
206	82	uniqueEntriesInTestSet.add(entry.getKey());
207		} else {
208	2	log(entry.getKey() + " already defined as entry ", Project.MSG_WARN);
209		}
210	84	entries.add(entry);
211		}
212
213		/**
214		* Retrieve of the entries of the TestSet. A warning is given if there are no entries.
215		*
216		* @return A list with entries of the TestSet. The elements of the list are of type Entry
217		* @see Entry
218		*/
219	550	public List getEntries() {
220	550	if (entries.size() == 0) {
221	4	log("The TestSet " + getName() + " doesn't contain any entries that describes the mapping to the property file", Project.MSG_WARN);
222		}
223	550	return entries;
224		}
225
226		/**
227		* Generate a testset.
228		*
229		* @param connection An open connection to the database
230		*/
231	80	public void generateTestSet(Connection connection) {
232
233		// Check required fields
234	80	getName();
235	78	getRowtoselect();
236	78	getQuery();
237
238	76	log("rowtoselect set to " + rowtoselect, Project.MSG_VERBOSE);
239
240	76	Statement statement = null;
241	76	ResultSet resultSet = null;
242
243		// Execute the query
244	76	log("Generating TestSet " + name, Project.MSG_INFO);
245
246	76	try {
247	76	log("Executing query: " + query, Project.MSG_VERBOSE);
248
249	76	statement = connection.createStatement(ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_READ_ONLY);
250	76	resultSet = statement.executeQuery(query.toString());
251
252	74	for (int i = 0; i < entries.size(); i++) {
253	102	Entry entry = (Entry) entries.get(i);
254	102	entry.processResult(resultSet, this);
255		}
256
257		} catch (SQLException e) {
258	2	throw new BuildException("Error while executing query for '" + name + "': " + e.getMessage());
259
260		} finally {
261	76	if (statement != null) {
262	76	try {
263	76	statement.close();
264		} catch (SQLException e) {
265	0	throw new BuildException("Error while closing database connection for test set '" + name + "': " + e.getMessage());
266		}
267		}
268		}
269		}
270
271		}
272