fulmar 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48f13381dfd883f6eb5f0c44a15aae30a4625914
-  data.tar.gz: 52c89009ba658dc348df94c69e47940afd99f76b
+  metadata.gz: 6a8c600aba68edc3253bda3a138e56d76b38a283
+  data.tar.gz: 82c43b52167c6b2b478bf75b25a28697d72316d5
 SHA512:
-  metadata.gz: 34b44d1c3f492b53a15b8481d11d9bb33fde77a17e51ae2a72fb25f5560ee856f985ff84e96123c4306e976b6d18cdec949c11e259fe12cb8b8b836c37d80a0d
-  data.tar.gz: 1717d95355ec5ed3800809f2712477872f72380525f7d8b1132ab9a4fab522af94581613d12e3bf1192287ce72787b7f2ff5fa27baf469d7c0f0d4e8695c04ec
+  metadata.gz: 2738a4ead46f2ea844230efb8466d78c97150396eac1f1f7d74f7064c60f2e2532b69cf724b6212e247094fc839652397cf5575605af24acb893dc1ca387b1ef
+  data.tar.gz: 8295d787803f53c9e6d470ae1d4259f576f5bd20abdefc2e327cd3ca76c7faa4813d531301ef1f34e11b3b6151b2254d1d92cadffb2c697b5805252a3a313e84

data/README.md

@@ -292,6 +292,34 @@ before calling file_sync.publish to create the symlink (current => releases/2015
 As you probably figured out, your webserver uses the "current" symlink to get the base directory of your web
 application. Here, you would point it to /tmp/current/public or something like that.
 
+### Custom versioning
+
+When deploying via Gitlab CI, the current branch or tag is available in the environment variable `CI_COMMIT_REF_NAME`. You very likely want to use tags here and set something like
+
+```yaml
+  only:
+    - /^live_\d+\.\d+.\d+/
+```
+
+in your .gitlab-ci.yaml. This way, whenever you tag something with e.g. "live_1.2.0" and push it, a deployment will trigger. Fulmar can be configured to read the content of an environment variable and use that as
+the version name. So you can add `version_name` to your config and set it to the gitlab env variable:
+
+```yaml
+environments:
+  all:
+    local_path: .
+  my_server:
+    files:
+      hostname: my-ssh-server
+      remote_path: /tmp
+      type: rsync_with_versions
+      shared:
+        - data
+      version_name: CI_COMMIT_REF_NAME
+```
+
+This way, fulmar will call the release "live_1.2.0" instead of the current timestamp.
+
 ### Configuration templates
 
 Sometimes you need different versions of files on your different environments. An exmaple might be the .htaccess file.

data/lib/fulmar/domain/model/application.rb

@@ -8,7 +8,7 @@ module Fulmar
       class Application < Rake::Application
         def initialize
           super
-          @rakefiles = %w(fulmarfile Fulmarfile fulmarfile.rb Fulmarfile.rb)
+          @rakefiles = %w[fulmarfile Fulmarfile fulmarfile.rb Fulmarfile.rb]
         end
 
         def name
@@ -71,13 +71,13 @@ module Fulmar
             end
           ]
           options << [
-              '--debug',
-              nil,
-              'Run in debug mode.',
-              lambda do |_value|
-                configuration = Fulmar::Domain::Service::ConfigurationService.instance
-                configuration.debug = true
-              end
+            '--debug',
+            nil,
+            'Run in debug mode.',
+            lambda do |_value|
+              configuration = Fulmar::Domain::Service::ConfigurationService.instance
+              configuration.debug = true
+            end
           ]
           options
         end

data/lib/fulmar/domain/model/configuration.rb

@@ -29,8 +29,8 @@ module Fulmar
           if ready?
             @data[:environments][@environment][@target][id] = value
           else
-            fail 'Environment or target not set. Please set both variables via configuration.environment = \'xxx\' / '\
-                 'configuration.target = \'yyy\''
+            raise 'Environment or target not set. Please set both variables via configuration.environment = \'xxx\' / '\
+                  'configuration.target = \'yyy\''
           end
         end
 
@@ -50,8 +50,8 @@ module Fulmar
         # Checks if environment and target are set
         def ready?
           return false if @environment.nil? || @target.nil?
-          fail 'Environment is invalid' if @data[:environments][@environment].nil?
-          fail 'Target is invalid' if @data[:environments][@environment][@target].nil?
+          raise 'Environment is invalid' if @data[:environments][@environment].nil?
+          raise 'Target is invalid' if @data[:environments][@environment][@target].nil?
           true
         end
 

data/lib/fulmar/domain/service/config_test_service.rb

@@ -14,11 +14,11 @@ module Fulmar
         end
 
         def target_test(name, &block)
-          @tests[name] = Proc.new do
+          @tests[name] = proc do
             results = []
             @config.each do |env, target, _data|
               @config.set env, target
-              result = block.call(@config)
+              result = yield(@config)
               if result
                 result[:message] = "in [#{env}:#{target}]: #{result[:message]}"
                 results << result

data/lib/fulmar/domain/service/config_tests/hosts.rb

@@ -2,7 +2,7 @@ target_test 'hostname is set' do |config|
   if config[:hostname].blank? && !config[:host].blank?
     next {
       severity: :warning,
-      message: "config has a host (#{[:host]}) but is missing a hostname"
+      message: "config has a host (#{config[:host]}) but is missing a hostname"
     }
   end
 end
@@ -16,8 +16,8 @@ target_test 'hostnames in ssh config' do |config|
 end
 
 target_test 'required hostnames' do |config|
-  types = %i(rsync rsync_with_version maria)
+  types = %i[rsync rsync_with_version maria]
   if types.include?(config[:type]) && config[:hostname].blank?
-    next {severity: :error, message: "config requires a hostname (#{config[:hostname]})"}
+    next { severity: :error, message: "config requires a hostname (#{config[:hostname]})" }
   end
 end

data/lib/fulmar/domain/service/config_tests/misc.rb

@@ -1,5 +1,4 @@
-relevant_options = [:rsync, :local_path, :remote_path, :host, :hostname, :shared, :templates,
-  :ssh_config, :type]
+relevant_options = %i[rsync local_path remote_path host hostname shared templates ssh_config type]
 relevant_options.each do |option|
   target_test "empty configuration settings #{option}" do |config|
     if config.key?(option) && config[option].nil?

data/lib/fulmar/domain/service/config_tests/paths.rb

@@ -8,8 +8,8 @@ target_test 'local path exists' do |config|
 end
 
 target_test 'remote_path is set' do |config|
-  types = %w(rsync rsync_with_version)
+  types = %w[rsync rsync_with_version]
   if types.include?(config[:type]) && config[:remote_path].blank?
-    next {severity: :error, message: 'config is missing a remote path for rsync'}
+    next { severity: :error, message: 'config is missing a remote path for rsync' }
   end
 end

data/lib/fulmar/domain/service/config_tests/project.rb

@@ -1,5 +1,8 @@
 global_test 'project name is set' do |config|
-  next {severity: :warning,
-        message: 'Project name is not set (must be short, no spaces)'
-  } if config.project.name.blank?
+  if config.project.name.blank?
+    next {
+      severity: :warning,
+      message: 'Project name is not set (must be short, no spaces)'
+    }
+  end
 end

data/lib/fulmar/domain/service/file_sync_service.rb

@@ -17,7 +17,7 @@ module Fulmar
       else
         help = config[:type] == '' ? 'Add a "type: " field to your deployment yaml file. ' : ''
         transfer_model = nil
-        fail "Transfer type '#{config[:type]}' is not valid. #{help}Valid values are: rsync, rsync_with_versions."
+        raise "Transfer type '#{config[:type]}' is not valid. #{help}Valid values are: rsync, rsync_with_versions."
       end
 
       transfer_model

data/lib/fulmar/domain/service/helper/common_helper.rb

@@ -58,7 +58,7 @@ module Fulmar
           end
 
           def storage
-            fail 'You need to set an environment and a target first' unless config.ready?
+            raise 'You need to set an environment and a target first' unless config.ready?
             @storage ||= {}
             @storage[config.environment] ||= {}
             @storage[config.environment][config.target] ||= {}

data/lib/fulmar/domain/service/plugin_service.rb

@@ -17,8 +17,8 @@ module Fulmar
           config = ConfigurationService.instance.configuration
 
           if config.plugins.class == Array
-            fail 'Plugin list must not be an array. Have a look at https://github.com/CORE4/fulmar#plugins for ' +
-                   'more information'
+            raise 'Plugin list must not be an array. Have a look at https://github.com/CORE4/fulmar#plugins for ' +
+                  'more information'
           end
 
           config.plugins.each_pair do |name, plugin_config|

data/lib/fulmar/domain/service/template_rendering_service.rb

@@ -22,8 +22,8 @@ module Fulmar
 
         def template_path(template_file)
           template = "#{@config[:local_path]}/#{template_file}"
-          fail "Template filenames must end in .erb - '#{template}' does not" unless template[-4, 4] == '.erb'
-          fail "Cannot render missing config file '#{template}'" unless File.exist? template
+          raise "Template filenames must end in .erb - '#{template}' does not" unless template[-4, 4] == '.erb'
+          raise "Cannot render missing config file '#{template}'" unless File.exist? template
           template
         end
       end

data/lib/fulmar/infrastructure/model/transfer/base.rb

@@ -13,7 +13,7 @@ module Fulmar
             remote_path: nil,
             local_path: '.',
             type: :rsync_with_versions
-          }
+          }.freeze
 
           attr_accessor :config
 
@@ -31,9 +31,9 @@ module Fulmar
 
           # Test the supplied config for required parameters
           def test_config
-            required = [:host, :remote_path, :local_path]
-            required.each { |key| fail "Configuration is missing required setting '#{key}'." if @config.blank? }
-            fail ':remote_path must be absolute' if @config[:remote_path][0, 1] != '/'
+            required = %i[host remote_path local_path]
+            required.each { |key| raise "Configuration is missing required setting '#{key}'." if @config.blank? }
+            raise ':remote_path must be absolute' if @config[:remote_path][0, 1] != '/'
           end
 
           def prepare

data/lib/fulmar/infrastructure/model/transfer/rsync.rb

@@ -27,7 +27,7 @@ module Fulmar
               @config[:rsync][:exclude_file] = @config[:local_path] + '/.rsyncignore'
             end
 
-            fail 'Hostname not set. Cannot initialize sync.' if @config[:hostname].nil? || @config[:hostname].empty?
+            raise 'Hostname not set. Cannot initialize sync.' if @config[:hostname].nil? || @config[:hostname].empty?
 
             super(@config)
           end

data/lib/fulmar/infrastructure/model/transfer/rsync_with_versions.rb

@@ -12,8 +12,8 @@ module Fulmar
         # Every deployment results in a new directory in the releases directory with the deployment time as
         # the folder name. A symlink 'current' points to this new directory after publish() is called.
         class RsyncWithVersions < Base
-          TIME_FOLDER = '%Y-%m-%d_%H%M%S'
-          TIME_READABLE = '%Y-%m-%d %H:%M:%S'
+          TIME_FOLDER = '%Y-%m-%d_%H%M%S'.freeze
+          TIME_READABLE = '%Y-%m-%d %H:%M:%S'.freeze
 
           DEFAULT_CONFIG = {
             temp_dir: 'temp',
@@ -28,8 +28,9 @@ module Fulmar
             },
             symlinks: {},
             limit_releases: 5,
+            version_name: Time.now.strftime('%Y-%m-%d_%H%M%S'),
             shared: []
-          }
+          }.freeze
 
           # @param [Fulmar::Domain::Service::ConfigurationService] config
           def initialize(config)
@@ -40,8 +41,6 @@ module Fulmar
             if @config[:rsync][:exclude_file].blank? && File.exist?(@config[:local_path] + '/.rsyncignore')
               @config[:rsync][:exclude_file] = @config[:local_path] + '/.rsyncignore'
             end
-
-            @release_time = Time.now
           end
 
           # Ensures all needed services are set up
@@ -49,6 +48,10 @@ module Fulmar
             super
             @remote_shell = Fulmar::Shell.new @config[:remote_path], @config.ssh_user_and_host
             @remote_shell.debug = @config[:debug]
+
+            if /^[A-Z][A-Z0-9\-_]+$/ =~ @config[:version_name]
+              @config[:version_name] = ENV[@config[:version_name]].split('/').last
+            end
           end
 
           # Copy the files via rsync to the release_path on the remote machine
@@ -56,10 +59,10 @@ module Fulmar
           def transfer
             prepare unless @prepared
 
-            fail 'Deployment failed when trying to prepare remote directories for sync.' unless create_paths
-            fail 'Deployment failed. Cannot sync files.' unless @local_shell.run(rsync_command)
-            fail 'Deployment failed when trying to move file from temporary upload dir.' unless copy_temp_to_release
-            fail 'Deployment failed when creating symlinks for shared folders' unless add_shared
+            raise 'Deployment failed when trying to prepare remote directories for sync.' unless create_paths
+            raise 'Deployment failed. Cannot sync files.' unless @local_shell.run(rsync_command)
+            raise 'Deployment failed when trying to move file from temporary upload dir.' unless copy_temp_to_release
+            raise 'Deployment failed when creating symlinks for shared folders' unless add_shared
           end
 
           # Publishes the current release (i.e. sets the 'current' symlink)
@@ -78,7 +81,7 @@ module Fulmar
           # Gets the currently generated release directory
           # @return [String] the release directory
           def release_dir
-            @config[:releases_dir] + '/' + @release_time.strftime('%Y-%m-%d_%H%M%S')
+            @config[:releases_dir] + '/' + @config[:version_name]
           end
 
           # Lists the existing releases on the remote machine
@@ -86,13 +89,17 @@ module Fulmar
           # @return [Array] list of dirs or dates/times
           def list_releases(plain = true)
             prepare unless @prepared
-            @remote_shell.run "ls -1 '#{@config[:releases_dir]}'"
-            list = @remote_shell.last_output.select { |dir| dir.match(/^\d{4}-\d{2}-\d{2}_\d{6}/) }
+            @remote_shell.run "ls -1tr '#{@config[:releases_dir]}'"
+            list = @remote_shell.last_output
             return list if plain
 
             current = current_release
             list.collect do |item|
-              Time.strptime(item, TIME_FOLDER).strftime(TIME_READABLE) + (item == current ? ' *' : '')
+              if item =~ /^\d{4}-\d{2}-\d{2}_\d{6}/
+                Time.strptime(item, TIME_FOLDER).strftime(TIME_READABLE) + (item == current ? ' *' : '')
+              else
+                item + (item == current ? ' *' : '')
+              end
             end
           end
 
@@ -101,7 +108,7 @@ module Fulmar
           def cleanup
             limit = @config[:limit_releases].to_i
             return true unless limit > 0
-            releases = list_releases.sort
+            releases = list_releases
             return true if releases.length <= limit
             obsolete_dirs = releases[0, releases.length - limit].collect { |dir| "\"#{@config[:releases_dir]}/#{dir}\"" }
             @remote_shell.run "rm -fr #{obsolete_dirs.join(' ')}"
@@ -124,7 +131,7 @@ module Fulmar
             return false if release.nil?
 
             # Convenience: Allow more readable version string from output
-            if release.match(/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}/)
+            if release =~ /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}/
               release = Time.strptime(item, TIME_READABLE).strftime(TIME_FOLDER)
             end
 
@@ -136,15 +143,15 @@ module Fulmar
           def last_release
             list = list_releases
             current = current_release
-            current_index = list.index(current)
-            (current_index.nil? || current_index == 0) ? nil : list[current_index - 1]
+            current_index = list.index(current).to_i
+            current_index.zero? ? nil : list[current_index - 1]
           end
 
           # Creates all necessary paths on the remote machine
           # @return [true, false] success
           def create_paths
             paths = [@config[:releases_dir], @config[:temp_dir], @config[:shared_dir]]
-            @remote_shell.run paths.collect { |path| "mkdir -p '#{@config[:remote_path]}/#{path}'" }
+            @remote_shell.run(paths.collect { |path| "mkdir -p '#{@config[:remote_path]}/#{path}'" })
           end
 
           def rsync_excludes
@@ -156,7 +163,7 @@ module Fulmar
           # Builds the rsync command
           # @return [String] the command
           def rsync_command
-            options = %w(-rl --delete-excluded)
+            options = %w[-rl --delete-excluded]
             options << rsync_excludes if rsync_excludes
             options << "--exclude-from='#{@config[:rsync][:exclude_file]}'" if @config[:rsync][:exclude_file]
             options << "--chown='#{@config[:rsync][:chown]}'" if @config[:rsync][:chown]

data/lib/fulmar/infrastructure/service/ssh_config_service.rb

@@ -8,8 +8,8 @@ module Fulmar
     module Service
       # Adds entries to the ssh config and checks for existing ones
       class SSHConfigService
-        DEFAULT_CONFIG_FILE = "#{ENV['HOME']}/.ssh/config"
-        DEFAULT_KNOWN_HOSTS_FILE = "#{ENV['HOME']}/.ssh/known_hosts"
+        DEFAULT_CONFIG_FILE = "#{ENV['HOME']}/.ssh/config".freeze
+        DEFAULT_KNOWN_HOSTS_FILE = "#{ENV['HOME']}/.ssh/known_hosts".freeze
 
         attr_accessor :config_file, :known_host_file, :quiet
 
@@ -55,7 +55,7 @@ module Fulmar
           input_file = File.open(@known_hosts_file, 'r')
           output_file = File.open(@known_hosts_file + '.temp', 'w')
           while (line = input_file.gets)
-            output_file.puts(line) unless /^\[?#{hostname.gsub('.', '\\.')}(?:\]:\d+)?[ ,]/.match(line)
+            output_file.puts(line) unless /^\[?#{hostname.gsub('.', '\\.')}(?:\]:\d+)?[ ,]/ =~ line
           end
           input_file.close
           output_file.close
@@ -77,7 +77,7 @@ module Fulmar
         def host_exists?(hostname)
           config_file = File.open(@config_file, 'r')
           while (line = config_file.gets)
-            if /\s*Host #{hostname.gsub('.', '\\.')}\s*$/.match(line)
+            if /\s*Host #{hostname.gsub('.', '\\.')}\s*$/ =~ line
               config_file.close
               return true
             end
@@ -91,7 +91,7 @@ module Fulmar
           puts "Adding host #{hostname}..." if @config[:debug]
           config_file = File.open(@config_file, 'a')
 
-          unless ssh_config[:IdentityFile].blank? or ssh_config[:IdentityFile][0, 1] == '/'
+          unless ssh_config[:IdentityFile].blank? || ssh_config[:IdentityFile][0, 1] == '/'
             ssh_config[:IdentityFile] = @config.base_path + '/' + ssh_config[:IdentityFile]
           end
 
@@ -108,7 +108,7 @@ module Fulmar
         protected
 
         def host_entry(hostname, ssh_config = {})
-          unless ssh_config[:IdentityFile].blank? or ssh_config[:IdentityFile][0, 1] == '/'
+          unless ssh_config[:IdentityFile].blank? || ssh_config[:IdentityFile][0, 1] == '/'
             ssh_config[:IdentityFile] = @config.base_path + '/' + ssh_config[:IdentityFile]
           end
 
@@ -142,9 +142,7 @@ module Fulmar
         end
 
         def remove_trailing_newlines(data)
-          while !data.empty? && data.last.strip.empty?
-            data.pop
-          end
+          data.pop while !data.empty? && data.last.strip.empty?
           data
         end
 
@@ -155,9 +153,7 @@ module Fulmar
             if line.strip[0] == '#'
               cache << line
             else
-              if /^Host\s#{hostname}$/.match line.strip
-                return remove_trailing_newlines(before)
-              end
+              return remove_trailing_newlines(before) if /^Host\s#{hostname}$/ =~ line.strip
               before += cache
               cache = []
               before << line
@@ -178,9 +174,7 @@ module Fulmar
             if line.strip[0] == '#'
               cache << line
             else
-              if /^Host\s/.match line.strip
-                write = true
-              end
+              write = true if /^Host\s/ =~ line.strip
               if write
                 after += cache
                 after << line

data/lib/fulmar/version.rb

@@ -1,4 +1,4 @@
 # Provides a global version number
 module Fulmar
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fulmar
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Jonas Siegl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A deployment task manager.