google-nomulus/javatests/google/registry/testing/AbstractEppResourceSubject.java

// Copyright 2017 The Nomulus Authors. All Rights Reserved.
//
// 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 google.registry.testing;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Strings.lenientFormat;
import static com.google.common.truth.Fact.simpleFact;
import static google.registry.model.EppResourceUtils.isActive;
import static google.registry.testing.DatastoreHelper.getHistoryEntriesOfType;
import static google.registry.testing.HistoryEntrySubject.assertAboutHistoryEntries;
import static google.registry.util.DiffUtils.prettyPrintEntityDeepDiff;

import com.google.common.collect.ImmutableSet;
import com.google.common.truth.FailureMetadata;
import com.google.common.truth.Subject;
import google.registry.model.EppResource;
import google.registry.model.ImmutableObject;
import google.registry.model.eppcommon.StatusValue;
import google.registry.model.reporting.HistoryEntry;
import google.registry.testing.TruthChainer.And;
import google.registry.testing.TruthChainer.Which;
import java.util.List;
import java.util.Objects;
import javax.annotation.Nullable;
import org.joda.time.DateTime;

/** Base Truth subject for asserting things about epp resources. */
abstract class AbstractEppResourceSubject
    <T extends EppResource, S extends AbstractEppResourceSubject<T, S>> extends Subject<S, T> {

  public AbstractEppResourceSubject(FailureMetadata failureMetadata, T subject) {
    super(failureMetadata, checkNotNull(subject));
  }

  private List<HistoryEntry> getHistoryEntries() {
    return DatastoreHelper.getHistoryEntries(actual());
  }

  @SuppressWarnings("unchecked")
  protected And<S> andChainer() {
    return new And<>((S) this);
  }

  @Override
  protected String actualCustomStringRepresentation() {
    return String.format(
        "%s with foreign key '%s'",
        actual().getClass().getSimpleName(),
        actual().getForeignKey());
  }

  @Override
  public void isEqualTo(@Nullable Object other) {
    // If the objects differ and we can show an interesting ImmutableObject diff, do so.
    if (actual() != null && other instanceof ImmutableObject && !actual().equals(other)) {
      String diffText = prettyPrintEntityDeepDiff(
          ((ImmutableObject) other).toDiffableFieldMap(), actual().toDiffableFieldMap());
      fail(String.format("is equal to %s\n\nIt differs as follows:\n%s", other, diffText));
    }
    // Otherwise, fall back to regular behavior.
    super.isEqualTo(other);
  }

  public And<S> hasRepoId(long roid) {
    return hasValue(roid, actual().getRepoId(), "has repoId");
  }

  public And<S> hasNoHistoryEntries() {
    if (!getHistoryEntries().isEmpty()) {
      failWithActual(simpleFact("expected to have no history entries"));
    }
    return andChainer();
  }

  public And<S> hasNumHistoryEntries(int num) {
    if (getHistoryEntries().size() != num) {
      failWithBadResults("has this number of history entries", num, getHistoryEntries().size());
    }
    return andChainer();
  }

  public And<S> hasNumHistoryEntriesOfType(HistoryEntry.Type type, int num) {
    List<HistoryEntry> entries = getHistoryEntriesOfType(actual(), type);
    if (entries.size() != num) {
      failWithBadResults(
          String.format("has this number of history entries of type %s", type.toString()),
          num,
          entries.size());
    }
    return andChainer();
  }

  public And<S> hasOneHistoryEntryEachOfTypes(HistoryEntry.Type ... types) {
    hasNumHistoryEntries(types.length);
    for (HistoryEntry.Type type : types) {
      hasNumHistoryEntriesOfType(type, 1);
    }
    return andChainer();
  }

  public And<S> hasOnlyOneHistoryEntry() {
    int numHistoryEntries = getHistoryEntries().size();
    if (numHistoryEntries != 1) {
      fail(String.format("has exactly one history entry (it has %d)", numHistoryEntries));
    }
    return andChainer();
  }

  public HistoryEntrySubject hasOnlyOneHistoryEntryWhich() {
    hasOnlyOneHistoryEntry();
    return assertAboutHistoryEntries().that(getHistoryEntries().get(0)).withCustomDisplaySubject(
        "the only history entry for " + actualAsString());
  }

  public Which<HistoryEntrySubject> hasHistoryEntryAtIndex(int index) {
    List<HistoryEntry> historyEntries = getHistoryEntries();
    if (historyEntries.size() < index + 1) {
      failWithBadResults(
          "has at least number of history entries", index + 1, historyEntries.size());
    }
    return new Which<>(assertAboutHistoryEntries()
        .that(getHistoryEntries().get(index)).withCustomDisplaySubject(String.format(
            "the history entry for %s at index %s", actualAsString(), index)));
  }

  public And<S> hasStatusValue(StatusValue statusValue) {
    if (!actual().getStatusValues().contains(statusValue)) {
      failWithoutActual(
          simpleFact(
              lenientFormat("%s should have had status value %s", actualAsString(), statusValue)));
    }
    return andChainer();
  }

  public And<S> doesNotHaveStatusValue(StatusValue statusValue) {
    if (actual().getStatusValues().contains(statusValue)) {
      failWithoutActual(
          simpleFact(
              lenientFormat(
                  "%s should not have had status value %s", actualAsString(), statusValue)));
    }
    return andChainer();
  }

  public And<S> hasExactlyStatusValues(StatusValue... statusValues) {
    if (!ImmutableSet.copyOf(actual().getStatusValues())
        .equals(ImmutableSet.copyOf(statusValues))) {
      check("getStatusValues()")
          .that(actual().getStatusValues())
          .containsExactly((Object[]) statusValues);
    }
    return andChainer();
  }

  public And<S> hasDeletionTime(DateTime deletionTime) {
    return hasValue(
        deletionTime,
        actual().getDeletionTime(),
        "has deletionTime");
  }

  public And<S> hasLastEppUpdateTime(DateTime lastUpdateTime) {
    return hasValue(
        lastUpdateTime,
        actual().getLastEppUpdateTime(),
        "has lastEppUpdateTime");
  }

  public And<S> hasLastEppUpdateTimeAtLeast(DateTime before) {
    DateTime lastEppUpdateTime = actual().getLastEppUpdateTime();
    if (lastEppUpdateTime == null || before.isAfter(lastEppUpdateTime)) {
      failWithBadResults("has lastEppUpdateTime at least", before, lastEppUpdateTime);
    }
    return andChainer();
  }

  public And<S> hasLastEppUpdateClientId(String clientId) {
    return hasValue(
        clientId,
        actual().getLastEppUpdateClientId(),
        "has lastEppUpdateClientId");
  }


  public And<S> hasPersistedCurrentSponsorClientId(String clientId) {
    return hasValue(
        clientId,
        actual().getPersistedCurrentSponsorClientId(),
        "has persisted currentSponsorClientId");
  }

  public And<S> isActiveAt(DateTime time) {
    if (!isActive(actual(), time)) {
      fail("is active at " + time);
    }
    return andChainer();
  }

  public And<S> isNotActiveAt(DateTime time) {
    if (isActive(actual(), time)) {
      fail("is not active at " + time);
    }
    return andChainer();
  }

  protected void failWithBadResults(String dualVerb, Object expected, Object actual) {
    failWithBadResults(dualVerb, expected, dualVerb, actual);
  }

  protected <E> And<S> hasValue(E expected, E actual, String verb) {
    if (!Objects.equals(expected, actual)) {
      failWithBadResults(verb, expected, actual);
    }
    return andChainer();
  }

  protected <E> And<S> doesNotHaveValue(E badValue, E actual, String valueName) {
    if (Objects.equals(badValue, actual)) {
      fail("has " + valueName + " not equal to " + badValue);
    }
    return andChainer();
  }
}