Add Scope property for routes

Fixes: #598
Signed-off-by: Lionel Jouin <[email protected]>

Author: LionelJouin

SPEC.md

@@ -578,6 +578,7 @@ Plugins must output a JSON object with the following keys upon a successful `ADD
     - `mtu` (uint): The MTU (Maximum transmission unit) along the path to the destination.
     - `advmss` (uint): The MSS (Maximal Segment Size) to advertise to these destinations when establishing TCP connections.
     - `priority` (uint): The priority of route, lower is higher.
+    - `scope` (uint): The scope of the destinations covered by the route prefix (global (0), link (253), host (254)).
 - `dns`: a dictionary consisting of DNS configuration information
     - `nameservers` (list of strings): list of a priority-ordered list of DNS nameservers that this network is aware of. Each entry in the list is a string containing either an IPv4 or an IPv6 address.
     - `domain` (string): the local domain used for short hostname lookups.

pkg/types/types.go

@@ -170,6 +170,7 @@ type Route struct {
 	MTU      int
 	AdvMSS   int
 	Priority int
+	Scope    int
 }
 
 func (r *Route) String() string {
@@ -182,11 +183,11 @@ func (r *Route) Copy() *Route {
 	}
 
 	return &Route{
-		Dst:      r.Dst,
-		GW:       r.GW,
-		MTU:      r.MTU,
-		AdvMSS:   r.AdvMSS,
-		Priority: r.Priority,
+		Dst:    r.Dst,
+		GW:     r.GW,
+		MTU:    r.MTU,
+		AdvMSS: r.AdvMSS,
+		Scope:  r.Scope,
 	}
 }
 
@@ -242,6 +243,7 @@ type route struct {
 	MTU      int    `json:"mtu,omitempty"`
 	AdvMSS   int    `json:"advmss,omitempty"`
 	Priority int    `json:"priority,omitempty"`
+	Scope    int    `json:"scope,omitempty"`
 }
 
 func (r *Route) UnmarshalJSON(data []byte) error {
@@ -255,6 +257,7 @@ func (r *Route) UnmarshalJSON(data []byte) error {
 	r.MTU = rt.MTU
 	r.AdvMSS = rt.AdvMSS
 	r.Priority = rt.Priority
+	r.Scope = rt.Scope
 
 	return nil
 }
@@ -266,6 +269,7 @@ func (r Route) MarshalJSON() ([]byte, error) {
 		MTU:      r.MTU,
 		AdvMSS:   r.AdvMSS,
 		Priority: r.Priority,
+		Scope:    r.Scope,
 	}
 
 	return json.Marshal(rt)

pkg/types/types_test.go

@@ -91,13 +91,14 @@ var _ = Describe("Types", func() {
 				MTU:      1500,
 				AdvMSS:   1340,
 				Priority: 100,
+				Scope:    253,
 			}
 		})
 
 		It("marshals and unmarshals to JSON", func() {
 			jsonBytes, err := json.Marshal(example)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(jsonBytes).To(MatchJSON(`{ "dst": "1.2.3.0/24", "gw": "1.2.3.1", "mtu": 1500, "advmss": 1340, "priority": 100 }`))
+			Expect(jsonBytes).To(MatchJSON(`{ "dst": "1.2.3.0/24", "gw": "1.2.3.1", "mtu": 1500, "advmss": 1340, "priority": 100, "scope": 253 }`))
 
 			var unmarshaled types.Route
 			Expect(json.Unmarshal(jsonBytes, &unmarshaled)).To(Succeed())
@@ -113,7 +114,7 @@ var _ = Describe("Types", func() {
 		})
 
 		It("formats as a string with a hex mask", func() {
-			Expect(example.String()).To(Equal(`{Dst:{IP:1.2.3.0 Mask:ffffff00} GW:1.2.3.1 MTU:1500 AdvMSS:1340 Priority:100}`))
+			Expect(example.String()).To(Equal(`{Dst:{IP:1.2.3.0 Mask:ffffff00} GW:1.2.3.1 MTU:1500 AdvMSS:1340 Priority:100 Scope:253}`))
 		})
 	})