20cd9e9588
- Avoid logging an error if a help_{lang}.yml file does not exist in the JAR
- No longer suggest /authme messages for updating the help translation
- Create consistency test to ensure that all help_{lang}.yml files in the JAR have entries for all help sections / messages / default permissions
94 lines
3.4 KiB
Java
94 lines
3.4 KiB
Java
package fr.xephi.authme.message;
|
|
|
|
import fr.xephi.authme.TestHelper;
|
|
import fr.xephi.authme.command.help.HelpMessage;
|
|
import fr.xephi.authme.command.help.HelpSection;
|
|
import fr.xephi.authme.permission.DefaultPermission;
|
|
import org.bukkit.configuration.file.FileConfiguration;
|
|
import org.bukkit.configuration.file.YamlConfiguration;
|
|
import org.hamcrest.Matcher;
|
|
import org.junit.Before;
|
|
import org.junit.Test;
|
|
|
|
import java.io.File;
|
|
import java.util.Arrays;
|
|
import java.util.List;
|
|
import java.util.regex.Pattern;
|
|
import java.util.stream.Collectors;
|
|
|
|
import static org.hamcrest.Matchers.both;
|
|
import static org.hamcrest.Matchers.emptyString;
|
|
import static org.hamcrest.Matchers.not;
|
|
import static org.hamcrest.Matchers.nullValue;
|
|
import static org.junit.Assert.assertThat;
|
|
|
|
/**
|
|
* Tests that all help_xx.yml files contain all entries for
|
|
* {@link HelpSection}, {@link HelpMessage} and {@link DefaultPermission}.
|
|
*/
|
|
public class HelpMessageConsistencyTest {
|
|
|
|
private static final String MESSAGES_FOLDER = "/messages";
|
|
private static final Pattern HELP_MESSAGES_FILE = Pattern.compile("help_[a-z]+\\.yml");
|
|
|
|
private List<File> helpFiles;
|
|
|
|
@Before
|
|
public void findHelpMessagesFiles() {
|
|
File folder = TestHelper.getJarFile(MESSAGES_FOLDER);
|
|
File[] files = folder.listFiles();
|
|
if (files == null || files.length == 0) {
|
|
throw new IllegalStateException("Could not get files from '" + MESSAGES_FOLDER + "'");
|
|
}
|
|
helpFiles = Arrays.stream(files)
|
|
.filter(file -> HELP_MESSAGES_FILE.matcher(file.getName()).matches())
|
|
.collect(Collectors.toList());
|
|
}
|
|
|
|
@Test
|
|
public void shouldHaveRequiredEntries() {
|
|
for (File file : helpFiles) {
|
|
// given
|
|
FileConfiguration configuration = YamlConfiguration.loadConfiguration(file);
|
|
|
|
// when / then
|
|
assertHasAllHelpSectionEntries(file.getName(), configuration);
|
|
}
|
|
}
|
|
|
|
private void assertHasAllHelpSectionEntries(String filename, FileConfiguration configuration) {
|
|
for (HelpSection section : HelpSection.values()) {
|
|
assertThat(filename + " should have entry for HelpSection '" + section + "'",
|
|
configuration.getString(section.getKey()), notEmptyString());
|
|
}
|
|
|
|
for (HelpMessage message : HelpMessage.values()) {
|
|
assertThat(filename + " should have entry for HelpMessage '" + message + "'",
|
|
configuration.getString(message.getKey()), notEmptyString());
|
|
}
|
|
|
|
for (DefaultPermission defaultPermission : DefaultPermission.values()) {
|
|
assertThat(filename + " should have entry for DefaultPermission '" + defaultPermission + "'",
|
|
configuration.getString(getPathForDefaultPermission(defaultPermission)), notEmptyString());
|
|
}
|
|
}
|
|
|
|
private static String getPathForDefaultPermission(DefaultPermission defaultPermission) {
|
|
String path = "common.defaultPermissions.";
|
|
switch (defaultPermission) {
|
|
case ALLOWED:
|
|
return path + "allowed";
|
|
case NOT_ALLOWED:
|
|
return path + "notAllowed";
|
|
case OP_ONLY:
|
|
return path + "opOnly";
|
|
default:
|
|
throw new IllegalStateException("Unknown default permission '" + defaultPermission + "'");
|
|
}
|
|
}
|
|
|
|
private static Matcher<String> notEmptyString() {
|
|
return both(not(emptyString())).and(not(nullValue()));
|
|
}
|
|
}
|