forked from testing-cabal/subunit-go
/
subunit_test.go
263 lines (236 loc) · 9.01 KB
/
subunit_test.go
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (c) 2015 Canonical Ltd
*
* Licensed under either the Apache License, Version 2.0 or the BSD 3-clause
* license at the users choice. A copy of both licenses are available in the
* project source as Apache-2.0 and BSD. You may not use this file except in
* compliance with one of these two licences.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under these licenses is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* license you chose for the specific language governing permissions and
* limitations under that license.
*
*/
package subunit_test
import (
"bytes"
"encoding/binary"
"hash/crc32"
"strings"
"time"
"github.com/testing-cabal/subunit-go"
check "gopkg.in/check.v1"
)
var _ = check.Suite(&SubunitSuite{})
type SubunitSuite struct {
stream *subunit.StreamResultToBytes
output bytes.Buffer
}
func (s *SubunitSuite) readNumber() int {
byte1 := s.output.Next(1)[0]
// Get the first two bits, shift them to the right and add one.
size := ((byte1 & 0xc0) >> 6) + 1
// Unset the first two bits.
b1Value := uint8(byte1) & 0x3f
switch size {
case 1:
return int(b1Value)
case 2:
// Add the second byte.
return int((int16(b1Value) << 8) | int16(s.output.Next(1)[0]))
case 3:
// Add the second and third bytes.
return int(int32(b1Value)<<16 | int32(s.output.Next(1)[0])<<8 |
int32(s.output.Next(1)[0]))
case 4:
// Add the second, third and fourth bytes.
return int(int32(b1Value)<<24 | int32(s.output.Next(1)[0])<<16 |
int32(s.output.Next(1)[0])<<8 | int32(s.output.Next(1)[0]))
}
// Impossible to get here.
panic("Something wrong happened reading the number")
}
func (s *SubunitSuite) SetUpSuite(c *check.C) {
s.stream = &subunit.StreamResultToBytes{Output: &s.output}
}
func (s *SubunitSuite) SetUpTest(c *check.C) {
s.output.Reset()
}
func (s *SubunitSuite) TestPacketMustContainSignature(c *check.C) {
s.stream.Status(subunit.Event{TestID: "dummytest", Status: "dummystatus"})
signature := s.output.Next(1)[0]
c.Assert(int(signature), check.Equals, 0xb3,
check.Commentf("Wrong signature"))
}
func (s *SubunitSuite) TestPacketMustContainVersion2Flag(c *check.C) {
s.stream.Status(subunit.Event{TestID: "dummytest", Status: "dummystatus"})
s.output.Next(1) // skip the signature.
flags := s.output.Next(2)
version := flags[0] >> 4 // 4 first bits of the first byte.
c.Assert(version, check.Equals, uint8(0x2), check.Commentf("Wrong version"))
}
func (s *SubunitSuite) TestWithoutFlagsPacketMustNotSetAnyPresentFlag(c *check.C) {
s.stream.Status(subunit.Event{})
s.output.Next(1) // skip the signature
flags := s.output.Next(2)
flagsHighByte := flags[0] & 0xf // Remove the version, 4 first bits.
flagsLowByte := flags[1]
c.Check(flagsHighByte, check.Equals, uint8(0x0), check.Commentf("Wrong flags high byte"))
c.Check(flagsLowByte, check.Equals, uint8(0x0), check.Commentf("Wrong flags low byte"))
}
func (s *SubunitSuite) TestWithIDPacketMustSetPresentFlag(c *check.C) {
s.stream.Status(subunit.Event{TestID: "test-id", Status: "dummystatus"})
s.output.Next(1) // skip the signature.
flags := s.output.Next(2)
testIDPresent := flags[0] & 0x8 // bit 11.
c.Assert(testIDPresent, check.Equals, uint8(0x8),
check.Commentf("Test ID present flag is not set"))
}
var statustests = []struct {
status string
flag byte
}{
{"", 0x0},
{"undefined", 0x0},
{"exists", 0x1},
{"inprogress", 0x2},
{"success", 0x3},
{"uxsuccess", 0x4},
{"skip", 0x5},
{"fail", 0x6},
{"xfail", 0x7},
}
func (s *SubunitSuite) TestPacketStatusFlag(c *check.C) {
for _, t := range statustests {
s.output.Reset()
s.stream.Status(subunit.Event{TestID: "dummytest", Status: t.status})
s.output.Next(1) // skip the signature.
flags := s.output.Next(2)
testStatus := flags[1] & 0x7 // Last three bits of the second byte.
c.Check(testStatus, check.Equals, t.flag,
check.Commentf("Wrong status for %s", t.status))
}
}
func (s *SubunitSuite) TestPacketLength(c *check.C) {
s.stream.Status(subunit.Event{TestID: "", Status: "dummystatus"})
s.output.Next(3) // skip the signature (1 byte) and the flags (2 bytes)
length := s.output.Next(1)[0]
// signature (1 byte) + flags (2 bytes) + length (2 bytes) + CRC32 (4 bytes)
var expectedLength byte = 8
c.Assert(length, check.Equals, expectedLength, check.Commentf("Wrong length"))
}
func (s *SubunitSuite) TestPacketCRC32(c *check.C) {
s.stream.Status(subunit.Event{TestID: "", Status: ""})
// skip the signature (1 byte), the flags (2 bytes) and the length (1 byte)
s.output.Next(4)
crc := s.output.Next(4)
expectedCRC32 := make([]byte, 4)
binary.BigEndian.PutUint32(expectedCRC32,
// signature = 0xb3
// flags with only version = 0x20 0x0
// size = 0x8
crc32.ChecksumIEEE([]byte{0xb3, 0x20, 0x0, 0x8}))
c.Assert(crc, check.DeepEquals, expectedCRC32, check.Commentf("Wrong CRC32"))
// Check against a CRC generated with python's subunit.
c.Assert(crc, check.DeepEquals, []byte{0x18, 0x15, 0xf0, 0xba},
check.Commentf("Wrong CRC32"))
}
var idtests = []struct {
testIDPrefix string
testIDLen int
packetLenSize int // The number of bytes in the packet length.
}{
{"test-id (1 byte)", 16, 1},
{"test-id-with-63-chars (1 byte)", 63, 2},
{"test-id-with-64-chars (2 bytes)", 64, 2},
{"test-id-with-16383-chars (2 bytes)", 16383, 3},
{"test-id-with-16384-chars (3 bytes)", 16384, 3},
// The size limit of the packet is 4194303. This is the biggest name possible.
{"test-id-with-4194290-chars (3 bytes)", 4194290, 3},
}
func (s *SubunitSuite) TestPacketTestID(c *check.C) {
for _, t := range idtests {
s.output.Reset()
testID := t.testIDPrefix + strings.Repeat("_", t.testIDLen-len(t.testIDPrefix))
s.stream.Status(subunit.Event{TestID: testID, Status: ""})
// skip the signature (1 byte) and the flags (2 bytes)
s.output.Next(3)
// skip the packet length (variable size)
s.readNumber()
idLen := s.readNumber()
c.Check(idLen, check.Equals, len(testID), check.Commentf("Wrong length"))
id := string(s.output.Next(idLen))
c.Check(id, check.Equals, testID, check.Commentf("Wrong ID"))
}
}
func (s *SubunitSuite) TestWithTimestampPacketMustSetPresentFlag(c *check.C) {
s.stream.Status(subunit.Event{Timestamp: time.Now()})
s.output.Next(1) // skip the signature.
flags := s.output.Next(2)
testIDPresent := flags[0] & 0x2 // bit 9.
c.Assert(testIDPresent, check.Equals, uint8(0x2),
check.Commentf("Timestamp present flag is not set"))
}
func (s *SubunitSuite) TestPacketTimestamp(c *check.C) {
t := time.Now()
s.stream.Status(subunit.Event{Timestamp: t})
// skip the signature (1 byte) and the flags (2 bytes)
s.output.Next(3)
// skip the packet length (variable size)
s.readNumber()
var sec uint32
secondsBytes := s.output.Next(4)
err := binary.Read(bytes.NewReader(secondsBytes), binary.BigEndian, &sec)
c.Assert(err, check.IsNil, check.Commentf("Error reading the timestamp seconds: %s", err))
nsec := s.readNumber()
timestamp := time.Unix(int64(sec), int64(nsec))
c.Assert(timestamp, check.Equals, t, check.Commentf("Wrong timestamp"))
}
func (s *SubunitSuite) TestWithMIMEPacketMustSetPresentFlag(c *check.C) {
s.stream.Status(subunit.Event{MIME: "dummy"})
s.output.Next(1) // skip the signature.
flags := s.output.Next(2)
mimePresent := flags[1] & 0x20 // bit 5.
c.Assert(mimePresent, check.Equals, uint8(0x20),
check.Commentf("MIME present flag not set."))
}
func (s *SubunitSuite) TestPacketMIME(c *check.C) {
testMIME := "text/plain;charset=utf8"
s.stream.Status(subunit.Event{MIME: testMIME})
// skip the signature (1 byte) and the flags (2 bytes)
s.output.Next(3)
// skip the packet length (variable size)
s.readNumber()
idLen := s.readNumber()
c.Check(idLen, check.Equals, len(testMIME), check.Commentf("Wrong length"))
mime := string(s.output.Next(idLen))
c.Check(mime, check.Equals, testMIME, check.Commentf("Wrong ID"))
}
func (s *SubunitSuite) TestWithFileContentPacketMustSetPresentFlag(c *check.C) {
s.stream.Status(subunit.Event{FileName: "dummy"})
s.output.Next(1) // skip the signature.
flags := s.output.Next(2)
mimePresent := flags[1] & 0x40 // bit 6.
c.Assert(mimePresent, check.Equals, uint8(0x40),
check.Commentf("File content present flag not set."))
}
func (s *SubunitSuite) TestFileContents(c *check.C) {
testFileName := "testfilename"
testFileBytes := []byte{0x1, 0xb, 0xf0}
s.stream.Status(subunit.Event{FileName: testFileName, FileBytes: testFileBytes})
// skip the signature (1 byte) and the flags (2 bytes)
s.output.Next(3)
// skip the packet length (variable size)
s.readNumber()
fileNameLen := s.readNumber()
c.Check(fileNameLen, check.Equals, len(testFileName), check.Commentf("Wrong file name length"))
fileName := string(s.output.Next(fileNameLen))
c.Check(fileName, check.Equals, testFileName, check.Commentf("Wrong file name"))
contentLen := s.readNumber()
c.Check(contentLen, check.Equals, len(testFileBytes), check.Commentf("Wrong content length"))
content := s.output.Next(contentLen)
c.Check(content, check.DeepEquals, testFileBytes, check.Commentf("Wrong content"))
}