machines 0.5.1

data/spec/lib/machines/file_operations_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe 'FileOperations' do
+  include Machines::FileOperations
+  include Machines::Core
+
+  describe 'append' do
+    it 'escapes backslashes (\\)' do
+      subject = append '\\', :to => 'file'
+      subject.command.must_match /"\\\\"/
+    end
+
+    it 'escapes dollar sign ($)' do
+      subject = append '$', :to => 'file'
+      subject.command.must_match /"\\\$\"/
+    end
+
+    it 'escapes double quotes (")' do
+      subject = append '"', :to => 'file'
+      subject.command.must_match /"\\""/
+    end
+
+    it 'escapes backticks (`)' do
+      subject = append '`', :to => 'file'
+      subject.command.must_match /"\\`"/
+    end
+
+    it 'appends to a file' do
+      subject = append 'string', :to => 'file'
+      subject.command.must_match /echo ".*" >> file/
+    end
+
+    it 'adds to a file with specified content including escaped characters' do
+      subject = append '\\$"`', :to => 'file'
+      subject.command.must_equal 'grep "\\\\\\$\\"\\`" file || echo "\\\\\\$\\"\\`" >> file'
+    end
+
+    it 'checks text was added' do
+      subject = append 'something', :to => 'file'
+      subject.check.must_equal "grep \"something\" file #{echo_result}"
+    end
+  end
+
+  describe 'chmod' do
+    subject { chmod(644, 'path') }
+    it { subject.command.must_equal 'chmod 644 path' }
+
+    describe 'when mode is a string' do
+      subject { chmod('644', 'path') }
+      it { subject.command.must_equal 'chmod 644 path' }
+    end
+  end
+
+  describe 'chown' do
+    it { chown('owner', 'path').command.must_equal 'chown owner:owner path' }
+    it { chown('user:group', 'path').command.must_equal 'chown user:group path' }
+  end
+
+  describe 'copy' do
+    subject { copy('from', 'to') }
+    it { subject.command.must_equal 'cp -rf from to' }
+  end
+
+  describe 'create_from' do
+    include Machines::AppSettings
+
+    it 'loads ERB template, applies settings and writes to remote machine' do
+      File.expects(:read).with('erb_path').returns('<%= method_on_binding %>')
+      app_builder = AppBuilder.new(:method_on_binding => 'result')
+      expects(:write).with('result', {:settings => app_builder, :to => 'file', :name => 'erb_path'})
+      create_from('erb_path', :settings => app_builder, :to => 'file')
+    end
+  end
+
+  describe 'link' do
+    subject { link 'target', 'link' }
+    it {subject.command.must_equal 'ln -sf target link'}
+  end
+
+  describe 'mkdir' do
+    it 'creates a mkdir command for a single path' do
+      mkdir('path').first.command.must_equal 'mkdir -p path'
+    end
+
+    it 'creates a mkdir command for a multiple paths' do
+      mkdir('path1', 'path2').map(&:command).must_equal ['mkdir -p path1', 'mkdir -p path2']
+    end
+
+    it 'creates a mkdir command for an array of paths' do
+      mkdir(['path1', 'path2']).map(&:command).must_equal ['mkdir -p path1', 'mkdir -p path2']
+    end
+   end
+
+  describe 'rename' do
+    subject { rename('oldname', 'newname') }
+    it { subject.command.must_equal 'mv -f oldname newname' }
+  end
+
+  describe 'remove' do
+    subject { remove 'file' }
+    it { subject.command.must_equal 'rm -rf file' }
+  end
+
+  describe 'remove_version_info' do
+    subject { remove_version_info 'name' }
+    it { subject.command.must_equal "find . -maxdepth 1 -name \"name*\" -a -type d | xargs -I xxx mv xxx name" }
+  end
+
+  describe 'replace' do
+    subject { replace('something', :with => 'some/path', :in => 'file') }
+    it { subject.command.must_equal "sed -i \"s/something/some\\/path/\" file" }
+    it { lambda{replace('something')}.must_raise ArgumentError }
+  end
+
+  describe 'write' do
+    it 'uploads from a buffer' do
+      mock_named_buffer = mock 'NamedBuffer'
+      NamedBuffer.expects(:new).with('name', 'something').returns mock_named_buffer
+      subject = write('something', :to => 'a_file', :name => 'name')
+      subject.local.must_equal mock_named_buffer
+    end
+  end
+end
+

data/spec/lib/machines/help_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Machines::Help do
+  subject { Machines::Help.new }
+
+  describe 'actions' do
+    it { subject.actions.must_equal ['htpasswd', 'new', 'dryrun', 'tasks', 'build', 'list', 'packages', 'override'] }
+  end
+
+  describe 'syntax' do
+    it 'includes version' do
+      subject.syntax.must_match /machines v0\.[0-9]+\.[0-9]+ - Ubuntu\/Ruby configuration tool\./
+    end
+
+    it 'includes syntax' do
+      subject.syntax.must_match /machines COMMAND/
+      subject.syntax.must_match /COMMAND can be:/
+      subject.syntax.must_match /build <machine> \[task\]   Builds your chosen machine\. Optionally, build just one task/
+    end
+  end
+end
+

data/spec/lib/machines/installation_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+describe 'Installation' do
+  include Machines::Core
+  include Machines::Installation
+  include Machines::Configuration
+
+  describe 'add_ppa' do
+    it 'adds a ppa' do
+      subject = add_ppa 'user/name', 'key'
+      subject.map(&:command).must_equal ['add-apt-repository ppa:user/name', 'apt-get -q -y update > /tmp/apt-update.log']
+    end
+  end
+
+  describe 'deb' do
+    it 'adds to /etc/apt/sources and add a key' do
+      subject = deb 'source', :key => 'gpg', :name => 'name'
+      subject.map(&:command).must_equal [
+        "echo deb source >> /etc/apt/sources.list",
+        "wget -q gpg -O - | apt-key add -",
+        "apt-get -q -y update > /tmp/apt-update.log"
+      ]
+      subject.map(&:check).must_equal [
+        "grep \"source\" /etc/apt/sources.list #{echo_result}",
+        "apt-key list | grep -i name #{echo_result}",
+        "grep \"Reading package lists\" /tmp/apt-update.log #{echo_result}"
+      ]
+    end
+
+    it 'modifies echo command to grab the distribution name to be used in the source' do
+      subject = deb 'source YOUR_UBUNTU_VERSION_HERE', :key => 'gpg', :name => 'name'
+      subject.first.command.must_equal 'expr substr `cat /etc/lsb-release | grep DISTRIB_CODENAME` 18 20 | xargs -I YOUR_UBUNTU_VERSION_HERE echo deb source YOUR_UBUNTU_VERSION_HERE >> /etc/apt/sources.list'
+    end
+  end
+
+  describe 'debconf' do
+    it 'sends args to debconf-set-selections' do
+      subject = debconf 'app', 'setting', 'boolean', true
+      subject.command.must_equal 'echo app setting boolean true | debconf-set-selections'
+    end
+  end
+
+  describe 'extract' do
+    it 'instaniates commands to download, extract and remove a tar archive' do
+      subject = extract 'http://url/package.tar'
+      subject.command.must_equal 'cd /usr/local/src && wget http://url/package.tar && tar -zxf package.tar && rm package.tar && cd -'
+      subject.check.must_equal 'test -d /usr/local/src/package && echo CHECK PASSED || echo CHECK FAILED'
+    end
+
+    it 'instaniates commands to download, extract and remove a zip archive' do
+      subject = extract 'http://url/package.zip'
+      subject.command.must_equal 'cd /usr/local/src && wget http://url/package.zip && unzip -qq package.zip && rm package.zip && cd -'
+      subject.check.must_equal 'test -d /usr/local/src/package && echo CHECK PASSED || echo CHECK FAILED'
+    end
+
+    it 'moves extracted contents to specified folder' do
+      subject = extract 'http://url/package-1.0.tar.gz', :to => '/opt'
+      subject.command.must_equal 'cd /opt && wget http://url/package-1.0.tar.gz && tar -zxf package-1.0.tar.gz && rm package-1.0.tar.gz && cd -'
+      subject.check.must_equal 'test -d /opt/package-1.0 && echo CHECK PASSED || echo CHECK FAILED'
+    end
+  end
+
+  describe 'gem' do
+    it 'instaniates a command to install a gem' do
+      subject = gem 'package'
+      subject.command.must_equal 'gem install package'
+    end
+
+    it 'instaniates a command to install a gem with a specified version' do
+      subject = gem 'package', :version => '1'
+      subject.command.must_equal "gem install package -v \"1\""
+    end
+  end
+
+  describe 'gem_update' do
+    it 'instaniates a command to update gems' do
+      subject = gem_update 'gem'
+      subject.command.must_equal 'gem update gem'
+    end
+  end
+
+  describe 'git_clone' do
+    it 'instaniates a command to clone a git repository' do
+      subject = git_clone 'http://git_url.git'
+      subject.command.must_equal 'git clone --quiet http://git_url.git'
+    end
+
+    it 'instaniates a command to clone a git repository to a specified folder' do
+      subject = git_clone 'http://git_url.git', :to => 'dir'
+      subject.command.must_equal 'git clone --quiet http://git_url.git dir'
+    end
+
+    it 'raises when no url supplied' do
+      lambda { git_clone '' }.must_raise ArgumentError
+      lambda { git_clone nil }.must_raise ArgumentError
+    end
+
+    describe ':branch option' do
+      it 'clones to a specific branch' do
+        subject = git_clone 'http://git_url.git', :branch => 'other'
+        subject.command.must_equal 'git clone --quiet --branch other http://git_url.git'
+      end
+    end
+
+    describe ':tag option' do
+      it 'checks out a specific tag' do
+        subject = git_clone 'http://git_url.git', :to => 'dir', :tag => 'v1.0'
+        subject.map(&:command).must_equal [
+          'git clone --quiet http://git_url.git dir',
+          'cd dir && git checkout v1.0'
+        ]
+      end
+
+      it 'raises when no dir' do
+        lambda { git_clone 'http://git_url.git', :tag => 'v1.0' }.must_raise ArgumentError
+      end
+    end
+  end
+
+  describe 'install' do
+    it 'instaniates commands to download, install and remove a DEB package ' do
+      subject = install "http://some.url/package_name.deb"
+      subject.map(&:command).must_equal [
+        'cd /tmp && wget http://some.url/package_name.deb && dpkg -i --force-architecture package_name.deb && rm package_name.deb && cd -'
+      ]
+    end
+
+    it 'instaniates commands to download, extract, install and remove a group of DEB packages ' do
+      subject = install "http://some.url/package_name.tar.gz"
+      subject.map(&:command).must_equal [
+        'cd /tmp && wget http://some.url/package_name.tar.gz && tar -zxf package_name.tar.gz && rm package_name.tar.gz && cd -',
+        'cd /tmp/package_name && dpkg -i --force-architecture *.deb && cd - && rm -rf /tmp/package_name'
+      ]
+    end
+
+    it 'instaniates a command to install a single apt package' do
+      subject = install 'package1'
+      subject.map(&:command).must_equal ['apt-get -q -y install package1']
+    end
+
+    it 'instaniates a command to install multiple apt packages' do
+      subject = install %w(package1 package2)
+      subject.map(&:command).must_equal [
+        'apt-get -q -y install package1',
+        'apt-get -q -y install package2'
+      ]
+    end
+  end
+
+  describe 'uninstall' do
+    it 'instaniates a command to uninstall a package' do
+      subject = uninstall %w(apackage)
+      subject.map(&:command).must_equal ['apt-get -q -y purge apackage']
+    end
+  end
+
+  describe 'update' do
+    it 'instaniates a command to update apt' do
+      subject = update
+      subject.command.must_equal 'apt-get -q -y update > /tmp/apt-update.log'
+    end
+  end
+
+  describe 'upgrade' do
+    it 'instaniates a command to upgrade apt' do
+      subject = upgrade
+      subject.map(&:command).must_equal [
+        'apt-get -q -y update',
+        'apt-get -q -y upgrade',
+        'apt-get -q -y autoremove',
+        'apt-get -q -y autoclean'
+      ]
+    end
+  end
+end
+

data/spec/lib/machines/log_command_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Machines::LogCommand do
+  subject {Machines::LogCommand.new :name, 'description'}
+
+  it 'logs the name and description' do
+    $conf.commands = [subject]
+    subject.run
+    $console.next.must_equal "\n"
+    $console.next.must_equal colored("     TASK   name - description\n", :info)
+
+    $file.next.must_equal "\n"
+    $file.next.must_equal colored("TASK   name - description\n", :info)
+  end
+end
+

data/spec/lib/machines/logger_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Machines::Logger do
+  before(:each) do
+    $conf.machine = AppConf.new
+    $conf.machine.user = 'www'
+    $conf.commands = [1,2,3]
+  end
+
+  describe 'logging to screen' do
+    it 'logs first line only' do
+      Machines::Command.console.log %(something with "some text\nsome more\nand "lets quote" this one" > and some output)
+      $console.next.must_equal %(something with "some text..." > and some output\n)
+    end
+
+    it 'truncates lines longer than screen width' do
+      $terminal.stubs(:output_cols).returns 10
+      Machines::Command.console.log "A line that's longer than the screen width", :newline => false
+      $console.next.must_equal "A line...\r"
+    end
+  end
+
+  describe 'logging to file' do
+    it 'logs all lines' do
+      Machines::Command.file.log %(something with "some text\nsome more\nand "lets quote" this one" > and some output)
+      $file.next.must_equal %(something with "some text\nsome more\nand "lets quote" this one" > and some output\n)
+    end
+  end
+
+  describe 'log' do
+    it 'does not error when no message' do
+      Machines::Command.file.log nil
+      $file.next.must_equal "(no message)\n"
+    end
+
+    it 'returns to the beginning of the line when no newline' do
+      Machines::Command.console.log 'message', :newline => false
+      $console.next.must_equal "message\r"
+    end
+
+    it 'sends the command and line number' do
+      Machines::Command.file.log 'command'
+      $file.next.must_equal "command\n"
+    end
+
+    it 'displays message in specified color' do
+      Machines::Command.file.log 'command', :color => :yellow
+      $file.next.must_equal colored("command\n", :yellow)
+    end
+
+    it 'does not show passwords' do
+      $conf.passwords = ['a_password', 'another password']
+      Machines::Command.file.log 'something with a_password and another password in'
+      $file.next.must_equal "something with ***** and ***** in\n"
+    end
+
+    it 'displays newline when empty message' do
+      Machines::Command.file.log ''
+      $file.next.must_equal "\n"
+    end
+
+    it 'flushes the file' do
+      mock_file = mock 'File'
+      subject = Machines::Logger.new(mock_file)
+      mock_file.expects(:flush)
+      subject.flush
+    end
+  end
+end
+

data/spec/lib/machines/machinesfile_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'Machinesfile' do
+  include Machines::Machinesfile
+
+  describe 'package' do
+    it 'raises specific error when failing to load Machinesfile' do
+      File.expects(:read).never
+      lambda{ package 'Machinesfile' }.must_raise LoadError, /Cannot find Machinesfile/
+    end
+
+    it 'loads custom package when it exists' do
+      custom_package = "packages/custom_package.rb"
+      FileUtils.mkdir_p File.dirname(custom_package)
+      FileUtils.touch custom_package
+      File.expects(:read).with(custom_package).returns ''
+      package :custom_package
+    end
+
+    it 'loads built-in package when no custom package' do
+      builtin_package = "#{$conf.application_dir}/packages/builtin_package.rb"
+      FileUtils.mkdir_p File.dirname(builtin_package)
+      FileUtils.touch builtin_package
+      File.expects(:read).with(builtin_package).returns ''
+      package :builtin_package
+    end
+
+    it 'raises when no custom and no built-in package' do
+      File.expects(:read).never
+      lambda { package :builtin_package}.must_raise LoadError, /Cannot find .* package builtin_package/
+    end
+  end
+end
+

data/spec/lib/machines/questions_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'Questions' do
+  include Machines::Questions
+
+  describe 'enter_password' do
+    before(:each) do
+      stubs(:ask).returns 'pa55word'
+    end
+
+    it 'does not echo output' do
+      mock_question = mock 'HighLine::Question'
+      mock_question.expects(:echo=).with(false).twice
+      stubs(:ask).yields(mock_question).returns 'pa55word'
+      enter_password 'type'
+    end
+
+    it 'prompts for a password' do
+      expects(:ask).with('Enter type password: ').once.returns 'pa55word'
+      enter_password('type')
+    end
+
+    it 'returns password' do
+      enter_password('type').must_equal 'pa55word'
+    end
+
+    it 'adds to password list' do
+      enter_password('type')
+      $conf.passwords.must_equal ['pa55word']
+    end
+
+    it 'does not add password less than 5 characters to password list' do
+      stubs(:ask).returns 'pass'
+      enter_password('type')
+      $conf.passwords.must_equal []
+    end
+
+    it 'does not add password if it is "password"' do
+      stubs(:ask).returns 'password'
+      enter_password('type')
+      $conf.passwords.must_equal []
+    end
+
+    it 'repeats until password and confirmation match' do
+      expects(:ask).with('Enter type password: ').twice.returns 'pa55word'
+      expects(:ask).with('Confirm the password: ').twice.returns 'pas', 'pa55word'
+      expects(:say).with('Passwords do not match, please re-enter')
+      enter_password('type').must_equal 'pa55word'
+    end
+
+    it 'only asks once when confirm set to false' do
+      expects(:ask).with('Enter type password: ').once.returns 'pa55word'
+      expects(:ask).with('Confirm the password: ').never
+      enter_password('type', false)
+    end
+
+    it 'password still added to list when not confirming' do
+      enter_password('type', false)
+      $conf.passwords.must_equal ['pa55word']
+    end
+
+    it 'password still returned when not confirming' do
+      enter_password('type', false).must_equal 'pa55word'
+    end
+
+    it 'do not add to passwords list if not available' do
+      $conf.passwords = nil
+      enter_password('type')
+      $conf.passwords.must_equal nil
+    end
+  end
+end
+

data/spec/lib/machines/services_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'Services' do
+  include Machines::Core
+  include Machines::FileOperations
+  include Machines::Services
+
+  describe 'restart' do
+    subject { restart 'daemon' }
+    it { subject.command.must_equal 'service daemon restart' }
+  end
+
+  describe 'start' do
+    it 'start daemon and check it runs' do
+      subject = start 'daemon'
+      subject.command.must_equal 'service daemon start'
+      subject.check.must_equal 'ps aux | grep daemon | grep -v grep && echo CHECK PASSED || echo CHECK FAILED'
+    end
+
+    it 'start daemon with custom check' do
+      subject = start 'daemon', :check => 'check'
+      subject.check.must_equal 'check'
+    end
+  end
+end
+

data/spec/lib/machines/upload_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Machines::Upload do
+  subject { Machines::Upload.new('local', 'remote', 'check') }
+
+  describe 'initialize' do
+    it 'sets line, local, remote and check' do
+      subject.command.must_equal nil
+      subject.local.must_equal 'local'
+      subject.remote.must_equal 'remote'
+      subject.check.must_equal 'check'
+    end
+  end
+
+  describe 'run' do
+    before(:each) do
+      $conf.commands = [subject]
+      $conf.log_only = false
+      @mock_ssh = mock 'Net::SSH'
+      @mock_scp = stub 'Net::SCP'
+      Machines::Command.ssh = @mock_ssh
+      Machines::Command.scp = @mock_scp
+      @mock_ssh.stubs(:exec!).with('export TERM=linux && check').returns "CHECK PASSED"
+    end
+
+    it 'uploads local to remote with logging' do
+      @mock_scp.expects(:upload!).with('local', 'remote', {:recursive => false})
+      subject.run
+
+      $file.next.must_equal colored("UPLOAD local to remote\n", :highlight)
+      $file.next.must_equal colored("CHECK PASSED\n", :success)
+      $console.next.must_equal "100% UPLOAD local to remote\r"
+      $console.next.must_equal colored("100% UPLOAD local to remote\n", :success)
+    end
+
+    it 'logs with newline when logging only' do
+      @mock_scp.stubs(:upload!)
+      $conf.log_only = true
+      subject.run
+
+      $console.next.must_equal "100% UPLOAD local to remote\n"
+    end
+
+    it 'logs with return when log_only not specified' do
+      @mock_scp.stubs(:upload!)
+      $conf.log_only = nil
+      subject.run
+
+      $console.next.must_equal "100% UPLOAD local to remote\r"
+    end
+
+    it 'uploads a folder source' do
+      FileUtils.mkdir_p('local')
+      @mock_scp.expects(:upload!).with('local', 'remote', {:recursive => true})
+
+      subject.run
+    end
+
+    it 'uploads an in memory buffer' do
+      buffer = NamedBuffer.new('name', 'a buffer')
+      subject = Machines::Upload.new(buffer, 'remote', 'check')
+      $conf.commands = [subject]
+      @mock_scp.expects(:upload!).with(buffer, 'remote', {:recursive => false})
+      subject.run
+    end
+  end
+
+  describe 'info' do
+    it 'contains source and destination paths and UPLOAD' do
+      subject.info.must_equal 'UPLOAD local to remote'
+    end
+
+    describe 'when local is a buffer' do
+      subject { Machines::Upload.new(NamedBuffer.new('name', 'a buffer'), 'remote', 'check') }
+      it 'contains name of the buffer' do
+        subject.info.must_equal 'UPLOAD buffer from name to remote'
+      end
+
+      it 'handles nil names' do
+        subject = Machines::Upload.new(NamedBuffer.new(nil, 'a buffer'), 'remote', 'check')
+        subject.info.must_equal "UPLOAD unnamed buffer to remote"
+      end
+    end
+  end
+end
+

data/spec/lib/packages/abiword_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'packages/apps' do
+  before(:each) do
+    load_package('abiword')
+  end
+
+  it 'adds the following commands' do
+    eval_package
+    $conf.commands.map(&:info).must_equal [
+      "TASK   abiword - Install a lightweight word processor",
+      "SUDO   apt-get -q -y install abiword",
+      "TASK   abiword_associations - Setup file associations for Abiword",
+      "RUN    grep \"application/x-abiword=abiword.desktop\" .local/share/applications/mimeapps.list || echo \"application/x-abiword=abiword.desktop\" >> .local/share/applications/mimeapps.list",
+      "RUN    grep \"application/msword=abiword.desktop\" .local/share/applications/mimeapps.list || echo \"application/msword=abiword.desktop\" >> .local/share/applications/mimeapps.list",
+      "RUN    grep \"application/rtf=abiword.desktop\" .local/share/applications/mimeapps.list || echo \"application/rtf=abiword.desktop\" >> .local/share/applications/mimeapps.list"
+    ]
+  end
+end
+

data/spec/lib/packages/amazon_mp3_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'packages/amazon_mp3' do
+  before(:each) do
+    load_package('amazon_mp3')
+  end
+
+  it 'adds the following commands' do
+    eval_package
+    $conf.commands.map(&:info).must_equal [
+      "TASK   amazon_mp3 - Download and install MP3 downloader from Amazon",
+      "SUDO   cd /tmp && wget http://www.hilltopyodeler.com/packages/AmazonMP3-InstallerForUbuntuNewerThan-9.04.tar.gz && tar -zxf AmazonMP3-InstallerForUbuntuNewerThan-9.04.tar.gz && rm AmazonMP3-InstallerForUbuntuNewerThan-9.04.tar.gz && cd -",
+      "SUDO   cd /tmp/AmazonMP3-InstallerForUbuntuNewerThan-9.04 && dpkg -i --force-architecture *.deb && cd - && rm -rf /tmp/AmazonMP3-InstallerForUbuntuNewerThan-9.04"
+    ]
+  end
+end
+