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
|
// Copyright (C) 2019-2024 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
package network
import (
"encoding/binary"
"fmt"
"testing"
"github.com/algorand/go-algorand/test/partitiontest"
"github.com/stretchr/testify/require"
)
// Test the marshall/unmarshall of Topics
func TestTopics(t *testing.T) {
partitiontest.PartitionTest(t)
topics := Topics{
Topic{
key: "key1",
data: []byte("value 1"),
},
Topic{
key: "Key2",
data: []byte("value of key2"),
},
}
// Check if the topics were initialized correctly
require.Equal(t, 2, len(topics))
require.Equal(t, "key1", topics[0].key)
require.Equal(t, "value 1", string(topics[0].data))
require.Equal(t, "Key2", topics[1].key)
val, found := topics.GetValue("Key2")
require.Equal(t, true, found)
require.Equal(t, "value of key2", string(val))
// Check if can be marshalled without errors
buffer := topics.MarshallTopics()
// Check if can be unmarshalled without errors
unMarshalled, e := UnmarshallTopics(buffer)
require.Empty(t, e)
// Check if the unmarshalled is equal to the original
require.Equal(t, len(topics), len(unMarshalled))
require.Equal(t, topics[0].key, unMarshalled[0].key)
require.Equal(t, topics[0].data, unMarshalled[0].data)
require.Equal(t, topics[1].key, unMarshalled[1].key)
require.Equal(t, topics[1].data, unMarshalled[1].data)
}
// TestCurruptedTopics checks the errors
// Makes sure UnmarshallTopics will not attempt to read beyond the buffer limits
func TestCurruptedTopics(t *testing.T) {
partitiontest.PartitionTest(t)
var buffer []byte
// empty buffer
buffer = make([]byte, 0)
_, err := UnmarshallTopics(buffer)
require.Equal(t, err, fmt.Errorf("UnmarshallTopics: could not read the number of topics"))
// more than 32 topics
buffer = make([]byte, binary.MaxVarintLen32)
binary.PutUvarint(buffer, 33)
_, err = UnmarshallTopics(buffer)
require.Equal(t, err, fmt.Errorf("UnmarshallTopics: number of topics %d is greater than 32", 33))
// no room for the key length
buffer = make([]byte, 1)
binary.PutUvarint(buffer, 1)
_, err = UnmarshallTopics(buffer)
require.Equal(t, err, fmt.Errorf("UnmarshallTopics: could not read the key length"))
// key length > buffer size
buffer = make([]byte, 2)
binary.PutUvarint(buffer, 1)
binary.PutUvarint(buffer[1:], 5)
_, err = UnmarshallTopics(buffer)
require.Equal(t, err, fmt.Errorf("UnmarshallTopics: could not read the key"))
// key length > buffer size 64
buffer = make([]byte, 100)
binary.PutUvarint(buffer, 1)
binary.PutUvarint(buffer[1:], 65)
_, err = UnmarshallTopics(buffer)
require.Equal(t, err, fmt.Errorf("UnmarshallTopics: could not read the key"))
// no room for the data length
buffer = make([]byte, 3)
binary.PutUvarint(buffer, 1) // 1 topic
binary.PutUvarint(buffer[1:], 1) // 1 char key
_, err = UnmarshallTopics(buffer)
require.Equal(t, err, fmt.Errorf("UnmarshallTopics: could not read the data length"))
// datalen > buffer size
buffer = make([]byte, 5)
binary.PutUvarint(buffer, 1) // 1 topic
binary.PutUvarint(buffer[1:], 1) // 1 char key
// buffer size is 5. Room for 1 byte data.
// [/*topics:*/1, /*key len:*/ 1, /*key:*/ 0, /*data len:*/ 2, /*1 byte space for data*/ 0]
// 2 byte data size should error
binary.PutUvarint(buffer[3:], 2)
_, err = UnmarshallTopics(buffer)
require.Equal(t, err, fmt.Errorf("UnmarshallTopics: data larger than buffer size"))
}
|
