electron/spec/api-tray-spec.ts
Samuel Attard 27c38bdead
build: add import/order eslint rule (#44107)
build: add import/order eslint rule (#44085)

* build: add import/order eslint rule

* chore: run lint:js --fix
2024-10-02 21:36:15 -07:00

235 lines
7.2 KiB
TypeScript

import { nativeImage } from 'electron/common';
import { Menu, Tray } from 'electron/main';
import { expect } from 'chai';
import * as path from 'node:path';
import { setTimeout } from 'node:timers/promises';
import { ifdescribe, ifit } from './lib/spec-helpers';
describe('tray module', () => {
let tray: Tray;
beforeEach(() => { tray = new Tray(nativeImage.createEmpty()); });
afterEach(() => {
tray.destroy();
tray = null as any;
});
describe('new Tray', () => {
it('sets the correct class name on the prototype', () => {
expect(Tray.prototype.constructor.name).to.equal('Tray');
});
it('throws a descriptive error for a missing file', () => {
const badPath = path.resolve('I', 'Do', 'Not', 'Exist');
expect(() => {
tray = new Tray(badPath);
}).to.throw(/Failed to load image from path (.+)/);
});
ifit(process.platform === 'win32')('throws a descriptive error if an invalid guid is given', () => {
expect(() => {
tray = new Tray(nativeImage.createEmpty(), 'I am not a guid');
}).to.throw('Invalid GUID format');
});
ifit(process.platform === 'win32')('accepts a valid guid', () => {
expect(() => {
tray = new Tray(nativeImage.createEmpty(), '0019A433-3526-48BA-A66C-676742C0FEFB');
}).to.not.throw();
});
it('is an instance of Tray', () => {
expect(tray).to.be.an.instanceOf(Tray);
});
});
ifdescribe(process.platform === 'darwin')('tray get/set ignoreDoubleClickEvents', () => {
it('returns false by default', () => {
const ignored = tray.getIgnoreDoubleClickEvents();
expect(ignored).to.be.false('ignored');
});
it('can be set to true', () => {
tray.setIgnoreDoubleClickEvents(true);
const ignored = tray.getIgnoreDoubleClickEvents();
expect(ignored).to.be.true('not ignored');
});
});
describe('tray.setContextMenu(menu)', () => {
it('accepts both null and Menu as parameters', () => {
expect(() => { tray.setContextMenu(new Menu()); }).to.not.throw();
expect(() => { tray.setContextMenu(null); }).to.not.throw();
});
});
describe('tray.destroy()', () => {
it('destroys a tray', () => {
expect(tray.isDestroyed()).to.be.false('tray should not be destroyed');
tray.destroy();
expect(tray.isDestroyed()).to.be.true('tray should be destroyed');
});
});
describe('tray.popUpContextMenu()', () => {
ifit(process.platform === 'win32')('can be called when menu is showing', async function () {
tray.setContextMenu(Menu.buildFromTemplate([{ label: 'Test' }]));
const timeout = setTimeout();
tray.popUpContextMenu();
await timeout;
tray.popUpContextMenu();
});
it('can be called with a menu', () => {
const menu = Menu.buildFromTemplate([{ label: 'Test' }]);
expect(() => {
tray.popUpContextMenu(menu);
}).to.not.throw();
});
it('can be called with a position', () => {
expect(() => {
tray.popUpContextMenu({ x: 0, y: 0 } as any);
}).to.not.throw();
});
it('can be called with a menu and a position', () => {
const menu = Menu.buildFromTemplate([{ label: 'Test' }]);
expect(() => {
tray.popUpContextMenu(menu, { x: 0, y: 0 });
}).to.not.throw();
});
it('throws an error on invalid arguments', () => {
expect(() => {
tray.popUpContextMenu({} as any);
}).to.throw(/index 0/);
const menu = Menu.buildFromTemplate([{ label: 'Test' }]);
expect(() => {
tray.popUpContextMenu(menu, {} as any);
}).to.throw(/index 1/);
});
});
describe('tray.closeContextMenu()', () => {
ifit(process.platform === 'win32')('does not crash when called more than once', async function () {
tray.setContextMenu(Menu.buildFromTemplate([{ label: 'Test' }]));
const timeout = setTimeout();
tray.popUpContextMenu();
await timeout;
tray.closeContextMenu();
tray.closeContextMenu();
});
});
describe('tray.getBounds()', () => {
afterEach(() => { tray.destroy(); });
ifit(process.platform !== 'linux')('returns a bounds object', function () {
const bounds = tray.getBounds();
expect(bounds).to.be.an('object').and.to.have.all.keys('x', 'y', 'width', 'height');
});
});
describe('tray.setImage(image)', () => {
it('throws a descriptive error for a missing file', () => {
const badPath = path.resolve('I', 'Do', 'Not', 'Exist');
expect(() => {
tray.setImage(badPath);
}).to.throw(/Failed to load image from path (.+)/);
});
it('accepts empty image', () => {
tray.setImage(nativeImage.createEmpty());
});
});
describe('tray.setPressedImage(image)', () => {
it('throws a descriptive error for a missing file', () => {
const badPath = path.resolve('I', 'Do', 'Not', 'Exist');
expect(() => {
tray.setPressedImage(badPath);
}).to.throw(/Failed to load image from path (.+)/);
});
it('accepts empty image', () => {
tray.setPressedImage(nativeImage.createEmpty());
});
});
ifdescribe(process.platform === 'win32')('tray.displayBalloon(image)', () => {
it('throws a descriptive error for a missing file', () => {
const badPath = path.resolve('I', 'Do', 'Not', 'Exist');
expect(() => {
tray.displayBalloon({
title: 'title',
content: 'wow content',
icon: badPath
});
}).to.throw(/Failed to load image from path (.+)/);
});
it('accepts an empty image', () => {
tray.displayBalloon({
title: 'title',
content: 'wow content',
icon: nativeImage.createEmpty()
});
});
});
ifdescribe(process.platform === 'darwin')('tray get/set title', () => {
it('sets/gets non-empty title', () => {
const title = 'Hello World!';
tray.setTitle(title);
const newTitle = tray.getTitle();
expect(newTitle).to.equal(title);
});
it('sets/gets empty title', () => {
const title = '';
tray.setTitle(title);
const newTitle = tray.getTitle();
expect(newTitle).to.equal(title);
});
it('can have an options object passed in', () => {
expect(() => {
tray.setTitle('Hello World!', {});
}).to.not.throw();
});
it('throws when the options parameter is not an object', () => {
expect(() => {
tray.setTitle('Hello World!', 'test' as any);
}).to.throw(/setTitle options must be an object/);
});
it('can have a font type option set', () => {
expect(() => {
tray.setTitle('Hello World!', { fontType: 'monospaced' });
tray.setTitle('Hello World!', { fontType: 'monospacedDigit' });
}).to.not.throw();
});
it('throws when the font type is specified but is not a string', () => {
expect(() => {
tray.setTitle('Hello World!', { fontType: 5.4 as any });
}).to.throw(/fontType must be one of 'monospaced' or 'monospacedDigit'/);
});
it('throws on invalid font types', () => {
expect(() => {
tray.setTitle('Hello World!', { fontType: 'blep' as any });
}).to.throw(/fontType must be one of 'monospaced' or 'monospacedDigit'/);
});
});
});