testing

tarafından contentstack

Testlerin nasıl çalıştırılacağı ve genişletileceği — Mocha birim, sanity API, Jest TypeScript; env ve mock'lar.

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

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)

GoalCommand
Lint (pre-test hook)npm run lint
Default npm testRuns test:api then test:unit — confirm test:api exists in your branch; else use test:unit
Unit onlynpm run test:unit — Mocha test/unit/index.js, nyc
Unit JSON reportnpm run test:unit:report:json
Sanity + coveragenpm run test:sanity-test
Sanity, no nycnpm run test:sanity-nocov
TypeScript / Jestnpm 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):

AreaVariablesNotes
OAuthCLIENT_ID, APP_ID, REDIRECT_URIoauth-test.js
2FATFA_EMAIL, TFA_PASSWORDuser-test.js
MFAMFA_SECRETuser-test.js
Team / shareMEMBER_EMAILteam-test.js, stack-test.js
DAM 2.0DAM_2_0_ENABLED=trueentry-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.

contentstack tarafından daha fazla skill

cms-assets
contentstack
Geliştiricilere Contentstack'te varlıkları düzenleme, teslim etme ve dönüştürme konusunda danışmanlık yapın. Klasör yapısını, Image Delivery API dönüşümlerini, yayınlamayı kapsar…
cms-branches-aliases
contentstack
Geliştiricilere, izole içerik geliştirme için Contentstack branch'lerini kullanma ve kesintisiz içerik dağıtımları için alias'ları kullanma konusunda önerilerde bulunun. Branch stratejisini ele alın,…
cms-data-modeling-best-practices
contentstack
Geliştiricilere Contentstack'te içeriği en basit yeniden kullanılabilir yapıyla modellemeleri için rehberlik eder. Bu beceri, content types, references, global… ne zaman kullanılacağını açıklar.
cms-live-preview-visual-builder-support-assistant
contentstack
Contentstack Live Preview ve Visual Builder uygulamalarını teşhis edin ve yönlendirin. Önizleme bağlamını izleyin, bozuk sözleşmeyi belirleyin ve öneride bulunun…
cms-releases
contentstack
Geliştiricilere, koordineli ve atomik içerik dağıtımı için Contentstack Releases kullanımı konusunda danışmanlık yapın. Release oluşturma, öğe yönetimi, aşamalı dağıtım,…
cms-roles-permissions
contentstack
Contentstack'te roller, izinler, ekipler ve token erişimi tasarlama konusunda geliştiricilere danışmanlık yapın. Yerleşik rolleri, özel rolleri, izin birleştirmeyi açıklayın,…
cms-taxonomy
contentstack
Geliştiricilere, Contentstack Taxonomy’yi yapılandırılmış, hiyerarşik içerik sınıflandırması ve teslimat tarafı filtreleme için kullanma konusunda danışmanlık yapar. Taxonomy ile etiketler arasındaki farkları kapsar,…
cms-tokens-authentication
contentstack
Geliştiricilere, frontend, backend, otomasyon ve üçüncü taraf uygulama kullanım senaryoları için doğru Contentstack kimlik doğrulama yöntemini ve token türünü seçme konusunda danışmanlık yapın.