matross 0.5.5 → 0.6.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjA3ODRjMThlMzYzOTgxZGE5OTg0NTQ4NDNjZjcyODQxYjNlMmU1Nw==
-  data.tar.gz: !binary |-
-    OWUzYWRkYmFjOGU2ZmE3OGQwMTVmNjUwY2MwZDcyMDU5OGFjZDkzMQ==
+SHA1:
+  metadata.gz: 16ea939d8285bf5288eea7bcf72c0ed739114c39
+  data.tar.gz: 5e6cbf82b320fbad26557833a5cb6747969324a8
 SHA512:
-  metadata.gz: !binary |-
-    ZDJiNjU2M2U1ZTg5ZmQwNDUwODgxZjU1ZDNhY2VjNmQ4YjU2Y2U2MmRiYjgx
-    M2ZmMzY0ODNjYTVlOGU5ODY4MWUxNTlkODQ5OTEwNWFlN2JkNWY0ZmQ5N2E3
-    ODFmN2I3ZWE3MDcyNzI3ZTg5YzVhYWIxNTU5NmVlYTIwOTJmOTE=
-  data.tar.gz: !binary |-
-    MzA1MjBkNDdiMDE3ODExNDA5YzY3ZDU0ZWVjNjhhOTVjNDExZjg0ZGVlN2Yx
-    MjRkNDM5YjA0M2I5YTVkMGYxNTJkODhhOTM4M2Y1YmU4ZWVlNDM3ZWRkN2Zj
-    N2Q4MmM2NDU1YjJhNDQyMGQ1NzQ4OTI0YWRlNjFmYThlNWRlYmM=
+  metadata.gz: 2a27e55db950c079071df47755b76b7ab22297843ee802ff2a12926424f5128d5980aed5a63227725b7e7efa0631ce7fd3711e46d90eeadd6e79844d41f1c925
+  data.tar.gz: 5ccfb6730d71d8577eafa1c70e916820e3e20ec11745cfe47450d11d17fa147ccb212ca56189c556f99d444daa5ba04888cfd26248ddcbadcd5ea3b1f07ff47d

data/README.md

@@ -112,7 +112,7 @@ Procfile task: `web: bundle exec unicorn -c <%= unicorn_config %> -E <%= rails_e
 
 ### Nginx
 
-This recipes creates and configures the virtual_host for the application. [This virtual host] has some sane defaults, suitable for most of our deployments (non-SSL). The file is created at `/etc/nginx/sites-available` and symlinked to `/etc/nginx/sites-enabled`. These are the defaults for the Nginx installation in Ubuntu. You can take a look at [our general `nginx.conf`](https://github.com/innvent/parcelles/blob/puppet/puppet/modules/nginx/files/nginx.conf).
+This recipes creates and configures the virtual_host for the application. [This virtual host] has some sane defaults, suitable for most of our deployments (non-SSL). The file is created at `/etc/nginx/sites-available` and symlinked to `/etc/nginx/sites-enabled`. These are the defaults for the Nginx installation in Ubuntu. You can take a look at [our general `nginx.conf`](https://github.com/innvent/parcelles/blob/master/puppet/modules/nginx/files/nginx.conf).
 
 Overwritable template: [`nginx_virtual_host_conf.erb`](lib/matross/templates/nginx/nginx_virtual_host_conf.erb)
 
@@ -156,17 +156,42 @@ Overwritable template: [`database.yml.erb`](lib/matross/templates/mysql/database
 
 > Tasks
 
-| Task                 | Description                                                                               |
-| ---                  | ---                                                                                       |
-| `mysql:setup`        | Creates the `database.yml` in the `shared_path`                                           |
-| `mysql:symlink`      | Creates a symlink for the `database.yml` file in the `current_path`                       |
-| `mysql:create`       | Creates the database if it hasn't been created                                            |
-| `mysql:schema_load`  | Loads the schema if there are no tables in the DB                                         |
-| `mysql:backup:setup` | Creates the backup script and configures the user's cron - *Not hooked to any other task* |
-| `mysql:dump:do`      | Dumps the application database                                                            |
-| `mysql:dump:get`     | Downloads a copy of the last generated database dump                                      |
-| `mysql:dump:apply`   | Apply the latest dump generated stored in 'dumps' locally                                 |
+| Task                        | Description                                                                               |
+| ---                         | ---                                                                                       |
+| `mysql:setup`               | Creates the `database.yml` in the `shared_path`                                           |
+| `mysql:symlink`             | Creates a symlink for the `database.yml` file in the `current_path`                       |
+| `mysql:create`              | Creates the database if it hasn't been created                                            |
+| `mysql:schema_load`         | Loads the schema if there are no tables in the DB                                         |
+| `mysql:backup:setup`        | Creates the backup script and configures the user's cron - *Not hooked to any other task* |
+| `mysql:dump:do`             | Dumps the application database                                                            |
+| `mysql:dump:get`            | Downloads a copy of the last generated database dump                                      |
+| `mysql:dump:apply`          | Applies the latest dump generated stored in 'dumps' locally                               |
+| `mysql:dump:post`           | Uploads a copy of the last generated database dump                                        |
+| `mysql:dump:apply_remotely` | Applies the latest uploaded dump in the remote server                                     |
 
+### PostgreSQL
+
+Requires having [`pg`](http://rubygems.org/gems/pg) available in the application. In our PostgreSQL recipe we dynamically generate a `database.yml` based on the variables that should be set globally or per-stage.
+
+**Please note** that we rely on local peer connection, hence, remote connections should use a custom template for `database.yml.erb`. **The PG cluster must have `UTF8` encoding.
+
+Overwritable template: [`database.yml.erb`](lib/matross/templates/postgresql/database.yml.erb)
+
+> Variables
+
+| Variable               | Default value                          | Description                                                           |
+| ---                    | ---                                    | ---                                                                   |
+| `:database_config`     | `"#{shared_path}/config/database.yml"` | Location of the configuration file                                    |
+| `:postgresql_database` | None                                   | PostgreSQL database name. Dashes `-` are *gsubed* for underscores `_` |
+| `:postgresql_user`     | `user`                                 | PostgreSQL user                                                       |
+
+> Tasks
+
+| Task                 | Description                                                             |
+| ---                  | ---                                                                     |
+| `postgresql:setup`   | Creates the `database.yml` in the `shared_path`, and the user if needed |
+| `postgresql:symlink` | Creates a symlink for the `database.yml` file in the `current_path`     |
+| `postgresql:create`  | Creates the database if it hasn't been created and loads the schema     |
 
 ## Mongoid
 

data/lib/matross/mysql.rb

@@ -6,20 +6,20 @@ _cset :mysql_backup_cron_schedule,  '30 3 * * *'
 
 namespace :mysql do
 
-  desc "Creates the database.yml file in shared path"
+  desc "Create the database.yml file in shared path"
   task :setup, :roles => [:app, :dj] do
     run "mkdir -p #{shared_path}/config"
     template "mysql/database.yml.erb", database_config
   end
   after "deploy:setup", "mysql:setup"
 
-  desc "Updates the symlink for database.yml for deployed release"
+  desc "Update the symlink for database.yml for deployed release"
   task :symlink, :roles => [:app, :dj] do
     run "ln -nfs #{database_config} #{release_path}/config/database.yml"
   end
   after "bundle:install", "mysql:symlink"
 
-  desc "Creates the application database"
+  desc "Create the application database"
   task :create, :roles  => :db do
     sql = <<-EOF.gsub(/^\s+/, '')
       CREATE DATABASE IF NOT EXISTS #{mysql_database.gsub("-", "_")};
@@ -31,7 +31,7 @@ namespace :mysql do
   end
   after "mysql:setup", "mysql:create"
 
-  desc "Loads the application schema into the database"
+  desc "Load the application schema into the database"
   task :schema_load, :roles => :db do
     sql = <<-EOF.gsub(/^\s+/, '')
       SELECT count(*) FROM information_schema.TABLES WHERE (TABLE_SCHEMA = '#{mysql_database.gsub("-", "_")}');
@@ -51,7 +51,7 @@ namespace :mysql do
 
     # This routine is heavily inspired by whenever's approach
     # https://github.com/javan/whenever
-    desc "Updates the crontab"
+    desc "Update the crontab with the backup entry"
     task :setup, :roles => :db do
       template "mysql/backup.sh.erb", mysql_backup_script
       run "chmod +x #{mysql_backup_script}"
@@ -91,7 +91,7 @@ namespace :mysql do
 
   namespace :dump do
 
-    desc "Dumps the application database"
+    desc "Dump the application database"
     task :do, :roles => :db, :except => { :no_release => true } do
       run "mkdir -p #{shared_path}/dumps"
       run %W{cd #{shared_path}/dumps &&
@@ -103,7 +103,7 @@ namespace :mysql do
              gzip > "$(date +'#{mysql_database}_\%Y\%m\%d\%H\%M.sql.gz')"} * ' '
     end
 
-    desc "Downloads a copy of the last generated database dump"
+    desc "Download a copy of the last generated database dump"
     task :get, :roles => :db, :except => { :no_release => true } do
       run_locally "mkdir -p dumps"
       most_recent_bkp = capture(%W{find #{shared_path} -type f -name
@@ -127,5 +127,33 @@ namespace :mysql do
                       #{'--password=' + db_config['password'] unless db_config['password'].nil?}
                       #{db_config['database']} < #{most_recent_bkp}} * ' '
     end
+
+    desc "Upload a copy of the last generated database dump"
+    task :post, :roles => :db, :except => { :no_release => true } do
+      run "mkdir -p #{shared_path}/dumps"
+      most_recent_bkp = %x[find dumps -type f -name '*.sql'].split.sort.last
+      abort 'No dump found. Run mysql:dump:get' if most_recent_bkp.nil?
+
+      run_locally "gzip -k #{most_recent_bkp}"
+      zipped_bkp = most_recent_bkp + '.gz'
+
+      upload zipped_bkp, "#{shared_path}/dumps", :via => :scp
+      run_locally "rm #{zipped_bkp}"
+    end
+
+    desc "Apply the latest uploaded dump in the remote server"
+    task :apply_remotely, :roles => :db, :except => { :no_release => true } do
+      most_recent_bkp = capture(%W{find #{shared_path} -type f -name '*.sql.gz'} * ' ').split.sort.last
+      abort 'No dump found. Run mysql:dump:post' if most_recent_bkp.nil?
+
+      db_config = YAML.load(capture("cat #{shared_path}/config/database.yml"))[rails_env]
+      run %W{zcat #{most_recent_bkp} | mysql --user=#{db_config['username']}
+              --host=#{db_config['host']}
+              #{'--password=' + db_config['password'] unless db_config['password'].nil?}
+              #{db_config['database']}} * ' '
+    end
+    before "mysql:dump:apply_remotely", "foreman:stop"
+    after  "mysql:dump:apply_remotely", "foreman:restart"
+
   end
 end

data/lib/matross/postgresql.rb

@@ -0,0 +1,44 @@
+dep_included? 'pg'
+
+_cset(:database_config) { "#{shared_path}/config/database.yml" }
+_cset(:postgresql_user) { user }
+
+namespace :postgresql do
+
+  desc 'Create the database.yml file in shared path. User is created if needed'
+  task :setup, :roles => [:app, :dj] do
+    run "mkdir -p #{shared_path}/config"
+    template "postgresql/database.yml.erb", database_config
+    user_count = capture(%W{ sudo -u postgres psql postgres -tAc
+                             "SELECT 1 FROM pg_roles
+                              WHERE rolname='#{postgresql_user}'" } * ' ').to_i
+    if user_count == 0
+      run "#{sudo} -u postgres createuser -d -r -s #{postgresql_user}"
+    else
+      logger.info 'User already created, skpping'
+    end
+  end
+  after 'deploy:setup', 'postgresql:setup'
+
+  desc 'Update the symlink for database.yml for deployed release'
+  task :symlink, :roles => [:app, :dj] do
+    run "ln -nfs #{database_config} #{release_path}/config/database.yml"
+  end
+  after 'bundle:install', 'postgresql:symlink'
+
+  desc "Create the database and load the schema"
+  task :create, :roles => :db do
+    db_count = capture(%W{ #{sudo} -u postgres psql -lqt |
+                           cut -d \\| -f 1 |
+                           grep -w #{postgresql_database.gsub("-", "_")} |
+                           wc -l } * ' ').to_i
+    if db_count == 0
+      run %W{ cd #{release_path} &&
+              RAILS_ENV=#{rails_env.to_s.shellescape}
+              bundle exec rake db:create db:schema:load } * ' '
+    else
+      logger.info 'DB is already configured, skipping'
+    end
+  end
+  after 'postgresql:symlink', 'postgresql:create'
+end

data/lib/matross/templates/postgresql/database.yml.erb

@@ -0,0 +1,6 @@
+<%= rails_env %>:
+  adapter: postgresql
+  encoding: utf8
+  database: <%= postgresql_database.gsub("-", "_") %>
+  pool: 5
+  reconnect: true

data/lib/matross/version.rb

@@ -1,3 +1,3 @@
 module Matross
-  VERSION = '0.5.5'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: matross
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Artur Rodrigues
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -61,7 +61,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -77,6 +77,7 @@ files:
 - lib/matross/mongoid.rb
 - lib/matross/mysql.rb
 - lib/matross/nginx.rb
+- lib/matross/postgresql.rb
 - lib/matross/templates/base/logrotate.erb
 - lib/matross/templates/faye/faye.ru.erb
 - lib/matross/templates/faye/faye_server.yml.erb
@@ -86,6 +87,7 @@ files:
 - lib/matross/templates/mysql/backup.sh.erb
 - lib/matross/templates/mysql/database.yml.erb
 - lib/matross/templates/nginx/nginx_virtual_host_conf.erb
+- lib/matross/templates/postgresql/database.yml.erb
 - lib/matross/templates/unicorn/unicorn.rb.erb
 - lib/matross/unicorn.rb
 - lib/matross/version.rb
@@ -100,18 +102,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Our collection of opnionated Capistrano recipes
 test_files: []
+has_rdoc: