GEODE-4084 rename handshake.proto (apache#1155)

renamed to protocolVersion
ringles · Dec 15, 2017 · 9ca4314 · 9ca4314
1 parent eff77bb
commit 9ca4314
Show file tree

Hide file tree

Showing 11 changed files with 180 additions and 197 deletions.
diff --git a/...f-messages/src/main/proto/handshake.proto → ...ages/src/main/proto/protocolVersion.proto b/...f-messages/src/main/proto/handshake.proto → ...ages/src/main/proto/protocolVersion.proto
@@ -25,13 +25,13 @@ enum MinorVersions {
     CURRENT_MINOR_VERSION = 1;  // Protobuf implementation at initial release
 }
 
-message NewConnectionHandshake {
+message NewConnectionClientVersion {
     fixed32 majorVersion = 1;
     fixed32 minorVersion = 2;
 }
 
-message HandshakeAcknowledgement {
+message VersionAcknowledgement {
     int32 serverMajorVersion = 1;
     int32 serverMinorVersion = 2;
-    bool handshakePassed = 3;
+    bool versionAccepted = 3;
 }
diff --git a/...src/main/java/org/apache/geode/internal/protocol/protobuf/v1/ProtobufLocatorPipeline.java b/...src/main/java/org/apache/geode/internal/protocol/protobuf/v1/ProtobufLocatorPipeline.java
@@ -26,7 +26,7 @@
 import org.apache.geode.internal.cache.client.protocol.ClientProtocolProcessor;
 import org.apache.geode.internal.cache.tier.CommunicationMode;
 import org.apache.geode.internal.protocol.MessageExecutionContext;
-import org.apache.geode.internal.protocol.protobuf.Handshake;
+import org.apache.geode.internal.protocol.protobuf.ProtocolVersion;
 import org.apache.geode.internal.protocol.protobuf.v1.operations.VersionValidator;
 import org.apache.geode.internal.protocol.state.ConnectionStateProcessor;
 import org.apache.geode.internal.protocol.state.NoSecurityConnectionStateProcessor;
@@ -75,8 +75,8 @@ private void handleHandshakeMessage(InputStream inputStream) throws IOException
     PushbackInputStream handshakeStream = new PushbackInputStream(inputStream);
     handshakeStream.unread(CommunicationMode.ProtobufClientServerProtocol.getModeNumber());
 
-    Handshake.NewConnectionHandshake handshakeRequest =
-        Handshake.NewConnectionHandshake.parseDelimitedFrom(handshakeStream);
+    ProtocolVersion.NewConnectionClientVersion handshakeRequest =
+        ProtocolVersion.NewConnectionClientVersion.parseDelimitedFrom(handshakeStream);
     int majorVersion = handshakeRequest.getMajorVersion();
     int minorVersion = handshakeRequest.getMinorVersion();
     if (!validator.isValid(majorVersion, minorVersion)) {

diff --git a/...src/main/java/org/apache/geode/internal/protocol/protobuf/v1/ProtobufProtocolService.java b/...src/main/java/org/apache/geode/internal/protocol/protobuf/v1/ProtobufProtocolService.java
@@ -19,7 +19,7 @@
 import org.apache.geode.distributed.internal.InternalLocator;
 import org.apache.geode.internal.cache.client.protocol.ClientProtocolProcessor;
 import org.apache.geode.internal.cache.client.protocol.ClientProtocolService;
-import org.apache.geode.internal.protocol.protobuf.Handshake;
+import org.apache.geode.internal.protocol.protobuf.ProtocolVersion;
 import org.apache.geode.internal.protocol.protobuf.statistics.ProtobufClientStatisticsImpl;
 import org.apache.geode.internal.protocol.statistics.NoOpStatistics;
 import org.apache.geode.internal.protocol.statistics.ProtocolClientStatistics;
@@ -63,6 +63,6 @@ public ClientProtocolProcessor createProcessorForLocator(InternalLocator locator
 
   @Override
   public int getServiceProtocolVersion() {
-    return Handshake.MajorVersions.CURRENT_MAJOR_VERSION_VALUE;
+    return ProtocolVersion.MajorVersions.CURRENT_MAJOR_VERSION_VALUE;
   }
 }
diff --git a/...tobuf/v1/operations/HandshakeHandler.java → ...v1/operations/ProtocolVersionHandler.java b/...tobuf/v1/operations/HandshakeHandler.java → ...v1/operations/ProtocolVersionHandler.java
@@ -21,34 +21,35 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
-import org.apache.geode.internal.protocol.protobuf.Handshake;
+import org.apache.geode.internal.protocol.protobuf.ProtocolVersion;
 import org.apache.geode.internal.protocol.statistics.ProtocolClientStatistics;
 
-public class HandshakeHandler {
+public class ProtocolVersionHandler {
   private static final Logger logger = LogManager.getLogger();
   private static final VersionValidator validator = new VersionValidator();
 
-  public static boolean handleHandshake(InputStream inputStream, OutputStream outputStream,
+  public static boolean handleVersionMessage(InputStream inputStream, OutputStream outputStream,
       ProtocolClientStatistics statistics) throws IOException {
-    Handshake.NewConnectionHandshake handshakeRequest =
-        Handshake.NewConnectionHandshake.parseDelimitedFrom(inputStream);
+    ProtocolVersion.NewConnectionClientVersion versionMessage =
+        ProtocolVersion.NewConnectionClientVersion.parseDelimitedFrom(inputStream);
 
-    statistics.messageReceived(handshakeRequest.getSerializedSize());
+    statistics.messageReceived(versionMessage.getSerializedSize());
 
-    final boolean handshakeSucceeded =
-        validator.isValid(handshakeRequest.getMajorVersion(), handshakeRequest.getMinorVersion());
+    final boolean versionAccepted =
+        validator.isValid(versionMessage.getMajorVersion(), versionMessage.getMinorVersion());
 
-    Handshake.HandshakeAcknowledgement handshakeResponse = Handshake.HandshakeAcknowledgement
-        .newBuilder().setServerMajorVersion(Handshake.MajorVersions.CURRENT_MAJOR_VERSION_VALUE)
-        .setServerMinorVersion(Handshake.MinorVersions.CURRENT_MINOR_VERSION_VALUE)
-        .setHandshakePassed(handshakeSucceeded).build();
+    ProtocolVersion.VersionAcknowledgement handshakeResponse =
+        ProtocolVersion.VersionAcknowledgement.newBuilder()
+            .setServerMajorVersion(ProtocolVersion.MajorVersions.CURRENT_MAJOR_VERSION_VALUE)
+            .setServerMinorVersion(ProtocolVersion.MinorVersions.CURRENT_MINOR_VERSION_VALUE)
+            .setVersionAccepted(versionAccepted).build();
 
     handshakeResponse.writeDelimitedTo(outputStream);
     statistics.messageSent(handshakeResponse.getSerializedSize());
-    if (!handshakeSucceeded) {
+    if (!versionAccepted) {
       throw new IOException("Incompatible protobuf version.");
     }
 
-    return handshakeSucceeded;
+    return versionAccepted;
   }
 }
diff --git a/...main/java/org/apache/geode/internal/protocol/protobuf/v1/operations/VersionValidator.java b/...main/java/org/apache/geode/internal/protocol/protobuf/v1/operations/VersionValidator.java
@@ -14,15 +14,15 @@
  */
 package org.apache.geode.internal.protocol.protobuf.v1.operations;
 
-import org.apache.geode.internal.protocol.protobuf.Handshake;
+import org.apache.geode.internal.protocol.protobuf.ProtocolVersion;
 
 public class VersionValidator {
   private int majorVersion;
   private int minorVersion;
 
   public VersionValidator() {
-    this(Handshake.MajorVersions.CURRENT_MAJOR_VERSION_VALUE,
-        Handshake.MinorVersions.CURRENT_MINOR_VERSION_VALUE);
+    this(ProtocolVersion.MajorVersions.CURRENT_MAJOR_VERSION_VALUE,
+        ProtocolVersion.MinorVersions.CURRENT_MINOR_VERSION_VALUE);
   }
 
   VersionValidator(int majorVersion, int minorVersion) {
@@ -31,9 +31,9 @@ public VersionValidator() {
   }
 
   public boolean isValid(int majorVersion, int minorVersion) {
-    if (majorVersion != Handshake.MajorVersions.INVALID_MAJOR_VERSION_VALUE
+    if (majorVersion != ProtocolVersion.MajorVersions.INVALID_MAJOR_VERSION_VALUE
         && majorVersion == this.majorVersion) {
-      if (minorVersion != Handshake.MinorVersions.INVALID_MINOR_VERSION_VALUE
+      if (minorVersion != ProtocolVersion.MinorVersions.INVALID_MINOR_VERSION_VALUE
           && minorVersion <= this.minorVersion) {
         return true;
       }

diff --git a/.../geode/internal/protocol/protobuf/v1/state/ProtobufConnectionHandshakeStateProcessor.java b/.../geode/internal/protocol/protobuf/v1/state/ProtobufConnectionHandshakeStateProcessor.java
@@ -23,7 +23,7 @@
 import org.apache.geode.internal.protocol.MessageExecutionContext;
 import org.apache.geode.internal.protocol.OperationContext;
 import org.apache.geode.internal.protocol.ProtocolErrorCode;
-import org.apache.geode.internal.protocol.protobuf.v1.operations.HandshakeHandler;
+import org.apache.geode.internal.protocol.protobuf.v1.operations.ProtocolVersionHandler;
 import org.apache.geode.internal.protocol.state.ConnectionStateProcessor;
 import org.apache.geode.internal.protocol.state.LegacySecurityConnectionStateProcessor;
 import org.apache.geode.internal.protocol.state.NoSecurityConnectionStateProcessor;
@@ -64,7 +64,7 @@ public boolean handleMessageIndependently(InputStream inputStream, OutputStream
     PushbackInputStream messageStream = new PushbackInputStream(inputStream);
     messageStream.unread(CommunicationMode.ProtobufClientServerProtocol.getModeNumber());
 
-    if (HandshakeHandler.handleHandshake(messageStream, outputStream,
+    if (ProtocolVersionHandler.handleVersionMessage(messageStream, outputStream,
         executionContext.getStatistics())) {
       executionContext.setConnectionStateProcessor(nextConnectionState());
     }

diff --git a/geode-protobuf/src/test/java/org/apache/geode/internal/protocol/protobuf/v1/MessageUtil.java b/geode-protobuf/src/test/java/org/apache/geode/internal/protocol/protobuf/v1/MessageUtil.java
@@ -23,7 +23,7 @@
 
 import com.google.protobuf.MessageLite;
 
-import org.apache.geode.internal.protocol.protobuf.Handshake;
+import org.apache.geode.internal.protocol.protobuf.ProtocolVersion;
 import org.apache.geode.internal.protocol.protobuf.v1.utilities.ProtobufRequestUtilities;
 import org.apache.geode.internal.protocol.protobuf.v1.utilities.ProtobufUtilities;
 import org.apache.geode.internal.protocol.serialization.SerializationService;
@@ -38,15 +38,15 @@ public static void performAndVerifyHandshake(Socket socket) throws IOException {
   }
 
   public static void verifyHandshakeSuccess(Socket socket) throws IOException {
-    Handshake.HandshakeAcknowledgement handshakeResponse =
-        Handshake.HandshakeAcknowledgement.parseDelimitedFrom(socket.getInputStream());
-    assertTrue(handshakeResponse.getHandshakePassed());
+    ProtocolVersion.VersionAcknowledgement handshakeResponse =
+        ProtocolVersion.VersionAcknowledgement.parseDelimitedFrom(socket.getInputStream());
+    assertTrue(handshakeResponse.getVersionAccepted());
   }
 
   public static void sendHandshake(Socket socket) throws IOException {
-    Handshake.NewConnectionHandshake.newBuilder()
-        .setMajorVersion(Handshake.MajorVersions.CURRENT_MAJOR_VERSION_VALUE)
-        .setMinorVersion(Handshake.MinorVersions.CURRENT_MINOR_VERSION_VALUE).build()
+    ProtocolVersion.NewConnectionClientVersion.newBuilder()
+        .setMajorVersion(ProtocolVersion.MajorVersions.CURRENT_MAJOR_VERSION_VALUE)
+        .setMinorVersion(ProtocolVersion.MinorVersions.CURRENT_MINOR_VERSION_VALUE).build()
         .writeDelimitedTo(socket.getOutputStream());
   }
 

diff --git a/...protobuf/v1/HandshakeIntegrationTest.java → ...uf/v1/ProtocolVersionIntegrationTest.java b/...protobuf/v1/HandshakeIntegrationTest.java → ...uf/v1/ProtocolVersionIntegrationTest.java
@@ -18,7 +18,6 @@
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
-import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -41,15 +40,12 @@
 import org.apache.geode.cache.server.CacheServer;
 import org.apache.geode.distributed.ConfigurationProperties;
 import org.apache.geode.internal.AvailablePortHelper;
-import org.apache.geode.internal.cache.CacheServerImpl;
-import org.apache.geode.internal.cache.InternalCache;
-import org.apache.geode.internal.cache.tier.CommunicationMode;
-import org.apache.geode.internal.protocol.protobuf.Handshake;
+import org.apache.geode.internal.protocol.protobuf.ProtocolVersion;
 import org.apache.geode.internal.protocol.protobuf.v1.serializer.ProtobufProtocolSerializer;
 import org.apache.geode.test.junit.categories.IntegrationTest;
 
 @Category(IntegrationTest.class)
-public class HandshakeIntegrationTest {
+public class ProtocolVersionIntegrationTest {
   private Cache cache;
 
   @Rule
@@ -104,13 +100,13 @@ public void testNormalHandshakeSucceeds() throws Exception {
 
   @Test
   public void testInvalidMajorVersionBreaksConnection() throws Exception {
-    Handshake.NewConnectionHandshake.newBuilder().setMajorVersion(2000)
-        .setMinorVersion(Handshake.MinorVersions.CURRENT_MINOR_VERSION_VALUE).build()
+    ProtocolVersion.NewConnectionClientVersion.newBuilder().setMajorVersion(2000)
+        .setMinorVersion(ProtocolVersion.MinorVersions.CURRENT_MINOR_VERSION_VALUE).build()
         .writeDelimitedTo(socket.getOutputStream());
 
-    Handshake.HandshakeAcknowledgement handshakeResponse =
-        Handshake.HandshakeAcknowledgement.parseDelimitedFrom(socket.getInputStream());
-    assertFalse(handshakeResponse.getHandshakePassed());
+    ProtocolVersion.VersionAcknowledgement handshakeResponse =
+        ProtocolVersion.VersionAcknowledgement.parseDelimitedFrom(socket.getInputStream());
+    assertFalse(handshakeResponse.getVersionAccepted());
 
     // Verify that connection is closed
     Awaitility.await().atMost(10, TimeUnit.SECONDS).until(() -> {
@@ -129,9 +125,9 @@ public void testInvalidMajorVersionBreaksConnection() throws Exception {
    */
   @Test
   public void testMissingMajorVersionBreaksConnection() throws Exception {
-    Handshake.NewConnectionHandshake.newBuilder()
-        .setMajorVersion(Handshake.MajorVersions.CURRENT_MAJOR_VERSION_VALUE).setMinorVersion(0)
-        .build().writeDelimitedTo(socket.getOutputStream());
+    ProtocolVersion.NewConnectionClientVersion.newBuilder()
+        .setMajorVersion(ProtocolVersion.MajorVersions.CURRENT_MAJOR_VERSION_VALUE)
+        .setMinorVersion(0).build().writeDelimitedTo(socket.getOutputStream());
 
     // Verify that connection is closed
     Awaitility.await().atMost(10, TimeUnit.SECONDS).until(() -> {

diff --git a/.../org/apache/geode/internal/protocol/protobuf/v1/operations/HandshakeHandlerJUnitTest.java b/.../org/apache/geode/internal/protocol/protobuf/v1/operations/HandshakeHandlerJUnitTest.java