Major refactoring done for feature and testing

Author: rrmistry

.devcontainer/devcontainer.json

@@ -15,13 +15,14 @@
             "extensions": [
                 "mads-hartmann.bash-ide-vscode",
                 "GitHub.copilot",
-                "GitHub.copilot-chat"
+                "GitHub.copilot-chat",
+                "Anthropic.claude-code"
             ]
         }
     },
     "features": {
         "ghcr.io/devcontainers/features/docker-in-docker:2": {}
     },
     "remoteUser": "node",
-    "updateContentCommand": "npm install -g @devcontainers/cli"
+    "updateContentCommand": "npm install -g @devcontainers/cli @anthropic-ai/claude-code"
 }

.github/workflows/test.yaml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         features:
-          - devbox
+          - jetify-devbox  # Changed from 'devbox' to match the feature ID
         baseImage:
           - alpine:latest
           - debian:latest
@@ -34,7 +34,7 @@ jobs:
     strategy:
       matrix:
         features:
-          - devbox
+          - jetify-devbox  # Changed from 'devbox' to match the feature ID
     steps:
       - uses: actions/checkout@v4
 
@@ -48,10 +48,11 @@ jobs:
         if: failure()
         uses: actions/upload-artifact@v4
         with:
-          name: test-logs
+          name: test-logs-${{ github.run_id }}
           path: |
             **/devbox-setup.log
             **/test-results.log
+            /tmp/devbox-setup.log
 
   test-global:
     runs-on: ubuntu-latest
@@ -69,7 +70,8 @@ jobs:
         if: failure()
         uses: actions/upload-artifact@v4
         with:
-          name: test-logs
+          name: test-logs-global-${{ github.run_id }}
           path: |
             **/devbox-setup.log
             **/test-results.log
+            /tmp/devbox-setup.log

.vscode/extensions.json

@@ -5,7 +5,8 @@
 	// List of extensions which should be recommended for users of this workspace.
 	"recommendations": [
 		"github.copilot",
-		"github.copilot-chat"
+		"github.copilot-chat",
+		"anthropic.claude-code"
 	],
 	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
 	"unwantedRecommendations": [

CLAUDE.md

@@ -0,0 +1,104 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This repository provides a Dev Container Feature that installs Jetify Devbox in development containers. Devbox is a command-line tool that creates isolated shells for development using Nix.
+
+## Key Commands
+
+### Testing
+```bash
+# Run all tests
+devcontainer features test .
+
+# Test specific feature
+devcontainer features test -f jetify-devbox .
+
+# Test specific scenario
+devcontainer features test -f jetify-devbox --skip-autogenerated .
+
+# Test with specific base image
+devcontainer features test -f jetify-devbox --base-image ubuntu:focal .
+
+# Run only global scenarios
+devcontainer features test --global-scenarios-only .
+```
+
+### Development Setup
+```bash
+# Install devcontainer CLI (required for testing)
+npm install -g @devcontainers/cli
+```
+
+## Architecture
+
+### Feature Structure
+- **src/jetify-devbox/**: Feature implementation
+  - `devcontainer-feature.json`: Feature metadata defining options and dependencies
+  - `install.sh`: Installation script that installs Devbox via Nix
+  - `ReadMe.md`: Feature-specific documentation
+
+- **test/jetify-devbox/**: Feature tests
+  - `test.sh`: Basic functionality tests
+  - `scenarios.json`: Test scenarios configuration
+  - `test_*.sh`: Scenario-specific test scripts
+  - `devbox.json`: Sample Devbox configuration for testing
+
+### Installation Flow
+1. Nix dependency is installed automatically (via `dependsOn`)
+2. `install.sh` runs during container build:
+   - Adds Nix unstable channel
+   - Installs Devbox using Nix profile
+   - Creates post-setup script at `/usr/local/share/devbox-post-setup.sh`
+   - Creates manual setup helper at `/usr/local/bin/devbox-setup`
+3. Post-setup script runs on container creation via `onCreateCommand`:
+   - Checks for `devbox.json` in workspace
+   - Runs `devbox update` to initialize environment
+   - Configures shell environment
+
+### Key Implementation Details
+
+#### Feature Options
+- `autoUpdate` (boolean, default: true): Controls whether `devbox update` runs automatically
+
+#### Environment Variables
+- `DEVBOX_FEATURE_INSTALLED`: Set to "true" in container environment
+- `WORKSPACE_FOLDER`: Used to locate `devbox.json`
+- `_REMOTE_USER`: Used to run commands as non-root user
+
+#### Scripts Created
+- `/usr/local/share/devbox-post-setup.sh`: Runs on container creation
+- `/usr/local/bin/devbox-setup`: Manual setup helper
+- `/usr/local/share/devbox-auto-update-enabled`: Stores autoUpdate preference
+
+### Testing Architecture
+
+The test suite verifies:
+1. **Basic functionality** (`test.sh`):
+   - Devbox installation
+   - PATH configuration
+   - Basic commands (`devbox version`, `devbox init`, `devbox shell`)
+
+2. **Scenario tests**:
+   - `auto_update_enabled`: Verifies automatic setup with devbox.json
+   - `auto_update_disabled`: Verifies manual setup workflow
+   - `test_vscode_integration`: Tests VS Code terminal integration
+   - `test_with_user_oncreate`: Ensures compatibility with user onCreateCommand
+   - `test_different_base_images`: Tests various base image compatibility
+
+### CI/CD Pipeline
+
+GitHub Actions workflow (`.github/workflows/test.yaml`):
+- Tests against multiple base images (Alpine, Debian, Ubuntu, devcontainers/base)
+- Runs autogenerated tests, scenario tests, and global tests
+- Uploads test logs on failure for debugging
+
+## Important Patterns
+
+1. **Shell Script Safety**: All scripts use `set -e` for error handling
+2. **User Context**: Scripts handle both root and non-root execution
+3. **Logging**: Post-setup script logs to `/tmp/devbox-setup.log`
+4. **Idempotency**: Scripts check for existing configurations before running
+5. **Feature ID**: The feature ID is `jetify-devbox` (not just `devbox`)

README.md

@@ -11,7 +11,7 @@ To use the feature in your devcontainer, add it to your `devcontainer.json`:
     "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
     "features": {
         "ghcr.io/righteouslabs/devcontainer-jetify-devbox/devbox:1": {
-            "initRepo": true
+            "autoUpdate": true
         }
     }
 }
@@ -21,17 +21,17 @@ To use the feature in your devcontainer, add it to your `devcontainer.json`:
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| initRepo | boolean | true | Initialize the repository by running 'devbox update' from the root of the repository. This relies on 'devbox.json' file being present in the root of the repository. |
+| autoUpdate | boolean | true | Automatically run 'devbox update' after container creation. This relies on 'devbox.json' file being present in the root of the repository. |
 
 ## Prerequisites
 
 - The feature requires the Nix package manager and automatically installs it as a dependency.
-- For initialization (`initRepo: true`), a `devbox.json` file must be present in the root of your repository.
+- For automatic updates (`autoUpdate: true`), a `devbox.json` file must be present in the root of your repository.
 
 ## How it works
 
 1. Installs Devbox using Nix
-2. If `initRepo` is true and a `devbox.json` file exists in your repository:
+2. If `autoUpdate` is true and a `devbox.json` file exists in your repository:
    - Changes to the repository root
    - Runs `devbox update` to initialize the development environment
 
@@ -42,11 +42,11 @@ This repository follows the standard [dev container Feature](https://containers.
 ```
 .
 ├── src
-│   └── devbox
+│   └── jetify-devbox
 │       ├── devcontainer-feature.json  # Feature metadata and options
 │       └── install.sh                 # Installation script
 └── test
-    └── devbox                        # Feature-specific tests
+    └── jetify-devbox                 # Feature-specific tests
         ├── scenarios.json            # Test scenarios
         └── test.sh                   # Test script
 ```
@@ -64,12 +64,12 @@ The feature includes automated tests that verify the functionality through diffe
    - Checks that basic commands work (e.g., `devbox version`)
 
 2. Scenario Tests:
-   - `devbox_without_init.sh`: Tests feature with `initRepo: false`
-   - `devbox_with_init.sh`: Tests feature with `initRepo: true`
+   - `test_auto_update_disabled.sh`: Tests feature with `autoUpdate: false`
+   - `test_auto_update_enabled.sh`: Tests feature with `autoUpdate: true`
    - Both scenarios use Ubuntu-based container image
 
 3. Test Configuration:
-   - Sample `devbox.json` in `test/devbox/` with basic packages:
+   - Sample `devbox.json` in `test/jetify-devbox/` with basic packages:
      ```json
      {
          "packages": [
@@ -92,11 +92,11 @@ The feature includes automated tests that verify the functionality through diffe
    # Test all features
    devcontainer features test .
 
-   # Test only your devbox feature
-   devcontainer features test -f devbox .
+   # Test only your jetify-devbox feature
+   devcontainer features test -f jetify-devbox .
 
    # Test with specific base image
-   devcontainer features test -f devbox --base-image ubuntu:focal .
+   devcontainer features test -f jetify-devbox --base-image ubuntu:focal .
 
    # Run only scenario tests
    devcontainer features test --skip-autogenerated .
@@ -107,11 +107,11 @@ The feature includes automated tests that verify the functionality through diffe
 
 #### Test Scenarios Configuration
 
-The test scenarios are defined in `test/devbox/scenarios.json`
+The test scenarios are defined in `test/jetify-devbox/scenarios.json`
 
 #### Test Configuration
 
-The test suite uses a sample `devbox.json` in the `test/devbox` directory:
+The test suite uses a sample `devbox.json` in the `test/jetify-devbox` directory:
 
 ```json
 {

src/devbox/ReadMe.md src/jetify-devbox/ReadMe.mdsrc/devbox/ReadMe.md renamed to src/jetify-devbox/ReadMe.md

@@ -3,6 +3,7 @@
     "id": "jetify-devbox",
     "version": "1.0.0",
     "description": "Instant, easy, and predictable development environments using Jetify Devbox",
+    "documentationURL": "https://github.com/righteouslabs/devcontainer-jetify-devbox",
     "dependsOn": {
         "ghcr.io/devcontainers/features/nix": {}
     },
@@ -13,8 +14,11 @@
             "description": "Automatically run 'devbox update' after container creation"
         }
     },
-    "onCreateCommand": "/usr/local/share/devbox-post-setup.sh",
+    "installsAfter": [
+        "ghcr.io/devcontainers/features/common-utils"
+    ],
     "containerEnv": {
         "DEVBOX_FEATURE_INSTALLED": "true"
-    }
+    },
+    "onCreateCommand": "/usr/local/share/devbox-post-setup.sh"
 }

src/devbox/devcontainer-feature.json …/jetify-devbox/devcontainer-feature.jsonsrc/devbox/devcontainer-feature.json renamed to src/jetify-devbox/devcontainer-feature.json src/devbox/devcontainer-feature.json renamed to src/jetify-devbox/devcontainer-feature.json

@@ -24,11 +24,23 @@ fi
 
 echo "devbox installed successfully."
 
-# Create post-setup script for devbox update
+# Save the autoUpdate option value for the onCreate script
+echo "${AUTOUPDATE}" > /usr/local/share/devbox-auto-update-enabled
+
+# Always create the onCreate script, but make it check the option
 cat << 'EOF' > /usr/local/share/devbox-post-setup.sh
 #!/bin/bash
 set -e
 
+# Check if auto-update is enabled
+AUTO_UPDATE_ENABLED=$(cat /usr/local/share/devbox-auto-update-enabled 2>/dev/null || echo "true")
+
+if [ "${AUTO_UPDATE_ENABLED}" != "true" ]; then
+    echo "Devbox auto-update is disabled. Skipping automatic setup."
+    echo "To manually set up devbox, run: devbox-setup"
+    exit 0
+fi
+
 # Log output for debugging
 exec 1> >(tee -a /tmp/devbox-setup.log)
 exec 2>&1
@@ -56,5 +68,28 @@ fi
 echo "Devbox setup completed successfully"
 EOF
 
-# Make the post-setup script executable
 chmod +x /usr/local/share/devbox-post-setup.sh
+
+# Always create the manual setup helper script
+cat << 'EOF' > /usr/local/bin/devbox-setup
+#!/bin/bash
+set -e
+
+echo "Running manual Devbox setup..."
+
+# Check if devbox.json exists in workspace
+if [ -f "${WORKSPACE_FOLDER:-/workspaces/*}/devbox.json" ]; then
+    echo "Found devbox.json, running devbox update..."
+    cd "${WORKSPACE_FOLDER:-/workspaces/*}"
+    devbox update
+    
+    # Also set up the shell environment for VS Code processes
+    devbox shellenv --init-hook >> ~/.profile
+    echo "Devbox setup completed successfully"
+else
+    echo "No devbox.json found in workspace"
+fi
+EOF
+
+chmod +x /usr/local/bin/devbox-setup
+echo "Devbox installation completed. Manual setup helper available at: devbox-setup"

src/devbox/install.sh src/jetify-devbox/install.shsrc/devbox/install.sh renamed to src/jetify-devbox/install.sh

@@ -0,0 +1,10 @@
+{
+    "test_all_features": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+        "features": {
+            "jetify-devbox": {
+                "autoUpdate": true
+            }
+        }
+    }
+}

test/_global/scenarios.json

@@ -0,0 +1,12 @@
+#!/bin/bash
+# ==================================================
+# test/_global/test_all_features.sh
+# ==================================================
+set -e
+
+source dev-container-features-test-lib
+
+# Test that devbox feature is installed
+check "devbox available globally" command -v devbox
+
+reportResults