feat: Add Cisco IOS-XR Provider and implement interface stubs

Author: sven-rosenzweig

internal/provider/cisco/iosxr/intf.go

@@ -0,0 +1,173 @@
+package iosxr
+
+import (
+	"encoding/json"
+	"fmt"
+	"regexp"
+)
+
+// YANG has an empty type that is represented as a JSON array with a single null value. Whenever the key is present in YANG, it should evaluate to true.
+type Empty bool
+
+func (e *Empty) UnmarshalJSON(b []byte) error {
+	var elements []any
+	if err := json.Unmarshal(b, &elements); err != nil {
+		return err
+	}
+
+	// Check if the data is a JSON array with a single null value
+	if len(elements) == 1 && elements[0] == nil {
+		*e = true
+		return nil
+	}
+	*e = false
+	return nil
+}
+
+func (e Empty) MarshalJSON() ([]byte, error) {
+	// If e is true, marshal as a JSON array with a single null value
+	if e {
+		return json.Marshal([]any{nil})
+	}
+	return nil, nil
+}
+
+type PhisIf struct {
+	Name         string       `json:"-"`
+	Description  string       `json:"description,omitempty"`
+	Active       string       `json:"active,omitempty"`
+	Vrf          string       `json:"Cisco-IOS-XR-infra-rsi-cfg:vrf,omitempty"`
+	Statistics   Statistics   `json:"Cisco-IOS-XR-infra-statsd-cfg:statistics,omitzero"`
+	IPv4Network  IPv4Network  `json:"Cisco-IOS-XR-ipv4-io-cfg:ipv4-network,omitzero"`
+	IPv6Network  IPv6Network  `json:"Cisco-IOS-XR-ipv6-ma-cfg:ipv6-network,omitzero"`
+	IPv6Neighbor IPv6Neighbor `json:"Cisco-IOS-XR-ipv6-nd-cfg:ipv6-neighbor,omitzero"`
+	MTUs         MTUs         `json:"mtus,omitzero"`
+	Shutdown     Empty        `json:"shutdown,omitzero"`
+}
+
+type Statistics struct {
+	LoadInterval uint8 `json:"load-interval,omitzero"`
+}
+
+type IPv4Network struct {
+	Addresses AddressesIPv4 `json:"addresses,omitzero"`
+	Mtu       uint16        `json:"mtu,omitzero"`
+}
+
+type AddressesIPv4 struct {
+	Primary Primary `json:"primary,omitzero"`
+}
+
+type Primary struct {
+	Address string `json:"address,omitempty"`
+	Netmask string `json:"netmask,omitempty"`
+}
+
+type IPv6Network struct {
+	Mtu       uint16        `json:"mtu,omitzero"`
+	Addresses AddressesIPv6 `json:"addresses,omitzero"`
+}
+
+type AddressesIPv6 struct {
+	RegularAddresses RegularAddresses `json:"regular-addresses,omitzero"`
+}
+
+type RegularAddresses struct {
+	RegularAddress []RegularAddress `json:"regular-address,omitempty"`
+}
+
+type RegularAddress struct {
+	Address      string `json:"address,omitempty"`
+	PrefixLength uint8  `json:"prefix-length,omitzero"`
+	Zone         string `json:"zone,omitempty"`
+}
+
+type IPv6Neighbor struct {
+	RASuppress bool `json:"ra-suppress,omitempty"`
+}
+
+type MTUs struct {
+	MTU []MTU `json:"mtu,omitempty"`
+}
+
+type MTU struct {
+	MTU   int32  `json:"mtu,omitzero"`
+	Owner string `json:"owner,omitempty"`
+}
+
+func (i *PhisIf) XPath() string {
+	return fmt.Sprintf("Cisco-IOS-XR-ifmgr-cfg:interface-configurations/interface-configuration[active=act][interface-name=%s]", i.Name)
+}
+
+func NewIface(name string) *PhisIf {
+	return &PhisIf{
+		Name:        name,
+		Statistics:  Statistics{},
+		IPv4Network: IPv4Network{},
+		IPv6Network: IPv6Network{},
+		MTUs:        MTUs{},
+	}
+}
+
+func (i *PhisIf) String() string {
+	return fmt.Sprintf("Name: %s, Description=%s, ShutDown=%t", i.Name, i.Description, i.Shutdown)
+}
+
+type IFaceSpeed string
+
+const (
+	TenGig        IFaceSpeed = "TenGigE"
+	TwentyFiveGig IFaceSpeed = "TwentyFiveGigE"
+	FortyGig      IFaceSpeed = "FortyGigE"
+	HundredGig    IFaceSpeed = "HundredGigE"
+)
+
+func ExractMTUOwnerFromIfaceName(ifaceName string) (IFaceSpeed, error) {
+	re := regexp.MustCompile(`^\D*`)
+
+	mtuOwner := string(re.Find([]byte(ifaceName)))
+
+	if mtuOwner == "" {
+		return "", fmt.Errorf("failed to extract MTU owner from interface name %s", ifaceName)
+	}
+
+	switch mtuOwner {
+	case string(TenGig):
+		return TenGig, nil
+	case string(TwentyFiveGig):
+		return TwentyFiveGig, nil
+	case string(FortyGig):
+		return FortyGig, nil
+	case string(HundredGig):
+		return HundredGig, nil
+	default:
+		return "", fmt.Errorf("unsupported interface type %s for MTU owner extraction", mtuOwner)
+	}
+}
+
+type PhysIfStates int
+
+const (
+	StateUp PhysIfStates = iota
+	StateDown
+	StateNotReady
+	StateAdminDown
+	StateShutDown
+)
+
+var stateMapping = map[string]PhysIfStates{
+	"im-state-not-ready": StateNotReady,
+	"im-state-down":      StateDown,
+	"im-state-up":        StateUp,
+	"im-state-shutdown":  StateShutDown,
+}
+
+type PhysIfState struct {
+	State string `json:"state,omitempty"`
+	Name  string `json:"-,omitempty"`
+}
+
+func (phys *PhysIfState) XPath() string {
+	// (fixme): hardcoded route processor for the moment
+	return fmt.Sprintf("Cisco-IOS-XR-ifmgr-oper:interface-properties/data-nodes/data-node[data-node-name=0/RP0/CPU0]/system-view/interfaces/interface[interface-name=%s]", phys.Name)
+}

internal/provider/cisco/iosxr/intf_test.go

@@ -0,0 +1,27 @@
+package iosxr
+
+func init() {
+	name := "TwentyFiveGigE0/0/0/14"
+
+	mtu := MTU{
+		MTU:   9026,
+		Owner: "TwentyFiveGigE",
+	}
+
+	Register("intf", &PhisIf{
+		Name:        name,
+		Description: "test",
+		Active:      "act",
+		MTUs: MTUs{
+			[]MTU{mtu},
+		},
+		IPv4Network: IPv4Network{
+			Addresses: AddressesIPv4{
+				Primary: Primary{
+					Address: "192.168.1.2",
+					Netmask: "255.255.255.0",
+				},
+			},
+		},
+	})
+}

internal/provider/cisco/iosxr/provider.go

@@ -2,11 +2,14 @@ package iosxr
 
 import (
 	"context"
+	"errors"
 	"fmt"
+	"strconv"
 
 	"github.com/ironcore-dev/network-operator/internal/deviceutil"
 	"github.com/ironcore-dev/network-operator/internal/provider"
 	"github.com/ironcore-dev/network-operator/internal/provider/cisco/gnmiext/v2"
+
 	"google.golang.org/grpc"
 )
 
@@ -43,21 +46,22 @@ func (p *Provider) Disconnect(ctx context.Context, conn *deviceutil.Connection)
 
 func (p *Provider) EnsureInterface(ctx context.Context, req *provider.InterfaceRequest) error {
 	if p.client == nil {
-		return fmt.Errorf("client is not connected")
+		return errors.New("client is not connected")
 	}
-	var name string = req.Interface.Spec.Name
+	var name = req.Interface.Spec.Name
 
-	var physif *PhisIf = NewIface(name)
+	var physif = NewIface(name)
 
 	physif.Name = req.Interface.Spec.Name
 	physif.Description = req.Interface.Spec.Description
 
 	physif.Statistics.LoadInterval = 30
 	owner, err := ExractMTUOwnerFromIfaceName(name)
 	if err != nil {
-		return fmt.Errorf("failed to extract MTU owner from interface name %s: %w", name, err)
+		message := "failed to extract MTU owner from interface name" + name
+		return errors.New(message)
 	}
-	physif.MTUs = MTUs{MTU: []MTU{{MTU: uint16(req.Interface.Spec.MTU), Owner: string(owner)}}}
+	physif.MTUs = MTUs{MTU: []MTU{{MTU: req.Interface.Spec.MTU, Owner: string(owner)}}}
 
 	// (fixme): for the moment it is enought to keep this static
 	// option1: extend existing interface spec
@@ -66,31 +70,30 @@ func (p *Provider) EnsureInterface(ctx context.Context, req *provider.InterfaceR
 	physif.Statistics.LoadInterval = uint8(30)
 
 	if len(req.Interface.Spec.IPv4.Addresses) == 0 {
-		return fmt.Errorf("no IPv4 address configured for interface %s", name)
+		message := "no IPv4 address configured for interface " + name
+		return errors.New(message)
 	}
 
 	if len(req.Interface.Spec.IPv4.Addresses) > 1 {
-		return fmt.Errorf("only a single primary IPv4 address is supported for interface %s", name)
+		message := "multiple IPv4 addresses configured for interface " + name
+		return errors.New(message)
 	}
 
 	// (fixme): support IPv6 addresses, IPv6 neighbor config
-	ip := req.Interface.Spec.IPv4.Addresses[0].Prefix.Addr().String()
-	ipNet := req.Interface.Spec.IPv4.Addresses[0].Prefix.Bits()
-	if err != nil {
-		return fmt.Errorf("failed to parse IPv4 address %s: %w", req.Interface.Spec.IPv4.Addresses[0], err)
-	}
+	ip := req.Interface.Spec.IPv4.Addresses[0].Addr().String()
+	ipNet := req.Interface.Spec.IPv4.Addresses[0].Bits()
 
 	physif.IPv4Network = IPv4Network{
 		Addresses: AddressesIPv4{
 			Primary: Primary{
 				Address: ip,
-				Netmask: string(ipNet),
+				Netmask: strconv.Itoa(ipNet),
 			},
 		},
 	}
 
 	// Check if interface exists otherwise patch will fail
-	var tmpiFace *PhisIf = NewIface(name)
+	var tmpiFace = NewIface(name)
 	err = p.client.GetConfig(ctx, tmpiFace)
 	if err != nil {
 		// Interface does not exist, create it
@@ -114,7 +117,7 @@ func (p *Provider) DeleteInterface(ctx context.Context, req *provider.InterfaceR
 	var iFace = NewIface(req.Interface.Spec.Name)
 
 	if p.client == nil {
-		return fmt.Errorf("client is not connected")
+		return errors.New("client is not connected")
 	}
 
 	err := p.client.Delete(ctx, iFace)
@@ -129,10 +132,10 @@ func (p *Provider) GetInterfaceStatus(ctx context.Context, req *provider.Interfa
 	state.Name = req.Interface.Spec.Name
 
 	if p.client == nil {
-		return provider.InterfaceStatus{}, fmt.Errorf("client is not connected")
+		return provider.InterfaceStatus{}, errors.New("client is not connected")
 	}
 
-	states, err := p.client.GetStateWithMultipleUpdates(ctx, state)
+	err := p.client.GetState(ctx, state)
 
 	if err != nil {
 		return provider.InterfaceStatus{}, fmt.Errorf("failed to get interface status for %s: %w", req.Interface.Spec.Name, err)
@@ -141,13 +144,11 @@ func (p *Provider) GetInterfaceStatus(ctx context.Context, req *provider.Interfa
 	providerStatus := provider.InterfaceStatus{
 		OperStatus: true,
 	}
-	for _, s := range *states {
-		currState := s.(*PhysIfState)
-		if stateMapping[currState.State] != StateUp {
-			providerStatus.OperStatus = false
-			break
-		}
+
+	if stateMapping[state.State] != StateUp {
+		providerStatus.OperStatus = false
 	}
+
 	return providerStatus, nil
 }