judges 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db0130833063b43aab8a1dacec3106566da9c398fe539eea33eb8e76529d9d09
-  data.tar.gz: 2ced92ba9c8896742ad493dc75be234864cef5690d0313a6a581ee7e12cb427a
+  metadata.gz: 01de840b5ca098985b5b4cbdc1ea16d96237d3bbed4617971662f5628fad46bf
+  data.tar.gz: e502a04924b0186921fbbc2026e4f7d78eed0ee47ec2f6cdfcfb01c65e092050
 SHA512:
-  metadata.gz: d4393433a51dfdbabec4e6b8c09d9a02255fc18f76022f571a9633abf73c9f4bc9783ef1b4175dca14f35a939f5cc043f6052f928c5798206d40bda22667e6d7
-  data.tar.gz: b4e7653eb03bec4c3ec08a4060c594d1ded0bbe63e24357bce24bab52e4dee1d74615ac7199bbbf09b485c51072c997f513d71011c3fef4147a46c378bf786cd
+  metadata.gz: 38e602fda2bc3a1cce738e1633094d7dc0bc8a50fb43ff97e1e28d4da36752bbdb56fac51f98a2cec884b7a3245b701566c7500d817f4a242fbfb0c28cd9b62d
+  data.tar.gz: d9d5761f6384e7898da2cbab0b39a659d22f91a1af61a834f52c038f0162b8ebf08f576a8ea846b9a3818fb5f822c6d018552478d979365fa0226955f7cdc5d3

data/.github/workflows/copyrights.yml

@@ -27,4 +27,4 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
-      - uses: yegor256/copyrights-action@0.0.4
+      - uses: yegor256/copyrights-action@0.0.5

data/.rubocop.yml

@@ -28,6 +28,8 @@ AllCops:
   SuggestExtensions: false
   NewCops: enable
 
+Metrics/ParameterLists:
+  Enabled: false
 Style/GlobalVars:
   Enabled: false
 Metrics/MethodLength:

data/Gemfile

@@ -25,13 +25,14 @@ gemspec
 
 gem 'cucumber', '9.2.0', require: false
 gem 'minitest', '5.24.1', require: false
+gem 'minitest-reporters', '1.7.1', require: false
 gem 'net-ping', '2.0.8', require: false
 gem 'rake', '13.2.1', require: false
 gem 'random-port', '~>0.0', require: false
 gem 'rspec-rails', '6.1.3', require: false
 gem 'rubocop', '1.65.0', require: false
 gem 'rubocop-performance', '1.21.1', require: false
-gem 'rubocop-rspec', '3.0.2', require: false
+gem 'rubocop-rspec', '3.0.3', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
 gem 'webmock', '3.23.1', require: false

data/Gemfile.lock

@@ -46,6 +46,7 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    ansi (1.5.0)
     ast (2.4.2)
     backtrace (0.4.0)
     base64 (0.2.0)
@@ -122,6 +123,11 @@ GEM
     loog (0.5.2)
     mini_mime (1.1.5)
     minitest (5.24.1)
+    minitest-reporters (1.7.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     moments (0.3.0)
     multi_test (1.1.0)
     mutex_m (0.2.0)
@@ -174,7 +180,7 @@ GEM
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
-    random-port (0.7.0)
+    random-port (0.7.1)
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
@@ -216,7 +222,7 @@ GEM
     rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.0.2)
+    rubocop-rspec (3.0.3)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
@@ -261,13 +267,14 @@ DEPENDENCIES
   cucumber (= 9.2.0)
   judges!
   minitest (= 5.24.1)
+  minitest-reporters (= 1.7.1)
   net-ping (= 2.0.8)
   rake (= 13.2.1)
   random-port (~> 0.0)
   rspec-rails (= 6.1.3)
   rubocop (= 1.65.0)
   rubocop-performance (= 1.21.1)
-  rubocop-rspec (= 3.0.2)
+  rubocop-rspec (= 3.0.3)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
   webmock (= 3.23.1)

data/README.md

@@ -34,6 +34,8 @@ global variables available to it:
 Every `.yml` file must be formatted as such:
 
 ```yaml
+before:
+  - abc
 category: slow
 runs: 1
 skip: false
@@ -60,6 +62,9 @@ which then may be turned on via the `--category` command line flag.
 The `runs` (default: `1`) is the number of times the `.rb` script should
 be executed. After each execution, all expected XPath expressions are validated.
 
+The `before` (default: `[]`) is a list of judges that must be executed before
+the current one.
+
 ## How to contribute
 
 Read

data/bin/judges

@@ -179,6 +179,8 @@ class App
     c.flag([:owner], default_value: 'default', type: String)
     c.desc 'Supplementary meta information about the upload (key:value)'
     c.flag([:meta], type: String, multiple: true)
+    c.desc 'How many times to retry'
+    c.flag([:retries], type: Integer, default_value: 3)
     c.action do |global, options, args|
       require_relative '../lib/judges/commands/push'
       Judges::Push.new(loog).run(options, args)
@@ -201,6 +203,8 @@ class App
     c.switch([:ssl], default_value: true)
     c.desc 'A unique name to use for a lock/unlock'
     c.flag([:owner], default_value: 'default', type: String)
+    c.desc 'How many times to retry'
+    c.flag([:retries], type: Integer, default_value: 3)
     c.action do |global, options, args|
       require_relative '../lib/judges/commands/pull'
       Judges::Pull.new(loog).run(options, args)

data/features/push.feature

@@ -6,6 +6,6 @@ Feature: Push
     Given I make a temp directory
     Then I run bin/judges with "--verbose eval simple.fb '(0..1000).each { $fb.insert.foo = 42 }'"
     And Exit code is zero
-    Then I run bin/judges with "push --token 00000000-0000-0000-0000-000000000000 --meta a:b --meta foo:bar simple simple.fb"
+    Then I run bin/judges with "push --token 00000000-0000-0000-0000-000000000000 --meta a:b --meta foo:bar --meta=pages_url:https://zerocracy.github.io/zerocracy.html --meta=duration:1055  simple simple.fb"
     Then Stdout contains "Pushed"
     And Exit code is zero

data/features/test.feature

@@ -118,3 +118,26 @@ Feature: Test
     Then I run bin/judges with "test --enable bad mine"
     Then Stdout contains "Testing mine/bad/bad.yml"
     And Exit code is not zero
+
+  Scenario: Test with a pre-condition
+    Given I make a temp directory
+    Then I have a "mine/first/first.rb" file with content:
+    """
+    n = $fb.insert
+    n.foo = 42
+    """
+    Then I have a "mine/second/second.rb" file with content:
+    """
+    n = $fb.insert
+    n.foo = 55
+    """
+    Then I have a "mine/second/second.yml" file with content:
+    """
+    ---
+    before:
+      - first
+    expected:
+      - /fb[count(f)=2]
+    """
+    Then I run bin/judges with "test mine"
+    And Exit code is zero

data/judges.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'judges'
-  s.version = '0.16.0'
+  s.version = '0.18.0'
   s.license = 'MIT'
   s.summary = 'Command-Line Tool for a Factbase'
   s.description =

data/lib/judges/baza.rb

@@ -33,15 +33,14 @@ require_relative '../judges/elapsed'
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Judges::Baza
-  # rubocop:disable Metrics/ParameterLists
-  def initialize(host, port, token, ssl: true, timeout: 30, loog: Loog::NULL)
-    # rubocop:enable Metrics/ParameterLists
+  def initialize(host, port, token, ssl: true, timeout: 30, retries: 3, loog: Loog::NULL)
     @host = host
     @port = port
     @ssl = ssl
     @token = token
     @timeout = timeout
     @loog = loog
+    @retries = retries
   end
 
   def push(name, data, meta)
@@ -50,9 +49,11 @@ class Judges::Baza
       'Content-Type' => 'application/octet-stream',
       'Content-Length' => data.size
     )
-    hdrs = hdrs.merge('X-Zerocracy-Meta' => meta.map { |v| Base64.encode64(v).strip }.join(' ')) unless meta.empty?
+    unless meta.empty?
+      hdrs = hdrs.merge('X-Zerocracy-Meta' => meta.map { |v| Base64.encode64(v).gsub("\n", '') }.join(' '))
+    end
     elapsed(@loog) do
-      ret = with_retries do
+      ret = with_retries(max_tries: @retries) do
         checked(
           Typhoeus::Request.put(
             home.append('push').append(name).to_s,
@@ -85,7 +86,9 @@ class Judges::Baza
           request.on_body do |chunk|
             f.write(chunk)
           end
-          request.run
+          with_retries(max_tries: @retries) do
+            request.run
+          end
           checked(request.response)
         end
         data = File.binread(file)
@@ -99,7 +102,7 @@ class Judges::Baza
   def finished?(id)
     finished = false
     elapsed(@loog) do
-      ret = with_retries do
+      ret = with_retries(max_tries: @retries) do
         checked(
           Typhoeus::Request.get(
             home.append('finished').append(id).to_s,
@@ -116,7 +119,7 @@ class Judges::Baza
   # Lock the name.
   def lock(name, owner)
     elapsed(@loog) do
-      with_retries do
+      with_retries(max_tries: @retries) do
         checked(
           Typhoeus::Request.get(
             home.append('lock').append(name).add(owner:).to_s,
@@ -131,7 +134,7 @@ class Judges::Baza
   # Unlock the name.
   def unlock(name, owner)
     elapsed(@loog) do
-      with_retries do
+      with_retries(max_tries: @retries) do
         checked(
           Typhoeus::Request.get(
             home.append('unlock').append(name).add(owner:).to_s,
@@ -146,7 +149,7 @@ class Judges::Baza
   def recent(name)
     job = 0
     elapsed(@loog) do
-      ret = with_retries do
+      ret = with_retries(max_tries: @retries) do
         checked(
           Typhoeus::Request.get(
             home.append('recent').append("#{name}.txt").to_s,
@@ -163,7 +166,7 @@ class Judges::Baza
   def name_exists?(name)
     exists = 0
     elapsed(@loog) do
-      ret = with_retries do
+      ret = with_retries(max_tries: @retries) do
         checked(
           Typhoeus::Request.get(
             home.append('exists').append(name).to_s,
@@ -220,6 +223,8 @@ class Judges::Baza
       msg +=
         ', most probably you are trying to reach a wrong server, which doesn\'t ' \
         'have the URL that it is expected to have'
+    when 0
+      msg += ', most likely an internal error'
     end
     raise msg
   end

data/lib/judges/commands/pull.rb

@@ -42,13 +42,14 @@ class Judges::Pull
       opts['host'], opts['port'].to_i, opts['token'],
       ssl: opts['ssl'],
       timeout: (opts['timeout'] || 30).to_i,
-      loog: @loog
+      loog: @loog,
+      retries: (opts['retries'] || 3).to_i
     )
     name = args[0]
     elapsed(@loog) do
       if baza.name_exists?(name)
         baza.lock(name, opts['owner'])
-        fb.import(baza.pull(wait(baza, baza.recent(name), opts['wait'])))
+        fb.import(baza.pull(wait(name, baza, baza.recent(name), opts['wait'])))
         Judges::Impex.new(@loog, args[1]).export(fb)
         throw :"Pulled #{fb.size} facts by the name '#{name}'"
       else
@@ -59,14 +60,15 @@ class Judges::Pull
 
   private
 
-  def wait(baza, id, limit)
+  def wait(name, baza, id, limit)
     raise 'Waiting time is nil' if limit.nil?
     start = Time.now
     loop do
       break if baza.finished?(id)
       sleep 1
-      raise 'Time is over, the job is still not finished' if Time.now - start > limit
-      @loog.debug("Still waiting for the job ##{id} to finish... (#{format('%.2f', Time.now - start)}s already)")
+      raise "Time is over, the job ##{id} ('#{name}') is still not finished" if Time.now - start > limit
+      lapsed = Time.now - start
+      @loog.debug("Still waiting for the job ##{id} ('#{name}') to finish... (#{format('%.2f', lapsed)}s already)")
     end
     id
   end

data/lib/judges/commands/push.rb

@@ -43,7 +43,8 @@ class Judges::Push
       opts['host'], opts['port'].to_i, opts['token'],
       ssl: opts['ssl'],
       timeout: (opts['timeout'] || 30).to_i,
-      loog: @loog
+      loog: @loog,
+      retries: (opts['retries'] || 3).to_i
     )
     elapsed(@loog) do
       baza.lock(name, opts['owner'])

data/lib/judges/commands/test.rb

@@ -46,18 +46,19 @@ class Judges::Test
     dir = args[0]
     @loog.info("Testing judges in #{dir.to_rel}...")
     errors = []
-    judges = 0
+    tested = 0
     tests = 0
     visible = []
+    judges = Judges::Judges.new(dir, opts['lib'], @loog)
     elapsed(@loog) do
-      Judges::Judges.new(dir, opts['lib'], @loog).each_with_index do |p, i|
-        visible << p.name
-        next unless include?(opts, p.name)
-        @loog.info("\n👉 Testing #{p.script} (##{i}) in #{p.dir.to_rel}...")
-        p.tests.each do |f|
+      judges.each_with_index do |judge, i|
+        visible << judge.name
+        next unless include?(opts, judge.name)
+        @loog.info("\n👉 Testing #{judge.script} (##{i}) in #{judge.dir.to_rel}...")
+        judge.tests.each do |f|
           tname = File.basename(f).gsub(/\.yml$/, '')
-          visible << "  #{p.name}/#{tname}"
-          next unless include?(opts, p.name, tname)
+          visible << "  #{judge.name}/#{tname}"
+          next unless include?(opts, judge.name, tname)
           yaml = YAML.load_file(f, permitted_classes: [Time])
           if yaml['skip']
             @loog.info("Skippped #{f.to_rel}")
@@ -69,25 +70,31 @@ class Judges::Test
           end
           @loog.info("🛠️ Testing #{f.to_rel}:")
           begin
-            test_one(opts, p, tname, yaml)
+            fb = Factbase.new
+            yaml['before']&.each do |n|
+              j = judges.get(n)
+              @loog.info("Running #{j.script} judge as a pre-condition...")
+              test_one(fb, opts, j, n, yaml, assert: false)
+            end
+            test_one(fb, opts, judge, tname, yaml)
             tests += 1
           rescue StandardError => e
             @loog.warn(Backtrace.new(e))
             errors << f
           end
         end
-        judges += 1
+        tested += 1
       end
-      throw :'👍 No judges tested' if judges.zero?
-      throw :"👍 All #{judges} judge(s) but no tests passed" if tests.zero?
-      throw :"👍 All #{judges} judge(s) and #{tests} tests passed" if errors.empty?
-      throw :"❌ #{judges} judge(s) tested, #{errors.size} of them failed"
+      throw :'👍 No judges tested' if tested.zero?
+      throw :"👍 All #{tested} judge(s) but no tests passed" if tests.zero?
+      throw :"👍 All #{tested} judge(s) and #{tests} tests passed" if errors.empty?
+      throw :"❌ #{tested} judge(s) tested, #{errors.size} of them failed"
     end
     unless errors.empty?
       raise "#{errors.size} tests failed" unless opts['quiet']
       @loog.debug('Not failing the build with tests failures, due to the --quiet option')
     end
-    return unless judges.zero? || tests.zero?
+    return unless tested.zero? || tests.zero?
     if opts['judge'].nil?
       raise 'There are seems to be no judges' unless opts['quiet']
       @loog.debug('Not failing the build with no judges tested, due to the --quiet option')
@@ -106,8 +113,7 @@ class Judges::Test
     judges.any? { |n| n.match?(%r{^#{name}(/#{tre})?$}) }
   end
 
-  def test_one(opts, judge, tname, yaml)
-    fb = Factbase.new
+  def test_one(fb, opts, judge, tname, yaml, assert: true)
     inputs = yaml['input']
     inputs&.each do |i|
       f = fb.insert
@@ -127,6 +133,7 @@ class Judges::Test
       fbx = fb
       fbx = Factbase::Looged.new(fb, @loog) if opts['log']
       judge.run(fbx, {}, {}, options)
+      next unless assert
       assert(judge, tname, fb, yaml) if r == runs || opts['assert_once'].is_a?(FalseClass)
     end
   end

data/lib/judges/judges.rb

@@ -34,8 +34,16 @@ class Judges::Judges
     @loog = loog
   end
 
+  # Get one judge by name.
+  # @return [Judge]
+  def get(name)
+    d = File.absolute_path(File.join(@dir, name))
+    raise "Judge #{name} doesn't exist in #{@dir}" unless File.exist?(d)
+    Judges::Judge.new(d, @lib, @loog)
+  end
+
   # Iterate over them all.
-  # @yield [Pack]
+  # @yield [Judge]
   def each
     Dir.glob(File.join(@dir, '**/*.rb')).each do |f|
       d = File.dirname(File.absolute_path(f))
@@ -44,7 +52,7 @@ class Judges::Judges
   end
 
   # Iterate over them all.
-  # @yield [(Pack, Integer)]
+  # @yield [(Judge, Integer)]
   def each_with_index
     idx = 0
     each do |p|

data/lib/judges.rb

@@ -25,5 +25,5 @@
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 module Judges
-  VERSION = '0.16.0'
+  VERSION = '0.18.0'
 end

data/test/commands/test_test.rb

@@ -88,6 +88,35 @@ class TestTest < Minitest::Test
     end
   end
 
+  def test_with_before
+    Dir.mktmpdir do |d|
+      home = File.join(d, 'judges')
+      FileUtils.mkdir_p(File.join(home, 'first'))
+      File.write(File.join(d, 'judges/first/the-first.rb'), '$fb.insert.foo = 42')
+      FileUtils.mkdir_p(File.join(home, 'second'))
+      File.write(File.join(d, 'judges/second/the-second.rb'), '$fb.insert.foo = 55')
+      File.write(
+        File.join(d, 'judges/first/something.yml'),
+        <<-YAML
+        input: []
+        expected:
+          - /fb[count(f)=1]
+        YAML
+      )
+      File.write(
+        File.join(d, 'judges/second/something.yml'),
+        <<-YAML
+        input: []
+        before:
+          - first
+        expected:
+          - /fb[count(f)=2]
+        YAML
+      )
+      Judges::Test.new(Loog::NULL).run({}, [home])
+    end
+  end
+
   def test_one_judge_negative
     Dir.mktmpdir do |d|
       File.write(File.join(d, 'foo.rb'), '')

data/test/test__helper.rb

@@ -29,3 +29,6 @@ require 'simplecov-cobertura'
 SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
 
 require 'minitest/autorun'
+
+require 'minitest/reporters'
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]

data/test/test_baza.rb

@@ -89,6 +89,21 @@ class TestBaza < Minitest::Test
     assert(req.include?("X-Zerocracy-Meta: Ym9vbSE= 0YXQtdC5IQ==\r\n"))
   end
 
+  def test_push_with_big_meta
+    req = with_http_server(200, 'yes') do |baza|
+      baza.push(
+        'simple',
+        'hello, world!',
+        [
+          'pages_url:https://zerocracy.github.io/zerocracy.html',
+          'others:https://zerocracy.github.io/zerocracy.html',
+          'duration:59595'
+        ]
+      )
+    end
+    assert(req.join.include?('X-Zerocracy-Meta: '))
+  end
+
   private
 
   def with_http_server(code, response)

data/test/test_judges.rb

@@ -30,7 +30,7 @@ require_relative '../lib/judges/judges'
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
-class TestPacks < Minitest::Test
+class TestJudges < Minitest::Test
   def test_basic
     Dir.mktmpdir do |d|
       File.write(File.join(d, 'foo.rb'), 'hey')
@@ -44,4 +44,14 @@ class TestPacks < Minitest::Test
       assert_equal(1, found)
     end
   end
+
+  def test_get_one
+    Dir.mktmpdir do |d|
+      f = File.join(d, 'boo/foo.rb')
+      FileUtils.mkdir_p(File.dirname(f))
+      File.write(f, 'hey')
+      j = Judges::Judges.new(d, nil, Loog::NULL).get('boo')
+      assert_equal('foo.rb', j.script)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2024-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace