com.github.tomakehurst.wiremock.stubbing.Scenario Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wiremock-jre8-standalone Show documentation
A web service test double for all occasions - standalone edition
There is a newer version: 3.0.1
Show newest version
/*
 * Copyright (C) 2011 Thomas Akehurst
 *
 * 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.github.tomakehurst.wiremock.stubbing;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.github.tomakehurst.wiremock.common.Json;
import com.google.common.base.Function;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.FluentIterable;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;

import java.util.*;

import static com.google.common.collect.FluentIterable.from;

public class Scenario {

	public static final String STARTED = "Started";

	private final UUID id;
	private final String name;
	private final String state;
	private final Set stubMappings;

	@JsonCreator
	public Scenario(@JsonProperty("id") UUID id,
                    @JsonProperty("name") String name,
                    @JsonProperty("state") String currentState,
                    @JsonProperty("possibleStates") Set ignored,
                    @JsonProperty("mappings") Set stubMappings) {
        this.id = id;
        this.name = name;
        this.state = currentState;
        this.stubMappings = stubMappings;
    }
	
	public static Scenario inStartedState(String name) {
		return new Scenario(UUID.randomUUID(), name, STARTED, ImmutableSet.of(STARTED), Collections.emptySet());
	}

    public UUID getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public String getState() {
		return state;
	}

    public Set getPossibleStates() {
        FluentIterable requiredStates = from(stubMappings)
            .transform(new Function() {
                @Override
                public String apply(StubMapping mapping) {
                    return mapping.getRequiredScenarioState();
                }
            });

        return from(stubMappings)
            .transform(new Function() {
                @Override
                public String apply(StubMapping mapping) {
                    return mapping.getNewScenarioState();
                }
            })
            .append(requiredStates)
            .filter(Predicates.notNull())
            .toSet();
    }

    public Set getMappings() {
        return stubMappings;
    }

    Scenario setState(String newState) {
		return new Scenario(id, name, newState, null, stubMappings);
	}

	Scenario reset() {
        return new Scenario(id, name, STARTED, null, stubMappings);
	}

    Scenario withStubMapping(StubMapping stubMapping) {
        Set newMappings = ImmutableSet.builder()
            .addAll(stubMappings)
            .add(stubMapping)
            .build();

        return new Scenario(id, name, state, null, newMappings);
    }

    Scenario withoutStubMapping(StubMapping stubMapping) {
        Set newMappings = Sets.difference(stubMappings, ImmutableSet.of(stubMapping));
        return new Scenario(id, name, state, null, newMappings);
    }

	@Override
	public String toString() {
		return Json.write(this);
	}

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Scenario scenario = (Scenario) o;
        return Objects.equals(getId(), scenario.getId()) &&
            Objects.equals(getName(), scenario.getName()) &&
            Objects.equals(getState(), scenario.getState()) &&
            Objects.equals(getMappings(), scenario.getMappings());
    }

    @Override
    public int hashCode() {
        return Objects.hash(getId(), getName(), getState(), getMappings());
    }

    public static final Predicate withName(final String name) {
	    return new Predicate() {
            @Override
            public boolean apply(Scenario input) {
                return input.getName().equals(name);
            }
        };
    }
}