From 4b20f15c9d54b6cf7a8259b70b3e480ad5d95ee8 Mon Sep 17 00:00:00 2001
From: Shigeru Yasuda <s-yasuda@da.jp.nec.com>
Date: Tue, 4 Mar 2014 20:07:04 +0900
Subject: [PATCH] Bug fix for equals(Object) in virtual node path classes.

Virtual node paths of different types should be treated as different
objects even if they have the same path components.

Change-Id: If2e6ab3cfc1436b8a14210e63284190c284957f8
Signed-off-by: Shigeru Yasuda <s-yasuda@da.jp.nec.com>
---
 .../vtn/manager/VBridgeIfPath.java            | 34 ++++++++++++++-----
 .../opendaylight/vtn/manager/VBridgePath.java | 34 ++++++++++++++-----
 .../opendaylight/vtn/manager/VTenantPath.java | 30 +++++++++++-----
 .../vtn/manager/VBridgeIfPathTest.java        | 12 ++++++-
 .../vtn/manager/VBridgePathTest.java          |  8 ++++-
 .../manager/internal/cluster/VlanMapPath.java | 26 +++++++++++---
 .../internal/cluster/VlanMapPathTest.java     | 13 ++++++-
 7 files changed, 125 insertions(+), 32 deletions(-)

diff --git a/manager/api/src/main/java/org/opendaylight/vtn/manager/VBridgeIfPath.java b/manager/api/src/main/java/org/opendaylight/vtn/manager/VBridgeIfPath.java
index 4e058529..4c75dd14 100644
--- a/manager/api/src/main/java/org/opendaylight/vtn/manager/VBridgeIfPath.java
+++ b/manager/api/src/main/java/org/opendaylight/vtn/manager/VBridgeIfPath.java
@@ -29,7 +29,7 @@ public class VBridgeIfPath extends VBridgePath {
     /**
      * Version number for serialization.
      */
-    private static final long serialVersionUID = -5494415245844633625L;
+    private static final long serialVersionUID = -4217150774548362963L;
 
     /**
      * The name of the
@@ -111,6 +111,27 @@ public class VBridgeIfPath extends VBridgePath {
         return builder;
     }
 
+    /**
+     * Determine whether all components in the given path equal to components
+     * in this object or not.
+     *
+     * @param path  An object to be compared.
+     * @return   {@code true} if all path components in {@code path} are
+     *           identical to components in this object.
+     *           Otherwise {@code false}.
+     */
+    protected final boolean equalsPath(VBridgeIfPath path) {
+        if (!equalsPath((VBridgePath)path)) {
+            return false;
+        }
+
+        if (ifName == null) {
+            return (path.ifName == null);
+        }
+
+        return ifName.equals(path.ifName);
+    }
+
     /**
      * Determine whether the given object is identical to this object.
      *
@@ -120,6 +141,8 @@ public class VBridgeIfPath extends VBridgePath {
      * <ul>
      *   <li>
      *     {@code o} is a {@code VBridgeIfPath} object.
+     *     Note that this method returns {@code false} if {@code o} is an
+     *     object of subclass of {@code VBridgeIfPath}.
      *   </li>
      *   <li>
      *     The following values stored in {@code o} are the same as in this
@@ -149,16 +172,11 @@ public class VBridgeIfPath extends VBridgePath {
         if (o == this) {
             return true;
         }
-        if (!(o instanceof VBridgeIfPath) || !super.equals(o)) {
+        if (o == null || !o.getClass().equals(VBridgeIfPath.class)) {
             return false;
         }
 
-        VBridgeIfPath path = (VBridgeIfPath)o;
-        if (ifName == null) {
-            return (path.ifName == null);
-        }
-
-        return ifName.equals(path.ifName);
+        return equalsPath((VBridgeIfPath)o);
     }
 
     /**
diff --git a/manager/api/src/main/java/org/opendaylight/vtn/manager/VBridgePath.java b/manager/api/src/main/java/org/opendaylight/vtn/manager/VBridgePath.java
index 371284d3..682fa0d4 100644
--- a/manager/api/src/main/java/org/opendaylight/vtn/manager/VBridgePath.java
+++ b/manager/api/src/main/java/org/opendaylight/vtn/manager/VBridgePath.java
@@ -27,7 +27,7 @@ public class VBridgePath extends VTenantPath {
     /**
      * Version number for serialization.
      */
-    private static final long serialVersionUID = 49188209943135523L;
+    private static final long serialVersionUID = -8958896997703009257L;
 
     /**
      * The name of the
@@ -108,6 +108,27 @@ public class VBridgePath extends VTenantPath {
         return builder;
     }
 
+    /**
+     * Determine whether all components in the given path equal to components
+     * in this object or not.
+     *
+     * @param path  An object to be compared.
+     * @return   {@code true} if all path components in {@code path} are
+     *           identical to components in this object.
+     *           Otherwise {@code false}.
+     */
+    protected final boolean equalsPath(VBridgePath path) {
+        if (!equalsPath((VTenantPath)path)) {
+            return false;
+        }
+
+        if (bridgeName == null) {
+            return (path.bridgeName == null);
+        }
+
+        return bridgeName.equals(path.bridgeName);
+    }
+
     /**
      * Determine whether the given object is identical to this object.
      *
@@ -117,6 +138,8 @@ public class VBridgePath extends VTenantPath {
      * <ul>
      *   <li>
      *     {@code o} is a {@code VBridgePath} object.
+     *     Note that this method returns {@code false} if {@code o} is an
+     *     object of subclass of {@code VBridgePath}.
      *   </li>
      *   <li>
      *     The following values stored in {@code o} are the same as in this
@@ -142,16 +165,11 @@ public class VBridgePath extends VTenantPath {
         if (o == this) {
             return true;
         }
-        if (!(o instanceof VBridgePath) || !super.equals(o)) {
+        if (o == null || !o.getClass().equals(VBridgePath.class)) {
             return false;
         }
 
-        VBridgePath path = (VBridgePath)o;
-        if (bridgeName == null) {
-            return (path.bridgeName == null);
-        }
-
-        return bridgeName.equals(path.bridgeName);
+        return equalsPath((VBridgePath)o);
     }
 
     /**
diff --git a/manager/api/src/main/java/org/opendaylight/vtn/manager/VTenantPath.java b/manager/api/src/main/java/org/opendaylight/vtn/manager/VTenantPath.java
index 1e0ea07b..9baf49b0 100644
--- a/manager/api/src/main/java/org/opendaylight/vtn/manager/VTenantPath.java
+++ b/manager/api/src/main/java/org/opendaylight/vtn/manager/VTenantPath.java
@@ -27,7 +27,7 @@ public class VTenantPath implements Serializable {
     /**
      * Version number for serialization.
      */
-    private static final long serialVersionUID = 5295435248672675596L;
+    private static final long serialVersionUID = 6666863891351658965L;
 
     /**
      * The name of the {@linkplain <a href="package-summary.html#VTN">VTN</a>}.
@@ -79,6 +79,23 @@ public class VTenantPath implements Serializable {
         return new StringBuilder(name);
     }
 
+    /**
+     * Determine whether all components in the given path equal to components
+     * in this object or not.
+     *
+     * @param path  An object to be compared.
+     * @return   {@code true} if all path components in {@code path} are
+     *           identical to components in this object.
+     *           Otherwise {@code false}.
+     */
+    protected final boolean equalsPath(VTenantPath path) {
+        if (tenantName == null) {
+            return (path.tenantName == null);
+        }
+
+        return tenantName.equals(path.tenantName);
+    }
+
     /**
      * Determine whether the given object is identical to this object.
      *
@@ -88,6 +105,8 @@ public class VTenantPath implements Serializable {
      * <ul>
      *   <li>
      *     {@code o} is a {@code VTenantPath} object.
+     *     Note that this method returns {@code false} if {@code o} is an
+     *     object of subclass of {@code VTenantPath}.
      *   </li>
      *   <li>
      *     The name of the
@@ -104,16 +123,11 @@ public class VTenantPath implements Serializable {
         if (o == this) {
             return true;
         }
-        if (!(o instanceof VTenantPath)) {
+        if (o == null || !o.getClass().equals(VTenantPath.class)) {
             return false;
         }
 
-        VTenantPath path = (VTenantPath)o;
-        if (tenantName == null) {
-            return (path.tenantName == null);
-        }
-
-        return tenantName.equals(path.tenantName);
+        return equalsPath((VTenantPath)o);
     }
 
     /**
diff --git a/manager/api/src/test/java/org/opendaylight/vtn/manager/VBridgeIfPathTest.java b/manager/api/src/test/java/org/opendaylight/vtn/manager/VBridgeIfPathTest.java
index 180f6ff7..df4cc9cb 100644
--- a/manager/api/src/test/java/org/opendaylight/vtn/manager/VBridgeIfPathTest.java
+++ b/manager/api/src/test/java/org/opendaylight/vtn/manager/VBridgeIfPathTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013 NEC Corporation
+ * Copyright (c) 2013-2014 NEC Corporation
  * All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -53,13 +53,23 @@ public class VBridgeIfPathTest extends TestBase {
         List<String> bnames = createStrings("bridge");
         List<String> inames = createStrings("ifname");
         for (String tname: tnames) {
+            VTenantPath tpath = new VTenantPath(tname);
             for (String bname: bnames) {
+                VBridgePath bpath = new VBridgePath(tname, bname);
                 for (String iname: inames) {
                     VBridgeIfPath p1 = new VBridgeIfPath(tname, bname, iname);
                     VBridgeIfPath p2 =
                         new VBridgeIfPath(copy(tname), copy(bname),
                                           copy(iname));
                     testEquals(set, p1, p2);
+
+                    // A instance of VTenantPath and VBridgePath must be
+                    // treated as different object even if it has the same
+                    // path component.
+                    assertFalse(tpath.equals(p1));
+                    assertFalse(p1.equals(tpath));
+                    assertFalse(bpath.equals(p1));
+                    assertFalse(p1.equals(bpath));
                 }
             }
         }
diff --git a/manager/api/src/test/java/org/opendaylight/vtn/manager/VBridgePathTest.java b/manager/api/src/test/java/org/opendaylight/vtn/manager/VBridgePathTest.java
index be77dd64..7112902a 100644
--- a/manager/api/src/test/java/org/opendaylight/vtn/manager/VBridgePathTest.java
+++ b/manager/api/src/test/java/org/opendaylight/vtn/manager/VBridgePathTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013 NEC Corporation
+ * Copyright (c) 2013-2014 NEC Corporation
  * All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -47,10 +47,16 @@ public class VBridgePathTest extends TestBase {
         List<String> tnames = createStrings("tenant");
         List<String> bnames = createStrings("bridge");
         for (String tname: tnames) {
+            VTenantPath tpath = new VTenantPath(tname);
             for (String bname: bnames) {
                 VBridgePath p1 = new VBridgePath(tname, bname);
                 VBridgePath p2 = new VBridgePath(copy(tname), copy(bname));
                 testEquals(set, p1, p2);
+
+                // VTenantPath object that has the same tenant name must be
+                // treated as different object.
+                assertFalse(p1.equals(tpath));
+                assertFalse(tpath.equals(p1));
             }
         }
 
diff --git a/manager/implementation/src/main/java/org/opendaylight/vtn/manager/internal/cluster/VlanMapPath.java b/manager/implementation/src/main/java/org/opendaylight/vtn/manager/internal/cluster/VlanMapPath.java
index 55a98424..69245289 100644
--- a/manager/implementation/src/main/java/org/opendaylight/vtn/manager/internal/cluster/VlanMapPath.java
+++ b/manager/implementation/src/main/java/org/opendaylight/vtn/manager/internal/cluster/VlanMapPath.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013 NEC Corporation
+ * Copyright (c) 2013-2014 NEC Corporation
  * All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -25,7 +25,7 @@ public class VlanMapPath extends VBridgePath {
     /**
      * Version number for serialization.
      */
-    private static final long serialVersionUID = 556981779172308505L;
+    private static final long serialVersionUID = -5858869883027125836L;
 
     /**
      * Identifier of the VLAN mapping.
@@ -68,6 +68,23 @@ public class VlanMapPath extends VBridgePath {
         return builder;
     }
 
+    /**
+     * Determine whether all components in the given path equal to components
+     * in this object or not.
+     *
+     * @param path  An object to be compared.
+     * @return   {@code true} if all path components in {@code path} are
+     *           identical to components in this object.
+     *           Otherwise {@code false}.
+     */
+    protected final boolean equalsPath(VlanMapPath path) {
+        if (!equalsPath((VBridgePath)path)) {
+            return false;
+        }
+
+        return mapId.equals(path.mapId);
+    }
+
     /**
      * Determine whether the given object is identical to this object.
      *
@@ -79,12 +96,11 @@ public class VlanMapPath extends VBridgePath {
         if (o == this) {
             return true;
         }
-        if (!(o instanceof VlanMapPath) || !super.equals(o)) {
+        if (o == null || !o.getClass().equals(VlanMapPath.class)) {
             return false;
         }
 
-        VlanMapPath path = (VlanMapPath)o;
-        return mapId.equals(path.mapId);
+        return equalsPath((VlanMapPath)o);
     }
 
     /**
diff --git a/manager/implementation/src/test/java/org/opendaylight/vtn/manager/internal/cluster/VlanMapPathTest.java b/manager/implementation/src/test/java/org/opendaylight/vtn/manager/internal/cluster/VlanMapPathTest.java
index 94f89750..bffb7386 100644
--- a/manager/implementation/src/test/java/org/opendaylight/vtn/manager/internal/cluster/VlanMapPathTest.java
+++ b/manager/implementation/src/test/java/org/opendaylight/vtn/manager/internal/cluster/VlanMapPathTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013 NEC Corporation
+ * Copyright (c) 2013-2014 NEC Corporation
  * All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -14,6 +14,7 @@ import java.util.List;
 
 import org.junit.Test;
 
+import org.opendaylight.vtn.manager.VTenantPath;
 import org.opendaylight.vtn.manager.VBridgePath;
 import org.opendaylight.vtn.manager.VBridgeIfPath;
 import org.opendaylight.vtn.manager.internal.TestBase;
@@ -52,6 +53,7 @@ public class VlanMapPathTest extends TestBase {
         List<String> bnames = createStrings("bridge");
         List<String> mapIds = createStrings("mapId", false);
         for (String tname: tnames) {
+            VTenantPath tpath = new VTenantPath(tname);
             for (String bname: bnames) {
                 VBridgePath bp1 = new VBridgePath(tname, bname);
                 VBridgePath bp2 = new VBridgePath(copy(tname), copy(bname));
@@ -69,6 +71,15 @@ public class VlanMapPathTest extends TestBase {
                             ifPath.equals(p1));
                     assertFalse("(p2)" + p2.toString() + ",(ifPath)" + ifPath.toString(),
                             ifPath.equals(p2));
+
+                    // A instance of VTenantPath, VBridgePath must be treated
+                    // as different object even if it has the same path
+                    // component.
+                    assertFalse(p1.equals(tpath));
+                    assertFalse(tpath.equals(p1));
+
+                    assertFalse(p1.equals(bp1));
+                    assertFalse(bp1.equals(p1));
                 }
             }
         }
-- 
2.36.6