LoadFlowProviderTest.java

/**
 * Copyright (c) 2023, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.loadflow;

import com.google.common.jimfs.Configuration;
import com.google.common.jimfs.Jimfs;
import com.powsybl.commons.config.InMemoryPlatformConfig;
import com.powsybl.commons.config.MapModuleConfig;
import com.powsybl.commons.parameters.Parameter;
import com.powsybl.commons.report.ReportNode;
import com.powsybl.computation.ComputationManager;
import com.powsybl.iidm.network.Network;
import com.powsybl.loadflow.json.JsonLoadFlowParametersTest;
import com.powsybl.loadflow.json.JsonLoadFlowParametersTest.DummyExtension;
import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.nio.file.FileSystem;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;

import static org.junit.jupiter.api.Assertions.*;

/**
 * @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
 */
class LoadFlowProviderTest {

    @Test
    void findAllProvidersTest() {
        assertEquals(1, LoadFlowProvider.findAll().size());
    }

    @Test
    void testParametersExtension() throws IOException {
        LoadFlowProvider provider = new LoadFlowProviderMock();
        assertEquals(3, provider.getSpecificParameters().size());
        assertEquals(List.of("parameterDouble", "parameterBoolean", "parameterString"), provider.getSpecificParameters().stream().map(Parameter::getName).toList());
        assertSame(DummyExtension.class, provider.getSpecificParametersClass().orElseThrow());
        try (FileSystem fileSystem = Jimfs.newFileSystem(Configuration.unix())) {
            InMemoryPlatformConfig platformConfig = new InMemoryPlatformConfig(fileSystem);
            DummyExtension parametersExtension = (DummyExtension) provider.loadSpecificParameters(platformConfig).orElseThrow();
            assertEquals(0, parametersExtension.getParameterDouble());
            assertFalse(parametersExtension.isParameterBoolean());
            MapModuleConfig moduleConfig = platformConfig.createModuleConfig("dummy-extension");
            moduleConfig.setStringProperty("parameterDouble", "3.14");
            parametersExtension = (DummyExtension) provider.loadSpecificParameters(platformConfig).orElseThrow();
            assertEquals(3.14, parametersExtension.getParameterDouble());
            parametersExtension = (DummyExtension) provider.loadSpecificParameters(Map.of("parameterBoolean", "true")).orElseThrow();
            assertTrue(parametersExtension.isParameterBoolean());
            parametersExtension.setParameterString("ok");
            assertEquals(Map.of("parameterDouble", "0.0", "parameterBoolean", "true", "parameterString", "ok"), provider.createMapFromSpecificParameters(parametersExtension));
            provider.updateSpecificParameters(parametersExtension, Map.of("parameterDouble", "666"));
            assertEquals(666, parametersExtension.getParameterDouble());
        }
    }

    @Test
    void abstractLoadFlowProviderTest() throws IOException {
        var provider = new AbstractNoSpecificParametersLoadFlowProvider() {
            @Override
            public CompletableFuture<LoadFlowResult> run(Network network, ComputationManager computationManager, String workingVariantId, LoadFlowParameters parameters, ReportNode reportNode) {
                return null;
            }

            @Override
            public String getName() {
                return "test";
            }

            @Override
            public String getVersion() {
                return "1";
            }
        };
        assertTrue(provider.getSpecificParametersClass().isEmpty());
        try (FileSystem fileSystem = Jimfs.newFileSystem(Configuration.unix())) {
            assertTrue(provider.loadSpecificParameters(new InMemoryPlatformConfig(fileSystem)).isEmpty());
        }
        assertTrue(provider.loadSpecificParameters(Collections.emptyMap()).isEmpty());
        assertTrue(provider.getSpecificParametersSerializer().isEmpty());
        assertTrue(provider.createMapFromSpecificParameters(new JsonLoadFlowParametersTest.DummyExtension()).isEmpty());
        provider.updateSpecificParameters(new JsonLoadFlowParametersTest.DummyExtension(), Map.of());
        assertTrue(provider.getSpecificParameters().isEmpty());
    }

    @Test
    void testConfiguredParameters() throws IOException {
        LoadFlowProvider provider = new LoadFlowProviderMock();
        try (FileSystem fileSystem = Jimfs.newFileSystem(Configuration.unix())) {
            InMemoryPlatformConfig platformConfig = new InMemoryPlatformConfig(fileSystem);
            List<Parameter> baseSpecificParameters = provider.getSpecificParameters();
            assertEquals(6.4, baseSpecificParameters.get(0).getDefaultValue());
            assertEquals(false, baseSpecificParameters.get(1).getDefaultValue());
            assertEquals("yes", baseSpecificParameters.get(2).getDefaultValue());
            MapModuleConfig moduleConfig = platformConfig.createModuleConfig("dummy-extension");
            moduleConfig.setStringProperty("parameterDouble", "3.14");
            List<Parameter> configuredSpecificParameters = provider.getSpecificParameters(platformConfig);
            assertEquals(3.14, configuredSpecificParameters.get(0).getDefaultValue());
            assertEquals(false, configuredSpecificParameters.get(1).getDefaultValue());
            assertEquals("yes", configuredSpecificParameters.get(2).getDefaultValue());
        }
    }
}