orats 0.6.5 → 0.7.0

data/lib/orats/templates/includes/new/rails/lib/backup/models/backup.rb

@@ -0,0 +1,55 @@
+Model.new(:backup, 'Backup for the current RAILS_ENV') do
+  split_into_chunks_of 10
+  compress_with Gzip
+
+  database PostgreSQL do |db|
+    db.sudo_user = ENV['DATABASE_USERNAME']
+    # To dump all databases, set `db.name = :all` (or leave blank)
+    db.name      = ENV['DATABASE_NAME']
+    db.username  = ENV['DATABASE_USERNAME']
+    db.password  = ENV['DATABASE_PASSWORD']
+    db.host      = ENV['DATABASE_HOST']
+    db.port      = 5432
+    db.socket    = '/var/run/postgresql'
+    #db.skip_tables        = ['skip', 'these', 'tables']
+    #db.only_tables        = ['only', 'these', 'tables']
+  end
+
+  # uncomment the block below to archive a specific path
+  # this may be useful if you have user supplied content
+
+  # archive :app_archive do |archive|
+  #   archive.add File.join(ENV['PROJECT_PATH'], 'public', 'system')
+  # end
+
+  # uncomment the block below and fill in the required information
+  # to use S3 to store your backups
+
+  # don't want to use S3? check out the other available options:
+  # http://meskyanichi.github.io/backup/v4/storages/
+
+  # store_with S3 do |s3|
+  #   s3.access_key_id = ENV['S3_ACCESS_KEY_ID']
+  #   s3.secret_access_key = ENV['S3_SECRET_ACCESS_KEY']
+  #   s3.region = ENV['S3_REGION']
+  #   s3.bucket = 'backup'
+  #   s3.path = "/database/#{ENV['RAILS_ENV']}"
+  # end
+
+  ENV['SMTP_ENCRYPTION'].empty? ? mail_encryption = 'none' : mail_encryption = ENV['SMTP_ENCRYPTION']
+
+  notify_by Mail do |mail|
+    mail.on_success     = false
+    #mail.on_warning           = true
+    mail.on_failure     = true
+    mail.from           = ENV['ACTION_MAILER_DEFAULT_FROM']
+    mail.to             = ENV['ACTION_MAILER_DEFAULT_TO']
+    mail.address        = ENV['SMTP_ADDRESS']
+    mail.port           = ENV['SMTP_PORT'].to_i
+    mail.domain         = ENV['SMTP_DOMAIN']
+    mail.user_name      = ENV['SMTP_USERNAME']
+    mail.password       = ENV['SMTP_PASSWORD']
+    mail.authentication = ENV['SMTP_AUTH']
+    mail.encryption     = mail_encryption.to_sym
+  end
+end

data/lib/orats/templates/includes/new/rails/lib/tasks/orats/backup.rake

@@ -0,0 +1,18 @@
+namespace :orats do
+  desc 'Create a backup of your application for a specific environment'
+  task :backup do
+    if File.exist?('.env') && File.file?('.env')
+      require 'dotenv'
+      Dotenv.load
+      source_external_env = ''
+    else
+      source_external_env = '. /etc/default/app_name &&'
+    end
+
+    # hack'ish way to run the backup command with elevated privileges, it won't prompt for a password on the production
+    # server because passwordless sudo has been enabled if you use the ansible setup provided by orats
+    system 'sudo whoami'
+
+    system "#{source_external_env} backup perform -t backup -c '#{File.join('lib', 'backup', 'config.rb')}' --log-path='#{File.join('log')}'"
+  end
+end

data/lib/orats/templates/includes/new/rails/lib/tasks/orats/favicon.rake

@@ -0,0 +1,48 @@
+namespace :orats do
+  desc 'Create favicons from a single base png'
+  task :favicons do
+    require 'favicon_maker'
+
+    FaviconMaker.generate do
+      setup do
+        template_dir Rails.root.join('app', 'assets', 'favicon')
+        output_dir Rails.root.join('public')
+      end
+
+      favicon_base_path = "#{template_dir}/favicon_base.png"
+
+      unless File.exist?(favicon_base_path)
+        puts
+        puts 'A base favicon could not be found, make sure one exists at:'
+        puts favicon_base_path
+        puts
+        exit 1
+      end
+
+      from File.basename(favicon_base_path) do
+        icon 'speeddial-160x160.png'
+        icon 'apple-touch-icon-228x228-precomposed.png'
+        icon 'apple-touch-icon-152x152-precomposed.png'
+        icon 'apple-touch-icon-144x144-precomposed.png'
+        icon 'apple-touch-icon-120x120-precomposed.png'
+        icon 'apple-touch-icon-114x114-precomposed.png'
+        icon 'apple-touch-icon-76x76-precomposed.png'
+        icon 'apple-touch-icon-72x72-precomposed.png'
+        icon 'apple-touch-icon-60x60-precomposed.png'
+        icon 'apple-touch-icon-57x57-precomposed.png'
+        icon 'favicon-196x196.png'
+        icon 'favicon-160x160.png'
+        icon 'favicon-96x96.png'
+        icon 'favicon-64x64.png'
+        icon 'favicon-32x32.png'
+        icon 'favicon-24x24.png'
+        icon 'favicon-16x16.png'
+        icon 'favicon.ico', size: '64x64,32x32,24x24,16x16'
+      end
+
+      each_icon do |filepath|
+        puts "Creating favicon @ #{filepath}"
+      end
+    end
+  end
+end

data/lib/orats/templates/includes/new/rails/public/404.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Error 404</title>
+    <meta charset="utf-8"/>
+    <style>
+    </style>
+</head>
+
+<body>
+<h1>Error 404</h1>
+</body>
+</html>

data/lib/orats/templates/includes/new/rails/public/422.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Error 422</title>
+    <meta charset="utf-8"/>
+    <style>
+    </style>
+</head>
+
+<body>
+<h1>Error 422</h1>
+</body>
+</html>

data/lib/orats/templates/includes/new/rails/public/500.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Error 500</title>
+    <meta charset="utf-8"/>
+    <style>
+    </style>
+</head>
+
+<body>
+<h1>Error 500</h1>
+</body>
+</html>

data/lib/orats/templates/includes/new/rails/public/502.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+
+    <title>Error 502</title>
+    <meta charset="utf-8"/>
+    <style>
+    </style>
+</head>
+<body>
+<h1>Error 502</h1>
+</body>
+</html>

data/lib/orats/templates/includes/new/rails/test/fixtures/accounts.yml

@@ -0,0 +1,27 @@
+---
+foo:
+  id: 1
+  email: foo@bar.com
+  encrypted_password: passwordisnotreallyencrypted
+  role: admin
+  created_at: 2012-01-01 01:45:17
+  current_sign_in_at: 2013-03-15 11:22:33
+
+no_role:
+  id: 2
+  email: joey@almostcool.com
+  encrypted_password: hackthegibson
+  created_at: 1995-09-15 08:10:12
+
+bad_role:
+  id: 3
+  email: hello@world.com
+  encrypted_password: reallysecure
+  role: ahhhh
+  created_at: 2011-09-20 10:10:10
+
+beep:
+  id: 4
+  email: beep@beep.com
+  encrypted_password: beepbeepbeep
+  created_at: 2010-03-6 05:15:45

data/lib/orats/templates/includes/new/rails/test/models/account_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class AccountTest < ActiveSupport::TestCase
+  def setup
+    @account = accounts(:foo)
+  end
+
+  def teardown
+    @account = nil
+  end
+
+  test 'expect new account' do
+    assert @account.valid?
+    assert_not_nil @account.email
+    assert_not_nil @account.encrypted_password
+  end
+
+  test 'expect guest to be default role' do
+    no_role = accounts(:no_role)
+    assert_equal 'guest', no_role.role
+  end
+
+  test 'expect invalid role to not save' do
+    bad_role = accounts(:bad_role)
+    assert_not bad_role.valid?
+  end
+
+  test 'expect e-mail to be unique' do
+    duplicate = Account.create(email: 'foo@bar.com')
+
+    assert_not duplicate.valid?
+  end
+
+  test 'expect random password if password is empty' do
+    @account.password           = ''
+    @account.encrypted_password = ''
+    @account.save
+
+    random_password = Account.generate_password
+    assert_equal 10, random_password.length
+  end
+
+  test 'expect random password of 20 characters' do
+    assert_equal 20, Account.generate_password(20).length
+  end
+end

data/lib/orats/templates/includes/playbook/site.yml

@@ -0,0 +1,53 @@
+---
+- name: ensure all servers are commonly configured
+  hosts: all
+  sudo: true
+
+  roles:
+    - { role: nickjj.user, tags: [common, user] }
+
+- name: ensure database servers are configured
+  hosts: database
+  sudo: true
+
+  roles:
+    - role: nickjj.security
+      tags: [database, security]
+      security_ufw_ports:
+        - rule: deny
+          port: 80
+          proto: tcp
+    - { role: nickjj.postgres, tags: [database, postgres] }
+
+- name: ensure cache servers are configured
+  hosts: cache
+  sudo: true
+
+  roles:
+    - role: nickjj.security
+      tags: [cache, security]
+      security_ufw_ports:
+        - rule: deny
+          port: 80
+          proto: tcp
+    - { role: DavidWittman.redis, tags: [cache, redis] }
+
+- name: ensure app servers are configured
+  hosts: app
+  sudo: true
+
+  roles:
+    - role: nickjj.security
+      tags: [app, security]
+      security_ufw_ports:
+        - rule: allow
+          port: 80
+          proto: tcp
+    - { role: nickjj.ruby, tags: [app, ruby] }
+    - { role: nickjj.nodejs, tags: [app, nodejs] }
+    - { role: nickjj.nginx, tags: [app, nginx] }
+    - { role: nickjj.rails, tags: [app, rails] }
+    - { role: nickjj.whenever, tags: [app, rails] }
+    - { role: nickjj.pumacorn, tags: [app, rails] }
+    - { role: nickjj.sidekiq, tags: [app, rails] }
+    - { role: nickjj.monit, tags: [app, monit] }

data/lib/orats/templates/playbook.rb

@@ -0,0 +1,115 @@
+require 'securerandom'
+
+# =============================================================================
+# template for generating an orats ansible playbook for ansible 1.6.x
+# =============================================================================
+# view the task list at the bottom of the file
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# private functions
+# -----------------------------------------------------------------------------
+def generate_token
+  SecureRandom.hex(64)
+end
+
+def method_to_sentence(method)
+  method.tr!('_', ' ')
+  method[0] = method[0].upcase
+  method
+end
+
+def log_task(message)
+  puts
+  say_status 'task', "#{method_to_sentence(message.to_s)}:", :yellow
+  puts '-'*80, ''; sleep 0.25
+end
+
+def git_commit(message)
+  git add: '-A'
+  git commit: "-m '#{message}'"
+end
+
+def git_config(field)
+  command         = "git config --global user.#{field}"
+  git_field_value = run(command, capture: true).gsub("\n", '')
+  default_value   = "YOUR_#{field.upcase}"
+
+  git_field_value.to_s.empty? ? default_value : git_field_value
+end
+
+def copy_from_local_gem(source, dest = '')
+  dest = source if dest.empty?
+
+  base_path = "#{File.expand_path File.dirname(__FILE__)}/includes/playbook"
+
+  run "mkdir -p #{File.dirname(dest)}" unless Dir.exist?(File.dirname(dest))
+  run "cp -f #{base_path}/#{source} #{dest}"
+end
+
+# ---
+
+def delete_generated_rails_code
+  log_task __method__
+
+  run 'rm -rf * .git .gitignore'
+end
+
+def add_playbook_directory
+  log_task __method__
+
+  run "mkdir -p #{app_name}"
+  run "mv #{app_name}/* ."
+  run "rm -rf #{app_name}"
+  git :init
+  git_commit 'Initial commit'
+end
+
+def add_license
+  log_task __method__
+
+  author_name  = git_config 'name'
+  author_email = git_config 'email'
+
+  copy_from_local_gem '../common/LICENSE', 'LICENSE'
+  gsub_file 'LICENSE', 'Time.now.year', Time.now.year.to_s
+  gsub_file 'LICENSE', 'author_name', author_name
+  gsub_file 'LICENSE', 'author_email', author_email
+  git_commit 'Add MIT license'
+end
+
+def add_main_playbook
+  log_task __method__
+
+  copy_from_local_gem 'site.yml', 'site.yml'
+  git_commit 'Add the main playbook'
+end
+
+def remove_unused_files_from_git
+  log_task __method__
+
+  git add: '-u'
+  git_commit 'Remove unused files'
+end
+
+def log_complete
+  puts
+  say_status 'success', "\e[1m\Everything has been setup successfully\e[0m", :cyan
+  puts
+  say_status 'question', 'Are most of your apps similar?', :yellow
+  say_status 'answer', 'You only need to generate one playbook and you just did', :white
+  say_status 'answer', 'Use the inventory in each project to customize certain things', :white
+  puts
+  say_status 'question', 'Are you new to ansible?', :yellow
+  say_status 'answer', 'http://docs.ansible.com/intro_getting_started.html', :white
+  puts
+end
+
+# ---
+
+delete_generated_rails_code
+add_playbook_directory
+add_license
+add_main_playbook
+remove_unused_files_from_git
+log_complete

data/lib/orats/version.rb

@@ -1,3 +1,3 @@
 module Orats
-  VERSION = '0.6.5'
+  VERSION = '0.7.0'
 end

data/test/integration/cli_test.rb

@@ -1,135 +1,182 @@
+require 'yaml'
 require_relative '../test_helper'
 
 class TestCLI < Minitest::Test
   include Orats::Test
 
-  def test_new_app
-    app_name = generate_app_name
+  attr_accessor :target_path, :extra_flags
 
-    out, err = capture_subprocess_io do
-      orats "new #{app_name}", flags: ORATS_FLAGS
-    end
-
-    assert_match /Start your server/, out
+  def startup
+    @target_path = ''
+    @extra_flags = ''
+  end
 
-    assert_path_exists "#{TEST_PATH}/#{app_name}/inventory"
-    assert_path_exists "#{TEST_PATH}/#{app_name}/secrets"
+  def teardown
+    assert_nuked unless @target_path.nil?
+  end
 
-    assert_nuked app_name
+  def test_project
+    assert_project ansible: :assert
   end
 
-  def test_new_app_with_auth
-    app_name     = generate_app_name
-    gemfile_path = "#{TEST_PATH}/#{app_name}/services/#{app_name}/Gemfile"
+  def test_project_with_auth
+    assert_project '--template auth', ansible: :assert
+  end
 
-    out, err = capture_subprocess_io do
-      orats "new #{app_name}", flags: "--auth #{ORATS_FLAGS}"
-    end
+  def test_project_without_ansible
+    assert_project '--skip-ansible', ansible: :refute
+  end
 
-    assert_match /Start your server/, out
+  def test_project_with_invalid_template
+    @target_path = generate_app_name
+    @extra_flags = "#{ORATS_NEW_FLAGS} --template foo"
 
-    assert_path_exists "#{TEST_PATH}/#{app_name}/inventory"
-    assert_path_exists "#{TEST_PATH}/#{app_name}/secrets"
-    assert_path_exists "#{TEST_PATH}/#{app_name}/services/#{app_name}"
+    assert_orats 'project', 'not a valid template'
+  end
 
-    assert_in_file gemfile_path, /devise/
-    assert_in_file gemfile_path, /devise-async/
-    assert_in_file gemfile_path, /pundit/
+  def test_inventory
+    assert_inventory
+  end
 
-    assert_nuked app_name
+  def test_playbook
+    assert_playbook
   end
 
-  def test_new_app_without_extras
-    app_name = generate_app_name
+  def test_diff
+    assert_playbook
 
-    out, err = capture_subprocess_io do
-      orats "new #{app_name}", flags: "--skip-extras #{ORATS_FLAGS}"
-    end
+    @target_path = ''
+    assert_orats 'diff', 'Compare this version of'
+  end
 
-    refute_path_exists "#{TEST_PATH}/#{app_name}/inventory"
-    refute_path_exists "#{TEST_PATH}/#{app_name}/secrets"
-    refute_path_exists "#{TEST_PATH}/#{app_name}/services/#{app_name}"
-    assert_path_exists "#{TEST_PATH}/#{app_name}"
+  def test_templates
+    assert_orats 'templates', '--template auth'
+  end
 
-    assert_nuked app_name
+  def test_version
+    assert_orats 'version', 'Orats'
   end
 
-  def test_play
-    app_name = generate_app_name
+  private
 
-    out, err = capture_subprocess_io do
-      orats "play #{app_name}"
-    end
+  def assert_orats(command, match_regex, ansible: nil)
+    out, err = capture_orats(command)
 
-    assert_match /success/, out
-    assert_nuked app_name
+    assert_match /#{match_regex}/, out
+
+    assert_or_refute_ansible ansible if ansible
   end
 
-  def test_outdated
-    app_name = generate_app_name
+  def assert_project(flags = '', ansible: nil)
+    @target_path         = generate_app_name
+    absolute_target_path = "#{TEST_PATH}/#{@target_path}"
+    @extra_flags         = "#{ORATS_NEW_FLAGS} #{flags}"
 
-    out, err = capture_subprocess_io do
-      orats "play #{app_name}"
-    end
-    assert_match /success/, out
+    assert_orats 'project', 'Start your server', ansible: ansible
 
-    out, err = capture_subprocess_io do
-      orats 'outdated'
+    if ansible == :assert
+      assert_ansible_yaml "#{absolute_target_path}/inventory/group_vars/all.yml"
     end
-    assert_match /Comparing this version of/, out
 
-    assert_nuked app_name
+    absolute_target_path << "/services/#{@target_path}"
+    assert_project_tests_pass absolute_target_path
   end
 
-  def test_version
+  def assert_project_tests_pass(target_path)
     out, err = capture_subprocess_io do
-      orats 'version'
+      system "cd #{target_path} && bundle exec rake test"
     end
 
-    assert_match /Orats/, out
+    log_rails_test_results out
+    assert out.include?('0 failures') && out.include?('0 errors'), err
   end
 
-  private
+  def assert_inventory
+    @target_path = generate_app_name
+    @extra_flags = '--skip-galaxy'
+
+    assert_orats 'inventory', 'success'
+    assert_ansible_yaml "#{TEST_PATH}/#{@target_path}/inventory/group_vars/all.yml"
+  end
+
+  def assert_playbook
+    @target_path = generate_app_name
 
-  def assert_nuked(app_name, options = {})
+    assert_orats 'playbook', 'success'
+    assert_ansible_yaml "#{TEST_PATH}/#{@target_path}/site.yml"
+  end
+
+  def assert_nuked(options = {})
     out, err = capture_subprocess_io do
-      orats "nuke #{app_name}", flags: options[:flags], answer: 'y'
+      orats "nuke #{@target_path}", flags: options[:flags], answer: 'y'
     end
 
-    assert_match /#{app_name}/, out
-    system 'rm -rf /tmp/orats'
+    assert_match /#{@target_path}/, out
+    system "rm -rf #{TEST_PATH}"
   end
 
-  def assert_server_started
-    assert port_taken?
+  def assert_in_file(file_path, match_regex)
+    file_contents = `cat #{file_path}`
+    assert_match /#{match_regex}/, file_contents
   end
 
-  def assert_path_exists(file_or_dir)
+  def assert_path(file_or_dir)
     assert File.exists?(file_or_dir), "Expected path '#{file_or_dir}' to exist"
   end
 
-  def refute_path_exists(file_or_dir)
+  def refute_path(file_or_dir)
     refute File.exists?(file_or_dir), "Expected path '#{file_or_dir}' to exist"
   end
 
-  def assert_in_file(file_path, regex)
-    out, err = capture_subprocess_io do
-      system "cat #{file_path}"
-    end
+  def assert_or_refute_ansible(assert_or_refute)
+    absolute_target_path = "#{TEST_PATH}/#{@target_path}"
+
+    assert_path "#{absolute_target_path}/services"
+    send("#{assert_or_refute.to_s}_path",
+         "#{absolute_target_path}/inventory")
+    send("#{assert_or_refute.to_s}_path",
+         "#{absolute_target_path}/secrets")
+  end
+
+  def assert_ansible_yaml(file_path)
+    begin
+      file                 = IO.read(file_path)
+      invalid_ansible_yaml = file.match(/^([^#].\w): {/)
+
+      if invalid_ansible_yaml
+        assert false, "Invalid yaml syntax found near:\n #{invalid_ansible_yaml}\n\nYou need to include quotes around values that start with jinja template tags:\n Example, foo: '{{ bar }}'"
+        return
+      end
 
-    assert_match regex, out
+      assert YAML.load(file)
+    rescue Psych::SyntaxError => ex
+      assert false, ex.message
+    end
   end
 
-  def ensure_port_is_free
-    skip 'Port 3000 is already in use, aborting test' if port_taken?
+  def capture_orats(command)
+    out, err = capture_subprocess_io do
+      orats "#{command} #{@target_path}", flags: @extra_flags
+    end
+
+    [out, err]
   end
 
-  def kill_server(stdout_text)
-    pid_lines = stdout_text.scan(/started with pid \d+/)
+  def log_rails_test_results(out)
+    out_lines = out.split("\n")
 
-    puma    = pid_lines[0].split(' ').last
-    sidekiq = pid_lines[1].split(' ').last
+    out_lines.delete_if do |line|
+      line.include?('Sidekiq') || line.start_with?('.') ||
+          line.include?('Running') || line.include?('Run options') ||
+          line.empty?
+    end
 
-    system "kill -9 #{puma} && kill -9 #{sidekiq}"
+    puts
+    puts '-'*80
+    puts 'Results of running `bundle exec rake test` on the generated test app:'
+    puts '-'*80
+    puts out_lines.join("\n\n").rstrip
+    puts '-'*80
+    puts
   end
 end