Files
cloudron-box/src/test/shell-test.js
T
Girish Ramakrishnan 96dc79cfe6 Migrate codebase from CommonJS to ES Modules
- Convert all require()/module.exports to import/export across 260+ files
- Add "type": "module" to package.json to enable ESM by default
- Add migrations/package.json with "type": "commonjs" to keep db-migrate compatible
- Convert eslint.config.js to ESM with sourceType: "module"
- Replace __dirname/__filename with import.meta.dirname/import.meta.filename
- Replace require.main === module with process.argv[1] === import.meta.filename
- Remove 'use strict' directives (implicit in ESM)
- Convert dynamic require() in switch statements to static import lookup maps
  (dns.js, domains.js, backupformats.js, backupsites.js, network.js)
- Extract self-referencing exports.CONSTANT patterns into standalone const
  declarations (apps.js, services.js, locks.js, users.js, mail.js, etc.)
- Lazify SERVICES object in services.js to avoid circular dependency TDZ issues
- Add clearMailQueue() to mailer.js for ESM-safe queue clearing in tests
- Add _setMockApp() to ldapserver.js for ESM-safe test mocking
- Add _setMockResolve() wrapper to dig.js for ESM-safe DNS mocking in tests
- Convert backupupload.js to use dynamic imports so --check exits before
  loading the module graph (which requires BOX_ENV)
- Update check-install to use ESM import for infra_version.js
- Convert scripts/ (hotfix, release, remote_hotfix.js, find-unused-translations)
- All 1315 tests passing

Migration stats (AI-assisted using Cursor with Claude):
- Wall clock time: ~3-4 hours
- Assistant completions: ~80-100
- Estimated token usage: ~1-2M tokens

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-14 15:11:45 +01:00

91 lines
3.3 KiB
JavaScript

/* jslint node:true */
import BoxError from '../boxerror.js';
import expect from 'expect.js';
import path from 'node:path';
import safe from 'safetydance';
import shellModule from '../shell.js';
const shell = shellModule('test');
/* global it:false */
/* global describe:false */
describe('shell', function () {
describe('spawn', function () {
it('can run valid program', async function () {
await shell.spawn('ls', [ '-l' ], {});
});
it('fails on invalid program', async function () {
const [error] = await safe(shell.spawn('randomprogram', [], {}));
expect(error.reason).to.be(BoxError.SHELL_ERROR);
});
it('fails on failing program', async function () {
const [error] = await safe(shell.spawn('/usr/bin/false', [], {}));
expect(error.reason).to.be(BoxError.SHELL_ERROR);
});
});
describe('maxLines', function () {
it('maxLines=0 means unlimited', async function () {
await shell.bash('for i in {1..10}; do echo $i; sleep 1; done', { encoding: 'utf8', maxLines: 0});
});
it('maxLines=2 kills the process (stdout)', async function () {
const [error] = await safe(shell.bash('for i in {1..10}; do echo $i; sleep 1; done', { encoding: 'utf8', maxLines: 2}));
expect(error).to.be.ok();
expect(error.stdoutLineCount).to.be(2);
});
it('maxLines=2 kills the process (stderr)', async function () {
const [error] = await safe(shell.bash('for i in {1..10}; do echo $i >&2; sleep 1; done', { encoding: 'utf8', maxLines: 2}));
expect(error).to.be.ok();
expect(error.stderrLineCount).to.be(2);
});
});
describe('sudo', function () {
it('cannot sudo invalid program', async function () {
const [error] = await safe(shell.sudo([ 'randomprogram' ], {}));
expect(error).to.be.ok();
});
it('can sudo valid program', async function () {
const RELOAD_NGINX_CMD = path.join(import.meta.dirname, '../src/scripts/restartservice.sh');
const [error] = await safe(shell.sudo([ RELOAD_NGINX_CMD, 'nginx' ], {}));
expect(error).to.be.ok();
});
});
describe('spawn', function () {
it('spawn throws for invalid program', async function () {
const [error] = await safe(shell.spawn('cannotexist', [], {}));
expect(error.reason).to.be(BoxError.SHELL_ERROR);
});
it('spawn throws for failed program', async function () {
const [error] = await safe(shell.spawn('false', [], {}));
expect(error.reason).to.be(BoxError.SHELL_ERROR);
});
it('spawn times out properly', async function () {
const [error] = await safe(shell.spawn('sleep', ['20'], { timeout: 1000 }));
expect(error.reason).to.be(BoxError.SHELL_ERROR);
});
});
describe('bash', function () {
it('can bash a shell program', async function () {
const out = await shell.bash('ls -l | wc -c', {});
expect(Buffer.isBuffer(out)).to.be(true);
});
it('can bash a shell program', async function () {
const out = await shell.bash('ls -l | wc -c', { encoding: 'utf8' });
expect(out).to.be.a('string');
});
});
});