Skip to content

Use encoding.TextMarshaler for string-valued types #567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
felix-kaestner wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use encoding.TextMarshaler for string-valued types #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions internal/provider/cisco/iosxr/bgp_peer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package iosxr

import (
"encoding/json"
"encoding"
"errors"
"fmt"
"math"
Expand All @@ -20,8 +20,8 @@ var (
_ gnmiext.DataElement = (*BGPPeer)(nil)
_ gnmiext.DataElement = (*BGPPeerOperStatus)(nil)

_ json.Marshaler = BGPPeerOperStatus{}
_ json.Unmarshaler = (*BGPPeerOperStatus)(nil)
_ encoding.TextMarshaler = BGPPeerOperStatus{}
_ encoding.TextUnmarshaler = (*BGPPeerOperStatus)(nil)
)

type AfName string
Expand Down Expand Up @@ -191,16 +191,12 @@ func (p *BGPPeerOperStatus) XPath() string {
return "Cisco-IOS-XR-ipv4-bgp-oper:bgp/instances/instance[instance-name=" + BGPDefaultInstance + "]/instance-active/vrfs/vrf[vrf-name=" + p.Name + "]/sessions/session/connection-state"
}

func (p BGPPeerOperStatus) MarshalJSON() ([]byte, error) {
return json.Marshal(p.State)
func (p BGPPeerOperStatus) MarshalText() ([]byte, error) {
return []byte(p.State), nil
}

func (p *BGPPeerOperStatus) UnmarshalJSON(data []byte) error {
var t string
if err := json.Unmarshal(data, &t); err != nil {
return err
}
p.State = BGPPeerOperSt(t)
func (p *BGPPeerOperStatus) UnmarshalText(data []byte) error {
p.State = BGPPeerOperSt(data)
return nil
}

Expand Down
17 changes: 7 additions & 10 deletions internal/provider/cisco/nxos/bgp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package nxos

import (
"encoding"
"encoding/json"
"errors"
"strings"
Expand Down Expand Up @@ -323,8 +324,8 @@ func (*MultisitePeerItems) XPath() string {
}

var (
_ json.Marshaler = MultisitePeer{}
_ json.Unmarshaler = (*MultisitePeer)(nil)
_ encoding.TextMarshaler = MultisitePeer{}
_ encoding.TextUnmarshaler = (*MultisitePeer)(nil)
)

type MultisitePeer struct {
Expand All @@ -336,16 +337,12 @@ func (p *MultisitePeer) XPath() string {
return "System/bgp-items/inst-items/dom-items/Dom-list[name=default]/peer-items/Peer-list[addr=" + p.Addr + "]/peerType"
}

func (p MultisitePeer) MarshalJSON() ([]byte, error) {
return json.Marshal(p.PeerType)
func (p MultisitePeer) MarshalText() ([]byte, error) {
return []byte(p.PeerType), nil
}

func (p *MultisitePeer) UnmarshalJSON(b []byte) error {
var t string
if err := json.Unmarshal(b, &t); err != nil {
return err
}
p.PeerType = BorderGatewayPeerType(t)
func (p *MultisitePeer) UnmarshalText(b []byte) error {
p.PeerType = BorderGatewayPeerType(b)
return nil
}

Expand Down
24 changes: 10 additions & 14 deletions internal/provider/cisco/nxos/intf.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ package nxos
import (
"cmp"
"context"
"encoding"
"encoding/json"
"errors"
"fmt"
Expand Down Expand Up @@ -670,20 +671,15 @@ const (
)

var (
_ fmt.Stringer = UserFlags(0)
_ json.Marshaler = UserFlags(0)
_ json.Unmarshaler = (*UserFlags)(nil)
_ fmt.Stringer = UserFlags(0)
_ encoding.TextMarshaler = UserFlags(0)
_ encoding.TextUnmarshaler = (*UserFlags)(nil)
)

// UnmarshalJSON implements json.Unmarshaler.
func (f *UserFlags) UnmarshalJSON(b []byte) error {
var s string
if err := json.Unmarshal(b, &s); err != nil {
return err
}

// UnmarshalText implements encoding.TextUnmarshaler.
func (f *UserFlags) UnmarshalText(b []byte) error {
var flags UserFlags
for flag := range strings.SplitSeq(s, ",") {
for flag := range strings.SplitSeq(string(b), ",") {
switch strings.TrimSpace(flag) {
case "admin_state":
flags |= UserFlagAdminState
Expand All @@ -705,9 +701,9 @@ func (f *UserFlags) UnmarshalJSON(b []byte) error {
return nil
}

// MarshalJSON implements json.Marshaler.
func (f UserFlags) MarshalJSON() ([]byte, error) {
return json.Marshal(f.String())
// MarshalText implements encoding.TextMarshaler.
func (f UserFlags) MarshalText() ([]byte, error) {
return []byte(f.String()), nil
}

// String implements fmt.Stringer.
Expand Down
10 changes: 6 additions & 4 deletions internal/provider/cisco/nxos/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"crypto/rand"
"crypto/rsa"
"crypto/x509"
"encoding"
"encoding/base64"
"encoding/hex"
"encoding/json"
Expand Down Expand Up @@ -445,17 +446,18 @@ func (d *Directory) UnmarshalJSON(b []byte) error {
return nil
}

var _ encoding.TextUnmarshaler = (*dirTime)(nil)

// dirTime handles the non-standard timestamp format returned by NX-OS dir output.
type dirTime struct {
time.Time
}

func (t *dirTime) UnmarshalJSON(b []byte) error {
s := strings.Trim(string(b), `"`)
if s == "" || s == "null" {
func (t *dirTime) UnmarshalText(b []byte) error {
if len(b) == 0 {
return nil
}
parsed, err := time.Parse("Jan 02 15:04:05 2006", s)
parsed, err := time.Parse("Jan 02 15:04:05 2006", string(b))
if err != nil {
return err
}
Expand Down
18 changes: 7 additions & 11 deletions internal/provider/cisco/nxos/vlan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package nxos

import (
"encoding/json"
"encoding"

"github.com/ironcore-dev/network-operator/internal/transport/gnmiext"
)
Expand Down Expand Up @@ -101,8 +101,8 @@ func (b *BDItems) GetByVXLAN(v string) *VXLAN {
}

var (
_ json.Marshaler = VXLAN{}
_ json.Unmarshaler = (*VXLAN)(nil)
_ encoding.TextMarshaler = VXLAN{}
_ encoding.TextUnmarshaler = (*VXLAN)(nil)
)

// VXLAN represents VXLAN encapsulation settings for a VLAN.
Expand All @@ -116,15 +116,11 @@ func (v *VXLAN) XPath() string {
return "System/bd-items/bd-items/BD-list[fabEncap=" + v.FabEncap + "]/accEncap"
}

func (v VXLAN) MarshalJSON() ([]byte, error) {
return json.Marshal(v.AccEncap)
func (v VXLAN) MarshalText() ([]byte, error) {
return []byte(v.AccEncap), nil
}

func (v *VXLAN) UnmarshalJSON(b []byte) error {
var encap string
if err := json.Unmarshal(b, &encap); err != nil {
return err
}
v.AccEncap = encap
func (v *VXLAN) UnmarshalText(b []byte) error {
v.AccEncap = string(b)
return nil
}
17 changes: 11 additions & 6 deletions internal/provider/openconfig/banner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package openconfig

import (
"context"
"encoding/json"
"encoding"
"fmt"

"github.com/ironcore-dev/network-operator/api/core/v1alpha1"
Expand Down Expand Up @@ -55,7 +55,11 @@ func toBannerType(t v1alpha1.BannerType) (BannerType, error) {
}

// Compile-time assertions.
var _ gnmiext.DataElement = (*Banner)(nil)
var (
_ gnmiext.DataElement = (*Banner)(nil)
_ encoding.TextMarshaler = (*Banner)(nil)
_ encoding.TextUnmarshaler = (*Banner)(nil)
)

// Banner targets a single banner leaf in the system config.
type Banner struct {
Expand All @@ -68,10 +72,11 @@ func (b *Banner) XPath() string {
return fmt.Sprintf("openconfig-system:system/config/%s", b.Type)
}

func (b *Banner) MarshalJSON() ([]byte, error) {
return json.Marshal(b.Message)
func (b Banner) MarshalText() ([]byte, error) {
return []byte(b.Message), nil
}

func (b *Banner) UnmarshalJSON(data []byte) error {
return json.Unmarshal(data, &b.Message)
func (b *Banner) UnmarshalText(data []byte) error {
b.Message = string(data)
return nil
}
Loading