Meishin/LoginSystem
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refactor message handlers into injectable components (preparation for #1467)

Browse Source
This commit is contained in:
ljacqu
2018-01-21 20:47:29 +01:00
parent 847991b658
commit 610a699c95
13 changed files with 317 additions and 433 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/test/java/fr/xephi/authme/message/MessageFileHandlerProviderTest.java
-175
View File
@@ -1,175 +0,0 @@
package fr.xephi.authme.message;
import ch.jalu.injector.testing.BeforeInjecting;
import ch.jalu.injector.testing.DelayedInjectionRunner;
import ch.jalu.injector.testing.InjectDelayed;
import com.google.common.io.Files;
import fr.xephi.authme.TestHelper;
import fr.xephi.authme.initialization.DataFolder;
import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;
import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import java.io.File;
import java.io.IOException;
import java.util.function.Function;
import static fr.xephi.authme.TestHelper.getJarFile;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.nullValue;
import static org.junit.Assert.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.verify;
/**
* Test for {@link MessageFileHandlerProvider}.
*/
@RunWith(DelayedInjectionRunner.class)
public class MessageFileHandlerProviderTest {
private static final Function<String, String> MESSAGES_BUILDER = lang -> "messages/messages_" + lang + ".yml";
@InjectDelayed
private MessageFileHandlerProvider handlerProvider;
@DataFolder
private File dataFolder;
@Mock
private Settings settings;
@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
@BeforeClass
public static void initLogger() {
TestHelper.setupLogger();
}
@BeforeInjecting
public void initDataFolder() throws IOException {
this.dataFolder = temporaryFolder.newFolder();
}
@Test
public void shouldReturnExistingMessagesFile() {
// given
String language = "fr";
// use another language file to make sure we won't copy over it
String jarFile = "/messages/messages_it.yml";
File existingFile = copyFromJar(MESSAGES_BUILDER.apply(language), jarFile);
// when
File result = handlerProvider.initializeFile(language, MESSAGES_BUILDER);
// then
assertThat(result, equalTo(existingFile));
assertThat(result.exists(), equalTo(true));
assertThat(result, equalToFile(getJarFile(jarFile)));
}
@Test
public void shouldCopyFromJarFile() {
// given
String language = "nl";
// when
File result = handlerProvider.initializeFile(language, MESSAGES_BUILDER);
// then
File expectedFile = new File(dataFolder, MESSAGES_BUILDER.apply(language));
assertThat(result, equalTo(expectedFile));
assertThat(result.exists(), equalTo(true));
assertThat(result, equalToFile(getJarFile("/messages/messages_nl.yml")));
}
@Test
public void shouldCopyDefaultFileForUnknownLanguage() {
// given
String language = "zxx";
// when
File result = handlerProvider.initializeFile(language, MESSAGES_BUILDER);
// then
File expectedFile = new File(dataFolder, MESSAGES_BUILDER.apply(language));
assertThat(result, equalTo(expectedFile));
assertThat(result.exists(), equalTo(true));
assertThat(result, equalToFile(getJarFile("/messages/messages_en.yml")));
}
@Test
public void shouldReturnNullForNonExistentDefault() {
// given
Function<String, String> fileFunction = s -> "bogus";
// when
File result = handlerProvider.initializeFile("gsw", fileFunction);
// then
assertThat(result, nullValue());
}
@Test
public void shouldCreateHandler() {
// given
String language = "fr";
given(settings.getProperty(PluginSettings.MESSAGES_LANGUAGE)).willReturn(language);
MessageFileHandlerProvider provider = Mockito.spy(handlerProvider);
Function<String, String> fileFunction = lang -> "file_" + lang + ".txt";
File file = new File(dataFolder, "some_file.txt");
doReturn(file).when(provider).initializeFile(language, fileFunction);
// when
MessageFileHandler handler = provider.initializeHandler(fileFunction);
// then
assertThat(handler, not(nullValue()));
verify(settings).getProperty(PluginSettings.MESSAGES_LANGUAGE);
verify(provider).initializeFile(language, fileFunction);
}
private File copyFromJar(String path, String jarPath) {
File file = new File(dataFolder, path);
if (!file.getParentFile().mkdirs()) {
throw new IllegalStateException("Could not create folders for '" + file + "'");
}
try {
Files.copy(getJarFile(jarPath), file);
return file;
} catch (IOException e) {
throw new IllegalStateException(e);
}
}
private static Matcher<File> equalToFile(File file) {
return new TypeSafeMatcher<File>() {
@Override
protected boolean matchesSafely(File item) {
try {
return Files.equal(item, file);
} catch (IOException e) {
throw new IllegalStateException("IOException during matcher evaluation", e);
}
}
@Override
public void describeTo(Description description) {
description.appendText("Equal to file '" + file + "'");
}
};
}
}
src/test/java/fr/xephi/authme/message/MessagesIntegrationTest.java
+30 -13
View File
@@ -1,21 +1,28 @@
package fr.xephi.authme.message;
import com.google.common.collect.ImmutableMap;
import com.google.common.io.Files;
import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.ReflectionTestUtils;
import fr.xephi.authme.TestHelper;
import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.util.FileUtils;
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.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.mockito.ArgumentCaptor;
import org.mockito.Mockito;
import java.io.File;
import java.io.IOException;
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;
@@ -23,7 +30,6 @@ 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;
@@ -38,9 +44,12 @@ import static org.mockito.hamcrest.MockitoHamcrest.argThat;
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;
@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
private File dataFolder;
@BeforeClass
public static void setup() {
TestHelper.setupLogger();
@@ -55,10 +64,15 @@ public class MessagesIntegrationTest {
* 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);
public void setUpMessages() throws IOException {
dataFolder = temporaryFolder.newFolder();
File testFile = new File(dataFolder, "messages/messages_test.yml");
new File(dataFolder, "messages").mkdirs();
FileUtils.create(testFile);
Files.copy(TestHelper.getJarFile(YML_TEST_FILE), testFile);
MessagesFileHandler fileHandler = createMessagesFileHandler();
messages = new Messages(fileHandler);
}
@Test
@@ -254,11 +268,14 @@ public class MessagesIntegrationTest {
}
}
@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;
private MessagesFileHandler createMessagesFileHandler() {
Settings settings = mock(Settings.class);
given(settings.getProperty(PluginSettings.MESSAGES_LANGUAGE)).willReturn("test");
MessagesFileHandler messagesFileHandler = new MessagesFileHandler();
ReflectionTestUtils.setField(AbstractMessageFileHandler.class, messagesFileHandler, "settings", settings);
ReflectionTestUtils.setField(AbstractMessageFileHandler.class, messagesFileHandler, "dataFolder", dataFolder);
ReflectionTestUtils.invokePostConstructMethods(messagesFileHandler);
return messagesFileHandler;
}
}