File: Codable%2BByteBufferTest.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (222 lines) | stat: -rw-r--r-- 10,952 bytes parent folder | download
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2019 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

import Foundation
import XCTest
import NIO
import NIOFoundationCompat

class CodableByteBufferTest: XCTestCase {
    var buffer: ByteBuffer!
    var allocator: ByteBufferAllocator!
    var decoder: JSONDecoder!
    var encoder: JSONEncoder!

    override func setUp() {
        self.allocator = ByteBufferAllocator()
        self.buffer = self.allocator.buffer(capacity: 1024)
        self.buffer.writeString(String(repeating: "A", count: 1024))
        self.buffer.moveReaderIndex(to: 129)
        self.buffer.moveWriterIndex(to: 129)
        self.decoder = JSONDecoder()
        self.encoder = JSONEncoder()
    }

    override func tearDown() {
        self.encoder = nil
        self.decoder = nil
        self.buffer = nil
        self.allocator = nil
    }

    func testSimpleDecode() {
        self.buffer.writeString(#"{"string": "hello", "int": 42}"#)
        var sAndI: StringAndInt?
        XCTAssertNoThrow(sAndI = try self.decoder.decode(StringAndInt.self, from: self.buffer))
        XCTAssertEqual(StringAndInt(string: "hello", int: 42), sAndI)
    }

    func testSimpleEncodeIntoBuffer() {
        let expectedSandI = StringAndInt(string: "hello", int: 42)
        XCTAssertNoThrow(try self.encoder.encode(expectedSandI, into: &self.buffer))
        XCTAssertNoThrow(XCTAssertEqual(expectedSandI, try self.decoder.decode(StringAndInt.self, from: self.buffer)))
    }

    func testSimpleEncodeToFreshByteBuffer() {
        let expectedSandI = StringAndInt(string: "hello", int: 42)
        var buffer = self.allocator.buffer(capacity: 0)
        XCTAssertNoThrow(buffer = try self.encoder.encodeAsByteBuffer(expectedSandI, allocator: self.allocator))
        XCTAssertNoThrow(XCTAssertEqual(expectedSandI, try self.decoder.decode(StringAndInt.self, from: buffer)))
    }

    func testGetJSONDecodableFromBufferWorks() {
        self.buffer.writeString("GARBAGE {}!!? / GARBAGE")
        let beginIndex = self.buffer.writerIndex
        self.buffer.writeString(#"{"string": "hello", "int": 42}"#)
        let endIndex = self.buffer.writerIndex
        self.buffer.writeString("GARBAGE {}!!? / GARBAGE")

        let expectedSandI = StringAndInt(string: "hello", int: 42)
        XCTAssertNoThrow(XCTAssertEqual(expectedSandI,
                                        try self.buffer.getJSONDecodable(StringAndInt.self,
                                                                         at: beginIndex,
                                                                         length: endIndex - beginIndex)))
    }

    func testGetJSONDecodableFromBufferFailsBecauseShort() {
        self.buffer.writeString("GARBAGE {}!!? / GARBAGE")
        let beginIndex = self.buffer.writerIndex
        self.buffer.writeString(#"{"string": "hello", "int": 42}"#)
        let endIndex = self.buffer.writerIndex

        XCTAssertThrowsError(try self.buffer.getJSONDecodable(StringAndInt.self,
                                                              at: beginIndex,
                                                              length: endIndex - beginIndex - 1)) { error in
            XCTAssert(error is DecodingError)
        }
    }

    func testReadJSONDecodableFromBufferWorks() {
        let beginIndex = self.buffer.writerIndex
        self.buffer.writeString(#"{"string": "hello", "int": 42}"#)
        let endIndex = self.buffer.writerIndex
        self.buffer.writeString("GARBAGE {}!!? / GARBAGE")

        let expectedSandI = StringAndInt(string: "hello", int: 42)
        XCTAssertNoThrow(XCTAssertEqual(expectedSandI,
                                        try self.buffer.readJSONDecodable(StringAndInt.self,
                                                                          length: endIndex - beginIndex)))
    }

    func testReadJSONDecodableFromBufferFailsBecauseShort() {
        let beginIndex = self.buffer.writerIndex
        self.buffer.writeString(#"{"string": "hello", "int": 42}"#)
        let endIndex = self.buffer.writerIndex

        XCTAssertThrowsError(try self.buffer.readJSONDecodable(StringAndInt.self,
                                                               length: endIndex - beginIndex - 1)) { error in
            XCTAssert(error is DecodingError)
        }
    }

    func testReadWriteJSONDecodableWorks() {
        let expectedSandI = StringAndInt(string: "hello", int: 42)
        self.buffer.writeString("hello")
        self.buffer.moveReaderIndex(forwardBy: 5)
        var writtenBytes: Int?
        XCTAssertNoThrow(writtenBytes = try self.buffer.writeJSONEncodable(expectedSandI))
        for _ in 0..<10 {
            XCTAssertNoThrow(try self.buffer.writeJSONEncodable(expectedSandI, encoder: JSONEncoder()))
        }
        for _ in 0..<11 {
            XCTAssertNoThrow(try self.buffer.readJSONDecodable(StringAndInt.self, length: writtenBytes ?? -1))
        }
        XCTAssertEqual(0, self.buffer.readableBytes)
    }

    func testGetSetJSONDecodableWorks() {
        let expectedSandI = StringAndInt(string: "hello", int: 42)
        self.buffer.writeString(String(repeating: "{", count: 1000))
        var writtenBytes: Int?
        XCTAssertNoThrow(writtenBytes = try self.buffer.setJSONEncodable(expectedSandI,
                                                                         at: self.buffer.readerIndex + 123))
        XCTAssertNoThrow(try self.buffer.setJSONEncodable(expectedSandI,
                                                          encoder: JSONEncoder(),
                                                          at: self.buffer.readerIndex + 501))
        XCTAssertNoThrow(XCTAssertEqual(expectedSandI,
                                        try self.buffer.getJSONDecodable(StringAndInt.self,
                                                                         at: self.buffer.readerIndex + 123,
                                                                         length: writtenBytes ?? -1)))
        XCTAssertNoThrow(XCTAssertEqual(expectedSandI,
                                        try self.buffer.getJSONDecodable(StringAndInt.self,
                                                                         at: self.buffer.readerIndex + 501,
                                                                         length: writtenBytes ?? -1)))
    }

    func testFailingReadsDoNotChangeReaderIndex() {
        let expectedSandI = StringAndInt(string: "hello", int: 42)
        var writtenBytes: Int?
        XCTAssertNoThrow(writtenBytes = try self.buffer.writeJSONEncodable(expectedSandI))
        for length in 0..<(writtenBytes ?? 0) {
            XCTAssertThrowsError(try self.buffer.readJSONDecodable(StringAndInt.self,
                                                                   length: length)) { error in
                XCTAssert(error is DecodingError)
            }
        }
        XCTAssertNoThrow(try self.buffer.readJSONDecodable(StringAndInt.self, length: writtenBytes ?? -1))
    }
    
    func testCustomEncoderIsRespected() {
        let expectedDate = Date(timeIntervalSinceReferenceDate: 86400)
        let strategyExpectation = XCTestExpectation(description: "Custom encoding strategy invoked")
        let encoder = JSONEncoder()
        encoder.dateEncodingStrategy = .custom({ date, encoder in
            var container = encoder.singleValueContainer()
            try container.encode(date.timeIntervalSinceReferenceDate)
            strategyExpectation.fulfill()
        })
        XCTAssertNoThrow(try encoder.encode(["date": expectedDate], into: &self.buffer))
        XCTAssertEqual(XCTWaiter().wait(for: [strategyExpectation], timeout: 0.0), .completed)
    }

    func testCustomDecoderIsRespected() {
        let expectedDate = Date(timeIntervalSinceReferenceDate: 86400)
        let strategyExpectation = XCTestExpectation(description: "Custom decoding strategy invoked")
        let encoder = JSONEncoder()
        let decoder = JSONDecoder()
        encoder.dateEncodingStrategy = .custom({ date, encoder in
            var container = encoder.singleValueContainer()
            try container.encode(date.timeIntervalSinceReferenceDate)
        })
        decoder.dateDecodingStrategy = .custom({ decoder in
            strategyExpectation.fulfill()
            let container = try decoder.singleValueContainer()
            return Date(timeIntervalSinceReferenceDate: try container.decode(Double.self))
        })
        XCTAssertNoThrow(try encoder.encode(["date": expectedDate], into: &self.buffer))
        XCTAssertNoThrow(XCTAssertEqual(["date": expectedDate], try decoder.decode(Dictionary<String, Date>.self, from: self.buffer)))
        XCTAssertEqual(XCTWaiter().wait(for: [strategyExpectation], timeout: 0.0), .completed)
    }

    func testCustomCodersAreRespectedWhenUsingReadWriteJSONDecodable() {
        let expectedDate = Date(timeIntervalSinceReferenceDate: 86400)
        let decoderStrategyExpectation = XCTestExpectation(description: "Custom decoding strategy invoked")
        let encoderStrategyExpectation = XCTestExpectation(description: "Custom encoding strategy invoked")

        let encoder = JSONEncoder()
        let decoder = JSONDecoder()
        encoder.dateEncodingStrategy = .custom({ date, encoder in
            encoderStrategyExpectation.fulfill()
            var container = encoder.singleValueContainer()
            try container.encode(date.timeIntervalSinceReferenceDate)
        })
        decoder.dateDecodingStrategy = .custom({ decoder in
            decoderStrategyExpectation.fulfill()
            let container = try decoder.singleValueContainer()
            return Date(timeIntervalSinceReferenceDate: try container.decode(Double.self))
        })
        XCTAssertNoThrow(try self.buffer.writeJSONEncodable(["date": expectedDate], encoder: encoder))
        XCTAssertNoThrow(XCTAssertEqual(["date": expectedDate],
                                        try self.buffer.readJSONDecodable(Dictionary<String, Date>.self,
                                                                          decoder: decoder,
                                                                          length: self.buffer.readableBytes)))
        XCTAssertEqual(XCTWaiter().wait(for: [decoderStrategyExpectation], timeout: 0.0), .completed)
        XCTAssertEqual(XCTWaiter().wait(for: [encoderStrategyExpectation], timeout: 0.0), .completed)
    }
}

struct StringAndInt: Codable, Equatable {
    var string: String
    var int: Int
}