inx/naj
1
0
Fork 0
Code Issues Pull requests Projects Releases 4 Packages Wiki Activity Actions
naj/scripts/tests
History
inx adce0a5e0d
chore(rename): rename project from 'gosh' to 'naj' 
This rebrands the CLI tool to 'naj' (Old Chinese reconstruction for "Me/I").
This name was chosen for better typing ergonomics (R-L-R alternation) and
availability on crates.io.

Changes:
- Update `Cargo.toml` package name to `naj`.
- Update binary name target to `naj`.
- Update documentation and README to reflect the new identity.

BREAKING CHANGE: The binary name is now `naj`. Users must update their
scripts and usage from `gosh` to `naj`.
2026-01-28 21:08:09 +08:00
..
alice.sh chore(rename): rename project from 'gosh' to 'naj' 2026-01-28 21:08:09 +08:00
alice2.sh chore(rename): rename project from 'gosh' to 'naj' 2026-01-28 21:08:09 +08:00
alice3.sh chore(rename): rename project from 'gosh' to 'naj' 2026-01-28 21:08:09 +08:00
edge_cases.sh chore(rename): rename project from 'gosh' to 'naj' 2026-01-28 21:08:09 +08:00
README.md chore(rename): rename project from 'gosh' to 'naj' 2026-01-28 21:08:09 +08:00
security_edge.sh chore(rename): rename project from 'gosh' to 'naj' 2026-01-28 21:08:09 +08:00

README.md

Naj Integration & Scenario Tests

This directory contains the integration test suite and scenario simulations for naj. These scripts are designed to validate the core functionality, security isolation, and developer workflows in a controlled, sandbox environment.

Overview

The tests in this directory focus on end-to-end (E2E) validation, ensuring that naj correctly interacts with Git configurations, SSH keys, and system environments without contaminating the user's global settings.

Test Matrix

Script Focus Area Description
alice.sh Basic Workflow Validates profile creation, cloning, and identity switching with SSH signing.
alice2.sh Advanced Signing Extends basic tests with complex signing scenarios and multi-profile setups.
alice3.sh Full Lifecycle Simulates a complex developer lifecycle involving multiple organizations.
edge_cases.sh Robustness Tests boundary conditions, invalid inputs, and error handling.
security_edge.sh Security Validates configuration isolation and prevents "leakage" between profiles.

Prerequisites

To run these tests locally, ensure you have the following installed:

  • Bash: Most scripts use standard Bash features.
  • Git: Version 2.34+ is required for SSH signing tests.
  • Naj: The naj binary must be available in your PATH or accessible via the GOSH_CMD environment variable.

Running Tests

Preparation

Before running the tests, compile the project to ensure the latest binary is used:

cargo build --release
export PATH="$PWD/target/release:$PATH"

Execution

You can run individual test scripts directly:

bash scripts/tests/alice.sh

Each script initializes a sandbox in /tmp/naj_test_* or similar, ensuring that your ~/.gitconfig and ~/.ssh remain untouched.

Design Principles

  1. Isolation: All tests use a dedicated GOSH_CONFIG_PATH and temporary directories to ensure side-effect-free execution.
  2. Assertions: Scripts use exit codes and explicit checks to verify expected outcomes (e.g., checking git cat-file for signatures).
  3. Readability: Log levels (STEP, INFO, ERROR) are used to provide clear feedback during execution.

Adding New Tests

When adding a new test script:

  • Use set -e to ensure the script fails on the first error.
  • Use a dedicated sandbox directory for all temporary files.
  • Export GOSH_CONFIG_PATH to point into your sandbox.
  • Document the scenario and expected results in the script header.