Skip to content
This repository was archived by the owner on Apr 13, 2024. It is now read-only.

Commit 194adfa

Browse files
AtkinsSJAtkinsSJ
committed
date: Add some basic tests
Using the chronokinesis library for mocking the date and timezone. All the tests use the `--utc` option so that the output doesn't vary depending on the local system timezone.
1 parent c84a12e commit 194adfa

File tree

4 files changed

+297
-0
lines changed

4 files changed

+297
-0
lines changed

‎package-lock.json

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
"dependencies": {
2121
"@pkgjs/parseargs": "^0.11.0",
2222
"capture-console": "^1.0.2",
23+
"chronokinesis": "^6.0.0",
2324
"cli-columns": "^4.0.0",
2425
"columnify": "^1.6.0",
2526
"fs-mode-to-string": "^0.0.2",

‎test/coreutils.test.js

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
* along with this program. If not, see <https://www.gnu.org/licenses/>.
1818
*/
1919
import { runBasenameTests } from "./coreutils/basename.js";
20+
import { runDateTests } from "./coreutils/date.js";
2021
import { runDirnameTests } from "./coreutils/dirname.js";
2122
import { runEchoTests } from "./coreutils/echo.js";
2223
import { runEnvTests } from "./coreutils/env.js";
@@ -32,6 +33,7 @@ import { runWcTests } from "./coreutils/wc.js";
3233

3334
describe('coreutils', function () {
3435
runBasenameTests();
36+
runDateTests();
3537
runDirnameTests();
3638
runEchoTests();
3739
runEnvTests();

‎test/coreutils/date.js

+288
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,288 @@
1+
/*
2+
* Copyright (C) 2024 Puter Technologies Inc.
3+
*
4+
* This file is part of Phoenix Shell.
5+
*
6+
* Phoenix Shell is free software: you can redistribute it and/or modify
7+
* it under the terms of the GNU Affero General Public License as published
8+
* by the Free Software Foundation, either version 3 of the License, or
9+
* (at your option) any later version.
10+
*
11+
* This program is distributed in the hope that it will be useful,
12+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
* GNU Affero General Public License for more details.
15+
*
16+
* You should have received a copy of the GNU Affero General Public License
17+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
18+
*/
19+
import assert from 'assert';
20+
import * as ck from 'chronokinesis';
21+
import { MakeTestContext } from './harness.js'
22+
import builtins from '../../src/puter-shell/coreutils/__exports__.js';
23+
24+
export const runDateTests = () => {
25+
describe('date', function () {
26+
beforeEach(() => {
27+
ck.freeze();
28+
ck.timezone('UTC', '2024-03-07 13:05:07');
29+
});
30+
afterEach(() => {
31+
ck.reset();
32+
});
33+
34+
const testCases = [
35+
{
36+
description: 'outputs the date and time in a standard format when no format parameter is given',
37+
input: [ ],
38+
options: { utc: true },
39+
expectedStdout: 'Thu Mar 7 13:05:07 UTC 2024\n',
40+
expectedStderr: '',
41+
},
42+
{
43+
description: 'outputs the format verbatim if no format sequences are included',
44+
input: [ '+hello' ],
45+
options: { utc: true },
46+
expectedStdout: 'hello\n',
47+
expectedStderr: '',
48+
},
49+
{
50+
description: '%a outputs abbreviated weekday name',
51+
input: [ '+%a' ],
52+
options: { utc: true },
53+
expectedStdout: 'Thu\n',
54+
expectedStderr: '',
55+
},
56+
{
57+
description: '%A outputs full weekday name',
58+
input: [ '+%A' ],
59+
options: { utc: true },
60+
expectedStdout: 'Thursday\n',
61+
expectedStderr: '',
62+
},
63+
{
64+
description: '%b outputs abbreviated month name',
65+
input: [ '+%b' ],
66+
options: { utc: true },
67+
expectedStdout: 'Mar\n',
68+
expectedStderr: '',
69+
},
70+
{
71+
description: '%B outputs full month name',
72+
input: [ '+%B' ],
73+
options: { utc: true },
74+
expectedStdout: 'March\n',
75+
expectedStderr: '',
76+
},
77+
{
78+
description: '%c outputs full date and time',
79+
input: [ '+%c' ],
80+
options: { utc: true },
81+
expectedStdout: '3/7/2024, 1:05:07 PM\n',
82+
expectedStderr: '',
83+
},
84+
{
85+
description: '%C outputs century as 2 digits',
86+
input: [ '+%C' ],
87+
options: { utc: true },
88+
expectedStdout: '20\n',
89+
expectedStderr: '',
90+
},
91+
{
92+
description: '%d outputs day of the month as 2 digits',
93+
input: [ '+%d' ],
94+
options: { utc: true },
95+
expectedStdout: '07\n',
96+
expectedStderr: '',
97+
},
98+
{
99+
description: '%D outputs date as mm/dd/yy',
100+
input: [ '+%D' ],
101+
options: { utc: true },
102+
expectedStdout: '03/07/24\n',
103+
expectedStderr: '',
104+
},
105+
{
106+
description: '%e outputs day of the month as 2 characters padded with a leading space',
107+
input: [ '+%e' ],
108+
options: { utc: true },
109+
expectedStdout: ' 7\n',
110+
expectedStderr: '',
111+
},
112+
{
113+
description: '%H outputs the 24-hour clock hour, as 2 digits',
114+
input: [ '+%H' ],
115+
options: { utc: true },
116+
expectedStdout: '13\n',
117+
expectedStderr: '',
118+
},
119+
{
120+
description: '%h outputs the same as %b',
121+
input: [ '+%h' ],
122+
options: { utc: true },
123+
expectedStdout: 'Mar\n',
124+
expectedStderr: '',
125+
},
126+
{
127+
description: '%I outputs the 12-hour clock hour, as 2 digits',
128+
input: [ '+%I' ],
129+
options: { utc: true },
130+
expectedStdout: '01\n',
131+
expectedStderr: '',
132+
},
133+
// TODO: %j outputs the day of the year as a 3-digit number, starting at 001.
134+
{
135+
description: '%m outputs the month, as 2 digits, with January as 01',
136+
input: [ '+%m' ],
137+
options: { utc: true },
138+
expectedStdout: '03\n',
139+
expectedStderr: '',
140+
},
141+
{
142+
description: '%M outputs the minute, as 2 digits',
143+
input: [ '+%M' ],
144+
options: { utc: true },
145+
expectedStdout: '05\n',
146+
expectedStderr: '',
147+
},
148+
{
149+
description: '%n outputs a newline character',
150+
input: [ '+%n' ],
151+
options: { utc: true },
152+
expectedStdout: '\n\n',
153+
expectedStderr: '',
154+
},
155+
{
156+
description: '%p outputs AM or PM',
157+
input: [ '+%p' ],
158+
options: { utc: true },
159+
expectedStdout: 'PM\n',
160+
expectedStderr: '',
161+
},
162+
{
163+
description: '%r outputs the 12-hour clock time',
164+
input: [ '+%r' ],
165+
options: { utc: true },
166+
expectedStdout: '01:05:07 PM\n',
167+
expectedStderr: '',
168+
},
169+
{
170+
description: '%S outputs seconds, as 2 digits',
171+
input: [ '+%S' ],
172+
options: { utc: true },
173+
expectedStdout: '07\n',
174+
expectedStderr: '',
175+
},
176+
{
177+
description: '%t outputs a tab character',
178+
input: [ '+%t' ],
179+
options: { utc: true },
180+
expectedStdout: '\t\n',
181+
expectedStderr: '',
182+
},
183+
{
184+
description: '%T outputs the 24-hour clock time',
185+
input: [ '+%T' ],
186+
options: { utc: true },
187+
expectedStdout: '13:05:07\n',
188+
expectedStderr: '',
189+
},
190+
{
191+
description: '%u outputs the week day as a number, with Monday = 1 and Sunday = 7',
192+
input: [ '+%u' ],
193+
options: { utc: true },
194+
expectedStdout: '4\n',
195+
expectedStderr: '',
196+
},
197+
// TODO: %U outputs the week of the year, as 2 digits, with weeks starting on Sunday, and the first being week 00
198+
// TODO: %V outputs the week of the year, as 2 digits, with weeks starting on Monday, and the first being week 01
199+
{
200+
description: '%w outputs the week day as a number, with Sunday = 0 and Saturday = 6',
201+
input: [ '+%w' ],
202+
options: { utc: true },
203+
expectedStdout: '4\n',
204+
expectedStderr: '',
205+
},
206+
// TODO: %W outputs the week of the year, as 2 digits,, with weeks starting on Monday, and the first being week 00
207+
{
208+
description: '%x outputs a local date representation',
209+
input: [ '+%x' ],
210+
options: { utc: true },
211+
expectedStdout: '3/7/2024\n',
212+
expectedStderr: '',
213+
},
214+
{
215+
description: '%X outputs a local time representation',
216+
input: [ '+%X' ],
217+
options: { utc: true },
218+
expectedStdout: '1:05:07 PM\n',
219+
expectedStderr: '',
220+
},
221+
{
222+
description: '%y outputs the year within a century, as 2 digits',
223+
input: [ '+%y' ],
224+
options: { utc: true },
225+
expectedStdout: '24\n',
226+
expectedStderr: '',
227+
},
228+
{
229+
description: '%Y outputs the year',
230+
input: [ '+%Y' ],
231+
options: { utc: true },
232+
expectedStdout: '2024\n',
233+
expectedStderr: '',
234+
},
235+
{
236+
description: '%Z outputs the timezone name',
237+
input: [ '+%Z' ],
238+
options: { utc: true },
239+
expectedStdout: 'UTC\n',
240+
expectedStderr: '',
241+
},
242+
{
243+
description: '%% outputs a percent sign',
244+
input: [ '+%%' ],
245+
options: { utc: true },
246+
expectedStdout: '%\n',
247+
expectedStderr: '',
248+
},
249+
{
250+
description: 'multiple format sequences can be included at once',
251+
input: [ '+%B is month %m' ],
252+
options: { utc: true },
253+
expectedStdout: 'March is month 03\n',
254+
expectedStderr: '',
255+
},
256+
{
257+
description: 'unrecognized formats are output verbatim',
258+
input: [ '+%4%L hello' ],
259+
options: { utc: true },
260+
expectedStdout: '%4%L hello\n',
261+
expectedStderr: '',
262+
},
263+
];
264+
265+
for (const { description, input, options, expectedStdout, expectedStderr, expectedFail } of testCases) {
266+
it(description, async () => {
267+
let ctx = MakeTestContext(builtins.date, { positionals: input, values: options });
268+
let hadError = false;
269+
try {
270+
const result = await builtins.date.execute(ctx);
271+
if (!expectedFail) {
272+
assert.equal(result, undefined, 'should exit successfully, returning nothing');
273+
}
274+
} catch (e) {
275+
hadError = true;
276+
if (!expectedFail) {
277+
assert.fail(e);
278+
}
279+
}
280+
if (expectedFail && !hadError) {
281+
assert.fail('should have returned an error code');
282+
}
283+
assert.equal(ctx.externs.out.output, expectedStdout, 'wrong output written to stdout');
284+
assert.equal(ctx.externs.err.output, expectedStderr, 'wrong output written to stderr');
285+
});
286+
}
287+
});
288+
};

0 commit comments

Comments
 (0)