machines 0.5.1

data/lib/template/webapps.yml

@@ -0,0 +1,75 @@
+# BE CAREFUL: THIS FILE IS ALSO WRITTEN TO BY MACHINES
+# This config file is used to read and also write application settings.
+# You can replace these comments with your own. Comment lines will be retained upto
+# the ---.
+#
+# TODO: Move passwords to separate GPG encrypted file
+#
+# password: Password for application database - Leave blank to generate one
+# database: Database name to write to database.yml - Leave blank to use application name
+# username: Username to write to database.yml - Leave blank to use application name
+# The name of the webapp will be used as the name of the destination folder of the clone
+# Any environments can be used here. A machine has a given environment.
+# Any of the keys can be used within or outside the environment
+
+---
+webapps:
+  condensd:
+    title: 'Condensd'
+    scm: git://github.com/PhilT/fountain.git
+    branch: condensd
+    ssl: false
+    write_yml: true
+    development:
+      server_name: condensd.dev
+      password: condensd
+    staging:
+      server_name: staging.condensd.com
+      password:
+      monitor_delayed_job: true
+      monit_web: true
+    production:
+      server_name: condensd.com
+      password:
+      monitor_delayed_job: true
+      monit_web: true
+
+  fountain:
+    title: 'Fountain'
+    scm: git://github.com/PhilT/fountain.git
+    database: fountain
+    username: fountain
+    ssl: false
+    write_yml: true
+    development:
+      server_name: fountainwiki.dev
+      password: fountain
+    staging:
+      server_name: staging.fountainwiki.com
+      username: fountain
+      password:
+      monitor_delayed_job: true
+    production:
+      server_name: fountainwiki.com
+      password:
+      monitor_delayed_job: true
+
+  velocitytracking:
+    title: 'Velocity'
+    scm: git://github.com/PhilT/velocity.git
+    database: velocity
+    username: velocity
+    ssl: false
+    write_yml: true
+    development:
+      server_name: velocitytracking.dev
+      password: velocity
+    staging:
+      server_name: staging.velocitytracking.com
+      password:
+      cert: selfsigned
+    production:
+      server_name: velocitytracking.com
+      password:
+      cert: velocitytracking.com
+

data/machines.gemspec

@@ -0,0 +1,44 @@
+require 'base64'
+$LOAD_PATH << 'lib'
+require 'machines/version.rb'
+
+Gem::Specification.new do |s|
+  s.name        = 'machines'
+  s.version     = Machines::VERSION
+  s.authors     = 'Phil Thompson'
+  s.email       = Base64.decode64("cGhpbEBlbGVjdHJpY3Zpc2lvbnMuY29t\n")
+  s.homepage    = 'http://github.com/PhilT/machines'
+  s.summary     = 'Simple configuration of development, staging and production computers or images for cloud machines'
+  s.description = 'Install and configure Ubuntu desktops, laptops, servers and cloud instances. Install software, configure settings, preferences, keys, projects, applications, scripts, etc...'
+  s.required_rubygems_version = '>= 1.3.6'
+  s.platform    = Gem::Platform::RUBY
+  s.rubyforge_project = 'machines'
+
+  %w(activesupport app_conf highline i18n net-ssh net-scp).each do |name|
+    s.add_dependency name
+  end
+
+  %w(
+    bluecloth
+    guard
+    guard-bundler
+    guard-minitest
+    fakefs
+    fog
+    minitest
+    mocha
+    rake
+    rev
+    simplecov
+    yard
+  ).each do |name|
+    s.add_development_dependency name
+  end
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- spec/*`.split("\n")
+
+  s.executables  = ['machines']
+  s.require_path = 'lib'
+end
+

data/spec/acceptance/dev_machine_spec.rb

@@ -0,0 +1,22 @@
+require './spec/support/vm_control'
+require 'app_conf'
+
+@vm = VmControl.new
+system 'cd tmp && rm -rf acceptance_project'
+system 'reset && clear'
+
+begin
+  system 'cd tmp && ruby -I../lib ../bin/machines new acceptance_project'
+  system 'cd tmp/acceptance_project && ruby -I../../lib ../../bin/machines dryrun testvm'
+  system 'cat tmp/acceptance_project/log/output.log'
+
+  @vm.restore
+  @vm.start
+
+  system 'cd tmp/acceptance_project && ruby -I../../lib ../../bin/machines build testvm'
+  puts 'cat tmp/acceptance_project/log/output.log to see full log'
+
+ensure
+  @vm.kill
+end
+

data/spec/lib/machines/app_settings_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe 'AppSettings' do
+  include Machines::AppSettings
+
+  describe 'load_and_generate_passwords_for_webapps' do
+    it 'generates passwords and saves to webapps.yml' do
+      File.open('webapps.yml', 'w') {|f| f.puts "###\n\n---\nwebapps:\n  my_app:\n    development:\n      password: \n" }
+      stubs(:generate_password).returns 'random'
+      load_and_generate_passwords_for_webapps
+      File.read('webapps.yml').must_equal "###\n\n---\nwebapps:\n  my_app:\n    development:\n      password: random\n"
+    end
+  end
+
+  describe 'load_app_settings' do
+    before do
+      $conf.environment = :test
+      $conf.appsroot = '/home/user'
+      @settings = <<-EOF
+---
+webapps:
+  app:
+    scm: scm://project.git
+    test:
+      setting: setting
+      password: secure
+      cert: signed
+EOF
+      File.open('webapps.yml', 'w') {|f| f.puts @settings.gsub("      cert: signed\n", '') }
+    end
+
+    it 'loads the app settings for selected apps' do
+      load_app_settings ['app']
+      $conf.webapps.must_equal({
+        'app' => AppBuilder.new(
+          :scm => 'scm://project.git',
+          :name => 'app',
+          :path => '/home/user/app',
+          :root => '/home/user/app/current/public',
+          :setting => 'setting',
+          :password => 'secure'
+        )
+      })
+    end
+
+    it 'handles ssl settings' do
+      File.open('webapps.yml', 'w') {|f| f.puts @settings }
+      load_app_settings ['app']
+      $conf.webapps.must_equal({
+        'app' => AppBuilder.new(
+          :name => 'app',
+          :scm => 'scm://project.git',
+          :path => '/home/user/app',
+          :root => '/home/user/app/current/public',
+          :setting => 'setting',
+          :password => 'secure',
+          :ssl_key => 'signed.key',
+          :ssl_crt => 'signed.crt',
+          :cert => 'signed',
+          :ssl => true
+        )
+      })
+    end
+
+    it 'does not fail when settings not included for specified environment' do
+      File.open('webapps.yml', 'w') {|f| f.puts "---\nwebapps:\n  app:\n    path: path\n" }
+      load_app_settings(['app'])
+    end
+
+    it 'loads settings for all apps when none specified' do
+      settings = <<-EOF
+---
+webapps:
+  app:
+    scm: scm://project.git
+    test:
+      setting: setting
+      password: secure
+  other:
+    scm: scm://other_project
+    test:
+      setting: other_setting
+      password: secure
+      EOF
+      File.open('webapps.yml', 'w') {|f| f.puts settings }
+      load_app_settings nil
+      $conf.webapps.must_equal({
+        'app' => AppBuilder.new(
+          :name => 'app',
+          :path => '/home/user/app',
+          :scm => 'scm://project.git',
+          :root => '/home/user/app/current/public',
+          :setting => 'setting',
+          :password => 'secure'),
+        'other' => AppBuilder.new(
+          :name => 'other',
+          :root => '/home/user/other/current/public',
+          :scm => 'scm://other_project',
+          :path => '/home/user/other',
+          :setting => 'other_setting',
+          :password => 'secure')
+      })
+    end
+  end
+end
+

data/spec/lib/machines/checks_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe 'Checks' do
+  describe 'echo_result' do
+    it do
+      echo_result.must_equal '&& echo CHECK PASSED || echo CHECK FAILED'
+    end
+  end
+
+  describe 'package' do
+    it 'exists' do
+      check_package('package1').must_equal "dpkg --get-selections | grep package1.*install #{echo_result}"
+    end
+
+    it 'does not exist' do
+      check_package('package1', false).must_equal "dpkg --get-selections | grep package1.*deinstall #{echo_result}"
+    end
+  end
+
+  describe 'check_gem' do
+    it do
+      check_gem('gem').must_equal "gem search gem --installed #{echo_result}"
+    end
+
+    it do
+      check_gem('gem', '1.2.3').must_equal "gem search gem -v 1.2.3 --installed #{echo_result}"
+    end
+  end
+
+  describe 'check_file' do
+    it do
+      check_file('file').must_equal "test -s file #{echo_result}"
+    end
+
+    it do
+      check_file('file', false).must_equal "test ! -s file #{echo_result}"
+    end
+  end
+
+  describe 'check_link' do
+    it do
+      check_link('link').must_equal "test -L link #{echo_result}"
+    end
+  end
+
+  describe 'check_dir' do
+    it do
+      check_dir('dir').must_equal "test -d dir #{echo_result}"
+    end
+
+    it do
+      check_dir('dir', false).must_equal "test ! -d dir #{echo_result}"
+    end
+  end
+
+  describe 'check_perms' do
+    it do
+      check_perms('764', 'path').must_equal "ls -la path | grep rwxrw-r-- #{echo_result}"
+    end
+
+    it do
+      check_perms('235', 'path').must_equal "ls -la path | grep -w--wxr-x #{echo_result}"
+    end
+  end
+
+  describe 'check_owner' do
+    it do
+      check_owner('owner', 'path').must_equal "ls -la path | grep \"owner.*owner\" #{echo_result}"
+    end
+  end
+
+  describe 'check_string' do
+    it do
+      check_string('string', 'file').must_equal "grep \"string\" file #{echo_result}"
+    end
+  end
+
+  describe 'check_daemon' do
+    it do
+      check_daemon('daemon').must_equal "ps aux | grep daemon | grep -v grep #{echo_result}"
+    end
+
+    it do
+      check_daemon('daemon', false).must_equal "ps aux | grep daemon | grep -v grep | grep -v daemon #{echo_result}"
+    end
+  end
+
+  describe 'check_init_d' do
+    it do
+      check_init_d('name').must_equal "test -L /etc/rc0.d/K20name #{echo_result}"
+    end
+  end
+
+  describe 'check_command' do
+    it do
+      check_command('command', 'match').must_equal "command | grep match #{echo_result}"
+    end
+
+    it do
+      check_command('command').must_equal "command #{echo_result}"
+    end
+
+  end
+end
+

data/spec/lib/machines/cloud_machine_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'fog'
+
+describe 'CloudMachine' do
+  include Machines::CloudMachine
+
+  before do
+    Fog.mock!
+    $conf.from_hash(:cloud => {:provider => 'AWS', :aws_access_key_id => '123', :aws_secret_access_key => '456'})
+    $conf.from_hash(:machine => {:cloud => {:flavor_id => 't1-micro', :image_id => 'ami-11f0cc65', :region => 'eu-west-1'}})
+  end
+
+  it 'displays an error message when fog gem is not available' do
+    stubs(:require)
+    expects(:require).with('fog').raises LoadError
+    lambda do
+      begin
+        connect_to_cloud
+      rescue LoadError
+      end
+    end.must_output "fog gem required to use cloud features.
+Please \"gem install fog\".
+"
+  end
+
+  it 'sets correct options and connects' do
+    connect_to_cloud
+    $conf.cloud.connection.must_be_kind_of Fog::Compute::AWS::Mock
+  end
+
+  it 'creates a server' do
+    connect_to_cloud
+    create_server
+  end
+end
+

data/spec/lib/machines/command_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe Machines::Command do
+  subject { Machines::Command.new('command', 'check') }
+
+  describe 'initialize' do
+    it 'sets line, command, check' do
+      subject.command.must_equal 'command'
+      subject.check.must_equal 'check'
+    end
+  end
+
+  describe 'run' do
+    before(:each) do
+      $conf.commands = [subject]
+      @mock_ssh = mock 'Net::SSH'
+      @mock_ssh.stubs(:exec!).returns 'result'
+      @mock_ssh.stubs(:exec!).with('export TERM=linux && command').returns "result"
+      @mock_ssh.stubs(:exec!).with('export TERM=linux && check').returns "CHECK PASSED"
+      Machines::Command.ssh = @mock_ssh
+    end
+
+    it 'does not execute command when logging only' do
+      @mock_ssh.expects(:exec!).never
+      $conf.log_only = true
+      subject.run
+    end
+
+    describe 'check_result' do
+      it 'returns NOT CHECKED when nothing to execute' do
+        subject = Machines::Command.new('command', nil)
+        $conf.commands = [subject]
+        @mock_ssh.expects(:exec!).with(nil).never
+        subject.run
+
+        $console.next.must_equal "100% RUN    command\r"
+        $console.next.must_equal colored("100% RUN    command\n", :warning)
+
+        $file.next.must_equal colored("RUN    command\n", :highlight)
+        $file.next.must_equal "result\n"
+        $file.next.must_equal colored("NOT CHECKED\n", :warning)
+      end
+    end
+
+    describe 'logs' do
+      before(:each) do
+        $conf.log_only = false
+      end
+
+      it 'to screen using newline instead of return when logging only' do
+        $conf.log_only = true
+        subject.run
+
+        $console.next.must_equal "100% RUN    command\n"
+      end
+
+      it 'defaults screen logging to return' do
+        $conf.log_only = nil
+        subject.run
+
+        $console.next.must_equal "100% RUN    command\r"
+      end
+
+      it 'successful command to screen and file' do
+        subject.run
+
+        $console.next.must_equal "100% RUN    command\r"
+        $console.next.must_equal colored("100% RUN    command\n", :success)
+
+        $file.next.must_equal colored("RUN    command\n", :highlight)
+        $file.next.must_equal "result\n"
+        $file.next.must_equal colored("CHECK PASSED\n", :success)
+      end
+
+      it 'successful sudo command to screen and file' do
+        $conf.password = 'userpass'
+        @mock_ssh.stubs(:exec!).with("echo userpass | sudo -S bash -c 'export TERM=linux && check'").returns 'CHECK PASSED'
+        subject.use_sudo
+        subject.run
+
+        $console.next.must_equal "100% SUDO   command\r"
+        $console.next.must_equal colored("100% SUDO   command\n", :success)
+
+        $file.next.must_equal colored("SUDO   command\n", :highlight)
+        $file.next.must_equal "result\n"
+        $file.next.must_equal colored("CHECK PASSED\n", :success)
+      end
+
+      it 'unsuccesful command to screen and file' do
+        @mock_ssh.stubs(:exec!).with('export TERM=linux && check').returns "CHECK FAILED"
+
+        subject.run
+
+        $console.next.must_equal "100% RUN    command\r"
+        $console.next.must_equal colored("100% RUN    command\n", :failure)
+
+        $file.next.must_equal colored("RUN    command\n", :highlight)
+        $file.next.must_equal "result\n"
+        $file.next.must_equal colored("CHECK FAILED\n", :failure)
+      end
+
+      it 'ensure failures are always logged even when exceptions raised' do
+        @mock_ssh.expects(:exec!).with('export TERM=linux && check').raises Exception
+
+        lambda {subject.run}.must_raise Exception
+
+        $console.next.must_equal "100% RUN    command\r"
+        $console.next.must_equal colored("100% RUN    command\n", :failure)
+
+        $file.next.must_equal colored("RUN    command\n", :highlight)
+        $file.next.must_equal "result\n"
+        $file.next.must_equal colored("Exception\n", :failure)
+      end
+
+      it 'ensure logging failures do not stop app exiting gracefully' do
+        @mock_ssh.expects(:exec!).with('export TERM=linux && check').raises Exception
+        Machines::Command.file.stubs(:log)
+        Machines::Command.file.expects(:log).with('Exception', :color => :failure).raises ArgumentError
+        begin
+          subject.run
+        rescue Exception
+        rescue ArgumentError
+          flunk 'Expecting Exception to be raised but not ArgumentError'
+        end
+      end
+
+      it 'ensure console failures do not stop app exiting gracefully' do
+        @mock_ssh.expects(:exec!).with('export TERM=linux && check').raises Exception
+        Machines::Command.console.stubs(:log)
+        Machines::Command.console.expects(:log).with('100% RUN    command', :color => :failure).raises ArgumentError
+        begin
+          subject.run
+        rescue Exception
+        rescue ArgumentError
+          flunk 'Expecting Exception to be raised but not ArgumentError'
+        end
+      end
+    end
+
+    it 'wraps command execution in sudo with a password' do
+      $conf.password = 'userpass'
+      @mock_ssh.expects(:exec!).with("echo userpass | sudo -S bash -c 'export TERM=linux && command'").returns "result"
+
+      subject.use_sudo
+      subject.run
+    end
+
+    it 'wraps command execution in sudo with no password' do
+      @mock_ssh.expects(:exec!).with("sudo -S bash -c 'export TERM=linux && command'").returns "result"
+
+      subject.use_sudo
+      subject.run
+    end
+
+    it 'wraps check execution in sudo with a password' do
+      $conf.password = 'userpass'
+      @mock_ssh.expects(:exec!).with("echo userpass | sudo -S bash -c 'export TERM=linux && check'").returns 'CHECK PASSED'
+
+      subject.use_sudo
+      subject.run
+    end
+
+    it 'wraps check execution in sudo with no password' do
+      @mock_ssh.expects(:exec!).with("sudo -S bash -c 'export TERM=linux && check'").returns 'CHECK PASSED'
+
+      subject.use_sudo
+      subject.run
+    end
+  end
+
+  describe 'progress' do
+    it 'returns correct percentage' do
+      $conf.commands = 200.times.map { Machines::Command.new('command', 'check') }
+      $conf.commands[10].send('progress').must_equal '  6% '
+    end
+  end
+
+  describe 'info' do
+    it 'returns the command' do
+      subject.info.must_equal 'RUN    command'
+    end
+  end
+end
+