serialbench 0.1.1 → 0.1.3

data/lib/serialbench/cli/resultset_cli.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+require_relative 'base_cli'
+require_relative '../models/result_set'
+require_relative '../site_generator'
+
+module Serialbench
+  module Cli
+    # CLI for managing benchmark resultsets (collections of runs)
+    class ResultsetCli < BaseCli
+      desc 'create NAME PATH', 'Create a new resultset'
+      long_desc <<~DESC
+        Create a new resultset (collection of benchmark runs).
+
+        NAME is required and must be unique.
+        PATH is the directory where the resultset will be created.
+
+        Examples:
+          serialbench resultset create performance-comparison results/sets/performance-comparison
+          serialbench resultset create cross-platform-test results/sets/cross-platform-test
+      DESC
+      def create(resultset_name, resultset_path)
+        Serialbench::Models::ResultStore.default
+
+        # Check if resultset already exists
+        definition_path = File.join(resultset_path, 'resultset.yaml')
+
+        if File.exist?(definition_path)
+          say "ResultSet at '#{resultset_path}' already exists", :yellow
+          return unless yes?('Create anyway with timestamp suffix? (y/n)')
+
+          resultset_path = "#{resultset_path}-#{generate_timestamp}"
+        end
+
+        # Create empty resultset using the new ResultSet model
+        resultset = Serialbench::Models::ResultSet.new(
+          name: resultset_name,
+          description: "ResultSet for #{resultset_name} benchmarks",
+          created_at: Time.now.utc.iso8601,
+          updated_at: Time.now.utc.iso8601
+        )
+        resultset.save(resultset_path)
+
+        say "✅ Created resultset: #{resultset_path}", :green
+        say "Path: #{definition_path}", :cyan
+        say "Use 'serialbench resultset add-result' to add benchmark runs", :white
+      rescue StandardError => e
+        say "Error creating resultset: #{e.message}", :red
+        exit 1
+      end
+
+      desc 'add-result RESULTSET_PATH RESULT_PATH...', 'Add one or more runs to a resultset'
+      long_desc <<~DESC
+        Add one or more benchmark runs to a resultset.
+
+        RESULTSET_PATH is the path to the resultset directory
+        RESULT_PATH... accepts multiple result paths (supports shell expansion)
+
+        Examples:
+          # Add single result
+          serialbench resultset add-result results/sets/weekly results/runs/my-run
+
+          # Add multiple results explicitly
+          serialbench resultset add-result results/sets/weekly results/runs/run1 results/runs/run2
+
+          # Add multiple results with shell expansion
+          serialbench resultset add-result results/sets/weekly artifacts/benchmark-results-*/
+          serialbench resultset add-result results/sets/weekly results/runs/*
+      DESC
+      def add_result(resultset_path, *result_paths)
+        if result_paths.empty?
+          say '❌ Error: At least one result path must be provided', :red
+          exit 1
+        end
+
+        resultset = Serialbench::Models::ResultSet.load(resultset_path)
+
+        say "📦 Adding #{result_paths.size} result(s) to resultset", :cyan
+        say "ResultSet: #{resultset_path}", :white
+        say ''
+
+        added_count = 0
+        failed_count = 0
+        skipped_count = 0
+
+        result_paths.each_with_index do |result_path, index|
+          say "#{index + 1}/#{result_paths.size} Processing: #{result_path}", :cyan
+
+          # Find results.yaml in the path or subdirectories
+          results_file = if File.exist?(File.join(result_path, 'results.yaml'))
+                           File.join(result_path, 'results.yaml')
+                         else
+                           Dir.glob(File.join(result_path, '**/results.yaml')).first
+                         end
+
+          unless results_file
+            say '  ⚠️  No results.yaml found - skipping', :yellow
+            skipped_count += 1
+            next
+          end
+
+          result_dir = File.dirname(results_file)
+
+          begin
+            resultset.add_result(result_dir)
+            say '  ✅ Added successfully', :green
+            added_count += 1
+          rescue StandardError => e
+            say "  ❌ Failed: #{e.message}", :red
+            failed_count += 1
+          end
+          say ''
+        end
+
+        resultset.save(resultset_path)
+
+        say '=' * 60, :cyan
+        say 'Summary:', :green
+        say "  Total processed: #{result_paths.size}", :white
+        say "  ✅ Successfully added: #{added_count}", :green
+        say "  ❌ Failed: #{failed_count}", :red if failed_count > 0
+        say "  ⚠️  Skipped: #{skipped_count}", :yellow if skipped_count > 0
+        say "  📊 Total results in set: #{resultset.results.count}", :cyan
+        say '=' * 60, :cyan
+
+        exit 1 if failed_count > 0 && added_count == 0
+      rescue StandardError => e
+        say "❌ Error: #{e.message}", :red
+        exit 1
+      end
+
+      desc 'remove-result RESULTSET_PATH RESULT_PATH', 'Remove a run from a resultset'
+      long_desc <<~DESC
+        Remove a benchmark run from a resultset.
+
+        RESULTSET_PATH must be specified explicitly
+        RESULT_PATH is the path to the run result directory
+
+        Examples:
+          serialbench resultset remove-result results/sets/performance-comparison results/runs/my-run-local-macos-arm64-ruby-3.3.8
+          serialbench resultset remove-result results/sets/cross-platform-test results/runs/my-docker-run
+      DESC
+      def remove_result(resultset_path, _result_path)
+        Serialbench::Models::ResultStore.default
+
+        # Find the resultset
+        resultset = Serialbench::Models::ResultSet.load(resultset_path)
+        if resultset.nil?
+          say "ResultSet '#{resultset_path}' not found", :red
+          exit 1
+        end
+
+        # Remove run from resultset
+        removed = resultset.remove_run(run_identifier)
+        unless removed
+          say "Run '#{run_identifier}' not found in resultset", :yellow
+          say 'Available runs in resultset:', :white
+          resultset.runs.each do |run_info|
+            say "  - #{run_info[:name]}", :white
+          end
+          return
+        end
+
+        resultset.save
+
+        say '✅ Removed run from resultset', :green
+        say "Run: #{run_identifier}", :cyan
+        say "ResultSet: #{resultset_path}", :cyan
+        say "Remaining runs in set: #{resultset.runs.length}", :white
+      rescue StandardError => e
+        say "Error removing run from resultset: #{e.message}", :red
+        exit 1
+      end
+
+      desc 'build-site RESULTSET_PATH [OUTPUT_DIR]', 'Generate HTML site for a resultset'
+      long_desc <<~DESC
+        Generate an HTML site for a resultset (comparative analysis).
+
+        RESULTSET_PATH must be specified explicitly
+        OUTPUT_DIR defaults to _site/
+
+        Examples:
+          serialbench resultset build-site results/sets/performance-comparison
+          serialbench resultset build-site results/sets/cross-platform-test output/
+      DESC
+      def build_site(resultset_path, output_dir = '_site')
+        unless Dir.exist?(resultset_path)
+          say "ResultSet directory not found: #{resultset_path}", :red
+          say "Please create a resultset first using 'serialbench resultset create'", :white
+          exit 1
+        end
+
+        resultset = Serialbench::Models::ResultSet.load(resultset_path)
+
+        if resultset.results.empty?
+          say "ResultSet '#{resultset_path}' contains no runs", :yellow
+          say "Use 'serialbench resultset add-result' to add runs first", :white
+          return
+        end
+
+        say "🏗️  Generating HTML site for resultset: #{resultset_path}", :green
+        say "Runs in set: #{resultset.results.size}", :cyan
+
+        # Use the unified site generator for resultsets
+        Serialbench::SiteGenerator.generate_for_resultset(resultset, output_dir)
+
+        say '✅ HTML site generated successfully!', :green
+        say "Site location: #{output_dir}", :cyan
+        say "Open: #{File.join(output_dir, 'index.html')}", :white
+      rescue StandardError => e
+        say "Error generating site: #{e.message}", :red
+        say "Details: #{e.backtrace.first(3).join("\n")}", :red if options[:verbose]
+        exit 1
+      end
+
+      desc 'list', 'List all available resultsets'
+      long_desc <<~DESC
+        List all resultsets in the results/sets/ directory.
+
+        Shows resultset names, number of runs, and timestamps.
+      DESC
+      def list
+        ensure_results_directory
+
+        begin
+          store = Serialbench::Models::ResultStore.default
+          resultsets = store.find_resultsets
+
+          if resultsets.empty?
+            say 'No resultsets found', :yellow
+            say "Use 'serialbench resultset create' to create a resultset", :white
+            return
+          end
+
+          say 'Available ResultSets:', :green
+          say '=' * 50, :green
+
+          resultsets.each do |resultset|
+            say "📁 #{resultset.name}", :cyan
+            say "   Runs: #{resultset.runs.length}", :white
+            say "   Created: #{resultset.metadata[:timestamp]}", :white
+            say "   Path: #{resultset.directory}", :white
+
+            if resultset.runs.any?
+              say '   Contains:', :white
+              resultset.runs.first(3).each do |run_info|
+                say "     - #{run_info[:name]}", :white
+              end
+              say "     ... and #{resultset.runs.length - 3} more" if resultset.runs.length > 3
+            end
+
+            say ''
+          end
+        rescue StandardError => e
+          say "Error listing resultsets: #{e.message}", :red
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/serialbench/cli/ruby_build_cli.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+require_relative 'base_cli'
+require_relative '../ruby_build_manager'
+
+module Serialbench
+  module Cli
+    # CLI for managing Ruby-Build definitions
+    class RubyBuildCli < BaseCli
+      desc 'update', 'Update Ruby-Build definitions from GitHub'
+      long_desc <<~DESC
+        Fetch the latest Ruby-Build definitions from the official ruby-build repository
+        and cache them locally for validation purposes.
+
+        This command is required before using any Ruby-Build validation features.
+
+        Examples:
+          serialbench ruby-build update
+      DESC
+      def update
+        say '🔄 Updating Ruby-Build definitions...', :green
+
+        begin
+          definitions = RubyBuildManager.update_definitions
+
+          say "✅ Successfully updated #{definitions.length} Ruby-Build definitions", :green
+          say "📁 Cache location: #{RubyBuildManager::CACHE_FILE}", :cyan
+
+          # Show some examples
+          recent_versions = definitions.select { |d| d.match?(/^3\.[2-4]\.\d+$/) }.last(5)
+          if recent_versions.any?
+            say "\n📋 Recent Ruby versions available:", :white
+            recent_versions.each { |version| say "  #{version}", :cyan }
+          end
+        rescue StandardError => e
+          say "❌ Failed to update Ruby-Build definitions: #{e.message}", :red
+          exit 1
+        end
+      end
+
+      desc 'list [FILTER]', 'List available Ruby-Build definitions'
+      long_desc <<~DESC
+        List all available Ruby-Build definitions from the local cache.
+
+        Optionally filter the list by providing a filter string.
+
+        Examples:
+          serialbench ruby-build list           # List all definitions
+          serialbench ruby-build list 3.3       # Filter by "3.3"
+          serialbench ruby-build list 3.2.      # Filter by "3.2."
+      DESC
+      option :limit, type: :numeric, default: 50, desc: 'Maximum number of definitions to show'
+      def list(filter = nil)
+        definitions = RubyBuildManager.list_definitions(filter: filter)
+
+        if definitions.empty?
+          if filter
+            say "No Ruby-Build definitions found matching '#{filter}'", :yellow
+          else
+            say 'No Ruby-Build definitions found in cache', :yellow
+            say 'Update the cache first: serialbench ruby-build update', :white
+          end
+          return
+        end
+
+        # Limit results if there are many
+        limited_definitions = definitions.first(options[:limit])
+
+        say "Ruby-Build Definitions#{filter ? " (filtered by '#{filter}')" : ''}:", :green
+        say '=' * 60, :green
+
+        limited_definitions.each do |definition|
+          say "  #{definition}", :cyan
+        end
+
+        if definitions.length > options[:limit]
+          remaining = definitions.length - options[:limit]
+          say "\n... and #{remaining} more definitions", :yellow
+          say 'Use --limit to show more results', :white
+        end
+
+        say "\nTotal: #{definitions.length} definitions", :white
+      rescue StandardError => e
+        say "❌ Failed to list Ruby-Build definitions: #{e.message}", :red
+        say 'Try updating the cache: serialbench ruby-build update', :white
+        exit 1
+      end
+
+      desc 'show TAG', 'Show details for a specific Ruby-Build definition'
+      long_desc <<~DESC
+        Show detailed information about a specific Ruby-Build definition.
+
+        Examples:
+          serialbench ruby-build show 3.3.8
+          serialbench ruby-build show 3.2.4
+      DESC
+      def show(tag)
+        definition = RubyBuildManager.show_definition(tag)
+
+        say "Ruby-Build Definition: #{tag}", :green
+        say '=' * 40, :green
+        say "Tag: #{definition[:tag]}", :cyan
+        say "Available: #{definition[:available] ? '✅ Yes' : '❌ No'}", :cyan
+        say "Source: #{definition[:source]}", :cyan
+        say "Cache file: #{definition[:cache_file]}", :white
+      rescue StandardError => e
+        say "❌ #{e.message}", :red
+        say 'Available definitions: serialbench ruby-build list', :white
+        exit 1
+      end
+
+      desc 'validate TAG', 'Validate a Ruby-Build tag'
+      long_desc <<~DESC
+        Validate whether a Ruby-Build tag exists in the cached definitions.
+
+        Examples:
+          serialbench ruby-build validate 3.3.8
+          serialbench ruby-build validate 3.2.4
+      DESC
+      def validate(tag)
+        valid = RubyBuildManager.validate_tag(tag)
+
+        if valid
+          say "✅ Ruby-Build tag '#{tag}' is valid", :green
+        else
+          say "❌ Ruby-Build tag '#{tag}' is not valid", :red
+
+          # Suggest similar tags
+          definitions = RubyBuildManager.list_definitions
+          similar = definitions.select { |d| d.include?(tag.split('.').first(2).join('.')) }.first(5)
+
+          if similar.any?
+            say "\n💡 Similar available tags:", :yellow
+            similar.each { |s| say "  #{s}", :cyan }
+          end
+
+          exit 1
+        end
+      rescue StandardError => e
+        say "❌ Failed to validate tag: #{e.message}", :red
+        say 'Try updating the cache: serialbench ruby-build update', :white
+        exit 1
+      end
+
+      desc 'suggest', 'Suggest Ruby-Build tag for current Ruby version'
+      long_desc <<~DESC
+        Suggest an appropriate Ruby-Build tag based on the current Ruby version.
+
+        This is useful when creating local environments to get the correct
+        ruby_build_tag value.
+
+        Examples:
+          serialbench ruby-build suggest
+      DESC
+      def suggest
+        current_ruby = RUBY_VERSION
+        suggested_tag = RubyBuildManager.suggest_current_ruby_tag
+
+        say "Current Ruby version: #{current_ruby}", :cyan
+        say "Suggested ruby_build_tag: #{suggested_tag}", :green
+
+        # Validate the suggestion
+        if RubyBuildManager.validate_tag(suggested_tag)
+          say '✅ Suggested tag is valid', :green
+        else
+          say '⚠️  Suggested tag not found in ruby-build definitions', :yellow
+          say 'You may need to update the cache or use a different tag', :white
+        end
+      rescue StandardError => e
+        say "❌ Failed to suggest tag: #{e.message}", :red
+        say 'Try updating the cache: serialbench ruby-build update', :white
+        exit 1
+      end
+
+      desc 'cache-info', 'Show information about the Ruby-Build definitions cache'
+      long_desc <<~DESC
+        Display information about the local Ruby-Build definitions cache,
+        including location, age, and update status.
+
+        Examples:
+          serialbench ruby-build cache-info
+      DESC
+      def cache_info
+        if RubyBuildManager.cache_exists?
+          cache_age = RubyBuildManager.cache_age
+          definitions_count = RubyBuildManager.list_definitions.length
+
+          say 'Ruby-Build Cache Information:', :green
+          say '=' * 40, :green
+          say "Location: #{RubyBuildManager::CACHE_FILE}", :cyan
+          say "Definitions: #{definitions_count}", :cyan
+          say "Age: #{format_cache_age(cache_age)}", :cyan
+          say 'Status: ✅ Available', :green
+
+          if cache_age > 7 * 24 * 60 * 60 # 7 days
+            say "\n💡 Cache is older than 7 days, consider updating:", :yellow
+            say '  serialbench ruby-build update', :white
+          end
+        else
+          say 'Ruby-Build Cache Information:', :green
+          say '=' * 40, :green
+          say "Location: #{RubyBuildManager::CACHE_FILE}", :cyan
+          say 'Status: ❌ Not found', :red
+          say "\n📥 Update the cache first:", :yellow
+          say '  serialbench ruby-build update', :white
+        end
+      end
+
+      private
+
+      def format_cache_age(seconds)
+        days = (seconds / (24 * 60 * 60)).to_i
+        hours = ((seconds % (24 * 60 * 60)) / (60 * 60)).to_i
+
+        if days.positive?
+          "#{days} day#{'s' if days != 1}, #{hours} hour#{'s' if hours != 1}"
+        elsif hours.positive?
+          "#{hours} hour#{'s' if hours != 1}"
+        else
+          'less than 1 hour'
+        end
+      end
+    end
+  end
+end

data/lib/serialbench/cli/validate_cli.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'base_cli'
+require_relative '../yaml_validator'
+
+module Serialbench
+  module Cli
+    # CLI for validating YAML files against schemas
+    class ValidateCli < BaseCli
+      desc 'result RESULT_FILE', 'Validate a benchmark result YAML file'
+      long_desc <<~DESC
+        Validate a benchmark result YAML file against its schema.
+
+        RESULT_FILE should be the path to a results.yaml file
+
+        Examples:
+          serialbench validate result results/runs/my-run/results.yaml
+          serialbench validate result test-artifacts/benchmark-results-ubuntu-latest-ruby-3.4/results.yaml
+      DESC
+      def result(file_path)
+        validate_file(file_path, 'result', 'Result')
+      end
+
+      desc 'config BENCHMARK_CONFIG', 'Validate a benchmark configuration file'
+      long_desc <<~DESC
+        Validate a benchmark configuration file against its schema.
+
+        BENCHMARK_CONFIG should be the path to a benchmark config YAML file
+
+        Examples:
+          serialbench validate config config/benchmarks/short.yml
+          serialbench validate config config/benchmarks/full.yml
+      DESC
+      def config(file_path)
+        validate_file(file_path, 'benchmark_config', 'Benchmark config')
+      end
+
+      desc 'environment ENV_CONFIG', 'Validate an environment configuration file'
+      long_desc <<~DESC
+        Validate an environment configuration file against its schema.
+
+        ENV_CONFIG should be the path to an environment config YAML file
+
+        Examples:
+          serialbench validate environment config/environments/local-dev.yml
+          serialbench validate environment config/environments/docker-ruby-3.4.yml
+      DESC
+      def environment(file_path)
+        validate_file(file_path, 'environment_config', 'Environment config')
+      end
+
+      desc 'resultset RESULTSET_FILE', 'Validate a resultset YAML file'
+      long_desc <<~DESC
+        Validate a resultset YAML file against its schema.
+
+        RESULTSET_FILE should be the path to a resultset.yaml file
+
+        Examples:
+          serialbench validate resultset results/sets/weekly-benchmark/resultset.yaml
+          serialbench validate resultset results/sets/comparison/resultset.yaml
+      DESC
+      def resultset(file_path)
+        validate_file(file_path, 'resultset', 'Resultset')
+      end
+
+      private
+
+      def validate_file(file_path, schema_name, friendly_name)
+        unless File.exist?(file_path)
+          say "❌ File not found: #{file_path}", :red
+          exit 1
+        end
+
+        say "📝 Validating #{friendly_name}: #{file_path}", :cyan
+
+        if Serialbench::YamlValidator.validate(file_path, schema_name)
+          say "✅ #{friendly_name} is valid", :green
+        else
+          say "❌ #{friendly_name} validation failed", :red
+          exit 1
+        end
+      rescue StandardError => e
+        say "❌ Error: #{e.message}", :red
+        exit 1
+      end
+    end
+  end
+end