types

type Config struct {
	Name            string            `yaml:"name" mapstructure:"name"`
	Modules         []string          `yaml:"module" mapstructure:"module"`
	GlobalSettings  GlobalSettings    `yaml:"global" mapstructure:"global"`
	FileDefinitions []*FileDefinition `yaml:"file" mapstructure:"file"`
	FileFormats     []*FileFormat     `yaml:"format,flow" mapstructure:"format,flow"`
	Layers          []*Layer          `yaml:"layer" mapstructure:"layer"`
	ManagementLayer ManagementLayer   `yaml:"mgmt_layer" mapstructure:"mgmt_layer"`
	ParameterRules  []*ParameterRule  `yaml:"param_rule,flow" mapstructure:"param_rule,flow"`

	NetworkClasses    []*NetworkClass    `yaml:"networkclass,flow" mapstructure:"network,flow"`
	NodeClasses       []*NodeClass       `yaml:"nodeclass,flow" mapstructure:"nodes,flow"`
	InterfaceClasses  []*InterfaceClass  `yaml:"interfaceclass,flow" mapstructure:"interfaces,flow"`
	ConnectionClasses []*ConnectionClass `yaml:"connectionclass,flow" mapstructure:"connections,flow"`
	GroupClasses      []*GroupClass      `yaml:"groupclass,flow" mapstructure:"group,flow"`

	LoadedModules              []Module           // reference to loaded modules, internal
	SorterConfigTemplateGroups mapset.Set[string] // list of sort-style config template groups
	// contains filtered or unexported fields
}

type ConfigTemplate struct {
	// Config block aggregation styles
	// hierarchy (default): specify child config templates in the template description as parameter
	// sort: merge child config templates of SortTarget groups into the "sort" config templates
	Style     string `yaml:"style" mapstructure:"style"`
	SortGroup string `yaml:"sort_group" mapstructure:"sort_group"`
	// Target file definition name
	// Config templates with file will generate a file of generated text
	File string `yaml:"file" mapstructure:"file"`
	// Name is used by parent objects to specify as childs in templates
	// Config templates with name will form a parameter that can be embeded in other hierarchy templates
	Name string `yaml:"name" mapstructure:"name"`
	// Group is used for sort config templates
	// A sort config template will aggregate all config blocks generated in child (or grandchild) objects of the same group
	Group string `yaml:"group" mapstructure:"group"`
	// Priority is used to reorder config templates in sort style
	// Config blocks with smaller priority should be on the top of generated config files
	// Default is 0, so users should specify negative values to make a config block top of a file
	Priority int `yaml:"priority" mapstructure:"priority"`
	// Used for hierarchy config templates
	// Config template names on same object that need to be embeded
	// Required for ordering config template generation considering the dependency
	Depends []string `yaml:"depends" mapstructure:"depends"`

	// Condition related fields
	// add config only for interfaces of nodes belongs to the nodeclass(es)
	// this option is valid only on InterfaceClass, ConnectionClass, and their NeighborClass
	NodeClass   string   `yaml:"node" mapstructure:"node"`
	NodeClasses []string `yaml:"nodes" mapstructure:"nodes"`
	// add config only if the neighbor node belongs to the nodeclass(es)
	// this option is valid only on NeighborClass
	NeighborNodeClass   string   `yaml:"neighbor_node" mapstructure:"neighbor_node"`
	NeighborNodeClasses []string `yaml:"neighbor_nodes" mapstructure:"neighbor_nodes"`
	// put empty file or namespace if conditions are not satisfied
	Empty bool `yaml:"empty" mapstructure:"empty"`

	// This option is valid only on InterfaceClass or ConnectionClass
	// If specified, add config only for included output (e.g., tinet only, clab only, etc)
	Platform []string `yaml:"platform,flow" mapstructure:"platform,flow"`
	// Style is used to iterpret the given config format. Style can be different on one file. As-is in default.
	//Style string `yaml:"style" mapstructure:"style"`
	Format  string   `yaml:"format" mapstructure:"format"`
	Formats []string `yaml:"formats" mapstructure:"formats"`
	// Priority is a value to be used for sorting config blocks. 0 in default.
	// Priority int `yaml:"priority" mapstructure:"priority"`
	// Load config template
	Template []string `yaml:"template" mapstructure:"template"`
	// Load config template from external file
	SourceFile string `yaml:"sourcefile" mapstructure:"sourcefile"`

	ParsedTemplate *template.Template
	// contains filtered or unexported fields
}

type Connection struct {
	Src    *Interface
	Dst    *Interface
	Layers mapset.Set[string]

	*ParsedLabels
}

type ConnectionClass struct {
	Name            string            `yaml:"name" mapstructure:"name"`
	Primary         bool              `yaml:"primary" mapstructure:"primary"`
	Virtual         bool              `yaml:"virtual" mapstructure:"virtual"`
	IPPolicy        []string          `yaml:"policy,flow" mapstructure:"policy,flow"`
	Layers          []string          `yaml:"layers,flow" mapstructure:"layers,flow"` // Connection is limited to specified layers
	Parameters      []string          `yaml:"params,flow" mapstructure:"params,flow"` // Parameter policies
	Values          map[string]string `yaml:"values" mapstructure:"values"`
	ConfigTemplates []*ConfigTemplate `yaml:"config,flow" mapstructure:"config,flow"`
	MemberClasses   []*MemberClass    `yaml:"classmembers,flow" mapstructure:"classmembers,flow"`
	NeighborClasses []*NeighborClass  `yaml:"neighbors,flow" mapstructure:"neighbors,flow"`

	// Following attributes are valid only on primary interface classes.
	Prefix    string                 `yaml:"prefix" mapstructure:"prefix"` // prefix of interface auto-naming
	TinetAttr map[string]interface{} `yaml:"tinet" mapstructure:"tinet"`   // tinet attributes
	ClabAttr  map[string]interface{} `yaml:"clab" mapstructure:"clab"`     // containerlab attributes

	LabelOwnerClass
}

type FileDefinition struct {
	// Name is used as the filename of generated file.
	Name string `yaml:"name" mapstructure:"name"`
	// Path is the path that the generated file is placed on the node.
	// If empty, the file is generated but not placed on the node.
	Path string `yaml:"path" mapstructure:"path"`
	// Format is used to determine the way to format lines in generated config text.
	Format  string   `yaml:"format" mapstructure:"format"`
	Formats []string `yaml:"formats,flow" mapstructure:"formats,flow"`
	// Scope specifies the scope of file creation.
	// For example, if Scope = "node", the file is created for each node.
	Scope string `yaml:"scope" mapstructure:"scope"`
}

type FileFormat struct {
	Name           string `yaml:"name" mapstructure:"name"`
	LinePrefix     string `yaml:"lineprefix" mapstructure:"lineprefix"`
	LineSuffix     string `yaml:"linesuffix" mapstructure:"linesuffix"`
	LineSeparator  string `yaml:"lineseparator" mapstructure:"lineseparator"`
	BlockPrefix    string `yaml:"blockprefix" mapstructure:"blockprefix"`
	BlockSuffix    string `yaml:"blocksuffix" mapstructure:"blocksuffix"`
	BlockSeparator string `yaml:"blockseparator" mapstructure:"blockseparator"`
}

type GlobalSettings struct {
	PathSpecification string `yaml:"path" mapstructure:"path"`
	MountSourcePath   string `yaml:"mountsourcepath" mapstructure:"mountsourcepath"`
	NodeAutoRename    bool   `yaml:"nodeautoname" mapstructure:"nodeautoname"`
	// ASNumberMin and ASNumberMAX are optional, considered in AssignASNumbers if specified
	ASNumberMin int `yaml:"asnumber_min" mapstructure:"asnumber_min"`
	ASNumberMax int `yaml:"asnumber_max" mapstructure:"asnumber_max"`

	ClabAttr map[string]interface{} `yaml:"clab" mapstructure:"clab"` // containerlab attributes
}

type Group struct {
	Name  string
	Nodes []*Node

	*NameSpace
	*ParsedLabels
}

type GroupClass struct {
	Name            string            `yaml:"name" mapstructure:"name"`
	Virtual         bool              `yaml:"virtual" mapstructure:"virtual"`
	Parameters      []string          `yaml:"params,flow" mapstructure:"params,flow"` // Parameter policies
	Values          map[string]string `yaml:"values" mapstructure:"values"`
	ConfigTemplates []*ConfigTemplate `yaml:"config,flow" mapstructure:"config,flow"`

	LabelOwnerClass
}

type IPPolicy struct {
	Name string `yaml:"name" mapstructure:"name"`
	// type: ip (deafult), loopback, mgmt
	Type                string `yaml:"type" mapstructure:"type"`
	AddrRange           string `yaml:"range" mapstructure:"range"`
	DefaultPrefixLength int    `yaml:"prefix" mapstructure:"prefix"`
	// contains filtered or unexported fields
}

type Interface struct {
	Name       string
	Node       *Node
	Virtual    bool
	Connection *Connection
	Opposite   *Interface
	Neighbors  map[string][]*Neighbor
	TinetAttr  *map[string]interface{}
	// ClabAttr        *map[string]interface{}
	NamePrefix string

	*NameSpace
	*ParsedLabels
	// contains filtered or unexported fields
}

type InterfaceClass struct {
	// An interface can have only one of "primary" interface class or "primary" connection class.
	Name            string            `yaml:"name" mapstructure:"name"`
	Primary         bool              `yaml:"primary" mapstructure:"primary"`
	Virtual         bool              `yaml:"virtual" mapstructure:"virtual"`
	IPPolicy        []string          `yaml:"policy,flow" mapstructure:"policy,flow"`
	Parameters      []string          `yaml:"params,flow" mapstructure:"params,flow"` // Parameter policies
	Values          map[string]string `yaml:"values" mapstructure:"values"`
	ConfigTemplates []*ConfigTemplate `yaml:"config,flow" mapstructure:"config,flow"`
	NeighborClasses []*NeighborClass  `yaml:"neighbors,flow" mapstructure:"neighbors,flow"`
	MemberClasses   []*MemberClass    `yaml:"classmembers,flow" mapstructure:"classmembers,flow"`

	// Following attributes are valid only on primary interface classes.
	Prefix    string                 `yaml:"prefix" mapstructure:"prefix"` // prefix of auto-naming
	TinetAttr map[string]interface{} `yaml:"tinet" mapstructure:"tinet"`   // tinet attributes
	ClabAttr  map[string]interface{} `yaml:"clab" mapstructure:"clab"`     // containerlab attributes

	LabelOwnerClass
}

type LabelOwner interface {
	ClassLabels() []string
	PlaceLabels() []string
	ValueLabels() map[string]string
	MetaValueLabels() map[string]string
	SetLabels(cfg *Config, labels []string, moduleLabels []string) error

	HasClass(string) bool
	GetClasses() []ObjectClass

	SetVirtual(bool)
	IsVirtual() bool

	ClassDefinition(cfg *Config, cls string) (interface{}, error)

	ObjectInstance
}

type LabelOwnerClass interface {
	GetGivenValues() map[string]string
}

type Layer struct {
	Name string `yaml:"name" mapstructure:"name"`
	// If default_connect is true, ConnectionClasses without ipspaces field are considered as connected on this Layer
	DefaultConnect bool        `yaml:"default_connect" mapstructure:"default_connect"`
	Policies       []*IPPolicy `yaml:"policy" mapstructure:"policy"`

	Layerer

	IPPolicy       []*IPPolicy
	LoopbackPolicy []*IPPolicy
}

type Layerer interface {
	IPAddressReplacer() string
	IPNetworkReplacer() string
	IPPrefixLengthReplacer() string
}

type ManagementLayer struct {
	Name      string `yaml:"name" mapstructure:"name"`
	AddrRange string `yaml:"range" mapstructure:"range"`
	// gateway is used only for management network or external network
	// the address is avoided in automated IPaddress assignment
	ExternalGateway string `yaml:"gateway" mapstructure:"gateway"`
	InterfaceName   string `yaml:"interface_name" mapstructure:"mgmt_name"`

	Layerer
}

type Member struct {
	ClassName string
	ClassType string
	Referrer  MemberReferrer
	Member    NameSpacer

	*NameSpace
}

type MemberClass struct {
	NodeClass         string            `yaml:"node" mapstructure:"node"`
	NodeClasses       []string          `yaml:"nodes" mapstructure:"nodes"`
	InterfaceClass    string            `yaml:"interface" mapstructure:"interface"`
	InterfaceClasses  []string          `yaml:"interfaces" mapstructure:"interfaces"`
	ConnectionClass   string            `yaml:"connection" mapstructure:"connection"`
	ConnectionClasses []string          `yaml:"connections" mapstructure:"connections"`
	IncludeSelf       bool              `yaml:"include_self" mapstructure:"include_self"`
	ConfigTemplates   []*ConfigTemplate `yaml:"config,flow" mapstructure:"config,flow"`
}

type MemberReferrer interface {
	LabelOwner
	NameSpacer
	ObjectInstance

	AddMemberClass(*MemberClass)
	GetMemberClasses() []*MemberClass
	AddMember(*Member)
	GetMembers() []*Member
}

type Module interface {
	UpdateConfig(cfg *Config) error
	AddModuleNodeClassLabel(label string)
	GetModuleNodeClassLabels() []string
	AddModuleInterfaceClassLabel(label string)
	GetModuleInterfaceClassLabels() []string
	AddModuleConnectionClassLabel(label string)
	GetModuleConnectionClassLabels() []string
	//SetClasses(cfg *Config, nm *NetworkModel) error
	GenerateParameters(cfg *Config, nm *NetworkModel) error
	CheckModuleRequirements(cfg *Config, nm *NetworkModel) error
}

type NameSpace struct {
	// contains filtered or unexported fields
}

type NameSpacer interface {
	// Methods to trace top-down network model
	ChildClasses() ([]string, error)
	Childs(c string) ([]NameSpacer, error)

	IterateFlaggedParams() <-chan string
	AddParam(k, v string)
	HasParam(k string) bool

	// BuildRelativeNameSpace() error
	BuildRelativeNameSpace(globalParams map[string]map[string]string) error
	SetRelativeParam(k, v string)
	HasRelativeParam(k string) bool
	SetRelativeParams(map[string]string)
	GetParams() map[string]string
	GetRelativeParams() map[string]string
	GetParamValue(string) (string, error)

	GetConfigTemplates(cfg *Config) []*ConfigTemplate
	GetPossibleConfigTemplates(cfg *Config) []*ConfigTemplate

	ObjectInstance
	// contains filtered or unexported methods
}

type Neighbor struct {
	Self            *Interface
	Neighbor        *Interface
	Layer           string
	NeighborClasses []*NeighborClass

	*NameSpace
}

type NeighborClass struct {
	Layer           string            `yaml:"layer" mapstructure:"layer"`
	ConfigTemplates []*ConfigTemplate `yaml:"config,flow" mapstructure:"config,flow"`
}

type NetworkClass struct {
	Name            string            `yaml:"name" mapstructure:"name"`
	Values          map[string]string `yaml:"values" mapstructure:"values"`
	ConfigTemplates []*ConfigTemplate `yaml:"config,flow" mapstructure:"config,flow"`

	LabelOwnerClass
}

type NetworkModel struct {
	Name        string
	Nodes       []*Node
	Connections []*Connection
	Groups      []*Group
	Classes     []*NetworkClass

	*NameSpace

	NetworkSegments map[string][]*SegmentMembers
	// contains filtered or unexported fields
}

type Node struct {
	Name       string
	Interfaces []*Interface
	Groups     []*Group
	//Virtual    bool
	// Files      *ConfigFiles
	TinetAttr *map[string]interface{}
	ClabAttr  *map[string]interface{}

	*NameSpace
	*ParsedLabels

	NamePrefix string
	// contains filtered or unexported fields
}

type NodeClass struct {
	// A node can have only one "primary" node class.
	// Unprimary node classes only have "name", "numbered" and "config". Other attributes are ignored.
	// A virtual node have parameters, but no object nor configuration. It is considered only on parameter assignment.
	Name              string            `yaml:"name" mapstructure:"name"`
	Primary           bool              `yaml:"primary" mapstructure:"primary"`
	Virtual           bool              `yaml:"virtual" mapstructure:"virtual"`
	IPPolicy          []string          `yaml:"policy,flow" mapstructure:"policy,flow"`
	Parameters        []string          `yaml:"params,flow" mapstructure:"params,flow"` // Parameter policies
	Values            map[string]string `yaml:"values" mapstructure:"values"`
	InterfaceIPPolicy []string          `yaml:"interface_policy,flow" mapstructure:"interface_policy,flow"`
	ConfigTemplates   []*ConfigTemplate `yaml:"config,flow" mapstructure:"config,flow"`
	MemberClasses     []*MemberClass    `yaml:"classmembers,flow" mapstructure:"classmembers,flow"`

	// Following attributes are valid only on primary interface classes.
	Prefix        string                 `yaml:"prefix" mapstructure:"prefix"`                           // prefix of auto-naming
	MgmtInterface string                 `yaml:"mgmt_interfaceclass" mapstructure:"mgmt_interfaceclass"` // InterfaceClass name for mgmt
	TinetAttr     map[string]interface{} `yaml:"tinet" mapstructure:"tinet"`                             // tinet attributes
	ClabAttr      map[string]interface{} `yaml:"clab" mapstructure:"clab"`                               // containerlab attributes

	LabelOwnerClass
}

type ObjectClass interface{}

type ObjectInstance interface {
	StringForMessage() string // just for debug messages
}

type ParameterRule struct {
	Name string `yaml:"name" mapstructure:"name"`
	// object (in default) or segment
	Assign string `yaml:"assign" mapstructure:"assign"`
	// layer is used only when the assign option is "segment"
	Layer string `yaml:"layer" mapstructure:"layer"`
	// integer (in default) or file
	Type string `yaml:"type" mapstructure:"type"`
	// for type integer
	Max    int    `yaml:"max" mapstructure:"max"`
	Min    int    `yaml:"min" mapstructure:"min"`
	Header string `yaml:"header" mapstructure:"header"`
	Footer string `yaml:"footer" mapstructure:"footer"`
	// for type file
	SourceFile string `yaml:"sourcefile" mapstructure:"soucefile"`
}

type ParsedLabels struct {
	Classes []ObjectClass
	// contains filtered or unexported fields
}

type SegmentMembers struct {
	Interfaces  []*Interface
	Connections []*Connection
}

type StandardModule struct {
	NodeClassLabels       []string
	InterfaceClassLabels  []string
	ConnectionClassLabels []string
}