capydash 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d65145bed2681cec5831f3f5b8715c90f06fe94d7f88d3fa7c8cb85781ef8f7
-  data.tar.gz: 8fa286bd777abe9c901d34587bcefb5b25f6dad9d73bda2a7ee8b28419552634
+  metadata.gz: 72ac597d4f4b57d15d412dcdfa56e2cba5600a045e62278d44a082c9ca2e6eff
+  data.tar.gz: c0fb3be58f53129bc4f048f6ea591f1250ef0cc03ca6d004322d86848002b953
 SHA512:
-  metadata.gz: 0e329477548327159151a4a88a54bd12fd53444a6c3c7ca56381f88ca2042d08e6a6b0e7f365f38a15d97c3f61a347884a43a7c31d4791c7775cce7e6b9c09e7
-  data.tar.gz: f3fd9b929e4a0bbe145078fe48769280ab40b965099a0e2eb4a581e508963c2c84117009775544eaf9511c231eaf4a9ded96b6893faff543a93e336e311d8413
+  metadata.gz: 634aabfc97331a3d68d452ac8806bb4a6b979549791c18344725bfdf5ed0bfbee41e27b39afb050d56b87dc6bff06e7b8790afcb231a877acd46fa9e487a2ae3
+  data.tar.gz: 9eddf128a30f7317483eeddc385c1170ec7a14701e0f077100d06e72dcdf63aea188b440483fac9c75502408aad64e2b284f103353693c8f7e09972f1bb5b4e0

data/README.md

@@ -1,286 +1,80 @@
 # CapyDash
 
-A real-time test monitoring dashboard for Rails applications that provides live visualization of test execution with screenshots, step-by-step tracking, and comprehensive error reporting.
+A live dashboard for Capybara tests that provides real-time visualization of test execution with screenshots, step-by-step tracking, comprehensive error reporting, and search capabilities. Perfect for debugging test failures and understanding test behavior.
 
-## Features
-
-- **Real-time Test Monitoring**: Watch tests execute live with WebSocket updates
-- **Visual Test Flow**: See each test step with screenshots and detailed information
-- **Hierarchical Organization**: Test classes → methods → individual steps
-- **Screenshot Capture**: Automatic screenshots at each test step
-- **Error Tracking**: Comprehensive error reporting and logging
-- **Configurable**: YAML-based configuration system
-- **Production Ready**: Built-in logging, error handling, and persistence
-
-## Quick Start
-
-### 1. Installation
-
-#### Option A: Install from RubyGems (Recommended)
+## Installation
 
 Add to your Gemfile:
 
 ```ruby
-gem 'capydash'
+gem "capydash"
 ```
 
-Then run:
+Or run:
 
 ```bash
-bundle install
-```
-
-#### Option B: Install from source
-
-```bash
-git clone https://github.com/damonclark/capydash.git
-cd capydash
-bundle install
-```
-
-#### Option C: Local development
-
-For local development, add to your Gemfile:
-
-```ruby
-gem 'capydash', path: '/path/to/capydash'
-```
-
-### 2. Configuration
-
-Create a configuration file at `config/capydash.yml`:
-
-```yaml
-# CapyDash Configuration
-server:
-  host: "localhost"
-  port: 4000
-  max_connections: 100
-
-dashboard:
-  title: "My Test Dashboard"
-  auto_scroll: true
-  show_timestamps: true
-
-tests:
-  system_tests_dir: "test/system"
-  feature_tests_dir: "test/features"
-  screenshot_dir: "tmp/capydash_screenshots"
-
-logging:
-  level: "info"
-  file: "log/capydash.log"
-
-security:
-  enable_auth: false
-  secret_key: "your-secret-key-here"
-```
-
-### 3. Setup in Rails
-
-Add to your `test/test_helper.rb`:
-
-```ruby
-require 'capydash'
-
-# CapyDash will automatically instrument your tests
-```
-
-### 4. Running Tests
-
-#### Option A: Standalone Server (Recommended)
-
-```bash
-# Terminal 1: Start the dashboard server
-bundle exec rake capydash:server
-
-# Terminal 2: Run tests with external WebSocket
-CAPYDASH_EXTERNAL_WS=1 bundle exec rails test
-```
-
-#### Option B: In-Process Server (Development)
-
-```bash
-# Just run your tests - CapyDash starts automatically
-bundle exec rails test
-```
-
-### 5. View Dashboard
-
-Open your browser to `http://localhost:4000` to see the live test dashboard.
-
-## Configuration Options
-
-### Server Configuration
-
-```yaml
-server:
-  host: "localhost"              # Server host
-  port: 4000                     # Server port
-  websocket_path: "/websocket"   # WebSocket endpoint
-  max_connections: 100           # Max concurrent connections
-  message_history_limit: 1000    # Max messages to keep in memory
-```
-
-### Dashboard Configuration
-
-```yaml
-dashboard:
-  title: "CapyDash Test Monitor"  # Dashboard title
-  refresh_interval: 1000          # UI refresh rate (ms)
-  auto_scroll: true               # Auto-scroll to latest step
-  show_timestamps: true           # Show timestamps in UI
-  screenshot_quality: 0.8         # Screenshot compression (0.0-1.0)
-  max_screenshot_width: 1200      # Max screenshot width (px)
-```
-
-### Test Configuration
-
-```yaml
-tests:
-  default_directory: "test"                    # Default test directory
-  system_tests_dir: "test/system"             # System tests directory
-  feature_tests_dir: "test/features"          # Feature tests directory
-  controller_tests_dir: "test/controllers"    # Controller tests directory
-  model_tests_dir: "test/models"              # Model tests directory
-  screenshot_dir: "tmp/capydash_screenshots"  # Screenshot storage
-  timeout: 300                                # Test timeout (seconds)
-```
-
-### Logging Configuration
-
-```yaml
-logging:
-  level: "info"           # Log level: debug, info, warn, error
-  file: "log/capydash.log" # Log file path
-  max_file_size: "10MB"   # Max log file size
-  max_files: 5            # Number of log files to keep
-```
-
-### Security Configuration
-
-```yaml
-security:
-  enable_auth: false                    # Enable authentication
-  secret_key: "your-secret-key-here"   # Secret key for tokens
-  session_timeout: 3600                # Session timeout (seconds)
+bundle add capydash
 ```
 
 ## Usage
 
-### Running Individual Test Classes
-
-The dashboard allows you to run individual test classes by clicking the "Run" button next to each class. CapyDash automatically:
-
-1. Detects the test class name from the test method names
-2. Generates the appropriate file path (e.g., `NavigationTest` → `test/system/navigation_test.rb`)
-3. Executes the test with proper environment setup
+1. **Start the dashboard server** in one terminal:
+   ```bash
+   bundle exec rake capydash:server
+   ```
 
-### Running All Tests
+2. **Start the frontend** in another terminal:
+   ```bash
+   npx vite
+   ```
 
-Click "Run All System Tests" to execute all system tests with live monitoring.
+3. **Open your browser** to `http://localhost:5173` to view the dashboard
 
-### Viewing Test Results
+4. **Run your tests** with external WebSocket:
+   ```bash
+   CAPYDASH_EXTERNAL_WS=1 bundle exec rails test
+   ```
 
-- **Test Classes**: Top-level organization by test class
-- **Test Methods**: Individual test methods within each class
-- **Test Steps**: Detailed step-by-step execution with screenshots
-- **Status Indicators**: Visual status for each level (PASSED/FAILED/RUNNING)
-- **Error Details**: Comprehensive error information for failed tests
+The dashboard will show your tests running in real-time with screenshots, detailed step information, and search functionality to filter tests by name, status, or content.
 
 ## Development
 
-### Project Structure
-
-```
-lib/capydash/
-├── engine.rb              # Rails engine integration
-├── instrumentation.rb     # Capybara method instrumentation
-├── dashboard_server.rb    # WebSocket server
-├── event_emitter.rb       # Event broadcasting
-├── forwarder.rb          # External WebSocket forwarding
-├── configuration.rb      # Configuration management
-├── logger.rb             # Logging system
-├── error_handler.rb      # Error handling
-├── persistence.rb        # Data persistence
-└── auth.rb              # Authentication
+### Testing with Dummy App
 
-dashboard/
-├── src/
-│   └── App.jsx          # React dashboard
-└── public/              # Static assets
-
-config/
-└── capydash.yml         # Configuration file
-```
-
-### Adding New Features
-
-1. **Configuration**: Add new options to `Configuration` class
-2. **Logging**: Use `CapyDash::Logger` for all logging
-3. **Error Handling**: Use `CapyDash::ErrorHandler` for error management
-4. **Persistence**: Use `CapyDash::Persistence` for data storage
-
-### Testing
+The project includes a dummy Rails app for testing. To run it:
 
 ```bash
-# Run the dummy app tests
 cd spec/dummy_app
+bundle install
 bundle exec rails test
-
-# Run with CapyDash monitoring
-CAPYDASH_EXTERNAL_WS=1 bundle exec rails test
-```
-
-## Troubleshooting
-
-### Common Issues
-
-1. **WebSocket Connection Failed**
-   - Check if port 4000 is available
-   - Verify firewall settings
-   - Check server logs for errors
-
-2. **Tests Not Appearing**
-   - Ensure `CAPYDASH_EXTERNAL_WS=1` is set
-   - Check that tests are in the correct directories
-   - Verify test class naming conventions
-
-3. **Screenshots Not Capturing**
-   - Check screenshot directory permissions
-   - Verify Capybara configuration
-   - Check available disk space
-
-### Debug Mode
-
-Enable debug logging:
-
-```yaml
-logging:
-  level: "debug"
 ```
 
-### Logs
+### Development Setup
 
-Check logs at:
-- `log/capydash.log` - Application logs
-- `tmp/capydash_screenshots/` - Screenshot storage
-- `tmp/capydash_data/` - Test run persistence
+1. Clone the repository
+2. Install dependencies: `bundle install`
+3. Run the dummy app tests to verify everything works
+4. Make your changes
+5. Test with the dummy app
 
 ## Contributing
 
 1. Fork the repository
 2. Create a feature branch
 3. Make your changes
-4. Add tests
+4. Test with the dummy app
 5. Submit a pull request
 
-## License
+## Publishing
 
-MIT License - see LICENSE file for details.
+Build the gem:
 
-## Support
+```bash
+gem build capydash.gemspec
+```
 
-- GitHub Issues: [Report bugs and request features](https://github.com/damonclark/capydash/issues)
-- Documentation: [Full documentation](https://github.com/damonclark/capydash/wiki)
-- Examples: [Example configurations and usage](https://github.com/damonclark/capydash/examples)
+Push to RubyGems:
+
+```bash
+gem push capydash-0.1.0.gem
+```

data/lib/capydash/instrumentation.rb

@@ -33,6 +33,9 @@ module CapyDash
       safe_step = step_name.gsub(/\s+/, '_')
       screenshot_path = File.join(base_dir, "#{safe_step}-#{timestamp}.png")
 
+      # Ensure we have an absolute path for Base64 encoding
+      absolute_screenshot_path = File.absolute_path(screenshot_path)
+
       data_url = nil
       if defined?(Capybara)
         begin
@@ -47,9 +50,25 @@ module CapyDash
               Capybara.current_session.save_screenshot(screenshot_path)
             end
             puts "[CapyDash] Saved screenshot: #{screenshot_path}"
-            if File.exist?(screenshot_path)
-              encoded = Base64.strict_encode64(File.binread(screenshot_path))
+
+            # Try to find the actual screenshot file location
+            actual_screenshot_path = nil
+            if File.exist?(absolute_screenshot_path)
+              actual_screenshot_path = absolute_screenshot_path
+            else
+              # Check if it was saved in the capybara tmp directory
+              capybara_path = File.join(Dir.pwd, "tmp", "capybara", screenshot_path)
+              if File.exist?(capybara_path)
+                actual_screenshot_path = capybara_path
+              end
+            end
+
+            if actual_screenshot_path && File.exist?(actual_screenshot_path)
+              encoded = Base64.strict_encode64(File.binread(actual_screenshot_path))
               data_url = "data:image/png;base64,#{encoded}"
+              puts "[CapyDash] Generated data URL for screenshot from: #{actual_screenshot_path}"
+            else
+              puts "[CapyDash] Screenshot file not found. Tried: #{absolute_screenshot_path} and #{capybara_path rescue 'N/A'}"
             end
           end
         rescue => e

data/lib/capydash/test_data_collector.rb

@@ -0,0 +1,76 @@
+require 'capydash/event_emitter'
+
+module CapyDash
+  class TestDataCollector
+    class << self
+      def start_test_run
+        CapyDash::Logger.info("Starting test run data collection")
+        @test_run_started = true
+        @test_count = 0
+        @passed_count = 0
+        @failed_count = 0
+      end
+
+      def finish_test_run
+        return unless @test_run_started
+
+        CapyDash::Logger.info("Finishing test run data collection", {
+          total_tests: @test_count,
+          passed: @passed_count,
+          failed: @failed_count
+        })
+
+        @test_run_started = false
+      end
+
+      def start_test(test_name, test_class, test_method)
+        return unless @test_run_started
+
+        @test_count += 1
+        CapyDash::Logger.info("Starting test", {
+          test_name: test_name,
+          test_class: test_class,
+          test_method: test_method
+        })
+
+        # Emit test start event
+        CapyDash::EventEmitter.broadcast(
+          step_name: "test_start",
+          detail: "Starting test: #{test_name}",
+          test_name: test_name,
+          status: "running"
+        )
+      end
+
+      def finish_test(test_name, status, error_message = nil)
+        return unless @test_run_started
+
+        if status == "passed"
+          @passed_count += 1
+        elsif status == "failed"
+          @failed_count += 1
+        end
+
+        CapyDash::Logger.info("Finishing test", {
+          test_name: test_name,
+          status: status,
+          error_message: error_message
+        })
+
+        # Emit test finish event
+        event_data = {
+          step_name: "test_finish",
+          detail: "Test #{status}: #{test_name}",
+          test_name: test_name,
+          status: status
+        }
+
+        if error_message
+          event_data[:error] = error_message
+        end
+
+        CapyDash::EventEmitter.broadcast(event_data)
+      end
+    end
+  end
+end

data/lib/capydash/version.rb

@@ -1,3 +1,3 @@
 module Capydash
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/capydash.rb

@@ -8,6 +8,7 @@ require "capydash/logger"
 require "capydash/error_handler"
 require "capydash/persistence"
 require "capydash/auth"
+require "capydash/test_data_collector"
 
 module CapyDash
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capydash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Damon Clark
@@ -114,6 +114,7 @@ files:
 - lib/capydash/instrumentation.rb
 - lib/capydash/logger.rb
 - lib/capydash/persistence.rb
+- lib/capydash/test_data_collector.rb
 - lib/capydash/version.rb
 - lib/tasks/capydash.rake
 homepage: https://github.com/damonclark/capydash