package fr.xephi.authme.message; import com.google.common.collect.ImmutableMap; import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.TestHelper; import fr.xephi.authme.util.expiring.Duration; import org.bukkit.command.CommandSender; import org.bukkit.entity.Player; import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test; import org.mockito.ArgumentCaptor; import org.mockito.Mockito; import java.io.File; import java.util.Map; import java.util.concurrent.TimeUnit; import java.util.function.Function; import java.util.logging.Logger; import static org.hamcrest.Matchers.arrayWithSize; import static org.hamcrest.Matchers.contains; import static org.hamcrest.Matchers.containsString; import static org.hamcrest.Matchers.equalTo; import static org.junit.Assert.assertThat; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.BDDMockito.given; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.hamcrest.MockitoHamcrest.argThat; /** * Test for {@link Messages}. */ public class MessagesIntegrationTest { private static final String YML_TEST_FILE = TestHelper.PROJECT_ROOT + "message/messages_test.yml"; private static final String YML_DEFAULT_TEST_FILE = "messages/messages_en.yml"; private Messages messages; @BeforeClass public static void setup() { TestHelper.setupLogger(); } /** * Loads the messages in the file {@code messages_test.yml} in the test resources folder. * The file does not contain all messages defined in {@link MessageKey} and its contents * reflect various test cases -- not what the keys stand for. *

* Similarly, the {@code messages_default.yml} from the test resources represents a default * file that should contain all messages, but again, for testing, it just contains a few. */ @Before public void setUpMessages() { File testFile = TestHelper.getJarFile(YML_TEST_FILE); MessageFileHandlerProvider provider = providerReturning(testFile, YML_DEFAULT_TEST_FILE); messages = new Messages(provider); } @Test public void shouldLoadMessageAndSplitAtNewLines() { // given MessageKey key = MessageKey.UNKNOWN_USER; // when String[] message = messages.retrieve(key); // then String[] lines = new String[]{"We've got", "new lines", "and ' apostrophes"}; assertThat(message, equalTo(lines)); } @Test public void shouldLoadMessageAsStringWithNewLines() { // given MessageKey key = MessageKey.UNKNOWN_USER; // when String message = messages.retrieveSingle(key); // then assertThat(message, equalTo("We've got\nnew lines\nand ' apostrophes")); } @Test public void shouldFormatColorCodes() { // given MessageKey key = MessageKey.LOGIN_SUCCESS; // when String[] message = messages.retrieve(key); // then assertThat(message, arrayWithSize(1)); assertThat(message[0], equalTo("§cHere we have§bdefined some colors §dand some other §lthings")); } @Test public void shouldNotSendEmptyMessage() { // given MessageKey key = MessageKey.EMAIL_ALREADY_USED_ERROR; CommandSender sender = mock(CommandSender.class); // when messages.send(sender, key); // then verify(sender, never()).sendMessage(anyString()); } @Test public void shouldSendMessageToPlayer() { // given MessageKey key = MessageKey.LOGIN_SUCCESS; Player player = Mockito.mock(Player.class); // when messages.send(player, key); // then verify(player).sendMessage("§cHere we have§bdefined some colors §dand some other §lthings"); } @Test public void shouldSendMultiLineMessageToPlayer() { // given MessageKey key = MessageKey.UNKNOWN_USER; Player player = Mockito.mock(Player.class); // when messages.send(player, key); // then String[] lines = new String[]{"We've got", "new lines", "and ' apostrophes"}; ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); verify(player, times(3)).sendMessage(captor.capture()); assertThat(captor.getAllValues(), contains(lines)); } @Test public void shouldSendMessageToPlayerWithTagReplacement() { // given MessageKey key = MessageKey.CAPTCHA_WRONG_ERROR; CommandSender sender = Mockito.mock(CommandSender.class); // when messages.send(sender, key, "1234"); // then verify(sender, times(1)).sendMessage("Use /captcha 1234 to solve the captcha"); } @Test public void shouldNotLogErrorForKeyWithNoTagReplacements() { // given MessageKey key = MessageKey.CAPTCHA_WRONG_ERROR; CommandSender sender = mock(CommandSender.class); // when messages.send(sender, key); // then verify(sender).sendMessage("Use /captcha THE_CAPTCHA to solve the captcha"); } @Test public void shouldLogErrorForInvalidReplacementCount() { // given Logger logger = mock(Logger.class); ConsoleLogger.setLogger(logger); MessageKey key = MessageKey.CAPTCHA_WRONG_ERROR; // when messages.send(mock(CommandSender.class), key, "rep", "rep2"); // then verify(logger).warning(argThat(containsString("Invalid number of replacements"))); } @Test public void shouldSendErrorForReplacementsOnKeyWithNoTags() { // given Logger logger = mock(Logger.class); ConsoleLogger.setLogger(logger); MessageKey key = MessageKey.UNKNOWN_USER; // when messages.send(mock(CommandSender.class), key, "Replacement"); // then verify(logger).warning(argThat(containsString("Invalid number of replacements"))); } @Test public void shouldGetMessageFromDefaultFile() { // given // Key is only present in default file MessageKey key = MessageKey.MUST_REGISTER_MESSAGE; // when String message = messages.retrieveSingle(key); // then assertThat(message, equalTo("§4Only registered users can join the server! Please visit http://example.com to register yourself!")); } @Test public void shouldNotUseMessageFromDefaultFile() { // given // Key is present in both files MessageKey key = MessageKey.WRONG_PASSWORD; // when String message = messages.retrieveSingle(key); // then assertThat(message, equalTo("§cWrong password!")); } @Test public void shouldRetrieveMessageWithReplacements() { // given MessageKey key = MessageKey.CAPTCHA_WRONG_ERROR; // when String result = messages.retrieveSingle(key, "24680"); // then assertThat(result, equalTo("Use /captcha 24680 to solve the captcha")); } @Test public void shouldFormatDurationObjects() { // given Map expectedTexts = ImmutableMap.builder() .put(new Duration(1, TimeUnit.SECONDS), "1 second") .put(new Duration(12, TimeUnit.SECONDS), "12 seconds") .put(new Duration(1, TimeUnit.MINUTES), "1 minute") .put(new Duration(0, TimeUnit.MINUTES), "0 minutes") .put(new Duration(1, TimeUnit.HOURS), "1 hour") .put(new Duration(-4, TimeUnit.HOURS), "-4 hours") .put(new Duration(1, TimeUnit.DAYS), "1 day") .put(new Duration(44, TimeUnit.DAYS), "44 days") .build(); // when / then for (Map.Entry entry : expectedTexts.entrySet()) { assertThat(messages.formatDuration(entry.getKey()), equalTo(entry.getValue())); } } @SuppressWarnings("unchecked") private static MessageFileHandlerProvider providerReturning(File file, String defaultFile) { MessageFileHandlerProvider handler = mock(MessageFileHandlerProvider.class); given(handler.initializeHandler(any(Function.class), anyString())) .willReturn(new MessageFileHandler(file, defaultFile, "/authme messages")); return handler; } }