fulmar 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b386982a3ab26556fd6efa59581e8431d768234
-  data.tar.gz: 8c06a406efb3477836ceba7c40ed3d418949ae7f
+  metadata.gz: b5773cc97e0e9d8615d47d72ee31a9d9b0438e6b
+  data.tar.gz: 9f2702193748a1561335ef13eacad2ba07acd6d6
 SHA512:
-  metadata.gz: 4d4fd4a803b9c83b4a74dd3042501567ce731c57ee6b414094205f8ebe6d5ae83c62395e4d788d680c54ed9218181ee73570f15c79cda5faa24513fed811f3b8
-  data.tar.gz: cd186eb2339d4b36ea5dc171c849201b34f4cd7308454bb8ddf55de431d7e2614676d9413582d3344260fe5dc2dbcf9e2d13955e2575df88794c8da9215fbe66
+  metadata.gz: eff45b616da762576e948fe24d2c0ebc201a8f3cea1e134c687c5e6d5d77db2ee4e5bd7a224c82720d737eaf046f6caef7b463deafa4a330f8d0554661f9ad54
+  data.tar.gz: 0aeedda8a394b79420f082ebc3a91c2ad08ab4e20e2c9217ba32e3a0597bab662d2f243afb8ce4986690ffcfcef220e4f175edc1531e831fef60d9d5e67bafb4

data/.gitignore

@@ -14,6 +14,8 @@
 mkmf.log
 /.idea/
 *.gem
+*.bak
+spec/fixtures/ssh_config/temp_*
 /.vagrant
 /Vagrantfile
 /vendor

data/fulmar.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'fulmar-shell', '~>1', '>=1.7.0'
   spec.add_runtime_dependency 'colorize', '~>0'
   spec.add_runtime_dependency 'activesupport', '~> 5.0'
+  spec.add_runtime_dependency 'diffy', '~> 3.2'
 end

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

@@ -94,22 +94,9 @@ module Fulmar
           @data[:hosts]
         end
 
-        # Check for a feature
-        # @todo Do we still need this? Maybe replace this with a "plugin?" method?
-        def feature?(feature)
-          return @data[:features].include? feature.to_s unless @data[:features].nil?
-          case feature
-          when :maria
-            key? :maria
-          else
-            false
-          end
-        end
-
         # Checks if a configuration key exists in one of the targets
         def key?(key)
-          each { |_env, _target, data| return true unless data[key].nil? }
-          false
+          ready? ? @data[:environments][@environment][@target].key?(key) : false
         end
 
         # Merge another configuration into the currently active one

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

@@ -0,0 +1,21 @@
+relevant_options = [: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?
+      next {
+        severity: :warning,
+        message: "config setting '#{option}' is set to nil/null, this might overwrite default settings"
+      }
+    end
+  end
+end
+
+target_test 'test if at least one shared directory exists' do |config|
+  if config[:type] == 'rsync_with_versions' && (config[:shared].nil? || config[:shared].empty?)
+    next {
+      severity: warning,
+      message: 'config does not contain a shared directory for versioning'
+    }
+  end
+end

data/lib/fulmar/domain/task/configuration.rake

@@ -43,3 +43,17 @@ namespace :test do
     info "Feelin' fine." if error_count == 0
   end
 end
+
+if File.exist?("#{Fulmar::Infrastructure::Service::SSHConfigService::DEFAULT_CONFIG_FILE}.bak")
+  namespace :revert do
+    task :ssh_config do
+      config = Fulmar::Infrastructure::Service::SSHConfigService::DEFAULT_CONFIG_FILE
+      backup = "#{config}.bak"
+      temp = "#{config}.tmp"
+      FileUtils.cp config, temp
+      FileUtils.cp backup, config
+      FileUtils.mv temp, backup
+      Fulmar::Infrastructure::Service::SSHConfigService.new(config).show_diff
+    end
+  end
+end

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

@@ -190,6 +190,8 @@ module Fulmar
           # @return [true, false] success
           def add_shared
             commands = [] # Collect all remote commands first, then execute them in one step to avoid reconnecting very often
+            return true if @config[:shared].nil? || @config[:shared].empty?
+
             @config[:shared].each do |path|
               commands << "mkdir -p \"#{release_dir}/#{File.dirname(path)}\""
 

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

@@ -1,45 +1,81 @@
 require 'fulmar/shell'
+require 'pp'
+require 'diffy'
+require 'active_support/core_ext/object/blank'
 
 module Fulmar
   module Infrastructure
     module Service
       # Adds entries to the ssh config and checks for existing ones
       class SSHConfigService
-        CONFIG_FILE = "#{ENV['HOME']}/.ssh/config"
-        KNOWN_HOST_FILE = "#{ENV['HOME']}/.ssh/known_hosts"
+        DEFAULT_CONFIG_FILE = "#{ENV['HOME']}/.ssh/config"
+        DEFAULT_KNOWN_HOSTS_FILE = "#{ENV['HOME']}/.ssh/known_hosts"
 
-        def initialize(config)
+        attr_accessor :config_file, :known_host_file, :quiet
+
+        def initialize(config, config_file = DEFAULT_CONFIG_FILE, known_hosts_file = DEFAULT_KNOWN_HOSTS_FILE)
           @config = config
+          @config_file = config_file
+          @known_hosts_file = known_hosts_file
+          @quiet = false
+        end
+
+        def changed?
+          File.read(@config_file) != File.read("#{@config_file}.bak")
+        end
+
+        def diff(type = :color)
+          before = File.read("#{@config_file}.bak")
+          after = File.read(@config_file)
+          Diffy::Diff.new(before, after, context: 3).to_s(type)
+        end
+
+        def show_diff
+          return if @quiet || !changed?
+          puts 'You ssh host configuration changed: '
+          puts '--------------- DIFF ---------------'
+          puts diff
+          puts '--------------- /DIFF --------------'
+          puts 'You can revert these changes by running "fulmar revert:ssh_config"'
         end
 
         def add_hosts
+          backup_file
           @config.hosts.values.each do |data|
             unless config_valid?(data)
               puts "Skipping #{data[:hostname]}, config not sufficient." if @config[:debug]
               next
             end
-            if host_exists?(data[:hostname])
-              puts "Host #{data[:hostname]} exists, skipping..." if @config[:debug]
-            else
-              add_host(data[:hostname], data[:ssh_config])
-            end
+            edit_host(data[:hostname], data[:ssh_config])
           end
+          show_diff
         end
 
         def remove_known_host(hostname)
-          input_file = File.open(KNOWN_HOST_FILE, 'r')
-          output_file = File.open(KNOWN_HOST_FILE + '.temp', 'w')
+          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)
           end
           input_file.close
           output_file.close
-          FileUtils.mv(KNOWN_HOST_FILE + '.temp', KNOWN_HOST_FILE)
+          FileUtils.mv(@known_hosts_file + '.temp', @known_hosts_file)
+        end
+
+        def edit_host(hostname, ssh_config)
+          data = read_file
+          new_data = block_before(data.clone, hostname) +
+                     host_entry(hostname, ssh_config) +
+                     block_after(data, hostname)
+
+          File.open(@config_file, 'w') do |file|
+            file.puts new_data.join("\n")
+          end
         end
 
         # Parses the users ssh config for an existing hostname
         def host_exists?(hostname)
-          config_file = File.open(CONFIG_FILE, 'r')
+          config_file = File.open(@config_file, 'r')
           while (line = config_file.gets)
             if /\s*Host #{hostname.gsub('.', '\\.')}\s*$/.match(line)
               config_file.close
@@ -53,29 +89,108 @@ module Fulmar
         # Adds a host to the ssh config file
         def add_host(hostname, ssh_config = {})
           puts "Adding host #{hostname}..." if @config[:debug]
-          config_file = File.open(CONFIG_FILE, 'a')
+          config_file = File.open(@config_file, 'a')
 
           unless ssh_config[:IdentityFile].blank? or ssh_config[:IdentityFile][0, 1] == '/'
             ssh_config[:IdentityFile] = @config.base_path + '/' + ssh_config[:IdentityFile]
           end
 
-          config_file.puts "\n" # Add some space between this and the second last entry
-          config_file.puts "# Automatically generated by fulmar for project '#{@config.project.description}'"
-          config_file.puts "Host #{hostname}"
-          ssh_config.keys.each do |key|
-            value = ssh_config[key].to_s
-            value = "\"#{value.gsub('"', '\\"')}\"" if value.include?(' ')
-            config_file.puts "    #{key} #{value}"
-          end
+          config_file.puts host_entry(hostname, ssh_config)
 
           config_file.close
         end
 
-        private
+        def backup_file
+          backup_filename = "#{@config_file}.bak"
+          FileUtils.cp @config_file, backup_filename
+        end
+
+        protected
+
+        def host_entry(hostname, ssh_config = {})
+          unless ssh_config[:IdentityFile].blank? or ssh_config[:IdentityFile][0, 1] == '/'
+            ssh_config[:IdentityFile] = @config.base_path + '/' + ssh_config[:IdentityFile]
+          end
+
+          entry = [
+            '', # Add some space between this and the second last entry
+            "# Automatically generated by fulmar for project '#{@config.project.description}'",
+            "Host #{hostname}"
+          ]
+          ssh_config.keys.each { |key| entry << "    #{key} #{escape_value(ssh_config[key])}" }
+          entry << ''
+          entry
+        end
+
+        def escape_value(value)
+          value = value.to_s
+          value = "\"#{value.gsub('"', '\\"')}\"" if value.include?(' ')
+          value
+        end
+
+        def read_file
+          config_file_data = []
+          File.open(@config_file, 'r') do |file|
+            until file.eof?
+              config_file_data << file.gets.chomp
+            end
+          end
+          config_file_data
+        end
 
         def config_valid?(host_config)
           (!host_config[:hostname].blank? && !host_config[:ssh_config].nil?)
         end
+
+        def remove_trailing_newlines(data)
+          while !data.empty? && data.last.strip.empty?
+            data.pop
+          end
+          data
+        end
+
+        def block_before(data, hostname)
+          cache = []
+          before = []
+          data.each do |line|
+            if line.strip[0] == '#'
+              cache << line
+            else
+              if /^Host\s#{hostname}$/.match line.strip
+                return remove_trailing_newlines(before)
+              end
+              before += cache
+              cache = []
+              before << line
+            end
+          end
+          remove_trailing_newlines(before)
+        end
+
+        def block_after(data, hostname)
+          data = data.drop_while { |i| !/^Host\s#{hostname}$/.match(i.strip) }
+          return [] if data.empty?
+          data.shift
+
+          after = []
+          cache = []
+          write = false
+          data.each do |line|
+            if line.strip[0] == '#'
+              cache << line
+            else
+              if /^Host\s/.match line.strip
+                write = true
+              end
+              if write
+                after += cache
+                after << line
+              end
+              cache = []
+            end
+          end
+          remove_trailing_newlines(after)
+        end
       end
     end
   end

data/lib/fulmar/version.rb

@@ -1,4 +1,4 @@
 # Provides a global version number
 module Fulmar
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 end

data/spec/fixtures/ssh_config/default_config.txt

@@ -0,0 +1,16 @@
+Host testhost examplehost foo-host
+    SendEnv FOO
+
+Host testhost
+    Hostname testhost.example.om
+    Port 1234
+    User nobody
+
+# trailing comment 4711
+
+# host comment 0815
+Host examplehost
+    Hostname example.com
+    IdentityFile /tmp/private.key
+    # ProxyCommand whoop whoop whoop
+    Port 4321

data/spec/lib/fulmar/service/ssh_config_service_spec.rb

@@ -0,0 +1,122 @@
+require 'fulmar/infrastructure/service/ssh_config_service'
+
+DEFAULT_CONFIG_FILE = "#{File.dirname(__FILE__)}/../../../fixtures/ssh_config/default_config.txt"
+DEFAULT_KNOWN_HOSTS_FILE = "#{File.dirname(__FILE__)}/../../../fixtures/ssh_config/default_known_hosts.txt"
+CONFIG_TEMP_FILE = "#{File.dirname(__FILE__)}/../../../fixtures/ssh_config/temp_config.txt"
+KNOWN_HOSTS_TEMP_FILE = "#{File.dirname(__FILE__)}/../../../fixtures/ssh_config/temp_known_hosts.txt"
+
+class MockProject
+  attr_accessor :name, :description
+end
+
+class MockConfig
+  def hosts
+    []
+  end
+
+  def project
+    MockProject.new
+  end
+end
+
+def new_service(config_file = DEFAULT_CONFIG_FILE, known_hosts_file = DEFAULT_KNOWN_HOSTS_FILE)
+  FileUtils.cp config_file, CONFIG_TEMP_FILE
+  FileUtils.cp known_hosts_file, KNOWN_HOSTS_TEMP_FILE
+  service = Fulmar::Infrastructure::Service::SSHConfigService.new(MockConfig.new, CONFIG_TEMP_FILE, KNOWN_HOSTS_TEMP_FILE)
+  service.backup_file
+  service
+end
+
+describe Fulmar::Infrastructure::Service::SSHConfigService do
+  after :each do
+    FileUtils.rm "#{CONFIG_TEMP_FILE}.bak"
+  end
+
+  describe '#edit_host' do
+    it 'should create a backup file' do
+      service = new_service
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      expect(File.exist?("#{CONFIG_TEMP_FILE}.bak")).to be true
+    end
+
+    it 'should add a host' do
+      service = new_service
+      service.edit_host('test_new', {'Hostname' => '123.example.com'})
+      expect(File.read(CONFIG_TEMP_FILE)).to include('testhost')
+      expect(File.read(CONFIG_TEMP_FILE)).to include('test_new')
+    end
+
+    it 'should replace an existing host' do
+      service = new_service
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      expect(File.read(CONFIG_TEMP_FILE)).not_to include('1234')
+    end
+
+    it 'should keep a trailing comment above the edited host entry' do
+      service = new_service
+      service.edit_host('examplehost', {'Hostname' => '123.example.com'})
+      expect(File.read(CONFIG_TEMP_FILE)).to include('trailing comment 4711')
+    end
+
+    it 'should keep replace the host comment above the edited host entry' do
+      service = new_service
+      service.edit_host('examplehost', {'Hostname' => '123.example.com'})
+      expect(File.read(CONFIG_TEMP_FILE)).not_to include('host comment 0815')
+    end
+
+    it 'should keep the number of hosts when replacing one' do
+      service = new_service
+      service.edit_host('examplehost', {'Hostname' => '123.example.com'})
+      before = File.read("#{CONFIG_TEMP_FILE}.bak").scan(/Host /).size
+      expect(File.read(CONFIG_TEMP_FILE).scan(/Host /).size).to eql(before)
+    end
+
+    it 'should increase the number of hosts when adding one' do
+      service = new_service
+      service.edit_host('examplehost2', {'Hostname' => '123.example.com'})
+      before = File.read("#{CONFIG_TEMP_FILE}.bak").scan(/Host /).size
+      expect(File.read(CONFIG_TEMP_FILE).scan(/Host /).size).to eql(before + 1)
+    end
+
+    it 'should keep comments within unaffected host blocks' do
+      service = new_service
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      expect(File.read(CONFIG_TEMP_FILE)).to include('whoop whoop whoop')
+    end
+
+    it 'should not add more new lines with every call' do
+      service = new_service
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      expect(File.read(CONFIG_TEMP_FILE)).not_to include("\n\n\n")
+    end
+
+    it 'should not change the file on a second run' do
+      service = new_service
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      service.backup_file
+      service.edit_host('testhost', {'Hostname' => '123.example.com'})
+      before = File.read("#{CONFIG_TEMP_FILE}.bak")
+      after = File.read(CONFIG_TEMP_FILE)
+      expect(after).to eql(before)
+    end
+  end
+
+  describe '#remove_trailing_newlines' do
+    it 'should remove multiple newlines from an array' do
+      service = new_service
+      test_array = ['test', '', '', '']
+      result = service.send(:remove_trailing_newlines, test_array)
+      expect(result).to eql(['test'])
+    end
+
+    it 'should not touch non-empty lines' do
+      service = new_service
+      test_array = %w[test foo bar]
+      result = service.send(:remove_trailing_newlines, test_array)
+      expect(result).to eql(test_array)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fulmar
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Jonas Siegl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Fulmar is a task manager for deployments.
 email:
 - j.siegl@core4.de
@@ -113,6 +127,7 @@ files:
 - lib/fulmar/domain/service/config_test_service.rb
 - lib/fulmar/domain/service/config_tests/compatibility.rb
 - lib/fulmar/domain/service/config_tests/hosts.rb
+- lib/fulmar/domain/service/config_tests/misc.rb
 - lib/fulmar/domain/service/config_tests/paths.rb
 - lib/fulmar/domain/service/config_tests/project.rb
 - lib/fulmar/domain/service/configuration_service.rb
@@ -139,9 +154,12 @@ files:
 - lib/fulmar/service/helper_service.rb
 - lib/fulmar/task_manager.rb
 - lib/fulmar/version.rb
+- spec/fixtures/ssh_config/default_config.txt
+- spec/fixtures/ssh_config/default_known_hosts.txt
 - spec/lib/fulmar/model/configuration_spec.rb
 - spec/lib/fulmar/service/helper_service_spec.rb
 - spec/lib/fulmar/service/plugin_service_spec.rb
+- spec/lib/fulmar/service/ssh_config_service_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/CORE4/fulmar
 licenses:
@@ -168,7 +186,10 @@ signing_key:
 specification_version: 4
 summary: A deployment task manager.
 test_files:
+- spec/fixtures/ssh_config/default_config.txt
+- spec/fixtures/ssh_config/default_known_hosts.txt
 - spec/lib/fulmar/model/configuration_spec.rb
 - spec/lib/fulmar/service/helper_service_spec.rb
 - spec/lib/fulmar/service/plugin_service_spec.rb
+- spec/lib/fulmar/service/ssh_config_service_spec.rb
 - spec/spec_helper.rb