Merge pull request #45 from alt3/dev

Merge dev in preparation for release 1.0-alpha1

Author: bravo-kernel

.cakebox/.gitignore

@@ -1,5 +1,9 @@
 # Do not ignore anything in this subdirectory
 !*
 
-# Except the git cloned Cakebox Console directory
+# Except these file
+last-known-box-version
+
+# Except these directories
 console/
+backups/

.cakebox/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 ALT3 B.V.
+
+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.

.cakebox/VERSION.txt

@@ -1 +1 @@
-cakebox 0.1.1
+cakebox 1.0-alpha1

.cakebox/Vagrantfile.rb

@@ -2,27 +2,45 @@ class Cakebox
   def Cakebox.configure(config, user_settings)
     require 'vagrant/util/deep_merge'
     require 'json'
+    require 'tempfile'
+
+    # Use absolute paths to construct file paths to support Vagrant Lookup Path
+    # tree climbing (and thus running vagrant commands in any subfolder).
+    currentFolder = "#{File.dirname(__FILE__)}"
+    rootFolder = File.expand_path("..", currentFolder)
 
     # Define absolutely required box settings
     settings =  Hash.new
     settings["vm"] =  Hash.new
     settings["vm"]["hostname"] = "cakebox"
     settings["vm"]["ip"] = "10.33.10.10"
-    settings["vm"]["memory"] = 2048
+    settings["vm"]["memory"] = 1024
     settings["vm"]["cpus"] = 1
     settings["cakebox"] =  Hash.new
-    settings["cakebox"]["branch"] = "master"
+    settings["cakebox"]["version"] = "dev-master"
+
+    if user_settings == false
+        user_settings = Hash.new
+    end
 
-    # Prevent merging empty vm user settings
-    user_settings["vm"] = Hash.new if user_settings["vm"].nil?
-    user_settings["vm"]["hostname"] = settings["vm"]["hostname"] if user_settings["vm"]["hostname"].nil?
-    user_settings["vm"]["ip"] = settings["vm"]["ip"] if user_settings["vm"]["ip"].nil?
-    user_settings["vm"]["memory"] = settings["vm"]["memory"] if user_settings["vm"]["memory"].nil?
-    user_settings["vm"]["cpus"] = settings["vm"]["cpus"] if user_settings["vm"]["cpus"].nil?
-    user_settings["cakebox"]["branch"] = settings["cakebox"]["branch"] if user_settings["cakebox"]["branch"].nil?
+    # Deep merge user settings found in Cakebox.yaml. Uses the Vagrant Util
+    # class to prevent a Vagrant plugin dependency + our custom 'compact' Hash
+    # cleaner class to prevent non-DRY checking per setting.
+    settings = Vagrant::Util::DeepMerge.deep_merge(settings, user_settings.compact!)
+    settings.tildeConvert!
+
+    # Determine Cakebox Dashboard protocol only once
+    if settings['cakebox']['https'] == true
+      settings['cakebox']['protocol'] = 'https'
+    else
+      settings['cakebox']['protocol'] = 'http'
+    end
 
-    # Deep merge user settings found in Cakebox.yaml without plugin dependency
-    settings = Vagrant::Util::DeepMerge.deep_merge(settings, user_settings)
+    # Specify Vagrant post-up message
+    config.vm.post_up_message =
+      "Your box is ready and waiting.\n\n" +
+      "=> Login to your Dashboard by browsing to " + settings['cakebox']['protocol'] + '://' + settings["vm"]["ip"] + "\n" +
+      "=> Login to your virtual machine by running: vagrant ssh"
 
     # Specify CDN base-box and hostname for the vm
     config.vm.box = "cakebox"
@@ -41,9 +59,38 @@ def Cakebox.configure(config, user_settings)
       #vb.customize ["setextradata", :id, "VBoxInternal2/SharedFoldersEnableSymlinksCreate/v-root", "1"]
     end
 
-    # Mount small (and thus fast) scripts folder instead of complete box root folder.
+    # SSH copy bash aliases file to the box
+    config.vm.provision "file", source: currentFolder + File::SEPARATOR + "aliases", destination: "/home/vagrant/.bash_aliases"
+
+    # SSH copy local Cakebox.yaml to /home/vagrant/.cakebox when --provision is
+    # being used so it can be used for virtual machine information.
+    config.vm.provision "file", source: rootFolder + File::SEPARATOR + "Cakebox.yaml", destination: "/home/vagrant/.cakebox/last-known-cakebox-yaml"   #@todo
+
+    # SSH copy most recent local Git commit for alt3/cakebox to /home/vagrant/.cakebox
+    composerVersionParts = settings['cakebox']['version'].split('-')
+    if composerVersionParts[1].nil?
+      raise Vagrant::Errors::VagrantError.new, 'Fatal: unable to extract local git branch from composer version "'  + settings['cakebox']['version'] + '"'
+    end
+    headFile = rootFolder + File::SEPARATOR + ".git" + File::SEPARATOR + "refs" + File::SEPARATOR + "heads" + File::SEPARATOR + "dev"
+    config.vm.provision "file", source: headFile, destination: "/home/vagrant/.cakebox/last-known-cakebox-commit"
+
+    # Write vagrant box version to file before ssh copying to /home/vagrant/.cakebox
+    tempfile = Tempfile.new('last-known-box-version')
+    boxes = `vagrant box list`
+    boxes.match(/cakebox\s+\(virtualbox,\s(.+)\)/)
+    tempfile.write($1)
+    config.vm.provision "file", source: tempfile, destination: "/home/vagrant/.cakebox/last-known-box-version"
+    tempfile.close
+
+    # Mount small (and thus fast) scripts folder instead of complete box root folder
     config.vm.synced_folder '.', '/vagrant', disabled: true
-    config.vm.synced_folder '.cakebox', '/cakebox'
+    config.vm.synced_folder '.cakebox', '/cakebox', :mount_options => ["dmode=777","fmode=766"], create: true
+
+    # Temporarily mount .vagrant directory so we can replace the Vagrant 1.7.x
+    # secure private key until these issues are resolved:
+    # https://github.com/mitchellh/vagrant/issues/5090
+    # https://github.com/mitchellh/vagrant/issues/4967
+    config.vm.synced_folder '.vagrant', '/vagrant', :mount_options => ["dmode=777","fmode=766"], create: true
 
     # Create Vagrant Synced Folders for all yaml specified "folders".
     unless settings["synced_folders"].nil?
@@ -78,42 +125,46 @@ def Cakebox.configure(config, user_settings)
     # Replace insecure Vagrant ssh public key with user generated public key
     unless settings["security"].nil?
       unless settings["security"]["box_public_key"].nil?
+
         public_key = settings["security"]["box_public_key"]
         unless File.exists?(public_key)
-          raise Vagrant::Errors::VagrantError.new, "Fatal: your public ssh key does not exist (#{settings["security"]["box_public_key"]})"
+          raise Vagrant::Errors::VagrantError.new, "Fatal: your public SSH key does not exist (#{public_key})"
         end
 
-        # A public key MUST be an accompanied by a private key
+        # A public key MUST be accompanied by a private key
         if settings["security"]["box_private_key"].nil?
           raise Vagrant::Errors::VagrantError.new, "Fatal: using a public ssh key also requires specifying a local private ssh key in your Cakebox.yaml"
         end
-        unless File.exists?(settings["security"]["box_private_key"])
-          raise Vagrant::Errors::VagrantError.new, "Fatal: your private ssh key does not exist (#{settings["security"]["box_private_key"]})"
+
+        private_key = settings["security"]["box_private_key"]
+        unless File.exists?(private_key)
+          raise Vagrant::Errors::VagrantError.new, "Fatal: your private ssh key does not exist (#{private_key})"
         end
 
         # Copy user's public key to the vm so it can be validated and applied
-        config.vm.provision "file", source: settings["security"]["box_public_key"], destination: "/home/vagrant/.ssh/" + File.basename(settings["security"]["box_public_key"])
+        config.vm.provision "file", source: public_key, destination: "/home/vagrant/.ssh/" + File.basename(public_key)
 
         # Add user's private key to all Vagrant-usable local private keys so all
         # required login scenarios will keep functioning as expected:
         # - initial non-secure vagrant up
         # - users protecting their box with a personally generated public key
         config.ssh.private_key_path = [
-          '~/.vagrant.d/insecure_private_key',
-          settings["security"]["box_private_key"]
+          private_key,
+          Dir.home + '/.vagrant.d/insecure_private_key'
         ]
 
         # Run bash script to replace insecure public key in authorized_keys
         config.vm.provision "shell" do |s|
-          s.inline = "bash /cakebox/bash/replace-insecure-key.sh $@"
-          s.args = "/home/vagrant/.ssh/" + File.basename(settings["security"]["box_public_key"])
+          s.inline = "bash /cakebox/bash/ssh-authentication.sh $@"
+          s.args = [ File.basename(public_key), File.basename(private_key) ]
         end
+
+        # Prevent Vagrant 1.7.x from generating a new private key and inserting
+        # corresponding public key (overwriting our just set custom key).
+        config.ssh.insert_key = false
       end
     end
 
-    # SSH copy bash aliases file to the box
-    config.vm.provision "file", source: ".cakebox/aliases", destination: "/home/vagrant/.bash_aliases"
-
     # Always display SSH Agent Forwarding sanity checks
     config.vm.provision "shell" do |s|
       s.privileged = false
@@ -124,7 +175,31 @@ def Cakebox.configure(config, user_settings)
     config.vm.provision "shell" do |s|
       s.privileged = false
       s.inline = "bash /cakebox/bash/console-installer.sh $@"
-      s.args = user_settings["cakebox"]["branch"]
+      s.args = settings["cakebox"]["version"]
+    end
+
+    # Run cakebox self-update
+    config.vm.provision "shell" do |s|
+      s.privileged = false
+      s.inline = "bash /cakebox/console/bin/cake update self"
+    end
+
+    # Set Cakebox Dashboard protocol to HTTP or HTTPS
+    config.vm.provision "shell" do |s|
+      s.privileged = false
+      s.inline = "bash /cakebox/console/bin/cake config dashboard --force --protocol $@"
+      s.args = settings["cakebox"]["protocol"]
+    end
+
+    # Turn CakePHP debug mode on/off for Cakebox Commands and Dashboard
+    config.vm.provision "shell" do |s|
+      s.privileged = false
+      s.inline = "bash /cakebox/console/bin/cake config debug $@"
+      if settings["cakebox"]["debug"] == false
+        s.args = 'off'
+      else
+        s.args = 'on'
+      end
     end
 
     # Set global git username and email using `cakebox config git [options]`
@@ -143,14 +218,14 @@ def Cakebox.configure(config, user_settings)
       end
     end
 
-    # Create Nginx site configuration files for all yaml specified "sites"
-    unless settings["sites"].nil?
-      settings["sites"].each do |site|
+    # Create Nginx virtual hosts for all yaml specified "vhosts"
+    unless settings["vhosts"].nil?
+      settings["vhosts"].each do |vhost|
         config.vm.provision "shell" do |s|
           s.privileged = false
-          s.inline = "bash /cakebox/console/bin/cake site add $@"
-          s.args = [ site["url"], site["webroot"] ]
-          s.args.push(site["options"]) if !site["options"].nil?
+          s.inline = "bash /cakebox/console/bin/cake vhost add $@"
+          s.args = [ vhost["url"], vhost["webroot"] ]
+          s.args.push(vhost["options"]) if !vhost["options"].nil?
         end
       end
     end
@@ -167,34 +242,123 @@ def Cakebox.configure(config, user_settings)
       end
     end
 
-    # Install fully working framework applications for all yaml specified "apps"
+    # Install fully working framework applications for all yaml specified "apps".
+    # The --repair parameter is appended so only missing components will be
+    # installed when the sources already exist (e.g. when recreating a new box
+    # with existing sources in a mapped Synced Folder)
     unless settings["apps"].nil?
       settings["apps"].each do |app|
         config.vm.provision "shell" do |s|
           s.privileged = false
           s.inline = "bash /cakebox/console/bin/cake application add $@"
           s.args = [ app["url"] ]
           s.args.push(app["options"]) if !app["options"].nil?
+          s.args.push('--repair')
         end
       end
     end
 
-    # Install all yaml specified "additional_software" packages
-    unless settings["software"].nil?
-      settings["software"].each do |package|
-        config.vm.provision "shell" do |s|
-          s.privileged = false
-          s.inline = "bash /cakebox/console/bin/cake package add $@"
-          s.args = [ package["package"] ]
+    # Install extras
+    unless settings["extra"].nil?
+      settings["extra"].each do | hash |
+        hashKey = hash.keys.first
+        unless hash[hashKey].nil?
+
+          # Install additional apt packages from the Ubuntu Package Archive
+          if hashKey == "apt_packages"
+            hash[hashKey].each do | package |
+              config.vm.provision "shell" do |s|
+                s.privileged = false
+                s.inline = "bash /cakebox/console/bin/cake package add $@"
+                s.args = [package]
+              end
+            end
+          end
+
+          # Upload and run user created bash scripts
+          if hashKey == "scripts"
+            hash[hashKey].each do | script |
+              remoteCopy = "/home/vagrant/.cakebox/last-known-script." + File.basename(script.to_s)
+              config.vm.provision "file", source: script, destination: remoteCopy
+              config.vm.provision "shell" do |s|
+                s.privileged = false
+                s.inline = "bash " + remoteCopy
+              end
+            end
+          end
         end
       end
     end
 
-    # Provide user with box-info
-    config.vm.provision "shell" do |s|
-        s.inline = "bash /cakebox/bash/box-info.sh $@"
-        s.args = [ settings["vm"]["ip"] ]
+  end
+end
+
+
+
+# Hash cleaner, removes nil/empty values recursively from a hash.
+#
+# Very handy to avoid errors when user yaml file does not include all required parts
+# After removing nil values, it can safely be deep merged into default settings,
+# without the need to check for all keys being present or having a value
+class Hash
+  def compact!
+    self.delete_if do |key, val|
+
+      if block_given?
+        yield(key,val)
+      else
+        test1 = val.nil?
+        test2 = val.empty? if val.respond_to?('empty?')
+        test3 = val.strip.empty? if val.is_a?(String) && val.respond_to?('empty?')
+
+        test1 || test2 || test3
+      end
+    end
+
+    self.each do |key, val|
+      if self[key].is_a?(Hash) && self[key].respond_to?('compact!')
+        if block_given?
+          self[key] = self[key].compact!(&Proc.new)
+        else
+          self[key] = self[key].compact!
+        end
+      end
     end
 
+    return self
+  end
+end
+
+# Recursively searches a Hash for Strings starting with ~ and then replaces ~
+# with OS independent Dir.home so we can support the use of ~ on Windows too.
+class Hash
+  def tildeConvert!
+    self.each do | key, value |
+
+      if value.is_a?(String)
+        if ( value =~ /^~/ )
+          self[key] = value.sub(/^~/, Dir.home)
+        end
+      end
+
+      if value.is_a?(Array)
+        value.each_with_index do | arrayElement, i |
+          if arrayElement.is_a?(String)
+            if ( arrayElement =~ /^~/ )
+              self[key][i] = arrayElement.sub(/^~/, Dir.home)
+            end
+          end
+
+          if arrayElement.is_a?(Hash)
+            arrayElement.tildeConvert!
+          end
+        end
+      end
+
+      if value.is_a?(Hash)
+        value.tildeConvert!
+      end
+
+    end
   end
 end

.cakebox/backups/README.md

@@ -0,0 +1,5 @@
+# Backups
+
+This directory will be used for backups of your:
+
++ MySQL database server (full)

.cakebox/bash/README.md

@@ -0,0 +1 @@
+Bash scripts used by ``.cakebox/Vagrantfile.rb`` when running ``vagrant --provision``.