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

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

View File

@ -49,7 +49,7 @@ public class MessagesCommand implements ExecutableCommand {
try { try {
helpTranslationGenerator.updateHelpFile(); helpTranslationGenerator.updateHelpFile();
sender.sendMessage("Successfully updated the help file"); sender.sendMessage("Successfully updated the help file");
helpMessagesService.reload(); helpMessagesService.reloadMessagesFile();
} catch (IOException e) { } catch (IOException e) {
sender.sendMessage("Could not update help file: " + e.getMessage()); sender.sendMessage("Could not update help file: " + e.getMessage());
ConsoleLogger.logException("Could not update help file:", e); ConsoleLogger.logException("Could not update help file:", e);
@ -65,7 +65,7 @@ public class MessagesCommand implements ExecutableCommand {
getMessagePath(DEFAULT_LANGUAGE)) getMessagePath(DEFAULT_LANGUAGE))
.executeCopy(sender); .executeCopy(sender);
if (isFileUpdated) { if (isFileUpdated) {
messages.reload(); messages.reloadMessagesFile();
} }
} catch (Exception e) { } catch (Exception e) {
sender.sendMessage("Could not update messages: " + e.getMessage()); sender.sendMessage("Could not update messages: " + e.getMessage());

View File

@ -4,9 +4,7 @@ import com.google.common.base.CaseFormat;
import fr.xephi.authme.command.CommandArgumentDescription; import fr.xephi.authme.command.CommandArgumentDescription;
import fr.xephi.authme.command.CommandDescription; import fr.xephi.authme.command.CommandDescription;
import fr.xephi.authme.command.CommandUtils; import fr.xephi.authme.command.CommandUtils;
import fr.xephi.authme.initialization.Reloadable; import fr.xephi.authme.message.HelpMessagesFileHandler;
import fr.xephi.authme.message.MessageFileHandlerProvider;
import fr.xephi.authme.message.MessageFileHandler;
import fr.xephi.authme.permission.DefaultPermission; import fr.xephi.authme.permission.DefaultPermission;
import javax.inject.Inject; import javax.inject.Inject;
@ -16,20 +14,18 @@ import java.util.stream.Collectors;
/** /**
* Manages translatable help messages. * Manages translatable help messages.
*/ */
public class HelpMessagesService implements Reloadable { public class HelpMessagesService {
private static final String COMMAND_PREFIX = "commands."; private static final String COMMAND_PREFIX = "commands.";
private static final String DESCRIPTION_SUFFIX = ".description"; private static final String DESCRIPTION_SUFFIX = ".description";
private static final String DETAILED_DESCRIPTION_SUFFIX = ".detailedDescription"; private static final String DETAILED_DESCRIPTION_SUFFIX = ".detailedDescription";
private static final String DEFAULT_PERMISSIONS_PATH = "common.defaultPermissions."; private static final String DEFAULT_PERMISSIONS_PATH = "common.defaultPermissions.";
private final MessageFileHandlerProvider messageFileHandlerProvider; private final HelpMessagesFileHandler helpMessagesFileHandler;
private MessageFileHandler messageFileHandler;
@Inject @Inject
HelpMessagesService(MessageFileHandlerProvider messageFileHandlerProvider) { HelpMessagesService(HelpMessagesFileHandler helpMessagesFileHandler) {
this.messageFileHandlerProvider = messageFileHandlerProvider; this.helpMessagesFileHandler = helpMessagesFileHandler;
reload();
} }
/** /**
@ -40,7 +36,7 @@ public class HelpMessagesService implements Reloadable {
*/ */
public CommandDescription buildLocalizedDescription(CommandDescription command) { public CommandDescription buildLocalizedDescription(CommandDescription command) {
final String path = COMMAND_PREFIX + getCommandSubPath(command); final String path = COMMAND_PREFIX + getCommandSubPath(command);
if (!messageFileHandler.hasSection(path)) { if (!helpMessagesFileHandler.hasSection(path)) {
// Messages file does not have a section for this command - return the provided command // Messages file does not have a section for this command - return the provided command
return command; return command;
} }
@ -72,36 +68,39 @@ public class HelpMessagesService implements Reloadable {
} }
public String getMessage(HelpMessage message) { public String getMessage(HelpMessage message) {
return messageFileHandler.getMessage(message.getKey()); return helpMessagesFileHandler.getMessage(message.getKey());
} }
public String getMessage(HelpSection section) { public String getMessage(HelpSection section) {
return messageFileHandler.getMessage(section.getKey()); return helpMessagesFileHandler.getMessage(section.getKey());
} }
public String getMessage(DefaultPermission defaultPermission) { public String getMessage(DefaultPermission defaultPermission) {
// e.g. {default_permissions_path}.opOnly for DefaultPermission.OP_ONLY // e.g. {default_permissions_path}.opOnly for DefaultPermission.OP_ONLY
String path = DEFAULT_PERMISSIONS_PATH + getDefaultPermissionsSubPath(defaultPermission); String path = DEFAULT_PERMISSIONS_PATH + getDefaultPermissionsSubPath(defaultPermission);
return messageFileHandler.getMessage(path); return helpMessagesFileHandler.getMessage(path);
} }
public static String getDefaultPermissionsSubPath(DefaultPermission defaultPermission) { public static String getDefaultPermissionsSubPath(DefaultPermission defaultPermission) {
return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, defaultPermission.name()); return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, defaultPermission.name());
} }
@Override
public void reload() {
messageFileHandler = messageFileHandlerProvider.initializeHandler(
lang -> "messages/help_" + lang + ".yml");
}
private String getText(String path, Supplier<String> defaultTextGetter) { private String getText(String path, Supplier<String> defaultTextGetter) {
String message = messageFileHandler.getMessageIfExists(path); String message = helpMessagesFileHandler.getMessageIfExists(path);
return message == null return message == null
? defaultTextGetter.get() ? defaultTextGetter.get()
: message; : message;
} }
/**
* Triggers a reload of the help messages file. Note that this method is not needed
* to be called for /authme reload.
*/
public void reloadMessagesFile() {
helpMessagesFileHandler.reload();
}
/** /**
* Returns the command subpath for the given command (i.e. the path to the translations for the given * Returns the command subpath for the given command (i.e. the path to the translations for the given
* command under "commands"). * command under "commands").

View File

@ -0,0 +1,141 @@
package fr.xephi.authme.message;
import com.google.common.annotations.VisibleForTesting;
import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.initialization.DataFolder;
import fr.xephi.authme.initialization.Reloadable;
import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.util.FileUtils;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;
import javax.annotation.PostConstruct;
import javax.inject.Inject;
import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
/**
* Handles a YAML message file with a default file fallback.
*/
public abstract class AbstractMessageFileHandler implements Reloadable {
private static final String DEFAULT_LANGUAGE = "en";
@DataFolder
@Inject
private File dataFolder;
@Inject
private Settings settings;
private String filename;
private FileConfiguration configuration;
private final String defaultFile;
private FileConfiguration defaultConfiguration;
protected AbstractMessageFileHandler() {
this.defaultFile = createFilePath(DEFAULT_LANGUAGE);
}
@Override
@PostConstruct
public void reload() {
String language = settings.getProperty(PluginSettings.MESSAGES_LANGUAGE);
filename = createFilePath(language);
File messagesFile = initializeFile(filename);
configuration = YamlConfiguration.loadConfiguration(messagesFile);
}
/**
* Returns whether the message file configuration has an entry at the given path.
*
* @param path the path to verify
* @return true if an entry exists for the path in the messages file, false otherwise
*/
public boolean hasSection(String path) {
return configuration.get(path) != null;
}
/**
* Returns the message for the given key.
*
* @param key the key to retrieve the message for
* @return the message
*/
public String getMessage(String key) {
String message = configuration.getString(key);
if (message == null) {
ConsoleLogger.warning("Error getting message with key '" + key + "'. "
+ "Please update your config file '" + filename + "' or run " + getUpdateCommand());
return getDefault(key);
}
return message;
}
/**
* Returns the message for the given key only if it exists,
* i.e. without falling back to the default file.
*
* @param key the key to retrieve the message for
* @return the message, or {@code null} if not available
*/
public String getMessageIfExists(String key) {
return configuration.getString(key);
}
/**
* Gets the message from the default file.
*
* @param key the key to retrieve the message for
* @return the message from the default file
*/
private String getDefault(String key) {
if (defaultConfiguration == null) {
InputStream stream = FileUtils.getResourceFromJar(defaultFile);
defaultConfiguration = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
}
String message = defaultConfiguration.getString(key);
return message == null
? "Error retrieving message '" + key + "'"
: message;
}
/**
* Creates the path to the messages file for the given language code.
*
* @param language the language code
* @return path to the message file for the given language
*/
protected abstract String createFilePath(String language);
/**
* @return command with which the messages file can be updated; output when a message is missing from the file
*/
protected abstract String getUpdateCommand();
/**
* Copies the messages file from the JAR to the local messages/ folder if it doesn't exist.
*
* @param filePath path to the messages file to use
* @return the messages file to use
*/
@VisibleForTesting
File initializeFile(String filePath) {
File file = new File(dataFolder, filePath);
// Check that JAR file exists to avoid logging an error
if (FileUtils.getResourceFromJar(filePath) != null && FileUtils.copyFileFromResource(file, filePath)) {
return file;
}
if (FileUtils.copyFileFromResource(file, defaultFile)) {
return file;
} else {
ConsoleLogger.warning("Wanted to copy default messages file '" + defaultFile
+ "' from JAR but it didn't exist");
return null;
}
}
}

View File

@ -0,0 +1,23 @@
package fr.xephi.authme.message;
import javax.inject.Inject;
/**
* File handler for the help_xx.yml resource.
*/
public class HelpMessagesFileHandler extends AbstractMessageFileHandler {
@Inject // Trigger injection in the superclass
HelpMessagesFileHandler() {
}
@Override
protected String createFilePath(String language) {
return "messages/help_" + language + ".yml";
}
@Override
protected String getUpdateCommand() {
return "/authme messages help";
}
}

View File

@ -1,95 +0,0 @@
package fr.xephi.authme.message;
import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.util.FileUtils;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;
import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
/**
* Handles a YAML message file with a default file fallback.
*/
public class MessageFileHandler {
// regular file
private final String filename;
private final FileConfiguration configuration;
private final String updateAddition;
// default file
private final String defaultFile;
private FileConfiguration defaultConfiguration;
/**
* Constructor.
*
* @param file the file to use for messages
* @param defaultFile the default file from the JAR to use if no message is found
* @param updateCommand command to update the messages file (nullable) to show in error messages
*/
public MessageFileHandler(File file, String defaultFile, String updateCommand) {
this.filename = file.getName();
this.configuration = YamlConfiguration.loadConfiguration(file);
this.defaultFile = defaultFile;
this.updateAddition = updateCommand == null
? ""
: " (or run " + updateCommand + ")";
}
/**
* Returns whether the message file configuration has an entry at the given path.
*
* @param path the path to verify
* @return true if an entry exists for the path in the messages file, false otherwise
*/
public boolean hasSection(String path) {
return configuration.get(path) != null;
}
/**
* Returns the message for the given key.
*
* @param key the key to retrieve the message for
* @return the message
*/
public String getMessage(String key) {
String message = configuration.getString(key);
if (message == null) {
ConsoleLogger.warning("Error getting message with key '" + key + "'. "
+ "Please update your config file '" + filename + "'" + updateAddition);
return getDefault(key);
}
return message;
}
/**
* Returns the message for the given key only if it exists,
* i.e. without falling back to the default file.
*
* @param key the key to retrieve the message for
* @return the message, or {@code null} if not available
*/
public String getMessageIfExists(String key) {
return configuration.getString(key);
}
/**
* Gets the message from the default file.
*
* @param key the key to retrieve the message for
* @return the message from the default file
*/
private String getDefault(String key) {
if (defaultConfiguration == null) {
InputStream stream = FileUtils.getResourceFromJar(defaultFile);
defaultConfiguration = YamlConfiguration.loadConfiguration(new InputStreamReader(stream));
}
String message = defaultConfiguration.getString(key);
return message == null
? "Error retrieving message '" + key + "'"
: message;
}
}

View File

@ -1,81 +0,0 @@
package fr.xephi.authme.message;
import com.google.common.annotations.VisibleForTesting;
import fr.xephi.authme.initialization.DataFolder;
import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.util.FileUtils;
import javax.inject.Inject;
import java.io.File;
import java.util.function.Function;
/**
* Injectable creator of {@link MessageFileHandler} instances.
*
* @see MessageFileHandler
*/
public class MessageFileHandlerProvider {
private static final String DEFAULT_LANGUAGE = "en";
@Inject
@DataFolder
private File dataFolder;
@Inject
private Settings settings;
MessageFileHandlerProvider() {
}
/**
* Initializes a message file handler with the messages file of the configured language.
* Ensures beforehand that the messages file exists or creates it otherwise.
*
* @param pathBuilder function taking the configured language code as argument and returning the messages file
* @return the message file handler
*/
public MessageFileHandler initializeHandler(Function<String, String> pathBuilder) {
return initializeHandler(pathBuilder, null);
}
/**
* Initializes a message file handler with the messages file of the configured language.
* Ensures beforehand that the messages file exists or creates it otherwise.
*
* @param pathBuilder function taking the configured language code as argument and returning the messages file
* @param updateCommand command to run to update the languages file (nullable)
* @return the message file handler
*/
public MessageFileHandler initializeHandler(Function<String, String> pathBuilder, String updateCommand) {
String language = settings.getProperty(PluginSettings.MESSAGES_LANGUAGE);
return new MessageFileHandler(
initializeFile(language, pathBuilder),
pathBuilder.apply(DEFAULT_LANGUAGE),
updateCommand);
}
/**
* Copies the messages file from the JAR if it doesn't exist.
*
* @param language the configured language code
* @param pathBuilder function returning message file name with language as argument
* @return the messages file to use
*/
@VisibleForTesting
File initializeFile(String language, Function<String, String> pathBuilder) {
String filePath = pathBuilder.apply(language);
File file = new File(dataFolder, filePath);
// Check that JAR file exists to avoid logging an error
if (FileUtils.getResourceFromJar(filePath) != null && FileUtils.copyFileFromResource(file, filePath)) {
return file;
}
String defaultFilePath = pathBuilder.apply(DEFAULT_LANGUAGE);
if (FileUtils.copyFileFromResource(file, defaultFilePath)) {
return file;
}
return null;
}
}

View File

@ -2,7 +2,6 @@ package fr.xephi.authme.message;
import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableMap;
import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.initialization.Reloadable;
import fr.xephi.authme.util.expiring.Duration; import fr.xephi.authme.util.expiring.Duration;
import org.bukkit.ChatColor; import org.bukkit.ChatColor;
import org.bukkit.command.CommandSender; import org.bukkit.command.CommandSender;
@ -14,7 +13,7 @@ import java.util.concurrent.TimeUnit;
/** /**
* Class for retrieving and sending translatable messages to players. * Class for retrieving and sending translatable messages to players.
*/ */
public class Messages implements Reloadable { public class Messages {
// Custom Authme tag replaced to new line // Custom Authme tag replaced to new line
private static final String NEWLINE_TAG = "%nl%"; private static final String NEWLINE_TAG = "%nl%";
@ -33,16 +32,14 @@ public class Messages implements Reloadable {
.put(TimeUnit.HOURS, MessageKey.HOURS) .put(TimeUnit.HOURS, MessageKey.HOURS)
.put(TimeUnit.DAYS, MessageKey.DAYS).build(); .put(TimeUnit.DAYS, MessageKey.DAYS).build();
private final MessageFileHandlerProvider messageFileHandlerProvider; private MessagesFileHandler messagesFileHandler;
private MessageFileHandler messageFileHandler;
/* /*
* Constructor. * Constructor.
*/ */
@Inject @Inject
Messages(MessageFileHandlerProvider messageFileHandlerProvider) { Messages(MessagesFileHandler messagesFileHandler) {
this.messageFileHandlerProvider = messageFileHandlerProvider; this.messagesFileHandler = messagesFileHandler;
reload();
} }
/** /**
@ -113,7 +110,7 @@ public class Messages implements Reloadable {
*/ */
private String retrieveMessage(MessageKey key) { private String retrieveMessage(MessageKey key) {
return formatMessage( return formatMessage(
messageFileHandler.getMessage(key.getKey())); messagesFileHandler.getMessage(key.getKey()));
} }
/** /**
@ -138,10 +135,12 @@ public class Messages implements Reloadable {
return message; return message;
} }
@Override /**
public void reload() { * Triggers a reload of the messages file. Note that this method is not necessary
this.messageFileHandler = messageFileHandlerProvider * to be called for /authme reload.
.initializeHandler(lang -> "messages/messages_" + lang + ".yml", "/authme messages"); */
public void reloadMessagesFile() {
messagesFileHandler.reload();
} }
private static String formatMessage(String message) { private static String formatMessage(String message) {

View File

@ -0,0 +1,23 @@
package fr.xephi.authme.message;
import javax.inject.Inject;
/**
* File handler for the messages_xx.yml resource.
*/
public class MessagesFileHandler extends AbstractMessageFileHandler {
@Inject // Trigger injection in the superclass
MessagesFileHandler() {
}
@Override
protected String createFilePath(String language) {
return "messages/messages_" + language + ".yml";
}
@Override
protected String getUpdateCommand() {
return "/authme messages";
}
}

View File

@ -1,5 +1,8 @@
package fr.xephi.authme; package fr.xephi.authme;
import ch.jalu.injector.handlers.postconstruct.PostConstructMethodInvoker;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field; import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException; import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method; import java.lang.reflect.Method;
@ -102,4 +105,32 @@ public final class ReflectionTestUtils {
throw new UnsupportedOperationException("Could not invoke method '" + method + "'", e); throw new UnsupportedOperationException("Could not invoke method '" + method + "'", e);
} }
} }
/**
* Runs all methods annotated with {@link javax.annotation.PostConstruct} on the given instance
* (including such methods on superclasses).
*
* @param instance the instance to process
*/
public static void invokePostConstructMethods(Object instance) {
// Use the implementation of the injector to invoke all @PostConstruct methods the same way
new PostConstructMethodInvoker().postProcess(instance, null, null);
}
/**
* Creates a new instance of the given class, using a no-args constructor (which may be hidden).
*
* @param clazz the class to instantiate
* @param <T> the class' type
* @return the created instance
*/
public static <T> T newInstance(Class<T> clazz) {
try {
Constructor<T> constructor = clazz.getDeclaredConstructor();
constructor.setAccessible(true);
return constructor.newInstance();
} catch (ReflectiveOperationException e) {
throw new UnsupportedOperationException("Could not invoke no-args constructor of class " + clazz, e);
}
}
} }

View File

@ -1,64 +1,55 @@
package fr.xephi.authme.command.help; package fr.xephi.authme.command.help;
import ch.jalu.injector.testing.BeforeInjecting; import com.google.common.io.Files;
import ch.jalu.injector.testing.DelayedInjectionRunner; import fr.xephi.authme.ReflectionTestUtils;
import ch.jalu.injector.testing.InjectDelayed; import fr.xephi.authme.TestHelper;
import fr.xephi.authme.command.CommandDescription; import fr.xephi.authme.command.CommandDescription;
import fr.xephi.authme.command.TestCommandsUtil; import fr.xephi.authme.command.TestCommandsUtil;
import fr.xephi.authme.message.MessageFileHandler; import fr.xephi.authme.message.AbstractMessageFileHandler;
import fr.xephi.authme.message.MessageFileHandlerProvider; import fr.xephi.authme.message.HelpMessagesFileHandler;
import fr.xephi.authme.permission.DefaultPermission; import fr.xephi.authme.permission.DefaultPermission;
import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test; import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.rules.TemporaryFolder;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import java.io.File;
import java.io.IOException;
import java.util.Collection; import java.util.Collection;
import java.util.function.Function;
import static fr.xephi.authme.TestHelper.getJarFile;
import static fr.xephi.authme.command.TestCommandsUtil.getCommandWithLabel; import static fr.xephi.authme.command.TestCommandsUtil.getCommandWithLabel;
import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasSize; import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.nullValue;
import static org.hamcrest.Matchers.sameInstance; import static org.hamcrest.Matchers.sameInstance;
import static org.junit.Assert.assertThat; import static org.junit.Assert.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given; import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.verify; import static org.mockito.Mockito.mock;
/** /**
* Test for {@link HelpMessagesService}. * Test for {@link HelpMessagesService}.
*/ */
@RunWith(DelayedInjectionRunner.class)
public class HelpMessagesServiceTest { public class HelpMessagesServiceTest {
private static final String TEST_FILE = "/fr/xephi/authme/command/help/help_test.yml"; private static final String TEST_FILE = "/fr/xephi/authme/command/help/help_test.yml";
private static final Collection<CommandDescription> COMMANDS = TestCommandsUtil.generateCommands(); private static final Collection<CommandDescription> COMMANDS = TestCommandsUtil.generateCommands();
@InjectDelayed
private HelpMessagesService helpMessagesService; private HelpMessagesService helpMessagesService;
@Mock @Rule
private MessageFileHandlerProvider messageFileHandlerProvider; public TemporaryFolder temporaryFolder = new TemporaryFolder();
private File dataFolder;
@BeforeInjecting @Before
@SuppressWarnings("unchecked") public void initializeHandler() throws IOException, InstantiationException, IllegalAccessException {
public void initializeHandler() { dataFolder = temporaryFolder.newFolder();
MessageFileHandler handler = new MessageFileHandler(getJarFile(TEST_FILE), "messages/messages_en.yml", null); new File(dataFolder, "messages").mkdirs();
given(messageFileHandlerProvider.initializeHandler(any(Function.class))).willReturn(handler); File messagesFile = new File(dataFolder, "messages/help_test.yml");
} Files.copy(TestHelper.getJarFile(TEST_FILE), messagesFile);
@Test HelpMessagesFileHandler helpMessagesFileHandler = createMessagesFileHandler();
@SuppressWarnings("unchecked") helpMessagesService = new HelpMessagesService(helpMessagesFileHandler);
public void shouldUseExistingFileAsTextFile() {
// given / when / then
ArgumentCaptor<Function<String, String>> functionCaptor = ArgumentCaptor.forClass(Function.class);
verify(messageFileHandlerProvider).initializeHandler(functionCaptor.capture());
Function<String, String> helpFilePathBuilder = functionCaptor.getValue();
String defaultFilePath = helpFilePathBuilder.apply("en");
assertThat(getClass().getClassLoader().getResource(defaultFilePath), not(nullValue()));
} }
@Test @Test
@ -154,4 +145,15 @@ public class HelpMessagesServiceTest {
// then // then
assertThat(description, equalTo(command.getDescription())); assertThat(description, equalTo(command.getDescription()));
} }
private HelpMessagesFileHandler createMessagesFileHandler() throws IllegalAccessException, InstantiationException {
Settings settings = mock(Settings.class);
given(settings.getProperty(PluginSettings.MESSAGES_LANGUAGE)).willReturn("test");
HelpMessagesFileHandler messagesFileHandler = ReflectionTestUtils.newInstance(HelpMessagesFileHandler.class);
ReflectionTestUtils.setField(AbstractMessageFileHandler.class, messagesFileHandler, "settings", settings);
ReflectionTestUtils.setField(AbstractMessageFileHandler.class, messagesFileHandler, "dataFolder", dataFolder);
ReflectionTestUtils.invokePostConstructMethods(messagesFileHandler);
return messagesFileHandler;
}
} }

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 + "'");
}
};
}
}

View File

@ -1,21 +1,28 @@
package fr.xephi.authme.message; package fr.xephi.authme.message;
import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableMap;
import com.google.common.io.Files;
import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.ReflectionTestUtils;
import fr.xephi.authme.TestHelper; 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 fr.xephi.authme.util.expiring.Duration;
import org.bukkit.command.CommandSender; import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.junit.Before; import org.junit.Before;
import org.junit.BeforeClass; import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test; import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.mockito.ArgumentCaptor; import org.mockito.ArgumentCaptor;
import org.mockito.Mockito; import org.mockito.Mockito;
import java.io.File; import java.io.File;
import java.io.IOException;
import java.util.Map; import java.util.Map;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.logging.Logger; import java.util.logging.Logger;
import static org.hamcrest.Matchers.arrayWithSize; 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.containsString;
import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertThat; import static org.junit.Assert.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.BDDMockito.given; import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mock;
@ -38,9 +44,12 @@ import static org.mockito.hamcrest.MockitoHamcrest.argThat;
public class MessagesIntegrationTest { public class MessagesIntegrationTest {
private static final String YML_TEST_FILE = TestHelper.PROJECT_ROOT + "message/messages_test.yml"; 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; private Messages messages;
@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
private File dataFolder;
@BeforeClass @BeforeClass
public static void setup() { public static void setup() {
TestHelper.setupLogger(); TestHelper.setupLogger();
@ -55,10 +64,15 @@ public class MessagesIntegrationTest {
* file that should contain all messages, but again, for testing, it just contains a few. * file that should contain all messages, but again, for testing, it just contains a few.
*/ */
@Before @Before
public void setUpMessages() { public void setUpMessages() throws IOException {
File testFile = TestHelper.getJarFile(YML_TEST_FILE); dataFolder = temporaryFolder.newFolder();
MessageFileHandlerProvider provider = providerReturning(testFile, YML_DEFAULT_TEST_FILE); File testFile = new File(dataFolder, "messages/messages_test.yml");
messages = new Messages(provider); new File(dataFolder, "messages").mkdirs();
FileUtils.create(testFile);
Files.copy(TestHelper.getJarFile(YML_TEST_FILE), testFile);
MessagesFileHandler fileHandler = createMessagesFileHandler();
messages = new Messages(fileHandler);
} }
@Test @Test
@ -254,11 +268,14 @@ public class MessagesIntegrationTest {
} }
} }
@SuppressWarnings("unchecked") private MessagesFileHandler createMessagesFileHandler() {
private static MessageFileHandlerProvider providerReturning(File file, String defaultFile) { Settings settings = mock(Settings.class);
MessageFileHandlerProvider handler = mock(MessageFileHandlerProvider.class); given(settings.getProperty(PluginSettings.MESSAGES_LANGUAGE)).willReturn("test");
given(handler.initializeHandler(any(Function.class), anyString()))
.willReturn(new MessageFileHandler(file, defaultFile, "/authme messages")); MessagesFileHandler messagesFileHandler = new MessagesFileHandler();
return handler; ReflectionTestUtils.setField(AbstractMessageFileHandler.class, messagesFileHandler, "settings", settings);
ReflectionTestUtils.setField(AbstractMessageFileHandler.class, messagesFileHandler, "dataFolder", dataFolder);
ReflectionTestUtils.invokePostConstructMethods(messagesFileHandler);
return messagesFileHandler;
} }
} }

View File

@ -10,7 +10,7 @@ import fr.xephi.authme.command.help.HelpMessage;
import fr.xephi.authme.command.help.HelpMessagesService; import fr.xephi.authme.command.help.HelpMessagesService;
import fr.xephi.authme.command.help.HelpSection; import fr.xephi.authme.command.help.HelpSection;
import fr.xephi.authme.initialization.DataFolder; import fr.xephi.authme.initialization.DataFolder;
import fr.xephi.authme.message.MessageFileHandlerProvider; import fr.xephi.authme.message.HelpMessagesFileHandler;
import fr.xephi.authme.settings.Settings; import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings; import fr.xephi.authme.settings.properties.PluginSettings;
import org.bukkit.configuration.MemorySection; import org.bukkit.configuration.MemorySection;
@ -44,7 +44,7 @@ public class HelpTranslationGeneratorIntegrationTest {
@InjectDelayed @InjectDelayed
private HelpMessagesService helpMessagesService; private HelpMessagesService helpMessagesService;
@InjectDelayed @InjectDelayed
private MessageFileHandlerProvider messageFileHandlerProvider; private HelpMessagesFileHandler helpMessagesFileHandler;
@InjectDelayed @InjectDelayed
private CommandInitializer commandInitializer; private CommandInitializer commandInitializer;