公開チェックを、自動テストで何度も確かめる
実際のEmDashの保存・公開処理を使い、下書き保存、公開拒否、修正後の公開を確認します。
目次
自動テストを使うと、「下書きは保存できる」「要約が空なら公開できない」という動作を、コードを変えるたびに繰り返し確かめられます。
今回は、一時的なデータを使って、テスト用EmDashの保存・公開処理を実行します。実習サイトの記事を消したり増やしたりせずに試せます。
先に用意するもの
共通の練習用サイトを準備します。教材の publish-check がプラグイン、weekend-note がそれを使うサイトです。完成コードは教材に入っています。このページでは、該当する処理を読んで動かし、一部を変更して確かめます。
対象はEmDash 1.4.0、プラグインCLI 0.13.5、テスト用パッケージ 0.2.11、Vitest 4.1.0、Node.js 24.22.1です。macOSで実行しました。Windowsで試す場合はコマンドプロンプトを使ってください。Windows実機での確認はまだ行っていません。
1. テストの設定を確認する
publish-check/vitest.config.ts は次の設定です。Vitestは、確認手順をコードにして実行する道具です。
import { emdashPluginTest } from "@emdash-cms/plugin-test/config";
import { defineConfig } from "vitest/config";
export default defineConfig({
plugins: [emdashPluginTest()],
});emdashPluginTest() が、プラグインを動かすテスト環境を用意します。依存する道具は教材の package-lock.json に版を固定しています。最初の準備で npm ci が終わっていれば、追加のインストールは不要です。
2. 保存・公開を確認するテストを読む
publish-check/tests/plugin.test.ts の最初には、毎回新しい環境と記事の入力欄を作る準備があります。
import { afterEach, beforeEach, expect, it } from 'vitest';
import { createPluginRuntimeTestHost, type PluginRuntimeTestHost } from '@emdash-cms/plugin-test';
let host: PluginRuntimeTestHost;
beforeEach(async () => {
host = await createPluginRuntimeTestHost();
await host.fixtures.collection({ slug: 'posts', label: '記事', supports: ['drafts', 'revisions'], fields: [
{ slug: 'title', label: 'タイトル', type: 'string', required: true },
{ slug: 'excerpt', label: '要約', type: 'text' },
] });
});
afterEach(async () => { await host?.dispose(); });beforeEach は各テストの前、afterEach は後に行うことです。dispose() で、使い終えた環境を片付けます。expect は「この結果になるはず」という条件を表します。
同じファイルにある、空欄の公開を止めるテストは次のとおりです。
it('空の要約でも下書きは保存でき、公開は拒否する', async () => {
const created = await host.actions.content.create('posts', { data: { title: '散歩', excerpt: ' ' } });
expect(created.success).toBe(true);
if (!created.success) throw new Error('作成に失敗');
await host.waitForDeferredTasks();
const result = await host.actions.content.publish('posts', created.data.item.id, { _rev: created.data._rev });
expect(result).toMatchObject({ success: false, error: { code: 'PUBLISH_REJECTED' } });
expect((await host.inspect.content.get('posts', created.data.item.id))?.status).toBe('draft');
});created.success で下書き保存が成功したことを確認し、その後に公開を試みます。PUBLISH_REJECTED は公開が拒否されたという結果です。最後に、記事が draft、つまり下書きのままかも見ています。
waitForDeferredTasks() は、保存後に続けて実行される処理が終わるのを待ちます。処理が終わる前の値を読んで、記録の失敗と判断しないように待ちます。
3. 6件のテストを実行する
publish-check のコマンド入力画面で実行します。
npm testTests 6 passed (6) が成功の目印です。内容は、保存と公開の区別、空白の公開拒否、パネルの空欄表示、通知の503失敗、通知の200成功、要約を直した後の公開です。6件すべてが通ることを確認しました。
テストの名前を絞る場合は、次のようにします。
npm test -- -t "空の要約でも下書きは保存でき、公開は拒否する"4. テストが失敗を見つけるか考える
例えば公開チェックを誤って削除すると、空欄の記事が公開され、拒否を期待するテストが失敗します。成功するケースだけでなく、止まるべきケースも残しておく理由です。
エラーが出たら、最初に失敗したテスト名と expected(期待)・received(実際)の違いを読みます。実行環境自体が起動できない場合は、Node.jsの版と npm ci の完了を確認します。
このテストだけでは、ブラウザー上の配置や本番の通信までは確認できません。パネルは管理画面で、外部通知は接続先を用意した検証環境でも、別途確認します。
終了と再実行
npm test は1回実行して終了します。コードを変えたら同じ命令で再実行できます。テストだけなら、4350のサイトを起動しておく必要はありません。