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

Go to download
/*
 * Copyright (C) 2012-2022 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 static com.google.common.collect.FluentIterable.from;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
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.*;

@JsonIgnoreProperties({"name"})
public class Scenario {

  public static final String STARTED = "Started";

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

  @JsonCreator
  public Scenario(
      @JsonProperty("id") String id,
      @JsonProperty("state") String currentState,
      @JsonProperty("possibleStates") Set ignored,
      @JsonProperty("mappings") Set stubMappings) {
    this.id = id;
    this.state = currentState;
    this.stubMappings = stubMappings;
  }

  public static Scenario inStartedState(String name) {
    return new Scenario(name, STARTED, ImmutableSet.of(STARTED), Collections.emptySet());
  }

  public String getId() {
    return id;
  }

  // For JSON backwards compatibility
  public String getName() {
    return id;
  }

  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, newState, null, stubMappings);
  }

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

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

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

  Scenario withoutStubMapping(StubMapping stubMapping) {
    Set newMappings = Sets.difference(stubMappings, ImmutableSet.of(stubMapping));
    return new Scenario(id, 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(getState(), scenario.getState())
        && Objects.equals(getMappings(), scenario.getMappings());
  }

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

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