mirror of
https://github.com/google/nomulus.git
synced 2025-05-01 20:47:52 +02:00
220f7589f5
The intention (from []is: - actualAsString() is the method that people call. - actualCustomStringRepresentation() is the method that people override. Fortunately, no one actually calls actualCustomStringRepresentation(), aside from some tests that call it to test a subject's implementation. That's easy enough to work around by extracting a method. (Arguably @ForOverride should permit calls from tests in some cases (now that Error Prone knows how to identify test code). But it's not entirely clear, since, e.g., people shouldn't be testing Converter.doForward(null) because the method can never be invoked that way. Some discussion here: []Tested: global TAP [] RELNOTES=Marked `actualCustomStringRepresentation()` as `@ForOverride`. To retrieve the string representation, call `actualAsString()`. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=185672328
106 lines
3.6 KiB
Java
106 lines
3.6 KiB
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.truth.Truth.assertAbout;
|
|
|
|
import com.google.common.truth.FailureMetadata;
|
|
import com.google.common.truth.SimpleSubjectBuilder;
|
|
import com.google.common.truth.Subject;
|
|
import google.registry.model.domain.Period;
|
|
import google.registry.model.reporting.HistoryEntry;
|
|
import google.registry.testing.TruthChainer.And;
|
|
import java.util.Objects;
|
|
import java.util.Optional;
|
|
|
|
/** Utility methods for asserting things about {@link HistoryEntry} instances. */
|
|
public class HistoryEntrySubject extends Subject<HistoryEntrySubject, HistoryEntry> {
|
|
|
|
private String customDisplaySubject;
|
|
|
|
public HistoryEntrySubject(FailureMetadata failureMetadata, HistoryEntry subject) {
|
|
super(failureMetadata, subject);
|
|
}
|
|
|
|
@Override
|
|
protected String actualCustomStringRepresentation() {
|
|
return Optional.ofNullable(customDisplaySubject).orElse(String.valueOf(actual()));
|
|
}
|
|
|
|
public HistoryEntrySubject withCustomDisplaySubject(String customDisplaySubject) {
|
|
this.customDisplaySubject = customDisplaySubject;
|
|
return this;
|
|
}
|
|
|
|
public And<HistoryEntrySubject> hasType(HistoryEntry.Type type) {
|
|
return hasValue(type, actual().getType(), "has type");
|
|
}
|
|
|
|
public And<HistoryEntrySubject> hasClientId(String clientId) {
|
|
return hasValue(clientId, actual().getClientId(), "has client ID");
|
|
}
|
|
|
|
public And<HistoryEntrySubject> hasOtherClientId(String otherClientId) {
|
|
return hasValue(otherClientId, actual().getOtherClientId(), "has other client ID");
|
|
}
|
|
|
|
public And<HistoryEntrySubject> hasPeriod() {
|
|
if (actual().getPeriod() == null) {
|
|
fail("has a period");
|
|
}
|
|
return new And<>(this);
|
|
}
|
|
|
|
public And<HistoryEntrySubject> hasPeriodYears(int years) {
|
|
return hasPeriod().and()
|
|
.hasValue(Period.Unit.YEARS, actual().getPeriod().getUnit(), "has period in").and()
|
|
.hasValue(years, actual().getPeriod().getValue(), "has period length");
|
|
}
|
|
|
|
public And<HistoryEntrySubject> hasNoXml() {
|
|
if (actual().getXmlBytes() != null) {
|
|
fail("has no xml");
|
|
}
|
|
return new And<>(this);
|
|
}
|
|
|
|
public And<HistoryEntrySubject> hasMetadataReason(String reason) {
|
|
return hasValue(reason, actual().getReason(), "has metadata reason");
|
|
}
|
|
|
|
public And<HistoryEntrySubject> hasMetadataRequestedByRegistrar(
|
|
boolean requestedByRegistrar) {
|
|
if (actual().getRequestedByRegistrar() != requestedByRegistrar) {
|
|
fail("has metadata requestedByRegistrar with value", requestedByRegistrar);
|
|
}
|
|
return new And<>(this);
|
|
}
|
|
|
|
protected void failWithBadResults(String dualVerb, Object expected, Object actual) {
|
|
failWithBadResults(dualVerb, expected, dualVerb, actual);
|
|
}
|
|
|
|
protected <E> And<HistoryEntrySubject> hasValue(E expected, E actual, String verb) {
|
|
if (!Objects.equals(expected, actual)) {
|
|
failWithBadResults(verb, expected, actual);
|
|
}
|
|
return new And<>(this);
|
|
}
|
|
|
|
public static SimpleSubjectBuilder<HistoryEntrySubject, HistoryEntry>
|
|
assertAboutHistoryEntries() {
|
|
return assertAbout(HistoryEntrySubject::new);
|
|
}
|
|
}
|