baza.rb 0.4.0 → 0.5.1

data/test/test_baza-rb.rb

@@ -5,11 +5,12 @@
 
 require 'factbase'
 require 'loog'
-require 'net/ping'
+require 'net/http'
 require 'random-port'
 require 'securerandom'
 require 'socket'
 require 'stringio'
+require 'uri'
 require 'wait_for'
 require 'webrick'
 require_relative 'test__helper'
@@ -17,10 +18,10 @@ require_relative '../lib/baza-rb'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class TestBazaRb < Minitest::Test
-  # The token to use for testing:
+  # The token to use for testing, in Zerocracy.com:
   TOKEN = '00000000-0000-0000-0000-000000000000'
 
   # The host of the production platform:
@@ -32,7 +33,7 @@ class TestBazaRb < Minitest::Test
   # Live agent:
   LIVE = BazaRb.new(HOST, PORT, TOKEN, loog: Loog::VERBOSE)
 
-  def test_live_push
+  def test_live_full_cycle
     WebMock.enable_net_connect!
     skip('We are offline') unless we_are_online
     fb = Factbase.new
@@ -43,7 +44,12 @@ class TestBazaRb < Minitest::Test
     assert(LIVE.name_exists?(n))
     assert_predicate(LIVE.recent(n), :positive?)
     id = LIVE.recent(n)
-    wait_for(60) { LIVE.finished?(id) }
+    assert(
+      wait_for(8 * 60) do
+        sleep(5)
+        LIVE.finished?(id)
+      end
+    )
     refute_nil(LIVE.pull(id))
     refute_nil(LIVE.stdout(id))
     refute_nil(LIVE.exit_code(id))
@@ -120,7 +126,7 @@ class TestBazaRb < Minitest::Test
     stub_request(:post, 'https://example.org/account/transfer').to_return(
       status: 302, headers: { 'X-Zerocracy-ReceiptId' => '42' }
     )
-    id = BazaRb.new('example.org', 443, '000').transfer('jeff', 42.50, 'for fun')
+    id = fake_baza.transfer('jeff', 42.50, 'for fun')
     assert_equal(42, id)
   end
 
@@ -130,10 +136,40 @@ class TestBazaRb < Minitest::Test
     stub_request(:post, 'https://example.org/account/transfer').to_return(
       status: 302, headers: { 'X-Zerocracy-ReceiptId' => '42' }
     )
-    id = BazaRb.new('example.org', 443, '000').transfer('jeff', 42.50, 'for fun', job: 555)
+    id = fake_baza.transfer('jeff', 42.50, 'for fun', job: 555)
     assert_equal(42, id)
   end
 
+  def test_reads_whoami
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/whoami').to_return(status: 200, body: 'jeff')
+    assert_equal('jeff', fake_baza.whoami)
+  end
+
+  def test_reads_balance
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/account/balance').to_return(status: 200, body: '42.33')
+    assert_in_delta(42.33, fake_baza.balance)
+  end
+
+  def test_checks_whether_job_is_finished
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/finished/42').to_return(status: 200, body: 'yes')
+    assert(fake_baza.finished?(42))
+  end
+
+  def test_reads_verification_verdict
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/jobs/42/verified.txt').to_return(status: 200, body: 'done')
+    assert(fake_baza.verified(42))
+  end
+
+  def test_unlocks_job_by_name
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/unlock/foo?owner=x').to_return(status: 302)
+    assert(fake_baza.unlock('foo', 'x'))
+  end
+
   def test_durable_place
     WebMock.disable_net_connect!
     stub_request(:get, 'https://example.org/csrf').to_return(body: 'token')
@@ -143,7 +179,7 @@ class TestBazaRb < Minitest::Test
     Dir.mktmpdir do |dir|
       file = File.join(dir, 'test.bin')
       File.binwrite(file, 'hello')
-      assert_equal(42, BazaRb.new('example.org', 443, '000').durable_place('simple', file))
+      assert_equal(42, fake_baza.durable_place('simple', file))
     end
   end
 
@@ -154,24 +190,71 @@ class TestBazaRb < Minitest::Test
     )
     assert_equal(
       42,
-      BazaRb.new('example.org', 443, '000').push('simple', 'hello, world!', [])
+      fake_baza.push('simple', 'hello, world!', [])
     )
   end
 
-  def test_simple_pop
+  def test_simple_pop_with_no_job_found
     WebMock.disable_net_connect!
     stub_request(:get, 'https://example.org/pop?owner=me').to_return(status: 204)
     Tempfile.open do |zip|
-      refute(BazaRb.new('example.org', 443, '000').pop('me', zip.path))
+      refute(fake_baza.pop('me', zip.path))
       refute_path_exists(zip.path)
     end
   end
 
+  def test_simple_pop_with_ranges
+    WebMock.disable_net_connect!
+    owner = 'owner888'
+    job = 4242
+    stub_request(:get, 'https://example.org/pop')
+      .with(query: { owner: })
+      .to_return(
+        status: 206,
+        headers: { 'Content-Range' => 'bytes 0-0/*', 'X-Zerocracy-JobId' => job, 'Content-Length' => 0 },
+        body: ''
+      )
+    bin = nil
+    Tempfile.open do |zip|
+      File.binwrite(zip.path, 'the archive to return (not a real ZIP for now)')
+      bin = File.binread(zip.path)
+      stub_request(:get, 'https://example.org/pop')
+        .with(query: { job:, owner: })
+        .with(headers: { 'Range' => 'bytes=0-' })
+        .to_return(
+          status: 206,
+          headers: {
+            'Content-Range' => "bytes 0-7/#{bin.size}",
+            'X-Zerocracy-JobId' => job,
+            'Content-Length' => 8
+          },
+          body: bin[0..7]
+        )
+      stub_request(:get, 'https://example.org/pop')
+        .with(query: { job:, owner: })
+        .with(headers: { 'Range' => 'bytes=8-' })
+        .to_return(
+          status: 206,
+          headers: {
+            'Content-Range' => "bytes 8-#{bin.size - 1}/#{bin.size}",
+            'X-Zerocracy-JobId' => job,
+            'Content-Length' => bin.size - 8
+          },
+          body: bin[8..]
+        )
+    end
+    Tempfile.open do |zip|
+      assert(fake_baza.pop(owner, zip.path))
+      assert_path_exists(zip.path)
+      assert_equal(bin, File.binread(zip.path))
+    end
+  end
+
   def test_simple_finish
     WebMock.disable_net_connect!
     stub_request(:put, 'https://example.org/finish?id=42').to_return(status: 200)
     Tempfile.open do |zip|
-      BazaRb.new('example.org', 443, '000').finish(42, zip.path)
+      fake_baza.finish(42, zip.path)
     end
   end
 
@@ -182,7 +265,7 @@ class TestBazaRb < Minitest::Test
       .to_return(status: 200, body: '42')
     assert_equal(
       42,
-      BazaRb.new('example.org', 443, '000').recent('simple')
+      fake_baza.recent('simple')
     )
   end
 
@@ -192,7 +275,7 @@ class TestBazaRb < Minitest::Test
       status: 200, body: 'yes'
     )
     assert(
-      BazaRb.new('example.org', 443, '000').name_exists?('simple')
+      fake_baza.name_exists?('simple')
     )
   end
 
@@ -202,7 +285,7 @@ class TestBazaRb < Minitest::Test
       status: 200, body: '0'
     )
     assert_predicate(
-      BazaRb.new('example.org', 443, '000').exit_code(42), :zero?
+      fake_baza.exit_code(42), :zero?
     )
   end
 
@@ -212,7 +295,7 @@ class TestBazaRb < Minitest::Test
       status: 200, body: 'hello!'
     )
     refute_empty(
-      BazaRb.new('example.org', 443, '000').stdout(42)
+      fake_baza.stdout(42)
     )
   end
 
@@ -222,21 +305,21 @@ class TestBazaRb < Minitest::Test
       status: 200, body: 'hello, world!'
     )
     assert(
-      BazaRb.new('example.org', 443, '000').pull(333).start_with?('hello')
+      fake_baza.pull(333).start_with?('hello')
     )
   end
 
   def test_simple_lock_success
     WebMock.disable_net_connect!
     stub_request(:get, 'https://example.org/lock/name?owner=owner').to_return(status: 302)
-    BazaRb.new('example.org', 443, '000').lock('name', 'owner')
+    fake_baza.lock('name', 'owner')
   end
 
   def test_simple_lock_failure
     WebMock.disable_net_connect!
     stub_request(:get, 'https://example.org/lock/name?owner=owner').to_return(status: 409)
     assert_raises(StandardError) do
-      BazaRb.new('example.org', 443, '000').lock('name', 'owner')
+      fake_baza.lock('name', 'owner')
     end
   end
 
@@ -245,7 +328,7 @@ class TestBazaRb < Minitest::Test
     stub_request(:put, 'https://example.org/push/foo')
       .to_return(status: 503, body: 'oops', headers: { 'X-Zerocracy-Failure': 'the failure' })
       .to_raise('why second time?')
-    e = assert_raises(StandardError) { BazaRb.new('example.org', 443, '000').push('foo', 'data', []) }
+    e = assert_raises(StandardError) { fake_baza.push('foo', 'data', []) }
     [
       'Invalid response code #503',
       '"the failure"'
@@ -293,30 +376,32 @@ class TestBazaRb < Minitest::Test
   def test_push_compressed_content
     WebMock.enable_net_connect!
     skip('We are offline') unless we_are_online
+    fb = Factbase.new
+    fb.insert.foo = 'test-' * 10_000
     req =
       with_http_server(200, 'yes') do |baza|
-        baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
+        baza.push('simple', fb.export, %w[meta1 meta2 meta3])
       end
     assert_equal('application/zip', req.content_type)
     assert_equal('gzip', req['content-encoding'])
     body = Zlib::GzipReader.zcat(StringIO.new(req.body))
-    assert_equal('hello, world!', body)
+    assert_equal(fb.export, body)
   end
 
   def test_push_compression_disabled
     WebMock.enable_net_connect!
-    skip('We are offline') unless we_are_online
+    fb = Factbase.new
+    fb.insert.foo = 'test-' * 10_000
     req =
       with_http_server(200, 'yes', compress: false) do |baza|
-        baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
+        baza.push('simple', fb.export, %w[meta1 meta2 meta3])
       end
     assert_equal('application/octet-stream', req.content_type)
-    assert_equal('hello, world!', req.body)
+    assert_equal(fb.export, req.body)
   end
 
   def test_with_very_short_timeout
     WebMock.enable_net_connect!
-    skip('We are offline') unless we_are_online
     host = '127.0.0.1'
     RandomPort::Pool::SINGLETON.acquire do |port|
       server = TCPServer.new(host, port)
@@ -335,16 +420,192 @@ class TestBazaRb < Minitest::Test
           BazaRb.new(host, port, '0000', ssl: false, timeout: 0.01).push('x', 'y', [])
         end.message, 'timed out in'
       )
-      t.join
+      t.terminate
+      assert(t.join(1))
     end
   end
 
+  def test_durable_save
+    WebMock.disable_net_connect!
+    Dir.mktmpdir do |dir|
+      file = File.join(dir, 'test.txt')
+      File.write(file, 'test content')
+      stub_request(:put, 'https://example.org:443/durables/42')
+        .with(headers: { 'X-Zerocracy-Token' => '000' }, body: 'test content')
+        .to_return(status: 200)
+      fake_baza.durable_save(42, file)
+    end
+  end
+
+  def test_durable_load
+    WebMock.disable_net_connect!
+    Dir.mktmpdir do |dir|
+      file = File.join(dir, 'loaded.txt')
+      stub_request(:get, 'https://example.org:443/durables/42')
+        .with(headers: { 'X-Zerocracy-Token' => '000' })
+        .to_return(status: 200, body: 'loaded content')
+      fake_baza.durable_load(42, file)
+      assert_equal('loaded content', File.read(file))
+    end
+  end
+
+  def test_durable_lock
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/durables/42/lock?owner=test-owner')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 302)
+    fake_baza.durable_lock(42, 'test-owner')
+  end
+
+  def test_durable_unlock
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/durables/42/unlock?owner=test-owner')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 302)
+    fake_baza.durable_unlock(42, 'test-owner')
+  end
+
+  def test_fee
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/csrf')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 200, body: 'csrf-token')
+    stub_request(:post, 'https://example.org:443/account/fee')
+      .with(
+        headers: { 'X-Zerocracy-Token' => '000' },
+        body: {
+          '_csrf' => 'csrf-token',
+          'tab' => 'unknown',
+          'amount' => '10.500000',
+          'summary' => 'Test fee',
+          'job' => '123'
+        }
+      )
+      .to_return(status: 302, headers: { 'X-Zerocracy-ReceiptId' => '456' })
+    receipt = fake_baza.fee('unknown', 10.5, 'Test fee', 123)
+    assert_equal(456, receipt)
+  end
+
+  def test_enter
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/valves/result?badge=test-badge')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 200, body: 'cached result')
+    result = fake_baza.enter('test-valve', 'test-badge', 'test reason', 123) { 'new result' }
+    assert_equal('cached result', result)
+  end
+
+  def test_enter_not_cached
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/valves/result?badge=test-badge')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 204)
+    stub_request(:get, 'https://example.org:443/csrf')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 200, body: 'csrf-token')
+    stub_request(:post, 'https://example.org:443/valves/add?job=123')
+      .with(
+        headers: { 'X-Zerocracy-Token' => '000' },
+        body: {
+          '_csrf' => 'csrf-token',
+          'name' => 'test-valve',
+          'badge' => 'test-badge',
+          'why' => 'test reason',
+          'result' => 'new result'
+        }
+      )
+      .to_return(status: 302)
+    result = fake_baza.enter('test-valve', 'test-badge', 'test reason', 123) { 'new result' }
+    assert_equal('new result', result)
+  end
+
+  def test_checked_with_500_error
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/test')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 500)
+    error =
+      assert_raises(BazaRb::ServerFailure) do
+        fake_baza.send(
+          :checked,
+          Typhoeus.get('https://example.org:443/test', headers: { 'X-Zerocracy-Token' => '000' })
+        )
+      end
+    assert_includes(error.message, 'Invalid response code #500')
+    assert_includes(error.message, "most probably it's an internal error on the server")
+  end
+
+  def test_checked_with_503_error
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/test')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 503, headers: { 'X-Zerocracy-Failure' => 'Service unavailable' })
+    error =
+      assert_raises(BazaRb::ServerFailure) do
+        fake_baza.send(
+          :checked,
+          Typhoeus.get('https://example.org:443/test', headers: { 'X-Zerocracy-Token' => '000' })
+        )
+      end
+    assert_includes(error.message, 'Invalid response code #503')
+    assert_includes(error.message, "most probably it's an internal error on the server")
+    assert_includes(error.message, 'Service unavailable')
+  end
+
+  def test_checked_with_404_error
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/test')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 404)
+    error =
+      assert_raises(BazaRb::ServerFailure) do
+        fake_baza.send(
+          :checked,
+          Typhoeus.get('https://example.org:443/test', headers: { 'X-Zerocracy-Token' => '000' })
+        )
+      end
+    assert_includes(error.message, 'Invalid response code #404')
+    assert_includes(error.message, 'most probably you are trying to reach a wrong server')
+  end
+
+  def test_checked_with_0_error
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org:443/test')
+      .with(headers: { 'X-Zerocracy-Token' => '000' })
+      .to_return(status: 0)
+    error =
+      assert_raises(BazaRb::ServerFailure) do
+        fake_baza.send(
+          :checked,
+          Typhoeus.get('https://example.org:443/test', headers: { 'X-Zerocracy-Token' => '000' })
+        )
+      end
+    assert_includes(error.message, 'Invalid response code #0')
+    assert_includes(error.message, 'most likely a connection failure')
+  end
+
+  def test_push_without_compression
+    WebMock.disable_net_connect!
+    baza = BazaRb.new('example.org', 443, '000', loog: Loog::NULL, compress: false)
+    stub_request(:put, 'https://example.org:443/push/test')
+      .with(
+        headers: {
+          'X-Zerocracy-Token' => '000',
+          'Content-Type' => 'application/octet-stream',
+          'Content-Length' => '4'
+        },
+        body: 'data'
+      )
+      .to_return(status: 200, body: '123')
+    id = baza.push('test', 'data', [])
+    assert_equal(123, id)
+  end
+
   private
 
   def with_http_server(code, response, opts = {})
     opts = { ssl: false, timeout: 1 }.merge(opts)
     WebMock.enable_net_connect!
-    skip('We are offline') unless we_are_online
     req = WEBrick::HTTPRequest.new(WEBrick::Config::HTTP)
     host = '127.0.0.1'
     RandomPort::Pool::SINGLETON.acquire do |port|
@@ -353,21 +614,44 @@ class TestBazaRb < Minitest::Test
         Thread.new do
           socket = server.accept
           req.parse(socket)
-          req.body
-          socket.puts "HTTP/1.1 #{code} OK\r\nContent-Length: #{response.length}\r\n\r\n#{response}"
+          body = req.body
+          len = req.header['content-length'].first.to_i
+          if body.nil? || len == body.size
+            socket.puts "HTTP/1.1 #{code} OK\r\nContent-Length: #{response.length}\r\n\r\n#{response}"
+          else
+            socket.puts "HTTP/1.1 400 Bad Request\r\n"
+          end
           socket.close
         end
       yield BazaRb.new(host, port, '0000', **opts)
-      t.join
+      t.terminate
+      assert(t.join(1))
     end
     req
   end
 
+  def fake_baza
+    BazaRb.new('example.org', 443, '000', loog: Loog::NULL)
+  end
+
   def fake_name
     "fake#{SecureRandom.hex(8)}"
   end
 
   def we_are_online
-    @we_are_online ||= Net::Ping::External.new('8.8.8.8').ping?
+    $we_are_online ||= !ARGV.include?('--offline') && uri_is_alive('https://www.zerocracy.com')
+  end
+  # rubocop:enable Style/GlobalVars
+
+  # Checks whether this URI is alive (HTTP status is 200).
+  def uri_is_alive(uri)
+    Timeout.timeout(4) do
+      require 'net/http'
+      WebMock.enable_net_connect!
+      Net::HTTP.get_response(URI(uri)).is_a?(Net::HTTPSuccess)
+    rescue Timeout::Error, Timeout::ExitException, Socket::ResolutionError, Errno::EHOSTUNREACH, Errno::EINVAL
+      puts "Ping failed to #{uri}"
+      false
+    end
   end
 end

data/test/test_fake.rb

@@ -8,7 +8,7 @@ require_relative '../lib/baza-rb/fake'
 
 # Test fake object.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class TestFake < Minitest::Test
   def test_whoami

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: baza.rb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 bindir: bin
 cert_chain: []
-date: 2025-04-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -163,15 +163,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: It is a Ruby client for Zerocracy API, allowing you to check your jobs
+description: It is a Ruby client for Zerocracy API, allowing you to check your job
   statuses, upload and download binaries, lock/unlock them, manage durables, and do
   everything else that is possible to do via the HTTP API.
 email: yegor256@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".0pdd.yml"
 - ".gitattributes"
@@ -182,6 +182,7 @@ files:
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
 - ".github/workflows/reuse.yml"
+- ".github/workflows/typos.yml"
 - ".github/workflows/xcop.yml"
 - ".github/workflows/yamllint.yml"
 - ".gitignore"
@@ -225,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Zerocracy API Ruby Client
 test_files: []