com.navercorp.fixturemonkey.builder.ArbitraryBuilderContext Maven / Gradle / Ivy
/*
* Fixture Monkey
*
* Copyright (c) 2021-present NAVER Corp.
*
* 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
*
* http://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 com.navercorp.fixturemonkey.builder;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import org.apiguardian.api.API;
import org.apiguardian.api.API.Status;
import com.navercorp.fixturemonkey.ArbitraryBuilder;
import com.navercorp.fixturemonkey.FixtureMonkey;
import com.navercorp.fixturemonkey.api.arbitrary.CombinableArbitrary;
import com.navercorp.fixturemonkey.api.context.MonkeyContext;
import com.navercorp.fixturemonkey.api.introspector.ArbitraryIntrospector;
import com.navercorp.fixturemonkey.api.matcher.MatcherOperator;
import com.navercorp.fixturemonkey.api.property.Property;
import com.navercorp.fixturemonkey.customizer.ArbitraryManipulator;
import com.navercorp.fixturemonkey.customizer.ContainerInfoManipulator;
import com.navercorp.fixturemonkey.tree.ObjectTree;
import com.navercorp.fixturemonkey.tree.TraverseContext;
/**
* {@link FixtureMonkey} → {@link ArbitraryBuilder} → {@link ObjectTree} → {@link CombinableArbitrary}
* 1:N 1:N 1:1
*
* It is a context within {@link ArbitraryBuilder}. It represents a status of the {@link ArbitraryBuilder}.
* The {@link ArbitraryBuilder} should be the same if the {@link ArbitraryBuilderContext} is the same.
*
* It is for internal use only. It can be changed or removed at any time.
*/
@API(since = "0.4.0", status = Status.INTERNAL)
public final class ArbitraryBuilderContext {
private final List manipulators;
private final List containerInfoManipulators;
private final Map, List> propertyConfigurers;
private final Map, ArbitraryIntrospector> arbitraryIntrospectorsByType;
private final MonkeyContext monkeyContext;
private boolean validOnly;
@Nullable
private FixedState fixedState = null;
@Nullable
private CombinableArbitrary fixedCombinableArbitrary;
private ArbitraryBuilderContext(
List manipulators,
List containerInfoManipulators,
Map, List> propertyConfigurers,
Map, ArbitraryIntrospector> arbitraryIntrospectorsByType,
boolean validOnly,
@Nullable FixedState fixedState,
@Nullable CombinableArbitrary fixedCombinableArbitrary,
MonkeyContext monkeyContext
) {
this.manipulators = manipulators;
this.containerInfoManipulators = containerInfoManipulators;
this.propertyConfigurers = propertyConfigurers;
this.arbitraryIntrospectorsByType = arbitraryIntrospectorsByType;
this.validOnly = validOnly;
this.fixedState = fixedState;
this.fixedCombinableArbitrary = fixedCombinableArbitrary;
this.monkeyContext = monkeyContext;
}
/**
* It is in {@link ArbitraryBuilderContext} due to MonkeyContext is in api module.
* It will be removed when all related class migrate to api module.
*/
@Deprecated
public static ArbitraryBuilderContext newBuilderContext(MonkeyContext monkeyContext) {
return new ArbitraryBuilderContext(
new ArrayList<>(),
new ArrayList<>(),
new HashMap<>(),
new HashMap<>(),
true,
null,
null,
monkeyContext
);
}
public ArbitraryBuilderContext copy() {
List copiedContainerInfoManipulators = this.containerInfoManipulators.stream()
.map(ContainerInfoManipulator::copy)
.collect(Collectors.toList());
return new ArbitraryBuilderContext(
new ArrayList<>(this.manipulators),
copiedContainerInfoManipulators,
new HashMap<>(propertyConfigurers),
new HashMap<>(arbitraryIntrospectorsByType),
this.validOnly,
fixedState,
fixedCombinableArbitrary,
monkeyContext
);
}
public void addManipulator(ArbitraryManipulator arbitraryManipulator) {
this.manipulators.add(arbitraryManipulator);
}
public void addManipulators(Collection arbitraryManipulators) {
this.manipulators.addAll(arbitraryManipulators);
}
public List getManipulators() {
return Collections.unmodifiableList(manipulators);
}
public void addContainerInfoManipulator(ContainerInfoManipulator containerInfo) {
this.containerInfoManipulators.add(containerInfo);
}
public void addContainerInfoManipulators(List containerInfoManipulators) {
this.containerInfoManipulators.addAll(containerInfoManipulators);
}
public List getContainerInfoManipulators() {
return Collections.unmodifiableList(containerInfoManipulators);
}
public void putPropertyConfigurer(Class type, List propertyConfigurer) {
this.propertyConfigurers.put(type, propertyConfigurer);
}
public void putArbitraryIntrospector(Class type, ArbitraryIntrospector arbitraryIntrospector) {
this.arbitraryIntrospectorsByType.put(type, arbitraryIntrospector);
}
public Map, ArbitraryIntrospector> getArbitraryIntrospectorsByType() {
return arbitraryIntrospectorsByType;
}
public Map, List> getPropertyConfigurers() {
return propertyConfigurers;
}
public void setValidOnly(boolean validOnly) {
this.validOnly = validOnly;
}
public boolean isValidOnly() {
return validOnly;
}
public void markFixed() {
if (fixedState != null
&& fixedState.getFixedManipulateSize() == this.manipulators.size()
&& fixedState.getFixedContainerManipulatorSize() == this.containerInfoManipulators.size()) {
return;
}
fixedState = new FixedState(this.manipulators.size(), this.containerInfoManipulators.size());
fixedCombinableArbitrary = null;
}
public boolean isFixed() {
return fixedState != null;
}
public boolean fixedExpired() {
return manipulators.size() > Objects.requireNonNull(fixedState).getFixedManipulateSize()
|| containerInfoManipulators.size() > fixedState.getFixedContainerManipulatorSize();
}
public void renewFixed(CombinableArbitrary fixedCombinableArbitrary) {
this.markFixed();
this.fixedCombinableArbitrary = fixedCombinableArbitrary;
}
@Nullable
public CombinableArbitrary getFixedCombinableArbitrary() {
return fixedCombinableArbitrary;
}
public TraverseContext newTraverseContext() {
List>> registeredContainerInfoManipulators =
monkeyContext.getRegisteredArbitraryBuilders()
.stream()
.map(it -> new MatcherOperator<>(
it.getMatcher(),
((DefaultArbitraryBuilder)it.getOperator()).getContext().getContainerInfoManipulators()
))
.collect(Collectors.toList());
return new TraverseContext(
new ArrayList<>(),
this.getContainerInfoManipulators(),
registeredContainerInfoManipulators,
this.getPropertyConfigurers(),
this.getArbitraryIntrospectorsByType(),
this.isValidOnly(),
this.monkeyContext
);
}
private static class FixedState {
private final int fixedManipulateSize;
private final int fixedContainerManipulatorSize;
public FixedState(int fixedManipulateSize, int fixedContainerManipulatorSize) {
this.fixedManipulateSize = fixedManipulateSize;
this.fixedContainerManipulatorSize = fixedContainerManipulatorSize;
}
public int getFixedManipulateSize() {
return fixedManipulateSize;
}
public int getFixedContainerManipulatorSize() {
return fixedContainerManipulatorSize;
}
}
}