project

type Config struct {
	// The Manifest pulls in most of the project configuration.
	Manifest `json:",inline"`

	// ManifestFile is the path to the manifest file.
	ManifestFile string `json:"manifest_file"`

	// Root is the root directory of the project. Usually this is the
	// directory of the manifest file.
	Root string

	// SourceDir is the directory containing source files, data files or
	// additional configuration files. SourceDir and Root are usually
	// identical, unless manifest was generated into a dedicated build
	// directory.
	SourceDir string `json:"source_dir"`

	// EnvFile is the path to the environment file. The content of the
	// environment file will overwrite variables defined in the manifest.
	// Default:
	//
	// 	${NTT_CACHE}/ntt.env
	EnvFile string `json:"env_file"`

	// ResultsFile is the path to the results file.
	ResultsFile string `json:"results_file"`

	K3 struct {
		k3.Instance `json:",inline"`

		// T3XF is the path to the T3XF file.
		T3XF string `json:"t3xf"`
	}
	// contains filtered or unexported fields
}

type ConfigOption func(*Config) error

type ExecuteCondition struct {
	Presets []string
}

type Index struct {
	// SourceDir is the top level source directory.
	SourceDir string `json:"source_dir"`

	// BinaryDir is the top level binary directory.
	BinaryDir string `json:"binary_dir"`

	// Suite is a list of directories to search for project configuration files.
	Suites []Suite `json:"suites"`
}

type Manifest struct {
	// Name is a short name of the project. It is recommended to use TTCN-3
	// identifiers (A-Za-z0-9_).
	Name string

	Version     string
	Description string
	Author      string
	License     string
	Homepage    string
	Repository  string
	Bugs        string
	Keywords    []string

	// Sources is a list of source files which provide the TTCN-3
	// test-cases.
	Sources []string

	// Imports is list of dependencies, which are required to run TTCN-3
	// test-cases. E.g. common code, adapters, codecs, ...
	Imports []string

	// BeforeBuild is a list of shell commands to be executed before
	// building. An exit code unequal to 0 will cancel any further
	// execution.
	BeforeBuild []string `json:"before_build"`

	// AfterBuild is a list of shell commands to be executed after
	// building. An exit code unequal to 0 will cancel any further
	// execution.
	AfterBuild []string `json:"after_build"`

	// BeforeRun is execute before any tests are run. An exit code unequal
	// to 0 will cancel any further test execution.
	BeforeRun []string `json:"before_run"`

	// AfterRun is executed after all tests are run.
	AfterRun []string `json:"after_run"`

	// BeforeTest is executed before each test. An exit code unequal to 0
	// will prevent test execution.
	BeforeTest []string `json:"before_test"`

	// AfterTest is executed after each test. An exit code unequal to 0
	// will result in an error verdict.
	AfterTest []string `json:"after_test"`

	// Variables is a list of variables that can be used in the
	// configuration files. Environment variables and variables defined in
	// the environment file (ntt.env) will overwrite variables defined in
	// this variables section.
	Variables env.Env

	// Diagnostics is a list of diagnostics flags used by compilator
	Diagnostics []string `json:"diagnostics"`

	// Parameters is an embedded parameters file.
	Parameters `json:",inline"`

	// ParametersFile is the path to the parameters file. Default:
	//
	// 	${NTT_SOURCE_DIR}/${NTT_NAME}.parameters
	ParametersFile string `json:"parameters_file"`

	// HooksFile is the path to the hooks file. Default:
	//
	// 	${NTT_SOURCE_DIR}/${NTT_NAME}.hooks
	HooksFile string `json:"hooks_file"`

	// LintFile is the path to the lint configuration file. Default:
	//
	// ${NTT_SOURCE_DIR}/ntt-lint.yml
	LintFile string `json:"lint_file"`
}

type Parameters struct {
	// Global test configuration
	TestConfig `json:",inline"`

	// Presets provides configuration presets, which can be used for global
	// and test specific configuration.
	Presets map[string]TestConfig

	// Execute provides a list of test specific configuration. Each entry
	// specifies how and when a test should be executed.
	Execute []TestConfig
}

type Rules struct {
	// Only execute testcase if the given conditions are met.
	Only *ExecuteCondition `json:",omitempty"`

	// Do not execute testcase if the given conditions are met.
	Except *ExecuteCondition `json:",omitempty"`
}

type Suite struct {
	// RootDir is the root directory of the project. This is usually where the package.yml is located.
	RootDir string `json:"root_dir"`

	// SourceDir is the directory where the test suite source files are located.
	SourceDir string `json:"source_dir"`

	// Target is an optional build target.
	Target string `json:"target,omitempty"`
}

type Task interface {
	// Inputs returns the list of input files.
	Inputs() []string

	// Outputs returns the list of output files.
	Outputs() []string

	// Run executes the task.
	Run() error

	// String returns a string representation of the task.
	String() string
}

type TestConfig struct {
	// A pattern describing a test. Optional testcase parameters are allowed.
	Test string `json:",omitempty"`

	// Presets is a list of preset configurations to be used to execute
	// the test.
	Preset []string `json:",omitempty"`

	// Timeout in seconds.
	Timeout yaml.Duration `json:",omitempty"`

	// Module parameters
	Parameters map[string]string `json:",omitempty"`

	// Rules describe when a configuration should be used.
	Rules `json:",inline"`
}