/*
 * RiskScape™ Copyright New Zealand Institute for Earth Science Limited
 * (Earth Sciences New Zealand) is distributed for research purposes only
 * under the terms of AGPLv3.
 *
 * RiskScape™ Copyright 2026 New Zealand Institute for Earth Science
 * Limited (Earth Sciences New Zealand). All rights reserved. Source code
 * available under the AGPLv3.
 * 
 * This program is free software: you can redistribute it and/or modify it under
 *  the terms of the GNU Affero General Public License as published by the Free
 *  Software Foundation, either version 3 of the License, or (at your option) any
 *  later version.
 * 
 * This program is distributed for RESEARCH PURPOSES ONLY, in the hope that it will
 * be useful for research and education initiatives.
 * 
 * If you are not a researcher, or you are a researcher who wishes to use this
 * program on terms other than AGPLv3 (including those who wish to restrict the
 * distribution of any source code created using this program), please contact:
 * https://riskscape.org.nz
 * 
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Affero General Public License for more details.  You should have received a copy
 * of the GNU Affero General Public License along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * By way of summary only, under the AGPLv3:
 *     • Permissions of this strongest copyleft license are conditioned
 *       on making available complete source code of licensed works and
 *       modifications, which include larger works using a licensed work,
 *       under the same license.
 *     • Copyright and license notices must be preserved.
 *     • Contributors provide an express grant of patent rights.
 *     • When a modified version is used to provide a service over a
 *       network, the complete source code of the modified version must be made
 *       available.
 */
package nz.org.riskscape.defaults;

import java.nio.file.Paths;
import java.util.Arrays;
import java.util.List;

import nz.org.riskscape.engine.DefaultEngine;
import nz.org.riskscape.engine.DefaultProject;
import nz.org.riskscape.engine.ProjectTest;
import nz.org.riskscape.engine.core.EnginePlugin;
import nz.org.riskscape.engine.defaults.Plugin;
import nz.org.riskscape.engine.plugin.BuiltInPluginDescriptor;
import nz.org.riskscape.engine.spi.EngineBootstrapper;

/**
 * Base class for tests that want to do integration tests using the default plugin
 */
public abstract class DefaultProjectTest extends ProjectTest {

  Plugin plugin;

  public Plugin getPlugin() {
    if (plugin == null) {
      plugin = BuiltInPluginDescriptor.testPlugin("default", Plugin.class, Paths.get("."));
    }

    return plugin;
  }

  @Override
  public List<nz.org.riskscape.engine.plugin.Plugin> getPlugins() {
    return Arrays.asList(
      new EnginePlugin(EnginePlugin.DESCRIPTOR),
      getPlugin()
    );
  }

  @Override
  public void addFeatures() {
  }

  @Override
  protected void populateEngineWithDefaults(DefaultEngine newEngine) {
    EngineBootstrapper.bootstrap(extensionPoints, newEngine);
    plugin.initializeEngine(newEngine);
  }

  @Override
  protected DefaultProject createProject() {
    DefaultProject project = super.createProject();

    plugin.initializeProject(project, engine);
    plugin.addFunctions(project, (p) -> System.err.println(p));
    return project;
  }

  @Override
  public void addDefaultTypesToRegistry() throws Exception {
    // we are relying on the plugin to do this, stop base class from doing it
  }

}

