kikubari 0.0.3 → 0.0.4

data/lib/deployer/deployer.rb

@@ -5,67 +5,65 @@
 # On deployment config (<em>deploy.yml</em>) can be setted the actions to be done one the code gathering is successfull. Then tipically the system would make come backups task, link some folder and files.
 #
 # Author::    Jose A Pio  (mailto:josetonyp@gmail.com)
-# Copyright:: Copyright (c) 2011 
+# Copyright:: Copyright (c) 2011
 # License::   Distributes under the same terms as Ruby
 module Kikubari
-  
   class Deploy
-    
     class Deployer
-      
+
       attr_accessor :config
-      
+
       def initialize(config)
         @config = config
         @logger = Logger.new
       end
-      
+
       ##
       # Create te the folder structure as is in the YAML
       #
       def create_structure
         @config.do["folder_structure"].each do |command|
           unless File.directory? command.first[1]
-            p "Creating Structure folder: #{command.first[1]} ..."
+            @logger.print "Creating Structure folder: #{command.first[1]}"
             FileUtils.mkdir_p command.first[1]
           end
         end
         self
       end
-      
-      
+
+
       ##
       # Create the environment folder as requested in the configuration
       #
       def create_environment_folder
         environment = @config.environment
         unless File.directory? @config.environment_folder
-          p "Creating Environment folder: #{ @config.environment_folder} ..."
+          @logger.print "Creating Environment folder: #{ @config.environment_folder}"
           FileUtils.mkdir_p  @config.environment_folder
         end
         self
       end
-      
+
       ##
-      # Create the folder where you will deploy the actual version of the code based on the configuration 
+      # Create the folder where you will deploy the actual version of the code based on the configuration
       #
       def create_version_folder
         FileUtils.mkdir_p(@config.env_time_folder) unless File.directory? @config.env_time_folder
         self
       end
-      
+
       ##
       # Create the current symlink to the deploy version folder
       #
       def create_current_symlink_folder
-        destination = @config.current_deploy_folder 
+        destination = @config.current_deploy_folder
         origin =  Pathname.new( @config.env_time_folder ).relative_path_from( Pathname.new( @config.current_deploy_folder.gsub(/\/[^\/]*?$/, "") ) ).to_s
         FileUtils.rm_f(destination) if File.symlink?(destination)
         FileUtils.ln_s origin, destination
         self
       end
-      
-      
+
+
       ##
       # Test if selected file already exist
       #
@@ -78,39 +76,39 @@ module Kikubari
         end
         self
       end
-      
+
       ##
       # Create the Symlinked folders
       #
       def create_sylinked_folders
           @config.do["folder_symbolic_links"].each do |folder|
-            p "- creating: #{@config.env_time_folder}/#{folder[1]}"
-            raise "Folder: #{@config.env_time_folder}/#{folder[1]} already exists and the symlink can't be created" if File.directory?("#{@config.env_time_folder}/#{folder[1]}") 
-            create_symlink( folder ) 
+            @logger.print "- linking: #{@config.env_time_folder}/#{folder[1]}"
+            raise "Folder: #{@config.env_time_folder}/#{folder[1]} already exists and the symlink can't be created" if File.directory?("#{@config.env_time_folder}/#{folder[1]}")
+            create_symlink( folder )
           end
           self
       end
-      
+
       ##
       # Execute creation of symlinked folder
       #
       def create_symlink( folder )
         destination = "#{@config.env_time_folder}/#{folder[1]}"
-        raise ArgumentError , "Origin folder #{"#{@config.get_structure_folder(folder[0])}"} is not a valid folder" unless File.directory?("#{@config.get_structure_folder(folder[0])}")
+        raise ArgumentError , "Origin folder #{@config.get_structure_folder(folder[0])} is not a valid folder" unless File.directory?("#{@config.get_structure_folder(folder[0])}")
         origin = Pathname.new( "#{@config.get_structure_folder(folder[0])}" ).relative_path_from( Pathname.new( destination.gsub(/\/[^\/]*?$/, "") ) ).to_s  ## Origin as a relative path from destination
         FileUtils.ln_s origin, destination
       end
-  
+
       def create_symlinked_files
-        p "Creating Files symbolic links ..."
+        @logger.print "Creating Files symbolic links"
         @config.do["file_symbolic_link"].each do |folder|
           destination = "#{@config.env_time_folder}/#{folder[1]}"
           origin = Pathname.new( "#{@config.get_test_file(folder[0])}" ).relative_path_from(Pathname.new( destination.gsub(/\/[^\/]*?$/, "") )).to_s
           FileUtils.ln_s  origin , destination
         end
       end
-      
-      
+
+
       ##
       # Create deployment structure
       #
@@ -119,19 +117,19 @@ module Kikubari
         create_environment_folder.create_version_folder
         self
       end
-      
+
       ##
       # Rotate old version folders
       #
       def rotate_folders
         DeployDir.rotate_folders( @config.environment_folder , @config.config["history_limit"] )
       end
-      
-      
+
+
       def has_after_deploy_run_commands
         @config.after.has_key?("run") && !@config.after["run"].empty?
       end
-      
+
       ##
       # Run comand line script after deploy
       #
@@ -144,12 +142,12 @@ module Kikubari
         end
         out
       end
-      
-      
+
+
       def has_before_deploy_run_commands
         @config.before.has_key?("run") && !@config.before["run"].empty?
       end
-      
+
       def before_deploy_run
         return unless has_before_deploy_run_commands
         out = Array.new
@@ -159,21 +157,21 @@ module Kikubari
         end
         out
       end
-      
+
       def execute_shell(command)
-        @logger.run(command, @config.env_time_folder) 
+        @logger.run(command, @config.env_time_folder)
         temp = capture_stderr "cd #{@config.env_time_folder} ; #{command} "
         @logger.result(temp[:stdout]) if temp[:stdout] != ""
         @logger.error(temp[:stderr]) if temp[:stderr] != ""
         temp
       end
-      
-      
+
+
       def capture_stderr ( command )
        stdin, stdout, stderr = Open3.popen3( command )
        ({ :stdout => stdout.readlines.join(""), :stderr => stderr.readlines.join("") })
       end
-      
+
       ##
       # Execute the deploy
       #
@@ -185,18 +183,17 @@ module Kikubari
         create_sylinked_folders if @config.do.has_key?("folder_symbolic_links") && !@config.do["folder_symbolic_links"].empty?
         create_symlinked_files if @config.do.has_key?("file_symbolic_link") && !@config.do["file_symbolic_link"].empty?
         create_current_symlink_folder
-        rotate_folders 
+        rotate_folders
           after_deploy_run
         self
       end
-      
+
       private
-      
+
       def do_deploy
         raise "This is an abstract method, implement this method in your deployer"
-        
       end
-      
+
     end
   end
-end
+end

data/lib/deployer/deployer_git.rb

@@ -15,10 +15,9 @@ module Kikubari
       def do_deploy
         branch = @config.config["branch"] || "master"
         %x(git clone #{@config.config["origin"]} -b #{branch} #{@config.env_time_folder} )
+        FileUtils.rm_rf("#{@config.env_time_folder}/.git")
       end
 
     end
-
   end
-
 end

data/lib/kikubari.rb

@@ -1,5 +1,16 @@
-module Kikubari
+require 'fileutils'
+require 'yaml'
+require 'git'
+require 'open3'
+
+require "configuration/deploy_configuration"
+require "deployer/deployer"
+require "deployer/deployer_git"
+require "deployer/deployer_git_wordpress"
+require "deploy_dir"
+require "deploy_logger"
 
+module Kikubari
   class Deploy
 
     attr_accessor :config
@@ -11,26 +22,24 @@ module Kikubari
     end
 
     def deploy
-      deployer = get_deployer( @config )
-      deployer.create_deploy_structure.deploy
+      get_deployer( @config ).create_deploy_structure.deploy
     end
 
     def rollback
-      p "rollingback"
+      @logger.print "rollingback"
     end
 
     def change( version )
-      p "changing to version #{version}"
+      @logger.print "changing to version #{version}"
     end
 
     private
 
     def get_deployer config
-      deployer_class = config.get_deployer_class
-      eval(deployer_class).new config
+      eval(deployer_class).new(config)
     end
 
 
   end
 
-end
+end

data/{test → spec}/deploy_files/deploy_git.yml

@@ -1,20 +1,20 @@
 ## Configurations Parameters
 config:
   system: git
-  origin: "git@github.com:josetonyp/sfRedisCachePlugin.git"
+  origin: "git@github.com:josetonyp/elements.git"
   branch: master
   history_limit: 10
-  
+
 ## Task actions for deployers
-## At versión 1 deployers should know the task order 
+## At versión 1 deployers should know the task order
 do:
 
   # Folder structure defining the backup and mantainance folder behind the deployment process
   folder_structure:
     cache: 'cache/#{environment}'
     log: 'log/#{environment}'
-    
+
   # Folder links from project folder and matainance folders
   folder_symbolic_links:
     cache: cache
-    log: log
+    log: log

data/{test → spec}/deploy_files/deploy_git_test_file.yml

@@ -1,19 +1,19 @@
 ## Configurations Parameters
 config:
   system: git
-  origin: "git@github.com:josetonyp/sfRedisCachePlugin.git"
+  origin: "git@github.com:josetonyp/elements.git"
   branch: master
   history_limit: 10
-  
+
 ## Task actions for deployers
-## At versión 1 deployers should know the task order 
+## At versión 1 deployers should know the task order
 do:
 
   # Folder structure defining the backup and mantainance folder behind the deployment process
   folder_structure:
     cache: 'cache/#{environment}'
     log: 'log/#{environment}'
-    
+
   # Folder links from project folder and matainance folders
   folder_symbolic_links:
     cache: cache
@@ -25,4 +25,4 @@ do:
 
   # Links to be build from tested files. Only tested files can be converted in symlinks to the project
   file_symbolic_link:
-    test: 'test/test.yml'
+    test: 'test/test.yml'

data/{test → spec}/deploy_files/deploy_symlink.yml

@@ -1,15 +1,15 @@
 # Deploy example sheet for a Symfony 1.4 and MySQL project
 #
 # Author::    Jose A Pio  (mailto:josetonyp@gmail.com)
-# Copyright:: Copyright (c) 2011 
+# Copyright:: Copyright (c) 2011
 # License::   Distributes under the same terms as Ruby
 #
 
 ## Configurations Parameters
 config:
-    
+
 ## Task actions for deployers
-## At versión 1 deployers should know the task order 
+## At versión 1 deployers should know the task order
 do:
 
   # Folder structure defining the backup and mantainance folder behind the deployment process
@@ -21,7 +21,8 @@ do:
   folder_symbolic_links:
     #name: #destination_name
     cache: cache
-      
+    config: config
+
   # Files to be tested before deployment. This files must exists or deployment will rise an exception
   # named_file: origin
   test_files:
@@ -34,4 +35,4 @@ do:
 
 after:
   run:
-    - 'mkdir new_folder'
+    - 'mkdir new_folder'

data/spec/lib/deploy_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+
+describe Kikubari::Deploy::Deployer do
+
+  let(:config) do
+    Kikubari::Deploy::Configuration.new(
+      "#{RSpec.configuration.deploy_files}/deploy_symlink.yml",
+      deploy_folder: RSpec.configuration.target_folder,
+      debug: false,
+      dry_run: false,
+      environment: 'production',
+      rollback: false)
+  end
+
+  subject(:subject) { described_class.new(config) }
+
+  before :all do
+    clear_target_project
+  end
+
+  context 'Folder Structure' do
+
+    it "creates an environment folder to host the structure" do
+      expect(subject.create_environment_folder).to satisfy do |deployer|
+        File.directory?(deployer.config.environment_folder)
+      end
+    end
+
+    it "creates a target version folder with a the current time stamp as name" do
+      expect(subject.create_version_folder).to satisfy do |deployer|
+        File.directory?(deployer.config.env_time_folder)
+      end
+    end
+
+    it "createa a symlink 'current' to the actual target version folder" do
+      expect(subject.create_version_folder.create_current_symlink_folder).to satisfy do |deployer|
+        File.symlink?(deployer.config.current_deploy_folder)
+      end
+    end
+
+    # Giving a folder structure like:
+    # From file: spec/deploy_files/deploy_symlink.yml
+    #
+    #  folder_structure:
+    #    cache: 'cache/#{environment}'
+    #    config: 'config/#{environment}'
+    #
+    # Example:
+    # project:
+    #   cache
+    #     [environment]
+    #   config
+    #     [environment]
+    #   [environment]
+    #     [version_folder]
+    #       cache: Symlink to cache/[environment]
+    #       config: Symlink to config/[environment]
+    #     current: Symlink to [version_folder]
+    #
+    it "creates the cache and condig folder inside" do
+      subject.tap do |deployer|
+        deployer.create_environment_folder
+        deployer.create_version_folder
+        deployer.create_current_symlink_folder
+
+        expect(deployer.create_structure).to satisfy do
+          File.directory?("#{deployer.config.deploy_folder}/cache/#{deployer.config.environment}") &&
+          File.directory?("#{deployer.config.deploy_folder}/config/#{deployer.config.environment}")
+        end
+      end
+    end
+
+    it "creates a symlink to inside the version folder pointing to the corresponding folder inside the structure" do
+      subject.tap do |deployer|
+        deployer.create_environment_folder
+        deployer.create_version_folder
+        deployer.create_structure
+
+        expect(deployer.create_sylinked_folders).to satisfy do
+          File.symlink?( "#{deployer.config.env_time_folder}/cache") &&
+          File.symlink?( "#{deployer.config.env_time_folder}/config")
+        end
+      end
+    end
+
+    it "should not create the symlinked folder is folder already exist" do
+      subject.create_environment_folder.create_version_folder.create_current_symlink_folder
+      subject.create_structure
+      FileUtils.mkdir_p "#{config.env_time_folder}/cache"
+      expect {
+        subject.create_sylinked_folders
+      }.to raise_error
+    end
+  end
+
+  context 'File linking' do
+    it "verifies a file in the folder and raise an error" do
+      subject.create_environment_folder.create_version_folder.create_current_symlink_folder
+      expect{subject.test_files}.to raise_error
+    end
+
+    it "verifies a file in the folder" do
+      subject.create_environment_folder.create_version_folder.create_current_symlink_folder
+      expect{subject.test_files}.to raise_error
+    end
+
+    it "creates a symlink file from tested files" do
+      subject.create_deploy_structure
+      ## Faking the config folder that should come with the repository
+      FileUtils.mkdir_p "#{config.env_time_folder}/config"
+      `echo "DB data...." >> #{config.deploy_folder}/config/#{config.environment}/databases.yml`
+      subject.create_symlinked_files.should satisfy do |deployer|
+        File.symlink?( "#{config.env_time_folder}/config/databases.yml")
+      end
+    end
+  end
+
+  context 'Execution' do
+    it "should execute the after run tasks" do
+      subject.create_deploy_structure
+      FileUtils.mkdir_p "#{config.env_time_folder}/config"
+      `echo "DB data..." >> #{config.deploy_folder}/config/#{config.environment}/databases.yml`
+      subject.after_deploy_run.should satisfy do |deployer|
+        File.directory?("#{config.env_time_folder}/new_folder")
+      end
+    end
+
+    it "should capture STDERR messages in a variable is command is not valid" do
+      subject.create_deploy_structure
+      subject.config.after['run'] = [ 'This is not a command' ]
+      out = subject.after_deploy_run
+      out.count.should == 1
+      out[0][:stdout].should == ""
+      out[0][:stderr].should_not == ""
+    end
+
+    it "should not capture STDERR messages in a variable if command is valid" do
+      subject.create_deploy_structure
+      subject.config.after['run'] = [ 'ls -lah' ]
+      out = subject.after_deploy_run
+      out.count.should == 1
+      out[0][:stdout].should_not == ""
+      out[0][:stderr].should == ""
+    end
+  end
+end