un-inception/CLAUDE.md
russell@unturf.com 8695578d89 feat: add smart multi-language testing strategy for client SDK growth
Add comprehensive testing infrastructure for UN clients:

1. Smart Change Detection (detect-changes.sh)
   - Detects changes in BOTH root-level (un.py, un.go) AND clients/ directory
   - Maps file extensions and directory names to languages
   - Triggers test_all when infrastructure changes

2. Language-Specific CI Matrix (generate-matrix.sh compatible)
   - Only runs tests for languages with changes
   - Example: modify clients/python/ → pytest runs, Go/Ruby skipped

3. Testing Strategy Document (TESTING-STRATEGY.md)
   - Complete testing matrix by language tier (compiled, interpreted, inception)
   - Unit, integration, embedding, and parity tests
   - Inception pattern for languages without local interpreters
   - Common failures and fixes
   - Rollout schedule for client/ migration

4. Makefile Targets
   - 'make test-python', 'make test-go', etc. for local development
   - 'make test-all' for comprehensive testing
   - 'make test-integration' for API contract validation
   - 'make test-ci-locally' to simulate CI pipeline

5. Updated CLAUDE.md
   - Documents SDK architecture (in growth state)
   - Explains three purposes: CLI, library, embeddable
   - References TESTING-STRATEGY.md for details

This enables:
✓ Per-language testing (only run what changed)
✓ Local developer workflow (make test-LANG)
✓ 42+ language feature parity validation
✓ Cross-language integration testing
2026-01-15 15:52:40 -05:00

9.3 KiB

Claude AI Instructions for un-inception

⚠️ CRITICAL: NEVER USE RAW LXC COMMANDS

ALWAYS use un CLI commands. NEVER use raw lxc commands on production.

# ✅ CORRECT - use un commands
un2 service --list
un2 service --destroy <id>
un2 service --execute <id> 'command'

# ❌ FORBIDDEN - raw lxc commands bypass auth and state sync
lxc list / lxc delete / lxc stop / lxc exec

On 2026-01-11, raw lxc delete destroyed 8 production services causing complete data loss.

Commit Messages

NEVER add Claude attribution to commit messages. No robot emoji, no "Generated with Claude Code", no "Co-Authored-By: Claude". Just write the commit message like a human wrote it.

Project Overview

UN CLI Inception - The UN CLI written in every language it can execute. 42+ implementations, one unified interface.

SDK Architecture (In Growth)

Current State: Root-level implementations (un.py, un.c, un.go, etc.) serving as both CLI + embeddable libraries.

Target State: Migrate to clients/ directory structure:

clients/
├── python/        # clients/python/un.py - sync/async client + CLI
├── javascript/    # clients/javascript/un.js - SDK + CLI
├── go/            # clients/go/un.go - SDK + CLI
├── java/          # clients/java/Un.java - SDK + CLI
├── ruby/          # clients/ruby/un.rb - SDK + CLI
├── php/           # clients/php/un.php - SDK + CLI
├── rust/          # clients/rust/un.rs - SDK + CLI
├── {42+ more}/

Each client implementation serves THREE purposes:

  1. Standalone CLI program - Argparse/getopt with full command support (execute, session, service)
  2. Importable client library - Can import and use as an SDK in other code
  3. Embeddable library - Can be bundled into other language projects

Example (Python):

# As CLI: python clients/python/un.py test/fib.py
# As library: from clients.python.un import UnsandboxClient
# As embedded: copy un.py into your project, import locally

Migration Path:

  • Phase 1 (Current): Grow clients/ directory in parallel with root un.* files
  • Phase 2: Root files eventually deprecated in favor of clients/
  • Phase 3: Root files maintained for backwards compatibility only

Authentication

HMAC Authentication (current):

export UNSANDBOX_PUBLIC_KEY="unsb-pk-xxxx-xxxx-xxxx-xxxx"
export UNSANDBOX_SECRET_KEY="unsb-sk-xxxxx-xxxxx-xxxxx-xxxxx"

The auth pattern for all implementations:

  • Authorization: Bearer {public_key}
  • X-Timestamp: {unix_seconds}
  • X-Signature: HMAC-SHA256(secret_key, "timestamp:METHOD:path:body")

Legacy UNSANDBOX_API_KEY is still supported as fallback.

HMAC Dependencies

Each implementation needs HMAC-SHA256 capability:

Language Dependency Install
Python hmac, hashlib Built-in
JavaScript/TS crypto Built-in (Node.js)
Ruby openssl Built-in
Go crypto/hmac Built-in
PHP hash_hmac() Built-in
Perl Digest::SHA Core module
Lua openssl CLI apt install openssl
Bash openssl CLI apt install openssl
Rust hmac, sha2 cargo add hmac sha2
C/C++ OpenSSL apt install libssl-dev + -lssl -lcrypto
Java javax.crypto Built-in
C# System.Security.Cryptography Built-in
Haskell cryptonite cabal install cryptonite
Clojure buddy-core Add to deps.edn
Erlang/Elixir :crypto OTP built-in
Julia SHA Built-in
R openssl install.packages("openssl")

Note: Languages without native HMAC (Lua, Bash, AWK, Forth) shell out to openssl dgst -sha256 -hmac.

The Inception Matrix - Testing Languages Without Local Interpreters

CRITICAL INSIGHT: Use un (the C implementation) to run tests for languages not installed locally!

If a language isn't available on the local machine (e.g., PHP, Julia, Haskell), run the UN implementation through unsandbox itself:

# Key flags:
# -n semitrusted  = allow network access so inner script can call API
# -e KEY=VALUE    = pass API keys to inner script

# Don't have PHP installed? Run un.php through unsandbox!
un -n semitrusted -e UNSANDBOX_PUBLIC_KEY=$UNSANDBOX_PUBLIC_KEY -e UNSANDBOX_SECRET_KEY=$UNSANDBOX_SECRET_KEY un.php test/fib.py

# Don't have Julia? Run un.jl through unsandbox!
un -n semitrusted -e UNSANDBOX_PUBLIC_KEY=$UNSANDBOX_PUBLIC_KEY -e UNSANDBOX_SECRET_KEY=$UNSANDBOX_SECRET_KEY un.jl test/fib.py

This is the inception - using un to run un to run code. Each layer executes through unsandbox's remote execution API.

Inception Test Matrix

To test ALL 42 implementations regardless of local interpreters:

# Use un (C implementation) to test all others through unsandbox
for impl in un.py un.js un.rb un.go un.php un.pl un.lua; do
    echo "Testing $impl..."
    un -n semitrusted \
       -e UNSANDBOX_PUBLIC_KEY=$UNSANDBOX_PUBLIC_KEY \
       -e UNSANDBOX_SECRET_KEY=$UNSANDBOX_SECRET_KEY \
       "$impl" test/fib.py
done

The test suite in tests/run_all_tests.sh currently skips languages without local interpreters. Use the inception pattern with un to achieve 100% test coverage.

Directory Structure

  • un.* - 42 UN CLI implementations (un.py, un.js, un.rb, un.go, etc.)
  • tests/ - Test suites for each implementation
  • test/ - Shared test files (fib.py, fib.sh, etc.)

Running Tests

Local Testing

# Set auth
export UNSANDBOX_PUBLIC_KEY="unsb-pk-zhi3-b6cv-jvqc-uven"
export UNSANDBOX_SECRET_KEY="unsb-sk-z4a93-a33xy-7u7eh-pngpg"

# Run all available tests
./tests/run_all_tests.sh

# Run individual test
python3 tests/test_un_py.py
lua tests/test_un_lua.lua
bash tests/test_un_sh.sh

# Run client-specific tests (after migration to clients/)
make test-python
make test-go
make test-javascript

CI Testing Strategy (Smart Detection)

When changes are pushed:

  1. Change Detection - detect-changes.sh identifies which files changed
  2. Per-Language Tests - Only language tests for CHANGED clients run (e.g., modify clients/python/ → pytest runs)
  3. Cross-Language Tests - All affected clients validated against API
  4. Science Jobs - Pool burning with real workloads

Example: Modify clients/python/un.py:

✓ Python pytest runs
✓ Python type checking (if applicable)
✓ Python integration tests with API
✓ Python embedding tests (can import in other code)
⚠ Go, Ruby, JavaScript tests SKIP (unchanged)

See TESTING-STRATEGY.md for complete testing matrix.

Common Test Fixes

Bash arithmetic in set -e mode

The pattern ((VAR++)) returns exit code 1 when VAR is 0. Use VAR=$((VAR + 1)) instead.

Script directory detection

  • Lua: arg[0]:match("(.*/)") or "./"
  • TypeScript: path.dirname(process.argv[1] || __filename)
  • Bash: SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

Shebang lines

Shebang MUST be on line 1, not buried in license headers.

Keeping Implementations in Sync

CRITICAL: ALL 38 implementations must have feature parity.

When adding a new feature to the CLI (e.g., new flag, new command):

  1. Update the canonical C implementation at ~/git/unsandbox.com/cli/un.c
  2. Update ALL 38 implementations in this repo - not just "main" ones, ALL of them
  3. Use the Task agent to batch update if needed

Current implementations (ALL must be updated):

un.awk un.clj un.cob un.cpp un.cr un.d un.dart un.erl un.ex un.f90
un.forth un.fs un.go un.groovy un.hs un.jl un.js un.kt un.lisp un.lua
un.m un.ml un.nim un.php un.pl un.pro un.ps1 un.py un.r un.raku
un.rb un.rs un.scm un.sh un.tcl un.ts un.v un.zig

Feature Checklist

Each implementation must support:

  • Execute: un file.py - run code with -e ENV=val, -f FILE, -n MODE, -a artifacts
  • Session: un session - interactive shell with -f FILE, --tmux, --screen, --list, --attach, --kill
  • Service: un service - persistent services with -f FILE, --name, --ports, --bootstrap, --bootstrap-file, --list, --info, --logs, --destroy

The -f FILE flag must work for ALL three commands (execute, session, service) - files go to /tmp/ in the container.

Git Remotes & Mirroring

This repo pushes to multiple remotes automatically. No git hooks needed - just uses git's built-in multi-push URL feature.

Remotes:

  • origin - Primary (fetches from unturf, pushes to both)
  • github - Public mirror at GitHub

Configuration:

origin	ssh://git@git.unturf.com:2222/engineering/unturf/un-inception.git (fetch)
origin	ssh://git@git.unturf.com:2222/engineering/unturf/un-inception.git (push)
origin	git@github.com:russellballestrini/un-inception.git (push)
github	git@github.com:russellballestrini/un-inception.git (fetch/push)

Usage:

  • git push origin - Pushes to both unturf AND GitHub automatically
  • git push github - Pushes only to GitHub (if needed)
  • git pull - Pulls from unturf (origin)

To replicate this setup:

git remote add github git@github.com:russellballestrini/un-inception.git
git remote set-url --add --push origin ssh://git@git.unturf.com:2222/engineering/unturf/un-inception.git
git remote set-url --add --push origin git@github.com:russellballestrini/un-inception.git