spock.mock.DetachedMockFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spock-core Show documentation
Show all versions of spock-core Show documentation
Spock is a testing and specification framework for Java and Groovy applications.
What makes it stand out from the crowd is its beautiful and highly expressive specification language.
Thanks to its JUnit runner, Spock is compatible with most IDEs, build tools, and continuous integration servers.
Spock is inspired from JUnit, jMock, RSpec, Groovy, Scala, Vulcans, and other fascinating life forms.
/*
* Copyright 2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* https://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package spock.mock;
import org.spockframework.mock.*;
import org.spockframework.util.*;
import spock.lang.Specification;
import java.util.*;
import static java.util.Collections.emptyMap;
import static java.util.Collections.singletonMap;
/**
* This factory allows the creations of mocks outside of a {@link spock.lang.Specification},
* e.g., in a Spring configuration.
*
* In order to be usable those Mocks must be manually attached to the {@link spock.lang.Specification}
* using {@link MockUtil#attachMock(Object, Specification)} and detached afterwards {@link MockUtil#detachMock(Object)}.
*/
@Beta
public class DetachedMockFactory implements MockFactory {
/**
* Creates a mock with the specified type. The mock name will be the types simple name.
*
* Example:
*
*
* def person = Mock(Person) // type is Person.class, name is "person"
*
*
* @param type the interface or class type of the mock
* @param the interface or class type of the mock
*
* @return a mock with the specified type
*/
@Override
public T Mock(Class type) {
return createMock(inferNameFromType(type), type, MockNature.MOCK, emptyMap());
}
/**
* Creates a mock with the specified options and type. The mock name will be the types simple name.
*
* Example:
*
*
* def person = Mock(Person, name: "myPerson") // type is Person.class, name is "myPerson"
*
*
* @param options optional options for creating the mock
* @param type the interface or class type of the mock
* @param the interface or class type of the mock
*
* @return a mock with the specified options and type
*/
@Override
public T Mock(Map options, Class type) {
return createMock(inferNameFromType(type), type, MockNature.MOCK, options);
}
/**
* Creates a stub with the specified type. The mock name will be the types simple name.
*
* Example:
*
*
* def person = Stub(Person) // type is Person.class, name is "person"
*
*
* @param type the interface or class type of the stub
* @param the interface or class type of the stub
*
* @return a stub with the specified type
*/
@Override
public T Stub(Class type) {
return createMock(inferNameFromType(type), type, MockNature.STUB, emptyMap());
}
/**
* Creates a stub with the specified options and type. The mock name will be the types simple name.
*
* Example:
*
*
* def person = Stub(Person, name: "myPerson") // type is Person.class, name is "myPerson"
*
*
* @param options optional options for creating the stub
* @param type the interface or class type of the stub
* @param the interface or class type of the stub
*
* @return a stub with the specified options and type
*/
@Override
public T Stub(Map options, Class type) {
return createMock(inferNameFromType(type), type, MockNature.STUB, options);
}
/**
* Creates a spy with the specified type. The mock name will be the types simple name.
*
* Example:
*
*
* def person = Spy(Person) // type is Person.class, name is "person"
*
*
* @param type the class type of the spy
* @param the class type of the spy
*
* @return a spy with the specified type
*/
@Override
public T Spy(Class type) {
return createMock(inferNameFromType(type), type, MockNature.SPY, emptyMap());
}
@Override
public T Spy(T obj) {
return createMock(inferNameFromType(obj.getClass()), obj, MockNature.SPY, singletonMap("useObjenesis", true));
}
/**
* Creates a spy with the specified options and type. The mock name will be the types simple name.
*
* Example:
*
*
* def person = Spy(Person, name: "myPerson") // type is Person.class, name is "myPerson"
*
*
* @param options optional options for creating the spy
* @param type the class type of the spy
* @param the class type of the spy
*
* @return a spy with the specified options and type
*/
@Override
public T Spy(Map options, Class type) {
return createMock(inferNameFromType(type), type, MockNature.SPY, options);
}
@SuppressWarnings("unchecked")
public T createMock(@Nullable String name, Class type, MockNature nature, Map options) {
ClassLoader classLoader = type.getClassLoader();
if (classLoader == null) {
classLoader = ClassLoader.getSystemClassLoader();
}
return (T) new MockUtil().createDetachedMock(name, type, nature, MockImplementation.JAVA, options, classLoader);
}
@SuppressWarnings("unchecked")
public T createMock(@Nullable String name, T obj, MockNature nature, Map options) {
ClassLoader classLoader = obj.getClass().getClassLoader();
if (classLoader == null) {
classLoader = ClassLoader.getSystemClassLoader();
}
return (T) new MockUtil().createDetachedMock(name, obj, nature, MockImplementation.JAVA, options, classLoader);
}
private String inferNameFromType(Class type) {
return type.getSimpleName();
}
}