const assert = require('assert') const ChildProcess = require('child_process') const https = require('https') const net = require('net') const fs = require('fs') const path = require('path') const {ipcRenderer, remote} = require('electron') const {closeWindow} = require('./window-helpers') const {app, BrowserWindow, ipcMain} = remote const isCI = remote.getGlobal('isCi') describe('electron module', function () { it('does not expose internal modules to require', function () { assert.throws(function () { require('clipboard') }, /Cannot find module 'clipboard'/) }) describe('require("electron")', function () { let window = null beforeEach(function () { window = new BrowserWindow({ show: false, width: 400, height: 400 }) }) afterEach(function () { return closeWindow(window).then(function () { window = null }) }) it('always returns the internal electron module', function (done) { ipcMain.once('answer', function () { done() }) window.loadURL('file://' + path.join(__dirname, 'fixtures', 'api', 'electron-module-app', 'index.html')) }) }) }) describe('app module', function () { let server, secureUrl const certPath = path.join(__dirname, 'fixtures', 'certificates') before(function () { const options = { key: fs.readFileSync(path.join(certPath, 'server.key')), cert: fs.readFileSync(path.join(certPath, 'server.pem')), ca: [ fs.readFileSync(path.join(certPath, 'rootCA.pem')), fs.readFileSync(path.join(certPath, 'intermediateCA.pem')) ], requestCert: true, rejectUnauthorized: false } server = https.createServer(options, function (req, res) { if (req.client.authorized) { res.writeHead(200) res.end('authorized') } else { res.writeHead(401) res.end('denied') } }) server.listen(0, '127.0.0.1', function () { const port = server.address().port secureUrl = `https://127.0.0.1:${port}` }) }) after(function () { server.close() }) describe('app.getVersion()', function () { it('returns the version field of package.json', function () { assert.equal(app.getVersion(), '0.1.0') }) }) describe('app.setVersion(version)', function () { it('overrides the version', function () { assert.equal(app.getVersion(), '0.1.0') app.setVersion('test-version') assert.equal(app.getVersion(), 'test-version') app.setVersion('0.1.0') }) }) describe('app.getName()', function () { it('returns the name field of package.json', function () { assert.equal(app.getName(), 'Electron Test') }) }) describe('app.setName(name)', function () { it('overrides the name', function () { assert.equal(app.getName(), 'Electron Test') app.setName('test-name') assert.equal(app.getName(), 'test-name') app.setName('Electron Test') }) }) describe('app.getLocale()', function () { it('should not be empty', function () { assert.notEqual(app.getLocale(), '') }) }) describe('app.isInApplicationsFolder()', function () { it('should be false during tests', function () { if (process.platform !== 'darwin') return assert.equal(app.isInApplicationsFolder(), false) }) }) describe('app.exit(exitCode)', function () { var appProcess = null afterEach(function () { if (appProcess != null) appProcess.kill() }) it('emits a process exit event with the code', function (done) { var appPath = path.join(__dirname, 'fixtures', 'api', 'quit-app') var electronPath = remote.getGlobal('process').execPath var output = '' appProcess = ChildProcess.spawn(electronPath, [appPath]) appProcess.stdout.on('data', function (data) { output += data }) appProcess.on('close', function (code) { if (process.platform !== 'win32') { assert.notEqual(output.indexOf('Exit event with code: 123'), -1) } assert.equal(code, 123) done() }) }) it('closes all windows', function (done) { var appPath = path.join(__dirname, 'fixtures', 'api', 'exit-closes-all-windows-app') var electronPath = remote.getGlobal('process').execPath appProcess = ChildProcess.spawn(electronPath, [appPath]) appProcess.on('close', function (code) { assert.equal(code, 123) done() }) }) }) describe('app.relaunch', function () { let server = null const socketPath = process.platform === 'win32' ? '\\\\.\\pipe\\electron-app-relaunch' : '/tmp/electron-app-relaunch' beforeEach(function (done) { fs.unlink(socketPath, () => { server = net.createServer() server.listen(socketPath) done() }) }) afterEach(function (done) { server.close(() => { if (process.platform === 'win32') { done() } else { fs.unlink(socketPath, () => { done() }) } }) }) it('relaunches the app', function (done) { this.timeout(120000) let state = 'none' server.once('error', (error) => { done(error) }) server.on('connection', (client) => { client.once('data', function (data) { if (String(data) === 'false' && state === 'none') { state = 'first-launch' } else if (String(data) === 'true' && state === 'first-launch') { done() } else { done(`Unexpected state: ${state}`) } }) }) const appPath = path.join(__dirname, 'fixtures', 'api', 'relaunch') ChildProcess.spawn(remote.process.execPath, [appPath]) }) }) describe('app.setUserActivity(type, userInfo)', function () { if (process.platform !== 'darwin') { return } it('sets the current activity', function () { app.setUserActivity('com.electron.testActivity', {testData: '123'}) assert.equal(app.getCurrentActivityType(), 'com.electron.testActivity') }) }) xdescribe('app.importCertificate', function () { if (process.platform !== 'linux') return var w = null afterEach(function () { return closeWindow(w).then(function () { w = null }) }) it('can import certificate into platform cert store', function (done) { let options = { certificate: path.join(certPath, 'client.p12'), password: 'electron' } w = new BrowserWindow({ show: false }) w.webContents.on('did-finish-load', function () { assert.equal(w.webContents.getTitle(), 'authorized') done() }) ipcRenderer.once('select-client-certificate', function (event, webContentsId, list) { assert.equal(webContentsId, w.webContents.id) assert.equal(list.length, 1) assert.equal(list[0].issuerName, 'Intermediate CA') assert.equal(list[0].subjectName, 'Client Cert') assert.equal(list[0].issuer.commonName, 'Intermediate CA') assert.equal(list[0].subject.commonName, 'Client Cert') event.sender.send('client-certificate-response', list[0]) }) app.importCertificate(options, function (result) { assert(!result) ipcRenderer.sendSync('set-client-certificate-option', false) w.loadURL(secureUrl) }) }) }) describe('BrowserWindow events', function () { var w = null afterEach(function () { return closeWindow(w).then(function () { w = null }) }) it('should emit browser-window-focus event when window is focused', function (done) { app.once('browser-window-focus', function (e, window) { assert.equal(w.id, window.id) done() }) w = new BrowserWindow({ show: false }) w.emit('focus') }) it('should emit browser-window-blur event when window is blured', function (done) { app.once('browser-window-blur', function (e, window) { assert.equal(w.id, window.id) done() }) w = new BrowserWindow({ show: false }) w.emit('blur') }) it('should emit browser-window-created event when window is created', function (done) { app.once('browser-window-created', function (e, window) { setImmediate(function () { assert.equal(w.id, window.id) done() }) }) w = new BrowserWindow({ show: false }) }) it('should emit web-contents-created event when a webContents is created', function (done) { app.once('web-contents-created', function (e, webContents) { setImmediate(function () { assert.equal(w.webContents.id, webContents.id) done() }) }) w = new BrowserWindow({ show: false }) }) }) describe('app.setBadgeCount API', function () { const shouldFail = process.platform === 'win32' || (process.platform === 'linux' && !app.isUnityRunning()) afterEach(function () { app.setBadgeCount(0) }) it('returns false when failed', function () { assert.equal(app.setBadgeCount(42), !shouldFail) }) it('should set a badge count', function () { app.setBadgeCount(42) assert.equal(app.getBadgeCount(), shouldFail ? 0 : 42) }) }) describe('app.get/setLoginItemSettings API', function () { if (process.platform === 'linux') return const updateExe = path.resolve(path.dirname(process.execPath), '..', 'Update.exe') const processStartArgs = [ '--processStart', `"${path.basename(process.execPath)}"`, '--process-start-args', `"--hidden"` ] beforeEach(function () { app.setLoginItemSettings({openAtLogin: false}) app.setLoginItemSettings({openAtLogin: false, path: updateExe, args: processStartArgs}) }) afterEach(function () { app.setLoginItemSettings({openAtLogin: false}) app.setLoginItemSettings({openAtLogin: false, path: updateExe, args: processStartArgs}) }) it('returns the login item status of the app', function () { app.setLoginItemSettings({openAtLogin: true}) assert.deepEqual(app.getLoginItemSettings(), { openAtLogin: true, openAsHidden: false, wasOpenedAtLogin: false, wasOpenedAsHidden: false, restoreState: false }) app.setLoginItemSettings({openAtLogin: true, openAsHidden: true}) assert.deepEqual(app.getLoginItemSettings(), { openAtLogin: true, openAsHidden: process.platform === 'darwin', // Only available on macOS wasOpenedAtLogin: false, wasOpenedAsHidden: false, restoreState: false }) app.setLoginItemSettings({}) assert.deepEqual(app.getLoginItemSettings(), { openAtLogin: false, openAsHidden: false, wasOpenedAtLogin: false, wasOpenedAsHidden: false, restoreState: false }) }) it('allows you to pass a custom executable and arguments', () => { if (process.platform !== 'win32') return app.setLoginItemSettings({openAtLogin: true, path: updateExe, args: processStartArgs}) assert.equal(app.getLoginItemSettings().openAtLogin, false) assert.equal(app.getLoginItemSettings({path: updateExe, args: processStartArgs}).openAtLogin, true) }) }) describe('isAccessibilitySupportEnabled API', function () { it('returns whether the Chrome has accessibility APIs enabled', function () { assert.equal(typeof app.isAccessibilitySupportEnabled(), 'boolean') }) }) describe('getPath(name)', function () { it('returns paths that exist', function () { assert.equal(fs.existsSync(app.getPath('exe')), true) assert.equal(fs.existsSync(app.getPath('home')), true) assert.equal(fs.existsSync(app.getPath('temp')), true) }) it('throws an error when the name is invalid', function () { assert.throws(function () { app.getPath('does-not-exist') }, /Failed to get 'does-not-exist' path/) }) it('returns the overridden path', function () { app.setPath('music', __dirname) assert.equal(app.getPath('music'), __dirname) }) }) xdescribe('select-client-certificate event', function () { let w = null beforeEach(function () { w = new BrowserWindow({ show: false, webPreferences: { partition: 'empty-certificate' } }) }) afterEach(function () { return closeWindow(w).then(function () { w = null }) }) it('can respond with empty certificate list', function (done) { w.webContents.on('did-finish-load', function () { assert.equal(w.webContents.getTitle(), 'denied') server.close() done() }) ipcRenderer.sendSync('set-client-certificate-option', true) w.webContents.loadURL(secureUrl) }) }) describe('setAsDefaultProtocolClient(protocol, path, args)', () => { if (process.platform !== 'win32') return const protocol = 'electron-test' const updateExe = path.resolve(path.dirname(process.execPath), '..', 'Update.exe') const processStartArgs = [ '--processStart', `"${path.basename(process.execPath)}"`, '--process-start-args', `"--hidden"` ] beforeEach(() => { app.removeAsDefaultProtocolClient(protocol) app.removeAsDefaultProtocolClient(protocol, updateExe, processStartArgs) }) afterEach(() => { app.removeAsDefaultProtocolClient(protocol) assert.equal(app.isDefaultProtocolClient(protocol), false) app.removeAsDefaultProtocolClient(protocol, updateExe, processStartArgs) assert.equal(app.isDefaultProtocolClient(protocol, updateExe, processStartArgs), false) }) it('sets the app as the default protocol client', () => { assert.equal(app.isDefaultProtocolClient(protocol), false) app.setAsDefaultProtocolClient(protocol) assert.equal(app.isDefaultProtocolClient(protocol), true) }) it('allows a custom path and args to be specified', () => { assert.equal(app.isDefaultProtocolClient(protocol, updateExe, processStartArgs), false) app.setAsDefaultProtocolClient(protocol, updateExe, processStartArgs) assert.equal(app.isDefaultProtocolClient(protocol, updateExe, processStartArgs), true) assert.equal(app.isDefaultProtocolClient(protocol), false) }) }) describe('getFileIcon() API', function () { // FIXME Get these specs running on Linux CI if (process.platform === 'linux' && isCI) return const iconPath = path.join(__dirname, 'fixtures/assets/icon.ico') const sizes = { small: 16, normal: 32, large: process.platform === 'win32' ? 32 : 48 } it('fetches a non-empty icon', function (done) { app.getFileIcon(iconPath, function (err, icon) { assert.equal(err, null) assert.equal(icon.isEmpty(), false) done() }) }) it('fetches normal icon size by default', function (done) { app.getFileIcon(iconPath, function (err, icon) { const size = icon.getSize() assert.equal(err, null) assert.equal(size.height, sizes.normal) assert.equal(size.width, sizes.normal) done() }) }) describe('size option', function () { it('fetches a small icon', function (done) { app.getFileIcon(iconPath, { size: 'small' }, function (err, icon) { const size = icon.getSize() assert.equal(err, null) assert.equal(size.height, sizes.small) assert.equal(size.width, sizes.small) done() }) }) it('fetches a normal icon', function (done) { app.getFileIcon(iconPath, { size: 'normal' }, function (err, icon) { const size = icon.getSize() assert.equal(err, null) assert.equal(size.height, sizes.normal) assert.equal(size.width, sizes.normal) done() }) }) it('fetches a large icon', function (done) { // macOS does not support large icons if (process.platform === 'darwin') return done() app.getFileIcon(iconPath, { size: 'large' }, function (err, icon) { const size = icon.getSize() assert.equal(err, null) assert.equal(size.height, sizes.large) assert.equal(size.width, sizes.large) done() }) }) }) }) describe('getAppMetrics() API', function () { it('returns memory and cpu stats of all running electron processes', function () { const appMetrics = app.getAppMetrics() assert.ok(appMetrics.length > 0, 'App memory info object is not > 0') const types = [] for (const {memory, pid, type, cpu} of appMetrics) { assert.ok(memory.workingSetSize > 0, 'working set size is not > 0') assert.ok(memory.privateBytes > 0, 'private bytes is not > 0') assert.ok(memory.sharedBytes > 0, 'shared bytes is not > 0') assert.ok(pid > 0, 'pid is not > 0') assert.ok(type.length > 0, 'process type is null') types.push(type) assert.equal(typeof cpu.percentCPUUsage, 'number') assert.equal(typeof cpu.idleWakeupsPerSecond, 'number') } if (process.platform === 'darwin') { assert.ok(types.includes('GPU')) } assert.ok(types.includes('Browser')) assert.ok(types.includes('Tab')) }) }) describe('getGPUFeatureStatus() API', function () { it('returns the graphic features statuses', function () { const features = app.getGPUFeatureStatus() assert.equal(typeof features.webgl, 'string') assert.equal(typeof features.gpu_compositing, 'string') }) }) describe('mixed sandbox option', function () { // FIXME Get these specs running on Linux if (process.platform === 'linux') return let appProcess = null let server = null const socketPath = process.platform === 'win32' ? '\\\\.\\pipe\\electron-mixed-sandbox' : '/tmp/electron-mixed-sandbox' beforeEach(function (done) { fs.unlink(socketPath, () => { server = net.createServer() server.listen(socketPath) done() }) }) afterEach(function (done) { if (appProcess != null) { appProcess.kill() } server.close(() => { if (process.platform === 'win32') { done() } else { fs.unlink(socketPath, () => { done() }) } }) }) describe('when app.enableMixedSandbox() is called', () => { it('adds --enable-sandbox to render processes created with sandbox: true', (done) => { const appPath = path.join(__dirname, 'fixtures', 'api', 'mixed-sandbox-app') appProcess = ChildProcess.spawn(remote.process.execPath, [appPath]) server.once('error', (error) => { done(error) }) server.on('connection', (client) => { client.once('data', function (data) { const argv = JSON.parse(data) assert.equal(argv.sandbox.includes('--enable-sandbox'), true) assert.equal(argv.sandbox.includes('--no-sandbox'), false) assert.equal(argv.noSandbox.includes('--enable-sandbox'), false) assert.equal(argv.noSandbox.includes('--no-sandbox'), true) done() }) }) }) }) describe('when the app is launched with --enable-mixed-sandbox', () => { it('adds --enable-sandbox to render processes created with sandbox: true', (done) => { const appPath = path.join(__dirname, 'fixtures', 'api', 'mixed-sandbox-app') appProcess = ChildProcess.spawn(remote.process.execPath, [appPath, '--enable-mixed-sandbox']) server.once('error', (error) => { done(error) }) server.on('connection', (client) => { client.once('data', function (data) { const argv = JSON.parse(data) assert.equal(argv.sandbox.includes('--enable-sandbox'), true) assert.equal(argv.sandbox.includes('--no-sandbox'), false) assert.equal(argv.noSandbox.includes('--enable-sandbox'), false) assert.equal(argv.noSandbox.includes('--no-sandbox'), true) assert.equal(argv.noSandboxDevtools, true) assert.equal(argv.sandboxDevtools, true) done() }) }) }) }) }) describe('disableDomainBlockingFor3DAPIs() API', function () { it('throws when called after app is ready', function () { assert.throws(function () { app.disableDomainBlockingFor3DAPIs() }, /before app is ready/) }) }) })