google-nomulus/javatests/google/registry/testing/LogsSubject.java
Ben McIlwain f61f1373df Improve error messages for LogsSubject
Currently, hasLogAtLevelWithMessage gave a very generic "no log at level with
message was found" error on failure. The user didn't know if there were no logs
at all, or if there was a small typo in the log etc.

Using the "regular" Truth assertions gives more informative errors in cleaner code.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=149007204
2017-03-07 13:33:20 -05:00

87 lines
2.9 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.collect.ImmutableList;
import com.google.common.testing.TestLogHandler;
import com.google.common.truth.AbstractVerb.DelegatedVerb;
import com.google.common.truth.Correspondence;
import com.google.common.truth.FailureStrategy;
import com.google.common.truth.Subject;
import google.registry.testing.TruthChainer.And;
import java.util.List;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
/** Utility methods for asserting things about logging {@link Handler} instances. */
public class LogsSubject extends Subject<LogsSubject, TestLogHandler> {
/** A factory for instances of this subject. */
private static class SubjectFactory
extends ReflectiveSubjectFactory<TestLogHandler, LogsSubject> {}
public LogsSubject(FailureStrategy strategy, TestLogHandler subject) {
super(strategy, subject);
}
private static final Correspondence<String, String> CONTAINS_CORRESPONDENCE =
new Correspondence<String, String>() {
@Override
public boolean compare(String actual, String expected) {
return actual.contains(expected);
}
@Override
public String toString() {
return "contains";
}
};
private List<String> getMessagesAtLevel(Level level) {
ImmutableList.Builder<String> builder = ImmutableList.<String>builder();
for (LogRecord log : actual().getStoredLogRecords()) {
if (log.getLevel().equals(level)) {
builder.add(log.getMessage());
}
}
return builder.build();
}
public And<LogsSubject> hasNoLogsAtLevel(Level level) {
check()
.withFailureMessage("Logs at level %s", level)
.that(getMessagesAtLevel(level))
.isEmpty();
return new And<>(this);
}
public And<LogsSubject> hasLogAtLevelWithMessage(Level level, String message) {
check()
.withFailureMessage("Logs at level %s", level)
.that(getMessagesAtLevel(level))
.comparingElementsUsing(CONTAINS_CORRESPONDENCE)
.contains(message);
return new And<>(this);
}
public static DelegatedVerb<LogsSubject, TestLogHandler> assertAboutLogs() {
return assertAbout(new SubjectFactory());
}
}