Package cleanup
- authme.cache to authme.data - Rename PlayerData to LimboPlayer to match with LimboCache - Move authme.converter to authme.datasource.converter - Split output package into output and message
This commit is contained in:
Gabriele C
@@ -0,0 +1,282 @@
|
||||
package fr.xephi.authme.message;
|
||||
|
||||
import fr.xephi.authme.ConsoleLogger;
|
||||
import fr.xephi.authme.TestHelper;
|
||||
import fr.xephi.authme.settings.Settings;
|
||||
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.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.junit.Assume.assumeThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Matchers.anyString;
|
||||
import static org.mockito.Matchers.argThat;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.never;
|
||||
import static org.mockito.Mockito.times;
|
||||
import static org.mockito.Mockito.verify;
|
||||
|
||||
/**
|
||||
* 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 = TestHelper.PROJECT_ROOT + "message/messages_default.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.
|
||||
* <p>
|
||||
* 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);
|
||||
Settings settings = mock(Settings.class);
|
||||
given(settings.getMessagesFile()).willReturn(testFile);
|
||||
given(settings.getDefaultMessagesFile()).willReturn(YML_DEFAULT_TEST_FILE);
|
||||
messages = new Messages(settings);
|
||||
}
|
||||
|
||||
@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.UNSAFE_QUIT_LOCATION;
|
||||
|
||||
// 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.UNSAFE_QUIT_LOCATION;
|
||||
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<String> 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(argThat(equalTo("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("Message from default file"));
|
||||
}
|
||||
|
||||
@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 shouldReturnErrorForMissingMessage() {
|
||||
// given
|
||||
// Key is not present in test file or default file
|
||||
MessageKey key = MessageKey.TWO_FACTOR_CREATE;
|
||||
|
||||
// when
|
||||
String message = messages.retrieveSingle(key);
|
||||
|
||||
// then
|
||||
assertThat(message, containsString("Error retrieving message"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void shouldAllowNullAsDefaultFile() {
|
||||
// given
|
||||
Settings settings = mock(Settings.class);
|
||||
given(settings.getMessagesFile()).willReturn(TestHelper.getJarFile(YML_TEST_FILE));
|
||||
Messages testMessages = new Messages(settings);
|
||||
// Key not present in test file
|
||||
MessageKey key = MessageKey.TWO_FACTOR_CREATE;
|
||||
|
||||
// when
|
||||
String message = testMessages.retrieveSingle(key);
|
||||
|
||||
// then
|
||||
assertThat(message, containsString("Error retrieving message"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void shouldLoadOtherFile() {
|
||||
// given
|
||||
MessageKey key = MessageKey.WRONG_PASSWORD;
|
||||
// assumption: message comes back as defined in messages_test.yml
|
||||
assumeThat(messages.retrieveSingle(key), equalTo("§cWrong password!"));
|
||||
Settings settings = mock(Settings.class);
|
||||
given(settings.getMessagesFile()).willReturn(TestHelper.getJarFile(
|
||||
TestHelper.PROJECT_ROOT + "message/messages_test2.yml"));
|
||||
|
||||
// when
|
||||
messages.reload(settings);
|
||||
|
||||
// then
|
||||
assertThat(messages.retrieveSingle(key), equalTo("test2 - wrong password"));
|
||||
// check that default message handling still works
|
||||
assertThat(messages.retrieveSingle(MessageKey.MUST_REGISTER_MESSAGE),
|
||||
equalTo("Message from default file"));
|
||||
}
|
||||
|
||||
@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"));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user