diff options
Diffstat (limited to 'tests')
| -rwxr-xr-x | tests/cli.test.sh | 82 | ||||
| -rwxr-xr-x | tests/conventional-commits.test.sh | 42 | ||||
| -rw-r--r-- | tests/helpers.test.mjs | 113 | ||||
| -rwxr-xr-x | tests/run.sh | 16 |
4 files changed, 250 insertions, 3 deletions
diff --git a/tests/cli.test.sh b/tests/cli.test.sh index aefb371..d3f8d88 100755 --- a/tests/cli.test.sh +++ b/tests/cli.test.sh @@ -1,19 +1,29 @@ #!/usr/bin/env bash -# Smoke tests for icloud-note CLI (no Apple login / network create required). +# CLI smoke + dry-run tests (no Apple network / no visible browser). set -euo pipefail ROOT="$(cd "$(dirname "$0")/.." && pwd)" CLI=(node "$ROOT/scripts/icloud-note.mjs") +TMP="$(mktemp -d)" +trap 'rm -rf "$TMP"' EXIT +export ICLOUD_NOTES_CONFIG="$TMP/cfg" +export ICLOUD_NOTES_DRY_RUN=1 fail() { echo "FAIL: $*" >&2; exit 1; } pass() { echo "ok: $*"; } -out="$("${CLI[@]}" help 2>&1)" || fail "help exited non-zero" -[[ "$out" == *"icloud-note create"* ]] || fail "help missing create usage" +# --- help --- +for flag in help -h --help; do + out="$("${CLI[@]}" "$flag" 2>&1)" || fail "help ($flag) exited non-zero" + [[ "$out" == *"icloud-note create"* ]] || fail "help missing create ($flag)" +done +out="$("${CLI[@]}" help 2>&1)" [[ "$out" == *"headless"* ]] || fail "help should say create/status are headless" [[ "$out" != *"--headed"* ]] || fail "help must not advertise --headed" +[[ "$out" == *"$ICLOUD_NOTES_CONFIG"* ]] || fail "help should show ICLOUD_NOTES_CONFIG path" pass "help" +# --- unknown --- set +e err="$("${CLI[@]}" nosuchcmd 2>&1)" code=$? @@ -22,6 +32,7 @@ set -e [[ "$err" == *"Unknown command"* ]] || fail "unknown command message" pass "unknown command" +# --- create validation --- set +e err="$("${CLI[@]}" create 2>&1)" code=$? @@ -30,4 +41,69 @@ set -e [[ "$err" == *"Provide --title"* ]] || fail "create empty message" pass "create requires content" +# --- create dry-run (no browser) --- +out="$("${CLI[@]}" create --title "T" --body "hello" 2>&1)" || fail "create dry-run failed" +[[ "$out" == *'dry-run: would create note title="T"'* ]] || fail "create dry-run output: $out" +[[ "$out" == *"chars="* ]] || fail "create dry-run missing chars" +pass "create dry-run --title/--body" + +printf 'from file\n' > "$TMP/body.txt" +out="$("${CLI[@]}" create --title "FileNote" --body-file "$TMP/body.txt" 2>&1)" \ + || fail "create body-file failed" +[[ "$out" == *'title="FileNote"'* ]] || fail "body-file title: $out" +pass "create --body-file" + +out="$(printf 'stdin body' | "${CLI[@]}" create --title "Stdin" --body-file - 2>&1)" \ + || fail "create stdin body-file failed" +[[ "$out" == *'title="Stdin"'* ]] || fail "stdin title: $out" +pass "create --body-file -" + +out="$("${CLI[@]}" create "Positional" --body "x" 2>&1)" || fail "positional create failed" +[[ "$out" == *'title="Positional"'* ]] || fail "positional title: $out" +pass "create positional title" + +# --- status dry-run without session --- +set +e +err="$("${CLI[@]}" status 2>&1)" +code=$? +set -e +[[ "$code" -ne 0 ]] || fail "status without session should fail" +[[ "$err" == *"No saved session"* ]] || fail "status empty message: $err" +pass "status dry-run without session" + +mkdir -p "$ICLOUD_NOTES_CONFIG" +echo '{"cookies":[]}' > "$ICLOUD_NOTES_CONFIG/storage-state.json" +out="$("${CLI[@]}" status 2>&1)" || fail "status dry-run with state failed" +[[ "$out" == *"dry-run status"* ]] || fail "status dry-run ok: $out" +pass "status dry-run with session file" + +# --- login dry-run must not open a browser --- +set +e +err="$("${CLI[@]}" login 2>&1)" +code=$? +set -e +[[ "$code" -ne 0 ]] || fail "login dry-run should refuse" +[[ "$err" == *"dry-run"* ]] || fail "login dry-run message: $err" +pass "login dry-run refuses browser" + +# --- login without display (real path, no dry-run) --- +unset ICLOUD_NOTES_DRY_RUN +set +e +err="$(env -u DISPLAY -u WAYLAND_DISPLAY ICLOUD_NOTES_CONFIG="$ICLOUD_NOTES_CONFIG" \ + "${CLI[@]}" login 2>&1)" +code=$? +set -e +[[ "$code" -ne 0 ]] || fail "login without DISPLAY should fail" +[[ "$err" == *"graphical session"* ]] || fail "login DISPLAY message: $err" +pass "login requires graphical session" + +# --- setup script present --- +[[ -x "$ROOT/scripts/setup.sh" ]] || fail "setup.sh not executable" +pass "setup.sh executable" + +# --- skill / docs mention headless --- +rg -q 'headless' "$ROOT/SKILL.md" || fail "SKILL.md should mention headless" +rg -q 'headless' "$ROOT/README.md" || fail "README.md should mention headless" +pass "docs mention headless" + echo "All cli tests passed." diff --git a/tests/conventional-commits.test.sh b/tests/conventional-commits.test.sh new file mode 100755 index 0000000..042b819 --- /dev/null +++ b/tests/conventional-commits.test.sh @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +# Enforce Conventional Commits 1.0.0 on every commit subject in this repo. +set -euo pipefail + +ROOT="$(cd "$(dirname "$0")/.." && pwd)" +cd "$ROOT" + +fail() { echo "FAIL: $*" >&2; exit 1; } +pass() { echo "ok: $*"; } + +# Same rule as scripts/lib/note-helpers.mjs isConventionalCommitSubject +RE='^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\([a-zA-Z0-9._/-]+\))?!?: .+' + +mapfile -t SUBJECTS < <(git log --format=%s) +[[ "${#SUBJECTS[@]}" -gt 0 ]] || fail "no commits" + +bad=0 +for s in "${SUBJECTS[@]}"; do + if [[ ! "$s" =~ $RE ]]; then + echo "non-conventional: $s" >&2 + bad=1 + else + pass "commit: $s" + fi +done +[[ "$bad" -eq 0 ]] || fail "one or more commits are not Conventional Commits" + +# Unit helper agrees with git history +node --input-type=module -e ' +import { isConventionalCommitSubject } from "./scripts/lib/note-helpers.mjs"; +import { execSync } from "node:child_process"; +const subjects = execSync("git log --format=%s", { encoding: "utf8" }) + .trim().split("\n").filter(Boolean); +for (const s of subjects) { + if (!isConventionalCommitSubject(s)) { + console.error("helper rejected:", s); + process.exit(1); + } +} +' + +echo "All conventional-commit checks passed." diff --git a/tests/helpers.test.mjs b/tests/helpers.test.mjs new file mode 100644 index 0000000..38742d8 --- /dev/null +++ b/tests/helpers.test.mjs @@ -0,0 +1,113 @@ +import assert from "node:assert/strict"; +import { describe, it } from "node:test"; +import { + formatNoteText, + isAppleAuthUrl, + looksLoggedOut, + resolveConfigPaths, + parseCreateArgv, + requireCreateContent, + isConventionalCommitSubject, +} from "../scripts/lib/note-helpers.mjs"; + +describe("formatNoteText", () => { + it("joins title and body with a blank line", () => { + assert.equal(formatNoteText("Hi", "body"), "Hi\n\nbody"); + }); + it("title only", () => { + assert.equal(formatNoteText("Hi", ""), "Hi"); + }); + it("body only", () => { + assert.equal(formatNoteText("", "body"), "body"); + }); + it("ignores nullish", () => { + assert.equal(formatNoteText(null, "x"), "x"); + }); +}); + +describe("isAppleAuthUrl / looksLoggedOut", () => { + it("detects idmsa / appleid URLs", () => { + assert.equal(isAppleAuthUrl("https://idmsa.apple.com/appleauth/auth"), true); + assert.equal(isAppleAuthUrl("https://appleid.apple.com/"), true); + assert.equal(isAppleAuthUrl("https://www.icloud.com/notes/"), false); + }); + it("detects sign-in page signals", () => { + assert.equal( + looksLoggedOut({ bodyText: "Sign in to iCloud to continue" }), + true, + ); + assert.equal(looksLoggedOut({ hasPasswordField: true }), true); + assert.equal( + looksLoggedOut({ hasSignInControl: true, hasNotesApp: false }), + true, + ); + assert.equal( + looksLoggedOut({ hasSignInControl: true, hasNotesApp: true }), + false, + ); + assert.equal(looksLoggedOut({ url: "https://www.icloud.com/notes/" }), false); + }); +}); + +describe("resolveConfigPaths", () => { + it("uses ICLOUD_NOTES_CONFIG when set", () => { + const p = resolveConfigPaths({ ICLOUD_NOTES_CONFIG: "/tmp/icloud-test" }); + assert.equal(p.configDir, "/tmp/icloud-test"); + assert.equal(p.statePath, "/tmp/icloud-test/storage-state.json"); + assert.equal(p.profileDir, "/tmp/icloud-test/browser-profile"); + }); + it("defaults under homedir/.config/icloud-notes", () => { + const p = resolveConfigPaths({}, "/home/me"); + assert.equal(p.configDir, "/home/me/.config/icloud-notes"); + }); +}); + +describe("parseCreateArgv / requireCreateContent", () => { + it("parses flags", () => { + const a = parseCreateArgv(["--title", "T", "--body", "B"]); + assert.equal(a.title, "T"); + assert.equal(a.body, "B"); + }); + it("positional title", () => { + const a = parseCreateArgv(["MyTitle"]); + assert.equal(a.title, "MyTitle"); + }); + it("body-file flag", () => { + const a = parseCreateArgv(["--title", "T", "--body-file", "/tmp/x"]); + assert.equal(a.bodyFile, "/tmp/x"); + }); + it("rejects unknown options", () => { + assert.throws(() => parseCreateArgv(["--headed"]), /Unknown option/); + }); + it("requireCreateContent throws when empty", () => { + assert.throws(() => requireCreateContent("", ""), /Provide --title/); + }); + it("requireCreateContent trims body trailing whitespace", () => { + const r = requireCreateContent("T", "hi\n\n"); + assert.equal(r.body, "hi"); + }); +}); + +describe("isConventionalCommitSubject", () => { + it("accepts Conventional Commits subjects", () => { + assert.equal( + isConventionalCommitSubject( + "feat: add icloud.com/notes helper and agent skill", + ), + true, + ); + assert.equal( + isConventionalCommitSubject( + "fix: run create/status headless without a visible browser", + ), + true, + ); + assert.equal(isConventionalCommitSubject("feat(notes): add dry-run"), true); + assert.equal(isConventionalCommitSubject("feat!: breaking"), true); + }); + it("rejects non-conventional subjects", () => { + assert.equal(isConventionalCommitSubject("Added tests"), false); + assert.equal(isConventionalCommitSubject("feat add stuff"), false); + assert.equal(isConventionalCommitSubject("FIX: caps type"), false); + }); +}); diff --git a/tests/run.sh b/tests/run.sh new file mode 100755 index 0000000..6d845df --- /dev/null +++ b/tests/run.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env bash +# Full test suite for iphone-notes. +set -euo pipefail +ROOT="$(cd "$(dirname "$0")/.." && pwd)" +cd "$ROOT" + +echo "== helpers (node:test) ==" +node --test tests/helpers.test.mjs + +echo "== cli ==" +./tests/cli.test.sh + +echo "== conventional commits ==" +./tests/conventional-commits.test.sh + +echo "All tests passed." |
