fix(etcd): canonicalize member join peer URLs

Author: wei

addons/etcd/scripts-ut-spec/member_join_spec.sh

@@ -107,6 +107,16 @@ Describe "Etcd Member Join Script Tests"
               '"Name" : ""' \
               '"PeerURL" : "http://etcd-1.etcd-headless.default.svc.cluster.local:2380"' ''
             ;;
+          unstarted-canonical-equivalent)
+            printf '%s\n' \
+              '"ID" : 0' \
+              '"Name" : "etcd-0"' \
+              '"PeerURL" : "http://etcd-0.etcd-headless.default.svc.cluster.local:2380"' \
+              '"ClientURL" : "http://etcd-0.etcd-headless.default.svc.cluster.local:2379"' '' \
+              '"ID" : 1' \
+              '"Name" : ""' \
+              '"PeerURL" : "http://ETCD-1.ETCD-HEADLESS.DEFAULT.SVC.CLUSTER.LOCAL.:2380"' ''
+            ;;
           unstarted-target-only)
             printf '%s\n' \
               '"ID" : 1' \
@@ -272,6 +282,39 @@ Describe "Etcd Member Join Script Tests"
       The output should eq "exact"
     End
 
+    It "classifies a canonical-equivalent unstarted peer URL as registered"
+      write_fields \
+        '"ID" : 1' \
+        '"Name" : ""' \
+        '"PeerURL" : "http://ETCD-1.ETCD-HEADLESS.DEFAULT.SVC.CLUSTER.LOCAL.:2380"' ''
+      When call classify_fixture "$TEST_DIR/member-list.fields" etcd-1 \
+        http://etcd-1.etcd-headless.default.svc.cluster.local:2380
+      The status should be success
+      The output should eq "unstarted-registered"
+    End
+
+    It "classifies a canonical-equivalent started peer URL as exact"
+      write_fields \
+        '"ID" : 1' \
+        '"Name" : "etcd-1"' \
+        '"PeerURL" : "http://ETCD-1.ETCD-HEADLESS.DEFAULT.SVC.CLUSTER.LOCAL.:2380"' ''
+      When call classify_fixture "$TEST_DIR/member-list.fields" etcd-1 \
+        http://etcd-1.etcd-headless.default.svc.cluster.local:2380
+      The status should be success
+      The output should eq "exact"
+    End
+
+    It "keeps a genuinely different canonical peer URL as a name conflict"
+      write_fields \
+        '"ID" : 1' \
+        '"Name" : "etcd-1"' \
+        '"PeerURL" : "http://ETCD-OTHER.EXAMPLE.:2380"' ''
+      When call classify_fixture "$TEST_DIR/member-list.fields" etcd-1 \
+        http://etcd-1.etcd-headless.default.svc.cluster.local:2380
+      The status should be success
+      The output should eq "name-conflict"
+    End
+
     It "classifies the same name with another URL as a name conflict"
       write_fields \
         '"ID" : 1' \
@@ -617,6 +660,15 @@ Describe "Etcd Member Join Script Tests"
       The contents of file "$MEMBER_JOIN_READ_COUNT" should eq "1"
     End
 
+    It "closes canonical-equivalent unstarted replay without a second add"
+      set_member_states unstarted-canonical-equivalent
+      When call add_member
+      The status should be success
+      The error should include "registered but not started"
+      The contents of file "$MEMBER_JOIN_CALL_LOG" should eq ""
+      The contents of file "$MEMBER_JOIN_READ_COUNT" should eq "1"
+    End
+
     It "closes an exact replay even when the target is the only current contact"
       set_member_states exact-only
       When call add_member

addons/etcd/scripts/member-join.sh

@@ -32,6 +32,52 @@ classify_member_state() {
       return value
     }
 
+    function canonical_host(host, parts, count, i, result) {
+      sub(/[.]$/, "", host)
+      host = tolower(host)
+      if (host == "" || length(host) > 253) return ""
+      if (host ~ /^[0-9.]+$/) {
+        count = split(host, parts, ".")
+        if (count != 4) return ""
+        result = ""
+        for (i = 1; i <= 4; i++) {
+          if (parts[i] !~ /^[0-9]+$/ || parts[i] + 0 > 255) return ""
+          result = result (i == 1 ? "" : ".") (parts[i] + 0)
+        }
+        return result
+      }
+      count = split(host, parts, ".")
+      for (i = 1; i <= count; i++) {
+        if (length(parts[i]) < 1 || length(parts[i]) > 63 ||
+            parts[i] !~ /^[a-z0-9][a-z0-9-]*$/ || parts[i] ~ /-$/) return ""
+      }
+      return host
+    }
+
+    function canonical_peer_url(value, required_protocol, marker, rest, host, port, protocol) {
+      marker = index(value, "://")
+      if (marker == 0) return ""
+      protocol = substr(value, 1, marker - 1)
+      rest = substr(value, marker + 3)
+      if (protocol != required_protocol || rest !~ /:[0-9]+$/) return ""
+      port = rest
+      sub(/^.*:/, "", port)
+      if (port !~ /^[1-9][0-9]*$/ || port + 0 > 65535) return ""
+      host = rest
+      sub(/:[0-9]+$/, "", host)
+      host = canonical_host(host)
+      if (host == "") return ""
+      return protocol "://" host ":" port
+    }
+
+    BEGIN {
+      target_protocol = target_peer_url
+      sub(/:.*/, "", target_protocol)
+      if (target_protocol != "http" && target_protocol != "https") malformed = 1
+      canonical_target_peer_url = canonical_peer_url(target_peer_url, target_protocol)
+      if (canonical_target_peer_url == "") malformed = 1
+    }
+
     function finish_member() {
       if (!in_member) {
         return
@@ -89,13 +135,19 @@ classify_member_state() {
     }
 
     /^"PeerURL"[[:space:]]*:/ {
+      peer_url = ""
       if (!in_member ||
           $0 !~ /^"PeerURL"[[:space:]]*:[[:space:]]*"[^"]+"[[:space:]]*$/) {
         malformed = 1
         next
       }
+      peer_url = canonical_peer_url(field_value($0), target_protocol)
+      if (peer_url == "") {
+        malformed = 1
+        next
+      }
       peer_seen = 1
-      if (field_value($0) == target_peer_url) {
+      if (peer_url == canonical_target_peer_url) {
         peer_matches = 1
       }
       next