mirror of
https://github.com/obra/superpowers.git
synced 2026-07-07 02:09:04 +08:00
Compare commits
25 Commits
chore/remo
...
tdd-writin
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0e69a4d32c | ||
|
|
8afa64b49d | ||
|
|
deb9d855cb | ||
|
|
78fb4643da | ||
|
|
6f3eca4f2e | ||
|
|
0cfc0a16b4 | ||
|
|
c809093a2a | ||
|
|
97506cefd7 | ||
|
|
4ecbbcd0b4 | ||
|
|
53106e6536 | ||
|
|
89338e5113 | ||
|
|
c842f8871a | ||
|
|
6752471ad9 | ||
|
|
371a26cf99 | ||
|
|
3bb0a3faa3 | ||
|
|
2d05b63edc | ||
|
|
f268f7c953 | ||
|
|
e1753f6e77 | ||
|
|
777cc2fae4 | ||
|
|
e7ddc25e51 | ||
|
|
711d895ce7 | ||
|
|
640ce6c0e9 | ||
|
|
879ae59c33 | ||
|
|
d376057029 | ||
|
|
add6a283b1 |
@@ -9,7 +9,7 @@
|
|||||||
{
|
{
|
||||||
"name": "superpowers",
|
"name": "superpowers",
|
||||||
"description": "Core skills library for Claude Code: TDD, debugging, collaboration patterns, and proven techniques",
|
"description": "Core skills library for Claude Code: TDD, debugging, collaboration patterns, and proven techniques",
|
||||||
"version": "6.1.0",
|
"version": "6.1.1",
|
||||||
"source": "./",
|
"source": "./",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Jesse Vincent",
|
"name": "Jesse Vincent",
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "superpowers",
|
"name": "superpowers",
|
||||||
"description": "Core skills library for Claude Code: TDD, debugging, collaboration patterns, and proven techniques",
|
"description": "Core skills library for Claude Code: TDD, debugging, collaboration patterns, and proven techniques",
|
||||||
"version": "6.1.0",
|
"version": "6.1.1",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Jesse Vincent",
|
"name": "Jesse Vincent",
|
||||||
"email": "jesse@fsck.com"
|
"email": "jesse@fsck.com"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "superpowers",
|
"name": "superpowers",
|
||||||
"version": "6.1.0",
|
"version": "6.1.1",
|
||||||
"description": "An agentic skills framework & software development methodology that works: planning, TDD, debugging, and collaboration workflows.",
|
"description": "An agentic skills framework & software development methodology that works: planning, TDD, debugging, and collaboration workflows.",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Jesse Vincent",
|
"name": "Jesse Vincent",
|
||||||
@@ -27,7 +27,7 @@
|
|||||||
"shortDescription": "Planning, TDD, debugging, and delivery workflows for coding agents",
|
"shortDescription": "Planning, TDD, debugging, and delivery workflows for coding agents",
|
||||||
"longDescription": "Use Superpowers to guide agent work through brainstorming, implementation planning, test-driven development, systematic debugging, parallel execution, code review, and finish-the-branch workflows.",
|
"longDescription": "Use Superpowers to guide agent work through brainstorming, implementation planning, test-driven development, systematic debugging, parallel execution, code review, and finish-the-branch workflows.",
|
||||||
"developerName": "Jesse Vincent",
|
"developerName": "Jesse Vincent",
|
||||||
"category": "Coding",
|
"category": "Developer Tools",
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"Interactive",
|
"Interactive",
|
||||||
"Read",
|
"Read",
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"name": "superpowers",
|
"name": "superpowers",
|
||||||
"displayName": "Superpowers",
|
"displayName": "Superpowers",
|
||||||
"description": "Core skills library: TDD, debugging, collaboration patterns, and proven techniques",
|
"description": "Core skills library: TDD, debugging, collaboration patterns, and proven techniques",
|
||||||
"version": "6.1.0",
|
"version": "6.1.1",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Jesse Vincent",
|
"name": "Jesse Vincent",
|
||||||
"email": "jesse@fsck.com"
|
"email": "jesse@fsck.com"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "superpowers",
|
"name": "superpowers",
|
||||||
"version": "6.1.0",
|
"version": "6.1.1",
|
||||||
"description": "An agentic skills framework and software development methodology.",
|
"description": "An agentic skills framework and software development methodology.",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Jesse Vincent",
|
"name": "Jesse Vincent",
|
||||||
|
|||||||
@@ -1,5 +1,16 @@
|
|||||||
# Superpowers Release Notes
|
# Superpowers Release Notes
|
||||||
|
|
||||||
|
## v6.1.1 (2026-07-02)
|
||||||
|
|
||||||
|
### Codex
|
||||||
|
|
||||||
|
- **Codex no longer re-registers the Claude SessionStart hook.** v6.1.0 removed the Codex hook config and its manifest `hooks` pointer, meaning to stop Codex from installing a SessionStart hook — but with no `hooks` field, Codex fell back to auto-discovering `hooks/hooks.json`, the Claude Code SessionStart hook that the marketplace ships from the repo root, and re-registered it along with its install-time trust prompt. The Codex manifest now declares an explicit empty hooks object (`hooks: {}`), which Codex reads as "no hooks" instead of reaching the auto-discovery fallback. An absent field, `[]`, and an empty inline list all collapse back to the fallback, so the value has to be exactly `{}`.
|
||||||
|
- **Removed orphaned Codex session-start dead code.** `hooks/session-start-codex` had no caller once the Codex hook config was deleted, so it and its redundant test cases are gone. The worked shell-hook example in `docs/porting-to-a-new-harness.md` moves from Codex — now native skill discovery with no session-start hook — to Cursor, a live shell-hook harness, and the stale `hooks-codex.json` pointer in `docs/windows/polyglot-hooks.md` is corrected. The Codex plugin category is also fixed to "Developer Tools".
|
||||||
|
|
||||||
|
### Packaging
|
||||||
|
|
||||||
|
- **New `package-codex-plugin.sh` for building the Codex portal package.** A maintainer script produces a deterministic Codex "portal" archive — `.zip` by default, `tar.gz` on request — that normalizes entry timestamps, preserves executable modes, verifies every packaged skill ships its OpenAI metadata, includes the app and composer icons, and refuses to run against a dirty worktree. The packaged manifest keeps the source `hooks: {}` object so a portal-installed plugin avoids the same SessionStart auto-discovery, and the script can rebuild a byte-identical archive from a saved metadata source. Covered by a new test suite.
|
||||||
|
|
||||||
## v6.1.0 (2026-06-30)
|
## v6.1.0 (2026-06-30)
|
||||||
|
|
||||||
### Lower Per-Session Token Cost
|
### Lower Per-Session Token Cost
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "superpowers",
|
"name": "superpowers",
|
||||||
"description": "Core skills library: TDD, debugging, collaboration patterns, and proven techniques",
|
"description": "Core skills library: TDD, debugging, collaboration patterns, and proven techniques",
|
||||||
"version": "6.1.0",
|
"version": "6.1.1",
|
||||||
"contextFileName": "GEMINI.md"
|
"contextFileName": "GEMINI.md"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "superpowers",
|
"name": "superpowers",
|
||||||
"version": "6.1.0",
|
"version": "6.1.1",
|
||||||
"description": "Superpowers skills and runtime bootstrap for coding agents",
|
"description": "Superpowers skills and runtime bootstrap for coding agents",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": ".opencode/plugins/superpowers.js",
|
"main": ".opencode/plugins/superpowers.js",
|
||||||
|
|||||||
342
scripts/package-codex-plugin.sh
Executable file
342
scripts/package-codex-plugin.sh
Executable file
@@ -0,0 +1,342 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
#
|
||||||
|
# Package the Superpowers Codex plugin as a rootless archive for portal upload.
|
||||||
|
#
|
||||||
|
# The Codex portal artifact differs from the old openai/plugins sync flow:
|
||||||
|
# it is a standalone archive, but it still needs the OpenAI-owned
|
||||||
|
# skills/*/agents/openai.yaml metadata that used to be preserved from the
|
||||||
|
# destination plugin repo. Seed that metadata from a prior official package.
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||||
|
REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
|
||||||
|
|
||||||
|
REF="HEAD"
|
||||||
|
OUTPUT=""
|
||||||
|
FORMAT=""
|
||||||
|
METADATA_SOURCE=""
|
||||||
|
ALLOW_DIRTY=0
|
||||||
|
KEEP_STAGE=0
|
||||||
|
|
||||||
|
usage() {
|
||||||
|
cat <<'EOF'
|
||||||
|
Usage:
|
||||||
|
scripts/package-codex-plugin.sh [options]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--output PATH Write archive to PATH.
|
||||||
|
Default: ../_tmp/sup-codex-packaging/superpowers-VERSION.zip
|
||||||
|
--format FORMAT Archive format: zip or tar.gz. Default: zip.
|
||||||
|
If --output ends in .zip, .tar.gz, or .tgz, that
|
||||||
|
extension is used when --format is omitted.
|
||||||
|
--metadata-source PATH Prior official package directory, .zip, or .tar.gz used to
|
||||||
|
seed skills/*/agents/openai.yaml.
|
||||||
|
Default: ../_tmp/sup-codex-packaging/superpowers,
|
||||||
|
falling back to superpowers.zip, then superpowers.tar.gz
|
||||||
|
--ref REF Git ref to package. Default: HEAD.
|
||||||
|
--allow-dirty Permit a dirty working tree. The archive still uses --ref.
|
||||||
|
--keep-stage Print and keep the temporary staging directory.
|
||||||
|
-h, --help Show this help.
|
||||||
|
|
||||||
|
The archive is rootless: .codex-plugin/, assets/, skills/, README.md, LICENSE,
|
||||||
|
and CODE_OF_CONDUCT.md sit at the archive root. Source-only repo files, hooks, tests,
|
||||||
|
docs, and other harness manifests are intentionally not shipped.
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
die() {
|
||||||
|
echo "ERROR: $*" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
while [[ $# -gt 0 ]]; do
|
||||||
|
case "$1" in
|
||||||
|
--output)
|
||||||
|
[[ $# -ge 2 ]] || die "--output requires a path"
|
||||||
|
OUTPUT="$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--format)
|
||||||
|
[[ $# -ge 2 ]] || die "--format requires a value"
|
||||||
|
case "$2" in
|
||||||
|
zip)
|
||||||
|
FORMAT="zip"
|
||||||
|
;;
|
||||||
|
tar.gz|tgz)
|
||||||
|
FORMAT="tar.gz"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
die "--format must be zip or tar.gz"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--metadata-source)
|
||||||
|
[[ $# -ge 2 ]] || die "--metadata-source requires a path"
|
||||||
|
METADATA_SOURCE="$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--ref)
|
||||||
|
[[ $# -ge 2 ]] || die "--ref requires a value"
|
||||||
|
REF="$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
--allow-dirty)
|
||||||
|
ALLOW_DIRTY=1
|
||||||
|
shift
|
||||||
|
;;
|
||||||
|
--keep-stage)
|
||||||
|
KEEP_STAGE=1
|
||||||
|
shift
|
||||||
|
;;
|
||||||
|
-h|--help)
|
||||||
|
usage
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "Unknown arg: $1" >&2
|
||||||
|
usage >&2
|
||||||
|
exit 2
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
infer_format_from_output() {
|
||||||
|
local output_path="$1"
|
||||||
|
|
||||||
|
case "$output_path" in
|
||||||
|
*.tar.gz|*.tgz)
|
||||||
|
printf '%s\n' "tar.gz"
|
||||||
|
;;
|
||||||
|
*.zip)
|
||||||
|
printf '%s\n' "zip"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
return 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
if [[ -z "$FORMAT" ]]; then
|
||||||
|
FORMAT="$(infer_format_from_output "$OUTPUT" || true)"
|
||||||
|
if [[ -z "$FORMAT" ]]; then
|
||||||
|
FORMAT="zip"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
output_format="$(infer_format_from_output "$OUTPUT" || true)"
|
||||||
|
if [[ -n "$output_format" && "$output_format" != "$FORMAT" ]]; then
|
||||||
|
die "--output extension does not match --format $FORMAT: $OUTPUT"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
command -v git >/dev/null || die "git not found in PATH"
|
||||||
|
command -v jq >/dev/null || die "jq not found in PATH"
|
||||||
|
command -v tar >/dev/null || die "tar not found in PATH"
|
||||||
|
command -v gzip >/dev/null || die "gzip not found in PATH"
|
||||||
|
command -v shasum >/dev/null || die "shasum not found in PATH"
|
||||||
|
if [[ "$FORMAT" == "zip" ]]; then
|
||||||
|
command -v zip >/dev/null || die "zip not found in PATH"
|
||||||
|
command -v unzip >/dev/null || die "unzip not found in PATH"
|
||||||
|
fi
|
||||||
|
|
||||||
|
[[ -d "$REPO_ROOT/.git" ]] || die "repo root is not a git checkout: $REPO_ROOT"
|
||||||
|
git -C "$REPO_ROOT" rev-parse --verify "$REF^{commit}" >/dev/null ||
|
||||||
|
die "git ref does not resolve to a commit: $REF"
|
||||||
|
|
||||||
|
if [[ "$ALLOW_DIRTY" -ne 1 ]]; then
|
||||||
|
dirty_status="$(git -C "$REPO_ROOT" status --porcelain --untracked-files=all)"
|
||||||
|
if [[ -n "$dirty_status" ]]; then
|
||||||
|
echo "Working tree has uncommitted changes:" >&2
|
||||||
|
printf '%s\n' "$dirty_status" | sed 's/^/ /' >&2
|
||||||
|
die "commit or stash changes first, or pass --allow-dirty to package $REF anyway"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -z "$METADATA_SOURCE" ]]; then
|
||||||
|
if [[ -d "$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers" ]]; then
|
||||||
|
METADATA_SOURCE="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers"
|
||||||
|
elif [[ -f "$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers.zip" ]]; then
|
||||||
|
METADATA_SOURCE="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers.zip"
|
||||||
|
elif [[ -f "$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers.tar.gz" ]]; then
|
||||||
|
METADATA_SOURCE="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers.tar.gz"
|
||||||
|
else
|
||||||
|
die "no metadata source found; pass --metadata-source <prior package dir, zip, or tar.gz>"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
WORK_DIR="$(mktemp -d "${TMPDIR:-/tmp}/superpowers-codex-package.XXXXXX")"
|
||||||
|
STAGE="$WORK_DIR/payload"
|
||||||
|
METADATA_WORK="$WORK_DIR/metadata"
|
||||||
|
ARCHIVE_LIST="$WORK_DIR/archive-list"
|
||||||
|
|
||||||
|
cleanup() {
|
||||||
|
if [[ "$KEEP_STAGE" -eq 1 ]]; then
|
||||||
|
echo "Keeping staging directory: $WORK_DIR" >&2
|
||||||
|
else
|
||||||
|
rm -rf "$WORK_DIR"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
trap cleanup EXIT
|
||||||
|
|
||||||
|
mkdir -p "$STAGE" "$METADATA_WORK"
|
||||||
|
|
||||||
|
metadata_root_from_dir() {
|
||||||
|
local candidate="$1"
|
||||||
|
local nested
|
||||||
|
|
||||||
|
if [[ -d "$candidate/skills" ]]; then
|
||||||
|
printf '%s\n' "$candidate"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
nested="$(find "$candidate" -mindepth 2 -maxdepth 2 -type d -name skills -print -quit)"
|
||||||
|
if [[ -n "$nested" ]]; then
|
||||||
|
dirname "$nested"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
prepare_metadata_root() {
|
||||||
|
local source="$1"
|
||||||
|
local root
|
||||||
|
|
||||||
|
if [[ -d "$source" ]]; then
|
||||||
|
root="$(cd "$source" && pwd)"
|
||||||
|
elif [[ -f "$source" ]]; then
|
||||||
|
case "$source" in
|
||||||
|
*.tar.gz|*.tgz)
|
||||||
|
tar -xzf "$source" -C "$METADATA_WORK"
|
||||||
|
root="$METADATA_WORK"
|
||||||
|
;;
|
||||||
|
*.zip)
|
||||||
|
command -v unzip >/dev/null || die "unzip not found in PATH"
|
||||||
|
unzip -q "$source" -d "$METADATA_WORK"
|
||||||
|
root="$METADATA_WORK"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
die "metadata source must be a directory, .zip, or .tar.gz: $source"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
else
|
||||||
|
die "metadata source does not exist: $source"
|
||||||
|
fi
|
||||||
|
|
||||||
|
metadata_root_from_dir "$root" ||
|
||||||
|
die "metadata source does not contain a skills/ directory: $source"
|
||||||
|
}
|
||||||
|
|
||||||
|
METADATA_ROOT="$(prepare_metadata_root "$METADATA_SOURCE")"
|
||||||
|
|
||||||
|
git -C "$REPO_ROOT" archive --format=tar "$REF" -- \
|
||||||
|
.codex-plugin \
|
||||||
|
CODE_OF_CONDUCT.md \
|
||||||
|
LICENSE \
|
||||||
|
README.md \
|
||||||
|
assets \
|
||||||
|
skills \
|
||||||
|
| tar -xf - -C "$STAGE"
|
||||||
|
|
||||||
|
VERSION="$(jq -r '.version // empty' "$STAGE/.codex-plugin/plugin.json")"
|
||||||
|
[[ -n "$VERSION" ]] || die "could not read version from .codex-plugin/plugin.json"
|
||||||
|
|
||||||
|
if [[ -z "$OUTPUT" ]]; then
|
||||||
|
case "$FORMAT" in
|
||||||
|
zip)
|
||||||
|
OUTPUT="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers-$VERSION.zip"
|
||||||
|
;;
|
||||||
|
tar.gz)
|
||||||
|
OUTPUT="$REPO_ROOT/../_tmp/sup-codex-packaging/superpowers-$VERSION.tar.gz"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
mkdir -p "$(dirname "$OUTPUT")"
|
||||||
|
OUTPUT="$(cd "$(dirname "$OUTPUT")" && pwd)/$(basename "$OUTPUT")"
|
||||||
|
|
||||||
|
missing_metadata=0
|
||||||
|
while IFS= read -r skill_dir; do
|
||||||
|
skill_name="${skill_dir##*/}"
|
||||||
|
metadata_file="$METADATA_ROOT/skills/$skill_name/agents/openai.yaml"
|
||||||
|
|
||||||
|
if [[ ! -f "$metadata_file" ]]; then
|
||||||
|
echo "Missing OpenAI agent metadata for skill: $skill_name" >&2
|
||||||
|
missing_metadata=1
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p "$skill_dir/agents"
|
||||||
|
cp "$metadata_file" "$skill_dir/agents/openai.yaml"
|
||||||
|
done < <(find "$STAGE/skills" -mindepth 1 -maxdepth 1 -type d -print | sort)
|
||||||
|
|
||||||
|
if [[ "$missing_metadata" -ne 0 ]]; then
|
||||||
|
die "metadata source is incomplete"
|
||||||
|
fi
|
||||||
|
|
||||||
|
skill_count="$(find "$STAGE/skills" -mindepth 1 -maxdepth 1 -type d | wc -l | tr -d ' ')"
|
||||||
|
metadata_count="$(find "$STAGE/skills" -path '*/agents/openai.yaml' -type f | wc -l | tr -d ' ')"
|
||||||
|
[[ "$skill_count" == "$metadata_count" ]] ||
|
||||||
|
die "metadata count mismatch: $metadata_count metadata files for $skill_count skills"
|
||||||
|
|
||||||
|
(
|
||||||
|
cd "$STAGE"
|
||||||
|
{
|
||||||
|
find . -mindepth 1 -type d | sed 's#^\./##' | LC_ALL=C sort
|
||||||
|
find . -mindepth 1 -type f | sed 's#^\./##' | LC_ALL=C sort
|
||||||
|
} >"$ARCHIVE_LIST"
|
||||||
|
)
|
||||||
|
|
||||||
|
case "$FORMAT" in
|
||||||
|
zip)
|
||||||
|
# ZIP cannot represent dates earlier than 1980.
|
||||||
|
TZ=UTC find "$STAGE" -exec touch -t 198001010000 {} +
|
||||||
|
(
|
||||||
|
cd "$STAGE"
|
||||||
|
rm -f "$OUTPUT"
|
||||||
|
COPYFILE_DISABLE=1 zip -X -q - -@ <"$ARCHIVE_LIST" >"$OUTPUT"
|
||||||
|
)
|
||||||
|
;;
|
||||||
|
tar.gz)
|
||||||
|
# Match the prior official archive's deterministic tar entry metadata.
|
||||||
|
TZ=UTC find "$STAGE" -exec touch -t 197001010000 {} +
|
||||||
|
(
|
||||||
|
cd "$STAGE"
|
||||||
|
rm -f "$OUTPUT"
|
||||||
|
COPYFILE_DISABLE=1 tar -cf - --no-recursion --format ustar --uid 0 --gid 0 --uname '' --gname '' -T "$ARCHIVE_LIST" |
|
||||||
|
gzip -9n >"$OUTPUT"
|
||||||
|
)
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if command -v xattr >/dev/null 2>&1; then
|
||||||
|
xattr -c "$OUTPUT" 2>/dev/null || true
|
||||||
|
fi
|
||||||
|
|
||||||
|
case "$FORMAT" in
|
||||||
|
zip)
|
||||||
|
archive_paths="$(unzip -Z1 "$OUTPUT" | sed 's#/$##')"
|
||||||
|
;;
|
||||||
|
tar.gz)
|
||||||
|
archive_paths="$(tar -tzf "$OUTPUT")"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
unexpected_paths="$(
|
||||||
|
printf '%s\n' "$archive_paths" |
|
||||||
|
grep -E '(^superpowers/|^\.agents/|^hooks/|package\.json$|^\.git|^\.pytest_cache|^\.ruff_cache|^scripts/|^tests/|^docs/|^evals/|^lib/|^\.claude|^\.cursor|^\.kimi|^\.opencode|^\.pi|^AGENTS\.md$|^CLAUDE\.md$|^GEMINI\.md$|^RELEASE-NOTES\.md$|^CHANGELOG\.md$)' || true
|
||||||
|
)"
|
||||||
|
if [[ -n "$unexpected_paths" ]]; then
|
||||||
|
printf '%s\n' "$unexpected_paths" | sed 's/^/ /' >&2
|
||||||
|
die "archive contains source-only paths"
|
||||||
|
fi
|
||||||
|
|
||||||
|
entry_count="$(printf '%s\n' "$archive_paths" | wc -l | tr -d ' ')"
|
||||||
|
checksum="$(shasum -a 256 "$OUTPUT" | awk '{print $1}')"
|
||||||
|
|
||||||
|
echo "Archive: $OUTPUT"
|
||||||
|
echo "Format: $FORMAT"
|
||||||
|
echo "Version: $VERSION"
|
||||||
|
echo "Entries: $entry_count"
|
||||||
|
echo "Skills: $skill_count"
|
||||||
|
echo "SHA-256: $checksum"
|
||||||
@@ -203,6 +203,12 @@ Next failing test for next feature.
|
|||||||
| **Clear** | Name describes behavior | `test('test1')` |
|
| **Clear** | Name describes behavior | `test('test1')` |
|
||||||
| **Shows intent** | Demonstrates desired API | Obscures what code should do |
|
| **Shows intent** | Demonstrates desired API | Obscures what code should do |
|
||||||
|
|
||||||
|
When writing or changing any test, read [writing-good-tests.md](writing-good-tests.md) for the rules that keep tests honest:
|
||||||
|
- Name the production change that would make the test fail — before writing it
|
||||||
|
- Assert on real behavior, never on mock behavior
|
||||||
|
- Keep test-only code in test utilities, out of production classes
|
||||||
|
- Understand a dependency's side effects before mocking it
|
||||||
|
|
||||||
## Why Order Matters
|
## Why Order Matters
|
||||||
|
|
||||||
**"I'll write tests after to verify it works"**
|
**"I'll write tests after to verify it works"**
|
||||||
@@ -354,13 +360,6 @@ Bug found? Write failing test reproducing it. Follow TDD cycle. Test proves fix
|
|||||||
|
|
||||||
Never fix bugs without a test.
|
Never fix bugs without a test.
|
||||||
|
|
||||||
## Testing Anti-Patterns
|
|
||||||
|
|
||||||
When adding mocks or test utilities, read [testing-anti-patterns.md](testing-anti-patterns.md) to avoid common pitfalls:
|
|
||||||
- Testing mock behavior instead of real behavior
|
|
||||||
- Adding test-only methods to production classes
|
|
||||||
- Mocking without understanding dependencies
|
|
||||||
|
|
||||||
## Final Rule
|
## Final Rule
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,299 +0,0 @@
|
|||||||
# Testing Anti-Patterns
|
|
||||||
|
|
||||||
**Load this reference when:** writing or changing tests, adding mocks, or tempted to add test-only methods to production code.
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Tests must verify real behavior, not mock behavior. Mocks are a means to isolate, not the thing being tested.
|
|
||||||
|
|
||||||
**Core principle:** Test what the code does, not what the mocks do.
|
|
||||||
|
|
||||||
**Following strict TDD prevents these anti-patterns.**
|
|
||||||
|
|
||||||
## The Iron Laws
|
|
||||||
|
|
||||||
```
|
|
||||||
1. NEVER test mock behavior
|
|
||||||
2. NEVER add test-only methods to production classes
|
|
||||||
3. NEVER mock without understanding dependencies
|
|
||||||
```
|
|
||||||
|
|
||||||
## Anti-Pattern 1: Testing Mock Behavior
|
|
||||||
|
|
||||||
**The violation:**
|
|
||||||
```typescript
|
|
||||||
// ❌ BAD: Testing that the mock exists
|
|
||||||
test('renders sidebar', () => {
|
|
||||||
render(<Page />);
|
|
||||||
expect(screen.getByTestId('sidebar-mock')).toBeInTheDocument();
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
**Why this is wrong:**
|
|
||||||
- You're verifying the mock works, not that the component works
|
|
||||||
- Test passes when mock is present, fails when it's not
|
|
||||||
- Tells you nothing about real behavior
|
|
||||||
|
|
||||||
**your human partner's correction:** "Are we testing the behavior of a mock?"
|
|
||||||
|
|
||||||
**The fix:**
|
|
||||||
```typescript
|
|
||||||
// ✅ GOOD: Test real component or don't mock it
|
|
||||||
test('renders sidebar', () => {
|
|
||||||
render(<Page />); // Don't mock sidebar
|
|
||||||
expect(screen.getByRole('navigation')).toBeInTheDocument();
|
|
||||||
});
|
|
||||||
|
|
||||||
// OR if sidebar must be mocked for isolation:
|
|
||||||
// Don't assert on the mock - test Page's behavior with sidebar present
|
|
||||||
```
|
|
||||||
|
|
||||||
### Gate Function
|
|
||||||
|
|
||||||
```
|
|
||||||
BEFORE asserting on any mock element:
|
|
||||||
Ask: "Am I testing real component behavior or just mock existence?"
|
|
||||||
|
|
||||||
IF testing mock existence:
|
|
||||||
STOP - Delete the assertion or unmock the component
|
|
||||||
|
|
||||||
Test real behavior instead
|
|
||||||
```
|
|
||||||
|
|
||||||
## Anti-Pattern 2: Test-Only Methods in Production
|
|
||||||
|
|
||||||
**The violation:**
|
|
||||||
```typescript
|
|
||||||
// ❌ BAD: destroy() only used in tests
|
|
||||||
class Session {
|
|
||||||
async destroy() { // Looks like production API!
|
|
||||||
await this._workspaceManager?.destroyWorkspace(this.id);
|
|
||||||
// ... cleanup
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// In tests
|
|
||||||
afterEach(() => session.destroy());
|
|
||||||
```
|
|
||||||
|
|
||||||
**Why this is wrong:**
|
|
||||||
- Production class polluted with test-only code
|
|
||||||
- Dangerous if accidentally called in production
|
|
||||||
- Violates YAGNI and separation of concerns
|
|
||||||
- Confuses object lifecycle with entity lifecycle
|
|
||||||
|
|
||||||
**The fix:**
|
|
||||||
```typescript
|
|
||||||
// ✅ GOOD: Test utilities handle test cleanup
|
|
||||||
// Session has no destroy() - it's stateless in production
|
|
||||||
|
|
||||||
// In test-utils/
|
|
||||||
export async function cleanupSession(session: Session) {
|
|
||||||
const workspace = session.getWorkspaceInfo();
|
|
||||||
if (workspace) {
|
|
||||||
await workspaceManager.destroyWorkspace(workspace.id);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// In tests
|
|
||||||
afterEach(() => cleanupSession(session));
|
|
||||||
```
|
|
||||||
|
|
||||||
### Gate Function
|
|
||||||
|
|
||||||
```
|
|
||||||
BEFORE adding any method to production class:
|
|
||||||
Ask: "Is this only used by tests?"
|
|
||||||
|
|
||||||
IF yes:
|
|
||||||
STOP - Don't add it
|
|
||||||
Put it in test utilities instead
|
|
||||||
|
|
||||||
Ask: "Does this class own this resource's lifecycle?"
|
|
||||||
|
|
||||||
IF no:
|
|
||||||
STOP - Wrong class for this method
|
|
||||||
```
|
|
||||||
|
|
||||||
## Anti-Pattern 3: Mocking Without Understanding
|
|
||||||
|
|
||||||
**The violation:**
|
|
||||||
```typescript
|
|
||||||
// ❌ BAD: Mock breaks test logic
|
|
||||||
test('detects duplicate server', () => {
|
|
||||||
// Mock prevents config write that test depends on!
|
|
||||||
vi.mock('ToolCatalog', () => ({
|
|
||||||
discoverAndCacheTools: vi.fn().mockResolvedValue(undefined)
|
|
||||||
}));
|
|
||||||
|
|
||||||
await addServer(config);
|
|
||||||
await addServer(config); // Should throw - but won't!
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
**Why this is wrong:**
|
|
||||||
- Mocked method had side effect test depended on (writing config)
|
|
||||||
- Over-mocking to "be safe" breaks actual behavior
|
|
||||||
- Test passes for wrong reason or fails mysteriously
|
|
||||||
|
|
||||||
**The fix:**
|
|
||||||
```typescript
|
|
||||||
// ✅ GOOD: Mock at correct level
|
|
||||||
test('detects duplicate server', () => {
|
|
||||||
// Mock the slow part, preserve behavior test needs
|
|
||||||
vi.mock('MCPServerManager'); // Just mock slow server startup
|
|
||||||
|
|
||||||
await addServer(config); // Config written
|
|
||||||
await addServer(config); // Duplicate detected ✓
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Gate Function
|
|
||||||
|
|
||||||
```
|
|
||||||
BEFORE mocking any method:
|
|
||||||
STOP - Don't mock yet
|
|
||||||
|
|
||||||
1. Ask: "What side effects does the real method have?"
|
|
||||||
2. Ask: "Does this test depend on any of those side effects?"
|
|
||||||
3. Ask: "Do I fully understand what this test needs?"
|
|
||||||
|
|
||||||
IF depends on side effects:
|
|
||||||
Mock at lower level (the actual slow/external operation)
|
|
||||||
OR use test doubles that preserve necessary behavior
|
|
||||||
NOT the high-level method the test depends on
|
|
||||||
|
|
||||||
IF unsure what test depends on:
|
|
||||||
Run test with real implementation FIRST
|
|
||||||
Observe what actually needs to happen
|
|
||||||
THEN add minimal mocking at the right level
|
|
||||||
|
|
||||||
Red flags:
|
|
||||||
- "I'll mock this to be safe"
|
|
||||||
- "This might be slow, better mock it"
|
|
||||||
- Mocking without understanding the dependency chain
|
|
||||||
```
|
|
||||||
|
|
||||||
## Anti-Pattern 4: Incomplete Mocks
|
|
||||||
|
|
||||||
**The violation:**
|
|
||||||
```typescript
|
|
||||||
// ❌ BAD: Partial mock - only fields you think you need
|
|
||||||
const mockResponse = {
|
|
||||||
status: 'success',
|
|
||||||
data: { userId: '123', name: 'Alice' }
|
|
||||||
// Missing: metadata that downstream code uses
|
|
||||||
};
|
|
||||||
|
|
||||||
// Later: breaks when code accesses response.metadata.requestId
|
|
||||||
```
|
|
||||||
|
|
||||||
**Why this is wrong:**
|
|
||||||
- **Partial mocks hide structural assumptions** - You only mocked fields you know about
|
|
||||||
- **Downstream code may depend on fields you didn't include** - Silent failures
|
|
||||||
- **Tests pass but integration fails** - Mock incomplete, real API complete
|
|
||||||
- **False confidence** - Test proves nothing about real behavior
|
|
||||||
|
|
||||||
**The Iron Rule:** Mock the COMPLETE data structure as it exists in reality, not just fields your immediate test uses.
|
|
||||||
|
|
||||||
**The fix:**
|
|
||||||
```typescript
|
|
||||||
// ✅ GOOD: Mirror real API completeness
|
|
||||||
const mockResponse = {
|
|
||||||
status: 'success',
|
|
||||||
data: { userId: '123', name: 'Alice' },
|
|
||||||
metadata: { requestId: 'req-789', timestamp: 1234567890 }
|
|
||||||
// All fields real API returns
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
### Gate Function
|
|
||||||
|
|
||||||
```
|
|
||||||
BEFORE creating mock responses:
|
|
||||||
Check: "What fields does the real API response contain?"
|
|
||||||
|
|
||||||
Actions:
|
|
||||||
1. Examine actual API response from docs/examples
|
|
||||||
2. Include ALL fields system might consume downstream
|
|
||||||
3. Verify mock matches real response schema completely
|
|
||||||
|
|
||||||
Critical:
|
|
||||||
If you're creating a mock, you must understand the ENTIRE structure
|
|
||||||
Partial mocks fail silently when code depends on omitted fields
|
|
||||||
|
|
||||||
If uncertain: Include all documented fields
|
|
||||||
```
|
|
||||||
|
|
||||||
## Anti-Pattern 5: Integration Tests as Afterthought
|
|
||||||
|
|
||||||
**The violation:**
|
|
||||||
```
|
|
||||||
✅ Implementation complete
|
|
||||||
❌ No tests written
|
|
||||||
"Ready for testing"
|
|
||||||
```
|
|
||||||
|
|
||||||
**Why this is wrong:**
|
|
||||||
- Testing is part of implementation, not optional follow-up
|
|
||||||
- TDD would have caught this
|
|
||||||
- Can't claim complete without tests
|
|
||||||
|
|
||||||
**The fix:**
|
|
||||||
```
|
|
||||||
TDD cycle:
|
|
||||||
1. Write failing test
|
|
||||||
2. Implement to pass
|
|
||||||
3. Refactor
|
|
||||||
4. THEN claim complete
|
|
||||||
```
|
|
||||||
|
|
||||||
## When Mocks Become Too Complex
|
|
||||||
|
|
||||||
**Warning signs:**
|
|
||||||
- Mock setup longer than test logic
|
|
||||||
- Mocking everything to make test pass
|
|
||||||
- Mocks missing methods real components have
|
|
||||||
- Test breaks when mock changes
|
|
||||||
|
|
||||||
**your human partner's question:** "Do we need to be using a mock here?"
|
|
||||||
|
|
||||||
**Consider:** Integration tests with real components often simpler than complex mocks
|
|
||||||
|
|
||||||
## TDD Prevents These Anti-Patterns
|
|
||||||
|
|
||||||
**Why TDD helps:**
|
|
||||||
1. **Write test first** → Forces you to think about what you're actually testing
|
|
||||||
2. **Watch it fail** → Confirms test tests real behavior, not mocks
|
|
||||||
3. **Minimal implementation** → No test-only methods creep in
|
|
||||||
4. **Real dependencies** → You see what the test actually needs before mocking
|
|
||||||
|
|
||||||
**If you're testing mock behavior, you violated TDD** - you added mocks without watching test fail against real code first.
|
|
||||||
|
|
||||||
## Quick Reference
|
|
||||||
|
|
||||||
| Anti-Pattern | Fix |
|
|
||||||
|--------------|-----|
|
|
||||||
| Assert on mock elements | Test real component or unmock it |
|
|
||||||
| Test-only methods in production | Move to test utilities |
|
|
||||||
| Mock without understanding | Understand dependencies first, mock minimally |
|
|
||||||
| Incomplete mocks | Mirror real API completely |
|
|
||||||
| Tests as afterthought | TDD - tests first |
|
|
||||||
| Over-complex mocks | Consider integration tests |
|
|
||||||
|
|
||||||
## Red Flags
|
|
||||||
|
|
||||||
- Assertion checks for `*-mock` test IDs
|
|
||||||
- Methods only called in test files
|
|
||||||
- Mock setup is >50% of test
|
|
||||||
- Test fails when you remove mock
|
|
||||||
- Can't explain why mock is needed
|
|
||||||
- Mocking "just to be safe"
|
|
||||||
|
|
||||||
## The Bottom Line
|
|
||||||
|
|
||||||
**Mocks are tools to isolate, not things to test.**
|
|
||||||
|
|
||||||
If TDD reveals you're testing mock behavior, you've gone wrong.
|
|
||||||
|
|
||||||
Fix: Test real behavior or question why you're mocking at all.
|
|
||||||
198
skills/test-driven-development/writing-good-tests.md
Normal file
198
skills/test-driven-development/writing-good-tests.md
Normal file
@@ -0,0 +1,198 @@
|
|||||||
|
# Writing Good Tests
|
||||||
|
|
||||||
|
**Load this reference when:** writing or changing tests, adding mocks, or
|
||||||
|
adding cleanup/helper methods for tests.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
A test exists to catch a specific break. Two principles govern everything
|
||||||
|
here:
|
||||||
|
|
||||||
|
```
|
||||||
|
1. Every test names the break it catches
|
||||||
|
2. Every test exercises the real thing
|
||||||
|
```
|
||||||
|
|
||||||
|
Strict TDD produces both naturally: a test written first and watched
|
||||||
|
failing against real code has already proven it can fail, and only earns
|
||||||
|
a mock when the real dependency proves slow or external.
|
||||||
|
|
||||||
|
## Principle 1: Name the Break
|
||||||
|
|
||||||
|
Before writing the test body, answer: **what production change should
|
||||||
|
make this test fail — and is that change a bug or a decision?** A test
|
||||||
|
earns its place by catching a wrong branch, missing side effect, wrong
|
||||||
|
argument, boundary case, or broken contract.
|
||||||
|
|
||||||
|
**Derive expectations independently.** Use literals and hand-checked
|
||||||
|
fixtures; table-driven tests with literal `want` values are the preferred
|
||||||
|
shape. An expectation computed by the code under test — or its helpers —
|
||||||
|
passes no matter what that code does:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ❌ Mirror assertion: the same builder computes both sides — always true
|
||||||
|
const expected = buildSearchQuery({ tag: 'urgent' });
|
||||||
|
expect(buildSearchQuery({ tag: 'urgent' })).toBe(expected);
|
||||||
|
|
||||||
|
// ✅ Hand-derived literal
|
||||||
|
expect(buildSearchQuery({ tag: 'urgent' })).toBe('tag:"urgent"');
|
||||||
|
```
|
||||||
|
|
||||||
|
**No change detectors.** If only intentional decisions can fail a test —
|
||||||
|
a constant's value, exact message wording, private structure — it fires
|
||||||
|
on redesign and sleeps through bugs. Test the behavior that depends on
|
||||||
|
the decision: not `expect(MAX_RETRIES).toBe(5)` but "a failing call is
|
||||||
|
retried 5 times and the 6th attempt never happens."
|
||||||
|
|
||||||
|
**Behavior, not text.** Asserting that a script, skill, or config
|
||||||
|
contains an exact line proves only that the source is the source. Run
|
||||||
|
scripts against controlled inputs and assert outputs, side effects, or
|
||||||
|
exit codes. Documents that instruct agents are tested by the consuming
|
||||||
|
agent's behavior (superpowers:writing-skills); prose for humans earns no
|
||||||
|
test at all.
|
||||||
|
|
||||||
|
**Your code, not the framework.** Test the contract your code makes at
|
||||||
|
its boundaries — the route you register, the query you emit, the payload
|
||||||
|
you produce. Upstream mechanics are their maintainers' tests to write
|
||||||
|
(the classic: asserting your router invokes a registered handler — that
|
||||||
|
is the framework's test, not yours). When upstream behavior genuinely
|
||||||
|
surprised you, write one narrow characterization test naming the
|
||||||
|
assumption. The same boundary applies inside your code: constructors,
|
||||||
|
getters, constants, and trivial forwarding earn tests only when they
|
||||||
|
validate, normalize, default, derive, enforce, or cause side effects —
|
||||||
|
otherwise assert the first consumer-visible result that depends on them.
|
||||||
|
|
||||||
|
### Gate Function
|
||||||
|
|
||||||
|
```
|
||||||
|
BEFORE writing the test body:
|
||||||
|
Name the production change that would make this test fail.
|
||||||
|
|
||||||
|
Cannot name one → redesign around an observable behavior
|
||||||
|
"The source text changed" → run the artifact and assert its effects
|
||||||
|
Only intentional decisions → change detector; test the behavior
|
||||||
|
that depends on the decision
|
||||||
|
|
||||||
|
Confirm the expected value is derived without the code under test.
|
||||||
|
IF it reuses the code's logic or helpers:
|
||||||
|
Replace it with a literal or hand-checked fixture
|
||||||
|
```
|
||||||
|
|
||||||
|
## Principle 2: Exercise the Real Thing
|
||||||
|
|
||||||
|
**The mock earns no assertions.** A mock assertion passes when the mock
|
||||||
|
is present and fails when it is absent — it says nothing about the
|
||||||
|
component. Assert the real component's behavior; if the mock is what you
|
||||||
|
are checking, unmock it or delete the assertion.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Real behavior
|
||||||
|
expect(screen.getByRole('navigation')).toBeInTheDocument();
|
||||||
|
|
||||||
|
// ❌ Mock existence
|
||||||
|
expect(screen.getByTestId('sidebar-mock')).toBeInTheDocument();
|
||||||
|
```
|
||||||
|
|
||||||
|
**your human partner's correction:** "Are we testing the behavior of a
|
||||||
|
mock?"
|
||||||
|
|
||||||
|
**Mock at the right level.** Learn every side effect of the real method
|
||||||
|
before replacing it; mock the slow or external operation and keep what
|
||||||
|
the test depends on real. When unsure, run the test against the real
|
||||||
|
implementation first and observe what actually needs to happen.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ❌ The mock swallows the config write that duplicate detection reads
|
||||||
|
vi.mock('ToolCatalog', () => ({
|
||||||
|
discoverAndCacheTools: vi.fn().mockResolvedValue(undefined)
|
||||||
|
}));
|
||||||
|
|
||||||
|
// ✅ Mock only the slow server startup; the config write stays real
|
||||||
|
vi.mock('MCPServerManager');
|
||||||
|
```
|
||||||
|
|
||||||
|
**Make doubles specific.** When arguments, call counts, or ordering are
|
||||||
|
part of the contract, assert them — a fake that accepts anything verifies
|
||||||
|
nothing. Give each branch (success, error, malformed) its own fixture or
|
||||||
|
spy, so the wrong branch cannot satisfy the expectation.
|
||||||
|
|
||||||
|
**Mirror real data completely.** Mock the complete structure as it exists
|
||||||
|
in reality — all documented fields — not just the ones your test reads.
|
||||||
|
Partial mocks fail silently when downstream code reads an omitted field:
|
||||||
|
the test passes while integration breaks.
|
||||||
|
|
||||||
|
**Production classes carry production methods only.** Cleanup that only
|
||||||
|
tests need lives in test utilities, never as a `destroy()` on the
|
||||||
|
production class. Ask: is this method called only from tests? Does this
|
||||||
|
class own this resource's lifecycle? Wrong answers → test utility.
|
||||||
|
|
||||||
|
**Prefer real components over complex mocks.** When mock setup outgrows
|
||||||
|
the test logic, mocks miss methods the real components have, or tests
|
||||||
|
break when the mock changes, switch to an integration test with real
|
||||||
|
components. **your human partner's question:** "Do we need to be using a
|
||||||
|
mock here?"
|
||||||
|
|
||||||
|
### Gate Function
|
||||||
|
|
||||||
|
```
|
||||||
|
BEFORE adding a mock or test helper:
|
||||||
|
List the real method's side effects; keep the ones the test
|
||||||
|
depends on real — mock the slow/external level below them.
|
||||||
|
|
||||||
|
Mock responses mirror the complete real structure.
|
||||||
|
|
||||||
|
A method only tests call lives in test utilities, not production.
|
||||||
|
|
||||||
|
About to assert on the mock itself?
|
||||||
|
Unmock it or delete the assertion.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tests Ship With the Implementation
|
||||||
|
|
||||||
|
The TDD cycle — failing test, minimal implementation, refactor — is what
|
||||||
|
"complete" means. Ship the tests the behavior needs and only those:
|
||||||
|
trivial code and human prose earn none, and a test written to satisfy
|
||||||
|
process costs maintenance forever.
|
||||||
|
|
||||||
|
## The Mutation Check
|
||||||
|
|
||||||
|
Before finishing, mentally mutate the production code; at least one test
|
||||||
|
should fail for each realistic mutation:
|
||||||
|
|
||||||
|
- Wrong constant or argument
|
||||||
|
- Wrong branch handler
|
||||||
|
- Missing state change or side effect
|
||||||
|
- Empty or default return
|
||||||
|
- Missing validation for zero, empty, nil, unauthorized, or malformed input
|
||||||
|
|
||||||
|
A mutation nothing catches marks the behavior as unprotected — or the
|
||||||
|
test as tautological.
|
||||||
|
|
||||||
|
## Quick Reference
|
||||||
|
|
||||||
|
| When you... | Do |
|
||||||
|
|-------------|-----|
|
||||||
|
| Write any test | Name the break it catches — a bug, not a decision |
|
||||||
|
| Build an expected value | Derive it by hand; never with the code under test |
|
||||||
|
| Test a script or document | Run it / pressure-test its consumer; never grep its text |
|
||||||
|
| Reach for a dependency test | Test your boundary contract, not their documented mechanics |
|
||||||
|
| Want to assert on a mocked element | Test the real component, or unmock it |
|
||||||
|
| Are about to mock a method | Learn its side effects; mock the slow/external level |
|
||||||
|
| Build a mock response | Mirror the real structure completely |
|
||||||
|
| Need cleanup only tests use | Put it in test utilities |
|
||||||
|
| Watch mock setup balloon | Switch to an integration test with real components |
|
||||||
|
| Finish a test file | Run the mutation check |
|
||||||
|
|
||||||
|
## Warning Signs
|
||||||
|
|
||||||
|
- Setup and assertion share the same object, guaranteeing equality
|
||||||
|
- The test can fail only through a panic, crash, or missing selector
|
||||||
|
- The test fails on every intentional change, never on accidental breakage
|
||||||
|
- Expected values are hidden behind loops, builders, or helpers
|
||||||
|
- The test greps source text, or asserts a removed symbol stays removed
|
||||||
|
- The test would still matter if only the framework remained
|
||||||
|
- The test exists for coverage, checking no side effect or outcome
|
||||||
|
- An assertion checks a `*-mock` test ID, or fails if you remove the mock
|
||||||
|
- A method is called only from test files
|
||||||
|
- Mock setup is more than half the test, or you can't explain why the mock is needed
|
||||||
|
- Mocking "just to be safe"
|
||||||
292
tests/codex/test-package-codex-plugin.sh
Executable file
292
tests/codex/test-package-codex-plugin.sh
Executable file
@@ -0,0 +1,292 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||||
|
REPO_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)"
|
||||||
|
SCRIPT_UNDER_TEST="$REPO_ROOT/scripts/package-codex-plugin.sh"
|
||||||
|
|
||||||
|
FAILURES=0
|
||||||
|
TEST_ROOT="$(mktemp -d)"
|
||||||
|
|
||||||
|
cleanup() {
|
||||||
|
rm -rf "$TEST_ROOT"
|
||||||
|
}
|
||||||
|
trap cleanup EXIT
|
||||||
|
|
||||||
|
pass() {
|
||||||
|
echo " [PASS] $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
fail() {
|
||||||
|
echo " [FAIL] $1"
|
||||||
|
FAILURES=$((FAILURES + 1))
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_equals() {
|
||||||
|
local actual="$1"
|
||||||
|
local expected="$2"
|
||||||
|
local description="$3"
|
||||||
|
|
||||||
|
if [[ "$actual" == "$expected" ]]; then
|
||||||
|
pass "$description"
|
||||||
|
else
|
||||||
|
fail "$description"
|
||||||
|
echo " expected: $expected"
|
||||||
|
echo " actual: $actual"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_contains() {
|
||||||
|
local haystack="$1"
|
||||||
|
local needle="$2"
|
||||||
|
local description="$3"
|
||||||
|
|
||||||
|
if printf '%s' "$haystack" | grep -Fq -- "$needle"; then
|
||||||
|
pass "$description"
|
||||||
|
else
|
||||||
|
fail "$description"
|
||||||
|
echo " expected to find: $needle"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
assert_not_matches() {
|
||||||
|
local haystack="$1"
|
||||||
|
local pattern="$2"
|
||||||
|
local description="$3"
|
||||||
|
|
||||||
|
if printf '%s' "$haystack" | grep -Eq -- "$pattern"; then
|
||||||
|
fail "$description"
|
||||||
|
echo " did not expect to match: $pattern"
|
||||||
|
else
|
||||||
|
pass "$description"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
list_archive() {
|
||||||
|
local archive_path="$1"
|
||||||
|
|
||||||
|
case "$archive_path" in
|
||||||
|
*.tar.gz|*.tgz)
|
||||||
|
tar -tzf "$archive_path"
|
||||||
|
;;
|
||||||
|
*.zip)
|
||||||
|
unzip -Z1 "$archive_path"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
unzip -Z1 "$archive_path"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
normalize_archive_paths() {
|
||||||
|
sed 's#/$##' | LC_ALL=C sort
|
||||||
|
}
|
||||||
|
|
||||||
|
extract_archive() {
|
||||||
|
local archive_path="$1"
|
||||||
|
local destination="$2"
|
||||||
|
|
||||||
|
mkdir -p "$destination"
|
||||||
|
case "$archive_path" in
|
||||||
|
*.tar.gz|*.tgz)
|
||||||
|
tar -xzf "$archive_path" -C "$destination"
|
||||||
|
;;
|
||||||
|
*.zip)
|
||||||
|
unzip -q "$archive_path" -d "$destination"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
unzip -q "$archive_path" -d "$destination"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
read_archive_file() {
|
||||||
|
local archive_path="$1"
|
||||||
|
local file_path="$2"
|
||||||
|
|
||||||
|
case "$archive_path" in
|
||||||
|
*.tar.gz|*.tgz)
|
||||||
|
tar -xOf "$archive_path" "$file_path"
|
||||||
|
;;
|
||||||
|
*.zip)
|
||||||
|
unzip -p "$archive_path" "$file_path"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
unzip -p "$archive_path" "$file_path"
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
write_metadata_fixture() {
|
||||||
|
local destination="$1"
|
||||||
|
local skill
|
||||||
|
|
||||||
|
while IFS= read -r skill; do
|
||||||
|
mkdir -p "$destination/skills/$skill/agents"
|
||||||
|
cat >"$destination/skills/$skill/agents/openai.yaml" <<EOF
|
||||||
|
interface:
|
||||||
|
display_name: "$skill"
|
||||||
|
short_description: "Fixture metadata for $skill"
|
||||||
|
EOF
|
||||||
|
done < <(find "$REPO_ROOT/skills" -mindepth 1 -maxdepth 1 -type d -print | sed 's#.*/##' | sort)
|
||||||
|
}
|
||||||
|
|
||||||
|
echo "Codex package archive tests"
|
||||||
|
|
||||||
|
metadata_source="$TEST_ROOT/metadata-source"
|
||||||
|
archive="$TEST_ROOT/superpowers"
|
||||||
|
tar_archive="$TEST_ROOT/superpowers.tar.gz"
|
||||||
|
extracted="$TEST_ROOT/extracted"
|
||||||
|
tar_extracted="$TEST_ROOT/tar-extracted"
|
||||||
|
write_metadata_fixture "$metadata_source"
|
||||||
|
|
||||||
|
source_hooks="$(python3 -c 'import json; print(json.load(open("'"$REPO_ROOT"'/.codex-plugin/plugin.json")).get("hooks"))')"
|
||||||
|
assert_equals "$source_hooks" "{}" "source Codex manifest suppresses local hook auto-discovery"
|
||||||
|
|
||||||
|
if output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$metadata_source" --output "$archive" 2>&1)"; then
|
||||||
|
pass "package script exits successfully"
|
||||||
|
else
|
||||||
|
fail "package script exits successfully"
|
||||||
|
printf '%s\n' "$output" | sed 's/^/ /'
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -f "$archive" ]]; then
|
||||||
|
pass "package script writes archive"
|
||||||
|
else
|
||||||
|
fail "package script writes archive"
|
||||||
|
fi
|
||||||
|
|
||||||
|
assert_contains "$output" "Archive:" "reports archive path"
|
||||||
|
assert_contains "$output" "Format: zip" "reports default zip format"
|
||||||
|
assert_contains "$output" "SHA-256:" "reports archive checksum"
|
||||||
|
|
||||||
|
extract_archive "$archive" "$extracted"
|
||||||
|
|
||||||
|
archive_paths="$(list_archive "$archive" | normalize_archive_paths)"
|
||||||
|
unexpected_pattern='(^superpowers/|^\.agents/|^hooks/|package\.json$|^\.git|^\.pytest_cache|^\.ruff_cache|^scripts/|^tests/|^docs/|^evals/|^lib/|^\.claude|^\.cursor|^\.kimi|^\.opencode|^\.pi|^AGENTS\.md$|^CLAUDE\.md$|^GEMINI\.md$|^RELEASE-NOTES\.md$|^CHANGELOG\.md$)'
|
||||||
|
assert_not_matches "$archive_paths" "$unexpected_pattern" "archive excludes source-only paths"
|
||||||
|
assert_contains "$archive_paths" ".codex-plugin/plugin.json" "archive includes Codex manifest"
|
||||||
|
assert_contains "$archive_paths" "skills/brainstorming/SKILL.md" "archive includes skills"
|
||||||
|
assert_contains "$archive_paths" "skills/brainstorming/agents/openai.yaml" "archive includes OpenAI skill metadata"
|
||||||
|
assert_contains "$archive_paths" "assets/app-icon.png" "archive includes app icon"
|
||||||
|
assert_contains "$archive_paths" "assets/superpowers-small.svg" "archive includes composer icon"
|
||||||
|
|
||||||
|
manifest_summary="$(read_archive_file "$archive" .codex-plugin/plugin.json | python3 -c 'import json,sys; data=json.load(sys.stdin); print("\t".join([data["name"], data["version"], data["skills"], str(data.get("hooks"))]))')"
|
||||||
|
expected_version="$(python3 -c 'import json; print(json.load(open("'"$REPO_ROOT"'/.codex-plugin/plugin.json"))["version"])')"
|
||||||
|
assert_equals "$manifest_summary" "superpowers $expected_version ./skills/ $source_hooks" "archive manifest preserves source hooks"
|
||||||
|
|
||||||
|
skill_count="$(find "$extracted/skills" -mindepth 1 -maxdepth 1 -type d | wc -l | tr -d ' ')"
|
||||||
|
metadata_count="$(find "$extracted/skills" -path '*/agents/openai.yaml' -type f | wc -l | tr -d ' ')"
|
||||||
|
assert_equals "$metadata_count" "$skill_count" "every packaged skill has OpenAI metadata"
|
||||||
|
|
||||||
|
if [[ -x "$extracted/skills/subagent-driven-development/scripts/task-brief" ]]; then
|
||||||
|
pass "archive preserves executable script mode"
|
||||||
|
else
|
||||||
|
fail "archive preserves executable script mode"
|
||||||
|
fi
|
||||||
|
|
||||||
|
zip_times="$(python3 - "$archive" <<'PY'
|
||||||
|
import sys
|
||||||
|
import zipfile
|
||||||
|
|
||||||
|
with zipfile.ZipFile(sys.argv[1]) as archive:
|
||||||
|
print("\n".join(sorted({str(info.date_time) for info in archive.infolist()})))
|
||||||
|
PY
|
||||||
|
)"
|
||||||
|
assert_equals "$zip_times" "(1980, 1, 1, 0, 0, 0)" "zip archive normalizes entry timestamps"
|
||||||
|
|
||||||
|
if tar_output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$metadata_source" --format tar.gz --output "$tar_archive" 2>&1)"; then
|
||||||
|
pass "package script writes explicit tar.gz archive"
|
||||||
|
else
|
||||||
|
fail "package script writes explicit tar.gz archive"
|
||||||
|
printf '%s\n' "$tar_output" | sed 's/^/ /'
|
||||||
|
fi
|
||||||
|
assert_contains "$tar_output" "Format: tar.gz" "reports explicit tar.gz format"
|
||||||
|
|
||||||
|
extract_archive "$tar_archive" "$tar_extracted"
|
||||||
|
tar_archive_paths="$(list_archive "$tar_archive" | normalize_archive_paths)"
|
||||||
|
assert_equals "$tar_archive_paths" "$archive_paths" "zip and tar.gz archives contain the same paths"
|
||||||
|
|
||||||
|
tar_task_brief_mode="$(tar -tzvf "$tar_archive" skills/subagent-driven-development/scripts/task-brief | awk '{print $1}')"
|
||||||
|
assert_equals "$tar_task_brief_mode" "-rwxr-xr-x" "tar.gz archive preserves executable script mode"
|
||||||
|
|
||||||
|
tar_metadata_times="$(tar -tzvf "$tar_archive" | awk '{print $6, $7, $8}' | sort -u)"
|
||||||
|
assert_equals "$tar_metadata_times" "Dec 31 1969" "tar.gz archive normalizes entry timestamps"
|
||||||
|
|
||||||
|
metadata_archive="$TEST_ROOT/metadata-source.tar.gz"
|
||||||
|
metadata_zip="$TEST_ROOT/metadata-source.zip"
|
||||||
|
archive_from_tar_source="$TEST_ROOT/superpowers-from-tar-source.zip"
|
||||||
|
archive_from_zip_source="$TEST_ROOT/superpowers-from-zip-source.zip"
|
||||||
|
(
|
||||||
|
cd "$metadata_source"
|
||||||
|
tar -czf "$metadata_archive" .
|
||||||
|
zip -X -q -r "$metadata_zip" .
|
||||||
|
)
|
||||||
|
|
||||||
|
if output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$metadata_archive" --output "$archive_from_tar_source" 2>&1)"; then
|
||||||
|
pass "package script accepts tarball metadata source"
|
||||||
|
else
|
||||||
|
fail "package script accepts tarball metadata source"
|
||||||
|
printf '%s\n' "$output" | sed 's/^/ /'
|
||||||
|
fi
|
||||||
|
|
||||||
|
if cmp -s "$archive" "$archive_from_tar_source"; then
|
||||||
|
pass "tarball metadata source produces identical archive"
|
||||||
|
else
|
||||||
|
fail "tarball metadata source produces identical archive"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$metadata_zip" --output "$archive_from_zip_source" 2>&1)"; then
|
||||||
|
pass "package script accepts zip metadata source"
|
||||||
|
else
|
||||||
|
fail "package script accepts zip metadata source"
|
||||||
|
printf '%s\n' "$output" | sed 's/^/ /'
|
||||||
|
fi
|
||||||
|
|
||||||
|
if cmp -s "$archive" "$archive_from_zip_source"; then
|
||||||
|
pass "zip metadata source produces identical archive"
|
||||||
|
else
|
||||||
|
fail "zip metadata source produces identical archive"
|
||||||
|
fi
|
||||||
|
|
||||||
|
incomplete_metadata="$TEST_ROOT/incomplete-metadata"
|
||||||
|
mkdir -p "$incomplete_metadata/skills/brainstorming/agents"
|
||||||
|
cp "$metadata_source/skills/brainstorming/agents/openai.yaml" \
|
||||||
|
"$incomplete_metadata/skills/brainstorming/agents/openai.yaml"
|
||||||
|
|
||||||
|
set +e
|
||||||
|
missing_output="$("$SCRIPT_UNDER_TEST" --allow-dirty --metadata-source "$incomplete_metadata" --output "$TEST_ROOT/missing.tar.gz" 2>&1)"
|
||||||
|
missing_status=$?
|
||||||
|
set -e
|
||||||
|
if [[ "$missing_status" -ne 0 ]]; then
|
||||||
|
pass "package script rejects incomplete metadata source"
|
||||||
|
else
|
||||||
|
fail "package script rejects incomplete metadata source"
|
||||||
|
fi
|
||||||
|
assert_contains "$missing_output" "ERROR: metadata source is incomplete" "incomplete metadata reports clear error"
|
||||||
|
|
||||||
|
dirty_repo="$TEST_ROOT/dirty-repo"
|
||||||
|
git clone -q --no-local "$REPO_ROOT" "$dirty_repo"
|
||||||
|
printf '\n# dirty fixture\n' >>"$dirty_repo/README.md"
|
||||||
|
set +e
|
||||||
|
dirty_output="$(
|
||||||
|
cd "$dirty_repo"
|
||||||
|
scripts/package-codex-plugin.sh \
|
||||||
|
--metadata-source "$metadata_source" \
|
||||||
|
--output "$TEST_ROOT/dirty.zip" 2>&1
|
||||||
|
)"
|
||||||
|
dirty_status=$?
|
||||||
|
set -e
|
||||||
|
if [[ "$dirty_status" -ne 0 ]]; then
|
||||||
|
pass "package script rejects dirty worktree by default"
|
||||||
|
else
|
||||||
|
fail "package script rejects dirty worktree by default"
|
||||||
|
fi
|
||||||
|
assert_contains "$dirty_output" "Working tree has uncommitted changes:" "dirty worktree reports changed files"
|
||||||
|
|
||||||
|
if [[ "$FAILURES" -eq 0 ]]; then
|
||||||
|
echo "All Codex package archive tests passed"
|
||||||
|
else
|
||||||
|
echo "$FAILURES Codex package archive test(s) failed"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
Reference in New Issue
Block a user