// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.node.admin.container;

import com.yahoo.config.provision.DockerImage;
import com.yahoo.vespa.hosted.node.admin.component.TaskContext;
import com.yahoo.vespa.hosted.node.admin.container.image.Image;
import com.yahoo.vespa.hosted.node.admin.nodeagent.ContainerData;
import com.yahoo.vespa.hosted.node.admin.nodeagent.NodeAgentContext;
import com.yahoo.vespa.hosted.node.admin.task.util.file.UnixUser;
import com.yahoo.vespa.hosted.node.admin.task.util.process.CommandLine;
import com.yahoo.vespa.hosted.node.admin.task.util.process.CommandResult;

import java.time.Duration;
import java.util.List;
import java.util.Optional;

/**
 * Interface for a container engine, such as Docker or Podman.
 *
 * @author mpolden
 */
public interface ContainerEngine {

    /**
     * Create a new container
     * @return ContainerData that can be used to write files inside container
     */
    ContainerData createContainer(NodeAgentContext context, ContainerResources containerResources);

    /** Start a created container */
    void startContainer(NodeAgentContext context);

    /** Update an existing container with new resources */
    void updateContainer(NodeAgentContext context, ContainerId containerId, ContainerResources containerResources);

    /** Remove given container. The container will be stopped if necessary */
    void removeContainer(TaskContext context, PartialContainer container);

    /** Get container for given context */
    Optional<Container> getContainer(NodeAgentContext context);

    /** Returns all containers known by this */
    List<PartialContainer> listContainers(TaskContext context);

    /** Returns the network interface used by container in given context */
    String networkInterface(NodeAgentContext context);

    /** Execute command inside container as given user. Ignores non-zero exit code */
    CommandResult execute(NodeAgentContext context, UnixUser user, Duration timeout, String... command);

    /** Execute command inside the container's network namespace. Throws on non-zero exit code */
    CommandResult executeInNetworkNamespace(NodeAgentContext context, CommandLine.Options options, String... command);

    default CommandResult executeInNetworkNamespace(NodeAgentContext context, String... command) {
        return executeInNetworkNamespace(context, new CommandLine.Options(), command);
    }

    /** Download given image */
    void pullImage(TaskContext context, DockerImage image, RegistryCredentials registryCredentials);

    /** Returns whether given image is already downloaded */
    boolean hasImage(TaskContext context, DockerImage image);

    /** Remove image by id */
    void removeImage(TaskContext context, String id);

    /** Returns images available in this */
    List<Image> listImages(TaskContext context);

}