Sinon-chrome
Sinon-chrome is helper tool for unit-testing chromium and Firefox extensions and apps. It mocks all extensions api with sinon stubs that allows you to run tests in Node.js without actual browser.
Schema support
API mocks are generated using official chromium extensions API (Firefox webextensions) schemas that ensures consistency with real API. Actual schemas are taken from Chrome 53 and Firefox 49.
How it works
Sinon-chrome mocks all chrome api, replaced methods by sinon stubs with some sugar. Chrome events replaced by classes with same behavior, so you can test your event handlers with manual triggering chrome events. All properties has values from chrome schema files.
Install
We recommend use sinon-chrome
on Node.js platform.
npm install sinon-chrome --save-dev
But, if you want...
You can download sinon-chrome
bundle from release page and include it on your page
or
Usage
For mock extensions Api
const chrome = ; // or const chrome = ;
For mock apps Api
const chrome = ; // stable apps api
Examples
Let's write small navigation helper, which use chrome api methods.
const navigationTarget = NEW_WINDOW: 'new-window' NEW_TAB: 'new-tab' CURRENT_TAB: 'current-tab'; /** * Navigate user * @param * @param * @returns */ { }
Test it
; // from 'sinon-chrome';; ;
You can run this example by command
npm run test-navigate
More tests in examples
dir.
stubs api
With original sinon stubs api we add flush
method, which reset stub behavior.
Sinon stub has same method resetBehavior
, but it has some issues.
Example
chromecookiegetAll;chromecookiegetAll; chromecookie; // [3, 4]chromecookie; // [1, 2]chromecookiegetAll;chromecookie; // not calledchromecookie; // not called
events
Let's write module, which depends on chrome events
{ this; } { chrometabsonUpdated; } { chromeruntime; }
And test it
; // from 'sinon-chrome';; ;
You can run this test via
npm run test-events
properties
You can set property values. chrome.flush
reset properties to default values (null
or specified by schema).
Let's create module, which wraps chrome api with Promise. If chrome.runtime.lastError
is set, promise will be rejected.
const api = tabs: /** * Wrapper for chrome.tabs.query * @param * @returns */ { return { chrometabs; }; } ;
And our tests
; // from 'sinon-chrome';;; chai;const assert = chaiassert; ;
You can run this test via
npm run test-then
Plugins
Sinon chrome module supports plugins, that emulates browser behavior. More info on example page.
const chrome = ;const CookiePlugin = CookiePlugin; chrome;
Extension namespaces
- chrome.alarms
- chrome.bookmarks
- chrome.browserAction
- chrome.browsingData
- chrome.commands
- chrome.contentSettings
- chrome.contextMenus
- chrome.cookies
- chrome.debugger
- chrome.declarativeContent
- chrome.desktopCapture
- chrome.devtools
- chrome.dial (undocumented API for communication with DIAL-capable devices)
- chrome.downloads
- chrome.extension
- chrome.extensionTypes
- chrome.fontSettings
- chrome.gcm
- chrome.history
- chrome.i18n
- chrome.identity
- chrome.idle
- chrome.instanceID
- chrome.management
- chrome.notifications
- chrome.omnibox
- chrome.pageAction
- chrome.pageCapture
- chrome.permissions
- chrome.power
- chrome.printerProvider
- chrome.privacy
- chrome.proxy
- chrome.runtime
- chrome.sessions
- chrome.storage
- chrome.system
- chrome.tabCapture
- chrome.tabs
- chrome.topSites
- chrome.tts
- chrome.ttsEngine
- chrome.types
- chrome.webNavigation
- chrome.webRequest
- chrome.webstore
- chrome.windows
Apps namespaces
- chrome.alarms
- chrome.app.runtime
- chrome.app.window
- chrome.bluetooth
- chrome.bluetoothSocket
- chrome.browser
- chrome.commands
- chrome.contextMenus
- chrome.events
- chrome.extensionTypes
- chrome.fileSystem
- chrome.gcm
- chrome.hid
- chrome.i18n
- chrome.identity
- chrome.idle
- chrome.instanceID
- chrome.mdns
- chrome.mediaGalleries
- chrome.notifications
- chrome.permissions
- chrome.power
- chrome.printerProvider
- chrome.runtime
- chrome.serial
- chrome.socket
- chrome.sockets
- chrome.storage
- chrome.syncFileSystem
- chrome.system
- chrome.tts
- chrome.types
- chrome.usb
- chrome.accessibilityFeatures
- chrome.bluetoothLowEnergy
- chrome.documentScan
- chrome.fileSystemProvider
- chrome.vpnProvider
- chrome.wallpaper
Webextensions API
- browser.alarms
- browser.cookies
- browser.downloads
- browser.events
- browser.manifest
- browser.extensionTypes
- browser.extension
- browser.i18n
- browser.idle
- browser.management
- browser.notifications
- browser.runtime
- browser.storage
- browser.test
- browser.webNavigation
- browser.webRequest
- browser.bookmarks
- browser.browserAction
- browser.commands
- browser.contextMenusInternal
- browser.contextMenus
- browser.history
- browser.pageAction
- browser.tabs
- browser.windows
Any questions?
Feel free to open issue.
Useful resources
Awesome Browser Extensions And Apps - a curated list of awesome resources for building browser extensions and apps.