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
172
173
174
|
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.core.tests.harness;
import static org.junit.Assert.assertFalse;
import junit.framework.AssertionFailedError;
import org.eclipse.core.runtime.jobs.Job;
/**
* This class can be used for testing progress monitoring.
* If you want to reuse one instance of this class for several
* invocations, make sure that you call prepare() before every
* invocation.
* Call sanityCheck() after the operation whose progress monitoring
* you are testing.
*/
public class FussyProgressMonitor extends TestProgressMonitor {
public class FussyProgressAssertionFailed extends AssertionFailedError {
/**
* All serializable objects should have a stable serialVersionUID
*/
private static final long serialVersionUID = 1L;
FussyProgressAssertionFailed(String name) {
super(name);
}
}
private static final double EPS_FACTOR = 0.01;
private static final long NOTICEABLE_DELAY = 1000; // milliseconds
private boolean beginTaskCalled;
private long beginTime;
private boolean canceled;
private int doneCalls;
private boolean hasFailed;
private boolean sanityCheckCalled = true;
private String taskName;
private int totalWork;
private double workedSoFar;
private Job job;
public FussyProgressMonitor() {
prepare();
}
/**
* Creates a fussy progress monitor that is associated with a particular job.
* On assertion failure the job name will be included in the failure message.
* @param job
*/
public FussyProgressMonitor(Job job) {
this();
this.job = job;
}
/**
*
* @param reason java.lang.String
* @param condition boolean
*/
private void assertTrue(String reason, boolean condition) {
// silently ignore follow-up failures
if (hasFailed) {
return;
}
if (!condition) {
hasFailed = true;
if (job != null) {
reason += " in job: " + job.getName();
}
throw new FussyProgressAssertionFailed(reason);
}
//Assert.assert(reason, condition);
}
/**
* Asserts that this progress monitor is all used up
*/
public void assertUsedUp() {
assertTrue("beginTask has not been called on ProgressMonitor", beginTaskCalled);
assertTrue("ProgressMonitor not used up", Math.round(workedSoFar) >= totalWork);
}
@Override
public void beginTask(String name, int newTotalWork) {
assertFalse("beginTask may only be called once (old name=" + taskName + ")", beginTaskCalled);
beginTaskCalled = true;
taskName = name;
assertTrue("total work must be positive or UNKNOWN", newTotalWork > 0 || newTotalWork == UNKNOWN);
this.totalWork = newTotalWork;
beginTime = System.currentTimeMillis();
}
@Override
public void done() {
workedSoFar = totalWork;
doneCalls++;
}
@Override
public void internalWorked(double work) {
assertTrue("can accept calls to worked/internalWorked only after beginTask", beginTaskCalled);
assertTrue("can accept calls to worked/internalWorked only before done is called", doneCalls == 0);
assertTrue("amount worked should be positive, not " + work, work >= 0);
if (work == 0) {
CoreTest.debug("INFO: amount worked should be positive, not " + work);
}
workedSoFar += work;
assertTrue("worked " + (workedSoFar - totalWork) + " more than totalWork", totalWork == UNKNOWN || workedSoFar <= totalWork + (totalWork * EPS_FACTOR));
}
@Override
public boolean isCanceled() {
return canceled;
}
/**
* should be called before every use of a FussyProgressMonitor
*/
public void prepare() {
sanityCheckCalled = false;
taskName = null;
totalWork = 0;
workedSoFar = 0;
beginTaskCalled = false;
doneCalls = 0;
hasFailed = false;
}
/**
* should be called after every use of a FussyProgressMonitor
*/
public void sanityCheck() {
if (sanityCheckCalled) {
CoreTest.debug("sanityCheck has already been called");
}
sanityCheckCalled = true;
long duration = System.currentTimeMillis() - beginTime;
if (duration > NOTICEABLE_DELAY && beginTaskCalled) {
assertTrue("this operation took: " + duration + "ms, it should report progress", workedSoFar > 0);
}
}
@Override
public void setCanceled(boolean b) {
boolean wasCanceled = isCanceled();
canceled = b;
if (canceled && !wasCanceled && job != null) {
job.cancel();
}
}
@Override
public void setTaskName(String name) {
taskName = name;
}
@Override
public void subTask(String name) {
// do nothing
}
@Override
public void worked(int work) {
internalWorked(work);
}
}
|
