Écrire des tests unitaires pour les extensions
Mettez en œuvre des tests unitaires pour la logique de votre extension à l’aide de frameworks de test JavaScript populaires afin d’en garantir la fiabilité.
Écrire des tests unitaires pour les extensions est une leçon Browser Extensions Development (Chrome & Edge) gratuite sur CoddyKit. Ceci est la leçon 2 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Browser Extensions Development (Chrome & Edge), et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Browser Extensions Development (Chrome & Edge) comprend 4 leçons au total.
Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.
Intro to Unit Testing
Welcome! In this lesson, we'll dive into unit testing for browser extensions. Unit testing is a way to test small, isolated parts of your code, often called "units."
For extensions, this means testing individual functions or modules without needing to run the full browser environment. It's about ensuring each piece works correctly on its own.
Why Test Extensions?
Testing is crucial for building robust browser extensions. Here's why:
- Reliability: Catches bugs early, ensuring your extension works as expected.
- Maintainability: Makes future changes safer, preventing accidental breakage (regressions).
- API Changes: Helps adapt to updates in browser APIs (like Manifest V3 changes).
- Complex Logic: Ensures tricky background or content script logic is sound.
Pick Your Test Framework
Several JavaScript frameworks help you write and run tests. Popular choices include:
- Jest: A complete testing solution from Facebook, known for its ease of use and built-in mocking.
- Mocha: A flexible test runner, often paired with an assertion library like Chai.
- Vitest: A fast, modern alternative built on Vite.
For this lesson, we'll use Jest due to its popularity and comprehensive features.
Set Up Jest for Testing
To get started, create a project folder and initialize it with npm. Then, install Jest as a development dependency:
npm init -y
npm install --save-dev jestNext, add a test script to your package.json file so you can easily run tests:
{
"name": "my-extension-tests",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "jest"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"jest": "^29.0.0" // Version may vary
}
}Test Pure JavaScript Logic
Let's write a simple utility function that might be part of your extension's logic. Create a file named utils.js:
// utils.js
function sum(a, b) {
return a + b;
}
function capitalize(str) {
if (!str) return '';
return str.charAt(0).toUpperCase() + str.slice(1);
}
module.exports = { sum, capitalize };Writing Your First Test
Now, create a test file named utils.test.js. Jest automatically finds files ending with .test.js or .spec.js.
We'll import our functions and use Jest's test (or it) and expect syntax to define and check our tests. Try running this example!
// utils.test.js
const { sum, capitalize } = require('./utils');
test('sums two numbers correctly', () => {
expect(sum(1, 2)).toBe(3);
expect(sum(-1, 1)).toBe(0);
});
test('capitalizes a string', () => {
expect(capitalize('hello')).toBe('Hello');
expect(capitalize('world')).toBe('World');
expect(capitalize('')).toBe('');
});
// To run these tests, execute: npm testThe Challenge of Chrome APIs
Browser extensions rely heavily on the chrome.* APIs (e.g., chrome.storage, chrome.tabs). These APIs are only available within a browser environment.
When running unit tests outside a browser (like with Node.js-based Jest), the chrome object will be undefined. To test logic that uses these APIs, we need to mock them.
Mocking means creating a simulated version of an object or function to control its behavior during a test.
Mocking chrome.storage
Let's create a utility that uses chrome.storage.local. This function would typically be in your background script or another module.
First, our utility function (e.g., in storageUtils.js):
// storageUtils.js
async function saveSetting(key, value) {
if (typeof chrome !== 'undefined' && chrome.storage && chrome.storage.local) {
await chrome.storage.local.set({ [key]: value });
return true;
}
// Fallback for non-browser environments or missing API
console.warn('chrome.storage.local not available');
return false;
}
async function getSetting(key) {
if (typeof chrome !== 'undefined' && chrome.storage && chrome.storage.local) {
const result = await chrome.storage.local.get(key);
return result[key];
}
// Fallback
console.warn('chrome.storage.local not available');
return undefined;
}
module.exports = { saveSetting, getSetting };Testing with Mocked APIs
Now, let's write a test for our storageUtils.js. We'll create a mock for chrome.storage.local before each test to simulate its behavior.
Jest's jest.fn() is perfect for creating mock functions and tracking their calls. Try running this test!
// storageUtils.test.js
const { saveSetting, getSetting } = require('./storageUtils');
// Mock chrome.storage.local globally for tests
const mockStorage = {};
global.chrome = {
storage: {
local: {
set: jest.fn(async (obj) => {
Object.assign(mockStorage, obj);
return Promise.resolve();
}),
get: jest.fn(async (key) => {
return Promise.resolve({ [key]: mockStorage[key] });
}),
},
},
};
beforeEach(() => {
// Reset mock storage and clear Jest mock calls before each test
for (const key in mockStorage) { delete mockStorage[key]; }
chrome.storage.local.set.mockClear();
chrome.storage.local.get.mockClear();
});
test('saveSetting saves data to chrome.storage.local', async () => {
await saveSetting('username', 'CoddyKit');
expect(chrome.storage.local.set).toHaveBeenCalledWith({ username: 'CoddyKit' });
expect(mockStorage.username).toBe('CoddyKit');
});
test('getSetting retrieves data from chrome.storage.local', async () => {
mockStorage.username = 'CoddyKit'; // Pre-set mock storage
const username = await getSetting('username');
expect(chrome.storage.local.get).toHaveBeenCalledWith('username');
expect(username).toBe('CoddyKit');
});
// To run these tests, execute: npm testQuick Check: Unit Testing
You've learned about unit testing and how to mock browser APIs. Which of the following statements is TRUE about unit testing browser extension logic?
Recap: Unit Testing
In this lesson, you learned:
- The importance of unit testing for browser extensions.
- How to set up a testing environment using Jest.
- How to write unit tests for pure JavaScript functions.
- The concept and practice of mocking
chrome.*APIs to test extension logic outside the browser.
Unit testing is a critical skill for building robust and maintainable extensions. Keep practicing to ensure your extension's core logic is always solid!
Questions Fréquemment Posées
La leçon « Écrire des tests unitaires pour les extensions » est-elle gratuite ?
Oui — le texte complet de « Écrire des tests unitaires pour les extensions » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Browser Extensions Development (Chrome & Edge), passe à CoddyKit PRO. Le cours Browser Extensions Development (Chrome & Edge) comprend 4 leçons au total.
Qu'est-ce que j'apprendrai dans « Écrire des tests unitaires pour les extensions » ?
Mettez en œuvre des tests unitaires pour la logique de votre extension à l’aide de frameworks de test JavaScript populaires afin d’en garantir la fiabilité. Tu pratiques Browser Extensions Development (Chrome & Edge) avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.
Dois-je avoir de l'expérience pour commencer Browser Extensions Development (Chrome & Edge) ?
Aucune expérience préalable n'est requise. Browser Extensions Development (Chrome & Edge) sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 2 sur 4.
Combien de temps prend la leçon « Écrire des tests unitaires pour les extensions » ?
La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.
Peux-tu écrire et exécuter du code dans cette leçon Browser Extensions Development (Chrome & Edge) ?
Oui. Chaque leçon Browser Extensions Development (Chrome & Edge) inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.
Toutes les leçons de ce cours
- Déboguer les composants d’une extension
- Écrire des tests unitaires pour les extensions
- Stratégies d’optimisation des performances
- Journalisation, signalement des erreurs et diagnostics