fulmar 1.10.1 → 2.0.0

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

@@ -1,12 +1,12 @@
 desc 'Open an interactive terminal within fulmar'
-task :console, [:environment] do |t, args|
+task :console, [:environment] do |_t, args|
   require 'irb'
   require 'irb/completion'
   ARGV.clear
   if args[:environment] && args[:environment].include?(':')
     environment, target = args[:environment].split(':')
-    configuration.environment = environment
-    configuration.target = target
+    config.environment = environment.to_sym
+    config.target = target.to_sym
   end
   IRB.start
 end

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

@@ -2,19 +2,12 @@
 # so that these tasks might be a dependency for other tasks
 
 namespace :environment do
-  full_configuration[:environments].each_key do |env|
-    # Sets the environment to #{env}
-    task env do
-      configuration.environment = env
-    end
-
+  config.each do |env, target, _data|
     namespace env do
-      full_configuration[:environments][env].each_key do |target|
-        # Sets the environment to #{env} and the target to #{target}
-        task target do
-          configuration.environment = env
-          configuration.target = target
-        end
+      # Sets the environment to #{env} and the target to #{target}
+      task target do
+        config.environment = env
+        config.target = target
       end
     end
   end

data/lib/fulmar/domain/task/initialization/base.rake

@@ -1,12 +1,6 @@
 require 'fulmar/domain/service/helper/common_helper'
 include Fulmar::Domain::Service::Helper::CommonHelper
 
-if configuration.feature? :database
-  require 'fulmar/domain/service/helper/database_helper'
-  include Fulmar::Domain::Service::Helper::DatabaseHelper
-end
-
-if configuration.feature? :flow
-  require 'fulmar/domain/service/helper/flow_helper'
-  include Fulmar::Domain::Service::Helper::FlowHelper
-end
+Fulmar::Domain::Service::PluginService.instance.helpers.each do |helper|
+  include helper
+end

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

@@ -3,12 +3,8 @@ include Fulmar::Domain::Service::Helper::CommonHelper
 namespace :versions do
   @versioned_servers = {}
 
-  full_configuration[:environments].each_pair do |env, targets|
-    next if env == :all
-
-    targets.each_pair do |target, config|
-      @versioned_servers["#{env}:#{target}"] = config if config[:type].to_s == 'rsync_with_versions'
-    end
+  config.each do |env, target, config|
+    @versioned_servers["#{env}:#{target}"] = config if config[:type].to_s == 'rsync_with_versions'
   end
 
   unless @versioned_servers.empty?
@@ -25,8 +21,8 @@ namespace :versions do
 
         desc "List available versions for environment/target \"#{env}\""
         task task_environment do
-          configuration.environment = env.split(':').first
-          configuration.target = env.split(':').last
+          config.environment = env.split(':').first
+          config.target = env.split(':').last
           file_sync.list_releases(false).each { |item| puts item }
         end
       end
@@ -34,8 +30,8 @@ namespace :versions do
       namespace :clean do
         desc "Delete obsolete versions for target \"#{env}\""
         task task_environment do
-          configuration.environment = env.split(':').first
-          configuration.target = env.split(':').last
+          config.environment = env.split(':').first
+          config.target = env.split(':').last
           file_sync.cleanup
         end
       end
@@ -43,8 +39,8 @@ namespace :versions do
       namespace :revert do
         desc "Revert to the previous version for \"#{env}\""
         task task_environment do
-          configuration.environment = env.split(':').first
-          configuration.target = env.split(':').last
+          config.environment = env.split(':').first
+          config.target = env.split(':').last
           error 'Cannot revert to previous version.' unless file_sync.revert
         end
       end

data/lib/fulmar/infrastructure/default_files/Fulmar/project.config.yml

@@ -0,0 +1,26 @@
+project:
+  name: example_project
+  fulmar_version: '~> 2.0'
+
+environments:
+  local:
+    base:
+      local_path: .
+
+  staging:
+    files:
+      host: staging_server
+
+dependencies:
+  # Dependencies under "all" are merged into all environments
+  all:
+    application:
+      type: git
+
+
+hosts:
+  staging_server:
+    hostname: staging
+    ssh_config:
+      Hostname: staging
+      User: deployment

data/lib/fulmar/infrastructure/default_files/Fulmarfile

@@ -0,0 +1,22 @@
+# This is a basic Fulmarfile. You can add task just like in Rake. Additionally, you can
+# use helper to modify the ssh config, open a shell locally or remote, or upload files to a preconfigured host
+# All paths and hostname are configured in Fulmar/project.config.yml. You can split you configuration over multiple
+# *.config.yml files which are all merged. You can create additional .rake files within the Fulmar directory.
+# For more help, look at https://github.com/CORE4/fulmar
+
+desc 'setup this project'
+task setup: 'environment:local:base' do
+  info 'Withing this task you can add the initialization of your project.'
+  # Maybe do this:
+  # dependencies.setup
+  # ssh_config.add_hosts
+end
+
+namespace :deploy do
+  desc 'Deploy to staging system'
+  task staging: 'environment:staging:application' do
+    info 'Here you can upload your files and maybe flush the cache'
+    # file_sync.transfer
+    # remote_shell.run 'php cli/console cache:flush'
+  end
+end

data/lib/fulmar/infrastructure/{service → model}/transfer/base.rb

@@ -1,11 +1,10 @@
-
 require 'fulmar/shell'
 
 module Fulmar
   module Infrastructure
-    module Service
+    module Model
       module Transfer
-        # Abstract class for alle transfers, provides common methods
+        # Abstract class for all transfers, provides common methods
         class Base
           DEFAULT_CONFIG = {
             debug: false,
@@ -38,7 +37,8 @@ module Fulmar
           end
 
           def prepare
-            @local_shell = Fulmar::Infrastructure::Service::ShellService.new @config[:local_path]
+            @local_shell = Fulmar::Shell.new @config[:local_path]
+            @local_shell.strict = true
             @local_shell.debug = @config[:debug]
             @prepared = true
           end

data/lib/fulmar/infrastructure/{service → model}/transfer/rsync.rb

@@ -1,9 +1,9 @@
 require 'pathname'
-require 'fulmar/infrastructure/service/transfer/base'
+require 'fulmar/infrastructure/model/transfer/base'
 
 module Fulmar
   module Infrastructure
-    module Service
+    module Model
       module Transfer
         # Implements the rsync transfer
         class Rsync < Base
@@ -27,6 +27,8 @@ module Fulmar
               @config[:rsync][:exclude_file] = @config[:local_path] + '/.rsyncignore'
             end
 
+            fail 'Hostname not set. Cannot initialize sync.' if @config[:hostname].empty?
+
             super(@config)
           end
 

data/lib/fulmar/infrastructure/{service → model}/transfer/rsync_with_versions.rb

@@ -1,11 +1,11 @@
 
-require 'fulmar/infrastructure/service/transfer/base'
+require 'fulmar/infrastructure/model/transfer/base'
 require 'time'
-require 'ruby_wings'
+require 'active_support'
 
 module Fulmar
   module Infrastructure
-    module Service
+    module Model
       module Transfer
         # Provides syncing with versioning on the server
         #
@@ -24,7 +24,7 @@ module Fulmar
               exclude_file: nil,
               chown: nil,
               chmod: nil,
-              delete:  true
+              delete: true
             },
             symlinks: {},
             limit_releases: 5,
@@ -47,7 +47,7 @@ module Fulmar
           # Ensures all needed services are set up
           def prepare
             super
-            @remote_shell = Fulmar::Infrastructure::Service::ShellService.new @config[:remote_path], @config.ssh_user_and_host
+            @remote_shell = Fulmar::Shell.new @config[:remote_path], @config.ssh_user_and_host
             @remote_shell.debug = @config[:debug]
           end
 
@@ -56,10 +56,7 @@ 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
+            create_paths && @local_shell.run(rsync_command) && copy_temp_to_release && add_shared
           end
 
           # Publishes the current release (i.e. sets the 'current' symlink)
@@ -156,7 +153,7 @@ module Fulmar
           # Builds the rsync command
           # @return [String] the command
           def rsync_command
-            options = %w(-rl --delete-excluded)
+            options = ['-rl']
             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]
@@ -169,7 +166,7 @@ module Fulmar
           # Copies the data from the sync temp to the actual release directory
           # @return [true, false] success
           def copy_temp_to_release
-            @remote_shell.run "cp -pR #{@config[:temp_dir]} #{release_dir}"
+            @remote_shell.run "cp -pr #{@config[:temp_dir]} #{release_dir}"
           end
 
           # Set the symlink to the given release or the return value of release_dir() otherwise
@@ -190,23 +187,24 @@ 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
-            @config[:shared].each do |path|
-              commands << "mkdir -p \"#{release_dir}/#{File.dirname(path)}\""
+            @config[:shared].each do |dir|
+              commands << "mkdir -p \"#{release_dir}/#{dir}\""
 
-              unless remote_path_exists?("#{@config[:shared_dir]}/#{path}")
-                commands << "mkdir -p \"#{@config[:shared_dir]}/#{path}\""
+              unless remote_dir_exists?("#{@config[:shared_dir]}/#{dir}")
+                commands << "mkdir -p \"#{@config[:shared_dir]}/#{File.dirname(dir)}\""
+                commands << "cp -pr \"#{release_dir}/#{dir}\" \"#{@config[:shared_dir]}/#{File.dirname(dir)}\""
               end
 
-              commands << "rm -fr \"#{release_dir}/#{path}\""
-              commands << "mkdir -p \"#{release_dir}/#{File.dirname(path)}\""
-              commands << "ln -s \"#{@config[:remote_path]}/#{@config[:shared_dir]}/#{path}\" \"#{release_dir}/#{path}\""
+              commands << "rm -fr \"#{release_dir}/#{dir}\""
+              commands << "mkdir -p \"#{release_dir}/#{File.dirname(dir)}\""
+              commands << "ln -s \"#{@config[:remote_path]}/#{@config[:shared_dir]}/#{dir}\" \"#{release_dir}/#{dir}\""
             end
 
             @remote_shell.run commands if commands.length > 0
           end
 
-          def remote_path_exists?(dir)
-            @remote_shell.run "test -e \"#{dir}\""
+          def remote_dir_exists?(dir)
+            @remote_shell.run "test -d \"#{dir}\""
           end
         end
       end

data/lib/fulmar/infrastructure/{service → model}/transfer/tar.rb

@@ -1,9 +1,9 @@
 
-require 'fulmar/infrastructure/service/transfer/base'
+require 'fulmar/infrastructure/model/transfer/base'
 
 module Fulmar
   module Infrastructure
-    module Service
+    module Model
       module Transfer
         # Implements the rsync transfer
         class Tar < Base

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

@@ -4,7 +4,7 @@ module Fulmar
       # Provides access to composer
       class CopyService
         # Copies a file to a remote server
-        # @param [Fulmar::Infrastructue::Service::ShellService] shell
+        # @param [Fulmar::Shell] shell
         # @param [String] local_file local filename, should be absolute
         # @param [String] remote_host SSH hostname
         # @param [String] remote_dir remote directory
@@ -15,7 +15,7 @@ module Fulmar
         end
 
         # Downloads a file from a remote server
-        # @param [Fulmar::Infrastructue::Service::ShellService] shell
+        # @param [Fulmar::Shell] shell
         # @param [String] remote_host SSH hostname
         # @param [String] remote_file remote directory
         # @param [String] local_dir local filename, should be absolute

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

@@ -7,26 +7,13 @@ module Fulmar
       class SSHConfigService
         CONFIG_FILE = "#{ENV['HOME']}/.ssh/config"
         KNOWN_HOST_FILE = "#{ENV['HOME']}/.ssh/known_hosts"
-        # @todo: Get rid of this layer (Version 2?)
-        CONFIG_MAP = {
-          hostname: 'Hostname',
-          port: 'Port',
-          user: 'User',
-          proxycommand: 'ProxyCommand',
-          checkhostip: 'CheckHostIP',
-          stricthostkeychecking: 'StrictHostKeyChecking',
-          identityfile: 'IdentityFile',
-          userknownhostfile: 'UserKnownHostsFile',
-          loglevel: 'LogLevel',
-          forwardagent: 'ForwardAgent'
-        }
 
         def initialize(config)
           @config = config
         end
 
         def add_hosts
-          @config.configuration[:hosts].values.each do |data|
+          @config.hosts.values.each do |data|
             unless config_valid?(data)
               puts "Skipping #{data[:hostname]}, config not sufficient." if @config[:debug]
               next
@@ -68,17 +55,17 @@ 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] == '/'
-            ssh_config[:identityfile] = @config.base_path + '/' + ssh_config[:identityfile]
+          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 "# Automatically generated by fulmar for project '#{@config.project.description}'"
           config_file.puts "Host #{hostname}"
-          CONFIG_MAP.keys.each do |key|
-            unless ssh_config[key].blank?
-              config_file.puts "    #{CONFIG_MAP[key]} \"#{ssh_config[key].to_s.gsub('"', '\\"')}\""
-            end
+          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.close

data/lib/fulmar/service/bootstrap_service.rb

@@ -2,12 +2,8 @@ module Fulmar
   module Service
     # Initializes the rake service and starts it
     class BootstrapService
-      def initialize
-        $logger = Fulmar::Service::LoggerService.new(STDOUT)
-      end
-
       def fly
-        Fulmar::Domain::Service::ApplicationService.new.run
+        Fulmar::Domain::Service::Application.new.run
       end
     end
   end

data/lib/fulmar/task_manager.rb

@@ -2,22 +2,16 @@ require 'fulmar/version'
 
 require 'fulmar/service/bootstrap_service'
 require 'fulmar/service/helper_service'
-require 'fulmar/service/logger_service'
 
 require 'fulmar/domain/service/initialization_service'
-require 'fulmar/domain/service/application_service'
+require 'fulmar/domain/model/application'
 require 'fulmar/domain/service/configuration_service'
-require 'fulmar/domain/service/config_rendering_service'
+require 'fulmar/domain/service/template_rendering_service'
 require 'fulmar/domain/service/file_sync_service'
 
-require 'fulmar/infrastructure/service/composer_service'
-require 'fulmar/infrastructure/service/shell_service'
 require 'fulmar/infrastructure/service/copy_service'
 require 'fulmar/infrastructure/service/ssh_config_service'
 
-require 'fulmar/infrastructure/service/database/database_service'
-
-require 'ruby_wings'
 require 'fileutils'
 
 bootstrap = Fulmar::Service::BootstrapService.new

data/lib/fulmar/version.rb

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

data/spec/lib/fulmar/model/configuration_spec.rb

@@ -0,0 +1,193 @@
+require 'fulmar/service/helper_service'
+require 'fulmar/domain/model/configuration'
+require 'active_support'
+
+FULMAR_TEST_CONFIG = {
+  project: {
+    name: 'Test data'
+  },
+  environments: {
+    all: {
+      local_path: 'Application',
+      inherit_test: 'global'
+    },
+    staging: {
+      all: {
+        host: 'stagingserver',
+        local_path: '/tmp',
+        inherit_test: 'environment'
+      },
+      data: {
+        relative_path: 'relative',
+        absolute_path: '/absolute',
+        remote_path: '/'
+      },
+      files: {
+        inherit_test: 'local',
+        local_path: '.',
+        remote_path: 'tmp',
+        hostname: 'localhost'
+      }
+    },
+    live: {
+      files: {
+      },
+      data: {
+        local_path: 'Application',
+        relative_path: 'SubApplication'
+      }
+    }
+  },
+  hosts: {
+    liveserver: {
+      hostname: 'liveserver',
+      remote_path: '/liveserver'
+    },
+    stagingserver: {
+      hostname: 'stagingserver',
+      remote_path: '/stagingserver'
+    }
+  }
+
+}
+
+describe Fulmar::Domain::Model::Configuration do
+  before :each do
+    # Make a deep copy of the hash so we have a fresh copy for every test
+    config_data = Marshal.load( Marshal.dump(FULMAR_TEST_CONFIG) )
+    @config = Fulmar::Domain::Model::Configuration.new(config_data, '/tmp')
+  end
+
+  describe '#instantiation' do
+    it 'should return a simple configuration option' do
+      @config.environment = :staging
+      @config.target = :files
+      expect(@config[:inherit_test]).to eql('local')
+    end
+
+    it 'should return an inherited configuration option from the environment' do
+      @config.environment = :staging
+      @config.target = :data
+      expect(@config[:inherit_test]).to eql('environment')
+    end
+
+    it 'should return an globally inherited configuration option' do
+      @config.environment = :live
+      @config.target = :files
+      expect(@config[:inherit_test]).to eql('global')
+    end
+  end
+
+  describe '#each' do
+    it 'should iterate over all environments/targets do' do
+      @all_targets = []
+      FULMAR_TEST_CONFIG[:environments].keys.each do |env|
+        next if env == :all
+        FULMAR_TEST_CONFIG[:environments][env].keys.each do |target, _value|
+          next if target == :all
+          @all_targets << "#{env}/#{target}"
+        end
+      end
+      @targets = []
+      @config.each do |env, target, _data|
+        @targets << "#{env}/#{target}"
+      end
+      expect(@targets).to eql(@all_targets)
+    end
+  end
+
+  describe '#project' do
+    it 'should return a new project' do
+      expect(@config.project).to be_a Fulmar::Domain::Model::Project
+    end
+  end
+
+  describe '#ready?' do
+    it 'should return false if settings are missing' do
+      expect(@config.ready?).to be false
+      @config.environment = :staging
+      expect(@config.ready?).to be false
+      @config.environment = nil
+      @config.target = :files
+      expect(@config.ready?).to be false
+    end
+
+    it 'should return true with all settings given' do
+      @config.environment = :staging
+      @config.target = :files
+      expect(@config.ready?).to be true
+    end
+  end
+
+  describe '#merge_hosts' do
+    it 'should merge the host configuration into the target' do
+      @config.environment = :staging
+      @config.target = :data
+      expect(@config[:hostname]).to eql('stagingserver')
+    end
+
+    it 'should prefer the local configuration over the host configuration' do
+      @config.environment = :staging
+      @config.target = :data
+      expect(@config[:remote_path]).to eql('/')
+    end
+  end
+
+  describe '#merge' do
+    it 'merges the given configuration into the current target' do
+      default_config = { new_default_value: 'default' }
+      @config.environment = :staging
+      @config.target = :data
+      @config.merge(default_config)
+      expect(@config[:new_default_value]).to eql('default')
+    end
+
+    it 'prefers the explicit config over the default values' do
+      default_config = { remote_path: '/default' }
+      @config.environment = :staging
+      @config.target = :data
+      @config.merge(default_config)
+      expect(@config[:remote_path]).to eql('/')
+    end
+  end
+
+  describe '#path_expansion' do
+    it 'keeps absolute paths' do
+      @config.environment = :staging
+      @config.target = :data
+      expect(@config[:absolute_path]).to eql('/absolute')
+    end
+
+    it 'keeps remote paths' do
+      @config.environment = :staging
+      @config.target = :files
+      expect(@config[:remote_path]).to eql('tmp')
+    end
+
+    it 'makes paths absolute' do
+      @config.environment = :staging
+      @config.target = :data
+      expect(@config[:relative_path][0,1]).to eql('/')
+    end
+
+    it 'joins the path, local_path and a given third path' do
+      @config.environment = :live
+      @config.target = :data
+      expect(@config[:relative_path]).to eql('/tmp/Application/SubApplication')
+    end
+  end
+
+  describe '#set' do
+    it 'should set the environment only' do
+      @config.set(:live)
+      expect(@config.environment).to eql(:live)
+      expect(@config.target).to be_nil
+    end
+
+    it 'should set the environment and the target' do
+      @config.set(:live, :data)
+      expect(@config.environment).to eql(:live)
+      expect(@config.target).to eql(:data)
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+#require 'fulmar/service/helper_service'
+#require 'fulmar/domain/model/configuration'
+
+require 'fulmar/domain/service/plugin_service'
+
+module Fulmar
+  module Plugin
+    module MariaDB
+      class Database
+      end
+    end
+  end
+end
+
+describe Fulmar::Domain::Service::PluginService do
+  before :each do
+    @plugin_service = Fulmar::Domain::Service::PluginService.instance
+  end
+
+  describe '#classname' do
+    it 'returns a module' do
+      expect(@plugin_service.classname :maria).to eql(Fulmar::Plugin::MariaDB)
+    end
+
+    it 'returns a class' do
+      expect(@plugin_service.classname(:maria, :database)).to eql(Fulmar::Plugin::MariaDB::Database)
+    end
+  end
+end