endorphin-ai 0.1.0

package/bin/endorphin.js

@@ -0,0 +1,256 @@
+#!/usr/bin/env node
+
+/**
+ * Endorphin AI CLI - E2E Testing Reinvented with AI
+ */
+
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import { readFileSync } from 'fs';
+import { getConfig } from '../framework/core/config-loader.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Get package info
+const packagePath = join(__dirname, '..', 'package.json');
+const packageInfo = JSON.parse(readFileSync(packagePath, 'utf8'));
+
+const args = process.argv.slice(2);
+
+// Parse CLI flags into configuration overrides
+function parseCliFlags(args) {
+  const flags = {};
+  
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    const nextArg = args[i + 1];
+    
+    switch (arg) {
+      case '--headless':
+        flags.headless = true;
+        break;
+      case '--no-headless':
+        flags.headless = false;
+        break;
+      case '--viewport':
+        if (nextArg && nextArg.includes('x')) {
+          const [width, height] = nextArg.split('x').map(Number);
+          flags.viewport = { width, height };
+          i++; // Skip next argument
+        }
+        break;
+      case '--timeout':
+        if (nextArg && !isNaN(nextArg)) {
+          flags.timeout = parseInt(nextArg, 10);
+          i++;
+        }
+        break;
+      case '--parallel':
+        if (nextArg && !isNaN(nextArg)) {
+          flags.parallel = parseInt(nextArg, 10);
+          i++;
+        }
+        break;
+      case '--model':
+        if (nextArg) {
+          flags.model = nextArg;
+          i++;
+        }
+        break;
+      case '--env':
+      case '--environment':
+        if (nextArg) {
+          flags.environment = nextArg;
+          i++;
+        }
+        break;
+      case '--base-url':
+        if (nextArg) {
+          flags.baseUrl = nextArg;
+          i++;
+        }
+        break;
+      case '--temperature':
+        if (nextArg && !isNaN(nextArg)) {
+          flags.temperature = parseFloat(nextArg);
+          i++;
+        }
+        break;
+      case '--retries':
+        if (nextArg && !isNaN(nextArg)) {
+          flags.maxRetries = parseInt(nextArg, 10);
+          i++;
+        }
+        break;
+      case '--tests-dir':
+        if (nextArg) {
+          flags.testsDirectory = nextArg;
+          i++;
+        }
+        break;
+      case '--data-dir':
+        if (nextArg) {
+          flags.dataDirectory = nextArg;
+          i++;
+        }
+        break;
+    }
+  }
+  
+  return flags;
+}
+
+// Show help
+function showHelp() {
+  console.log(`
+🎉 Endorphin AI v${packageInfo.version} - E2E Testing Reinvented with AI
+
+Usage:
+  endorphin <command> [options]
+
+Commands:
+  run test <test-id>     Run a specific test (e.g., QE-001)
+  run test all           Run all tests
+  run test --tag <tag>   Run tests by tag (e.g., authentication)
+  run test --priority <level>  Run tests by priority (High, Medium, Low)
+  run test-recorder      Start interactive test recorder
+  list                   List all available tests
+  help                   Show this help message
+
+Options:
+  --headless             Run browser in headless mode
+  --no-headless          Run browser with visible UI
+  --viewport <WxH>       Set browser viewport (e.g., 1920x1080)
+  --timeout <ms>         Set test timeout in milliseconds
+  --parallel <n>         Run tests in parallel (default: 1)
+  --model <name>         Set AI model to use (e.g., gpt-4o-mini)
+  --env <environment>    Set environment (development/staging/production)
+
+Examples:
+  endorphin run test QE-001                    # Run specific test
+  endorphin run test all --headless            # Run all tests headless
+  endorphin run test --tag smoke --parallel 3  # Run smoke tests in parallel
+  endorphin run test --priority High --env staging # Run high priority tests on staging
+  endorphin run test-recorder                  # Start test recorder
+  endorphin list                               # Show all available tests
+
+Configuration:
+  Create endorphin.config.js in your project root for default settings
+  CLI flags override configuration file settings
+  Set OPENAI_API_KEY in your .env file or environment variables
+
+Documentation: https://github.com/andrewnovykov/endorphin-ai#readme
+`);
+}
+
+// Main CLI handler
+async function main() {
+  try {
+    if (args.length === 0 || args.includes('--help') || args.includes('-h') || args.includes('help')) {
+      showHelp();
+      process.exit(0);
+    }
+
+    if (args.includes('--version') || args.includes('-v')) {
+      console.log(`Endorphin AI v${packageInfo.version}`);
+      process.exit(0);
+    }
+
+    // Load configuration with CLI flag overrides
+    const cliFlags = parseCliFlags(args);
+    const config = await getConfig({ cwd: process.cwd(), cliFlags });
+    
+    // Debug: show loaded config if --debug flag is present
+    if (args.includes('--debug')) {
+      console.log('🔧 Loaded configuration:', JSON.stringify(config, null, 2));
+    }
+
+    const command = args[0];
+    const subcommand = args[1];
+    const target = args[2];
+
+    // Handle list command
+    if (command === 'list') {
+      console.log('📋 Available Tests:');
+      const { listAllTests } = await import('../framework/core/test-discovery.js');
+      await listAllTests(config);
+      process.exit(0);
+    }
+
+    // Handle run commands
+    if (command === 'run') {
+      if (subcommand === 'test-recorder') {
+        console.log('🎬 Starting Interactive Test Recorder...');
+        const { runInteractiveRecorder } = await import('../framework/interactive/enhanced-interactive-recorder.js');
+        await runInteractiveRecorder(config);
+        process.exit(0);
+      }
+
+      if (subcommand === 'test') {
+        // Check for flags
+        if (args.includes('--tag')) {
+          const tagIndex = args.indexOf('--tag');
+          const tag = args[tagIndex + 1];
+          if (!tag) {
+            console.error('❌ Error: Please specify a tag value');
+            process.exit(1);
+          }
+          console.log(`🏷️ Running tests with tag: ${tag}`);
+          const { runTestsByTag } = await import('../framework/core/test-discovery.js');
+          await runTestsByTag(tag, config);
+          process.exit(0);
+        }
+
+        if (args.includes('--priority')) {
+          const priorityIndex = args.indexOf('--priority');
+          const priority = args[priorityIndex + 1];
+          if (!priority) {
+            console.error('❌ Error: Please specify a priority value');
+            process.exit(1);
+          }
+          console.log(`🎯 Running tests with priority: ${priority}`);
+          const { runTestsByPriority } = await import('../framework/core/test-discovery.js');
+          await runTestsByPriority(priority, config);
+          process.exit(0);
+        }
+
+        // Handle specific test or "all"
+        if (target === 'all') {
+          console.log('🚀 Running all tests...');
+          const { runAllTests } = await import('../framework/core/test-discovery.js');
+          await runAllTests(config);
+          process.exit(0);
+        } else if (target) {
+          console.log(`🧪 Running test: ${target}`);
+          const { runSingleTestById } = await import('../framework/core/test-discovery.js');
+          await runSingleTestById(target, config);
+          process.exit(0);
+        } else {
+          console.error('❌ Error: Please specify a test ID or "all" (e.g., endorphin run test QE-001)');
+          process.exit(1);
+        }
+      }
+
+      console.error(`❌ Unknown run command: ${subcommand}`);
+      console.log('Use "endorphin help" for usage information');
+      process.exit(1);
+    }
+
+    console.error(`❌ Unknown command: ${command}`);
+    console.log('Use "endorphin help" for usage information');
+    process.exit(1);
+
+  } catch (error) {
+    console.error('❌ Error:', error.message);
+    
+    if (error.message.includes('OPENAI_API_KEY')) {
+      console.log('\n💡 Tip: Make sure to set your OPENAI_API_KEY in your .env file or environment variables');
+    }
+    
+    process.exit(1);
+  }
+}
+
+// Run CLI
+main();

package/examples/endorphin.config.js

@@ -0,0 +1,22 @@
+export default {
+  browser: {
+    headless: false,  // Make sure this is false to see browser
+    viewport: { width: 1280, height: 720 },
+    timeout: 30000
+  },
+  
+  // Results configuration
+  results: {
+    directory: "./test-results",
+    keepHistory: 10,
+    format: ["json", "html"],
+    screenshots: true,
+    recordVideo: false
+  },
+  
+  ai: {
+    model: "gpt-4o",
+    maxRetries: 3,
+    temperature: 0.1
+  }
+};

package/examples/tests/QE-001-basic-login-test.js

@@ -0,0 +1,18 @@
+// QE-001: Basic Login Test
+// Description: Test the login functionality with valid credentials
+// Priority: High
+// Tags: authentication, login, smoke
+
+export const QE_001 = {
+  id: "QE-001",
+  name: "Basic Login Test", 
+  description: "Test the login functionality with valid credentials",
+  priority: "High",
+  tags: ["authentication", "login", "smoke"],
+  site: "https://qafromla.herokuapp.com/",
+  testData: {
+    email: "papapin888@gmail.com",
+    password: "lalalend"
+  },
+  task: "Navigate to https://qafromla.herokuapp.com/, click on 'Log In' button, fill email field with 'papapin888@gmail.com', fill password field with 'lalalend', click 'Sign In' button, and verify successful login by checking for dashboard or user menu elements."
+};

package/examples/tests/sample-test.js

@@ -0,0 +1,9 @@
+export const HEALTH_001 = {
+    id: "HEALTH-001",
+    name: "Framework Health Check",
+    description: "Verify basic framework functionality",
+    priority: "High",
+    tags: ["health", "smoke"],
+    site: "https://example.com",
+    task: "Navigate to https://example.com and verify page loads successfully"
+  };

package/framework/config/agent-config.js

@@ -0,0 +1,53 @@
+// Endorphin e2e AI test framework>
+// Copyright (C)  2025 Redstudio Agency
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import * as dotenv from "dotenv";
+
+dotenv.config();
+
+export const AGENT_CONFIG = {
+  // OpenAI Configuration
+  openai: {
+    apiKey: process.env.OPENAI_API_KEY,
+    modelName: "gpt-4o"
+  },
+  
+  // Agent behavior settings
+  agent: {
+    recursionLimit: 150,
+    timeout: 5 * 60 * 1000, // 5 minutes
+    
+    // Stop phrases that indicate test completion
+    stopPhrases: [
+      'test completed', 
+      'verification complete', 
+      'login successful', 
+      'test finished', 
+      'done', 
+      'stop',
+      'stop - test completed'
+    ]
+  },
+  
+  // Test execution settings
+  execution: {
+    stepDelay: 2000, // 2 seconds between test steps
+    maxRetries: 3,
+    retryDelay: 1000
+  }
+};
+
+export default AGENT_CONFIG;

package/framework/config/browser-config.js

@@ -0,0 +1,53 @@
+// Endorphin e2e AI test framework>
+// Copyright (C)  2025 Redstudio Agency
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+
+import dotenv from 'dotenv';
+
+// Load environment variables
+dotenv.config();
+
+export const BROWSER_CONFIG = {
+  // Browser launch options
+  launchOptions: {
+    headless: process.env.HEADLESS === 'true' ? true : false,
+    args: ['--start-maximized']
+  },
+  
+  // Browser context options
+  contextOptions: {
+    viewport: { width: 1920, height: 1080 }
+  },
+  
+  // Default timeouts (in milliseconds)
+  timeouts: {
+    navigation: 60000,
+    element: 10000,
+    screenshot: 5000,
+    testExecution: 5 * 60 * 1000 // 5 minutes
+  },
+  
+  // Screenshot options
+  screenshot: {
+    fullPage: false,
+    type: 'png'
+  },
+  
+  // Base URL for testing
+  baseUrl: process.env.BASE_URL || 'https://qafromla.herokuapp.com/'
+};
+
+export default BROWSER_CONFIG;

package/framework/config/paths.js

@@ -0,0 +1,40 @@
+// Endorphin e2e AI test framework>
+// Copyright (C)  2025 Redstudio Agency
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Get project root directory (go up from framework/config/ to project root)
+const projectRoot = path.resolve(__dirname, '..', '..');
+
+export const PATHS = {
+  // Project directories
+  PROJECT_ROOT: projectRoot,
+  TEST_RESULT_DIR: path.join(projectRoot, 'test-result'),
+  TEST_RECORDER_DIR: path.join(projectRoot, 'test-recorder'),
+  TESTS_DIR: path.join(projectRoot, 'tests'),
+  
+  // Framework directories
+  FRAMEWORK_DIR: path.join(projectRoot, 'framework'),
+  TOOLS_DIR: path.join(projectRoot, 'framework', 'tools'),
+  CORE_DIR: path.join(projectRoot, 'framework', 'core'),
+  CONFIG_DIR: path.join(projectRoot, 'framework', 'config'),
+};
+
+export default PATHS;

package/framework/core/agent-setup.js

@@ -0,0 +1,75 @@
+// Endorphin e2e AI test framework>
+// Copyright (C)  2025 Redstudio Agency
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import { ChatOpenAI } from "@langchain/openai";
+import { ToolNode } from "@langchain/langgraph/prebuilt";
+import { StateGraph, MessagesAnnotation } from "@langchain/langgraph";
+import { AGENT_CONFIG } from '../config/agent-config.js';
+
+/**
+ * Setup AI agent with tools and workflow
+ * @param {Array} tools - Array of browser automation tools
+ * @returns {Object} Compiled agent workflow
+ */
+export async function setupAgent(tools) {
+  console.log("🤖 Configuring AI agent with tools...");
+  
+  const toolNode = new ToolNode(tools);
+
+  const model = new ChatOpenAI({
+    openAIApiKey: AGENT_CONFIG.openai.apiKey,
+    modelName: AGENT_CONFIG.openai.modelName,
+  }).bindTools(tools);
+
+  function shouldContinue({ messages }) {
+    const lastMessage = messages[messages.length - 1];
+    
+    // Check for explicit stop conditions in the message content
+    const content = lastMessage.content?.toLowerCase() || '';
+    const hasStopPhrase = AGENT_CONFIG.agent.stopPhrases.some(phrase => 
+      content.includes(phrase)
+    );
+    
+    if (hasStopPhrase) {
+      console.log(`🛑 Stop condition detected: ${content}`);
+      return "__end__";
+    }
+    
+    if (lastMessage.tool_calls?.length) {
+      return "tools";
+    }
+    return "__end__";
+  }
+
+  async function callModel(state) {
+    const response = await model.invoke(state.messages);
+    return { messages: [response] };
+  }
+
+  const workflow = new StateGraph(MessagesAnnotation)
+    .addNode("agent", callModel)
+    .addEdge("__start__", "agent")
+    .addNode("tools", toolNode)
+    .addEdge("tools", "agent")
+    .addConditionalEdges("agent", shouldContinue);
+
+  const agent = workflow.compile({
+    recursionLimit: AGENT_CONFIG.agent.recursionLimit,
+  });
+
+  console.log("✅ AI agent configured successfully");
+  return agent;
+}