remove hpack-test-case submodule (#156)

Motivation:

Submodules can cause trouble with mirrored git setups because they can't
be easily mirrored through SwiftPM's mirror support.

Modification:

Remove the hpack-test-case submodule and add as files.

Result:

Easier to mirror.

Author: weissi

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "hpack-test-case"]
-	path = hpack-test-case
-	url = https://github.com/http2jp/hpack-test-case.git

Tests/NIOHPACKTests/HPACKIntegrationTests.swift

@@ -22,10 +22,10 @@ class HPACKIntegrationTests : XCTestCase {
         let myURL = URL(fileURLWithPath: #file, isDirectory: false)
         let result: URL
         if #available(OSX 10.11, iOS 9.0, *) {
-            result = URL(fileURLWithPath: "../../hpack-test-case", isDirectory: true, relativeTo: myURL).absoluteURL
+            result = URL(fileURLWithPath: "../hpack-test-case", isDirectory: true, relativeTo: myURL).absoluteURL
         } else {
             // Fallback on earlier versions
-            result = URL(string: "../../hpack-test-case", relativeTo: myURL)!.absoluteURL
+            result = URL(string: "../hpack-test-case", relativeTo: myURL)!.absoluteURL
         }
         return result
     }()

Tests/hpack-test-case/README.md

@@ -0,0 +1,91 @@
+# hpack-test-case
+
+## Spec
+
+HPACK: Header Compression for HTTP/2
+https://tools.ietf.org/html/rfc7541
+
+
+## Directory
+
+The ```raw-data``` directory has original stories of header data in
+json.
+
+Other than ```raw-data``` directory, the HPACK implementations have
+their own directories to store the result of its encoder.
+
+You can perform interoperability testing for your implementation with
+them.
+
+## File Name
+
+Each json in story-#{n}.json is story case and shares compression
+context. Each story is either series of requests or responses.
+
+## JSON Format
+
+Each json has:
+
+- description: general description of encoding strategy or implementation.
+- cases: array of test cases.
+  - seqno: a sequence number. 0 origin.
+  - header_table_size: the header table size sent in SETTINGS_HEADER_TABLE_SIZE and ACKed just before this case. The first case should contain this field. If omitted, the default value, 4,096, is used.
+  - wire: encoded wire data in hex string.
+  - headers: decoded http header in hash.
+
+To test the decoder implementation, for each story file, for each case
+in ```cases``` in the order they appear, decode compressed header
+block in ```wire``` and verify the result against the header set in
+```headers```. Please note that elements in ```cases``` share the same
+compression context.
+
+To test the encoder implementation, generate json story files by
+encoding header sets in ```headers```. Using json files in
+```raw-data``` is handy. Then use your decoder to verify that it can
+successfully decode the compressed header block. If you can play with
+other HPACK decoder implementations, try decoding your encoded data
+with them. If there is any mismatch, then there must be a bug in
+somewhere either encoder or decoder, or both.
+
+```js
+{
+  "description": "Encoded request headers with Literal without index only.",
+  "cases": [
+    {
+      "seqno": 0,
+      "header_table_size": 4096,
+      "wire": "1234567890abcdef",
+      "headers": [
+        { ":method": "GET" },
+        { ":scheme": "http" },
+        { ":authority": "example.com" },
+        { ":path": "/" },
+        { "x-my-header": "value1,value2" }
+      ]
+    },
+    .....
+  ]
+}
+```
+
+## Original Data
+
+These Header Data are converted from https://github.com/http2/http_samples
+
+
+## Compression Ratio
+
+https://github.com/http2jp/hpack-test-case/wiki/Compression-Ratio
+
+
+## Contributor
+
+- jxck
+- summerwind
+- kazu-yamamoto
+- tatsuhiro-t
+
+
+## License
+
+The MIT License (MIT)

Tests/hpack-test-case/genratiotbl.py

@@ -0,0 +1,131 @@
+#!/usr/bin/env python
+#
+# This script takes directories which contain the hpack-test-case json
+# files, and calculates the compression ratio in each file and outputs
+# the result in table formatted in rst.
+#
+# The each directory contains the result of various HPACK compressor.
+#
+# The table is laid out so that we can see that how input header set
+# in one json file is compressed in each compressor.
+#
+import sys, json, os, re, argparse
+
+class Stat:
+
+    def __init__(self, complen, srclen):
+        self.complen = complen
+        self.srclen = srclen
+
+def compute_stat(jsdata):
+    complen = 0
+    srclen = 0
+    for item in jsdata['cases']:
+        complen += len(item['wire']) // 2
+        srclen += \
+                  sum([len(list(x.keys())[0]) + len(list(x.values())[0]) \
+                       for x in item['headers']])
+    return Stat(complen, srclen)
+
+def format_result(r):
+    return '{:.02f} ({}/{}) '.format(float(r.complen)/r.srclen,
+                                     r.complen, r.srclen)
+
+if __name__ == '__main__':
+    ap = argparse.ArgumentParser(description='''\
+Generate HPACK compression ratio table in reStructuredText.
+
+An output is written to stdout.
+''')
+    ap.add_argument('dir', nargs='+',
+                    help='A directory containing JSON files')
+
+    args = ap.parse_args()
+
+    entries = [(os.path.basename(re.sub(r'/+$', '', p)), p) for p in args.dir]
+    maxnamelen = 0
+    maxstorynamelen = 0
+    res = {}
+
+    stories = set()
+    for name, ent in entries:
+        files = [p for p in os.listdir(ent) if p.endswith('.json')]
+        res[name] = {}
+        maxnamelen = max(maxnamelen, len(name))
+        for fn in files:
+            stories.add(fn)
+            maxstorynamelen = max(maxstorynamelen, len(fn))
+            with open(os.path.join(ent, fn)) as f:
+                input = f.read()
+            rv = compute_stat(json.loads(input))
+            res[name][fn] = rv
+            maxnamelen = max(maxnamelen, len(format_result(rv)))
+    stories = list(stories)
+    stories.sort()
+
+    overall = []
+    for name, _ in entries:
+        r = Stat(0, 0)
+        for _, stat in res[name].items():
+            r.srclen += stat.srclen
+            r.complen += stat.complen
+        overall.append(r)
+        maxnamelen = max(maxnamelen, len(format_result(r)))
+
+    storynameformat = '{{:{}}} '.format(maxstorynamelen)
+    nameformat = '{{:{}}} '.format(maxnamelen)
+
+
+    sys.stdout.write('''\
+hpack-test-case compression ratio
+=================================
+
+The each cell has ``X (Y/Z)`` format:
+
+X
+  Y / Z
+Y
+  number of bytes after compression
+Z
+  number of bytes before compression
+
+''')
+
+    def write_border():
+        sys.stdout.write('='*maxstorynamelen)
+        sys.stdout.write(' ')
+        for _ in entries:
+            sys.stdout.write('='*maxnamelen)
+            sys.stdout.write(' ')
+        sys.stdout.write('\n')
+
+    write_border()
+
+    sys.stdout.write(storynameformat.format('story'))
+    for name, _ in entries:
+        sys.stdout.write(nameformat.format(name))
+    sys.stdout.write('\n')
+
+    write_border()
+
+    for story in stories:
+        sys.stdout.write(storynameformat.format(story))
+        srclen = -1
+        for name, _ in entries:
+            stats = res[name]
+            if story not in stats:
+                sys.stdout.write(nameformat.format('N/A'))
+                continue
+            if srclen == -1:
+                srclen = stats[story].srclen
+            elif srclen != stats[story].srclen:
+                raise Exception('Bad srclen')
+            sys.stdout.write(nameformat.format(format_result(stats[story])))
+        sys.stdout.write('\n')
+
+    sys.stdout.write(storynameformat.format('Overall'))
+    for r in overall:
+        sys.stdout.write(nameformat.format(format_result(r)))
+    sys.stdout.write('\n')
+
+    write_border()

Tests/hpack-test-case/go-hpack/story_00.json

@@ -0,0 +1,62 @@
+{
+  "description": "https://github.com/Jxck/hpack implemeted in Golang. Encoded using String Literal with Huffman, no Header/Static Table, and always start with emptied Reference Set. by Jxck.",
+  "cases": [
+    {
+      "seqno": 0,
+      "header_table_size": 4096,
+      "wire": "0085b9495339e483c5837f0085b8824e5a4b839d29af0088b83b5339ec327d7f88f439ce75c875fa570084b958d33f8163",
+      "headers": [
+        {
+          ":method": "GET"
+        },
+        {
+          ":scheme": "http"
+        },
+        {
+          ":authority": "yahoo.co.jp"
+        },
+        {
+          ":path": "/"
+        }
+      ]
+    },
+    {
+      "seqno": 1,
+      "header_table_size": 4096,
+      "wire": "0085b9495339e483c5837f0085b8824e5a4b839d29af0088b83b5339ec327d7f8cf1e3c2fe8739ceb90ebf4aff0084b958d33f8163",
+      "headers": [
+        {
+          ":method": "GET"
+        },
+        {
+          ":scheme": "http"
+        },
+        {
+          ":authority": "www.yahoo.co.jp"
+        },
+        {
+          ":path": "/"
+        }
+      ]
+    },
+    {
+      "seqno": 2,
+      "header_table_size": 4096,
+      "wire": "0085b9495339e483c5837f0085b8824e5a4b839d29af0088b83b5339ec327d7f87eabfa35332fd2b0084b958d33f9b60d48e62a1849eb611589825353141e63ad52160b206c4f2f5d537",
+      "headers": [
+        {
+          ":method": "GET"
+        },
+        {
+          ":scheme": "http"
+        },
+        {
+          ":authority": "k.yimg.jp"
+        },
+        {
+          ":path": "/images/top/sp2/cmn/logo-ns-130528.png"
+        }
+      ]
+    }
+  ]
+}

Tests/hpack-test-case/go-hpack/story_01.json

@@ -0,0 +1,58 @@
+{
+  "description": "https://github.com/Jxck/hpack implemeted in Golang. Encoded using String Literal with Huffman, no Header/Static Table, and always start with emptied Reference Set. by Jxck.",
+  "cases": [
+    {
+      "seqno": 0,
+      "header_table_size": 4096,
+      "wire": "0085b8824e5a4b849d29ad1f0088b83b5339ec327d7f882f91d35d055c87a70084b958d33f81630085b9495339e483c5837f0087b505b161cc5a93879eb193aac92a13008421cfd4c587f3e7cf9f3e7c870086f2b4e5a283ff84f07b2893",
+      "headers": [
+        {
+          ":scheme": "https"
+        },
+        {
+          ":authority": "example.com"
+        },
+        {
+          ":path": "/"
+        },
+        {
+          ":method": "GET"
+        },
+        {
+          "user-agent": "hpack-test"
+        },
+        {
+          "cookie": "xxxxxxx1"
+        },
+        {
+          "x-hello": "world"
+        }
+      ]
+    },
+    {
+      "seqno": 1,
+      "header_table_size": 4096,
+      "wire": "0085b8824e5a4b849d29ad1f0088b83b5339ec327d7f882f91d35d055c87a70084b958d33f81630085b9495339e483c5837f0087b505b161cc5a93879eb193aac92a13008421cfd4c587f3e7cf9f3e7c8b",
+      "headers": [
+        {
+          ":scheme": "https"
+        },
+        {
+          ":authority": "example.com"
+        },
+        {
+          ":path": "/"
+        },
+        {
+          ":method": "GET"
+        },
+        {
+          "user-agent": "hpack-test"
+        },
+        {
+          "cookie": "xxxxxxx2"
+        }
+      ]
+    }
+  ]
+}