hastci 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5b2325eb3310d82c948100ad8944303a1cafc0f3824497fa68ff3a2d229184b
-  data.tar.gz: 93b8a6e612a613d8491624008fa0e334653aff2b769e437385141c56ad62372b
+  metadata.gz: ea7c58f1b590502ae7258d6ded75619b5389d602ca474de3626de52ef65c1580
+  data.tar.gz: 8fe736f73a92b44e7d9f6a3e6b8fe569f48a3cf9114890e89e128132886cc2b4
 SHA512:
-  metadata.gz: d8d05f307a3408f5238081361f11c5fafbf5e5f1c1eb822bbeaf8dd42fb172bc4048ca7ae6d3303aa5cf77de543f51cea829313e7efaee814c74df59680debe3
-  data.tar.gz: 9b557ef0c58252027907cb79197d00273e100a7735b2072203d68c897c6a966cb0b47d0d985993ebcedf2954ab1238cdab9333902352a28cdb8fd3344d0a5397
+  metadata.gz: 69d3a81ad390852e5c28d4caf6900b4429a7d4d7d6781fd2eef97d8589b2027baef9b1241861fd7bf3001d5ecebc628aad4bf1c7373bcc92f51909798970df20
+  data.tar.gz: 54e1101e729ebf74cfbc06e857970c1d6966205f522d79b59e22ab93bd752c84ce74bc986c6cd05a6915253a2885ec0196ea0f9fe17ee74c88f543ad568f9b81

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  NewCops: disable
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false

data/README.md

@@ -1,43 +1,91 @@
-# HastCI
+# HastCI RSpec
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hastci`. To experiment with that code, run `bin/console` for an interactive prompt.
+Distributed test execution for RSpec. Workers pull tests from a central queue, so faster workers automatically run more tests.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add to your Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+group :development, :test do
+  gem "hastci-rspec"
+end
+```
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Usage
+
+### GitHub Actions
+
+HastCI auto-detects GitHub Actions and configures itself from the environment.
+
+```yaml
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ci_node_index: [0, 1, 2, 3]
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec hastci-rspec
+        env:
+          CI_NODE_INDEX: ${{ matrix.ci_node_index }}
+          HASTCI_API_KEY: ${{ secrets.HASTCI_API_KEY }}
+```
+
+For matrix builds with multiple dimensions (e.g., Ruby versions), use `HASTCI_SUBRUN_ID` to create separate test queues:
+
+```yaml
+strategy:
+  matrix:
+    ruby-version: ["3.2", "3.3", "3.4"]
+    ci_node_index: [0, 1]
+
+# ...
+
+env:
+  CI_NODE_INDEX: ${{ matrix.ci_node_index }}
+  HASTCI_API_KEY: ${{ secrets.HASTCI_API_KEY }}
+  HASTCI_SUBRUN_ID: ruby-${{ matrix.ruby-version }}
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Generic CI
+
+For other CI systems, set the required environment variables:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+export HASTCI_API_KEY="your-api-key"
+export HASTCI_RUN_KEY="unique-run-identifier"  # e.g., build-123-abc
+export CI_NODE_INDEX="0"  # 0, 1, 2... for each parallel worker
+
+bundle exec hastci-rspec
 ```
 
-## Usage
+## Configuration
 
-TODO: Write usage instructions here
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `HASTCI_API_KEY` | Yes | API key for HastCI |
+| `HASTCI_RUN_KEY` | Generic CI only | Unique identifier for this test run |
+| `CI_NODE_INDEX` | Yes | Worker index (0, 1, 2...) |
+| `HASTCI_WORKER_ID` | No | Custom worker ID (overrides `CI_NODE_INDEX`) |
+| `HASTCI_SUBRUN_ID` | No | Distinguishes matrix variations (GitHub Actions) |
+| `HASTCI_API_URL` | No | Custom API endpoint |
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/wojtodzio/hastci. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/wojtodzio/hastci/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/wojtodzio/hastci.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the HastCI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wojtodzio/hastci/blob/main/CODE_OF_CONDUCT.md).

data/bin/hastci-rspec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'hastci'
+require "hastci"
 
 exit HastCI.run_rspec(argv: ARGV, env: ENV)

data/lib/hastci/ack_worker.rb

@@ -4,7 +4,7 @@ module HastCI
   class AckWorker
     DEFAULT_QUEUE_SIZE = 1000
     DEFAULT_FLUSH_TIMEOUT = 10
-    EMPTY_QUEUE_POLL_INTERVAL = 0.05
+    EMPTY_QUEUE_POLL_INTERVAL = 0.5
     SHUTDOWN_TIMEOUT = 10
 
     private_constant :DEFAULT_QUEUE_SIZE, :DEFAULT_FLUSH_TIMEOUT, :EMPTY_QUEUE_POLL_INTERVAL,

data/lib/hastci/adapters/rspec/runner.rb

@@ -25,6 +25,7 @@ module HastCI
           @clock = clock
 
           @options = ::RSpec::Core::ConfigurationOptions.new(argv)
+          add_default_path_if_needed(@options, configuration)
           @configuration = configuration
           @world = world
         end
@@ -147,27 +148,18 @@ module HastCI
         end
 
         def build_logs(failed_examples)
-          {
-            summary: summary_for(failed_examples),
-            failures: failed_examples.map { |example| failure_payload(example) }
-          }
-        end
-
-        def summary_for(failed_examples)
-          return "passed" if failed_examples.empty?
+          return [] if failed_examples.empty?
 
-          "failed: #{failed_examples.length}"
-        end
+          failed_examples.map do |example|
+            exception = example.exception
 
-        def failure_payload(example)
-          exception = example.exception
-
-          {
-            file: example.metadata[:file_path],
-            line: example.metadata[:line_number],
-            message: exception&.message,
-            backtrace: Array(exception&.backtrace)
-          }
+            {
+              file: example.metadata[:file_path],
+              line: example.metadata[:line_number],
+              message: exception&.message,
+              backtrace: Array(exception&.backtrace)
+            }
+          end
         end
 
         def ordered_task_names(example_groups)
@@ -199,6 +191,16 @@ module HastCI
           end
           # :nocov:
         end
+
+        def add_default_path_if_needed(options, configuration)
+          files = options.options[:files_or_directories_to_run]
+          return unless files.empty?
+
+          default_path = configuration.default_path
+          return unless default_path
+
+          files << default_path
+        end
       end
     end
   end

data/lib/hastci/api_client.rb

@@ -7,6 +7,8 @@ require "uri"
 
 module HastCI
   class ApiClient
+    OriginalNetHTTP = Net::HTTP
+
     DEFAULT_MAX_RETRIES = 5
     DEFAULT_INITIAL_BACKOFF = 0.5
     DEFAULT_MAX_BACKOFF = 30
@@ -28,11 +30,13 @@ module HastCI
 
     private_constant :API_PATH_PREFIX, :CONNECTION_DEFAULT, :CONNECTION_HEARTBEAT, :CONNECTION_ACK
 
-    def initialize(config:, sleeper: Kernel.method(:sleep), max_retries: nil, random: Random.new)
+    def initialize(config:, sleeper: Kernel.method(:sleep), max_retries: nil, random: Random.new,
+      http_class: OriginalNetHTTP)
       @config = config
       @max_retries = max_retries || config.api_max_retries || DEFAULT_MAX_RETRIES
       @sleeper = sleeper
       @random = random
+      @http_class = http_class
 
       @base_url = URI.parse(config.api_base_url)
       @api_key = config.api_key
@@ -140,7 +144,7 @@ module HastCI
 
     def get_json(path, pool: CONNECTION_DEFAULT)
       uri = build_uri(path)
-      request = Net::HTTP::Get.new(uri)
+      request = @http_class::Get.new(uri)
       request["Authorization"] = "Bearer #{@api_key}"
 
       execute_request(request, pool: pool)
@@ -148,7 +152,7 @@ module HastCI
 
     def post_json(path, body, pool: CONNECTION_DEFAULT)
       uri = build_uri(path)
-      request = Net::HTTP::Post.new(uri)
+      request = @http_class::Post.new(uri)
       request["Content-Type"] = "application/json"
       request["Authorization"] = "Bearer #{@api_key}"
       request.body = JSON.generate(body)
@@ -226,7 +230,7 @@ module HastCI
     end
 
     def create_connection
-      http = Net::HTTP.new(@base_url.host, @base_url.port)
+      http = @http_class.new(@base_url.host, @base_url.port)
       http.use_ssl = @base_url.scheme == "https"
       http.open_timeout = DEFAULT_OPEN_TIMEOUT
       http.read_timeout = DEFAULT_READ_TIMEOUT

data/lib/hastci/cli.rb

@@ -86,12 +86,15 @@ module HastCI
     private_class_method :configure_logging
 
     # :nocov:
-    def self.setup_interrupt_handler(session, err, &on_interrupt)
+    def self.setup_interrupt_handler(session, err, signal_enqueuer: nil, &on_interrupt)
       signals = Queue.new
       signal_count = 0
+      enqueue_signal = signal_enqueuer || lambda do |queue, signal|
+        Thread.new { queue << signal }
+      end
 
-      trap("INT") { signals << "SIGINT" }
-      trap("TERM") { signals << "SIGTERM" }
+      trap("INT") { enqueue_signal.call(signals, "SIGINT") }
+      trap("TERM") { enqueue_signal.call(signals, "SIGTERM") }
 
       watcher = Thread.new do
         loop do

data/lib/hastci/config.rb

@@ -5,7 +5,7 @@ require "securerandom"
 module HastCI
   class Config
     DEFAULT_API_BASE_URL = "https://hastci.com"
-    DEFAULT_CLAIM_BATCH_SIZE = 10
+    DEFAULT_CLAIM_BATCH_SIZE = 2
     DEFAULT_HEARTBEAT_INTERVAL = 15
     DEFAULT_SEEDING_TIMEOUT = 300
     DEFAULT_LOG_LEVEL = "INFO"
@@ -33,12 +33,16 @@ module HastCI
       run_attempt = env.fetch("GITHUB_RUN_ATTEMPT")
       commit_sha = env.fetch("GITHUB_SHA")
       node_index = env.fetch("CI_NODE_INDEX")
+      subrun_id = env["HASTCI_SUBRUN_ID"]
+
+      base_run_key = "gha-#{run_id}-#{run_attempt}-#{commit_sha}"
+      run_key = subrun_id ? "#{base_run_key}-#{subrun_id}" : base_run_key
 
       new(
         api_key: env.fetch("HASTCI_API_KEY"),
         api_base_url: env.fetch("HASTCI_API_URL", DEFAULT_API_BASE_URL),
         api_max_retries: env["HASTCI_API_MAX_RETRIES"]&.to_i,
-        run_key: "gha-#{run_id}-#{run_attempt}-#{commit_sha}",
+        run_key: run_key,
         worker_id: "gha-worker-#{node_index}",
         commit_sha: commit_sha,
         claim_batch_size: env.fetch("HASTCI_CLAIM_BATCH_SIZE", DEFAULT_CLAIM_BATCH_SIZE).to_i,

data/lib/hastci/session.rb

@@ -3,8 +3,8 @@
 module HastCI
   class Session
     DEFAULT_POLL_INTERVAL = 0.5
-    DEFAULT_BUFFER_MIN_SIZE = 3
-    DEFAULT_BUFFER_MAX_SIZE = 10
+    DEFAULT_BUFFER_MIN_SIZE = 1
+    DEFAULT_BUFFER_MAX_SIZE = 2
     DEFAULT_SEEDING_POLL_INTERVAL = 1.0
 
     STOP_REASONS = %i[user_interrupt server_cancelled].freeze

data/lib/hastci/task_buffer.rb

@@ -54,20 +54,24 @@ module HastCI
     end
 
     def next_task
-      error = @error_collector.first_error
-      raise error if error
-
-      task = @queue.pop
-
-      if task.nil?
+      loop do
         error = @error_collector.first_error
         raise error if error
 
-        return nil
-      end
+        return nil if queue_closed_and_empty?
+
+        begin
+          task = @queue.pop(true)
+        rescue ThreadError
+          @sleeper.call(@poll_interval)
+          next
+        end
+
+        return nil if task.nil?
 
-      signal_prefetch_if_needed
-      task
+        signal_prefetch_if_needed
+        return task
+      end
     end
 
     def size
@@ -84,6 +88,10 @@ module HastCI
 
     private
 
+    def queue_closed_and_empty?
+      @queue.respond_to?(:closed?) && @queue.closed? && @queue.empty?
+    end
+
     def signal_prefetch_if_needed
       @mutex.synchronize do
         @prefetch_condition.signal if @queue.size < @min_size
@@ -117,9 +125,7 @@ module HastCI
 
     def wait_for_prefetch_signal
       @mutex.synchronize do
-        while @running && !@drained && @queue.size >= @min_size
-          @prefetch_condition.wait(@mutex, @poll_interval)
-        end
+        @prefetch_condition.wait(@mutex, @poll_interval) while @running && !@drained && @queue.size >= @min_size
       end
     end
 

data/lib/hastci/version.rb

@@ -2,6 +2,6 @@
 
 # :nocov:
 module HastCI
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end
 # :nocov:

data/spec/pacts/hastci_rspec-hastci_api.json

@@ -373,16 +373,69 @@
         "body": {
           "status": "passed",
           "duration_s": 1.5,
-          "logs": {
-            "summary": "1 example, 0 failures",
-            "failures": [
+          "logs": [
         ]
+        },
+        "matchingRules": {
+          "$.path": {
+            "match": "regex",
+            "regex": "^\\/api\\/v1\\/tasks\\/\\d+\\/acknowledgment$"
           }
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "ok": true
+        }
+      }
+    },
+    {
+      "description": "a request to ack a task with failures",
+      "providerState": "a task exists",
+      "request": {
+        "method": "post",
+        "path": "/api/v1/tasks/101/acknowledgment",
+        "headers": {
+          "Authorization": "Bearer test-api-key",
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "status": "failed",
+          "duration_s": 2.0,
+          "logs": [
+            {
+              "file": "spec/models/user_spec.rb",
+              "line": 123,
+              "message": "Expected 1, got 2",
+              "backtrace": [
+                "spec/models/user_spec.rb:123:in `block'"
+              ]
+            }
+          ]
         },
         "matchingRules": {
           "$.path": {
             "match": "regex",
             "regex": "^\\/api\\/v1\\/tasks\\/\\d+\\/acknowledgment$"
+          },
+          "$.body.logs[0].file": {
+            "match": "type"
+          },
+          "$.body.logs[0].line": {
+            "match": "type"
+          },
+          "$.body.logs[0].message": {
+            "match": "type"
+          },
+          "$.body.logs[0].backtrace": {
+            "min": 1
+          },
+          "$.body.logs[0].backtrace[*].*": {
+            "match": "type"
           }
         }
       },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hastci
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Wojciech Wrona
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 files:
 - ".envrc"
 - ".rspec"
+- ".rubocop.yml"
 - ".standard.yml"
 - ".zed/settings.json"
 - CHANGELOG.md