Capistrano task - checks parameters.yml keys against parameters.yml.dist

symfony_check_parameters.rb

namespace :symfony do

  desc "Check if shared parameters.yml is in sync with release parameters.yml.dist"
  task :check_parameters, :except => { :no_release => true } do
    puts "--> <symfony:check_parameters>"
    distParameters = YAML::load(capture("cat #{release_path}/app/config/parameters.yml.dist"))

    invoke_command("if [ -f '#{shared_path}/app/config/parameters.yml' ]; then echo -n 'true'; else echo -n 'false'; fi") do |ch, stream, out|
      if out != 'true'
        puts "    \e[31mUnable to find file #{shared_path}/app/config/\e[35mparameters.yml\e[0m"
        exit 1
      end
    end

    invoke_command("cat #{shared_path}/app/config/parameters.yml") do |ch, stream, out|
      parameters = YAML::load(out)
      if !parameters.kind_of?(Hash) || !parameters.key?('parameters') || !parameters['parameters'].kind_of?(Hash)
        puts "    \e[31mFile \e[1m#{shared_path}/app/config/parameters.yml\e[22m must contains a \e[1mparameters\e[22m key which itself should be an Hash\e[0m"
        puts "    \e[31mIs it a valid yaml file ?\e[0m"
        exit 1
      end

      distParameters['parameters'].each do |k,v|
        if parameters['parameters'][k].nil? && parameters['parameters'].fetch(k, false) == false
          puts "    \e[31mParameters \e[1m#{k}\e[22m is missing in the file \e[1m#{shared_path}/app/config/\parameters.yml\e[22m\e[0m"
          exit 1
        end
      end

    end
    puts "--> </symfony:check_parameters>"
  end

end

We need to check if all the keys defined in app/config/parameters.yml.dist (which is versioned) are defined in the shared/app/config/parameters.yml of every server.

This will tell us if we have forget to define some new keys in our production/staging server

Call this after shared_file:symlink

after "shared_file:symlink" do
    symfony.check_parameters
end