depengine 3.0.20 → 3.0.21

data/lib/depengine/publisher/dweb.rb

@@ -20,48 +20,44 @@ module Publisher
     # debug with:
     # ssh -i apps/deploy_engine/etc/ssh/id_rsa.deployadmin dwebuser@dei[iup]2s.dweb.intranet.db.com
     # > 'enter command'
-    def send_command(command, options={})
-      Helper.validates_presence_of staging_host, "Staging Host not set"
-      Helper.validates_presence_of ssh_key_file, "SSH keyfile not set"
-      Helper.validates_presence_of siteid, "Siteid not set"
+    def send_command(command, options = {})
+      Helper.validates_presence_of staging_host, 'Staging Host not set'
+      Helper.validates_presence_of ssh_key_file, 'SSH keyfile not set'
+      Helper.validates_presence_of siteid, 'Siteid not set'
 
       result = ''
       joined_filename = File.join(File.dirname($exec_file_path), ssh_key_file)
       ssh_key_file    = joined_filename
 
       # overwrite siteid for multi target deployments
-      if not options[:siteid].nil?
-        self.siteid = options[:siteid]
-      end
+      self.siteid = options[:siteid] if options[:siteid]
 
       # check ssh keyfile
-      if not File.file? ssh_key_file
+      unless File.file? ssh_key_file
         $log.writer.error "Can not find SSH keyfile #{ssh_key_file}"
-        exit 1
+        fail "Can not find SSH keyfile #{ssh_key_file}"
       end
 
       ### Probleme auf UAT und PROD
-      if command.include? "list"
-        return result
-      end
-
-      Net::SSH.start(staging_host, "dwebuser", \
-                     :auth_methods  => ['publickey'], \
-                     :forward_agent => false, \
-                     :keys          => ssh_key_file, \
-                     :timeout       => 90 ) do |session|
-        session.open_channel do |ch|
-          ch.exec "/scripts/dwebuser #{siteid}" do |ch, success|
-            if not success
-              $log.writer.error "Can not execute dwebuser command"
+      return result if command.include? 'list'
+
+      Net::SSH.start(staging_host, 'dwebuser', \
+                     auth_methods: ['publickey'], \
+                     forward_agent: false, \
+                     keys: ssh_key_file, \
+                     timeout: 90) do |session|
+        session.open_channel do |channel|
+          channel.exec "/scripts/dwebuser #{siteid}" do |ch, success|
+            unless success
+              $log.writer.error 'Can not execute dwebuser command'
               exit 1
             end
 
-            ch.on_data do |ch, data|
-              if not data.empty?
+            ch.on_data do |_ch, data|
+              unless data.empty?
                 result << data
 
-                if command.include? "list"
+                if command.include? 'list'
                   result_a = result.split("\n")
                   test = result_a.last
                   if not test.nil? and test.length > 0
@@ -73,7 +69,7 @@ module Publisher
             end
 
             # something on stderr?
-            ch.on_extended_data do |ch, type, data|
+            ch.on_extended_data do |_ch, _type, data|
               # dirty filter for non critical return messages
               if data =~ /^ERROR.*/
                 $log.writer.error \
@@ -85,82 +81,79 @@ module Publisher
               end
             end
 
-            ch.on_close do |ch|
-              result << "all done, closing ssh channel!"
+            ch.on_close do |_ch|
+              result << 'all done, closing ssh channel!'
             end
 
             ch.send_data command + "\n"
           end
-          ch.wait
+          channel.wait
         end
       end
       $log.writer.debug result
 
-      return result
+      result
     end
 
-    def upload(source, target, options={})
-      Helper.validates_presence_of staging_host, "Staging Host not set"
-      Helper.validates_presence_of ssh_key_file, "SSH keyfile not set"
+    def upload(source, target, options = {})
+      Helper.validates_presence_of staging_host, 'Staging Host not set'
+      Helper.validates_presence_of ssh_key_file, 'SSH keyfile not set'
 
-      result          = ''
       joined_filename = File.join(File.dirname($exec_file_path), ssh_key_file)
       ssh_key_file    = joined_filename
 
       # overwrite siteid for multi target deployments
-      if not options[:siteid].nil?
-        self.siteid = options[:siteid]
-      end
-      Helper.validates_presence_of siteid, "Siteid not set"
+      self.siteid = options[:siteid] if options[:siteid]
+      Helper.validates_presence_of siteid, 'Siteid not set'
 
       # check ssh keyfile
-      if not File.file? ssh_key_file
+      unless File.file? ssh_key_file
         $log.writer.error "Can not find SSH keyfile #{ssh_key_file}"
-        exit 1
+        fail "Can not find SSH keyfile #{ssh_key_file}"
       end
 
       # first connection to delete files
       begin
-        if not options[:cleanup] == false
+        unless options[:cleanup] == false
           Net::SFTP.start(staging_host, siteid + 'f', \
-                     :auth_methods  => ['publickey'], \
-                     :forward_agent => false, \
-                     :keys          => ssh_key_file, \
-                     :timeout       => 90 ) do |session|
+                          auth_methods: ['publickey'], \
+                          forward_agent: false, \
+                          keys: ssh_key_file, \
+                          timeout: 90) do |session|
 
             # delete all files in target, but not the target-dir itself
             $log.writer.debug "Cleaning remote directory #{target}"
             session.rm_r!(target)
-        
+
           end
         end
         # second connection to upload files
-        processing_file = ""
+        processing_file = ''
         Net::SCP.start(staging_host, siteid + 'f', \
-                     :auth_methods  => ['publickey'], \
-                     :forward_agent => false, \
-                     :keys          => ssh_key_file, \
-                     :timeout       => 90 ) do |session|
+                       auth_methods: ['publickey'], \
+                       forward_agent: false, \
+                       keys: ssh_key_file, \
+                       timeout: 90) do |session|
           Dir.glob(File.join(source, '/*'), File::FNM_DOTMATCH) do |entry|
-            if not entry =~ /\.$/
+            unless entry =~ /\.$/
               processing_file = entry
               if not options[:excludes].nil?
-                if options[:excludes].any? {|term| entry.include? term }
+                if options[:excludes].any? { |term| entry.include? term }
                   $log.writer.debug "Exclude #{entry} from upload"
                 else
                   $log.writer.debug "Upload #{entry}"
                   session.upload!(entry, File.join(target, '/'), \
-                                  :recursive => true)
+                                  recursive: true)
                 end
               else
                 $log.writer.debug "Upload #{entry}"
                 session.upload!(entry, File.join(target, '/'), \
-                                :recursive => true)
+                                recursive: true)
               end
             end
           end
         end
-      rescue Exception => e
+      rescue => e
         $log.writer.error "Can not upload file #{processing_file} to #{target}"
         $log.writer.error e.message
         $log.writer.error e.backtrace.join("\n")
@@ -168,60 +161,54 @@ module Publisher
       end
     end
 
-    def remote_symlink(source, symlink, options={})
-      Helper.validates_presence_of staging_host, "Staging Host not set"
-      Helper.validates_presence_of ssh_key_file, "SSH keyfile not set"
+    def remote_symlink(source, symlink, options = {})
+      Helper.validates_presence_of staging_host, 'Staging Host not set'
+      Helper.validates_presence_of ssh_key_file, 'SSH keyfile not set'
 
-      result          = ''
       joined_filename = File.join(File.dirname($exec_file_path), ssh_key_file)
       ssh_key_file    = joined_filename
 
       # overwrite siteid for multi target deployments
-      if not options[:siteid].nil?
-        self.siteid = options[:siteid]
-      end
-      Helper.validates_presence_of siteid, "Siteid not set"
+      self.siteid = options[:siteid] if options[:siteid]
+      Helper.validates_presence_of siteid, 'Siteid not set'
 
       # check ssh keyfile
-      if not File.file? ssh_key_file
+      unless File.file? ssh_key_file
         $log.writer.error "Can not find SSH keyfile #{ssh_key_file}"
         exit 1
       end
 
       begin
         Net::SFTP.start(staging_host, siteid + 'f', \
-                     :auth_methods  => ['publickey'], \
-                     :forward_agent => false, \
-                     :keys          => ssh_key_file, \
-                     :timeout       => 90 ) do |session|
-              begin
-                if session.lstat!(symlink).type == Net::SFTP::Protocol::V01::Attributes::T_SYMLINK
-                  $log.writer.debug "Delete already existing link #{symlink}"
-                  session.remove!(symlink)
-                end
-              rescue
-                # maybe the link does not exist yet, or the remove faild
-                # anyway, we try to create it
-              end
-              session.symlink!(source, symlink)
+                        auth_methods: ['publickey'], \
+                        forward_agent: false, \
+                        keys: ssh_key_file, \
+                        timeout: 90) do |session|
+          begin
+            if session.lstat!(symlink).type == Net::SFTP::Protocol::V01::Attributes::T_SYMLINK
+              $log.writer.debug "Delete already existing link #{symlink}"
+              session.remove!(symlink)
+            end
+          rescue
+            $log.writer.warn 'Maybe the link does not exist yet, or the remove faild. Anyway, we try to create it.'
+          end
+          session.symlink!(source, symlink)
         end
-      rescue Exception => e
-        $log.writer.error "Can not create remote symlink #{symlink} to #{source}
-"
+      rescue => e
+        $log.writer.error "Can not create remote symlink #{symlink} to #{source}"
         $log.writer.error e.message
         $log.writer.error e.backtrace.join("\n")
         exit 1
       end
       true
     end
-
   end
 end
 
-class Net::SFTP::Session
-  def rm_r!(path, options={})
+class Net::SFTP::Session # rubocop:disable Style/ClassAndModuleChildren
+  def rm_r!(path, options = {})
     @rm_depth = 0 if @rm_depth.nil?
-    self.dir.entries(path).each do |entry|
+    dir.entries(path).each do |entry|
 
       next if entry.name == '.' or entry.name == '..'
 
@@ -237,9 +224,6 @@ class Net::SFTP::Session
       end
     end
 
-    if @rm_depth != 0 or options[:delete_root]
-      self.rmdir!(path)
-    end
+    self.rmdir!(path) if @rm_depth != 0 or options[:delete_root]
   end
 end
-

data/lib/depengine/publisher/iis.rb

@@ -3,8 +3,8 @@ module Publisher
     attr_accessor :url, :protocol, :http_read_timeout
 
     def build(tag, env, version, value, application_name)
-      Helper.validates_presence_of @url, "IIS URL not set"
-      Helper.validates_presence_of @protocol, "Protocol not set"
+      Helper.validates_presence_of @url, 'IIS URL not set'
+      Helper.validates_presence_of @protocol, 'Protocol not set'
       iis_error = false
 
       begin
@@ -16,30 +16,27 @@ module Publisher
           request.content_type = 'application/x-www-form-urlencoded;charset=utf-8'
           http.request request do |response|
             response.read_body do |chunk|
-              if chunk.include?("### Error while executing")
-                $log.writer.error "Error executing build on IIS"
+              if chunk.include?('### Error while executing')
+                $log.writer.error 'Error executing build on IIS'
                 iis_error = true
               end
               $log.writer.info "#{chunk}"
             end
           end
         end
-      rescue Exception => e
-        $log.writer.error "Error: while connecting to IIS Server"
-        $log.writer.error "Request was: #{uri.to_s}"
+      rescue => e
+        $log.writer.error 'Error: while connecting to IIS Server'
+        $log.writer.error "Request was: #{uri}"
         $log.writer.error e.message
         exit 1
       end
 
-      if iis_error
-        exit 1
-      end
-
+      fail if iis_error
     end
 
     def appcmd(value)
-      Helper.validates_presence_of @url, "IIS URL not set"
-      Helper.validates_presence_of @protocol, "Protocol not set"
+      Helper.validates_presence_of @url, 'IIS URL not set'
+      Helper.validates_presence_of @protocol, 'Protocol not set'
 
       begin
         uri    = URI(@protocol + '://' + @url)
@@ -54,17 +51,17 @@ module Publisher
             end
           end
         end
-      rescue Exception => e
-        $log.writer.error "Error: while connecting to IIS Server"
-        $log.writer.error "Request was: #{uri.to_s}"
+      rescue => e
+        $log.writer.error 'Error: while connecting to IIS Server'
+        $log.writer.error "Request was: #{uri}"
         $log.writer.error e.message
         exit 1
       end
     end
 
-   def deploy(version, iis_application_name, env)
-      Helper.validates_presence_of @url, "IIS URL not set"
-      Helper.validates_presence_of @protocol, "Protocol not set"
+    def deploy(version, iis_application_name, env)
+      Helper.validates_presence_of @url, 'IIS URL not set'
+      Helper.validates_presence_of @protocol, 'Protocol not set'
       iis_error = false
 
       begin
@@ -76,26 +73,22 @@ module Publisher
           request.content_type = 'application/x-www-form-urlencoded;charset=utf-8'
           http.request request do |response|
             response.read_body do |chunk|
-              if chunk.include?("### Error while executing")
-                $log.writer.error "Error executing deploy on IIS"
+              if chunk.include?('### Error while executing')
+                $log.writer.error 'Error executing deploy on IIS'
                 iis_error = true
               end
               $log.writer.info "#{chunk}"
             end
           end
         end
-      rescue Exception => e
-        $log.writer.error "Error: while connecting to IIS Server"
-        $log.writer.error "Request was: #{uri.to_s}"
+      rescue => e
+        $log.writer.error 'Error: while connecting to IIS Server'
+        $log.writer.error "Request was: #{uri}"
         $log.writer.error e.message
         exit 1
       end
 
-      if iis_error
-        exit 1
-      end
-
+      fail if iis_error
     end
-
   end
-end
+end

data/lib/depengine/publisher/rsync.rb

@@ -4,20 +4,19 @@ module Publisher
     attr_accessor :remote_user
     attr_accessor :ssh_key_file
 
-    def sync(source, target, options={})
+    def sync(source, target, options = {})
       # default options
-      command_options = ["-a"]
+      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"
+        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'
@@ -25,7 +24,7 @@ module Publisher
       if not options[:whole_file].nil? and options[:whole_file] == true
         command_options << '-W'
       end
-      if not options[:rsync_path].nil?
+      unless options[:rsync_path].nil?
         command_options << "--rsync-path=#{options[:rsync_path]}"
       end
       if options[:one_filesystem].nil? or options[:one_filesystem] == true
@@ -34,11 +33,10 @@ module Publisher
       if options[:compression].nil? or options[:compression] == true
         command_options << '-z'
       end
-      if not options[:exclude].nil?
+      unless options[:exclude].nil?
         [options[:exclude]].flatten.each do |current_exclude|
-          if current_exclude > ""
-            command_options << "--exclude #{current_exclude}"
-          end
+          next unless current_exclude > ''
+          command_options << "--exclude #{current_exclude}"
         end
       end
 
@@ -47,16 +45,16 @@ module Publisher
       # options[:whole_file] default false
       # options[:one_filesystem] default true
       # options[:compression] default true
-      # todo: ssh-agent preload key with passphrase
+      # 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}\""
+        stdout = `#{rsync} #{command_options.join(' ')} \"#{source}\" \"#{target}\"`
         $log.writer.debug stdout
 
-        if not RUBY_VERSION < '1.9'
-          raise 'rsync execution error' if $?.exitstatus != 0
+        unless RUBY_VERSION < '1.9'
+          fail 'rsync execution error' if $CHILD_STATUS.exitstatus != 0
         end
-      rescue Exception => e
+      rescue => e
         $log.writer.error "Can not sync directory #{source} with #{target}"
         $log.writer.error e.message
         $log.writer.error e.backtrace.join("\n")
@@ -65,4 +63,3 @@ module Publisher
     end
   end
 end
-

data/lib/depengine/publisher/samba.rb

@@ -5,19 +5,19 @@ module Publisher
     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"
+    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}")
+          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)
+          unless File.directory?(to)
+            unless FileUtils.mkdir_p(to)
               $log.writer.error "Unable to create target directory #{to}"
               exit 1
             end
@@ -27,7 +27,7 @@ module Publisher
           shell_cmd = "rsync -a --delete #{source} #{to}"
           $log.writer.debug "Execute command: #{shell_cmd}"
           output = system shell_cmd
-          if not output
+          unless output
             $log.writer.error "#{method} #{shell_cmd} failed"
             exit 1
           end
@@ -36,27 +36,25 @@ module Publisher
           # umount
           worker.samba_umount("#{samba_mountpoints}/#{samba_share}")
 
-        rescue Exception => e
-          $log.writer.error "Can not publish files using samba"
+        rescue => 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
+      rescue => 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"
+    def chmod(_path, _permissions, _options = {})
+      $log.writer.fatal 'Not yet implemented'
       exit 1
     end
   end
 end
-