# SPDX-FileCopyrightText: 2019 Frank Hunleth
#
# SPDX-License-Identifier: Apache-2.0
#
defmodule VintageNet.Interface.RawConfig do
  @moduledoc """
  Raw configuration for an interface

  This struct contains the low-level instructions for how to configure and
  deconfigure an interface.

  Fields:

  * `:ifname` - the name of the interface (e.g., `"eth0"`)
  * `:type` - the type of network interface (aka the module that created the config)
  * `:source_config` - the configuration that generated this one
  * `:required_ifnames` - a list of ifnames that need to exist before starting this configuration. (e.g. `["eth0"]`)
  * `:retry_millis` - if bringing the interface up fails, wait this amount of time before retrying
  * `:files` - a list of file path, content tuples
  * `:restart_strategy` - the restart strategy for the list of `child_specs`. I.e., `:one_for_one | :one_for_all | :rest_for_one`
  * `:child_specs` - a set of child_specs for GenServers to start up and supervise
  * `:up_cmd_millis` - the maximum amount of time to allow the up command list to take
  * `:up_cmds` - a list of commands to run to configure the interface
  * `:down_cmd_millis` - the maximum amount of time to allow the down command list to take
  * `:down_cmds` - a list of commands to run to bring the interface down
  * `:cleanup_files` - additional files to delete (the files listed in `files` are deleted too)

  """

  @typedoc """
  A command to run for RawConfig.up_cmds or RawConfig.down_cmds
  """
  @type command ::
          {:run, String.t(), [String.t()]}
          | {:run_ignore_errors, String.t(), [String.t()]}
          | {:fun, (-> :ok | {:error, any()})}
          | {:fun, module(), atom(), list()}

  @type file_contents :: {Path.t(), String.t()}

  @enforce_keys [:ifname, :type, :source_config, :required_ifnames]
  defstruct ifname: nil,
            type: nil,
            source_config: %{},
            required_ifnames: [],
            retry_millis: 30_000,
            files: [],
            restart_strategy: :one_for_all,
            child_specs: [],
            up_cmd_millis: 5_000,
            up_cmds: [],
            down_cmd_millis: 5_000,
            down_cmds: [],
            cleanup_files: []

  @type t :: %__MODULE__{
          ifname: VintageNet.ifname(),
          type: atom(),
          source_config: map(),
          required_ifnames: [VintageNet.ifname()],
          retry_millis: non_neg_integer(),
          files: [file_contents()],
          restart_strategy: Supervisor.strategy(),
          child_specs: [Supervisor.child_spec() | {module(), term()} | module()],
          up_cmd_millis: non_neg_integer(),
          up_cmds: [command()],
          down_cmd_millis: non_neg_integer(),
          down_cmds: [command()],
          cleanup_files: [Path.t()]
        }
end
