Migrate to Container-Based Testing and Add Host-Based Index Targeting (#44)

Container-Based Testing Infrastructure

Local development: Docker containers for all Pinecone operations
CI/CD integration: GitHub Actions runs against local containers
No external dependencies: Tests run without API keys or network calls
Enhanced validation: Tests verify actual data content, not just HTTP status codes
🔧 Technical Changes

API Enhancements

Added host parameter to Pinecone::Client#index()
Added global host configuration: Pinecone.configure { |c| c.host = "..." }
HTTP/HTTPS protocol detection (HTTP for localhost, HTTPS for production)
Improved error handling and validation
Test Infrastructure Overhaul

Removed VCR dependencies across all specs
Container-based testing for vector operations (dense: 5081, sparse: 5082, database: 5080)
Strategic mocking for control plane operations (collections)
Enhanced validations verify actual data presence, not just key existence

Author: ScotterC

.github/workflows/ruby.yml

@@ -21,21 +21,61 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.2', '3.3']
+        ruby-version: ['3.4']
     env:
       PINECONE_API_KEY: sekret
-      PINECONE_ENVIRONMENT: us-east1-gcp
+    services:
+      pinecone-database:
+        image: ghcr.io/pinecone-io/pinecone-local:latest
+        env:
+          PORT: 5080
+          PINECONE_HOST: localhost
+        ports:
+          - 5080:5080
+      
+      dense-index:
+        image: ghcr.io/pinecone-io/pinecone-index:latest
+        env:
+          PORT: 5081
+          INDEX_TYPE: serverless
+          VECTOR_TYPE: dense
+          DIMENSION: 2
+          METRIC: cosine
+        ports:
+          - 5081:5081
+      
+      sparse-index:
+        image: ghcr.io/pinecone-io/pinecone-index:latest
+        env:
+          PORT: 5082
+          INDEX_TYPE: serverless
+          VECTOR_TYPE: sparse
+          DIMENSION: 0
+          METRIC: dotproduct
+        ports:
+          - 5082:5082
+    
     steps:
     - uses: actions/checkout@v3
+    
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+      # change this to (see https://github.com/ruby/setup-ruby#versioning):
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    
+    - name: Wait for Pinecone containers to be ready
+      run: |
+        echo "Waiting for Pinecone containers to be ready..."
+        timeout 60 bash -c 'until curl -f http://localhost:5080/indexes; do echo "Waiting for database container..."; sleep 2; done'
+        timeout 60 bash -c 'until curl -f http://localhost:5081/vectors/list; do echo "Waiting for dense index container..."; sleep 2; done'
+        timeout 60 bash -c 'until curl -f http://localhost:5082/vectors/list; do echo "Waiting for sparse index container..."; sleep 2; done'
+        echo "All Pinecone containers are ready!"
         
     - name: Run StandardRB Lint
       run: bundle exec standardrb
+      
     - name: Run tests
       run: bundle exec rspec

.gitignore

@@ -1,4 +1,6 @@
 .env
 scratch/
 *.gem
-settings.json
+settings.json
+plans/
+mise.toml

Gemfile

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
 
-gem "dotenv", "~> 2.8"
 gem "awesome_print", "~> 1.9"
-gem "rake", "~> 13.0"
 gem "debug", "~> 1.7"
+gem "dotenv", "~> 2.8"
+gem "rake", "~> 13.0"
 gem "rspec", "~> 3.12"
-gem "webmock", "~> 3.14"
-gem "vcr", "~> 6.1"
 gem "standard", "~> 1.33"
+gem "vcr", "~> 6.1"
+gem "webmock", "~> 3.14"

Gemfile.lock

@@ -9,131 +9,159 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.4)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
     awesome_print (1.9.2)
-    concurrent-ruby (1.2.2)
-    crack (0.4.5)
+    base64 (0.3.0)
+    bigdecimal (3.2.2)
+    concurrent-ruby (1.3.5)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    csv (3.3.0)
-    debug (1.7.2)
-      irb (>= 1.5.0)
-      reline (>= 0.3.1)
-    diff-lcs (1.5.0)
+    csv (3.3.5)
+    date (3.4.1)
+    debug (1.11.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.6.2)
     dotenv (2.8.1)
-    dry-configurable (1.0.1)
-      dry-core (~> 1.0, < 2)
+    dry-configurable (1.3.0)
+      dry-core (~> 1.1)
       zeitwerk (~> 2.6)
-    dry-core (1.0.0)
+    dry-core (1.1.0)
       concurrent-ruby (~> 1.0)
+      logger
       zeitwerk (~> 2.6)
-    dry-inflector (1.0.0)
-    dry-initializer (3.1.1)
-    dry-logic (1.5.0)
+    dry-inflector (1.2.0)
+    dry-initializer (3.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
       concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
+      dry-core (~> 1.1)
       zeitwerk (~> 2.6)
-    dry-schema (1.13.1)
+    dry-schema (1.14.1)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 1.0, >= 1.0.1)
-      dry-core (~> 1.0, < 2)
-      dry-initializer (~> 3.0)
-      dry-logic (>= 1.4, < 2)
-      dry-types (>= 1.7, < 2)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-logic (~> 1.5)
+      dry-types (~> 1.8)
       zeitwerk (~> 2.6)
-    dry-struct (1.6.0)
-      dry-core (~> 1.0, < 2)
-      dry-types (>= 1.7, < 2)
+    dry-struct (1.8.0)
+      dry-core (~> 1.1)
+      dry-types (~> 1.8, >= 1.8.2)
       ice_nine (~> 0.11)
       zeitwerk (~> 2.6)
-    dry-types (1.7.1)
+    dry-types (1.8.3)
+      bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0)
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    dry-validation (1.10.0)
+    dry-validation (1.11.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
-      dry-initializer (~> 3.0)
-      dry-schema (>= 1.12, < 2)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-schema (~> 1.14)
       zeitwerk (~> 2.6)
-    hashdiff (1.0.1)
+    erb (5.0.1)
+    hashdiff (1.2.0)
     httparty (0.22.0)
       csv
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     ice_nine (0.11.2)
-    io-console (0.6.0)
-    irb (1.6.4)
-      reline (>= 0.3.0)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    mini_mime (1.1.2)
-    multi_xml (0.6.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    logger (1.7.0)
+    mini_mime (1.1.5)
+    multi_xml (0.7.2)
+      bigdecimal (~> 3.1)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    public_suffix (5.0.1)
-    racc (1.7.3)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.4.0)
+    psych (5.2.6)
+      date
+      stringio
+    public_suffix (6.0.2)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.9.0)
-    reline (0.3.3)
+    rake (13.3.0)
+    rdoc (6.14.1)
+      erb
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.1)
       io-console (~> 0.5)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rexml (3.4.1)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.59.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    rubocop (1.75.8)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
     ruby-progressbar (1.13.0)
-    standard (1.33.0)
+    standard (1.50.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.59.0)
+      rubocop (~> 1.75.5)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
+      standard-performance (~> 1.8)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.3.1)
+    standard-performance (1.8.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    unicode-display_width (2.5.0)
-    vcr (6.1.0)
-    webmock (3.18.1)
+      rubocop-performance (~> 1.25.0)
+    stringio (3.1.7)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.8)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-21