Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
displayName: {
name: 'UNRAID',
color: 'orange',
},
collectCoverage: true,
coverageReporters: ['text'],
collectCoverageFrom: ['!<rootDir>/tests/', 'src/**/*.ts', '!<rootDir>/src/index.ts'],
coverageProvider: 'babel',
moduleNameMapper: {
'@system/(.*)': '<rootDir>/src/modules/system/extensions/$1',
},
};
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
"private": false,
"access": "public",
"devDependencies": {
"@babel/preset-typescript": "^7.16.5",
"@release-it/conventional-changelog": "^3.3.0",
"@types/jest": "^27.0.3",
"@types/ssh2": "^0.5.49",
"@typescript-eslint/eslint-plugin": "^5.4.0",
"@typescript-eslint/parser": "^5.4.0",
Expand All @@ -21,8 +23,10 @@
"eslint-plugin-import": "^2.25.3",
"eslint-plugin-prettier": "^4.0.0",
"eslint-plugin-simple-import-sort": "^7.0.0",
"jest": "^27.4.5",
"prettier": "^2.5.0",
"release-it": "^14.11.8",
"ts-jest": "^27.1.2",
"typedoc": "^0.22.10",
"typescript": "^4.5.2"
},
Expand Down
1 change: 0 additions & 1 deletion src/modules/system/extensions/cpu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ export class SystemModuleCpuExtension<

async usage(): Promise<CPUUsage> {
const { code, stdout } = await this.instance.execute(SystemModuleCpuExtension.cpuUsageCommand);
console.log({ stdout });
if (code !== 0) throw new Error('Got non-zero exit code while getting date');

return SystemModuleCpuExtension.parseCpuUsageOutput(stdout);
Expand Down
44 changes: 44 additions & 0 deletions tests/executor/TestExecutor.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import * as fs from 'fs/promises';
import * as path from 'path';
import { executor as Executor } from '../../src/instance';

export type SSHConfig = Record<string, string>;

export class TestExecutor extends Executor.Executor<SSHConfig> {
private ready = false;

async connect(): Promise<void> {
this.ready = true;
}

disconnect(): void {
this.ready = false;
}

execute(command: Executor.IExecuteSimple): Promise<Executor.IExecuteResult>;

execute({ command }: Executor.IExecute): Promise<Executor.IExecuteResult>;

execute(command: Executor.IExecuteSimple | Executor.IExecute): Promise<Executor.IExecuteResult>;

async execute(command: Executor.IExecuteSimple | Executor.IExecute): Promise<Executor.IExecuteResult> {
if (!this.ready) await this.connect();
if (typeof command === 'object') command = command.command;
const file = await fs.readFile(
`${path.join(__dirname, 'mocks', TestExecutor.sanitizeCommand(global.mock || command))}.txt`,
{
encoding: 'utf-8',
}
);
return {
code: 0,
signal: '',
stderr: [],
stdout: [file.trim()],
};
}

private static sanitizeCommand(command: string): string {
return command.replace(/ /g, '_').replace(/'/g, '_').replace(/"/g, '_');
}
}
1 change: 1 addition & 0 deletions tests/executor/mocks/cpu.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
%Cpu0 : 0.0 us, 5.6 sy, 0.0 ni, 94.4 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu1 : 0.0 us, 5.0 sy, 0.0 ni, 85.0 id, 10.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu2 : 0.0 us, 10.5 sy, 0.0 ni, 84.2 id, 5.3 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu3 : 0.0 us, 10.0 sy, 0.0 ni, 60.0 id, 30.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu4 : 5.0 us, 10.0 sy, 0.0 ni, 70.0 id, 15.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu5 : 19.0 us, 4.8 sy, 0.0 ni, 23.8 id, 52.4 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu6 : 5.3 us, 15.8 sy, 0.0 ni, 0.0 id, 78.9 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu7 : 4.8 us, 0.0 sy, 0.0 ni, 81.0 id, 14.3 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu8 : 10.0 us, 0.0 sy, 0.0 ni, 55.0 id, 35.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu9 : 5.3 us, 0.0 sy, 0.0 ni, 68.4 id, 26.3 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu10 : 0.0 us, 5.3 sy, 0.0 ni, 0.0 id, 94.7 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu11 : 0.0 us, 4.8 sy, 4.8 ni, 81.0 id, 9.5 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu12 : 0.0 us, 10.0 sy, 0.0 ni, 65.0 id, 25.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu13 : 0.0 us, 0.0 sy, 0.0 ni, 77.8 id, 22.2 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu14 : 5.3 us, 5.3 sy, 0.0 ni, 89.5 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu15 : 4.8 us, 9.5 sy, 0.0 ni, 0.0 id, 85.7 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu16 : 4.8 us, 4.8 sy, 9.5 ni, 76.2 id, 4.8 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu17 : 0.0 us, 0.0 sy, 15.0 ni, 80.0 id, 5.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu18 : 0.0 us, 15.0 sy, 0.0 ni, 0.0 id, 85.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu19 : 0.0 us, 4.8 sy, 28.6 ni, 66.7 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu20 : 0.0 us, 10.0 sy, 0.0 ni, 65.0 id, 25.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu21 : 0.0 us, 5.0 sy, 0.0 ni, 0.0 id, 95.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu22 : 4.8 us, 4.8 sy, 28.6 ni, 38.1 id, 23.8 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu23 : 0.0 us, 0.0 sy, 9.5 ni, 90.5 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st|
1 change: 1 addition & 0 deletions tests/executor/mocks/date.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sat Dec 18 02:17:50 CET 2021
1 change: 1 addition & 0 deletions tests/executor/mocks/date_-R.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sat Dec 18 02:17:50 CET 2021
10 changes: 10 additions & 0 deletions tests/helpers/getInstance.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { Unraid } from '../../src';
import { UnraidConfig } from '../../src/instance/unraid';
import { SSHConfig, TestExecutor } from '../executor/TestExecutor';

export function getInstance(): Unraid<SSHConfig, TestExecutor> {
return new Unraid({
executor: TestExecutor,
executorConfig: {},
} as UnraidConfig<SSHConfig, TestExecutor>);
}
285 changes: 285 additions & 0 deletions tests/modules/system/__snapshots__/cpu.test.ts.snap
Original file line number Diff line number Diff line change
@@ -0,0 +1,285 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`system - cpu usage 1`] = `
Object {
"all": Object {
"hardwareInterrupts": 0,
"idle": 56.31666666666667,
"ioWait": 30.954166666666662,
"nice": 4,
"softwareInterrupts": 0,
"steal": 0,
"sys": 5.875,
"usr": 2.8791666666666664,
},
"cores": Array [
Object {
"core": 0,
"hardwareInterrupts": 0,
"idle": 94.4,
"ioWait": 0,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 5.6,
"usr": 0,
},
Object {
"core": 1,
"hardwareInterrupts": 0,
"idle": 85,
"ioWait": 10,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 5,
"usr": 0,
},
Object {
"core": 2,
"hardwareInterrupts": 0,
"idle": 84.2,
"ioWait": 5.3,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 10.5,
"usr": 0,
},
Object {
"core": 3,
"hardwareInterrupts": 0,
"idle": 60,
"ioWait": 30,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 10,
"usr": 0,
},
Object {
"core": 4,
"hardwareInterrupts": 0,
"idle": 70,
"ioWait": 15,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 10,
"usr": 5,
},
Object {
"core": 5,
"hardwareInterrupts": 0,
"idle": 23.8,
"ioWait": 52.4,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 4.8,
"usr": 19,
},
Object {
"core": 6,
"hardwareInterrupts": 0,
"idle": 0,
"ioWait": 78.9,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 15.8,
"usr": 5.3,
},
Object {
"core": 7,
"hardwareInterrupts": 0,
"idle": 81,
"ioWait": 14.3,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 0,
"usr": 4.8,
},
Object {
"core": 8,
"hardwareInterrupts": 0,
"idle": 55,
"ioWait": 35,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 0,
"usr": 10,
},
Object {
"core": 9,
"hardwareInterrupts": 0,
"idle": 68.4,
"ioWait": 26.3,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 0,
"usr": 5.3,
},
Object {
"core": 10,
"hardwareInterrupts": 0,
"idle": 0,
"ioWait": 94.7,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 5.3,
"usr": 0,
},
Object {
"core": 11,
"hardwareInterrupts": 0,
"idle": 81,
"ioWait": 9.5,
"nice": 4.8,
"softwareInterrupts": 0,
"steal": 0,
"sys": 4.8,
"usr": 0,
},
Object {
"core": 12,
"hardwareInterrupts": 0,
"idle": 65,
"ioWait": 25,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 10,
"usr": 0,
},
Object {
"core": 13,
"hardwareInterrupts": 0,
"idle": 77.8,
"ioWait": 22.2,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 0,
"usr": 0,
},
Object {
"core": 14,
"hardwareInterrupts": 0,
"idle": 89.5,
"ioWait": 0,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 5.3,
"usr": 5.3,
},
Object {
"core": 15,
"hardwareInterrupts": 0,
"idle": 0,
"ioWait": 85.7,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 9.5,
"usr": 4.8,
},
Object {
"core": 16,
"hardwareInterrupts": 0,
"idle": 76.2,
"ioWait": 4.8,
"nice": 9.5,
"softwareInterrupts": 0,
"steal": 0,
"sys": 4.8,
"usr": 4.8,
},
Object {
"core": 17,
"hardwareInterrupts": 0,
"idle": 80,
"ioWait": 5,
"nice": 15,
"softwareInterrupts": 0,
"steal": 0,
"sys": 0,
"usr": 0,
},
Object {
"core": 18,
"hardwareInterrupts": 0,
"idle": 0,
"ioWait": 85,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 15,
"usr": 0,
},
Object {
"core": 19,
"hardwareInterrupts": 0,
"idle": 66.7,
"ioWait": 0,
"nice": 28.6,
"softwareInterrupts": 0,
"steal": 0,
"sys": 4.8,
"usr": 0,
},
Object {
"core": 20,
"hardwareInterrupts": 0,
"idle": 65,
"ioWait": 25,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 10,
"usr": 0,
},
Object {
"core": 21,
"hardwareInterrupts": 0,
"idle": 0,
"ioWait": 95,
"nice": 0,
"softwareInterrupts": 0,
"steal": 0,
"sys": 5,
"usr": 0,
},
Object {
"core": 22,
"hardwareInterrupts": 0,
"idle": 38.1,
"ioWait": 23.8,
"nice": 28.6,
"softwareInterrupts": 0,
"steal": 0,
"sys": 4.8,
"usr": 4.8,
},
Object {
"core": 23,
"hardwareInterrupts": 0,
"idle": 90.5,
"ioWait": 0,
"nice": 9.5,
"softwareInterrupts": 0,
"steal": 0,
"sys": 0,
"usr": 0,
},
],
"raw": Array [
"%Cpu0 : 0.0 us, 5.6 sy, 0.0 ni, 94.4 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu1 : 0.0 us, 5.0 sy, 0.0 ni, 85.0 id, 10.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu2 : 0.0 us, 10.5 sy, 0.0 ni, 84.2 id, 5.3 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu3 : 0.0 us, 10.0 sy, 0.0 ni, 60.0 id, 30.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu4 : 5.0 us, 10.0 sy, 0.0 ni, 70.0 id, 15.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu5 : 19.0 us, 4.8 sy, 0.0 ni, 23.8 id, 52.4 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu6 : 5.3 us, 15.8 sy, 0.0 ni, 0.0 id, 78.9 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu7 : 4.8 us, 0.0 sy, 0.0 ni, 81.0 id, 14.3 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu8 : 10.0 us, 0.0 sy, 0.0 ni, 55.0 id, 35.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu9 : 5.3 us, 0.0 sy, 0.0 ni, 68.4 id, 26.3 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu10 : 0.0 us, 5.3 sy, 0.0 ni, 0.0 id, 94.7 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu11 : 0.0 us, 4.8 sy, 4.8 ni, 81.0 id, 9.5 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu12 : 0.0 us, 10.0 sy, 0.0 ni, 65.0 id, 25.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu13 : 0.0 us, 0.0 sy, 0.0 ni, 77.8 id, 22.2 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu14 : 5.3 us, 5.3 sy, 0.0 ni, 89.5 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu15 : 4.8 us, 9.5 sy, 0.0 ni, 0.0 id, 85.7 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu16 : 4.8 us, 4.8 sy, 9.5 ni, 76.2 id, 4.8 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu17 : 0.0 us, 0.0 sy, 15.0 ni, 80.0 id, 5.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu18 : 0.0 us, 15.0 sy, 0.0 ni, 0.0 id, 85.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu19 : 0.0 us, 4.8 sy, 28.6 ni, 66.7 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu20 : 0.0 us, 10.0 sy, 0.0 ni, 65.0 id, 25.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu21 : 0.0 us, 5.0 sy, 0.0 ni, 0.0 id, 95.0 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu22 : 4.8 us, 4.8 sy, 28.6 ni, 38.1 id, 23.8 wa, 0.0 hi, 0.0 si, 0.0 st|%Cpu23 : 0.0 us, 0.0 sy, 9.5 ni, 90.5 id, 0.0 wa, 0.0 hi, 0.0 si, 0.0 st|",
],
}
`;
5 changes: 5 additions & 0 deletions tests/modules/system/__snapshots__/date.test.ts.snap
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`system - date parsed 1`] = `Date { NaN }`;

exports[`system - date raw 1`] = `"Sat Dec 18 02:17:50 CET 2021"`;
Loading