Omitting timer properties from addresses inside NNS (#1413)

The `preferred-life-time` and `valid-life-time` keep changing every time
we do `nmstatectl show`. Because of this, NodeNetworkState is updated
all the time.

In order to reduce the number of updates we are removing those dynamic
properties and introduce `dynamic: true` instead.

Signed-off-by: Mat Kowalski <[email protected]>

Author: mkowalski

pkg/state/filter.go

@@ -59,6 +59,11 @@ func isInInterfaces(interfaceName string, interfaces []interfaceState) bool {
 }
 
 func filterOutDynamicAttributes(iface map[string]interface{}) {
+	filterOutBridgeDynamicAttributes(iface)
+	filterOutIPAddressLifetimeAttributes(iface)
+}
+
+func filterOutBridgeDynamicAttributes(iface map[string]interface{}) {
 	// The gc-timer and hello-time are deep into linux-bridge like this
 	//    - bridge:
 	//        options:
@@ -90,6 +95,39 @@ func filterOutDynamicAttributes(iface map[string]interface{}) {
 	delete(options, "hello-timer")
 }
 
+func filterOutIPAddressLifetimeAttributes(iface map[string]interface{}) {
+	// The preferred-life-time and valid-life-time are in IPv4/IPv6 address entries like this:
+	//    - ipv4:
+	//        address:
+	//          - ip: 192.168.1.1
+	//            prefix-length: 24
+	//            preferred-life-time: 3600
+	//            valid-life-time: 7200
+	filterOutAddressLifetimes(iface, "ipv4")
+	filterOutAddressLifetimes(iface, "ipv6")
+}
+
+func filterOutAddressLifetimes(iface map[string]interface{}, ipVersion string) {
+	ip, ok := iface[ipVersion].(map[string]interface{})
+	if !ok {
+		return
+	}
+
+	addresses, ok := ip["address"].([]interface{})
+	if !ok {
+		return
+	}
+
+	for _, addrRaw := range addresses {
+		addr, ok := addrRaw.(map[string]interface{})
+		if !ok {
+			continue
+		}
+		delete(addr, "preferred-life-time")
+		delete(addr, "valid-life-time")
+	}
+}
+
 func filterOutInterfaces(ifacesState []interfaceState) []interfaceState {
 	filteredInterfaces := []interfaceState{}
 	for _, iface := range ifacesState {

pkg/state/filter_test.go

@@ -325,4 +325,68 @@ dns-resolver:
 			Expect(returnedState).To(MatchYAML(state))
 		})
 	})
+
+	Context("when there are interfaces with preferred-life-time and valid-life-time in addresses", func() {
+		BeforeEach(func() {
+			state = nmstate.NewState(`
+interfaces:
+- name: eth1
+  state: up
+  type: ethernet
+  ipv4:
+    address:
+    - ip: 192.168.1.1
+      prefix-length: 24
+      preferred-life-time: 3600
+      valid-life-time: 7200
+    dhcp: false
+    enabled: true
+  ipv6:
+    address:
+    - ip: 2001:db8::1
+      prefix-length: 64
+      preferred-life-time: 1800
+      valid-life-time: 3600
+    - ip: fe80::1
+      prefix-length: 64
+      preferred-life-time: forever
+      valid-life-time: forever
+    autoconf: false
+    dhcp: false
+    enabled: true
+routes:
+  config: []
+  running: []
+`)
+			filteredState = nmstate.NewState(`
+interfaces:
+- name: eth1
+  state: up
+  type: ethernet
+  ipv4:
+    address:
+    - ip: 192.168.1.1
+      prefix-length: 24
+    dhcp: false
+    enabled: true
+  ipv6:
+    address:
+    - ip: 2001:db8::1
+      prefix-length: 64
+    - ip: fe80::1
+      prefix-length: 64
+    autoconf: false
+    dhcp: false
+    enabled: true
+routes:
+  config: []
+  running: []
+`)
+		})
+		It("should remove preferred-life-time and valid-life-time from address entries", func() {
+			returnedState, err := filterOut(state)
+			Expect(err).ToNot(HaveOccurred())
+			Expect(returnedState).To(MatchYAML(filteredState))
+		})
+	})
 })