labdb_manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 909b21cc1ddbba3c422a33191657951acbf636da
+  data.tar.gz: e96a44db487b6f1e77fcdecd74c840aa073daf4d
+SHA512:
+  metadata.gz: 6b178845e45f09eb9784d02e41ed17a1171525e7ace255d2f2f75aa037402971dbdbcd210ea3e695c6352c3c56ca4d56d5fe4c1d069d5d16d6d46e2e59adb913
+  data.tar.gz: f785e8ad00ade7fa8687f278705453162fff86748085bbcf25fe40048f0c89705974db5a2926bd37833215826e22e5f17cc60e9286a2e219a3d5d00ea047a3b0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in labdb_manager.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Colin J. Fuller
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# LabdbManager
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'labdb_manager'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install labdb_manager
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/labdb_manager/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/labdb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require 'labdb_manager'
+
+if __FILE__ == $0 then
+  first_arg = ARGV.shift
+  if first_arg == "--dry-run" then
+    run_task ARGV[0], args: ARGV[1..-1], dry_run: true
+  else
+    run_task first_arg, args: ARGV
+  end
+end

data/labdb_manager.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'labdb_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "labdb_manager"
+  spec.version       = LabdbManager::VERSION
+  spec.authors       = ["Colin J. Fuller"]
+  spec.email         = ["cjfuller@gmail.com"]
+  spec.summary       = %q{Management script for labdb.}
+  spec.description   = %q{Script for updating, helping to install, and managing labdb.}
+  spec.homepage      = "https://github.com/cjfuller/labdb_manager"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/labdb_manager/version.rb

@@ -0,0 +1,3 @@
+module LabdbManager
+  VERSION = "0.0.1"
+end

data/lib/labdb_manager.rb

@@ -0,0 +1,288 @@
+require "securerandom"
+
+require "labdb_manager/version"
+
+COMMAND_PREFIX = "--> "
+CONFIRM_PREFIX = "--? "
+
+#git parameters
+BR_DEPLOY_STAGING = 'deploy_staging'
+BR_DEPLOY = 'deploy'
+BR_REMOTE = 'master'
+REM_NAME = 'origin'
+PROJECT_URL = 'https://github.com/cjfuller/labdb.git'
+DEFAULT_REPO_PATH = '~/labdb'
+DEFAULT_BACKUP_DIR = '~/backups'
+AUTO_MERGE_MESSAGE = '"auto merge by manage.py"'
+
+#database backend
+PG_DUMP_PATH = `which pg_dump`.strip
+
+#paths to config files
+HOSTNAME_CFG_FILE = 'config/full_hostname.txt'
+SECRET_CFG_FILE = 'config/secret_token.txt'
+
+COLORS = {
+  green: "\033[92m",
+  yellow: "\033[93m",
+  red: "\033[91m",
+  off: "\033[0m"
+}
+
+# define methods on string for each color
+class String
+  COLORS.each do |c, s|
+    define_method c do
+      s + self + COLORS[:off]
+    end
+  end
+end
+
+def print_command(cmd)
+  ### Print a command being run in a standard format
+  puts (COMMAND_PREFIX + cmd).green
+end
+
+def confirm(cmd)
+  # Ask the user for confirmation of the specified command
+  #
+  # If confirmation is not given, exit the program immediately without running
+  # the command.
+  puts (CONFIRM_PREFIX + cmd).yellow
+  response = gets
+  unless ['yes', 'y'].include? response.downcase then
+    exit 0
+  end
+  cmd
+end
+
+SHELL_COMMAND_LIST = []
+
+def queue_command(**kwargs, &bl)
+  SHELL_COMMAND_LIST << ShellCommand.new(bl, **kwargs)
+end
+
+def run_queued_commands(dry_run: false)
+  SHELL_COMMAND_LIST.each do |c|
+    c.call(dry_run: dry_run)
+  end
+  SHELL_COMMAND_LIST.clear
+end
+
+class ShellCommand
+  # A command that gets run in a login shell.
+
+  def self.prepend_login_shell(cmd)
+    "/bin/bash --login -c #{cmd}"
+  end
+
+  def initialize(cmd_fct, args: [], requires_sudo: false, exit_on_fail: true)
+    @cmd_fct = cmd_fct
+    @requires_sudo = requires_sudo
+    @exit_on_fail = exit_on_fail
+    @args = args
+  end
+
+  def call(dry_run: false)
+    # Run the command.
+    command_string = @cmd_fct.call *@args
+    puts (COMMAND_PREFIX + command_string).green
+    unless dry_run then
+      `#{ShellCommand.prepend_login_shell command_string}`
+      if $?.exitstatus > 0 and @exit_on_fail
+        puts ("Encountered an unresolvable error while running #{command_string}.  " +
+              "Please resolve the problem manually and re-run").red
+        exit($?.exitstatus)
+      end
+    end
+    $?.exitstatus
+  end
+
+  def to_s
+    @cmd_fct.call
+  end
+end
+
+# git commands
+def check_for_staging_branch
+  # Check (via process return code) if the staging branch already exists.
+  #
+  # @return 0 if the branch exists, nonzero otherwise
+
+  "git show-ref --verify --quiet refs/heads/#{BR_DEPLOY_STAGING}"
+end
+
+def clean_up_staging_branch
+  # Delete the staging branch.  Don't check for its existence.
+  confirm "git checkout #{BR_DEPLOY} && git branch -d #{BR_DEPLOY_STAGING}"
+end
+
+def create_staging_branch
+  # Create the staging branch.  Don't check for its existence.
+  "git checkout #{BR_DEPLOY} && git branch #{BR_DEPLOY_STAGING}"
+end
+
+def fetch_remote_changes
+  # Download changes from the central labdb repo set up as a remote.
+  #
+  # The remote name and branch to download are set up in the constants above.
+
+  "git checkout #{BR_REMOTE} && git pull #{REM_NAME} #{BR_REMOTE}"
+end
+
+def stage_changes
+  # Merge changes from the downloaded branch into the staging branch.
+  #
+  # This is where problems should arise if there are merge conflicts.  If this
+  # happens and you need to get back to a workable state, you can force the
+  # load of the (still unchanged) deploy branch using `manage.py revert-
+  # failure`.
+
+  ("git checkout #{BR_DEPLOY_STAGING} && " +
+   "git merge -m #{AUTO_MERGE_MESSAGE} #{BR_REMOTE}")
+end
+
+def merge_into_production
+  # Merge changes from staging into production.
+  ("git checkout #{BR_DEPLOY} && " +
+   "git merge -m #{AUTO_MERGE_MESSAGE} #{BR_DEPLOY_STAGING}")
+end
+
+def revert_merge_failure
+  # Revert a merge and go back to production in case conflicts arise.
+  "git reset --merge && git checkout #{BR_DEPLOY}"
+end
+
+# application commands
+
+def bundle_install
+  "bundle install"
+end
+
+def bundle_update
+  confirm "bundle update"
+end
+
+def precompile_assets
+  "bundle exec rake assets:precompile"
+end
+
+# database commands
+
+def create_backup
+  suffix = "_labdb_backup.dump"
+  backup_timestring = Time.now.strftime("%Y%m%d_%H%M%S")
+  fn = backup_timestring + suffix
+  fn_full = File.expand_path(fn, DEFAULT_BACKUP_DIR)
+  [PG_DUMP_PATH,
+   "-h localhost labdb > #{fn_full}",
+   "&&",
+   "tar cjf #{fn_full}.tar.bz2 -C {DEFAULT_BACKUP_DIR} {fn}",
+   "&&",
+   "rm -f #{fn_full}"
+   ].join(" ")
+end
+
+def create_production_db
+  "RAILS_ENV=production bundle exec rake db:setup"
+end
+
+# server status commands
+
+def restart_server
+  "supervisorctl restart labdb"
+end
+
+def run_devserver
+  "bundle exec puma --config config/puma.rb"
+end
+
+# other commands not using the shell
+
+def set_hostname(hostname: nil)
+  if hostname.nil?
+    puts ("Please enter the full hostname of the machine.\n" +
+      '(i.e. the part that would appear including the https:// ' +
+      'in a url but before any other slashes):').yellow
+    CONFIRM_PREFIX.yellow
+    hostname = gets
+    File.open(HOSTNAME_CFG_FILE, 'w') do |f|
+      f.write hostname
+    end
+  end
+end
+
+def generate_application_secret
+  secret = SecureRandom.hex(64) # 512 bits
+  puts (COMMAND_PREFIX +
+        "Writing application secret to #{SECRET_CFG_FILE}").green
+  File.open(SECRET_CFG_FILE, 'w') do |f|
+    f.write secret
+  end
+  File.chmod(0600, SECRET_CFG_FILE)
+  ok
+end
+
+# task helpers
+
+def ok
+  puts "OK".green
+end
+
+# tasks
+
+def update
+  queue_command {create_backup}
+  if ShellCommand.new(
+      Proc.new {check_for_staging_branch}, exit_on_fail: false).call == 0 then
+    queue_command {clean_up_staging_branch}
+  end
+  queue_command {create_staging_branch}
+  queue_command {fetch_remote_changes}
+  queue_command {stage_changes}
+  queue_command {bundle_install}
+  queue_command {precompile_assets}
+  queue_command {merge_into_production}
+  queue_command {restart_server}
+end
+
+def backup
+  queue_command {create_backup}
+end
+
+def force_update_deps
+  queue_command bundle_update
+end
+
+def secret
+  generate_application_secret
+end
+
+def hostname(hostname: nil)
+  set_hostname(hostname: hostname)
+end
+
+def install
+  queue_command {create_production_db}
+end
+
+def revert_failure
+  queue_command {revert_merge_failure}
+end
+
+def restart
+  queue_command {restart_server}
+end
+
+def devserver
+  queue_command {run_devserver}
+end
+
+def help
+end
+
+def run_task(t, args: [], dry_run: false)
+  send t, *args
+  run_queued_commands dry_run: dry_run
+  ok
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: labdb_manager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Colin J. Fuller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Script for updating, helping to install, and managing labdb.
+email:
+- cjfuller@gmail.com
+executables:
+- labdb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/labdb
+- labdb_manager.gemspec
+- lib/labdb_manager.rb
+- lib/labdb_manager/version.rb
+homepage: https://github.com/cjfuller/labdb_manager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2
+signing_key: 
+specification_version: 4
+summary: Management script for labdb.
+test_files: []