aboutsummaryrefslogtreecommitdiffstats
path: root/sources/hv-collector-core/src/test/kotlin/org/onap/dcae/collectors/veshv/impl/wire/WireChunkDecoderTest.kt
blob: f06a0dc7933d21bc97adb96f841dfad1d2da6545 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/*
 * ============LICENSE_START=======================================================
 * dcaegen2-collectors-veshv
 * ================================================================================
 * Copyright (C) 2018 NOKIA
 * ================================================================================
 * Licensed 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
 *
 *      http://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.
 * ============LICENSE_END=========================================================
 */
package org.onap.dcae.collectors.veshv.impl.wire

import io.netty.buffer.ByteBuf
import io.netty.buffer.Unpooled
import io.netty.buffer.UnpooledByteBufAllocator
import org.assertj.core.api.Assertions.assertThat
import org.jetbrains.spek.api.Spek
import org.jetbrains.spek.api.dsl.describe
import org.jetbrains.spek.api.dsl.given
import org.jetbrains.spek.api.dsl.it
import org.onap.dcae.collectors.veshv.domain.WireFrameEncoder
import org.onap.dcae.collectors.veshv.domain.WireFrameDecoder
import org.onap.dcae.collectors.veshv.domain.WireFrameMessage
import reactor.test.test

/**
 * @author Piotr Jaszczyk <piotr.jaszczyk></piotr.jaszczyk>@nokia.com>
 * @since May 2018
 */
internal object WireChunkDecoderTest : Spek({
    val alloc = UnpooledByteBufAllocator.DEFAULT
    val samplePayload = "konstantynopolitanczykowianeczka".toByteArray()
    val anotherPayload = "ala ma kota a kot ma ale".toByteArray()

    val encoder = WireFrameEncoder(alloc)

    fun WireChunkDecoder.decode(frame: WireFrameMessage) = decode(encoder.encode(frame))

    fun createInstance() = WireChunkDecoder(WireFrameDecoder(WireFrameMessage.DEFAULT_MAX_PAYLOAD_SIZE_BYTES), alloc)

    fun verifyMemoryReleased(vararg byteBuffers: ByteBuf) {
        for (bb in byteBuffers) {
            assertThat(bb.refCnt())
                    .describedAs("should be released: $bb ref count")
                    .isEqualTo(0)
        }
    }

    fun verifyMemoryNotReleased(vararg byteBuffers: ByteBuf) {
        for (bb in byteBuffers) {
            assertThat(bb.refCnt())
                    .describedAs("should not be released: $bb ref count")
                    .isEqualTo(1)
        }
    }

    describe("decoding wire protocol") {
        given("empty input") {
            val input = Unpooled.EMPTY_BUFFER

            it("should yield empty result") {
                createInstance().decode(input).test().verifyComplete()
            }
        }

        given("input with no readable bytes") {
            val input = Unpooled.wrappedBuffer(byteArrayOf(0x00)).readerIndex(1)

            it("should yield empty result") {
                createInstance().decode(input).test().verifyComplete()
            }

            it("should release memory") {
                verifyMemoryReleased(input)
            }
        }

        given("invalid input (not starting with marker)") {
            val input = Unpooled.wrappedBuffer(samplePayload)

            it("should yield error") {
                createInstance().decode(input).test()
                        .verifyError(WireFrameException::class.java)
            }

            it("should leave memory unreleased") {
                verifyMemoryNotReleased(input)
            }
        }

        given("valid input") {
            val input = WireFrameMessage(samplePayload)

            it("should yield decoded input frame") {
                createInstance().decode(input).test()
                        .expectNextMatches { it.payloadSize == samplePayload.size }
                        .verifyComplete()
            }
        }

        given("valid input with part of next frame") {
            val input = Unpooled.buffer()
                    .writeBytes(encoder.encode(WireFrameMessage(samplePayload)))
                    .writeBytes(encoder.encode(WireFrameMessage(samplePayload)).slice(0, 3))

            it("should yield decoded input frame") {
                createInstance().decode(input).test()
                        .expectNextMatches { it.payloadSize == samplePayload.size }
                        .verifyComplete()
            }

            it("should leave memory unreleased") {
                verifyMemoryNotReleased(input)
            }
        }

        given("valid input with garbage after it") {
            val input = Unpooled.buffer()
                    .writeBytes(encoder.encode(WireFrameMessage(samplePayload)))
                    .writeBytes(Unpooled.wrappedBuffer(samplePayload))

            it("should yield decoded input frame and error") {
                createInstance().decode(input).test()
                        .expectNextMatches { it.payloadSize == samplePayload.size }
                        .verifyError(WireFrameException::class.java)
            }

            it("should leave memory unreleased") {
                verifyMemoryNotReleased(input)
            }
        }

        given("two inputs containing two separate messages") {
            val input1 = encoder.encode(WireFrameMessage(samplePayload))
            val input2 = encoder.encode(WireFrameMessage(anotherPayload))

            it("should yield decoded input frames") {
                val cut = createInstance()
                cut.decode(input1).test()
                        .expectNextMatches { it.payloadSize == samplePayload.size }
                        .verifyComplete()
                cut.decode(input2).test()
                        .expectNextMatches { it.payloadSize == anotherPayload.size }
                        .verifyComplete()
            }

            it("should release memory") {
                verifyMemoryReleased(input1, input2)
            }
        }

        given("1st input containing 1st frame and 2nd input containing garbage") {
            val input1 = encoder.encode(WireFrameMessage(samplePayload))
            val input2 = Unpooled.wrappedBuffer(anotherPayload)

            it("should yield decoded input frames") {
                val cut = createInstance()
                cut.decode(input1)
                        .test()
                        .expectNextMatches { it.payloadSize == samplePayload.size }
                        .verifyComplete()
                cut.decode(input2).test()
                        .verifyError(WireFrameException::class.java)
            }

            it("should release memory for 1st input") {
                verifyMemoryReleased(input1)
            }

            it("should leave memory unreleased for 2nd input") {
                verifyMemoryNotReleased(input2)
            }
        }


        given("1st input containing 1st frame + part of 2nd frame and 2nd input containing rest of 2nd frame") {
            val frame1 = encoder.encode(WireFrameMessage(samplePayload))
            val frame2 = encoder.encode(WireFrameMessage(anotherPayload))

            val input1 = Unpooled.buffer()
                    .writeBytes(frame1)
                    .writeBytes(frame2, 3)
            val input2 = Unpooled.buffer().writeBytes(frame2)

            it("should yield decoded input frames") {
                val cut = createInstance()
                cut.decode(input1).test()
                        .expectNextMatches { it.payloadSize == samplePayload.size }
                        .verifyComplete()
                cut.decode(input2).test()
                        .expectNextMatches { it.payloadSize == anotherPayload.size }
                        .verifyComplete()
            }

            it("should release memory") {
                verifyMemoryReleased(input1, input2)
            }
        }

        given("1st input containing part of 1st frame and 2nd input containing rest of 1st + 2nd frame") {
            val frame1 = encoder.encode(WireFrameMessage(samplePayload))
            val frame2 = encoder.encode(WireFrameMessage(anotherPayload))

            val input1 = Unpooled.buffer()
                    .writeBytes(frame1, 5)
            val input2 = Unpooled.buffer()
                    .writeBytes(frame1)
                    .writeBytes(frame2)

            it("should yield decoded input frames") {
                val cut = createInstance()
                cut.decode(input1).test()
                        .verifyComplete()
                cut.decode(input2).test()
                        .expectNextMatches { it.payloadSize == samplePayload.size }
                        .expectNextMatches { it.payloadSize == anotherPayload.size }
                        .verifyComplete()
            }

            it("should release memory") {
                verifyMemoryReleased(input1, input2)
            }
        }
    }
})