depengine 0.0.1

data/lib/depengine/publisher/rsync.rb

@@ -0,0 +1,68 @@
+module Publisher
+  class Rsync
+    attr_accessor :remote_host
+    attr_accessor :remote_user
+    attr_accessor :ssh_key_file
+
+    def sync(source, target, options={})
+      # default options
+      command_options = ["-a"]
+      if options[:local].nil? or options[:local] == false
+        Helper.validates_presence_of remote_host, "Remote Host not set"
+        Helper.validates_presence_of remote_user, "Remote User not set"
+        Helper.validates_presence_of ssh_key_file, "SSH-Keyfile not set"
+
+        target = "#{remote_user}@#{remote_host}:" + target
+        command_options << "-e \'ssh -c arcfour -o StrictHostKeyChecking=no -i #{ssh_key_file}\'"
+      end
+
+      rsync  = options[:rsync_bin] || 'rsync'
+      result = ''
+
+      if not options[:delete].nil? and options[:delete] == true
+        command_options << '--delete'
+      end
+      if not options[:whole_file].nil? and options[:whole_file] == true
+        command_options << '-W'
+      end
+      if not options[:rsync_path].nil?
+        command_options << "--rsync-path=#{options[:rsync_path]}"
+      end
+      if options[:one_filesystem].nil? or options[:one_filesystem] == true
+        command_options << '-x'
+      end
+      if options[:compression].nil? or options[:compression] == true
+        command_options << '-z'
+      end
+      if not options[:exclude].nil?
+        [options[:exclude]].flatten.each do |current_exclude|
+          if current_exclude > ""
+            command_options << "--exclude #{current_exclude}"
+          end
+        end
+      end
+
+      # sync options
+      # options[:delete] default false
+      # options[:whole_file] default false
+      # options[:one_filesystem] default true
+      # options[:compression] default true
+      # todo: ssh-agent preload key with passphrase
+      begin
+        $log.writer.debug "#{rsync} #{command_options.join(' ')} #{source} #{target}"
+        stdout = %x"#{rsync} #{command_options.join(' ')} \"#{source}\" \"#{target}\""
+        $log.writer.debug stdout
+
+        if not RUBY_VERSION < '1.9'
+          raise 'rsync execution error' if $?.exitstatus != 0
+        end
+      rescue Exception => e
+        $log.writer.error "Can not sync directory #{source} with #{target}"
+        $log.writer.error e.message
+        $log.writer.error e.backtrace.join("\n")
+        exit 1
+      end
+    end
+  end
+end
+

data/lib/depengine/publisher/samba.rb

@@ -0,0 +1,62 @@
+# See http://sambala.rubyforge.org/ruby-doc/
+module Publisher
+  class Samba
+    attr_accessor :samba_share
+    attr_accessor :samba_mountpoints
+    attr_accessor :worker
+
+    def copy(source, target, options={})
+      Helper.validates_presence_of samba_mountpoints, "Samba mountpoints not set"
+      Helper.validates_presence_of samba_share, "Samba Share not set"
+
+      begin
+        begin
+          # mount
+          worker.samba_mount(samba_share,"#{samba_mountpoints}/#{samba_share}")
+
+          to = "#{samba_mountpoints}/#{samba_share}/#{target}"
+          ### create target directory
+          if not File.directory?(to)
+            if not FileUtils.mkdir_p(to)
+              $log.writer.error "Unable to create target directory #{to}"
+              exit 1
+            end
+          end
+
+          # local rsync
+          shell_cmd = "rsync -a --delete #{source} #{to}"
+          $log.writer.debug "Execute command: #{shell_cmd}"
+          output = system shell_cmd
+          if not output
+            $log.writer.error "#{method} #{shell_cmd} failed"
+            exit 1
+          end
+          $log.writer.info output
+
+          # umount
+          worker.samba_umount("#{samba_mountpoints}/#{samba_share}")
+
+        rescue Exception => e
+          $log.writer.error "Can not publish files using samba"
+          $log.writer.error e.message
+          $log.writer.error e.backtrace.join("\n")
+          worker.samba_umount("#{samba_mountpoints}/#{samba_share}")
+          exit 1
+        end
+
+      rescue Exception => e
+        $log.writer.error "Can not upload files to #{target}"
+        $log.writer.error e.message
+        $log.writer.error e.backtrace.join("\n")
+        exit 1
+      end
+
+    end
+
+    def chmod(path, permissions, options={})
+      $log.writer.fatal "Not yet implemented"
+      exit 1
+    end
+  end
+end
+

data/lib/depengine/publisher/sftp.rb

@@ -0,0 +1,107 @@
+module Publisher
+  class Sftp
+    attr_accessor :remote_host
+    attr_accessor :remote_user
+    attr_accessor :ssh_key_file
+
+    def copy(source, target, options={})
+      Helper.validates_presence_of remote_host, "Remote Host not set"
+      Helper.validates_presence_of remote_user, "Remote User not set"
+      Helper.validates_presence_of ssh_key_file, "SSH-Keyfile not set"
+      
+      
+      # check ssh keyfile
+      if not File.file? ssh_key_file
+        $log.writer.error "Can not find SSH keyfile #{ssh_key_file}"
+        exit 1
+      end
+
+      source_last = source.split('/').last
+      target_last = target.split('/').last
+      if not source_last == target_last
+        if not target.end_with?('/')
+          target = target + '/' + source_last
+        else
+          target = target + source_last
+        end
+      end
+     
+      begin
+      	
+### delete directory
+        if File.directory?(source)      	
+          Net::SFTP.start(remote_host, remote_user, \
+                       :auth_methods  => ['publickey'], \
+                       :forward_agent => false, \
+                       :keys          => ssh_key_file, \
+                       :timeout       => 90 ) do |sftp|
+    
+              # delete all files in target, but not the target-dir itself
+              $log.writer.debug "Cleaning remote directory #{target}"
+              sftp.rm_r!(target, {:delete_root => true})                  
+          end
+        end
+
+
+### copy files
+        Net::SFTP.start(remote_host, remote_user, \
+                     :auth_methods  => ['publickey'], \
+                     :forward_agent => false, \
+                     :keys          => ssh_key_file, \
+                     :timeout       => 90 ) do |sftp|
+
+
+            sftp.upload!(source, target) 
+
+
+        end
+      rescue Exception => e
+        $log.writer.error "Can not upload files to #{target}"
+        $log.writer.error e.message
+        #$log.writer.error e.backtrace.join("\n")
+        exit 1
+      end
+      
+    end
+
+
+    def chmod(path, permissions, options={})
+      Helper.validates_presence_of remote_host, "Remote Host not set"
+      Helper.validates_presence_of remote_user, "Remote User not set"
+      Helper.validates_presence_of ssh_key_file, "SSH-Keyfile not set"
+      
+      # check ssh keyfile
+      if not File.file? ssh_key_file
+        $log.writer.error "Can not find SSH keyfile #{ssh_key_file}"
+        exit 1
+      end
+
+      Net::SFTP.start(remote_host, remote_user, \
+                   :auth_methods  => ['publickey'], \
+                   :forward_agent => false, \
+                   :keys          => ssh_key_file, \
+                   :timeout       => 90 ) do |sftp|
+
+          $log.writer.debug "Set permissions"
+          
+          if options[:recursive]
+            sftp.dir.entries(path).each do |entry|
+              next if entry.name == '.' or entry.name == '..'
+              child_path = File.join(path, entry.name)
+
+              sftp.setstat!(child_path, :permissions => permissions)
+            end
+        
+            sftp.setstat!(path, :permissions => permissions)
+            
+          else
+            sftp.setstat!(path, :permissions => permissions)
+          end
+      end
+
+    end
+
+
+  end
+end
+

data/lib/depengine/publisher/ssh.rb

@@ -0,0 +1,51 @@
+module Publisher
+  class Ssh
+    attr_accessor :remote_user
+    attr_accessor :remote_host
+    attr_accessor :ssh_key_file
+
+    def remote_execute(command)
+      Helper.validates_presence_of remote_user,  "Remote User not set"
+      Helper.validates_presence_of remote_host,  "Remote Host not set"
+      Helper.validates_presence_of ssh_key_file, "SSH keyfile not set"
+      Helper.validates_presence_of command,      "No valid remote command given"
+
+      result          = ''
+      # joined_filename = File.join(File.dirname($exec_file_path), ssh_key_file)
+      # ssh_key_file    = joined_filename
+
+      if not File.file? ssh_key_file
+        $log.writer.error "Can not find SSH keyfile #{ssh_key_file}"
+        exit 1
+      end
+
+      Net::SSH.start(remote_host, remote_user, \
+                     :auth_methods  => ['publickey'], \
+                     :forward_agent => true, \
+                     :keys          => ssh_key_file, \
+                     :timeout       => 30 ) do |session|
+        session.open_channel do |ch|
+          ch.exec command do |ch, success|
+            if not success
+              $log.writer.error "Can not execute remote command: '#{command}'"
+              exit 1
+            end
+
+            ch.on_data do |ch, data|
+              if not data.empty?
+                result << data
+              end
+            end
+
+            ch.on_close do |ch|
+              # result << "all done, closing!"
+            end
+
+          end
+        end
+      end
+      result
+    end
+  end
+end
+

data/lib/depengine/publisher/tomcat.rb

@@ -0,0 +1,45 @@
+module Publisher
+  class Tomcat
+    attr_accessor :servers
+    attr_accessor :runners
+    attr_accessor :initd_script
+    attr_accessor :application_name
+    attr_accessor :catalina_home
+    attr_accessor :tomcat_context
+    attr_accessor :logfilename
+    attr_accessor :check_host
+    attr_accessor :worker
+
+    def deploy(options={})
+      Helper.validates_presence_of servers, "servers not set"
+      Helper.validates_presence_of runners, "runners not set"
+      Helper.validates_presence_of initd_script, "initd_script not set"
+      Helper.validates_presence_of application_name, "application_name not set"
+      Helper.validates_presence_of catalina_home, "catalina_home not set"
+      Helper.validates_presence_of tomcat_context, "tomcat_context not set"
+      Helper.validates_presence_of logfilename, "logfilename not set"
+      Helper.validates_presence_of check_host, "check_host not set"
+
+      servers.each do |server|
+        $log.writer.info "========== Processing #{server}"
+        is_runner = runners.include?(server)
+        if is_runner
+          $log.writer.info "Stopping tomcat on #{server}"
+          stdout = worker.remote_execute("sudo #{initd_script} stop",  :remote_host => server)
+          $log.writer.info stdout
+        end
+        $log.writer.info "Deploying to webapp"
+        worker.rsync("target/#{application_name}/", "#{catalina_home}/webapps/#{tomcat_context}", :remote_host => server)
+        if is_runner
+          $log.writer.info "Starting tomcat on #{server}"
+          stdout = worker.remote_execute("sudo #{initd_script} start",  :remote_host => server)
+          $log.writer.info stdout
+          stdout = worker.remote_execute("sleep 10; tail -50 #{catalina_home}/logs/#{logfilename}",  :remote_host => server)
+          $log.writer.debug stdout
+          worker.assert_url_response_of(:check_host => check_host)
+        end
+      end
+    end
+  end
+end
+

data/lib/depengine/reporter/cdb.rb

@@ -0,0 +1,14 @@
+module Reporter
+  class Cdb
+    attr_accessor :version
+    attr_accessor :worker
+
+    def set_version(options={})
+      Helper.validates_presence_of version, "version not set"
+
+      worker.set_cdb_parameter('deployed_version', version)
+      worker.set_cdb_parameter('last_deployment_date', Time.now.strftime("%m/%d/%Y-%I:%M%p"))
+    end
+  end
+end
+

data/lib/depengine/reporter/mail.rb

@@ -0,0 +1,28 @@
+module Reporter
+  class Mail
+    attr_accessor :deploy_email_from
+    attr_accessor :deploy_email_to
+    attr_accessor :application_name
+    attr_accessor :module_name
+    attr_accessor :environment
+    attr_accessor :version
+    attr_accessor :worker
+
+    def send(options={})
+      Helper.validates_presence_of deploy_email_from, "deploy_email_from not set"
+      Helper.validates_presence_of deploy_email_to, "deploy_email_to not set"
+      Helper.validates_presence_of application_name, "application_name not set"
+      Helper.validates_presence_of module_name, "module_name not set"
+      Helper.validates_presence_of environment, "environment not set"
+
+      status = options[:status] || "done"
+      message = options[:message] || ""
+
+      worker.sendmail(:from => "#{deploy_email_from}", \
+          :to => "#{deploy_email_to}", \
+           :subject => "JENKINS: #{module_name} #{environment} #{application_name} #{status}", \
+           :body => "Module: #{module_name}\nEnvironment:  #{environment}\nJob: #{application_name}\nVersion: #{version}\n#{status}.\n\n#{message}" )
+    end
+  end
+end
+

data/lib/depengine/version.rb

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

data/spec/cdb_spec.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'net/http'
+require 'json'
+require 'log4r'
+require 'lib/depengine/helper/validations'
+require 'lib/depengine/provider/cdb'
+require 'lib/depengine/log/log'
+
+$log       = Log::DeploymentLogger.new
+$log.level = Log4r::ERROR
+
+describe "the cdb backend" do
+  include Provider
+  path    = '/INT/dbde/dboverallsearch/port'
+  version = 0
+  it "should deliver a parameter from the cdb by path" do
+    worker = Provider::CDB.new
+    worker.protocol = 'http'
+    worker.host     = 'localhost:4567'
+    worker.context  = ''
+    worker.env          = 'INT'
+
+    result = worker.get_parameter('dbde/dboverallsearch/port', 0)
+    result.should include("10123")
+  end
+
+  it "should deliver all parameters for an app from the cdb by path" do
+    worker = Provider::CDB.new
+    worker.protocol = 'http'
+    worker.host     = 'localhost:4567'
+    worker.context  = ''
+    worker.env      = 'INT'
+
+    result = worker.get_parameters('dbde/dboverallsearch', 0)
+    
+    result['env'].should include("INT")
+    result['appname'].should include("dboverallsearch")
+    result['port'].should be 10123
+  end 
+
+  it "should set a parameter in the cdb" do
+    worker = Provider::CDB.new
+    worker.protocol = 'http'
+    worker.host     = 'localhost:4567'
+    worker.context  = ''
+    worker.env      = 'INT'
+
+    worker.set_parameter('dbde/dboverallsearch', 'deployed_version', 123)
+    result = worker.get_parameter('dbde/dboverallsearch/deployed_version', 0)
+
+    result.should include("123")
+  end
+end
+

data/spec/deployhelper_spec.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'json'
+require 'log4r'
+require 'fakefs/spec_helpers'
+require 'lib/depengine/helper/validations'
+require 'lib/depengine/helper/hudson'
+require 'lib/depengine/log/log'
+require 'fileutils'
+
+$log       = Log::DeploymentLogger.new
+$log.level = Log4r::ERROR
+
+describe "helper functions" do
+  include Helper
+  it "should deliver all relevant envirnoment variables as a hash" do
+    result = get_environemnt_variables
+    result.should include("HOME")
+  end
+
+  it "should return a plain version number as a hash" do
+    version = "1.2.3"
+    result = parse_version(version)
+    result['app'].should include("1.2.3")
+  end
+
+  it "should parse a json version string and return as hash" do
+    version = "{\"app\": \"1.2.3\", \"cdb\": 23, \"depsw\": 44}"
+    result = parse_version(version)
+    result['app'].should include( "1.2.3" )
+    result['cdb'].should  be 23 
+    result['depsw'].should be 44 
+  end
+
+  it "should remove all files from workspace" do
+    FileUtils.mkdir_p 'workspace'
+    FileUtils.touch   'workspace/dummy.file'
+    cleanup_workspace!('workspace')
+
+    File.directory?( 'workspace' ).should be true
+    File.file?( 'workspace/dummy.file' ).should be false
+  end
+
+  it "should create all inital directories in the workspace" do
+    FileUtils.mkdir_p 'workspace'
+    init_workspace('workspace')
+
+    File.directory?( 'workspace' ).should be true
+    File.directory?( 'workspace/source' ).should be true
+    File.directory?( 'workspace/target' ).should be true
+    File.directory?( 'workspace/config' ).should be true
+    File.directory?( 'workspace/keep' ).should be true
+  end
+
+end
+

data/spec/dweb_spec.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'log4r'
+require 'net/ssh'
+require 'net/sftp'
+require 'lib/depengine/helper/validations'
+require 'lib/depengine/publisher/dweb'
+require 'lib/depengine/log/log'
+
+$log            = Log::DeploymentLogger.new
+$log.level      = Log4r::ERROR
+$exec_file_path = __FILE__
+
+describe "the dweb publisher" do
+  it "should execute a command on a dweb staging host" do
+    worker = Publisher::Dweb.new
+    worker.staging_host = '217.73.53.42'
+    worker.ssh_key_file = '../etc/ssh/id_rsa.deployadmin'
+    worker.siteid       = 'dw09964'
+
+    result = worker.send_command('list')
+    result.should include("complete")
+  end
+
+  it "should upload files to the dweb staging system" do
+    # todo
+  end
+end
+

data/spec/fileops_spec.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'log4r'
+require 'fakefs/spec_helpers'
+require 'lib/depengine/processor/fileops'
+require 'lib/depengine/log/log'
+
+$log       = Log::DeploymentLogger.new
+$log.level = Log4r::ERROR
+
+describe "file operations" do
+  include FakeFS::SpecHelpers
+  include Processor
+  it "should copy a file" do
+    FileUtils.mkdir_p 'source'
+    FileUtils.mkdir_p 'target'
+    FileUtils.touch 'source/dummy.file'
+ 
+    copy('source/dummy.file', 'target/dummy.file')
+    File.file?( 'target/dummy.file' ).should be_true
+  end
+
+  it "should create a directory" do
+    mkdir('target')
+    File.directory?( 'target' ).should be_true
+  end
+
+  it "should modifie file parameter" do
+    #not testable with FakeFS
+  end
+
+  it "should delete a file" do
+    FileUtils.touch 'dummy.file'
+    remove('dummy.file')
+    
+    File.file?( 'dummy.file' ).should be_false
+  end
+
+  it "should delete a directory" do
+    FileUtils.mkdir_p 'dummy'
+    remove('dummy')
+
+    File.directory?( 'dummy' ).should be_false
+  end
+end
+

data/spec/log_spec.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'log4r'
+require 'lib/depengine/log/log'
+require 'stringio'
+
+describe "logging" do
+  it "should log a message to STDOUT" do
+    # redirect STDOUT
+    sio = StringIO.new
+    old_stdout, $stdout = $stdout, sio
+ 
+    log = Log::DeploymentLogger.new
+    log.writer.debug "Logger is now setup"
+
+    # restore STDOUT
+    $stdout = old_stdout
+    result  = sio.string
+
+    result.should include( "Logger is now setup" )
+  end
+
+  it "should log a message to STDOUT with priority WARN" do
+    # redirect STDOUT
+    sio = StringIO.new
+    old_stdout, $stdout = $stdout, sio
+
+    log = Log::DeploymentLogger.new
+    log.level = Log4r::WARN
+    log.writer.warn "Logger is now setup"
+
+    # restore STDOUT
+    $stdout = old_stdout
+    result  = sio.string
+
+    result.should include( "Logger is now setup" )
+  end
+
+  it "should log a message to a logfile" do
+    FileUtils.rm_rf "spec/logs/log_spec.log"
+
+    log = Log::DeploymentLogger.new
+    log.add_outputter(Log4r::FileOutputter.new('log_warn', :filename => "./spec/logs/log_spec.log", :level => Log4r::INFO))
+    log.writer.info "Logger is now setup"
+
+    File.open("spec/logs/log_spec.log", 'r') do |line|
+      line.gets.should include("Logger is now setup")
+    end
+  end
+end
+

data/spec/logs/log_spec.log

@@ -0,0 +1 @@
+ INFO Deployment: Logger is now setup

data/spec/mail_spec.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'log4r'
+require 'pony'
+require 'lib/depengine/helper/validations'
+require 'lib/depengine/helper/mail'
+require 'lib/depengine/log/log'
+
+$log       = Log::DeploymentLogger.new
+$log.level = Log4r::ERROR
+
+describe "mail delivery" do
+  it "should send an email via smtp" do
+    options = {}
+    options[:from]    = 'deployment@localhost'
+    options[:to]      = 'marstu@localhost'
+    options[:subject] = 'spec mail'
+    options[:body]    = 'test mail'
+
+    worker = Helper::Mail.new
+    worker.smtp_host = 'chiara'
+    worker.sendmail(options)
+  end
+
+end
+