config

type CLIOptions interface {
	// Port returns the configured port number the HTTP server should bind to.
	// Defaults to "80".
	Port() uint16

	// ConfigPath returns the configured path to the service config file.
	// Defaults to "/app/config.yml".
	ConfigPath() string

	// WorkspacePath returns the configured workspace root directory.
	// Defaults to "/workspace"
	WorkspacePath() string

	// GetUsablePort returns the configured server port in the format expected by
	// the Golang HTTP server package.
	GetUsablePort() string
}

type Command struct {
	Executable string   `yaml:"executable" json:"executable"`
	Args       []string `yaml:"args" json:"arguments"`
}

type FileOptions interface {

	// Commands returns the command configured in the config.yml file.
	Commands() Command

	// FileTypes returns the configured allowed file types for the handler
	// command.
	FileTypes() []string

	// ServiceName returns the name of the configured service.
	ServiceName() string
}

type InjectorProvider func(
	*job.Details,
	*job.Metadata,
	*logrus.Entry,
) inject.VariableInjector

type Options struct {

	// Name of the service as it appears in health/status output.
	ServiceName string `yaml:"service-name" json:"serviceName"`

	// Configuration for the CLI call to the dataset tooling used to process
	// uploads.
	Command Command `yaml:"command" json:"command"`

	// Allowed list of raw upload file extensions.
	//
	// The service will handle zip and tar archives automatically.  This config
	// option simply controls what file extensions are allowed for uploads in
	// addition to the server's built in archive handling.
	//
	// Leaving this empty, or omitting it will mean that the server will only
	// accept it's own known archive formats, and will reject everything else.
	//
	// Setting this to, for example, ".txt" will result in the server allowing
	// file uploads for archive formats _and_ files ending in the extension
	// ".txt".
	FileTypes []string `yaml:"file-types" json:"fileTypes"`

	// CLI Option: Port the HTTP server will bind to on startup.
	Port uint16 `yaml:"-" json:"port"`

	// CLI Option: Path to the configuration file to use.
	ConfigPath string `yaml:"-" json:"configPath"`

	// Internal: The current service binary version as a string value.
	Version string `yaml:"-" json:"-"`

	Workspace string `yaml:"-" json:"workspace"`
}