capistrano-postgresql 4.2.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6c6b91718c3a2c3c0c8733300c1c7a19585e5c27
-  data.tar.gz: 6f4f36cde7ed8b8c4868b1ad858028cf44d4400f
+SHA256:
+  metadata.gz: cc75baf6e5ae3f4072935434e99527a40d17ab23997b006bc5056ccaadcfaa10
+  data.tar.gz: f310c43d82487fde14eedbe428e10278efb2429dc0625c99f5f04e77eb8ee70d
 SHA512:
-  metadata.gz: 5aeb539216266abc36d13bd9910bb0333cc67d090ba1c28294d5c3675d356419c15355ecf02c57239415e15556d0a82a9742a2a523365134011053a34ca5352f
-  data.tar.gz: d1ade56e40f24515535ac8627adff68cdfe4c4b2b4085c2b3bc1dfea81a4081877c8e58623cae17a69ba3f91cb61f53f6a72834ad18c626406c1c0cea0cdbd97
+  metadata.gz: 4134b4d0711f378706881eaf7949162a7edaeeb365a1c8f6c61855f1753e6876d0ca8a5d6932d606289c1e97688834ac1707e1b23a8d1fb7dfce45cbdd51cf99
+  data.tar.gz: 39847b45d9d15eb0371e2b06af11c1e944db256ca758fecb026b1e30bd49ad4b9ec20207373a40ac56459c2478510583b6b01dd2984c71d6ffebc3cb403e9149

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+Gemfile.lock
+*.gem

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ### master
 
+## v4.6.1, 2017-12-15
+- Removing require 'pry' (silly mistake)
+
+## v4.6.0, 2017-12-10
+- :pg_without_sudo added (thanks to snake66) so you can run remote psql commands on environments without sudo available.
+- Fixed exists? methods, removing the need for arguments
+- Printing sudo status to capistrano STDOUT
+
+## v4.4.1, 2017-10-26
+- Switched back from CREATE ROLE to CREATE USER (so LOGIN rights are granted automatically)
+
+## v4.4.0, 2017-10-26
+- :remove_yml_files task added to clean up old files on remote server
+
+## v4.3.1, 2017-10-21
+- Fixed quoting on CREATE USER so we can include integers in usernames & Quoted other values like CREATE DATABASE so they can include integers too
+- Changed to createuser convention "CREATE ROLE" instead of USER (v4.4.1 reversed this)
+
+## v4.3.0, 2017-10-21
+- issues/27: raise on :deploy_to with ~ in it
+- Net::SCP.upload! to replace old upload! for using :system_user
+- issues/31 : psql -> psql_simple so user can be created regardless of database existence
+- General cleanup
+
 ### v4.2.1, 2015-04-22
 - change `on roles(:db, primary: true)` to the correct `on primary :db`
 

data/README.md

@@ -45,11 +45,19 @@ the following in `Capfile` file:
     require 'capistrano/postgresql'
 
 Make sure the `deploy_to` path exists and has the right privileges on the
-server (i.e. `/var/www/myapp`).<br/>
+server (i.e. `/var/www/myapp`). Warning: The ~ symbol (i.e. `~/myapp`) is not supported.<br/>
 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:
+
+    set :pg_without_sudo, true # defaults to false
+
 To setup the server(s), run:
 
     $ bundle exec cap production setup

data/capistrano-postgresql.gemspec

@@ -4,10 +4,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'capistrano/postgresql/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "capistrano-postgresql"
+  gem.name          = 'capistrano-postgresql'
   gem.version       = Capistrano::Postgresql::VERSION
-  gem.authors       = ["Bruno Sutic"]
-  gem.email         = ["bruno.sutic@gmail.com"]
+  gem.authors       = ['Bruno Sutic', 'Ruben Stranders']
+  gem.email         = ['bruno.sutic@gmail.com', 'r.stranders@gmail.com']
   gem.description   = <<-EOF.gsub(/^\s+/, '')
     Capistrano tasks for PostgreSQL configuration and management for Rails
     apps. Manages `database.yml` template on the server.
@@ -16,14 +16,13 @@ Gem::Specification.new do |gem|
     https://github.com/bruno-/capistrano2-postgresql
   EOF
   gem.summary       = %q{Creates application database user and `database.yml` on the server. No SSH login required!}
-  gem.homepage      = "https://github.com/capistrano-plugins/capistrano-postgresql"
+  gem.homepage      = 'https://github.com/capistrano-plugins/capistrano-postgresql'
 
-  gem.license       = "MIT"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
   gem.add_dependency 'capistrano', '>= 3.0'
-
-  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'rake'
 end

data/lib/capistrano/postgresql/helper_methods.rb

@@ -17,13 +17,15 @@ module Capistrano
 
       # location of database.yml file on clients
       def database_yml_file
+        raise(":deploy_to in your app/config/deploy/\#{environment}.rb file cannot contain ~") if shared_path.to_s.include?('~') # issues/27
         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
       def archetype_database_yml_file
-        deploy_path.join("db/database.yml")
+        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')
       end
     end
   end

data/lib/capistrano/postgresql/psql_helpers.rb

@@ -2,9 +2,13 @@ module Capistrano
   module Postgresql
     module PsqlHelpers
 
-      # returns true or false depending on the remote command exit status
       def psql(*args)
-        psql_on_db(fetch(:pg_system_db), *args)
+        # Reminder: -u #{fetch(:pg_system_user)} seen below differs slightly from -U, an option on the psql command: https://www.postgresql.org/docs/9.6/static/app-psql.html
+        args.unshift("-U #{fetch(:pg_system_user)}") if fetch(:pg_without_sudo) # Add the :pg_system_user to psql command since we aren't using sudo anymore
+        # test :sudo, "-u #{fetch(:pg_system_user)} psql", *args
+        cmd = [ :psql, *args ]
+        cmd = [ :sudo, "-u #{fetch(:pg_system_user)}", *cmd ] unless fetch(:pg_without_sudo)
+        test *cmd.flatten
       end
 
       # Runs psql on the application database
@@ -12,18 +16,24 @@ module Capistrano
         psql_on_db(fetch(:pg_database), *args)
       end
 
-      def db_user_exists?(name)
-        psql '-tAc', %Q{"SELECT 1 FROM pg_roles WHERE rolname='#{name}';" | grep -q 1}
+      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}
       end
 
-      def database_exists?(db_name)
-        psql '-tAc', %Q{"SELECT 1 FROM pg_database WHERE datname='#{db_name}';" | grep -q 1}
+      def database_exists?
+        psql_on_db fetch(:pg_system_db), '-tAc', %Q{"SELECT 1 FROM pg_database WHERE datname='#{fetch(:pg_database)}';" | grep -q 1}
       end
 
       private
-      def psql_on_db(db_name, *args)
-        test :sudo, "-u #{fetch(:pg_system_user)} psql -d #{db_name}", *args
-      end
+
+        def psql_on_db(db_name, *args)
+          args.unshift("-U #{fetch(:pg_system_user)}") if fetch(:pg_without_sudo) # Add the :pg_system_user to psql command since we aren't using sudo anymore
+          cmd = [ :psql, "-d #{db_name}", *args ]
+          cmd = [ :sudo, "-u #{fetch(:pg_system_user)}", *cmd ] unless fetch(:pg_without_sudo)
+          test *cmd.flatten
+          #test :sudo, "-u #{fetch(:pg_system_user)} psql -d #{db_name}", *args
+        end
+
     end
   end
 end

data/lib/capistrano/postgresql/version.rb

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

data/lib/capistrano/tasks/postgresql.rake

@@ -8,11 +8,13 @@ include Capistrano::Postgresql::PsqlHelpers
 
 namespace :load do
   task :defaults do
+    set :system_user, 'root' # Used for SCP commands to deploy files to remote servers
     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_without_sudo, false # issues/22 | Contributed by snake66
     set :pg_system_db, 'postgres'
     set :pg_use_hstore, false
     set :pg_extensions, []
@@ -29,7 +31,6 @@ namespace :load do
         primary(:db).hostname
       end
     end
-
   end
 end
 
@@ -58,31 +59,25 @@ namespace :postgresql do
     end
 
     on roles :db do
-      psql '-c', %Q{"DROP database #{fetch(:pg_database)};"}
-      psql '-c', %Q{"DROP user #{fetch(:pg_user)};"}
+      psql '-c', %Q{"DROP database \\"#{fetch(:pg_database)}\\";"}
+      psql '-c', %Q{"DROP user \\"#{fetch(:pg_user)}\\";"}
     end
   end
 
-  desc "Add the hstore extension to postgresql"
-  task :add_hstore do
-    next unless fetch(:pg_use_hstore)
-    on roles :db do
-      psql_on_app_db '-c', %Q{"CREATE EXTENSION IF NOT EXISTS hstore;"}
+  task :remove_yml_files do
+    on release_roles :all do
+      if test "[ -e #{database_yml_file} ]"
+        execute :rm, database_yml_file
+      end
     end
-  end
-
-  desc "Add pg_extension to postgresql db"
-  task :add_extensions do
-    next unless Array( fetch(:pg_extensions) ).any?
-    on roles :db do
-      # add extensions if extension is present
-      Array( fetch(:pg_extensions) ).each do |ext|
-        psql_on_app_db '-c', %Q{"CREATE EXTENSION IF NOT EXISTS #{ext};"} unless [nil, false, ""].include?(ext)
+    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"
+  desc 'Remove pg_extension from postgresql db'
   task :remove_extensions do
     next unless Array( fetch(:pg_extensions) ).any?
     on roles :db do
@@ -93,13 +88,26 @@ namespace :postgresql do
     end
   end
 
-  desc 'Create DB user'
-  task :create_db_user do
+  desc 'Add the hstore extension to postgresql'
+  task :add_hstore do
+    next unless fetch(:pg_use_hstore)
     on roles :db do
-      next if db_user_exists? fetch(:pg_user)
-      unless psql '-c', %Q{"CREATE user #{fetch(:pg_user)} WITH password '#{fetch(:pg_password)}';"}
-        error 'postgresql: creating database user failed!'
-        exit 1
+      psql_on_app_db '-c', %Q{"CREATE EXTENSION IF NOT EXISTS hstore;"}
+    end
+  end
+
+  desc 'Add pg_extension to postgresql db'
+  task :add_extensions 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)
+        if psql_on_app_db '-c', %Q{"CREATE EXTENSION IF NOT EXISTS #{ext};"}
+          puts "- Added extension #{ext} to #{fetch(:pg_database)}"
+        else
+          error "postgresql: adding extension #{ext} failed!"
+          exit 1
+        end
       end
     end
   end
@@ -107,14 +115,26 @@ namespace :postgresql do
   desc 'Create database'
   task :create_database do
     on roles :db do
-      next if database_exists? fetch(:pg_database)
-      unless psql '-c', %Q{"CREATE database #{fetch(:pg_database)} owner #{fetch(:pg_user)};"}
+      next if database_exists?
+      unless psql_on_db fetch(:pg_system_db), '-c', %Q{"CREATE DATABASE \\"#{fetch(:pg_database)}\\" OWNER \\"#{fetch(:pg_user)}\\";"}
         error 'postgresql: creating database failed!'
         exit 1
       end
     end
   end
 
+  desc 'Create DB user'
+  task :create_db_user 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)}';"}
+        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.
   desc 'Generate database.yml archetype'
@@ -122,7 +142,7 @@ namespace :postgresql do
     on primary :db do
       next if test "[ -e #{archetype_database_yml_file} ]"
       execute :mkdir, '-pv', File.dirname(archetype_database_yml_file)
-      upload! pg_template('postgresql.yml.erb'), archetype_database_yml_file
+      Net::SCP.upload!(fetch(:pg_host), fetch(:system_user), pg_template('postgresql.yml.erb'), archetype_database_yml_file)
     end
   end
 
@@ -136,8 +156,8 @@ namespace :postgresql do
     end
 
     on release_roles :all do
-      execute :mkdir, '-pv', shared_path.join('config')
-      upload! StringIO.new(database_yml_contents), database_yml_file
+      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)
     end
   end
 
@@ -149,12 +169,14 @@ namespace :postgresql do
 
   desc 'Postgresql setup tasks'
   task :setup do
-    invoke "postgresql:create_db_user"
-    invoke "postgresql:create_database"
+    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:create_db_user'
+    invoke 'postgresql:create_database'
     invoke 'postgresql:add_hstore'
     invoke 'postgresql:add_extensions'
-    invoke "postgresql:generate_database_yml_archetype"
-    invoke "postgresql:generate_database_yml"
+    invoke 'postgresql:generate_database_yml_archetype'
+    invoke 'postgresql:generate_database_yml'
   end
 end
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-postgresql
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Bruno Sutic
+- Ruben Stranders
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -45,10 +46,12 @@ description: |
   https://github.com/bruno-/capistrano2-postgresql
 email:
 - bruno.sutic@gmail.com
+- r.stranders@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -85,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Creates application database user and `database.yml` on the server. No SSH