@elizaos/cli 1.3.2 → 1.4.2

package/dist/templates/plugin-starter/src/plugin.ts

@@ -13,7 +13,6 @@ import type {
 } from '@elizaos/core';
 import { ModelType, Service, logger } from '@elizaos/core';
 import { z } from 'zod';
-import { StarterPluginTestSuite } from './tests';
 
 /**
  * Defines the configuration schema for a plugin, including the validation rules for the plugin name.
@@ -89,7 +88,7 @@ const helloWorldAction: Action = {
         },
       };
     } catch (error) {
-      logger.error('Error in HelloWorld action:', error);
+      logger.error({ error }, 'Error in HelloWorld action:');
       return {
         success: false,
         error: error instanceof Error ? error : new Error(String(error)),
@@ -245,35 +244,34 @@ export const starterPlugin: Plugin = {
       async (params) => {
         logger.debug('MESSAGE_RECEIVED event received');
         // print the keys
-        logger.debug(Object.keys(params));
+        logger.debug({ keys: Object.keys(params) }, 'MESSAGE_RECEIVED param keys');
       },
     ],
     VOICE_MESSAGE_RECEIVED: [
       async (params) => {
         logger.debug('VOICE_MESSAGE_RECEIVED event received');
         // print the keys
-        logger.debug(Object.keys(params));
+        logger.debug({ keys: Object.keys(params) }, 'VOICE_MESSAGE_RECEIVED param keys');
       },
     ],
     WORLD_CONNECTED: [
       async (params) => {
         logger.debug('WORLD_CONNECTED event received');
         // print the keys
-        logger.debug(Object.keys(params));
+        logger.debug({ keys: Object.keys(params) }, 'WORLD_CONNECTED param keys');
       },
     ],
     WORLD_JOINED: [
       async (params) => {
         logger.debug('WORLD_JOINED event received');
         // print the keys
-        logger.debug(Object.keys(params));
+        logger.debug({ keys: Object.keys(params) }, 'WORLD_JOINED param keys');
       },
     ],
   },
   services: [StarterService],
   actions: [helloWorldAction],
   providers: [helloWorldProvider],
-  tests: [StarterPluginTestSuite],
   // dependencies: ['@elizaos/plugin-knowledge'], <--- plugin dependencies go here (if requires another plugin)
 };
 

package/dist/templates/project-starter/README.md

@@ -42,23 +42,36 @@ elizaos test
 
 ## Testing
 
-ElizaOS provides a comprehensive testing structure for projects:
+ElizaOS employs a dual testing strategy:
 
-### Test Structure
+1. **Component Tests** (`src/__tests__/*.test.ts`)
+
+   - Run with Bun's native test runner
+   - Fast, isolated tests using mocks
+   - Perfect for TDD and component logic
 
-- **Component Tests** (`__tests__/` directory):
+2. **E2E Tests** (`src/__tests__/e2e/*.e2e.ts`)
+   - Run with ElizaOS custom test runner
+   - Real runtime with actual database (PGLite)
+   - Test complete user scenarios
 
-  - **Unit Tests**: Test individual functions and components in isolation
-  - **Integration Tests**: Test how components work together
-  - Run with: `elizaos test component`
+### Test Structure
 
-- **End-to-End Tests** (`e2e/` directory):
+```
+src/
+  __tests__/              # All tests live inside src
+    *.test.ts            # Component tests (use Bun test runner)
+    e2e/                 # E2E tests (use ElizaOS test runner)
+      project-starter.e2e.ts  # E2E test suite
+      README.md          # E2E testing documentation
+  index.ts               # Export tests here: tests: [ProjectStarterTestSuite]
+```
 
-  - Test the project within a full ElizaOS runtime
-  - Run with: `elizaos test e2e`
+### Running Tests
 
-- **Running All Tests**:
-  - `elizaos test` runs both component and e2e tests
+- `elizaos test` - Run all tests (component + e2e)
+- `elizaos test component` - Run only component tests
+- `elizaos test e2e` - Run only E2E tests
 
 ### Writing Tests
 

package/dist/templates/project-starter/package.json

@@ -28,10 +28,10 @@
     "dist"
   ],
   "dependencies": {
-    "@elizaos/cli": "1.3.2",
-    "@elizaos/core": "1.3.2",
-    "@elizaos/plugin-bootstrap": "1.3.2",
-    "@elizaos/plugin-sql": "1.3.2",
+    "@elizaos/cli": "1.4.2",
+    "@elizaos/core": "1.4.2",
+    "@elizaos/plugin-bootstrap": "1.4.2",
+    "@elizaos/plugin-sql": "1.4.2",
     "@tanstack/react-query": "^5.29.0",
     "clsx": "^2.1.1",
     "react": "^18.3.1",

package/dist/templates/project-starter/src/__tests__/actions.test.ts

@@ -107,7 +107,7 @@ describe('Actions', () => {
           expect(result).toBe(true);
         } catch (e) {
           error = e as Error;
-          logger.error('Validate function error:', e);
+          logger.error({ error: e }, 'Validate function error:');
         }
 
         documentTestResult('HELLO_WORLD action validate', result, error);
@@ -145,7 +145,7 @@ describe('Actions', () => {
           expect(callbackResponse).toHaveProperty('source', 'test');
         } catch (e) {
           error = e as Error;
-          logger.error('Handler function error:', e);
+          logger.error({ error: e }, 'Handler function error:');
         }
 
         documentTestResult('HELLO_WORLD action handler', callbackResponse, error);

package/dist/templates/project-starter/src/__tests__/e2e/README.md

@@ -0,0 +1,103 @@
+# E2E Tests for Project Starter
+
+This directory contains end-to-end tests for the ElizaOS project starter template.
+
+## ElizaOS Testing Philosophy
+
+ElizaOS employs a dual testing strategy:
+
+1. **Component Tests** (`src/__tests__/*.test.ts`)
+
+   - Run with Bun's native test runner
+   - Fast, isolated tests using mocks
+   - Perfect for TDD and component logic
+   - Command: `bun test`
+
+2. **E2E Tests** (`src/__tests__/e2e/*.e2e.ts`)
+   - Run with ElizaOS custom test runner
+   - Real runtime with actual database (PGLite)
+   - Test complete user scenarios
+   - Command: `elizaos test --type e2e`
+
+## Overview
+
+E2E tests run in a real ElizaOS runtime environment, allowing you to test your project's behavior as it would work in production. Unlike component tests, E2E tests provide access to a fully initialized runtime with all services, actions, and providers available.
+
+## Test Structure
+
+- **ProjectStarterTestSuite** - Main test suite containing comprehensive e2e tests:
+  - **Core Project Tests**
+    - `project_should_initialize_correctly` - Verifies project and runtime initialization
+    - `character_should_be_loaded_correctly` - Validates all character configuration fields
+  - **Natural Language Processing Tests**
+    - `agent_should_respond_to_greeting` - Tests basic greeting interactions
+    - `agent_should_respond_to_hello_world` - Validates specific hello world response
+    - `agent_should_respond_to_casual_greetings` - Tests various casual greeting formats
+    - `agent_should_maintain_conversation_context` - Validates context retention
+  - **Action & Provider Tests**
+    - `hello_world_action_direct_execution` - Tests direct action execution
+    - `hello_world_provider_test` - Validates provider functionality
+  - **Service & System Tests**
+    - `starter_service_test` - Tests service lifecycle and configuration
+    - `memory_system_should_store_and_retrieve_messages` - Tests memory persistence
+    - `agent_should_handle_multiple_concurrent_messages` - Tests concurrent processing
+    - `project_configuration_should_be_valid` - Validates project configuration
+    - `plugin_initialization_test` - Tests plugin system integration
+
+## Integration with Project
+
+E2E tests are integrated directly into your project through the main index.ts file:
+
+```typescript
+// src/index.ts
+import { ProjectStarterTestSuite } from './__tests__/e2e/project-starter.e2e';
+
+export const project: Project = {
+  agents: [projectAgent],
+  tests: [ProjectStarterTestSuite], // Direct import!
+};
+```
+
+## Running Tests
+
+```bash
+# Run all tests (component + e2e)
+elizaos test
+
+# Run only e2e tests (slower, full integration)
+elizaos test --type e2e
+
+# Run only component tests (fast, for TDD)
+bun test
+# or
+elizaos test --type component
+```
+
+## Implementation Details
+
+1. **Direct Import**: Tests are imported directly from the e2e test file - no intermediate export file needed
+2. **Project Integration**: The test suite is added to the project's `tests` array
+3. **Test Discovery**: The ElizaOS test runner automatically finds and executes tests from the project's `tests` array
+4. **Runtime Access**: Each test receives a real runtime instance with full access to:
+   - Agent character configuration
+   - Database and model access
+   - All registered plugins and services
+   - Memory and conversation history
+
+## Key Differences from Plugin Tests
+
+- **Export Location**: Tests are exported from the `ProjectAgent` in `src/index.ts` (not directly from `Project`)
+- **Test Focus**: Tests focus on agent behavior and character configuration rather than plugin functionality
+- **Project Context**: Tests have access to the full project configuration including character settings
+
+## Writing New Tests
+
+See the comprehensive documentation at the top of `project-starter.e2e.ts` for detailed instructions on adding new tests.
+
+## Best Practices
+
+1. **Test User Journeys**: Focus on complete user interactions with the agent
+2. **Character Validation**: Ensure character properties affect agent behavior as expected
+3. **Context Testing**: Verify the agent maintains context across conversations
+4. **Concurrent Operations**: Test how the agent handles multiple simultaneous requests
+5. **Configuration Validation**: Ensure all required settings are properly loaded