=begin
This rakefile is meant to trigger your local puppet-linter. To take
advantage of that powerful linter, you must have the puppet and
puppet-lint gems:

  $ sudo gem install puppet
  $ sudo gem install puppet-lint

Then run the linter using rake (a ruby build helper):

  $ rake lint

A list of top errors can be obtained using:
  rake lint |rev |cut -d\  -f4- | rev | sort | uniq -c | sort -rn

puppet-lint doc is at https://github.com/rodjek/puppet-lint


Another target is spec, which runs unit/integration tests. You will need some
more gems installed:

  $ sudo gem install puppet rspec puppetlabs_spec_helper

Then:

  $rake spec

=end

# Only care about color when using a tty
if Rake.application.tty_output?
	# Since we are going to use puppet internal stuff, we might as
	# well attempt to reuse their colorization utility. Note the utility class
	# is not available in older puppet versions.
	begin
		require'puppet/util/colors'
		include Puppet::Util::Colors
		$enable_color=true
	rescue LoadError
		puts "Cant load puppet/util/colors .. no color for you!"
	end
end

unless respond_to? :console_color
	# define our own colorization method that simply output the message
	def console_color( level, message )
		return message
	end
end

task :default => [:help]

desc 'Show the help'
task :help do
	puts "Puppet helper for operations/puppet.git

Welcome #{ENV['USER']} in WMF wonderful rake helper to play with puppet.

---[Command line options]----------------------------------------------
`rake -T` : list available tasks
`rake -P` : shows tasks dependencies

---[Available rake tasks]----------------------------------------------"

	# show our tasks list
	system "rake -T"

puts "-----------------------------------------------------------------------"
puts "
Examples:

Validate syntax for all puppet manifests:
  rake validate

Validate manifests/nfs.pp and manifests/apaches.pp
  rake \"validate[manifests/nfs.pp manifests/apaches.pp]\"

Run puppet style checker:
  rake lint
"

end

task :run_puppet_lint do
	require 'puppet-lint/tasks/puppet-lint'

	# Get possible checks values with: puppet-lint --help
	disabled_checks = [

		# We still use the 2.6 way of referencing variables.
		# 2.8 will requires $::globalname. Skip for now
		"variable_scope",

		# We really like nesting classes:
		"nested_classes_or_defines",

		# Lot of long lines (ssh keys for example)
		"80chars",

		# Anyone as a different indentation preference
		"hard_tabs",
		"2sp_soft_tabs",

		# Misc rules, some of them might use to be enabled later
		"autoloader_layout",  # unused in our setup?
		"inherits_across_namespaces",
		"double_quoted_strings",
		"unquoted_file_mode",
		"ensure_first_param",
		"unquoted_resource_title",
		"arrow_alignment",

		# "true" and "false" are everywhere.
		"quoted_booleans",

		# We dont have much documentation yet:
		"documentation",

		# Variables should be enclosed in {}
		"variables_not_enclosed",

		# We use dash in class and variables
		"names_containing_dash",
		"variable_contains_dash",

		# FIXME Following test cause a stacktrace ;-(
		"ensure_not_symlink_target",
	]

	# Disable checks referenced above:
	disabled_checks.each { |name|
		warn "Disabling rule '#{name}' from rakefile"
		PuppetLint.configuration.send( "disable_#{name}" )
	}
end

desc "Build documentation"
task :doc do
	doc_cmd = ["puppet doc",
		"--mode rdoc",
		"--all",  # build all references
		"--manifestdir manifests",
		"--modulepath modules",
	].join(' ')
	puts "Running #{doc_cmd}"
	system(doc_cmd)
end

desc "Lint puppet files"
task :lint => :run_puppet_lint

desc "Validate puppet syntax (default: manifests/site.pp)"
task :validate, [:files ] do |t, args|

	success = true

	if args.files
		puts console_color( :info, "Validating " + args.files.inspect )
		ok = puppet_parser_validate args.files
	else
		ok = puppet_parser_validate 'manifests/site.pp'
		success = success && ok

		Dir.glob("modules/*").each do |dir|
			puts console_color( :info, "Validating manifests in '#{dir}'" )
			ok = puppet_parser_validate Dir.glob( "#{dir}/**/*.pp" )
			success = success && ok
		end
	end

	if success
		puts "[OK] " + console_color( :info,  "files looks fine!" )
	else
		raise console_color( :alert, "puppet failed to validate files (exit: #{res.exitstatus}" )
	end
end

# Validate manifests passed as an array of filenames
def puppet_parser_validate(*manifests)
	manifests = manifests.join(' ')
	sh "puppet parser validate #{manifests}"
end

desc "Run spec tests found in modules"
task :spec do

	# Hold a list of modules not passing tests
	failed_modules = []

	# Invoke rake whenever a module has a Rakefile
	FileList["modules/*/Rakefile"].each do |rakefile|

		module_name = rakefile.match('modules/(.+)/')[1]

		if not run_module_spec(module_name)
			failed_modules << module_name  # recording
		end
		puts "\n"

	end

	puts '-' * 80
	puts 'Finished running tests for all modules'
	puts '-' * 80

	unless failed_modules.empty?
		puts "\nThe following modules are NOT passing tests:\n"
		puts '- ' + failed_modules * "\n- "
		puts
		raise "Some modules had failures, sorry."
	end
end

desc "Generates ctags"
task :tags do
	puts "Generating ctags file.."
	system('ctags -R .')
	puts "Done"
	puts
	puts "See https://github.com/majutsushi/tagbar/wiki#puppet for vim"
	puts "integration with the vim tagbar plugin."
end

# Wrapper to run rspec in a module
def run_module_spec(module_name)

	puts '-' * 80
	puts "Running rspec tests for module #{module_name}"
	puts '-' * 80

	Dir.chdir("modules/#{module_name}") do
		# The following is a customized replacement for 'spec_prep'.
		# We do not want to use upstream modules which are usually installed
		# using `rake spec_prep`, instead we symlink to our own modules.
		directory_name = "spec/fixtures"
		Dir.mkdir(directory_name) unless File.exists?(directory_name)
		link_name = "spec/fixtures/modules"
		system("ln -s ../../../../modules #{link_name}") unless File.exists?(link_name)

		# We also need to create an empty site.pp file in the manifests dir.
		directory_name = "spec/fixtures/manifests"
		Dir.mkdir(directory_name) unless File.exists?(directory_name)
		site_file_name = "spec/fixtures/manifests/site.pp"
		system("touch #{site_file_name}") unless File.exists?(site_file_name)

		puts "Invoking tests on module #{module_name}"
		system('rake spec_standalone')
	end
end


=begin lint
amass profit
donate!
=end