depengine 3.0.12 → 3.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65323cd0cb0e566052549a932ebf9648b5e9cdff
-  data.tar.gz: e332c30d4454cf4894058dc3b1fc4f1f6c123697
+  metadata.gz: 9e2c029e3eb7bd3346ecf335948c89a5c32887de
+  data.tar.gz: d816e6f7d3a987b5fc28a2b50c71b02da46b0691
 SHA512:
-  metadata.gz: dd0b8f3e5b915c513c177eaceaaa4cba2a85db0f808a3ced5ed1322f156062b21c44a04ebea896f2c77dc83bb5749c1cd0baa077ff733e8f3dc0b08587f3dd01
-  data.tar.gz: e0832ffbb1bf5d715b9041b09dc3bd28ade749b7f7366384d5aa10f007147ce74b8fa88bf790e035199ca06b7790af37d37a28ffc1d150613e137246ef3f1396
+  metadata.gz: d04519c274f0eaa98ecbb8cff280bce4e00d6691201c13490e4f13b8f3a4fc7ed920187de3d5d7dcc9049aa969b257efeacc55918f2a6311dd601d7fccf47e59
+  data.tar.gz: a2d8b34ff09c1d4deeae8441fb6c0ac4d7386d63cca1d5e01f2d254642690aa62d571f9ca8e05e108e69168b4024b766061083fcb296e35f2db7ee3ac6bcd1de

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    depengine (3.0.11)
+    depengine (3.0.12)
       expect4r (~> 0.0)
       json (~> 1.4)
       log4r (~> 1.1)
@@ -26,7 +26,7 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.25.1)
-    net-scp (1.1.2)
+    net-scp (1.2.0)
       net-ssh (>= 2.6.5)
     net-sftp (2.1.2)
       net-ssh (>= 2.6.5)

data/README.md

@@ -4,7 +4,7 @@
 `gem build depengine.gemspec`
 
 ## Usage
-  1. rvm use 1.9.3
+  1. rvm use 2.1.1
   2. bundle install
   3. bundle exec depengine
 
@@ -19,4 +19,40 @@ To run the specs, your machine needs to fulfill some requirements:
 
 There is a somewhat simplistic script to get a suitable environment up and running. Have a look at *bin/spec_setup*.
 
-`rspec`
+`rspec`
+
+## Documentation
+
+To see a list of all currently supported methods in the DSL, run `rake doc` and browse to: doc/table_of_contents.html#methods
+
+## Example recipe
+
+```
+set :application_name,         "testapp"
+set :module_name,              "testmodule"
+
+set :cleanup_workspace_before, ["source", "tmp"]
+
+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 "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)
+  end
+
+  report_by_mail
+  $log.writer.info "Sent mail to deployment team #{config['deploy_email_to']}"
+
+  $log.writer.info "Deployment done!"
+end
+```

data/Rakefile

@@ -9,3 +9,8 @@ task :build do
   sh "gem build -V depengine.gemspec"
 end
 
+desc "generates docs for the DSL"
+task :doc do
+  sh "rm -rf doc/"
+  sh "rdoc lib/depengine/dsl/*.rb"
+end

data/lib/depengine/cli.rb

@@ -39,9 +39,13 @@ module Depengine
 
         recipe_filename   = File.join(($recipe_config[:recipe_base_dir] || $recipe_config[:deploy_home]), @recipe_name)
         puts "Evaluating recipe #{recipe_filename}"
-        eval(File.new(recipe_filename).read)
+        evaluate_recipe!(File.open(recipe_filename).read)
         return 0
       end
+
+      def evaluate_recipe!(recipe)
+        eval(recipe)
+      end
     end
   end
 end

data/lib/depengine/dsl/deployment.rb

@@ -15,6 +15,9 @@ module Deployment
   end
 
   class Worker
+
+    attr_accessor :cdb
+
     def initialize
       # initialize logging
       if not $recipe_config[:log_level].nil?
@@ -47,18 +50,15 @@ module Deployment
       Helper.validates_not_empty $recipe_config[:version], "version is not set"
       Helper.validates_not_empty $recipe_config[:deploy_home], "deploy_home is not set"
 
-      # read configuration from cdb
-      $recipe_config['cdb_host'] ||= "filesystem"
-      $recipe_config['cdb_context'] ||= ""
-      @cdb = get_cdb_parameters(@version['cdb'])
-
-      # clean workspace if needed
-      if $recipe_config[:cleanup_workspace_before]
-         $log.writer.info "Remove all files from Workspace"
-        Helper.cleanup_workspace!($recipe_config[:deploy_home], $recipe_config[:cleanup_workspace_before])
+      if $recipe_config[:skip_cdb_setup]
+        @cdb = {}
+      else
+        $recipe_config['cdb_host'] ||= "filesystem"
+        $recipe_config['cdb_context'] ||= ""
+        @cdb = get_cdb_parameters(@version['cdb'])
       end
-      # init workspace with default directorys
-      Helper.init_workspace($recipe_config[:deploy_home])
+
+      setup_workspace!
 
       # the logfile needs a correct WORKSPACE and the initial dirs
       # so we have to set it here
@@ -107,6 +107,26 @@ module Deployment
       end
     end
 
+    def setup_workspace!
+      if $recipe_config[:cleanup_workspace_before]
+         $log.writer.info "Remove all files from Workspace"
+        Helper.cleanup_workspace!($recipe_config[:deploy_home], $recipe_config[:cleanup_workspace_before])
+      end
+
+      Helper.init_workspace($recipe_config[:deploy_home])
+
+      if $recipe_config[:copy_to_workspace]
+        $recipe_config[:copy_to_workspace] = ["config"] unless $recipe_config[:copy_to_workspace].respond_to?(:each)
+        $recipe_config[:copy_to_workspace].each do |dir|
+          copy_to_workspace!(dir)
+        end
+      end
+    end
+
+    def copy_to_workspace!(dir)
+      Processor::copy(File.join($recipe_config[:recipe_base_dir], dir), $recipe_config[:deploy_home])
+    end
+
     # access configdata like this...
     # @hudson['USER']
     # $recipe_config[:application_name]

data/lib/depengine/dsl/fileops.rb

@@ -1,29 +1,51 @@
 module Deployment
   module Methods
     module Fileops
+
+      # Copies a file or directory from a given source to a given target.<br>
+      # Both are prefixed with the recipes +:deploy_home+.
       def copy(source, target, options={})
         Processor.copy(File.join($recipe_config[:deploy_home], source), \
                        File.join($recipe_config[:deploy_home], target), \
                        options)
       end
 
+      # Recursively creates a directory with a given name/path.<br>
+      # The path will be prefixed with the recipes +:deploy_home+.
       def mkdir(directory)
         Processor.mkdir(File.join($recipe_config[:deploy_home], directory))
       end
 
+      # Changes permission modes on a given name/path.<br>
+      # The path will be prefixed with the recipes +:deploy_home+.
+      #
+      # Parameters:
+      # * +file+ - the file to change mode on
+      # * +mode+ - the new file permission mode (e.g. "644")
+      # * [+options+] - a hash with additional parameters. This is optional.
       def chmod(file, mode, options={})
         Processor.chmod(File.join($recipe_config[:deploy_home], file), \
                         mode, options)
       end
 
+      # Removes a given name/path.<br>
+      # The path will be prefixed with the recipes +:deploy_home+.
       def remove(file)
         Processor.remove(File.join($recipe_config[:deploy_home], file))
       end
 
+      # Creates a link from a given file to a given target.<br>
+      # The target be prefixed with the recipes +:deploy_home+.
       def mklink(source, target)
         Processor.mklink(source, File.join($recipe_config[:deploy_home], target))
       end
 
+      # Check for the existence of all files in a given list in a given directory.
+      #
+      # Parameters:
+      # * +list+ - a CSV list of filenames to check for
+      # * +target+ - the directory to check in.
+      # Both are prefixed with the recipes +:deploy_home+.
       def check_filelist(list, target)
         Processor.check_filelist(File.join($recipe_config[:deploy_home], list), \
                                  File.join($recipe_config[:deploy_home], target))

data/lib/depengine/dsl/helper.rb

@@ -1,48 +1,106 @@
 module Deployment
   module Methods
     module Helper
+
+      # Returns an time-dependant string that can be used in pseudo-unique
+      # release versions and the such.
+      #
+      # The object will be cached for later reference, so multiple uses of this
+      # method in a recipe will result in the same string.
+      #
+      # Parameters:
+      # * +format+ - the strftime format that is to be used to generate the unique string. Defaults to "%Y-%m-%d_%s".
+      def date_unique(format="%Y-%m-%d_%s")
+        @date_unique ||= Time.now.strftime(format)
+      end
+
+      # Sends an email.
+      #
+      # Parameters:
+      # * +options+ - a hash with needed configuration options for the email.
+      #   * +:body+ - the actual text to send
+      #   * +:subject+ - the subject line of the email
+      #   * +:from+ - the senders address
+      #   * +:to+ - the recipiants address
       def sendmail(options)
         Helper.validates_presence_of options[:from],    "Mail-FROM not set"
         Helper.validates_presence_of options[:to],      "Mail-TO not set"
         Helper.validates_presence_of options[:subject], "No mail subject set"
         Helper.validates_presence_of options[:body],    "No mail body set"
-        Helper.validates_presence_of @cdb['smtp_host'], "SMTP host not set"
 
         helper = ::Helper::Mail.new
-        helper.smtp_host = @cdb['smtp_host']
+        helper.smtp_host = @cdb['smtp_host'] if @cdb and @cdb['smtp_host']
         helper.sendmail(options)
       end
 
+      # Checks if a given url returns 200 and a body that matches a given regexp.
+      #
+      # Parameters:
+      # * +options+ - a hash with needed configuration options
+      #   * +:check_protocol+ - "http" or "https" or maybe something else...
+      #   * +:check_host+ - the host to contact
+      #   * +:check_port+ - the port to connect to
+      #   * +:check_uri+ - the recipiants address
+      #   * +:check_response_string+ - the string or regexp to check
       def assert_url_response_of(options={})
         asserter = ::Asserter::Url.new
         asserter.check_protocol  = options[:check_protocol] ||  @cdb['check_protocol'] || "http"
         asserter.check_host  = options[:check_host] || @cdb['check_host']
         asserter.check_port  = options[:check_port] || @cdb['check_port'] || '80'
         asserter.check_uri  = options[:check_uri] || @cdb['check_uri'] || '/'
-        asserter.check_response_string  = options[:chek_response_string] || @cdb['check_response_string'] || 'html'
+        asserter.check_response_string  = options[:check_response_string] || @cdb['check_response_string'] || 'html'
 
         asserter.assert_url_response_of(options)
       end
 
-      def report_to_cdb(options={})
+      # Reports a deployment to its cdb.
+      def report_to_cdb()
         reporter = ::Reporter::Cdb.new
         reporter.version  = @version.to_json
         reporter.worker  = self
-        reporter.set_version(options)
+        reporter.set_version()
       end
 
+      # Sends an email to report a deployment to a given recepiant.
+      #
+      # Parameters:
+      # * +options+ - a hash with needed configuration options for the email. All parameters are optional.
+      #   * +:application_name+ - which application has been deployed
+      #   * +:module_name+ - which module of the application has been deployed
+      #   * +:status+ - the resulting status of the deployment
+      #   * +:message+ - a additional message to send in the mail, commonly used to specify any non positive status.
+      #   * +:deploy_email_from+ - the senders address
+      #   * +:deploy_email_to+ - the recipiants address
       def report_by_mail(options={})
-        reporter = ::Reporter::Mail.new
-        reporter.deploy_email_from  = options[:deploy_email_from] || @cdb['deploy_email_from']
-        reporter.deploy_email_to  = options[:deploy_email_to] || @cdb['deploy_email_to']
-        reporter.application_name  = options[:application_name] ||  $recipe_config[:application_name] || @cdb['application_name']
-        reporter.module_name  = options[:module_name] ||  $recipe_config[:module_name] || @cdb['module_name']
-        reporter.environment  =  $recipe_config['ENVIRONMENT']
-        reporter.version  =  @version.to_json
-        reporter.worker  = self
-        reporter.send(options)
+        application_name  = options[:application_name] ||  $recipe_config[:application_name] || @cdb['application_name']
+        module_name  = options[:module_name] ||  $recipe_config[:module_name] || @cdb['module_name']
+
+        status = options[:status] || "done"
+        message = options[:message] || ""
+
+        mail_options = {
+          :from => options[:deploy_email_from] || @cdb['deploy_email_from'],
+          :to => options[:deploy_email_to] || @cdb['deploy_email_to'],
+          :subject => "DeploymentReport: #{module_name} #{$recipe_config['ENV']} #{application_name} #{status}",
+          :body => "Module: #{module_name}\nEnvironment:  #{$recipe_config['ENV']}\nJob: #{application_name}\nVersion: #{@version.to_json}\n#{status}.\n\n#{message}"
+        }
+        sendmail(mail_options)
       end
 
+      # Deploys a tomcat based application to a set of app servers. <br>
+      # The tomcats are restarted in this process.
+      #
+      # Parameters:
+      # * +options+ - a hash with needed configuration options.
+      #   * +:servers+ - an enumerable list of the app servers
+      #   * +:runners+ - a subset of +:servers+ which are currently active. Is equal to +:servers+ if not set
+      #   * +:initd_script+ - the path to the init script of the appserver. Used to stop/start.
+      #   * +:application_name+ - the name of the current application
+      #   * +:catalina_home+ - the path in which the app servers webapps/ directory is
+      #   * +:tomcat_context+ - the tomcat context to deploy in
+      #   * +:logfilename+ - the name of the logfile. Will be automatically prefixed with #{catalina_home}/logs/
+      #   * +:check_host+ - an options hash to pass to +#assert_url_response_of+ to check the status of the app
+      # All parameters can also be spcified via CDB.
       def tomcat_deploy(options={})
         publisher = ::Publisher::Tomcat.new
         publisher.servers  = options[:servers] || @cdb['servers']
@@ -57,6 +115,11 @@ module Deployment
         publisher.deploy(options)
       end
 
+      # Mounts a SMB share.
+      #
+      # Parameters:
+      # * +remote_path+ - the path to the remote share (e.g."smb://somehost/someshare")
+      # * +:local_path+ - the local path in which the share will be mounted
       def samba_mount (remote_path, local_path)
         smb                   = ::Helper::Smb.new
         smb.remote_path       = remote_path
@@ -64,6 +127,10 @@ module Deployment
         smb.samba_mount()
       end
 
+      # Unmounts a previously mounted SMB share.
+      #
+      # Parameters:
+      # * +:local_path+ - the local path in which the share is mounted
       def samba_umount (local_path)
         smb                   = ::Helper::Smb.new
         smb.local_path        = local_path

data/lib/depengine/dsl/iis.rb

@@ -16,9 +16,9 @@ module Deployment
         Helper.validates_presence_of $recipe_config['VALUE'], \
                                      "VALUE parameter is missing"
 
-        iis          = ::Publisher::Iis_build.new
-        iis.iis_build_protocol = @cdb['iis_build_protocol']
-        iis.iis_build_url     = @cdb['iis_build_url']
+        iis          = ::Publisher::IIS.new
+        iis.protocol = @cdb['iis_build_protocol']
+        iis.url     = @cdb['iis_build_url']
         if @cdb['http_read_timeout']
           iis.http_read_timeout = @cdb['http_read_timeout']
         else
@@ -40,9 +40,9 @@ module Deployment
         Helper.validates_presence_of  @version['app'], \
                                      "VERSION parameter is missing"
 
-        iis          = ::Publisher::Iis_deploy.new
-        iis.iis_deploy_protocol = @cdb['iis_deploy_protocol']
-        iis.iis_deploy_url     = options[:iis_deploy_url] || @cdb['iis_deploy_url']
+        iis          = ::Publisher::IIS.new
+        iis.protocol = @cdb['iis_deploy_protocol']
+        iis.url     = options[:iis_deploy_url] || @cdb['iis_deploy_url']
         if @cdb['http_read_timeout']
           iis.http_read_timeout = @cdb['http_read_timeout']
         else
@@ -59,9 +59,9 @@ module Deployment
         Helper.validates_presence_of $recipe_config['VALUE'], \
                                      "VALUE parameter is missing"
 
-        iis          = ::Publisher::Iis_appcmd.new
-        iis.iis_appcmd_protocol = @cdb['iis_appcmd_protocol']
-        iis.iis_appcmd_url     = @cdb['iis_appcmd_url']
+        iis          = ::Publisher::IIS.new
+        iis.protocol = @cdb['iis_appcmd_protocol']
+        iis.url     = @cdb['iis_appcmd_url']
         if @cdb['http_read_timeout']
           iis.http_read_timeout = @cdb['http_read_timeout']
         else

data/lib/depengine/dsl/patch.rb

@@ -3,23 +3,13 @@ module Deployment
     module Patch
 
       def patch_properties (source, target, options={})
-        patch_set = 'patch_properties'
-        if not options[:patch_set].nil?
-          patch_set = options[:patch_set]
-        end
-        Helper.validates_presence_of @cdb[patch_set], \
-           "Can not find a valid patch_set"
+        patch_set = options[:patch_set] || 'patch_properties'
+        Helper.validates_presence_of @cdb[patch_set], "Can not find a valid patch_set"
 
-        assigner = '='
-        if not options[:assigner].nil?
-          assigner = options[:assigner]
-        end
+        assigner = options[:assigner] || '='
 
         properties                 = Processor::Properties.new
         properties.properties_hash = @cdb[patch_set]
-        ### add db_endpoint
-        properties.properties_hash['db_endpoint_1'] = @cdb['db_endpoint_1']
-        properties.properties_hash['db_endpoint_2'] = @cdb['db_endpoint_2']      
         properties.assigner        = assigner
         properties.patch(File.join($recipe_config[:deploy_home], source), \
                          File.join($recipe_config[:deploy_home], target,  \

data/lib/depengine/dsl/repository.rb

@@ -77,28 +77,28 @@ module Deployment
       end
 
       def git_fetch(options={})
-        publisher = ::Publisher::Git.new
+        publisher = ::Provider::Git.new
         publisher.repository_url = options[:git_repository_url] || @cdb['git_repository_url']
         publisher.repository_local_dir = options[:git_repository_local] || @cdb['git_repository_local']
         publisher.fetch()
       end
 
       def git_checkout(branch_name, options={})
-        publisher = ::Publisher::Git.new
+        publisher = ::Provider::Git.new
         publisher.repository_url = options[:git_repository_url] || @cdb['git_repository_url']
         publisher.repository_local_dir = options[:git_repository_local] || @cdb['git_repository_local']
         publisher.checkout(branch_name, options)
       end
 
       def git_submodule(submodule_option, options={})
-        publisher = ::Publisher::Git.new
+        publisher = ::Provider::Git.new
         publisher.repository_url = options[:git_repository_url] || @cdb['git_repository_url']
         publisher.repository_local_dir = options[:git_repository_local] || @cdb['git_repository_local']
         publisher.submodule(submodule_option, options)
       end
 
       def git_tag(tag_name, options={})
-        publisher = ::Publisher::Git.new
+        publisher = ::Provider::Git.new
         publisher.repository_url = options[:git_repository_url] || @cdb['git_repository_url']
         publisher.repository_local_dir = options[:git_repository_local] || @cdb['git_repository_local']
         publisher.tag(tag_name, options)