From c1ba23933cd3e7c723fe33d58173b58da80ac3bb Mon Sep 17 00:00:00 2001
From: Benjamin Roux <ben.dev@outlook.com>
Date: Thu, 19 Nov 2020 05:23:37 -0800
Subject: [PATCH] Add ABORT and COMMIT STOMP commands to the StompCommand enum
 (#10790)

Motivation:

ABORT and COMMIT commands were missing from the enum but they are part of the STOMP spec.

Modifications:

Modified the enum to add the missing commands.

Result:

ABORT and COMMIT commands can now be parsed properly and acted on.
---
 .../handler/codec/stomp/StompCommand.java     |   2 +
 .../codec/stomp/StompCommandDecodeTest.java   | 100 ++++++++++++++++++
 2 files changed, 102 insertions(+)
 create mode 100644 codec-stomp/src/test/java/io/netty/handler/codec/stomp/StompCommandDecodeTest.java

diff --git a/codec-stomp/src/main/java/io/netty/handler/codec/stomp/StompCommand.java b/codec-stomp/src/main/java/io/netty/handler/codec/stomp/StompCommand.java
index af47b1a4b8..3d8587fb8b 100644
--- a/codec-stomp/src/main/java/io/netty/handler/codec/stomp/StompCommand.java
+++ b/codec-stomp/src/main/java/io/netty/handler/codec/stomp/StompCommand.java
@@ -28,6 +28,8 @@ public enum StompCommand {
     ACK,
     NACK,
     BEGIN,
+    ABORT,
+    COMMIT,
     DISCONNECT,
     MESSAGE,
     RECEIPT,
diff --git a/codec-stomp/src/test/java/io/netty/handler/codec/stomp/StompCommandDecodeTest.java b/codec-stomp/src/test/java/io/netty/handler/codec/stomp/StompCommandDecodeTest.java
new file mode 100644
index 0000000000..9dc8830ef6
--- /dev/null
+++ b/codec-stomp/src/test/java/io/netty/handler/codec/stomp/StompCommandDecodeTest.java
@@ -0,0 +1,100 @@
+/*
+ * Copyright 2020 The Netty Project
+ *
+ * The Netty Project licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+package io.netty.handler.codec.stomp;
+
+import io.netty.buffer.ByteBuf;
+import io.netty.buffer.Unpooled;
+import io.netty.channel.embedded.EmbeddedChannel;
+import java.util.Arrays;
+import java.util.Collection;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+
+import static io.netty.util.CharsetUtil.*;
+import static org.junit.Assert.*;
+
+@RunWith(Parameterized.class)
+public class StompCommandDecodeTest {
+
+    private final String rawCommand;
+    private final StompCommand expectedCommand;
+    private final Boolean valid;
+
+    private EmbeddedChannel channel;
+
+    public StompCommandDecodeTest(String rawCommand, StompCommand expectedCommand, Boolean valid) {
+        this.rawCommand = rawCommand;
+        this.expectedCommand = expectedCommand;
+        this.valid = valid;
+    }
+
+    @Before
+    public void setUp() {
+        channel = new EmbeddedChannel(new StompSubframeDecoder(true));
+    }
+
+    @After
+    public void tearDown() {
+        assertFalse(channel.finish());
+    }
+
+    @Test
+    public void testDecodeCommand() {
+        byte[] frameContent = String.format("%s\n\n\0", rawCommand).getBytes(UTF_8);
+        ByteBuf incoming = Unpooled.wrappedBuffer(frameContent);
+        assertTrue(channel.writeInbound(incoming));
+
+        StompHeadersSubframe frame = channel.readInbound();
+
+        assertNotNull(frame);
+        assertEquals(expectedCommand, frame.command());
+
+        if (valid) {
+            assertTrue(frame.decoderResult().isSuccess());
+
+            StompContentSubframe content = channel.readInbound();
+            assertSame(LastStompContentSubframe.EMPTY_LAST_CONTENT, content);
+            content.release();
+        } else {
+            assertTrue(frame.decoderResult().isFailure());
+            assertNull(channel.readInbound());
+        }
+    }
+
+    @Parameterized.Parameters(name = "{index}: testDecodeCommand({0}) = {1}")
+    public static Collection<Object[]> stompCommands() {
+        return Arrays.asList(new Object[][] {
+                { "STOMP", StompCommand.STOMP, true },
+                { "CONNECT", StompCommand.CONNECT, true },
+                { "SEND", StompCommand.SEND, true },
+                { "SUBSCRIBE", StompCommand.SUBSCRIBE, true },
+                { "UNSUBSCRIBE", StompCommand.UNSUBSCRIBE, true },
+                { "ACK", StompCommand.ACK, true },
+                { "NACK", StompCommand.NACK, true },
+                { "BEGIN", StompCommand.BEGIN, true },
+                { "ABORT", StompCommand.ABORT, true },
+                { "COMMIT", StompCommand.COMMIT, true },
+                { "DISCONNECT", StompCommand.DISCONNECT, true },
+
+                // invalid commands
+                { "INVALID", StompCommand.UNKNOWN, false },
+                { "disconnect", StompCommand.UNKNOWN , false }
+        });
+    }
+}