Coverage Report

Coverage Report - org.tap4j.model.TestSet

Classes in this File

Line Coverage

Branch Coverage

Complexity

TestSet

100%

74/74

93%

28/30

1.483

 /*
  * The MIT License
  *
  * Copyright (c) <2010> <tap4j>
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  * 
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  * 
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
 package org.tap4j.model;
 
 import java.io.Serializable;
 import java.util.LinkedList;
 import java.util.List;
 
 import org.tap4j.util.StatusValues;
 
 /**
  * A Test Set is the top element in a TAP File. It holds references to the
  * Header, Plan, List of Test Results and the rest of elements in TAP spec.
  * 
  * @since 1.0
  */
 public class TestSet implements Serializable {
 
     /*
      * Serial Version UID.
      */
     private static final long serialVersionUID = 114777557084672201L;
 
     /**
      * TAP Header.
      */
     private Header header;
 
     /**
      * TAP Plan.
      */
     private Plan plan;
 
     /**
      * List of TAP Lines.
      */
     private List<TapResult> tapLines = new LinkedList<TapResult>();
 
     /**
      * List of Test Results.
      */
     private List<TestResult> testResults = new LinkedList<TestResult>();
 
     /**
      * List of Bail Outs.
      */
     private List<BailOut> bailOuts = new LinkedList<BailOut>();
 
     /**
      * List of comments.
      */
     private List<Comment> comments = new LinkedList<Comment>();
 
     /**
      * TAP Footer.
      */
     private Footer footer;
 
     /**
      * Default constructor.
      */
     public TestSet() {
         super();
     }
 
     /**
      * @return TAP Header.
      */
     public Header getHeader() {
         return this.header;
     }
 
     /**
      * @param header TAP Header.
      */
     public void setHeader(Header header) {
         this.header = header;
     }
 
     /**
      * @return TAP Plan.
      */
     public Plan getPlan() {
         return this.plan;
     }
 
     /**
      * @param plan TAP Plan.
      */
     public void setPlan(Plan plan) {
         this.plan = plan;
     }
 
     /**
      * @return List of TAP Lines. These lines may be either a TestResult or a
      *         BailOut.
      */
     public List<TapResult> getTapLines() {
         return this.tapLines;
     }
 
     /**
      * @return List of Test Results.
      */
     public List<TestResult> getTestResults() {
         return this.testResults;
     }
     
     /**
      * @return Next test number.
      */
     public int getNextTestNumber() {
         return (this.testResults.size() + 1);
     }
 
     /**
      * @return List of Bail Outs.
      */
     public List<BailOut> getBailOuts() {
         return this.bailOuts;
     }
 
     /**
      * @return List of Comments.
      */
     public List<Comment> getComments() {
         return this.comments;
     }
 
     /**
      * Adds a new TAP Line.
      * 
      * @param tapLine TAP Line.
      * @return True if the TAP Line could be added into the list successfully.
      */
     public boolean addTapLine(TapResult tapLine) {
         return this.tapLines.add(tapLine);
     }
 
     /**
      * Adds a TestResult into the list of TestResults. If the TestResult Test
      * Number is null or less than or equals to zero it is changed to the next
      * Test Number in the sequence.
      * 
      * @param testResult TAP TestResult.
      * @return Whether could add to TestResult list or not.
      */
     public boolean addTestResult(TestResult testResult) {
         if (testResult.getTestNumber() == null ||
             testResult.getTestNumber() <= 0) {
             testResult.setTestNumber(this.testResults.size() + 1);
         }
         this.testResults.add(testResult);
         return this.tapLines.add(testResult);
     }
 
     /**
      * @param bailOut Bail Out.
      * @return Whether could add to BailOut list or not.
      */
     public boolean addBailOut(BailOut bailOut) {
         this.bailOuts.add(bailOut);
         return this.tapLines.add(bailOut);
     }
 
     /**
      * @param comment Comment. Whether could add to Comment list or not.
      */
     public boolean addComment(Comment comment) {
         this.comments.add(comment);
         return this.tapLines.add(comment);
     }
 
     /**
      * Removes a TAP Line from the list.
      * 
      * @param tapLine TAP Line object.
      * @return True if could successfully remove the TAP Line from the list.
      */
     protected boolean removeTapLine(TapResult tapLine) {
         return this.tapLines.remove(tapLine);
     }
 
     /**
      * Removes a Test Result from the list.
      * 
      * @param testResult Test Result.
      * @return True if could successfully remove the Test Result from the list.
      */
     public boolean removeTestResult(TestResult testResult) {
         boolean flag = false;
         if (this.tapLines.remove(testResult)) {
             this.testResults.remove(testResult);
             flag = true;
         }
         return flag;
     }
 
     /**
      * Removes a Bail Out from the list.
      * 
      * @param bailOut Bail Out object.
      * @return True if could successfully remove the Bail Out from the list.
      */
     public boolean removeBailOut(BailOut bailOut) {
         boolean flag = false;
         if (this.tapLines.remove(bailOut)) {
             this.bailOuts.remove(bailOut);
             flag = true;
         }
         return flag;
     }
 
     /**
      * Removes a Comment from the list.
      * 
      * @param comment Comment.
      * @return True if could successfully remove the Comment from the list.
      */
     public boolean removeComment(Comment comment) {
         boolean flag = false;
         if (this.tapLines.remove(comment)) {
             this.comments.remove(comment);
             flag = true;
         }
         return flag;
     }
 
     /**
      * @return Number of TAP Lines. It includes Test Results, Bail Outs and
      *         Comments (the footer is not included).
      */
     public int getNumberOfTapLines() {
         return this.tapLines.size();
     }
 
     /**
      * @return Number of Test Results.
      */
     public int getNumberOfTestResults() {
         return this.testResults.size();
     }
 
     /**
      * @return Number of Bail Outs.
      */
     public int getNumberOfBailOuts() {
         return this.bailOuts.size();
     }
 
     /**
      * @return Number of Comments.
      */
     public int getNumberOfComments() {
         return this.comments.size();
     }
 
     /**
      * @return Footer
      */
     public Footer getFooter() {
         return this.footer;
     }
 
     /**
      * @param footer Footer
      */
     public void setFooter(Footer footer) {
         this.footer = footer;
     }
 
     /**
      * @return True if it has any Bail Out statement, false otherwise.
      */
     public boolean hasBailOut() {
         boolean isBailOut = false;
 
         for (TapResult tapLine : tapLines) {
             if (tapLine instanceof BailOut) {
                 isBailOut = true;
                 break;
             }
         }
 
         return isBailOut;
     }
 
     /*
      * (non-Javadoc)
      * @see org.tap4j.TapConsumer#containsOk()
      */
     public Boolean containsOk() {
         Boolean containsOk = false;
 
         for (TestResult testResult : this.testResults) {
             if (testResult.getStatus().equals(StatusValues.OK)) {
                 containsOk = true;
                 break;
             }
         }
 
         return containsOk;
     }
 
     /*
      * (non-Javadoc)
      * @see org.tap4j.TapConsumer#containsNotOk()
      */
     public Boolean containsNotOk() {
         Boolean containsNotOk = false;
 
         for (TestResult testResult : this.testResults) {
             if (testResult.getStatus().equals(StatusValues.NOT_OK)) {
                 containsNotOk = true;
                 break;
             }
         }
 
         return containsNotOk;
     }
 
     /*
      * (non-Javadoc)
      * @see org.tap4j.TapConsumer#containsBailOut()
      */
     public Boolean containsBailOut() {
         return this.bailOuts.size() > 0;
     }
 
     /*
      * (non-Javadoc)
      * @see org.tap4j.TapConsumer#getTestResult(java.lang.Integer)
      */
     public TestResult getTestResult(Integer testNumber) {
         TestResult foundTestResult = null;
 
         for (TestResult testResult : this.testResults) {
             if (testResult.getTestNumber() != null &&
                 testResult.getTestNumber().equals(testNumber)) {
                 foundTestResult = testResult;
                 break;
             }
         }
 
         return foundTestResult;
     }
 
 }

1		/*
2		* The MIT License
3		*
4		* Copyright (c) <2010> <tap4j>
5		*
6		* Permission is hereby granted, free of charge, to any person obtaining a copy
7		* of this software and associated documentation files (the "Software"), to deal
8		* in the Software without restriction, including without limitation the rights
9		* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10		* copies of the Software, and to permit persons to whom the Software is
11		* furnished to do so, subject to the following conditions:
12		*
13		* The above copyright notice and this permission notice shall be included in
14		* all copies or substantial portions of the Software.
15		*
16		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22		* THE SOFTWARE.
23		*/
24		package org.tap4j.model;
25
26		import java.io.Serializable;
27		import java.util.LinkedList;
28		import java.util.List;
29
30		import org.tap4j.util.StatusValues;
31
32		/**
33		* A Test Set is the top element in a TAP File. It holds references to the
34		* Header, Plan, List of Test Results and the rest of elements in TAP spec.
35		*
36		* @since 1.0
37		*/
38		public class TestSet implements Serializable {
39
40		/*
41		* Serial Version UID.
42		*/
43		private static final long serialVersionUID = 114777557084672201L;
44
45		/**
46		* TAP Header.
47		*/
48		private Header header;
49
50		/**
51		* TAP Plan.
52		*/
53		private Plan plan;
54
55		/**
56		* List of TAP Lines.
57		*/
58	129	private List<TapResult> tapLines = new LinkedList<TapResult>();
59
60		/**
61		* List of Test Results.
62		*/
63	129	private List<TestResult> testResults = new LinkedList<TestResult>();
64
65		/**
66		* List of Bail Outs.
67		*/
68	129	private List<BailOut> bailOuts = new LinkedList<BailOut>();
69
70		/**
71		* List of comments.
72		*/
73	129	private List<Comment> comments = new LinkedList<Comment>();
74
75		/**
76		* TAP Footer.
77		*/
78		private Footer footer;
79
80		/**
81		* Default constructor.
82		*/
83		public TestSet() {
84	129	super();
85	129	}
86
87		/**
88		* @return TAP Header.
89		*/
90		public Header getHeader() {
91	54	return this.header;
92		}
93
94		/**
95		* @param header TAP Header.
96		*/
97		public void setHeader(Header header) {
98	24	this.header = header;
99	24	}
100
101		/**
102		* @return TAP Plan.
103		*/
104		public Plan getPlan() {
105	138	return this.plan;
106		}
107
108		/**
109		* @param plan TAP Plan.
110		*/
111		public void setPlan(Plan plan) {
112	52	this.plan = plan;
113	52	}
114
115		/**
116		* @return List of TAP Lines. These lines may be either a TestResult or a
117		* BailOut.
118		*/
119		public List<TapResult> getTapLines() {
120	101	return this.tapLines;
121		}
122
123		/**
124		* @return List of Test Results.
125		*/
126		public List<TestResult> getTestResults() {
127	55	return this.testResults;
128		}
129
130		/**
131		* @return Next test number.
132		*/
133		public int getNextTestNumber() {
134	2	return (this.testResults.size() + 1);
135		}
136
137		/**
138		* @return List of Bail Outs.
139		*/
140		public List<BailOut> getBailOuts() {
141	36	return this.bailOuts;
142		}
143
144		/**
145		* @return List of Comments.
146		*/
147		public List<Comment> getComments() {
148	3	return this.comments;
149		}
150
151		/**
152		* Adds a new TAP Line.
153		*
154		* @param tapLine TAP Line.
155		* @return True if the TAP Line could be added into the list successfully.
156		*/
157		public boolean addTapLine(TapResult tapLine) {
158	62	return this.tapLines.add(tapLine);
159		}
160
161		/**
162		* Adds a TestResult into the list of TestResults. If the TestResult Test
163		* Number is null or less than or equals to zero it is changed to the next
164		* Test Number in the sequence.
165		*
166		* @param testResult TAP TestResult.
167		* @return Whether could add to TestResult list or not.
168		*/
169		public boolean addTestResult(TestResult testResult) {
170	203	if (testResult.getTestNumber() == null \|\|
171		testResult.getTestNumber() <= 0) {
172	105	testResult.setTestNumber(this.testResults.size() + 1);
173		}
174	203	this.testResults.add(testResult);
175	203	return this.tapLines.add(testResult);
176		}
177
178		/**
179		* @param bailOut Bail Out.
180		* @return Whether could add to BailOut list or not.
181		*/
182		public boolean addBailOut(BailOut bailOut) {
183	9	this.bailOuts.add(bailOut);
184	9	return this.tapLines.add(bailOut);
185		}
186
187		/**
188		* @param comment Comment. Whether could add to Comment list or not.
189		*/
190		public boolean addComment(Comment comment) {
191	20	this.comments.add(comment);
192	20	return this.tapLines.add(comment);
193		}
194
195		/**
196		* Removes a TAP Line from the list.
197		*
198		* @param tapLine TAP Line object.
199		* @return True if could successfully remove the TAP Line from the list.
200		*/
201		protected boolean removeTapLine(TapResult tapLine) {
202	1	return this.tapLines.remove(tapLine);
203		}
204
205		/**
206		* Removes a Test Result from the list.
207		*
208		* @param testResult Test Result.
209		* @return True if could successfully remove the Test Result from the list.
210		*/
211		public boolean removeTestResult(TestResult testResult) {
212	2	boolean flag = false;
213	2	if (this.tapLines.remove(testResult)) {
214	1	this.testResults.remove(testResult);
215	1	flag = true;
216		}
217	2	return flag;
218		}
219
220		/**
221		* Removes a Bail Out from the list.
222		*
223		* @param bailOut Bail Out object.
224		* @return True if could successfully remove the Bail Out from the list.
225		*/
226		public boolean removeBailOut(BailOut bailOut) {
227	2	boolean flag = false;
228	2	if (this.tapLines.remove(bailOut)) {
229	1	this.bailOuts.remove(bailOut);
230	1	flag = true;
231		}
232	2	return flag;
233		}
234
235		/**
236		* Removes a Comment from the list.
237		*
238		* @param comment Comment.
239		* @return True if could successfully remove the Comment from the list.
240		*/
241		public boolean removeComment(Comment comment) {
242	2	boolean flag = false;
243	2	if (this.tapLines.remove(comment)) {
244	1	this.comments.remove(comment);
245	1	flag = true;
246		}
247	2	return flag;
248		}
249
250		/**
251		* @return Number of TAP Lines. It includes Test Results, Bail Outs and
252		* Comments (the footer is not included).
253		*/
254		public int getNumberOfTapLines() {
255	3	return this.tapLines.size();
256		}
257
258		/**
259		* @return Number of Test Results.
260		*/
261		public int getNumberOfTestResults() {
262	112	return this.testResults.size();
263		}
264
265		/**
266		* @return Number of Bail Outs.
267		*/
268		public int getNumberOfBailOuts() {
269	3	return this.bailOuts.size();
270		}
271
272		/**
273		* @return Number of Comments.
274		*/
275		public int getNumberOfComments() {
276	5	return this.comments.size();
277		}
278
279		/**
280		* @return Footer
281		*/
282		public Footer getFooter() {
283	26	return this.footer;
284		}
285
286		/**
287		* @param footer Footer
288		*/
289		public void setFooter(Footer footer) {
290	13	this.footer = footer;
291	13	}
292
293		/**
294		* @return True if it has any Bail Out statement, false otherwise.
295		*/
296		public boolean hasBailOut() {
297	2	boolean isBailOut = false;
298
299	2	for (TapResult tapLine : tapLines) {
300	4	if (tapLine instanceof BailOut) {
301	1	isBailOut = true;
302	1	break;
303		}
304		}
305
306	2	return isBailOut;
307		}
308
309		/*
310		* (non-Javadoc)
311		* @see org.tap4j.TapConsumer#containsOk()
312		*/
313		public Boolean containsOk() {
314	7	Boolean containsOk = false;
315
316	7	for (TestResult testResult : this.testResults) {
317	4	if (testResult.getStatus().equals(StatusValues.OK)) {
318	3	containsOk = true;
319	3	break;
320		}
321		}
322
323	7	return containsOk;
324		}
325
326		/*
327		* (non-Javadoc)
328		* @see org.tap4j.TapConsumer#containsNotOk()
329		*/
330		public Boolean containsNotOk() {
331	5	Boolean containsNotOk = false;
332
333	5	for (TestResult testResult : this.testResults) {
334	5	if (testResult.getStatus().equals(StatusValues.NOT_OK)) {
335	3	containsNotOk = true;
336	3	break;
337		}
338		}
339
340	5	return containsNotOk;
341		}
342
343		/*
344		* (non-Javadoc)
345		* @see org.tap4j.TapConsumer#containsBailOut()
346		*/
347		public Boolean containsBailOut() {
348	4	return this.bailOuts.size() > 0;
349		}
350
351		/*
352		* (non-Javadoc)
353		* @see org.tap4j.TapConsumer#getTestResult(java.lang.Integer)
354		*/
355		public TestResult getTestResult(Integer testNumber) {
356	25	TestResult foundTestResult = null;
357
358	25	for (TestResult testResult : this.testResults) {
359	36	if (testResult.getTestNumber() != null &&
360		testResult.getTestNumber().equals(testNumber)) {
361	25	foundTestResult = testResult;
362	25	break;
363		}
364		}
365
366	25	return foundTestResult;
367		}
368
369		}