LoginSystem/src/test/java/fr/xephi/authme/settings/ConfigFileConsistencyTest.java

package fr.xephi.authme.settings;

import fr.xephi.authme.settings.domain.Property;
import fr.xephi.authme.settings.properties.SettingsFieldRetriever;
import fr.xephi.authme.settings.propertymap.PropertyMap;
import fr.xephi.authme.util.StringUtils;
import org.bukkit.configuration.MemorySection;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.configuration.file.YamlConfiguration;
import org.junit.Test;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static org.junit.Assert.fail;

/**
 * Test for {@link NewSetting} and the project's config.yml,
 * verifying that no settings are missing from the file.
 */
public class ConfigFileConsistencyTest {

    /** The file name of the project's sample config file. */
    private static final String CONFIG_FILE = "/config.yml";

    @Test
    public void shouldHaveAllConfigs() throws IOException {
        // given
        URL url = this.getClass().getResource(CONFIG_FILE);
        File configFile = new File(url.getFile());
        FileConfiguration configuration = YamlConfiguration.loadConfiguration(configFile);

        // when
        boolean result = SettingsMigrationService.containsAllSettings(
            configuration, SettingsFieldRetriever.getAllPropertyFields());

        // then
        if (!result) {
            Set<String> knownProperties = getAllKnownPropertyPaths();
            List<String> missingProperties = new ArrayList<>();
            for (String path : knownProperties) {
                if (!configuration.contains(path)) {
                    missingProperties.add(path);
                }
            }
            fail("Found missing properties!\n-" + StringUtils.join("\n-", missingProperties));
        }
    }

    @Test
    public void shouldNotHaveUnknownConfigs() {
        // given
        URL url = this.getClass().getResource(CONFIG_FILE);
        File configFile = new File(url.getFile());
        YamlConfiguration configuration = YamlConfiguration.loadConfiguration(configFile);
        Map<String, Object> allReadProperties = configuration.getValues(true);
        Set<String> knownKeys = getAllKnownPropertyPaths();

        // when
        List<String> unknownPaths = new ArrayList<>();
        for (Map.Entry<String, Object> entry : allReadProperties.entrySet()) {
            // The value being a MemorySection means it's a parent node
            if (!(entry.getValue() instanceof MemorySection) && !knownKeys.contains(entry.getKey())) {
                unknownPaths.add(entry.getKey());
            }
        }

        // then
        if (!unknownPaths.isEmpty()) {
            fail("Found " + unknownPaths.size() + " unknown property paths in the project's config.yml: \n- "
                + StringUtils.join("\n- ", unknownPaths));
        }
    }

    private static Set<String> getAllKnownPropertyPaths() {
        PropertyMap propertyMap = SettingsFieldRetriever.getAllPropertyFields();
        Set<String> paths = new HashSet<>(propertyMap.size());
        for (Property<?> property : propertyMap.keySet()) {
            paths.add(property.getPath());
        }
        return paths;
    }

}