File: TestResult.java

package info (click to toggle)
mauve 20080616-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 26,856 kB
  • ctags: 21,952
  • sloc: java: 234,107; sh: 2,834; xml: 208; makefile: 59
file content (171 lines) | stat: -rw-r--r-- 5,215 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// Copyright (c) 2004 Noa Resare.
// Written by Noa Resre <noa@resare.com>
                                                                               
// This file is part of Mauve.
                                                                               
// Mauve 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, or (at your option)
// any later version.
                                                                               
// Mauve 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.
                                                                               
// You should have received a copy of the GNU General Public License
// along with Mauve; see the file COPYING.  If not, write to
// the Free Software Foundation, 59 Temple Place - Suite 330,
// Boston, MA 02111-1307, USA.

package gnu.testlet;

import java.util.List;
import java.util.ArrayList;

/**
 * A TestResult object represents the results a run of one Testlet. TestResult
 * objects are normally agregated in a TestReport. The natural ordering of
 * TestResult is defined to be the same as the natural order of their 
 * respective testletName field.
 */
public class TestResult
  implements Comparable
{
  private String testletName = null;
  private List failMessages = new ArrayList();
  private List passMessages = new ArrayList();
  private Throwable exception = null;
  private String exceptionReason = null;
  private String exceptionMessage = null;

  /**
   * Constructs a TestResult instance with testletName set to the given name.
   *
   * @param testletName the name of the testlet that produced this TestResult
   */
  public TestResult(String testletName)
  {
    if (testletName == null)
      throw new IllegalArgumentException("testletName can not be null");
    this.testletName = testletName;
  }

  /**
   * Adds a pass message identifying a passing test.  Should be called 
   * when a test passes.
   * 
   * @param message a String that identifies the test that passed
   */
  public void addPass(String message)
  {
    passMessages.add(message);
  }

  /**
   * Adds a failure message identifying a failing test. Should be called when
   * a test fails. 
   *
   * @param message a String that identifies the test that failed inside
   * this servlet
   */
  public void addFail(String message)
  {
    failMessages.add(message);
  }

  /**
   * Adds an Exception and optional identification message to this TestResult
   * object. Should be called when the instantiation or execution of a Testlet
   * results in an exception.
   *
   * @param exception The exception that was thrown
   * @param message A message that identifies the test that caused the
   * @param reason the stack trace for the Exception
   * exception to be thrown
   */
  public void addException(Throwable exception, String message, String reason)
  {
    if (this.exception != null)
      throw new IllegalArgumentException("trying to add more than one " +
               "exception to TestResult");           
    this.exception = exception;
    this.exceptionMessage = message;
    this.exceptionReason = reason;
  }

  /**
   * The number of tests that have preformed without failure or exceptions.
   */
  public int getPassCount()
  {
    return passMessages.size();
  }

  /**
   * An array of Strings that holds the identifying messages for all failed
   * tests.
   */
  public String[] getFailMessags()
  {
    return (String[]) failMessages.toArray(new String[0]);
  }

  /**
   * An array of Strings that holds the identifying messages for all
   * passing tests.
   * 
   * @return an array of Strings holding the messages for passing tests.
   */
  public String[] getPassMessages()
  {
    return (String[]) passMessages.toArray(new String[0]);
  }
  
  /**
   * The name of the Testlet that this TestResult holds information about.
   */
  public String getTestletName()
  {
    return testletName;
  }

  /**
   * If an Exception was thrown when the Testlet was instantiated or run it
   * is returned, else null is returned.
   */
  public Throwable getException()
  {
    return exception;
  }

  /**
   * If an Exception was thrown when the Testlet was instantiated or run,
   * this String identifies what test (or other contition) caused the test.
   */
  public String getExceptionMessage()
  {
    return exceptionMessage;
  }
  
  /**
   * If an Exception was thrown when the Testlet was instantiated or run,
   * this String is the stack trace associated with the Exception.
   * 
   * @return the stack trace associated with the Exception
   */
  public String getExceptionReason()
  {
    return exceptionReason;
  }

  /**
   * Compares one TestResult object to another. TestResult objects compare
   * the same as their testletName fields.
   */ 
  public int compareTo(Object o)
  {
    TestResult other = (TestResult)o;
    return testletName.compareTo(other.testletName);
  }
}