Class: Sprinkle::Verify

Inherits:
Object show all
Includes:
Configurable
Defined in:
lib/sprinkle/verify.rb

Overview

Verification Methods

As documented in Sprinkle::Package, you may define a block on a package which verifies that a package was installed correctly. If this verification block fails, Sprinkle will stop the script gracefully, raising the error.

In addition to checking post install if it was successfully, verification blocks are also run before an install to see if a package is already installed. If this is the case, the package is skipped and Sprinkle continues with the next package. This behavior can be overriden by setting the -f flag on the sprinkle script or setting Sprinkle::OPTIONS to true if you're using sprinkle programmatically.

An Example

The following verifies that rails was installed correctly be checking to see if the 'rails' command is available on the command line:

package :rails do
  gem 'rails'

  verify do
    has_executable 'rails'
  end
end

Available Verifiers

There are a variety of available methods for use in the verification block. The standard methods are defined in the Sprinkle::Verifiers module, so see their corresponding documentation.

Custom Verifiers

If you feel that the built-in verifiers do not offer a certain aspect of verification which you need, you may create your own verifier! Simply wrap any method in a module which you want to use:

module MagicBeansVerifier
  def has_magic_beans(sauce)
    @commands << '[ -z "`echo $' + sauce + '`"]'
  end
end

The method can append as many commands as it wishes to the @commands array. These commands will be run on the remote server and MUST give an exit status of 0 if successful or other if unsuccessful.

To register your verifier, call the register method on Sprinkle::Verify:

Sprinle::Verify.register(MagicBeansVerifier)

And now you may use it like any other verifier:

package :magic_beans do
  gem 'magic_beans'

  verify { has_magic_beans('ranch') }
end

Instance Attribute Summary collapse

Attributes included from Configurable

#delivery

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Configurable

#assert_delivery, #defaults, #method_missing, #option?

Constructor Details

#initialize(package, description = '', &block) ⇒ Verify

:nodoc:



72
73
74
75
76
77
78
79
80
81
82
# File 'lib/sprinkle/verify.rb', line 72

def initialize(package, description = '', &block) #:nodoc:
  raise 'Verify requires a block.' unless block
  
  @package = package
  @description = description
  @commands = []
  @options ||= {}
  @options[:padding] = 4
  
  self.instance_eval(&block)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Sprinkle::Configurable

Instance Attribute Details

#commandsObject

:nodoc:



63
64
65
# File 'lib/sprinkle/verify.rb', line 63

def commands
  @commands
end

#descriptionObject

:nodoc:



63
64
65
# File 'lib/sprinkle/verify.rb', line 63

def description
  @description
end

#packageObject

:nodoc:



63
64
65
# File 'lib/sprinkle/verify.rb', line 63

def package
  @package
end

Class Method Details

.register(new_module) ⇒ Object

Register a verification module



67
68
69
# File 'lib/sprinkle/verify.rb', line 67

def register(new_module)
  class_eval { include new_module }
end

Instance Method Details

#process(roles, pre = false) ⇒ Object

:nodoc:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/sprinkle/verify.rb', line 84

def process(roles, pre = false) #:nodoc:
  assert_delivery
  
  description = @description.empty? ? @package.name : @description
  
  if logger.debug?
    logger.debug "#{@package.name}#{description} verification sequence: #{@commands.join('; ')} for roles: #{roles}\n"
  end
  
  unless Sprinkle::OPTIONS[:testing]
    logger.info "#{" " * @options[:padding]}--> Verifying #{description}..."
    
    unless @delivery.process(@package.name, @commands, roles, true)
      # Verification failed, halt sprinkling gracefully.
      raise Sprinkle::VerificationFailed.new(@package, description)
    end
  end
end