本文へ移動
Senu English

付録: プロジェクト一覧 (任意)

約 3 分で読めます

Senu には記事のほかに、senu serve というもう一つの動き方があります。決まったサンプルのプロジェクト一覧を、Web ページと JSON (プログラムが読むテキストの形式) で、それぞれ別のデモ用の認証情報の後ろに表示します。この付録ではそれを動かし、テストから先にプロジェクトの名前を変えます。講座を終えていることを前提にしています。下のデモ用の認証情報は、自分のコンピューターの中でしか使えません。

一覧を起動する

どちらの動き方もポート 3000 を使うので、先に Ctrl+C でサイトを止めてください。senu serve には認証情報が三つ必要です。コマンドの前に NAME=value と書くと、そのコマンドに環境変数という設定を渡せます。

SENU_WEB_USER=demo SENU_WEB_PASSWORD=demo-password SENU_API_TOKEN=demo-api-token cargo run --quiet -- serve
senu: listening on http://127.0.0.1:3000

一覧を見る

Web ページは http://127.0.0.1:3000/projects にあり、ブラウザーがユーザー名 demo とパスワード demo-password を尋ねます。次のコマンドは名前に「notes」を含むプロジェクトを検索し、grep が一覧の項目だけを残します。プロジェクトの名前にはわざと <script> タグが入っていますが、ノートと同じように文字として表示されます。

curl -s -u demo:demo-password 'http://127.0.0.1:3000/projects?q=notes' | grep 'data-project-id'
<li data-project-id="acme-003">&#60;script&#62;alert(&#39;x&#39;)&#60;/script&#62; &#38; &#34;Launch&#34; Notes</li>

同じ検索を、パスワードの代わりに API トークンを使って JSON で行います。

curl -s -w '\n' -H 'Authorization: Bearer demo-api-token' 'http://127.0.0.1:3000/api/projects?q=notes'
{"projects":[{"id":"acme-003","name":"<script>alert('x')</script> & \"Launch\" Notes"}]}

認証情報はそれぞれ自分の扉しか開けません。API トークンを Web ページに送ると、ステータスコード 401 (Unauthorized、認証されていない) が返ります。

curl -s -o /dev/null -w '%{http_code} %header{www-authenticate}\n' -H 'Authorization: Bearer demo-api-token' 'http://127.0.0.1:3000/projects'
401 Basic realm="senu", charset="UTF-8"

演習: テストから先にプロジェクトの名前を変える

最初のプロジェクトの名前を「Apollo Launch」から「Artemis Launch」に変えます。関数の章と同じように、先にテストを変えます。下の枠はそれぞれ差分 (diff) です。- で始まる行を消し、+ で始まる行を足します。ほかの行は場所の目印です。エディターでそれぞれの変更をしてください。

まず期待する値です。src/catalogue.rs のテスト demo_catalogue_matches_the_spec_table は、すべてのプロジェクトを並べています。

--- a/src/catalogue.rs
+++ b/src/catalogue.rs
@@ -93,7 +93,7 @@
         assert_eq!(
             all,
             vec![
-                ("acme-001", "acme", "Apollo Launch"),
+                ("acme-001", "acme", "Artemis Launch"),
                 ("acme-002", "acme", "Café Roadmap"),
                 (
                     "acme-003",
cargo test --quiet --lib demo_catalogue_matches_the_spec_table

running 1 test
catalogue::tests::demo_catalogue_matches_the_spec_table --- FAILED

failures:

---- catalogue::tests::demo_catalogue_matches_the_spec_table stdout ----

thread 'catalogue::tests::demo_catalogue_matches_the_spec_table' (ID) panicked at src/catalogue.rs:93:9:
assertion `left == right` failed
  left: [("acme-001", "acme", "Apollo Launch"), ("acme-002", "acme", "Café Roadmap"), ("acme-003", "acme", "<script>alert('x')</script> & \"Launch\" Notes"), ("globex-001", "globex", "Globex Launch"), ("globex-002", "globex", "Zephyr Migration")]
 right: [("acme-001", "acme", "Artemis Launch"), ("acme-002", "acme", "Café Roadmap"), ("acme-003", "acme", "<script>alert('x')</script> & \"Launch\" Notes"), ("globex-001", "globex", "Globex Launch"), ("globex-002", "globex", "Zephyr Migration")]
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace


failures:
    catalogue::tests::demo_catalogue_matches_the_spec_table

test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 149 filtered out; finished in 0.00s

error: test failed, to rerun pass `--lib`

正しい理由で red になりました。データがまだ Apollo のままだからです。次に、同じファイルの少し上にあるデータを変えます。

--- a/src/catalogue.rs
+++ b/src/catalogue.rs
@@ -37,7 +37,7 @@
     Project {
         id: "acme-001",
         tenant: TenantId::ACME,
-        name: "Apollo Launch",
+        name: "Artemis Launch",
     },
     Project {
         id: "acme-002",
cargo test --quiet --lib demo_catalogue_matches_the_spec_table

running 1 test
.
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 149 filtered out; finished in 0.00s

tests フォルダーのテストは Senu を外側から HTTP で呼んでいて、そのうち二つがまだ古い名前を期待しています。tests/adapter_http.rs を直します。

--- a/tests/adapter_http.rs
+++ b/tests/adapter_http.rs
@@ -129,7 +129,7 @@
     assert_eq!(
         reply.json(),
         json!({"projects": [
-            {"id": "acme-001", "name": "Apollo Launch"},
+            {"id": "acme-001", "name": "Artemis Launch"},
             {"id": "acme-003", "name": "<script>alert('x')</script> & \"Launch\" Notes"},
         ]})
     );
@@ -298,7 +298,7 @@
     let app = app();
     let reply = send(&app, api_get("/api/projects?q=CAF%C3%89+")).await;
     assert_eq!(ids(&reply.json()), ["acme-002"]);
-    let reply = send(&app, api_get("/api/projects?q=apollo+launch")).await;
+    let reply = send(&app, api_get("/api/projects?q=artemis+launch")).await;
     assert_eq!(ids(&reply.json()), ["acme-001"]);
     let reply = send(&app, api_get("/api/projects?q")).await;
     assert_eq!(ids(&reply.json()), ["acme-001", "acme-002", "acme-003"]);
cargo test --quiet --test adapter_http --test adapter_parity

running 24 tests
........................
test result: ok. 24 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s


running 2 tests
..
test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

解答. 上の三つの差分が解答です。期待する表の名前が一つ、データの名前が一つ、HTTP のテストの 2 か所です。grep -rn Apollo src tests のように古い名前でプロジェクトを検索すると、直すべき場所がすぐに見つかります。

うまくいかないとき

次へ: MCP で Senu を使う