@seflless/ghosttown 1.5.0 → 1.6.1

package/src/cli.test.sh

@@ -0,0 +1,605 @@
+#!/bin/bash
+
+# =============================================================================
+# Ghosttown CLI Test Suite
+# =============================================================================
+#
+# This test file validates the session management functionality of the
+# ghosttown CLI. It covers session creation, naming, renaming, and the
+# stable ID system that enables rename-resilient URLs.
+#
+# IMPORTANT FOR AI AGENTS:
+# ------------------------
+# When making changes to session management code, run this test suite to
+# verify your changes don't break existing functionality. If you add new
+# features, add corresponding tests here.
+#
+# Run with: bash src/cli.test.sh
+#
+# The tests use tmux directly to verify behavior, so tmux must be installed.
+# Tests clean up after themselves by killing any gt-test-* sessions created.
+#
+# =============================================================================
+
+set -e
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+CYAN='\033[0;36m'
+NC='\033[0m' # No Color
+
+# Test counters
+TESTS_RUN=0
+TESTS_PASSED=0
+TESTS_FAILED=0
+
+# Prefix for test sessions (to avoid conflicts with real sessions)
+TEST_PREFIX="gt-test-"
+
+# =============================================================================
+# Test Utilities
+# =============================================================================
+
+# Print a test description
+test_start() {
+  TESTS_RUN=$((TESTS_RUN + 1))
+  echo -e "${CYAN}TEST $TESTS_RUN:${NC} $1"
+}
+
+# Mark test as passed
+test_pass() {
+  TESTS_PASSED=$((TESTS_PASSED + 1))
+  echo -e "  ${GREEN}✓ PASSED${NC}"
+}
+
+# Mark test as failed
+test_fail() {
+  TESTS_FAILED=$((TESTS_FAILED + 1))
+  echo -e "  ${RED}✗ FAILED:${NC} $1"
+}
+
+# Assert that a condition is true
+assert() {
+  if eval "$1"; then
+    return 0
+  else
+    return 1
+  fi
+}
+
+# Assert string contains substring
+assert_contains() {
+  if [[ "$1" == *"$2"* ]]; then
+    return 0
+  else
+    return 1
+  fi
+}
+
+# Assert string matches regex
+assert_matches() {
+  if [[ "$1" =~ $2 ]]; then
+    return 0
+  else
+    return 1
+  fi
+}
+
+# Clean up any test sessions
+cleanup_test_sessions() {
+  # Kill all sessions starting with gt-test-
+  tmux list-sessions -F "#{session_name}" 2>/dev/null | grep "^gt-test-" | while read -r session; do
+    tmux kill-session -t "$session" 2>/dev/null || true
+  done
+  # Also clean up temp sessions
+  tmux list-sessions -F "#{session_name}" 2>/dev/null | grep "^gt-temp-" | while read -r session; do
+    tmux kill-session -t "$session" 2>/dev/null || true
+  done
+}
+
+# Create a test session directly via tmux (bypassing CLI for setup)
+create_test_session() {
+  local name="$1"
+  tmux new-session -d -s "$name" -x 80 -y 24
+}
+
+# Get session info in format: session_name|session_id
+get_session_info() {
+  local name="$1"
+  tmux list-sessions -F "#{session_name}|#{session_id}" 2>/dev/null | grep "^$name|" || echo ""
+}
+
+# =============================================================================
+# Test: Session Name Validation
+# =============================================================================
+
+test_session_name_validation() {
+  test_start "Session name validation - valid names"
+
+  # Valid names should pass (we test the validation logic indirectly)
+  # Valid: alphanumeric, hyphens, underscores
+  local valid_names=("my-session" "test_session" "Session123" "a" "a-b_c")
+  local all_valid=true
+
+  for name in "${valid_names[@]}"; do
+    # Names that are purely numeric should fail, others should pass
+    if [[ "$name" =~ ^[0-9]+$ ]]; then
+      all_valid=false
+      break
+    fi
+    # Names with invalid chars should fail
+    if [[ ! "$name" =~ ^[a-zA-Z0-9_-]+$ ]]; then
+      all_valid=false
+      break
+    fi
+  done
+
+  if $all_valid; then
+    test_pass
+  else
+    test_fail "Valid names were rejected"
+  fi
+}
+
+test_session_name_validation_invalid() {
+  test_start "Session name validation - invalid names rejected"
+
+  # These should all be invalid:
+  # - Purely numeric (conflicts with auto-generated IDs)
+  # - Contains spaces or special chars
+  # - Empty
+  local invalid_names=("123" "my session" "test@session" "")
+  local all_rejected=true
+
+  for name in "${invalid_names[@]}"; do
+    # Purely numeric should be rejected
+    if [[ "$name" =~ ^[0-9]+$ ]]; then
+      continue  # This is correctly invalid
+    fi
+    # Empty should be rejected
+    if [[ -z "$name" ]]; then
+      continue  # This is correctly invalid
+    fi
+    # Invalid chars should be rejected
+    if [[ ! "$name" =~ ^[a-zA-Z0-9_-]+$ ]]; then
+      continue  # This is correctly invalid
+    fi
+    # If we get here, the name passed validation but shouldn't have
+    all_rejected=false
+  done
+
+  if $all_rejected; then
+    test_pass
+  else
+    test_fail "Invalid names were accepted"
+  fi
+}
+
+# =============================================================================
+# Test: Session Naming Format
+# =============================================================================
+#
+# BEHAVIOR: Sessions use format gt-<stableId>-<displayName>
+# - stableId: Numeric part of tmux's internal $N session ID
+# - displayName: User-facing name (custom or auto-generated number)
+#
+# This enables rename-resilient URLs: even if displayName changes,
+# the stableId remains constant.
+#
+# =============================================================================
+
+test_session_naming_format() {
+  test_start "Session naming format - gt-<stableId>-<displayName>"
+
+  cleanup_test_sessions
+
+  # Create a session via the API simulation
+  # We'll create it manually with the expected format
+  local temp_name="gt-temp-$$"
+  tmux new-session -d -s "$temp_name" -x 80 -y 24
+
+  # Get the session ID
+  local session_id
+  session_id=$(tmux list-sessions -F "#{session_name}|#{session_id}" | grep "^$temp_name|" | cut -d'|' -f2 | tr -d '$')
+
+  # Rename to final format
+  local final_name="gt-${session_id}-testname"
+  tmux rename-session -t "$temp_name" "$final_name"
+
+  # Verify the session exists with correct format
+  if tmux has-session -t "$final_name" 2>/dev/null; then
+    test_pass
+    tmux kill-session -t "$final_name" 2>/dev/null || true
+  else
+    test_fail "Session not created with expected format"
+  fi
+}
+
+test_parse_session_name() {
+  test_start "Parse session name - extracts stableId and displayName"
+
+  # Test parsing logic
+  # Format: gt-<stableId>-<displayName>
+  local test_name="gt-42-my-cool-session"
+
+  # Extract stableId (first number after gt-)
+  local stable_id
+  if [[ "$test_name" =~ ^gt-([0-9]+)-(.+)$ ]]; then
+    stable_id="${BASH_REMATCH[1]}"
+    local display_name="${BASH_REMATCH[2]}"
+
+    if [[ "$stable_id" == "42" ]] && [[ "$display_name" == "my-cool-session" ]]; then
+      test_pass
+    else
+      test_fail "Parsed values incorrect: stableId=$stable_id, displayName=$display_name"
+    fi
+  else
+    test_fail "Regex did not match"
+  fi
+}
+
+test_legacy_session_name_parsing() {
+  test_start "Legacy session name parsing - handles old gt-<name> format"
+
+  # BEHAVIOR: Old sessions without stableId should still work
+  # They get stableId=null and displayName=<everything after gt->
+
+  local legacy_name="gt-old-session"
+
+  # This should NOT match the new format
+  if [[ "$legacy_name" =~ ^gt-([0-9]+)-(.+)$ ]]; then
+    test_fail "Legacy name incorrectly matched new format"
+  else
+    # Extract display name for legacy format
+    local display_name="${legacy_name#gt-}"
+    if [[ "$display_name" == "old-session" ]]; then
+      test_pass
+    else
+      test_fail "Legacy display name extraction failed"
+    fi
+  fi
+}
+
+# =============================================================================
+# Test: Session Rename Preserves Stable ID
+# =============================================================================
+#
+# BEHAVIOR: When renaming a session, the stableId prefix is preserved.
+# This allows URLs using the stableId to continue working after rename.
+#
+# =============================================================================
+
+test_rename_preserves_stable_id() {
+  test_start "Rename preserves stable ID"
+
+  cleanup_test_sessions
+
+  # Create a session with stable ID format
+  local temp_name="gt-temp-$$"
+  tmux new-session -d -s "$temp_name" -x 80 -y 24
+
+  local session_id
+  session_id=$(tmux list-sessions -F "#{session_name}|#{session_id}" | grep "^$temp_name|" | cut -d'|' -f2 | tr -d '$')
+
+  local original_name="gt-${session_id}-original"
+  tmux rename-session -t "$temp_name" "$original_name"
+
+  # Now rename to a new display name, preserving stable ID
+  local new_name="gt-${session_id}-renamed"
+  tmux rename-session -t "$original_name" "$new_name"
+
+  # Verify the session exists with new name but same stable ID
+  if tmux has-session -t "$new_name" 2>/dev/null; then
+    # Extract stable ID from new name
+    if [[ "$new_name" =~ ^gt-([0-9]+)- ]]; then
+      local extracted_id="${BASH_REMATCH[1]}"
+      if [[ "$extracted_id" == "$session_id" ]]; then
+        test_pass
+      else
+        test_fail "Stable ID changed after rename: expected $session_id, got $extracted_id"
+      fi
+    else
+      test_fail "New name doesn't match expected format"
+    fi
+    tmux kill-session -t "$new_name" 2>/dev/null || true
+  else
+    test_fail "Session not found after rename"
+  fi
+}
+
+# =============================================================================
+# Test: Find Session by Stable ID
+# =============================================================================
+#
+# BEHAVIOR: Sessions can be looked up by their stable ID regardless of
+# their current display name. This is how the web UI connects after rename.
+#
+# =============================================================================
+
+test_find_session_by_stable_id() {
+  test_start "Find session by stable ID"
+
+  cleanup_test_sessions
+
+  # Create a session
+  local temp_name="gt-temp-$$"
+  tmux new-session -d -s "$temp_name" -x 80 -y 24
+
+  local session_id
+  session_id=$(tmux list-sessions -F "#{session_name}|#{session_id}" | grep "^$temp_name|" | cut -d'|' -f2 | tr -d '$')
+
+  local session_name="gt-${session_id}-findme"
+  tmux rename-session -t "$temp_name" "$session_name"
+
+  # Search for session by stable ID
+  local found=""
+  while IFS= read -r line; do
+    if [[ "$line" =~ ^gt-${session_id}- ]]; then
+      found="$line"
+      break
+    fi
+  done < <(tmux list-sessions -F "#{session_name}" 2>/dev/null)
+
+  if [[ -n "$found" ]]; then
+    test_pass
+    tmux kill-session -t "$session_name" 2>/dev/null || true
+  else
+    test_fail "Could not find session by stable ID $session_id"
+  fi
+}
+
+test_find_session_by_display_name() {
+  test_start "Find session by display name (legacy support)"
+
+  cleanup_test_sessions
+
+  # Create a session
+  local temp_name="gt-temp-$$"
+  tmux new-session -d -s "$temp_name" -x 80 -y 24
+
+  local session_id
+  session_id=$(tmux list-sessions -F "#{session_name}|#{session_id}" | grep "^$temp_name|" | cut -d'|' -f2 | tr -d '$')
+
+  local display_name="unique-test-name-$$"
+  local session_name="gt-${session_id}-${display_name}"
+  tmux rename-session -t "$temp_name" "$session_name"
+
+  # Search for session by display name
+  local found=""
+  while IFS= read -r line; do
+    # Parse the session name
+    if [[ "$line" =~ ^gt-[0-9]+-(.+)$ ]]; then
+      local parsed_display="${BASH_REMATCH[1]}"
+      if [[ "$parsed_display" == "$display_name" ]]; then
+        found="$line"
+        break
+      fi
+    fi
+  done < <(tmux list-sessions -F "#{session_name}" 2>/dev/null)
+
+  if [[ -n "$found" ]]; then
+    test_pass
+    tmux kill-session -t "$session_name" 2>/dev/null || true
+  else
+    test_fail "Could not find session by display name $display_name"
+  fi
+}
+
+# =============================================================================
+# Test: Auto-generated Display Names
+# =============================================================================
+#
+# BEHAVIOR: When no custom name is provided, sessions get auto-generated
+# numeric display names (1, 2, 3, etc.) based on the highest existing number.
+#
+# =============================================================================
+
+test_auto_generated_display_names() {
+  test_start "Auto-generated display names increment correctly"
+
+  cleanup_test_sessions
+
+  # Create sessions with numeric display names
+  # Simulate gt-<id>-1, gt-<id>-2 format
+
+  # Session 1
+  local temp1="gt-temp-1-$$"
+  tmux new-session -d -s "$temp1" -x 80 -y 24
+  local id1
+  id1=$(tmux list-sessions -F "#{session_name}|#{session_id}" | grep "^$temp1|" | cut -d'|' -f2 | tr -d '$')
+  tmux rename-session -t "$temp1" "gt-${id1}-1"
+
+  # Session 2
+  local temp2="gt-temp-2-$$"
+  tmux new-session -d -s "$temp2" -x 80 -y 24
+  local id2
+  id2=$(tmux list-sessions -F "#{session_name}|#{session_id}" | grep "^$temp2|" | cut -d'|' -f2 | tr -d '$')
+  tmux rename-session -t "$temp2" "gt-${id2}-2"
+
+  # Now find the next available number
+  local max_num=0
+  while IFS= read -r line; do
+    if [[ "$line" =~ ^gt-[0-9]+-([0-9]+)$ ]]; then
+      local num="${BASH_REMATCH[1]}"
+      if (( num > max_num )); then
+        max_num=$num
+      fi
+    fi
+  done < <(tmux list-sessions -F "#{session_name}" 2>/dev/null)
+
+  local next_num=$((max_num + 1))
+
+  if [[ "$next_num" == "3" ]]; then
+    test_pass
+  else
+    test_fail "Expected next number to be 3, got $next_num"
+  fi
+
+  # Cleanup
+  tmux kill-session -t "gt-${id1}-1" 2>/dev/null || true
+  tmux kill-session -t "gt-${id2}-2" 2>/dev/null || true
+}
+
+# =============================================================================
+# Test: Display Name Uniqueness
+# =============================================================================
+#
+# BEHAVIOR: Two sessions cannot have the same display name, even if they
+# have different stable IDs.
+#
+# =============================================================================
+
+test_display_name_uniqueness() {
+  test_start "Display names must be unique"
+
+  cleanup_test_sessions
+
+  # Create a session with a specific display name
+  local temp1="gt-temp-1-$$"
+  tmux new-session -d -s "$temp1" -x 80 -y 24
+  local id1
+  id1=$(tmux list-sessions -F "#{session_name}|#{session_id}" | grep "^$temp1|" | cut -d'|' -f2 | tr -d '$')
+  local display_name="unique-name-$$"
+  tmux rename-session -t "$temp1" "gt-${id1}-${display_name}"
+
+  # Check if display name already exists (simulating validation)
+  local exists=false
+  while IFS= read -r line; do
+    if [[ "$line" =~ ^gt-[0-9]+-(.+)$ ]]; then
+      if [[ "${BASH_REMATCH[1]}" == "$display_name" ]]; then
+        exists=true
+        break
+      fi
+    fi
+  done < <(tmux list-sessions -F "#{session_name}" 2>/dev/null)
+
+  if $exists; then
+    test_pass
+  else
+    test_fail "Display name uniqueness check failed"
+  fi
+
+  # Cleanup
+  tmux kill-session -t "gt-${id1}-${display_name}" 2>/dev/null || true
+}
+
+# =============================================================================
+# Test: URL Format
+# =============================================================================
+#
+# BEHAVIOR: URLs use format /?session=<displayName>&id=<stableId>
+# - session: Human-readable display name
+# - id: Stable ID for rename resilience
+#
+# The system tries to look up by stable ID first, then by display name.
+#
+# =============================================================================
+
+test_url_format() {
+  test_start "URL format includes both display name and stable ID"
+
+  # Simulate URL construction
+  local display_name="my-session"
+  local stable_id="42"
+
+  local url="/?session=${display_name}&id=${stable_id}"
+
+  # Parse it back
+  # Extract session param
+  if [[ "$url" =~ session=([^&]+) ]]; then
+    local parsed_session="${BASH_REMATCH[1]}"
+  fi
+
+  # Extract id param
+  if [[ "$url" =~ id=([^&]+) ]]; then
+    local parsed_id="${BASH_REMATCH[1]}"
+  fi
+
+  if [[ "$parsed_session" == "$display_name" ]] && [[ "$parsed_id" == "$stable_id" ]]; then
+    test_pass
+  else
+    test_fail "URL parsing failed: session=$parsed_session, id=$parsed_id"
+  fi
+}
+
+# =============================================================================
+# Run All Tests
+# =============================================================================
+
+main() {
+  echo ""
+  echo -e "${YELLOW}==============================================================================${NC}"
+  echo -e "${YELLOW}                     Ghosttown CLI Test Suite${NC}"
+  echo -e "${YELLOW}==============================================================================${NC}"
+  echo ""
+
+  # Ensure tmux is installed
+  if ! command -v tmux &> /dev/null; then
+    echo -e "${RED}ERROR: tmux is not installed. Tests require tmux.${NC}"
+    exit 1
+  fi
+
+  # Clean up any leftover test sessions
+  cleanup_test_sessions
+
+  echo -e "${CYAN}Running tests...${NC}"
+  echo ""
+
+  # Session Name Validation
+  test_session_name_validation
+  test_session_name_validation_invalid
+
+  # Session Naming Format
+  test_session_naming_format
+  test_parse_session_name
+  test_legacy_session_name_parsing
+
+  # Rename Behavior
+  test_rename_preserves_stable_id
+
+  # Session Lookup
+  test_find_session_by_stable_id
+  test_find_session_by_display_name
+
+  # Auto-generated Names
+  test_auto_generated_display_names
+
+  # Display Name Uniqueness
+  test_display_name_uniqueness
+
+  # URL Format
+  test_url_format
+
+  # Final cleanup
+  cleanup_test_sessions
+
+  # Print summary
+  echo ""
+  echo -e "${YELLOW}==============================================================================${NC}"
+  echo -e "${YELLOW}                           Test Summary${NC}"
+  echo -e "${YELLOW}==============================================================================${NC}"
+  echo ""
+  echo -e "  Tests run:    ${TESTS_RUN}"
+  echo -e "  ${GREEN}Passed:       ${TESTS_PASSED}${NC}"
+  if [[ $TESTS_FAILED -gt 0 ]]; then
+    echo -e "  ${RED}Failed:       ${TESTS_FAILED}${NC}"
+  else
+    echo -e "  Failed:       ${TESTS_FAILED}"
+  fi
+  echo ""
+
+  if [[ $TESTS_FAILED -gt 0 ]]; then
+    echo -e "${RED}SOME TESTS FAILED${NC}"
+    exit 1
+  else
+    echo -e "${GREEN}ALL TESTS PASSED${NC}"
+    exit 0
+  fi
+}
+
+# Run main if script is executed directly
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  main "$@"
+fi

package/src/cli.test.ts

@@ -0,0 +1,75 @@
+/**
+ * CLI tests
+ *
+ * Tests for the ghosttown CLI command-line interface.
+ */
+
+import { describe, expect, test } from 'bun:test';
+import { spawn } from 'child_process';
+import { join } from 'path';
+import { fileURLToPath } from 'url';
+
+const __dirname = join(fileURLToPath(import.meta.url), '..');
+const CLI_PATH = join(__dirname, '..', 'bin', 'gt.js');
+
+/**
+ * Run the CLI with given arguments and return stdout/stderr/exit code
+ */
+function runCli(args: string[]): Promise<{ stdout: string; stderr: string; code: number }> {
+  return new Promise((resolve) => {
+    const proc = spawn('node', [CLI_PATH, ...args], {
+      stdio: ['pipe', 'pipe', 'pipe'],
+    });
+
+    let stdout = '';
+    let stderr = '';
+
+    proc.stdout.on('data', (data) => {
+      stdout += data.toString();
+    });
+
+    proc.stderr.on('data', (data) => {
+      stderr += data.toString();
+    });
+
+    proc.on('close', (code) => {
+      resolve({ stdout, stderr, code: code ?? 1 });
+    });
+  });
+}
+
+describe('CLI', () => {
+  describe('version flag', () => {
+    test('-v should print version and exit', async () => {
+      const result = await runCli(['-v']);
+      expect(result.code).toBe(0);
+      expect(result.stdout.trim()).toMatch(/^\d+\.\d+\.\d+$/);
+      expect(result.stderr).toBe('');
+    });
+
+    test('--version should print version and exit', async () => {
+      const result = await runCli(['--version']);
+      expect(result.code).toBe(0);
+      expect(result.stdout.trim()).toMatch(/^\d+\.\d+\.\d+$/);
+      expect(result.stderr).toBe('');
+    });
+  });
+
+  describe('help flag', () => {
+    test('-h should print help and exit', async () => {
+      const result = await runCli(['-h']);
+      expect(result.code).toBe(0);
+      expect(result.stdout).toContain('Usage: ghosttown');
+      expect(result.stdout).toContain('--version');
+      expect(result.stdout).toContain('--help');
+      expect(result.stderr).toBe('');
+    });
+
+    test('--help should print help and exit', async () => {
+      const result = await runCli(['--help']);
+      expect(result.code).toBe(0);
+      expect(result.stdout).toContain('Usage: ghosttown');
+      expect(result.stderr).toBe('');
+    });
+  });
+});