1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.collections4;
18
19 import java.util.ArrayList;
20 import java.util.List;
21 import java.util.ListIterator;
22
23 import org.apache.commons.lang3.StringUtils;
24 import org.easymock.EasyMock;
25 import org.easymock.IExpectationSetters;
26
27 /**
28 * Provides utilities for making mock-based tests. Most notable is the generic "type-safe"
29 * {@link #createMock(Class)} method, and {@link #replay()} and {@link #verify()} methods
30 * that call the respective methods on all created mock objects.
31 */
32 public abstract class MockTestCase {
33 private final List<Object> mockObjects = new ArrayList<>();
34
35 @SuppressWarnings("unchecked")
36 protected <T> T createMock(final Class<?> name) {
37 final T mock = (T) EasyMock.createMock(name);
38 return registerMock(mock);
39 }
40
41 protected <T> IExpectationSetters<T> expect(final T t) {
42 return EasyMock.expect(t);
43 }
44
45 private <T> T registerMock(final T mock) {
46 mockObjects.add(mock);
47 return mock;
48 }
49
50 protected final void replay() {
51 for (final Object o : mockObjects) {
52 EasyMock.replay(o);
53 }
54 }
55
56 protected final void verify() {
57 for (final ListIterator<Object> i = mockObjects.listIterator(); i.hasNext();) {
58 try {
59 EasyMock.verify(i.next());
60 } catch (final AssertionError e) {
61 throw new AssertionError(i.previousIndex() + 1 + StringUtils.EMPTY
62 + e.getMessage());
63 }
64 }
65 }
66 }