capistrano-postgresql 4.7.0 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc75baf6e5ae3f4072935434e99527a40d17ab23997b006bc5056ccaadcfaa10
-  data.tar.gz: f310c43d82487fde14eedbe428e10278efb2429dc0625c99f5f04e77eb8ee70d
+  metadata.gz: 99782e17f1cfadc9a7bef273471fc8c0d9327badfb8cc1aaabd0e5d1d71b1e16
+  data.tar.gz: b243ef51314de1d4924727f9a693e086893f05180d736c0a2789d125f6d16a9f
 SHA512:
-  metadata.gz: 4134b4d0711f378706881eaf7949162a7edaeeb365a1c8f6c61855f1753e6876d0ca8a5d6932d606289c1e97688834ac1707e1b23a8d1fb7dfce45cbdd51cf99
-  data.tar.gz: 39847b45d9d15eb0371e2b06af11c1e944db256ca758fecb026b1e30bd49ad4b9ec20207373a40ac56459c2478510583b6b01dd2984c71d6ffebc3cb403e9149
+  metadata.gz: 158247310972ce9e07dd08a3cf1d6f9d169149d110121bf62b56a0af8be85cd3860c9e7b114be14dd68460631eaa09bd406910a5a41bac39671908b5c04d89c2
+  data.tar.gz: 6e9b98484fae0fd73af2cd2a97c03a1318e0ece3422d33b483633d3e6f1492c77e6bb2cbf4315db97c4793ae83f5b2c532100f2dec8c60db6da93657cfc22775

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ### master
 
+## v4.8.0, 2017-12-28
+- issues/47: Added new pg_template helper code to handle maintaining the randomly generated password, :pg_ask_for_password, and user set pg_password
+- Added the rest of the supported options for the database.yml
+- pull/46 (Thanks to Tom Prats / tomprats): Fix for pg_host when localhost is used
+- Removed system_user as it's not necessary if server values are defined properly in config/deploy/* files
+- General cleanup of notes
+
+## v4.7.0, 2017-12-19
+- Fixed create database and user tasks to use (:pg_system_db) and psql_on_db
+
 ## v4.6.1, 2017-12-15
 - Removing require 'pry' (silly mistake)
 

data/README.md

@@ -30,7 +30,7 @@ Put the following in your application's `Gemfile`:
 
     group :development do
       gem 'capistrano', '~> 3.2.0'
-      gem 'capistrano-postgresql', '~> 4.2.0'
+      gem 'capistrano-postgresql', '~> 4.8.0'
     end
 
 Then:
@@ -50,9 +50,6 @@ Or just install
 [capistrano-safe-deploy-to](https://github.com/capistrano-plugins/capistrano-safe-deploy-to)
 plugin and don't think about it.
 
-Within your app/config/deploy/#{environment}.rb files, make sure to specify a user with ssh access to all deployment servers:
-
-    set :system_user, 'ssh_user' # defaults to root
     
 Optionally, you can run psql commands WITHOUT sudo if needed. Set the following:
 

data/lib/capistrano/postgresql/helper_methods.rb

@@ -4,15 +4,47 @@ module Capistrano
   module Postgresql
     module HelperMethods
 
-      def pg_template(template_name)
-        config_file = "#{fetch(:pg_templates_path)}/#{template_name}"
-        # If there's no customized file in your rails app template directory,
-        # proceed with the default.
-        unless File.exists?(config_file)
-          default_config_path = "../../generators/capistrano/postgresql/templates/#{template_name}"
-          config_file = File.join(File.dirname(__FILE__), default_config_path)
+      def generate_database_yml_io(password=fetch(:pg_password))
+        StringIO.open do |s|
+          s.puts "#{fetch(:pg_env)}:"
+          {
+              adapter: 'postgresql',
+              encoding: fetch(:pg_encoding),
+              database: fetch(:pg_database),
+              pool: fetch(:pg_pool),
+              username: fetch(:pg_username),
+              password: password,
+              host: fetch(:pg_host),
+              socket: fetch(:pg_socket),
+              port: fetch(:pg_port),
+              timeout: fetch(:pg_timeout)
+          }.each { |option_name,option_value| s.puts "  #{option_name}: #{option_value}" } # Yml does not support tabs. There are two spaces leading the config option line
+          s.string
         end
-        StringIO.new ERB.new(File.read(config_file)).result(binding)
+      end
+
+      def pg_template(update=false,archetype_file=nil)
+        config_file = "#{fetch(:pg_templates_path)}/postgresql.yml.erb"
+        if update
+          raise('Updates need the original file to update from.') if archetype_file.nil?
+          raise('Cannot update a custom postgresql.yml.erb file.') if File.exists?(config_file) # Skip custom postgresql.yml.erb if we're updating. It's not supported
+          # Update yml file from settings
+          if fetch(:pg_password).nil? && fetch(:pg_ask_for_password) == false # User isn't generating a random password or wanting to set it manually from prompt
+            current_password = archetype_file.split("\n").grep(/password/)[0].split('password:')[1].strip
+            generate_database_yml_io(current_password)
+          else
+            generate_database_yml_io
+          end
+        else
+          if File.exists?(config_file) # If there is a customized file in your rails app template directory, use it and convert any ERB
+            StringIO.new ERB.new(File.read(config_file)).result(binding)
+          else # Else there's no customized file in your rails app template directory, proceed with the default.
+            # Build yml file from settings
+            ## We build the file line by line to avoid overwriting existing files
+            generate_database_yml_io
+          end
+        end
+
       end
 
       # location of database.yml file on clients
@@ -21,8 +53,7 @@ module Capistrano
         shared_path.join('config/database.yml')
       end
 
-      # location of archetypical database.yml file created on primary db role when user and
-      # database are first created
+      # location of archetypical database.yml file created on primary db role when user and database are first created
       def archetype_database_yml_file
         raise(":deploy_to in your app/config/deploy/\#{environment}.rb file cannot contain ~") if shared_path.to_s.include?('~') # issues/27
         deploy_path.join('db/database.yml')

data/lib/capistrano/postgresql/password_helpers.rb

@@ -8,9 +8,7 @@ module Capistrano
         SecureRandom.hex(10)
       end
 
-      # This method is invoked only if `:pg_password` is not already
-      # set in `config/#{:stage}/deploy.rb`. Directly setting
-      # `:pg_password` has precedence.
+      # This method is invoked only if :pg_password is not already set in config/#{:stage}/deploy.rb. Directly setting :pg_password has precedence.
       def ask_for_or_generate_password
         if fetch(:pg_ask_for_password)
           ask :pg_password, "Postgresql database password for the app: "

data/lib/capistrano/postgresql/psql_helpers.rb

@@ -17,7 +17,7 @@ module Capistrano
       end
 
       def db_user_exists?
-        psql_on_db fetch(:pg_system_db),'-tAc', %Q{"SELECT 1 FROM pg_roles WHERE rolname='#{fetch(:pg_user)}';" | grep -q 1}
+        psql_on_db fetch(:pg_system_db),'-tAc', %Q{"SELECT 1 FROM pg_roles WHERE rolname='#{fetch(:pg_username)}';" | grep -q 1}
       end
 
       def database_exists?

data/lib/capistrano/postgresql/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Postgresql
-    VERSION = '4.7.0'
+    VERSION = '4.8.1'
   end
 end

data/lib/capistrano/tasks/postgresql.rake

@@ -8,29 +8,27 @@ include Capistrano::Postgresql::PsqlHelpers
 
 namespace :load do
   task :defaults do
-    set :system_user, 'root' # Used for SCP commands to deploy files to remote servers
+    # Options necessary for database.yml creation (pg_template|helper_methods.rb)
+    set :pg_env, -> { fetch(:rails_env) || fetch(:stage) }
+    set :pg_encoding, 'unicode'
     set :pg_database, -> { "#{fetch(:application)}_#{fetch(:stage)}" }
-    set :pg_user, -> { fetch(:pg_database) }
-    set :pg_ask_for_password, false
-    set :pg_password, -> { ask_for_or_generate_password }
-    set :pg_system_user, 'postgres'
+    set :pg_pool, 5
+    set :pg_username, -> { fetch(:pg_database) }
+    set :pg_password, nil
+    set :pg_socket, ''
+    set :pg_host, -> do # for multiple release nodes automatically use server hostname (IP?) in the database.yml
+      release_roles(:all).count == 1 && release_roles(:all).first == primary(:db) ? 'localhost' : primary(:db).hostname
+    end
+    set :pg_port, 5432
+    set :pg_timeout, 5000 # 5 seconds (rails default)
+    # General settings
     set :pg_without_sudo, false # issues/22 | Contributed by snake66
+    set :pg_system_user, 'postgres'
+    set :pg_ask_for_password, false
     set :pg_system_db, 'postgres'
     set :pg_use_hstore, false
     set :pg_extensions, []
-    # template only settings
     set :pg_templates_path, 'config/deploy/templates'
-    set :pg_env, -> { fetch(:rails_env) || fetch(:stage) }
-    set :pg_pool, 5
-    set :pg_encoding, 'unicode'
-    # for multiple release nodes automatically use server hostname (IP?) in the database.yml
-    set :pg_host, -> do
-      if release_roles(:all).count == 1 && release_roles(:all).first == primary(:db)
-        'localhost'
-      else
-        primary(:db).hostname
-      end
-    end
   end
 end
 
@@ -60,21 +58,17 @@ namespace :postgresql do
 
     on roles :db do
       psql '-c', %Q{"DROP database \\"#{fetch(:pg_database)}\\";"}
-      psql '-c', %Q{"DROP user \\"#{fetch(:pg_user)}\\";"}
+      psql '-c', %Q{"DROP user \\"#{fetch(:pg_username)}\\";"}
     end
   end
 
-  task :remove_yml_files do
-    on release_roles :all do
+  task :remove_app_database_yml_files do
+    # We should never delete archetype files. The generate_database_yml_archetype task will handle updates
+    on release_roles :app do
       if test "[ -e #{database_yml_file} ]"
         execute :rm, database_yml_file
       end
     end
-    on primary :db do
-      if test "[ -e #{archetype_database_yml_file} ]"
-        execute :rm, archetype_database_yml_file
-      end
-    end
   end
 
   desc 'Remove pg_extension from postgresql db'
@@ -101,7 +95,7 @@ namespace :postgresql do
     next unless Array( fetch(:pg_extensions) ).any?
     on roles :db do
       Array( fetch(:pg_extensions) ).each do |ext|
-        next if [nil, false, ""].include?(ext)
+        next if [nil, false, ''].include?(ext)
         if psql_on_app_db '-c', %Q{"CREATE EXTENSION IF NOT EXISTS #{ext};"}
           puts "- Added extension #{ext} to #{fetch(:pg_database)}"
         else
@@ -116,7 +110,7 @@ namespace :postgresql do
   task :create_database do
     on roles :db do
       next if database_exists?
-      unless psql_on_db fetch(:pg_system_db), '-c', %Q{"CREATE DATABASE \\"#{fetch(:pg_database)}\\" OWNER \\"#{fetch(:pg_user)}\\";"}
+      unless psql_on_db fetch(:pg_system_db), '-c', %Q{"CREATE DATABASE \\"#{fetch(:pg_database)}\\" OWNER \\"#{fetch(:pg_username)}\\";"}
         error 'postgresql: creating database failed!'
         exit 1
       end
@@ -128,26 +122,28 @@ namespace :postgresql do
     on roles :db do
       next if db_user_exists?
       # If you use CREATE USER instead of CREATE ROLE the LOGIN right is granted automatically; otherwise you must specify it in the WITH clause of the CREATE statement.
-      unless psql_on_db fetch(:pg_system_db), '-c', %Q{"CREATE USER \\"#{fetch(:pg_user)}\\" PASSWORD '#{fetch(:pg_password)}';"}
+      unless psql_on_db fetch(:pg_system_db), '-c', %Q{"CREATE USER \\"#{fetch(:pg_username)}\\" PASSWORD '#{fetch(:pg_password)}';"}
         error 'postgresql: creating database user failed!'
         exit 1
       end
     end
   end
 
-  # This task creates the archetype database.yml file on the primary db server. This is done once when a
-  # new DB user is created.
+  # This task creates the archetype database.yml file on the primary db server. This is done once when a new DB user is created.
   desc 'Generate database.yml archetype'
   task :generate_database_yml_archetype do
     on primary :db do
-      next if test "[ -e #{archetype_database_yml_file} ]"
-      execute :mkdir, '-pv', File.dirname(archetype_database_yml_file)
-      Net::SCP.upload!(fetch(:pg_host), fetch(:system_user), pg_template('postgresql.yml.erb'), archetype_database_yml_file)
+      if test "[ -e #{archetype_database_yml_file} ]" # Archetype already exists. Just update values that changed. Make sure we don't overwrite it to protect generated passwords.
+        Net::SCP.upload!(self.host.hostname, self.host.user,StringIO.new(pg_template(true, download!(archetype_database_yml_file))),archetype_database_yml_file)
+      else
+        ask_for_or_generate_password if fetch(:pg_password).nil? || fetch(:pg_ask_for_password) == true # Avoid setting a random password or one from user prompt
+        execute :mkdir, '-pv', File.dirname(archetype_database_yml_file)
+        Net::SCP.upload!(self.host.hostname,self.host.user,StringIO.new(pg_template),archetype_database_yml_file)
+      end
     end
   end
 
-  # This task copies the archetype database file on the primary db server to all clients. This is done on
-  # every setup, to ensure new servers get a copy as well.
+  # This task copies the archetype database file on the primary db server to all clients. This is done on every setup, to ensure new servers get a copy as well.
   desc 'Copy archetype database.yml from primary db server to clients'
   task :generate_database_yml do
     database_yml_contents = nil
@@ -157,7 +153,7 @@ namespace :postgresql do
 
     on release_roles :all do
       execute :mkdir, '-pv', File.dirname(database_yml_file)
-      Net::SCP.upload!(self.host.hostname, fetch(:system_user), StringIO.new(database_yml_contents), database_yml_file)
+      Net::SCP.upload!(self.host.hostname, self.host.user, StringIO.new(database_yml_contents), database_yml_file)
     end
   end
 
@@ -170,7 +166,7 @@ namespace :postgresql do
   desc 'Postgresql setup tasks'
   task :setup do
     puts "* ============================= * \n All psql commands will be run #{fetch(:pg_without_sudo) ? 'without sudo' : 'with sudo'}\n You can modify this in your deploy/{env}.rb by setting the pg_without_sudo boolean \n* ============================= *"
-    invoke 'postgresql:remove_yml_files' # Delete old yml files. Allows you to avoid having to manually delete the files on your web/app servers to get a new pool size for example.
+    invoke 'postgresql:remove_app_database_yml_files' # Deletes old yml files from all app role servers. Allows you to avoid having to manually delete the files on your app servers to get a new pool size for example. Don't touch the archetype file to avoid deleting generated passwords
     invoke 'postgresql:create_db_user'
     invoke 'postgresql:create_database'
     invoke 'postgresql:add_hstore'

data/lib/generators/capistrano/postgresql/templates/postgresql.yml.erb

@@ -3,6 +3,9 @@
   encoding: <%= fetch :pg_encoding %>
   database: <%= fetch :pg_database %>
   pool: <%= fetch :pg_pool %>
-  username: <%= fetch :pg_user %>
+  username: <%= fetch :pg_username %>
   password: '<%= fetch :pg_password %>'
   host: <%= fetch :pg_host %>
+  socket: <%= fetch :pg_socket %>
+  port: <%= fetch :pg_port %>
+  timeout: <%= fetch :pg_timeout %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-postgresql
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.1
 platform: ruby
 authors:
 - Bruno Sutic
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Creates application database user and `database.yml` on the server. No SSH