depengine 3.0.20 → 3.0.21

data/lib/depengine/publisher/sftp.rb

@@ -4,104 +4,94 @@ module Publisher
     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"
-      
-      
+    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
+      unless 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
+      unless 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)      	
+
+        ### 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})                  
+                          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
+        ### 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) 
+                        auth_methods: ['publickey'], \
+                        forward_agent: false, \
+                        keys: ssh_key_file, \
+                        timeout: 90) do |sftp|
 
+          sftp.upload!(source, target)
 
         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")
+        # $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'
 
-    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
+      unless 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
+                      auth_methods: ['publickey'], \
+                      forward_agent: false, \
+                      keys: ssh_key_file, \
+                      timeout: 90) do |sftp|
 
-    end
+        $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

@@ -5,52 +5,51 @@ module Publisher
     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"
+      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
+      unless 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
+                     auth_methods: ['publickey'], \
+                     forward_agent: true, \
+                     keys: ssh_key_file, \
+                     timeout: 30) do |session|
+        session.open_channel do |channel|
+          channel.exec command do |ch, success|
+            unless success
               $log.writer.error "could not execute remote command: '#{command}'"
               exit 1
             end
 
-            ch.on_data do |ch, data| # STDOUT of command
+            ch.on_data do |_ch, data| # STDOUT of command
               if data
                 $log.writer.debug data.strip
                 result << data
               else
-                $log.writer.info "Warning: Maybe successfully executed but no output found"
+                $log.writer.info 'Warning: Maybe successfully executed but no output found'
               end
             end
 
-            ch.on_extended_data do |ch, type, data| # STDERR of command
-              $log.writer.error "could not execute command"
+            ch.on_extended_data do |_ch, type, data| # STDERR of command
+              $log.writer.error 'could not execute command'
               $log.writer.error data
               $log.writer.error type
               exit 1
             end
 
-            ch.on_close do |ch|
+            ch.on_close do |_ch|
               # result << "all done, closing!"
             end
-
           end
         end
       end
@@ -58,15 +57,13 @@ module Publisher
     end
 
     def remove_old_releases(path, num_of_releases_to_keep, release_name_shema)
-      releases = remote_execute("ls #{path}").split("\n").find_all {|dir| dir =~ release_name_shema}.sort
-      num_to_remove = releases.size-num_of_releases_to_keep
+      releases = remote_execute("ls #{path}").split("\n").select { |dir| dir =~ release_name_shema }.sort
+      num_to_remove = releases.size - num_of_releases_to_keep
       releases_to_delete = releases.take(num_to_remove < 0 ? 0 : num_to_remove)
       releases_to_delete.each do |dir|
         $log.writer.debug "removing #{path}/#{dir}"
         remote_execute("rm -rf #{path}/#{dir}")
       end
     end
-
   end
 end
-

data/lib/depengine/publisher/tomcat.rb

@@ -10,36 +10,34 @@ module Publisher
     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"
+    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)
+          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
+        $log.writer.info 'Deploying to webapp'
+        worker.rsync("target/#{application_name}/", "#{catalina_home}/webapps/#{tomcat_context}", remote_host: server)
+        next unless 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
-

data/lib/depengine/reporter/cdb.rb

@@ -4,11 +4,10 @@ module Reporter
     attr_accessor :worker
 
     def set_version
-      Helper.validates_presence_of version, "version not set"
+      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"))
+      worker.set_cdb_parameter('last_deployment_date', Time.now.strftime('%m/%d/%Y-%I:%M%p'))
     end
   end
 end
-

data/lib/depengine/version.rb

@@ -1,3 +1,3 @@
 module Depengine
-  VERSION = "3.0.20"
+  VERSION = '3.0.21'
 end

data/lib/depengine.rb

@@ -17,8 +17,7 @@ require 'csv'
 require 'zlib'
 require 'optparse'
 
-
-Dir[File.join( File.dirname(__FILE__), '**/*.rb' )].sort.each { |file| require file }
+Dir[File.join(File.dirname(__FILE__), '**/*.rb')].sort.each { |file| require file }
 
 # Global variables
 $exec_file_path = __FILE__

data/spec/cdb_spec.rb

@@ -10,19 +10,18 @@ $exec_file_path = __FILE__
 $log       = Log::DeploymentLogger.new
 $log.writer.level = Log4r::DEBUG
 
-describe "the cdb backend" do
+describe 'the cdb backend' do
   include Provider
   path_to_cdb = File.join(File.dirname(__FILE__), '../../cdb/')
-  version = 0
 
   before(:all) do
-    $log.writer.debug "starting a CDB webserver on port 4567"
+    $log.writer.debug 'starting a CDB webserver on port 4567'
     $pid = spawn("rackup #{path_to_cdb}/config.ru -p 4567")
     $log.writer.debug "CDB running as pid #{$pid}"
     sleep(2) # waiting for CDB to come properly
   end
 
-  it "should deliver a parameter from the cdb by path" do
+  it 'should deliver a parameter from the cdb by path' do
     worker = Provider::CDB.new
     worker.protocol = 'http'
     worker.host     = 'localhost:4567'
@@ -30,26 +29,25 @@ describe "the cdb backend" do
     worker.env      = 'INT'
 
     result = worker.get_parameter('module/app/this_is', 0)
-    result.should include("INT_module_app")
+    result.should include('INT_module_app')
   end
 
-  it "should set a parameter in the cdb" do
+  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('module/app', 'this_is', "INT_module_app")
+    worker.set_parameter('module/app', 'this_is', 'INT_module_app')
     result = worker.get_parameter('module/app/this_is', 0)
 
-    result.should include("INT_module_app")
+    result.should include('INT_module_app')
   end
 
   after(:all) do
-    $log.writer.debug "killing CDB webserver"
+    $log.writer.debug 'killing CDB webserver'
     `kill #{$pid}`
   end
 
 end
-

data/spec/demo_recipe/recipes/demo.rb

@@ -1,27 +1,27 @@
-set :application_name,         "testapp"
-set :module_name,              "testmodule"
+set :application_name,         'testapp'
+set :module_name,              'testmodule'
 
-set :cleanup_workspace_before, ["source", "tmp"]
+set :cleanup_workspace_before, %w(source tmp)
 
-set :log_level,                "INFO"
-set :log_file,                 "deploy.log"
-set :log_file_level,           "DEBUG"
+set :log_level,                'INFO'
+set :log_file,                 'deploy.log'
+set :log_file_level,           'DEBUG'
 
 Deployment.deliver do
 
   config = get_all_config_parameters
-  $log.writer.info "Got config parameters from cdb"
+  $log.writer.info 'Got config parameters from cdb'
 
   $log.writer.info "date_unique: #{date_unique}"
 
   config['test_app_hosts'].each do |test_app_host|
     $log.writer.info "doing something on #{test_app_host}"
-    rsync("target/", "/srv/testapp/")
-    remote_execute("export JAVA_HOME=/opt/java7; cd /srv/testapp/project_#{config['env'].downcase}/current/; . ./setantenv.sh; ant;", :remote_host => test_app_host)
+    rsync('target/', '/srv/testapp/')
+    remote_execute("export JAVA_HOME=/opt/java7; cd /srv/testapp/project_#{config['env'].downcase}/current/; . ./setantenv.sh; ant;", remote_host: test_app_host)
   end
 
   report_by_mail
   $log.writer.info "Sent mail to deployment team #{config['deploy_email_to']}"
 
-  $log.writer.info "Deployment done!"
+  $log.writer.info 'Deployment done!'
 end

data/spec/deployhelper_spec.rb

@@ -8,50 +8,49 @@ require_relative '../lib/depengine/helper/hudson'
 require_relative '../lib/depengine/log/log'
 
 $log       = Log::DeploymentLogger.new
-#$log.writer.level = Log4r::ERROR
+# $log.writer.level = Log4r::ERROR
 
-describe "helper functions" do
+describe 'helper functions' do
   include Helper
   include FakeFS::SpecHelpers
 
-  it "should deliver all relevant envirnoment variables as a hash" do
+  it 'should deliver all relevant envirnoment variables as a hash' do
     result = get_environemnt_variables
-    result.should include("HOME")
+    result.should include('HOME')
   end
 
-  it "should return a plain version number as a hash" do
-    version = "1.2.3"
+  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")
+    result['app'].should include('1.2.3')
   end
 
-  it "should parse a json version string and return as hash" do
+  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['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
+  it 'should remove all files from workspace' do
     FileUtils.mkdir_p 'workspace'
-    FileUtils.touch   'workspace/dummy.file'
+    FileUtils.touch 'workspace/dummy.file'
     cleanup_workspace!('workspace')
 
-    File.directory?( 'workspace' ).should be true
-    File.file?( 'workspace/dummy.file' ).should be false
+    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
+  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
+    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/fileops_spec.rb

@@ -7,39 +7,38 @@ require_relative '../lib/depengine/log/log'
 $log       = Log::DeploymentLogger.new
 $log.writer.level = Log4r::ERROR
 
-describe "file operations" do
+describe 'file operations' do
   include FakeFS::SpecHelpers
   include Processor
 
-  it "should copy a file" do
+  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
+    File.file?('target/dummy.file').should be_true
   end
 
-  it "should create a directory" do
+  it 'should create a directory' do
     mkdir('target')
-    File.directory?( 'target' ).should be_true
+    File.directory?('target').should be_true
   end
 
-  it "should modifie file parameter" do
-    #not testable with FakeFS
+  it 'should modifie file parameter' do
+    # not testable with FakeFS
   end
 
-  it "should delete a file" do
+  it 'should delete a file' do
     FileUtils.touch 'dummy.file'
     remove('dummy.file')
-    File.file?( 'dummy.file' ).should be_false
+    File.file?('dummy.file').should be_false
   end
 
-  it "should delete a directory" do
+  it 'should delete a directory' do
     FileUtils.mkdir_p 'dummy'
     remove('dummy')
 
-    File.directory?( 'dummy' ).should be_false
+    File.directory?('dummy').should be_false
   end
 end
-

data/spec/git_spec.rb

@@ -3,12 +3,16 @@ require_relative '../lib/depengine/processor/local_execute'
 
 describe '#history' do
 
-  let(:git) { g = Provider::Git.new; g.repository_local_dir = '.'; g }
+  let(:git) do
+    g = Provider::Git.new
+    g.repository_local_dir = '.'
+    g
+  end
 
   context 'no parameters given' do
     it 'falls back to all history' do
       expect(Processor).to receive(:local_execute).once.with(['git log --oneline ']).and_return('ok')
-      git.history()
+      git.history
     end
   end
 
@@ -24,8 +28,8 @@ describe '#history' do
     it 'uses both to get commits betweem them' do
       r1, r2 = '4223abc', 'caffe42'
       expect(Processor).to receive(:local_execute).once.with(['git log --oneline 4223abc..caffe42']).and_return('ok')
-      git.history(r1,r2)
+      git.history(r1, r2)
     end
   end
 
-end
+end