Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Commit

Permalink
test: add process module tests for main process (electron#35057)
Browse files Browse the repository at this point in the history
  • Loading branch information
@nornagon @khalwa
nornagon authored and khalwa committed Feb 22, 2023
1 parent 6e53885 commit d59f169
Showing 1 changed file with 195 additions and 88 deletions.
283 changes: 195 additions & 88 deletions spec-main/api-process-spec.ts
View file
Expand Up @@ -6,119 +6,226 @@ import { defer, ifdescribe } from './spec-helpers';
import { app } from 'electron/main';
import { closeAllWindows } from './window-helpers';

describe('renderer process module', () => {
let w: BrowserWindow;
before(async () => {
w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
await w.loadURL('about:blank');
});
after(closeAllWindows);
describe('process module', () => {
describe('renderer process', () => {
let w: BrowserWindow;
before(async () => {
w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } });
await w.loadURL('about:blank');
});
after(closeAllWindows);

describe('process.getCreationTime()', () => {
it('returns a creation time', async () => {
const creationTime = await w.webContents.executeJavaScript('process.getCreationTime()');
expect(creationTime).to.be.a('number').and.be.at.least(0);
describe('process.getCreationTime()', () => {
it('returns a creation time', async () => {
const creationTime = await w.webContents.executeJavaScript('process.getCreationTime()');
expect(creationTime).to.be.a('number').and.be.at.least(0);
});
});
});

describe('process.getCPUUsage()', () => {
it('returns a cpu usage object', async () => {
const cpuUsage = await w.webContents.executeJavaScript('process.getCPUUsage()');
expect(cpuUsage.percentCPUUsage).to.be.a('number');
expect(cpuUsage.idleWakeupsPerSecond).to.be.a('number');
describe('process.getCPUUsage()', () => {
it('returns a cpu usage object', async () => {
const cpuUsage = await w.webContents.executeJavaScript('process.getCPUUsage()');
expect(cpuUsage.percentCPUUsage).to.be.a('number');
expect(cpuUsage.idleWakeupsPerSecond).to.be.a('number');
});
});
});

ifdescribe(process.platform !== 'darwin')('process.getIOCounters()', () => {
it('returns an io counters object', async () => {
const ioCounters = await w.webContents.executeJavaScript('process.getIOCounters()');
expect(ioCounters.readOperationCount).to.be.a('number');
expect(ioCounters.writeOperationCount).to.be.a('number');
expect(ioCounters.otherOperationCount).to.be.a('number');
expect(ioCounters.readTransferCount).to.be.a('number');
expect(ioCounters.writeTransferCount).to.be.a('number');
expect(ioCounters.otherTransferCount).to.be.a('number');
ifdescribe(process.platform !== 'darwin')('process.getIOCounters()', () => {
it('returns an io counters object', async () => {
const ioCounters = await w.webContents.executeJavaScript('process.getIOCounters()');
expect(ioCounters.readOperationCount).to.be.a('number');
expect(ioCounters.writeOperationCount).to.be.a('number');
expect(ioCounters.otherOperationCount).to.be.a('number');
expect(ioCounters.readTransferCount).to.be.a('number');
expect(ioCounters.writeTransferCount).to.be.a('number');
expect(ioCounters.otherTransferCount).to.be.a('number');
});
});
});

describe('process.getBlinkMemoryInfo()', () => {
it('returns blink memory information object', async () => {
const heapStats = await w.webContents.executeJavaScript('process.getBlinkMemoryInfo()');
expect(heapStats.allocated).to.be.a('number');
expect(heapStats.total).to.be.a('number');
describe('process.getBlinkMemoryInfo()', () => {
it('returns blink memory information object', async () => {
const heapStats = await w.webContents.executeJavaScript('process.getBlinkMemoryInfo()');
expect(heapStats.allocated).to.be.a('number');
expect(heapStats.total).to.be.a('number');
});
});
});

describe('process.getProcessMemoryInfo()', () => {
it('resolves promise successfully with valid data', async () => {
const memoryInfo = await w.webContents.executeJavaScript('process.getProcessMemoryInfo()');
expect(memoryInfo).to.be.an('object');
if (process.platform === 'linux' || process.platform === 'win32') {
expect(memoryInfo.residentSet).to.be.a('number').greaterThan(0);
}
expect(memoryInfo.private).to.be.a('number').greaterThan(0);
// Shared bytes can be zero
expect(memoryInfo.shared).to.be.a('number').greaterThan(-1);
describe('process.getProcessMemoryInfo()', () => {
it('resolves promise successfully with valid data', async () => {
const memoryInfo = await w.webContents.executeJavaScript('process.getProcessMemoryInfo()');
expect(memoryInfo).to.be.an('object');
if (process.platform === 'linux' || process.platform === 'win32') {
expect(memoryInfo.residentSet).to.be.a('number').greaterThan(0);
}
expect(memoryInfo.private).to.be.a('number').greaterThan(0);
// Shared bytes can be zero
expect(memoryInfo.shared).to.be.a('number').greaterThan(-1);
});
});
});

describe('process.getSystemMemoryInfo()', () => {
it('returns system memory info object', async () => {
const systemMemoryInfo = await w.webContents.executeJavaScript('process.getSystemMemoryInfo()');
expect(systemMemoryInfo.free).to.be.a('number');
expect(systemMemoryInfo.total).to.be.a('number');
describe('process.getSystemMemoryInfo()', () => {
it('returns system memory info object', async () => {
const systemMemoryInfo = await w.webContents.executeJavaScript('process.getSystemMemoryInfo()');
expect(systemMemoryInfo.free).to.be.a('number');
expect(systemMemoryInfo.total).to.be.a('number');
});
});
});

describe('process.getSystemVersion()', () => {
it('returns a string', async () => {
const systemVersion = await w.webContents.executeJavaScript('process.getSystemVersion()');
expect(systemVersion).to.be.a('string');
describe('process.getSystemVersion()', () => {
it('returns a string', async () => {
const systemVersion = await w.webContents.executeJavaScript('process.getSystemVersion()');
expect(systemVersion).to.be.a('string');
});
});

describe('process.getHeapStatistics()', () => {
it('returns heap statistics object', async () => {
const heapStats = await w.webContents.executeJavaScript('process.getHeapStatistics()');
expect(heapStats.totalHeapSize).to.be.a('number');
expect(heapStats.totalHeapSizeExecutable).to.be.a('number');
expect(heapStats.totalPhysicalSize).to.be.a('number');
expect(heapStats.totalAvailableSize).to.be.a('number');
expect(heapStats.usedHeapSize).to.be.a('number');
expect(heapStats.heapSizeLimit).to.be.a('number');
expect(heapStats.mallocedMemory).to.be.a('number');
expect(heapStats.peakMallocedMemory).to.be.a('number');
expect(heapStats.doesZapGarbage).to.be.a('boolean');
});
});

describe('process.takeHeapSnapshot()', () => {
it('returns true on success', async () => {
const filePath = path.join(app.getPath('temp'), 'test.heapsnapshot');
defer(() => {
try {
fs.unlinkSync(filePath);
} catch (e) {
// ignore error
}
});

const success = await w.webContents.executeJavaScript(`process.takeHeapSnapshot(${JSON.stringify(filePath)})`);
expect(success).to.be.true();
const stats = fs.statSync(filePath);
expect(stats.size).not.to.be.equal(0);
});

it('returns false on failure', async () => {
const success = await w.webContents.executeJavaScript('process.takeHeapSnapshot("")');
expect(success).to.be.false();
});
});
});

describe('process.getHeapStatistics()', () => {
it('returns heap statistics object', async () => {
const heapStats = await w.webContents.executeJavaScript('process.getHeapStatistics()');
expect(heapStats.totalHeapSize).to.be.a('number');
expect(heapStats.totalHeapSizeExecutable).to.be.a('number');
expect(heapStats.totalPhysicalSize).to.be.a('number');
expect(heapStats.totalAvailableSize).to.be.a('number');
expect(heapStats.usedHeapSize).to.be.a('number');
expect(heapStats.heapSizeLimit).to.be.a('number');
expect(heapStats.mallocedMemory).to.be.a('number');
expect(heapStats.peakMallocedMemory).to.be.a('number');
expect(heapStats.doesZapGarbage).to.be.a('boolean');
describe('process.contextId', () => {
it('is a string', async () => {
const contextId = await w.webContents.executeJavaScript('process.contextId');
expect(contextId).to.be.a('string');
});
});
});

describe('process.takeHeapSnapshot()', () => {
it('returns true on success', async () => {
const filePath = path.join(app.getPath('temp'), 'test.heapsnapshot');
defer(() => {
try {
fs.unlinkSync(filePath);
} catch (e) {
// ignore error
describe('main process', () => {
describe('process.getCreationTime()', () => {
it('returns a creation time', () => {
const creationTime = process.getCreationTime();
expect(creationTime).to.be.a('number').and.be.at.least(0);
});
});

describe('process.getCPUUsage()', () => {
it('returns a cpu usage object', () => {
const cpuUsage = process.getCPUUsage();
expect(cpuUsage.percentCPUUsage).to.be.a('number');
expect(cpuUsage.idleWakeupsPerSecond).to.be.a('number');
});
});

ifdescribe(process.platform !== 'darwin')('process.getIOCounters()', () => {
it('returns an io counters object', () => {
const ioCounters = process.getIOCounters();
expect(ioCounters.readOperationCount).to.be.a('number');
expect(ioCounters.writeOperationCount).to.be.a('number');
expect(ioCounters.otherOperationCount).to.be.a('number');
expect(ioCounters.readTransferCount).to.be.a('number');
expect(ioCounters.writeTransferCount).to.be.a('number');
expect(ioCounters.otherTransferCount).to.be.a('number');
});
});

describe('process.getBlinkMemoryInfo()', () => {
it('returns blink memory information object', () => {
const heapStats = process.getBlinkMemoryInfo();
expect(heapStats.allocated).to.be.a('number');
expect(heapStats.total).to.be.a('number');
});
});

describe('process.getProcessMemoryInfo()', () => {
it('resolves promise successfully with valid data', async () => {
const memoryInfo = await process.getProcessMemoryInfo();
expect(memoryInfo).to.be.an('object');
if (process.platform === 'linux' || process.platform === 'win32') {
expect(memoryInfo.residentSet).to.be.a('number').greaterThan(0);
}
expect(memoryInfo.private).to.be.a('number').greaterThan(0);
// Shared bytes can be zero
expect(memoryInfo.shared).to.be.a('number').greaterThan(-1);
});
});

const success = await w.webContents.executeJavaScript(`process.takeHeapSnapshot(${JSON.stringify(filePath)})`);
expect(success).to.be.true();
const stats = fs.statSync(filePath);
expect(stats.size).not.to.be.equal(0);
describe('process.getSystemMemoryInfo()', () => {
it('returns system memory info object', () => {
const systemMemoryInfo = process.getSystemMemoryInfo();
expect(systemMemoryInfo.free).to.be.a('number');
expect(systemMemoryInfo.total).to.be.a('number');
});
});

it('returns false on failure', async () => {
const success = await w.webContents.executeJavaScript('process.takeHeapSnapshot("")');
expect(success).to.be.false();
describe('process.getSystemVersion()', () => {
it('returns a string', () => {
const systemVersion = process.getSystemVersion();
expect(systemVersion).to.be.a('string');
});
});
});

describe('process.contextId', () => {
it('is a string', async () => {
const contextId = await w.webContents.executeJavaScript('process.contextId');
expect(contextId).to.be.a('string');
describe('process.getHeapStatistics()', () => {
it('returns heap statistics object', async () => {
const heapStats = process.getHeapStatistics();
expect(heapStats.totalHeapSize).to.be.a('number');
expect(heapStats.totalHeapSizeExecutable).to.be.a('number');
expect(heapStats.totalPhysicalSize).to.be.a('number');
expect(heapStats.totalAvailableSize).to.be.a('number');
expect(heapStats.usedHeapSize).to.be.a('number');
expect(heapStats.heapSizeLimit).to.be.a('number');
expect(heapStats.mallocedMemory).to.be.a('number');
expect(heapStats.peakMallocedMemory).to.be.a('number');
expect(heapStats.doesZapGarbage).to.be.a('boolean');
});
});

describe('process.takeHeapSnapshot()', () => {
// TODO(nornagon): this seems to take a really long time when run in the
// main process, for unknown reasons.
it.skip('returns true on success', () => {
const filePath = path.join(app.getPath('temp'), 'test.heapsnapshot');
defer(() => {
try {
fs.unlinkSync(filePath);
} catch (e) {
// ignore error
}
});

const success = process.takeHeapSnapshot(filePath);
expect(success).to.be.true();
const stats = fs.statSync(filePath);
expect(stats.size).not.to.be.equal(0);
});

it('returns false on failure', async () => {
const success = process.takeHeapSnapshot('');
expect(success).to.be.false();
});
});
});
});

0 comments on commit d59f169

Please sign in to comment.