testflow-ai 0.5.2 → 0.5.3

package/README.md

@@ -234,9 +234,8 @@ my-api/
 │   ├── index.ts              # Test runner
 │   ├── context.md            # API context
 │   └── flows/
-│       ├── health-check.yaml
 │       ├── todo-crud.yaml
-│       └── todo-complete-flow.yaml
+│       └── todo-graphql.yaml
 └── package.json
 ```
 
@@ -352,14 +351,14 @@ import { TestRunner, FlowExecutor, parseYamlFile, parseContextFile } from 'testf
 // Runner with full control
 const runner = new TestRunner({
   contextFile: './context.md',
-  testFiles: ['./tests/critical.yaml'],
+  testFiles: ['./tests/todo-crud.yaml'],
   ai: { provider: 'ollama', model: 'mistral:7b' },
 });
 const report = await runner.run();
 
 // Manual execution
 const context = await parseContextFile('./context.md');
-const flow = await parseYamlFile('./tests/flow.yaml');
+const flow = await parseYamlFile('./tests/todo-crud.yaml');
 const executor = new FlowExecutor(context, true);
 const result = await executor.executeFlow(flow);
 ```
@@ -374,65 +373,65 @@ const result = await executor.executeFlow(flow);
 ### Basic structure
 
 ```yaml
-name: User Registration Flow
-description: Create and verify a new user
+name: Todo Lifecycle
+description: Create a todo and verify it exists
 tags:
-  - users
+  - todos
   - smoke
 
 steps:
-  - name: Create user
+  - name: Create todo
     request:
       method: POST
-      url: "{api}/users"
+      url: "{api}/todos"
       headers:
         Content-Type: application/json
       body:
-        email: alice@example.com
-        name: Alice
+        title: "Buy groceries"
+        completed: false
     capture:
-      - name: userId
+      - name: todoId
         path: data.id
     assertions:
       - path: status
         operator: equals
         value: 201
-      - path: data.email
+      - path: data.title
         operator: equals
-        value: alice@example.com
+        value: "Buy groceries"
 
-  - name: Verify user
+  - name: Verify todo
     request:
       method: GET
-      url: "{api}/users/${userId}"
+      url: "{api}/todos/${todoId}"
     assertions:
       - path: data.id
         operator: equals
-        value: "${userId}"
+        value: "${todoId}"
 ```
 
 ### GraphQL requests
 
 ```yaml
 steps:
-  - name: Query user
+  - name: Query todo
     request:
       method: POST
       url: "{graphql}"
       graphql:
         query: |
-          query GetUser($id: ID!) {
-            user(id: $id) {
+          query GetTodo($id: ID!) {
+            todo(id: $id) {
               id
-              email
-              name
+              title
+              completed
             }
           }
         variables:
-          id: "${userId}"
+          id: "${todoId}"
     capture:
-      - name: userEmail
-        path: data.user.email
+      - name: todoTitle
+        path: data.todo.title
 ```
 
 ### Variable capture and interpolation
@@ -441,25 +440,29 @@ Variables captured in one step are available in all subsequent steps:
 
 ```yaml
 steps:
-  - name: Login
+  - name: Create todo
     request:
       method: POST
-      url: "{api}/auth/login"
+      url: "{api}/todos"
+      headers:
+        Content-Type: application/json
       body:
-        email: admin@example.com
-        password: secret
+        title: "Read docs"
+        completed: false
     capture:
-      - name: token
-        path: data.accessToken
-      - name: userId
-        path: data.user.id
+      - name: todoId
+        path: data.id
+      - name: todoTitle
+        path: data.title
 
-  - name: Get profile
+  - name: Verify todo title
     request:
       method: GET
-      url: "{api}/users/${userId}"
-      headers:
-        Authorization: "Bearer ${token}"
+      url: "{api}/todos/${todoId}"
+    assertions:
+      - path: data.title
+        operator: equals
+        value: "${todoTitle}"
 ```
 
 **Supported patterns:**
@@ -474,20 +477,20 @@ For operations that take time — polls until condition is met or timeout:
 
 ```yaml
 steps:
-  - name: Wait for job completion
+  - name: Wait for todo sync
     request:
       method: GET
-      url: "{api}/jobs/${jobId}"
+      url: "{api}/todos/${todoId}/sync-status"
     waitUntil:
       path: data.status
       operator: equals
-      value: "COMPLETED"
+      value: "SYNCED"
       timeout: 30000    # max wait (ms)
       interval: 2000    # poll every (ms)
     assertions:
       - path: data.status
         operator: equals
-        value: "COMPLETED"
+        value: "SYNCED"
 ```
 
 </details>
@@ -633,19 +636,19 @@ const report = await runTests({
 
 ```yaml
 steps:
-  - name: Check article quality
+  - name: Check todo description
     request:
       method: GET
-      url: "{api}/articles/1"
+      url: "{api}/todos/${todoId}"
     assertions:
       # Traditional assertion
       - path: status
         operator: equals
         value: 200
       # AI-powered assertion (works with any provider)
-      - path: data.content
+      - path: data.description
         operator: ai-evaluate
-        value: "Does this article contain a coherent explanation with at least two paragraphs?"
+        value: "Is this a well-formed task description with a clear action item?"
 ```
 
 ### Context file AI config
@@ -744,23 +747,25 @@ This gives you:
 Define your project context in Markdown. The runner uses it to resolve `{baseUrlKey}` references in your YAML flows.
 
 ```markdown
-# My API
+# Todo List API
 
 ## Description
-Brief description of your API.
+A REST + GraphQL API for managing todo items.
 
 ## Base URLs
 - api: http://localhost:3000
 - graphql: http://localhost:3000/graphql
 
 ## Endpoints
-- POST /users - Create user
-- GET /users/:id - Get user
+- POST /todos - Create todo
+- GET /todos/:id - Get todo by ID
+- PUT /todos/:id - Update todo
+- DELETE /todos/:id - Delete todo
 - POST /graphql - GraphQL endpoint
 
 ## Rules
 - All endpoints return JSON
-- Authentication required for /users
+- Todos have: id, title, completed, createdAt
 
 ## AI Configuration
 - provider: ollama
@@ -815,26 +820,27 @@ That's it. If tests fail, the job fails automatically (exit code 1).
 ══════════════════════════════════════════════════════════════
 
 Summary:
-  Total:    5 flows
-  Passed:  5
-  Failed:  0
-  Duration: 2450ms
+  Total:    3 flows
+  Passed:  2
+  Failed:  1
+  Duration: 1850ms
 
 Narrative:
 
-✅ **User CRUD**
-   → Create user
-     📦 userId: abc-123
-   → Read user
-   → Update user
+✅ **Todo CRUD**
+   → Create todo
+     📦 todoId: abc-123
+   → Read todo
+   → Update todo
+   → Delete todo
 
-✅ **Auth Flow**
-   → Login
-     📦 token: eyJhbG…
-   → Access protected route
+✅ **Todo GraphQL**
+   → Create todo (mutation)
+     📦 todoId: def-456
+   → Query todo
 
-❌ **Payment Flow**
-   ✗ Create payment
+❌ **Todo Bulk Import**
+   ✗ Import todos from CSV
      ⚠️  Expected status to equal 200, got 500
 
 ══════════════════════════════════════════════════════════════
@@ -863,20 +869,23 @@ Narrative:
 
 See the [`examples/`](./examples) directory for:
 
-- **Todo List CRUD** (`todo-crud.yaml`) - Complete REST CRUD flow
-- **Todo GraphQL** (`todo-graphql.yaml`) - GraphQL mutations and queries
-- **REST CRUD** (`rest-crud.yaml`) - User management example
-- **GraphQL Flow** (`graphql-flow.yaml`) - GraphQL with variable capture
-- **Auth Flow** (`auth-flow.yaml`) - Authentication and protected routes
-- **Context Files** (`context.md`, `todo-list-context.md`) - API context templates
+- **REST CRUD** (`rest-crud.yaml`) — Full todo lifecycle: create → read → update → verify
+- **Auth Flow** (`auth-flow.yaml`) — Login, create todo with token, verify access control
+- **GraphQL Flow** (`graphql-flow.yaml`) — Create + query todos via GraphQL mutations
+- **Todo CRUD** (`todo-crud.yaml`) — Extended CRUD with delete + verify deletion
+- **Todo GraphQL** (`todo-graphql.yaml`) — GraphQL mutations and queries with variable capture
+- **Context Files** (`context.md`, `todo-list-context.md`) — API context templates
 
 **Quick start with examples:**
 
 ```bash
-# Run specific example
-npx testflow --context ./examples/todo-list-context.md ./examples/todo-crud.yaml
+# Run a specific flow
+npx testflow --context ./examples/context.md ./examples/rest-crud.yaml
+
+# Run the auth flow
+npx testflow --context ./examples/context.md ./examples/auth-flow.yaml
 
-# Run all examples in directory
+# Run all examples
 npx testflow --dir ./examples --context ./examples/context.md
 ```
 

package/examples/auth-flow.yaml

@@ -1,9 +1,10 @@
-# Auth flow — Login, use token, access protected resource.
+# Auth flow — Login, use token, create and access a protected todo.
 
-name: Authentication Flow
-description: Login and access a protected endpoint using the returned token
+name: Authenticated Todo Flow
+description: Login, create a todo with auth token, and verify access control
 tags:
   - auth
+  - todos
   - smoke
 
 steps:
@@ -19,8 +20,6 @@ steps:
     capture:
       - name: token
         path: data.accessToken
-      - name: userId
-        path: data.user.id
     assertions:
       - path: status
         operator: equals
@@ -28,10 +27,31 @@ steps:
       - path: data.accessToken
         operator: exists
 
-  - name: Access protected route
+  - name: Create todo (authenticated)
+    request:
+      method: POST
+      url: "{api}/todos"
+      headers:
+        Content-Type: application/json
+        Authorization: "Bearer ${token}"
+      body:
+        title: "Deploy to production"
+        completed: false
+    capture:
+      - name: todoId
+        path: data.id
+    assertions:
+      - path: status
+        operator: equals
+        value: 201
+      - path: data.title
+        operator: equals
+        value: "Deploy to production"
+
+  - name: Read todo (authenticated)
     request:
       method: GET
-      url: "{api}/users/${userId}"
+      url: "{api}/todos/${todoId}"
       headers:
         Authorization: "Bearer ${token}"
     assertions:
@@ -40,12 +60,16 @@ steps:
         value: 200
       - path: data.id
         operator: equals
-        value: "${userId}"
+        value: "${todoId}"
 
   - name: Reject without token
     request:
-      method: GET
-      url: "{api}/users/${userId}"
+      method: POST
+      url: "{api}/todos"
+      headers:
+        Content-Type: application/json
+      body:
+        title: "Should fail"
     assertions:
       - path: status
         operator: equals

package/examples/context.md

@@ -1,25 +1,27 @@
-# My API
+# Todo API
 
 ## Description
-Example API context for testflow-ai.
+Example API context for testflow-ai — a simple Todo REST + GraphQL API.
 
 ## Base URLs
 - api: http://localhost:3000
 - graphql: http://localhost:3000/graphql
 
 ## Endpoints
-- POST /users - Create a new user
-- GET /users/:id - Get user by ID
-- PUT /users/:id - Update user
-- DELETE /users/:id - Delete user
+- POST /todos - Create a new todo
+- GET /todos/:id - Get todo by ID
+- GET /todos - List all todos
+- PUT /todos/:id - Update todo
+- DELETE /todos/:id - Delete todo
 - POST /auth/login - Authenticate and get token
 - POST /graphql - GraphQL endpoint
 
 ## Rules
 - All endpoints return JSON
-- Authentication required for /users endpoints
+- Authentication required for write operations
 - Rate limit: 100 requests per minute
 
 ## AI Configuration
+- provider: ollama
 - url: http://localhost:11434
 - model: llama3.2:3b

package/examples/graphql-flow.yaml

@@ -1,58 +1,58 @@
-# GraphQL — Mutation + query with variable capture.
+# GraphQL — Mutation + query with variable capture for todos.
 
-name: GraphQL User Flow
-description: Create a user via mutation, then query it back
+name: GraphQL Todo Flow
+description: Create a todo via mutation, then query it back
 tags:
   - graphql
-  - users
+  - todos
 
 steps:
-  - name: Create user (mutation)
+  - name: Create todo (mutation)
     request:
       method: POST
       url: "{graphql}"
       graphql:
         query: |
-          mutation CreateUser($input: CreateUserInput!) {
-            createUser(input: $input) {
+          mutation CreateTodo($input: CreateTodoInput!) {
+            createTodo(input: $input) {
               id
-              email
-              name
+              title
+              completed
             }
           }
         variables:
           input:
-            email: bob@example.com
-            name: Bob
+            title: "Learn GraphQL"
+            completed: false
     capture:
-      - name: userId
-        path: data.createUser.id
+      - name: todoId
+        path: data.createTodo.id
     assertions:
-      - path: data.createUser.email
+      - path: data.createTodo.title
         operator: equals
-        value: bob@example.com
-      - path: data.createUser.id
+        value: "Learn GraphQL"
+      - path: data.createTodo.id
         operator: exists
 
-  - name: Query user
+  - name: Query todo
     request:
       method: POST
       url: "{graphql}"
       graphql:
         query: |
-          query GetUser($id: ID!) {
-            user(id: $id) {
+          query GetTodo($id: ID!) {
+            todo(id: $id) {
               id
-              email
-              name
+              title
+              completed
             }
           }
         variables:
-          id: "${userId}"
+          id: "${todoId}"
     assertions:
-      - path: data.user.id
+      - path: data.todo.id
         operator: equals
-        value: "${userId}"
-      - path: data.user.email
+        value: "${todoId}"
+      - path: data.todo.title
         operator: equals
-        value: bob@example.com
+        value: "Learn GraphQL"

package/examples/rest-crud.yaml

@@ -1,76 +1,77 @@
-# REST CRUD — Create, read, update, verify a user.
+# REST CRUD — Create, read, update, verify a todo item.
 
-name: User CRUD
-description: Full lifecycle test for a REST user resource
+name: Todo REST CRUD
+description: Full lifecycle test for a REST todo resource
 tags:
-  - users
+  - todos
   - crud
   - smoke
 
 steps:
-  - name: Create user
+  - name: Create todo
     request:
       method: POST
-      url: "{api}/users"
+      url: "{api}/todos"
       headers:
         Content-Type: application/json
       body:
-        email: alice@example.com
-        name: Alice
+        title: "Write unit tests"
+        completed: false
     capture:
-      - name: userId
+      - name: todoId
         path: data.id
-      - name: userEmail
-        path: data.email
+      - name: todoTitle
+        path: data.title
     assertions:
       - path: status
         operator: equals
         value: 201
-      - path: data.email
+      - path: data.title
         operator: equals
-        value: alice@example.com
+        value: "Write unit tests"
       - path: data.id
         operator: exists
 
-  - name: Read user
+  - name: Read todo
     request:
       method: GET
-      url: "{api}/users/${userId}"
+      url: "{api}/todos/${todoId}"
     assertions:
       - path: status
         operator: equals
         value: 200
       - path: data.id
         operator: equals
-        value: "${userId}"
-      - path: data.email
+        value: "${todoId}"
+      - path: data.title
         operator: equals
-        value: "${userEmail}"
+        value: "${todoTitle}"
 
-  - name: Update user
+  - name: Update todo
     request:
       method: PUT
-      url: "{api}/users/${userId}"
+      url: "{api}/todos/${todoId}"
       headers:
         Content-Type: application/json
       body:
-        name: Alice Updated
+        title: "Write unit tests (done)"
+        completed: true
     assertions:
       - path: status
         operator: equals
         value: 200
-      - path: data.name
+      - path: data.title
         operator: equals
-        value: Alice Updated
+        value: "Write unit tests (done)"
 
   - name: Verify update
     request:
       method: GET
-      url: "{api}/users/${userId}"
+      url: "{api}/todos/${todoId}"
     assertions:
-      - path: data.name
+      - path: data.title
         operator: equals
-        value: Alice Updated
-      - path: data.email
+        value: "Write unit tests (done)"
+      - path: data.completed
         operator: equals
-        value: "${userEmail}"
+        value: true

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "testflow-ai",
-    "version": "0.5.2",
+    "version": "0.5.3",
     "description": "Declarative API testing powered by YAML flows. Replace Postman with version-controlled, AI-friendly test definitions.",
     "author": "Marcos Carbajal",
     "license": "MIT",