|
class Puppetclass < ActiveRecord::Base
|
|
include Authorization
|
|
has_and_belongs_to_many :environments
|
|
has_and_belongs_to_many :operatingsystems
|
|
has_and_belongs_to_many :hostgroups
|
|
has_many :host_classes, :dependent => :destroy
|
|
has_many :hosts, :through => :host_classes
|
|
|
|
has_many :lookup_keys, :inverse_of => :puppetclass
|
|
accepts_nested_attributes_for :lookup_keys, :reject_if => lambda { |a| a[:key].blank? }, :allow_destroy => true
|
|
|
|
validates_uniqueness_of :name
|
|
validates_presence_of :name
|
|
validates_associated :environments
|
|
validates_format_of :name, :with => /\A(\S+\s?)+\Z/, :message => "can't be blank or contain white spaces."
|
|
acts_as_audited
|
|
|
|
before_destroy Ensure_not_used_by.new(:hosts)
|
|
before_destroy Ensure_not_used_by.new(:hostgroups)
|
|
default_scope :order => 'LOWER(puppetclasses.name)'
|
|
|
|
scoped_search :on => :name, :complete_value => :true
|
|
scoped_search :in => :environments, :on => :name, :complete_value => :true, :rename => "environment"
|
|
scoped_search :in => :hostgroups, :on => :name, :complete_value => :true, :rename => "hostgroup"
|
|
scoped_search :in => :hosts, :on => :name, :complete_value => :true, :rename => "host", :ext_method => :search_by_host, :only_explicit => true
|
|
|
|
|
|
def to_param
|
|
name
|
|
end
|
|
|
|
# Scans a directory path for puppet classes
|
|
# +paths+ : String containing a colon separated module path
|
|
# returns
|
|
# Array of Strings containing puppet class names
|
|
def self.scanForClasses(paths)
|
|
klasses=Array.new
|
|
for path in paths.split(":")
|
|
Dir.glob("#{path}/*/manifests/**/*.pp").each do |manifest|
|
|
File.read(manifest).each_line do |line|
|
|
klass=line.match(/^class (\S+).*\{/)
|
|
klasses << klass[1] if klass
|
|
end
|
|
end
|
|
end
|
|
return klasses.uniq
|
|
end
|
|
|
|
# returns a hash containing modules and associated classes
|
|
def self.classes2hash classes
|
|
hash = {}
|
|
for klass in classes
|
|
if mod = klass.module_name
|
|
hash[mod] ||= []
|
|
hash[mod] << klass
|
|
else
|
|
next
|
|
end
|
|
end
|
|
return hash
|
|
end
|
|
|
|
# returns module name (excluding of the class name)
|
|
# if class separator does not exists (the "::" chars), then returns the whole class name
|
|
def module_name
|
|
return (i = name.index("::")) ? name[0..i-1] : name
|
|
end
|
|
|
|
# returns class name (excluding of the module name)
|
|
def klass
|
|
return name.gsub(module_name+"::","")
|
|
end
|
|
|
|
# add sort by class name
|
|
def <=>(other)
|
|
klass <=> other.klass
|
|
end
|
|
|
|
# Retrieve the manifest dir from the puppet configuration
|
|
# Returns: String
|
|
def self.manifestdir
|
|
ps = Puppet.settings.instance_variable_get(:@values)
|
|
ps[:main][:manifestdir] || ps[:puppetmasterd][:manifestdir] || ps[:puppetd][:manifestdir] || Puppet.settings[:manifestdir] || "/etc/puppet/manifests"
|
|
end
|
|
|
|
# Populates the rdoc tree with information about all the classes in your modules.
|
|
# Firstly, we prepare the modules tree
|
|
# Secondly we run puppetdoc over the modulespath and manifestdir for all environments
|
|
# The results are written into document_root/puppet/rdoc/<env>/<class>"
|
|
def self.rdoc root
|
|
debug, verbose = false, false
|
|
relocated = root != "/" # This is true if the prepare phase copied the modules tree
|
|
|
|
# Retrieve an optional http server's DocumentRoot from the settings.yaml file, and prepare it for writing
|
|
doc_root = Pathname.new(Setting[:document_root])
|
|
doc_root.mkpath
|
|
unless doc_root.directory? and doc_root.writable?
|
|
puts "Unable to write html to #{doc_root}"
|
|
return false
|
|
end
|
|
validator = '<div id="validator-badges">'
|
|
# For each environment we write a puppetdoc tree
|
|
for env, path in Environment.puppetEnvs
|
|
# We may need to rewrite the modulepaths because they have been changed by the prepare step
|
|
modulepaths = relocated ? path.split(":").map{|p| root + p}.join(":") : path
|
|
|
|
# Identify and prepare the output directory
|
|
out = doc_root + env.id2name
|
|
out.rmtree if out.directory?
|
|
|
|
replacement = "<div id=\\\"validator-badges\\\"><small><a href=\\\"/puppet/rdoc/#{env}/\\\">[Browser]</a></small>"
|
|
|
|
# Create the documentation
|
|
|
|
cmd = "puppetdoc --output #{out} --modulepath #{modulepaths} -m rdoc"
|
|
puts cmd if defined?(Rake)
|
|
sh cmd do |ok, res|
|
|
unless ok
|
|
logger.warn "Failed to process puppetdocs for #{out} while executing #{cmd}"
|
|
warn "Failed to process puppetdocs for #{out} while executing #{cmd}"
|
|
return false
|
|
end
|
|
|
|
# Add a link to the class browser
|
|
files = %x{find #{out} -exec grep -l 'validator-badges' {} \\; 2>/dev/null}.gsub(/\n/, " ")
|
|
if files.empty?
|
|
warn "No files to update with the browser link in #{out}. This is probably due to a previous error."
|
|
else
|
|
cmd = "ruby -p -i -e '$_.gsub!(/#{validator}/,\"#{replacement}\")' #{files}"
|
|
puts cmd if debug
|
|
sh cmd
|
|
end
|
|
# Relocate the paths for files and references if the manifests were relocated and sanitized
|
|
if relocated and (files = %x{find #{out} -exec grep -l '#{root}' {} \\;}.gsub(/\n/, " ")) != ""
|
|
puts "Rewriting..." if verbose
|
|
cmd = "ruby -p -i -e 'rex=%r{#{root}};$_.gsub!(rex,\"\")' #{files}"
|
|
puts cmd if debug
|
|
sh cmd
|
|
# Now relocate the files/* files to match the rewritten url
|
|
mv Dir.glob("#{out}/files/#{root}/*"), "#{out}/files", :verbose => verbose
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
# Optionally creates a copy of the current puppet modules and sanitizes it.
|
|
# If your 'live' manifests and modules can be parsed by puppetdoc
|
|
# then you do not need to do this step. (Unfortunately some sites have circular
|
|
# symlinks which have to be removed.)
|
|
# If the executable RAILS_ROOT/script/rdoc_prepare_script exists then it is run
|
|
# and passed a list of all directory paths in all environments.
|
|
# It should return the directory into which it has copied the cleaned modules"
|
|
def self.prepare_rdoc root
|
|
debug, verbose = false, false
|
|
|
|
prepare_script = Pathname.new(RAILS_ROOT) + "script/rdoc_prepare_script.rb"
|
|
if prepare_script.executable?
|
|
dirs = Environment.puppetEnvs.values.join(":").split(":").uniq.sort.join(" ")
|
|
puts "Running #{prepare_script} #{dirs}" if debug
|
|
location = %x{#{prepare_script} #{dirs}}
|
|
if $? == 0
|
|
root = location.chomp
|
|
puts "Relocated modules to #{root}" if verbose
|
|
end
|
|
else
|
|
puts "No executable #{prepare_script} found so using the uncopied module sources" if verbose
|
|
end
|
|
root
|
|
end
|
|
|
|
def as_json(options={})
|
|
super({:only => [:name, :id]}.merge(options))
|
|
end
|
|
|
|
def self.search_by_host(key, operator, value)
|
|
conditions = "hosts.name #{operator} '#{value_to_sql(operator, value)}'"
|
|
direct = Puppetclass.all(:conditions => conditions, :joins => :hosts, :select => 'DISTINCT puppetclasses.id').map(&:id)
|
|
indirect = Hostgroup.all(:conditions => conditions, :joins => [:hosts,:puppetclasses], :select => 'DISTINCT puppetclasses.id').map(&:id)
|
|
|
|
opts = ''
|
|
opts += "puppetclasses.id IN(#{direct.join(',')})" unless direct.blank?
|
|
opts += " OR " unless direct.blank? || indirect.blank?
|
|
opts += "hostgroups.id IN(#{indirect.join(',')})" unless indirect.blank?
|
|
opts = "puppetclasses.id = 'nil'" if direct.blank? && indirect.blank?
|
|
return {:conditions => opts, :include => :hostgroups}
|
|
end
|
|
|
|
def self.value_to_sql(operator, value)
|
|
return value if operator !~ /LIKE/i
|
|
return value.tr_s('%*', '%') if (value ~ /%|\*/)
|
|
|
|
return "%#{value}%"
|
|
end
|
|
|
|
end
|
