Repository navigation
Expand file tree
/
Copy pathbencode_test.clj
More file actions
249 lines (210 loc) · 8.58 KB
/
Copy pathbencode_test.clj
File metadata and controls
249 lines (210 loc) · 8.58 KB
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
;; Copyright (c) Meikel Brandmeyer. All rights reserved.
;; The use and distribution terms for this software are covered by the
;; Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
;; which can be found in the file epl-v10.html at the root of this distribution.
;; By using this software in any fashion, you are agreeing to be bound by
;; the terms of this license.
;; You must not remove this notice, or any other, from this software.
(ns nrepl.bencode-test
(:require [clojure.test :refer [are deftest is testing]]
[clojure.test.check.generators :as gen]
[clojure.test.check.properties :as tc.prop]
[clojure.test.check.clojure-test :refer [defspec]]
[nrepl.bencode :as bencode :refer [read-bencode
read-netstring
write-bencode
write-netstring]])
(:import clojure.lang.RT
[java.io ByteArrayInputStream ByteArrayOutputStream PushbackInputStream]))
(defn #^{:private true} >bytes
[#^String input]
(.getBytes input "UTF-8"))
(defmulti #^{:private true} <bytes class)
(defmethod <bytes :default
[input]
input)
(defmethod <bytes (RT/classForName "[B")
[#^"[B" input]
(String. input "UTF-8"))
(defmethod <bytes clojure.lang.IPersistentVector
[input]
(vec (map <bytes input)))
(defmethod <bytes clojure.lang.IPersistentMap
[input]
(->> input
(map (fn [[k v]] [k (<bytes v)]))
(into {})))
(defn- decode
[bytes & {:keys [reader]}]
(-> bytes
ByteArrayInputStream.
PushbackInputStream.
reader))
(defn- >input
[^String input & args]
(-> input
(.getBytes "UTF-8")
(#(apply decode % args))
<bytes))
(deftest test-netstring-reading
(are [x y] (= (>input x :reader read-netstring) y)
"0:," ""
"13:Hello, World!," "Hello, World!"
"16:Hällö, Würld!," "Hällö, Würld!"
"25:Здравей, Свят!," "Здравей, Свят!"))
(deftest test-string-reading
(are [x y] (= (>input x :reader read-bencode) y)
"0:" ""
"13:Hello, World!" "Hello, World!"
"16:Hällö, Würld!" "Hällö, Würld!"
"25:Здравей, Свят!" "Здравей, Свят!"))
(deftest test-integer-reading
(are [x y] (= (>input x :reader read-bencode) y)
"i0e" 0
"i42e" 42
"i-42e" -42))
(deftest test-list-reading
(are [x y] (= (>input x :reader read-bencode) y)
"le" []
"l6:cheesee" ["cheese"]
"l6:cheese3:ham4:eggse" ["cheese" "ham" "eggs"]))
(deftest test-map-reading
(are [x y] (= (>input x :reader read-bencode) y)
"de" {}
"d3:ham4:eggse" {"ham" "eggs"}))
(deftest test-nested-reading
(are [x y] (= (>input x :reader read-bencode) y)
"l6:cheesei42ed3:ham4:eggsee" ["cheese" 42 {"ham" "eggs"}]
"d6:cheesei42e3:haml4:eggsee" {"cheese" 42 "ham" ["eggs"]}))
(defn- >stream
^ByteArrayOutputStream
[thing & {:keys [writer]}]
(doto (ByteArrayOutputStream.)
(writer thing)))
(defn- >output
[& args]
(-> >stream
^ByteArrayOutputStream (apply args)
(.toString "UTF-8")))
(deftest test-netstring-writing
(are [x y] (= (>output (>bytes x) :writer write-netstring) y)
"" "0:,"
"Hello, World!" "13:Hello, World!,"
"Hällö, Würld!" "16:Hällö, Würld!,"
"Здравей, Свят!" "25:Здравей, Свят!,"))
(deftest test-byte-array-writing
(are [x y] (= (>output (>bytes x) :writer write-bencode) y)
"" "0:"
"Hello, World!" "13:Hello, World!"
"Hällö, Würld!" "16:Hällö, Würld!"
"Здравей, Свят!" "25:Здравей, Свят!"))
(deftest test-string-writing
(are [x y] (= (>output x :writer write-bencode) y)
"" "0:"
"Hello, World!" "13:Hello, World!"
"Hällö, Würld!" "16:Hällö, Würld!"
"Здравей, Свят!" "25:Здравей, Свят!"))
(deftest test-input-stream-writing
(are [x y] (= (>output (ByteArrayInputStream. (>bytes x))
:writer write-bencode) y)
"" "0:"
"Hello, World!" "13:Hello, World!"
"Hällö, Würld!" "16:Hällö, Würld!"
"Здравей, Свят!" "25:Здравей, Свят!"))
(deftest test-integer-writing
(are [x y] (= (>output x :writer write-bencode) y)
0 "i0e"
42 "i42e"
-42 "i-42e"
;; Works for all integral types.
;; Note: BigInts (42N) not tested, since they are not
;; supported in 1.2.
(Byte/parseByte "42" 10) "i42e"
(Short/parseShort "42" 10) "i42e"
(Integer/parseInt "42" 10) "i42e"
(Long/parseLong "42" 10) "i42e"))
(deftest test-named-writing
(are [x y] (= (>output x :writer write-bencode) y)
:foo "3:foo"
:foo/bar "7:foo/bar"
'foo "3:foo"
'foo/bar "7:foo/bar"))
(deftest test-list-writing
(are [x y] (= (>output x :writer write-bencode) y)
nil "le"
[] "le"
["cheese"] "l6:cheesee"
["cheese" "ham" "eggs"] "l6:cheese3:ham4:eggse"))
(deftest test-map-writing
(are [x y] (= (>output x :writer write-bencode) y)
{} "de"
{"ham" "eggs"} "d3:ham4:eggse"
{:ham "eggs"} "d3:ham4:eggse"
{'ham "eggs"} "d3:ham4:eggse"
{:h/am "eggs"} "d4:h/am4:eggse"))
(deftest test-nested-writing
(are [x y] (= (>output x :writer write-bencode) y)
["cheese" 42 {"ham" "eggs"}] "l6:cheesei42ed3:ham4:eggsee"
{"cheese" 42 "ham" ["eggs"]} "d6:cheesei42e3:haml4:eggsee"))
(deftest test-lexicographic-sorting
(let [source (zipmap ["ham" "eggs" "hamburger" "hamburg" "cheese"] (range))]
(is (= "d6:cheesei4e4:eggsi1e3:hami0e7:hamburgi3e9:hamburgeri2ee"
(>output source :writer write-bencode)))))
(deftest unencoded-values
;; just some PNG data that won't round-trip cleanly through UTF-8 encoding, so
;; any default encoding in the bencode implementation will be caught immediately
(let [binary-data (byte-array
[-119 80 78 71 13 10 26 10 0 0 0 13 73 72 68 82 0 0 0
100 0 0 0 100 8 6 0 0 0 112 -30 -107 84 0 0 3 -16 105
67 67 80 73 67 67 32 80 114 111 102 105 108 101 0 0 40
-111 -115 85 -35 111 -37 84 20 63 -119 111 92 -92 22 63
-96 -79 -114 14 21 -117 -81 85 83 91 -71 27 26 -83 -58 6
73 -109 -91 -23 66 26 -71 -51 -40 42 -92 -55 117 110])]
(is (= (seq binary-data)
(-> {"data" binary-data}
(>stream :writer write-bencode)
.toByteArray
(decode :reader read-bencode)
(get "data")
seq)))))
(deftest unwritable-values
(testing "write-bencode writes eagerly"
(let [out (ByteArrayOutputStream.)]
(is (thrown? IllegalArgumentException
(write-bencode out {"obj" (Object.)})))
(is (= "d3:obj" (String. (.toByteArray out)))))))
;; ## Generative testing.
;;
;; Verify that any valid value remains the same after encode-decode roundtrip.
(def valid-bencode-input-generator
"This is a recursive test.check generator that can generate a string, a number,
or a list or a map that contains any other valid value."
(gen/recursive-gen #(gen/one-of [%
(gen/vector % 0 20)
(gen/map gen/string % {:min-elements 0
:max-elements 20})])
(gen/one-of [gen/string gen/large-integer])))
;; :num-tests is intentionally so small to avoid crashing with OOM on CI. When
;; making any changes to `nrepl.bencode`, make sure to increase this number and
;; extensively run this locally.
(defspec generative-roundtrip-test {:num-tests 30}
(tc.prop/for-all
[value valid-bencode-input-generator]
(= value (>input (>output value :writer write-bencode) :reader read-bencode))))
;; ## Performance testing
;;
;; This code is to be run manually, so it is in a comment block. Evaluate the
;; performance of bencode encoding and decoding when making changes to bencode
;; implementation, and compare it to the previous version.
(comment
(def data (gen/generate valid-bencode-input-generator 5000 4))
(count (str data)) ;; Sanity-check data size.
;; Writing benchmark
(time+ (write-bencode (ByteArrayOutputStream.) data))
;; Reading benchmark
(let [baos (doto (ByteArrayOutputStream.)
(write-bencode data))
arr (.toByteArray baos)]
(time+
(nrepl.bencode/read-bencode (PushbackInputStream. (java.io.ByteArrayInputStream. arr)))
nil)))