Sha256: 29f5685520605fe8867d6a926c791bd34161841e56a253160e5e581662ebdfb6

Contents?: true

Size: 880 Bytes

Versions: 14

Compression:

Stored size: 880 Bytes

Contents

# frozen_string_literal: true

# Repeat the block until it returns a truthy value. Returns the value.
Puppet::Functions.create_function(:'ctrl::do_until') do
  # @param options Additional options: 'until'
  # @example Run a task until it succeeds
  #   ctrl::do_until() || {
  #     run_task('test', $target, _catch_errors => true).ok()
  #   }
  #
  # @example Run a task until it succeeds or fails 10 times
  #   ctrl::do_until('limit' => 10) || {
  #     run_task('test', $target, _catch_errors => true).ok()
  #   }
  #
  dispatch :do_until do
    optional_param 'Hash[String[1], Any]', :options
    block_param
  end

  def do_until(options = { 'limit' => 0 })
    Puppet.lookup(:bolt_executor) {}&.report_function_call(self.class.name)
    limit = options['limit']
    i = 0
    until (x = yield)
      i += 1
      break if limit != 0 && i >= limit
    end
    x
  end
end

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
bolt-1.49.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.48.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.47.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.45.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.44.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.43.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.42.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.41.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.40.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.39.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.38.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.37.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.36.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
bolt-1.35.0 bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb