Skip to content

Commit df93dcd

Browse files
timothyb89timothyb89
committed
Initial import with working input/output transform streams
0 parents  commit df93dcd

9 files changed

+725
-0
lines changed

‎.eslintignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

‎.eslintrc.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"extends" : "openstack",
3+
4+
"globals" : {
5+
"module": true
6+
},
7+
8+
"env" : {
9+
"node": true
10+
},
11+
12+
"rules" : {
13+
"module-setter": 0,
14+
"strict": [2,"global"],
15+
"valid-jsdoc": 0,
16+
"brace-style": [2, "1tbs", { "allowSingleLine": true }],
17+
"no-extra-parens": [2, "functions"],
18+
"complexity": 0,
19+
"no-unused-vars": 0,
20+
"guard-for-in": 0,
21+
"quote-props": 0,
22+
"no-use-before-define": 0
23+
}
24+
25+
}

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Project-specific ignores
2+
node_modules
3+
4+
# Editors
5+
*~
6+
.*.swp
7+
.*sw?

‎.tern-project

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"ecmaVersion": 6,
3+
"libs": [],
4+
"plugins": {
5+
"node": {},
6+
"doc_comment": {},
7+
"requirejs": {}
8+
}
9+
}

‎LICENSE

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+

‎README.md

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
node-subunit
2+
============
3+
4+
Provides utilities for reading and writing
5+
[Subunit streams](https://github.com/testing-cabal/subunit) with Node.js,
6+
targeting Node versions 0.10 (pre-packaged on Ubuntu Trusty) and higher.
7+
8+
Installation
9+
------------
10+
11+
npm install --save node-subunit
12+
13+
Usage
14+
-----
15+
### Native Packet Format
16+
Subunit packets are represented in JavaScript like so:
17+
```javascript
18+
{
19+
timestamp: <Date>,
20+
testId: <string>,
21+
tags: <string[]>,
22+
mime: <string>,
23+
fileContent: <Buffer>,
24+
fileName: <string>,
25+
routingCode: <string>,
26+
status: <string>
27+
_packet: {
28+
length: <number>
29+
flags: {
30+
testId: <boolean>,
31+
routeCode: <boolean>,
32+
timestamp: <boolean>,
33+
runnable: <boolean>,
34+
tags: <boolean>,
35+
mimeType: <boolean,
36+
eof: <boolean>,
37+
fileContent: <boolean>
38+
}
39+
}
40+
}
41+
```
42+
43+
Note that `true` entries in `_packet.flags` generally imply an associated field
44+
of the same name, except for `runnable` and `eof`. All fields (except `_packet`)
45+
are optional and, when read, will be undefined if not included in the original
46+
bytes. The `status` field is a bit special in that it
47+
48+
### Reading with `SubunitToObjectStream`
49+
`SubunitToObjectStream` is a transform stream that accepts Subunit bytes and
50+
outputs objects as described above. To read a file `testrepository.subunit`:
51+
52+
```javascript
53+
var fs = require('fs');
54+
var subunit = require('node-subunit');
55+
56+
fs.createReadStream('testrepository.subunit')
57+
.pipe(new subunit.SubunitToObjectStream())
58+
.on('data', function(packet) {
59+
console.log(packet);
60+
});
61+
```
62+
63+
### Writing with `ObjectToSubunitStream`
64+
The `ObjectToSubunitStream` is also a transform stream, but it accepts objects
65+
as formatted above and outputs Subunit-compatible bytes.
66+
67+
A few notes:
68+
* Flag masks for the `status` field will be looked up automatically based on its
69+
string value (e.g. `success`, `skip`, `fail`, etc)
70+
* Values in `_packet` are ignored, except for `flags.runnable` and `flags.eof`.
71+
These flag masks will automatically be added based on the defined values in
72+
the packet object.
73+
74+
As an example, this code:
75+
```javascript
76+
var fs = require('fs');
77+
var subunit = require('./index.js');
78+
79+
var stream = subunit.ObjectToSubunitStream();
80+
stream.pipe(fs.createWriteStream('./test1.subunit'));
81+
stream.write({
82+
testId: 'TestyMcTestface',
83+
status: 'success',
84+
timestamp: new Date(),
85+
_packet: {
86+
flags: { runnable: true }
87+
}
88+
});
89+
```
90+
91+
... is equivalent to this (save for timestamps and thus the CRC):
92+
```bash
93+
subunit-output --success TestyMcTestface
94+
```
95+
96+
### Chaining
97+
The streams are mostly idempotent, so they can be chained together (and perhaps
98+
mutated along the way). However, note the following:
99+
100+
```javascript
101+
fs.createReadStream('testrepository.subunit')
102+
.pipe(new subunit.SubunitToObjectStream())
103+
.on('data', function(d) {
104+
console.log('<-', d.timestamp);
105+
})
106+
.pipe(new subunit.ObjectToSubunitStream())
107+
.pipe(new subunit.SubunitToObjectStream())
108+
.on('data', function(d) {
109+
console.log('->', d.timestamp);
110+
});
111+
```
112+
113+
If you run this code, you might notice timestamps change (though the result
114+
should otherwise be bit-identical). Since JavaScript `Date` values don't have
115+
nanosecond resolution, timestamp values will be rounded down to the nearest
116+
millisecond when read initially. This generally isn't noticeable, but may lead
117+
to some unexpected trouble in some situations.

‎index.js

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Copyright 2016 Hewlett-Packard Development Company, L.P.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License"); you may
4+
// not use this file except in compliance with the License. You may obtain
5+
// a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11+
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12+
// License for the specific language governing permissions and limitations
13+
// under the License.
14+
'use strict';
15+
16+
var subunit = require('./subunit-stream');
17+
18+
module.exports = {
19+
SubunitToObjectStream: subunit.SubunitToObjectStream,
20+
ObjectToSubunitStream: subunit.ObjectToSubunitStream
21+
};

‎package.json

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "node-subunit",
3+
"version": "0.0.1",
4+
"description": "Subunit stream I/O for Node",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"keywords": [
10+
"subunit"
11+
],
12+
"author": "OpenStack <[email protected]> (http://www.openstack.org/)",
13+
"license": "Apache-2.0",
14+
"devDependencies": {
15+
"eslint": "^1.5.1",
16+
"eslint-config-openstack": "^1.2.4"
17+
},
18+
"dependencies": {
19+
"bl": "^1.1.2",
20+
"buffer-crc32": "^0.2.5"
21+
},
22+
"main": "index.js",
23+
"files": [
24+
"index.js",
25+
"subunit-stream.js"
26+
],
27+
"repository": {
28+
"type": "git",
29+
"url": "https://github.com/timothyb89/node-subunit"
30+
}
31+
}

0 commit comments

Comments
 (0)