testing

par contentstack

How to run and extend tests — Mocha unit, sanity API, Jest TypeScript; env and mocks.

npx skills add https://github.com/contentstack/contentstack-management-javascript --skill testing

Télécharger ZIP GitHub

Testing – Contentstack Management JavaScript SDK

When to use

Running npm run test:unit, sanity, or Jest.
Adding or changing tests under test/unit/ or test/sanity-check/.
Configuring env vars for live CMA sanity runs.

Instructions

Commands (from `package.json`)

Goal	Command
Lint (pre-test hook)	`npm run lint`
Default `npm test`	Runs `test:api` then `test:unit` — confirm `test:api` exists in your branch; else use `test:unit`
Unit only	`npm run test:unit` — Mocha `test/unit/index.js`, nyc
Unit JSON report	`npm run test:unit:report:json`
Sanity + coverage	`npm run test:sanity-test`
Sanity, no nyc	`npm run test:sanity-nocov`
TypeScript / Jest	`npm run test:typescript`

Always npm run build before sanity if dist/node/contentstack-management.js must match lib/ (sanity imports the built artifact).

Unit tests (`test/unit/`)

Mocha + Chai + @babel/register; 30s timeout per script.
HTTP: mock with Nock, axios-mock-adapter, or stubs — no live CMA.
Suites are required from test/unit/index.js — add new *-test.js files and register them there.

Sanity tests (`test/sanity-check/`)

Live CMA calls; orchestrated by test/sanity-check/sanity.js.
Authoritative env list: test/sanity-check/utility/testSetup.js (and sanity.js).

Environment variables

Required (core) — setup fails without: EMAIL, PASSWORD, HOST, ORGANIZATION.

Suite-specific (tests skip or degrade when missing):

Area	Variables	Notes
OAuth	`CLIENT_ID`, `APP_ID`, `REDIRECT_URI`	`oauth-test.js`
2FA	`TFA_EMAIL`, `TFA_PASSWORD`	`user-test.js`
MFA	`MFA_SECRET`	`user-test.js`
Team / share	`MEMBER_EMAIL`	`team-test.js`, `stack-test.js`
DAM 2.0	`DAM_2_0_ENABLED=true`	`entry-test.js`

Optional: PERSONALIZE_HOST, DELETE_DYNAMIC_RESOURCES (defaults in setup). Set HOST to your CMA API host.

Runtime: setup assigns API_KEY, AUTHTOKEN, MANAGEMENT_TOKEN, etc. — do not commit those.

Jest (`test/typescript/`)

jest.config.js: ts-jest, coverage under coverage/.

Hygiene

No committed only / skip for CI-needed tests.
Never commit real tokens in tests or snapshots.

Plus de skills de contentstack

brand-kit-assistant

Conseiller les utilisateurs sur les concepts, la configuration, la gouvernance et la génération IA conforme à la marque du Contentstack Brand Kit. Router les tâches liées aux API vers la capacité Brand Kit appropriée ou…

Conseiller les développeurs sur l'organisation, la livraison et la transformation des assets dans Contentstack. Couvrir la structure des dossiers, les transformations de l'API de livraison d'images, la publication…

cms-branches-aliases

Advise developers on using Contentstack branches for isolated content development and aliases for zero-downtime content deployments. Cover branch strategy,…

cms-data-modeling-best-practices

Guidez les développeurs pour modéliser le contenu dans Contentstack en utilisant la structure réutilisable la plus simple. La compétence explique quand utiliser les types de contenu, les références, les éléments globaux…

Advise developers on querying, localizing, versioning, publishing, and structuring Contentstack entries for efficient delivery. Focus on CDA usage, reference…

cms-environments-publishing

Conseiller les développeurs sur la configuration des environnements, la publication de contenu, l'utilisation des jetons de livraison et d'aperçu, l'exploitation de l'API Sync, et la compréhension du CDN et…

cms-live-preview-visual-builder-support-assistant

Diagnose and guide Contentstack Live Preview and Visual Builder implementations. Trace preview context, identify the broken contract, and recommend the…

cms-localization

Advise developers on Contentstack localization: language setup, fallback chains, localized vs unlocalized entries, non-localizable fields, and multi-locale…