-
Notifications
You must be signed in to change notification settings - Fork 1
/
mod.test.ts
240 lines (178 loc) · 5.87 KB
/
mod.test.ts
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
import { assertEquals, assertRejects, assertStringIncludes } from "./deps.dev.ts";
import { $, CommandBuilder } from "./deps.ts";
const mod = $.relativePath(import.meta.url, "mod.ts");
const demo = $.relativePath(import.meta.url, "demo.md");
const demoText = Deno.readTextFileSync(demo);
const t$ = $.build$({
commandBuilder: new CommandBuilder().captureCombined(true)
.noThrow(true).env({ NO_COLOR: "true" }).timeout(10_000),
});
const makeDetails = (opts?: { summary?: string; desc?: string }) => {
const details = $.dedent`
<details data-mdrb>
${opts?.summary ? `<summary>${opts.summary}</summary>` : ""}
<pre>
description = "${opts?.desc ?? ""}"
</pre>
</details>
`;
return details;
};
// Adapted from https://github.com/dsherret/dax/blob/77c2e708d1c14e4afc657f0affa38a450ff35607/src/request.test.ts#L5
function withServer(action: (serverUrl: URL) => Promise<void>) {
const controller = new AbortController();
const signal = controller.signal;
return new Promise<void>((resolve, reject) => {
Deno.serve({
hostname: "localhost",
signal,
async onListen(details) {
const url = new URL(`http://${details.hostname}:${details.port}/`);
try {
await action(url);
resolve();
controller.abort();
} catch (err) {
reject(err);
controller.abort();
}
},
}, (request) => {
const url = new URL(request.url);
if (url.pathname === "/demo") {
return new Response(demoText, { status: 200 });
} else {
return new Response("", { status: 404 });
}
});
});
}
Deno.test("mdrb works with local file", async () => {
const { combined } = await t$`deno run -A ${mod} ${demo}`.stdinText("");
const expected = $.dedent`
step 1 of 3 // say hello to the world
Hello MDRB!
step 2 of 3 // say hello to the world again
Hello (again) MDRB!
step 3 of 3 // log a final message to standard error
heeeeey! this will be printed to stderr :)
`;
assertEquals(combined.trim(), expected.trim());
});
Deno.test("mdrb shows error output for local file if no file exists", async () => {
const { combined, code } = await t$`deno run -A ${mod} ./does-not-exist.md`.stdinText("");
assertEquals(code, 2);
assertStringIncludes(combined, "no file exists at ./does-not-exist.md");
});
Deno.test("mdrb shows error output for local file if text read", async () => {
const file = await Deno.makeTempFile({ prefix: "mdrb-test_", suffix: ".md" });
const { combined, code } = await t$`deno run -A ${mod} ${file}`.stdinText("");
assertEquals(code, 2);
assertStringIncludes(combined, `no code to run for ${file}`);
});
Deno.test("mdrb works with http", async () => {
await withServer(async (serverURL) => {
const url = new URL("/demo", serverURL);
const { combined } = await t$`deno run -A ${mod} ${url}`.stdinText("");
const expected = $.dedent`
step 1 of 3 // say hello to the world
Hello MDRB!
step 2 of 3 // say hello to the world again
Hello (again) MDRB!
step 3 of 3 // log a final message to standard error
heeeeey! this will be printed to stderr :)
`;
assertEquals(combined.trim(), expected.trim());
});
});
Deno.test("mdrb shows error output for http if no text served", async () => {
await withServer(async (serverURL) => {
const url = new URL("/does-not-exist", serverURL);
const { combined, code } = await t$`deno run -A ${mod} ${url}`.stdinText("");
assertEquals(code, 2);
assertStringIncludes(combined, "no code to run for http://localhost");
});
});
Deno.test("mdrb works with stdin", async () => {
const { combined } = await t$`deno run -A ${mod}`.stdinText(demoText);
const expected = $.dedent`
step 1 of 3 // say hello to the world
Hello MDRB!
step 2 of 3 // say hello to the world again
Hello (again) MDRB!
step 3 of 3 // log a final message to standard error
heeeeey! this will be printed to stderr :)
`;
assertEquals(combined.trim(), expected.trim());
});
Deno.test("mdrb shows error output for stdin if no text piped", async () => {
const { combined, code } = await t$`deno run -A ${mod}`.stdinText("");
assertEquals(code, 2);
assertStringIncludes(combined, "no code to run from stdin");
});
Deno.test(
"mdrb switches to 'isolated' mode from 'runbook' mode for stdin and does not wait for step confirmation",
async () => {
const timeout = 3_000;
await t$`deno run -A ${mod} --mode runbook`.stdinText(demoText)
.timeout(timeout).noThrow(false);
},
);
Deno.test("$ is defined by default", async () => {
const md = $.dedent`
~~~ts
console.log("$ is", typeof $);
~~~
`;
const { combined } = await t$`deno run -A ${mod}`
.stdinText(md);
assertStringIncludes(combined, "$ is function");
});
Deno.test("$ is undefined if dax integration disabled", async () => {
const md = $.dedent`
~~~ts
console.log("$ is", typeof $);
~~~
`;
const { combined } = await t$`deno run -A ${mod} --dax=false`
.stdinText(md);
assertStringIncludes(combined, "$ is undefined");
});
Deno.test("single mode throws if blocks are incompatible", async () => {
await assertRejects(async () => {
const md = $.dedent`
~~~ts
const a = 1;
~~~
~~~ts
const a = 2;
console.log("a is", a);
~~~
`;
await t$`deno run -A ${mod} --mode=single`.stdinText(md).noThrow(false);
});
});
Deno.test("summary is printed if one is available", async () => {
const summary = "this is the step name";
const md = $.dedent`
${makeDetails({ summary })}
~~~ts
console.log("$ is", typeof $);
~~~
`;
const { combined } = await t$`deno run -A ${mod}`
.stdinText(md);
assertStringIncludes(combined, `step 1 of 1 // ${summary}`);
});
Deno.test("summary is not printed if one is not available", async () => {
const summary = "";
const md = $.dedent`
${makeDetails({ summary })}
~~~ts
console.log("$ is", typeof $);
~~~
`;
const { stderr } = await t$`deno run -A ${mod}`
.captureCombined(false).stdinText(md);
assertEquals(stderr.trim(), "step 1 of 1");
});