pulsar 1.0.0 → 1.1.0

data/lib/pulsar/context_error.rb

@@ -0,0 +1,7 @@
+module Pulsar
+  class ContextError < StandardError
+    def to_s
+      backtrace ? backtrace.unshift(super).join("\n") : super
+    end
+  end
+end

data/lib/pulsar/interactors/add_applications.rb

@@ -1,8 +1,10 @@
 module Pulsar
   class AddApplications
     include Interactor
+    include Pulsar::Validator
 
-    before :validate_input!, :prepare_context
+    validate_context_for! :config_path
+    before :prepare_context
     after :validate_output!
 
     def call
@@ -10,7 +12,7 @@ module Pulsar
         context.applications[File.basename(app)] = stages_for(app)
       end
     rescue
-      context.fail! error: $!.message
+      context_fail! $!.message
     end
 
     private
@@ -19,12 +21,8 @@ module Pulsar
       context.applications = {}
     end
 
-    def validate_input!
-      context.fail! if context.config_path.nil?
-    end
-
     def validate_output!
-      context.fail! error: "No application found on repository #{context.repository}" if context.applications.empty?
+      context_fail! "No application found on repository #{context.repository}" if context.applications.empty?
     end
 
     def each_application_path

data/lib/pulsar/interactors/cleanup.rb

@@ -1,6 +1,7 @@
 module Pulsar
   class Cleanup
     include Interactor
+    include Pulsar::Validator
 
     def call
       FileUtils.rm_rf(context.run_path)

data/lib/pulsar/interactors/clone_repository.rb

@@ -1,8 +1,9 @@
 module Pulsar
   class CloneRepository
     include Interactor
+    include Pulsar::Validator
 
-    before :validate_input!
+    validate_context_for! :config_path, :repository, :repository_type
 
     def call
       case context.repository_type
@@ -11,17 +12,11 @@ module Pulsar
       when :folder then copy_local_folder
       end
     rescue
-      context.fail! error: $!.message
+      context_fail! $!.message
     end
 
     private
 
-    def validate_input!
-      context.fail! if context.config_path.nil? ||
-                       context.repository.nil? ||
-                       context.repository_type.nil?
-    end
-
     def clone_git_repository
       cmd   = 'git clone'
       opts  = '--quiet --depth 1'

data/lib/pulsar/interactors/copy_environment_file.rb

@@ -1,8 +1,11 @@
 module Pulsar
   class CopyEnvironmentFile
     include Interactor
+    include Pulsar::Validator
 
-    before :validate_input!, :prepare_context
+    validate_context_for! :config_path, :cap_path, :application, :applications
+    before :validate_environment!
+    before :prepare_context
 
     def call
       env_file = "#{context.config_path}/apps/#{context.application}/#{context.environment}.rb"
@@ -10,7 +13,7 @@ module Pulsar
       FileUtils.mkdir_p(context.cap_deploy_path)
       FileUtils.cp(env_file, context.environment_file_path)
     rescue
-      context.fail! error: $!.message
+      context_fail! $!.message
     end
 
     private
@@ -20,15 +23,16 @@ module Pulsar
       context.environment_file_path = "#{context.cap_deploy_path}/#{context.environment}.rb"
     end
 
-    def validate_input!
-      context.fail! if context.config_path.nil? ||
-                       context.cap_path.nil? ||
-                       context.application.nil? ||
-                       context.applications.nil? ||
-                       context.environment.nil?
-      unless context.applications[context.application].include? context.environment
-        context.fail! error: "The application #{context.application} does not have an environment called #{context.environment}"
-      end
+    def validate_environment!
+      fail_on_missing_environment! unless environment_exist?
+    end
+
+    def environment_exist?
+      context.applications[context.application].include?(context.environment)
+    end
+
+    def fail_on_missing_environment!
+      context_fail! "The application #{context.application} does not have an environment called #{context.environment}"
     end
   end
 end

data/lib/pulsar/interactors/copy_initial_repository.rb

@@ -1,8 +1,7 @@
 module Pulsar
   class CopyInitialRepository
     include Interactor
-
-    before :validate_input!
+    include Pulsar::Validator
 
     def call
       current_path = File.dirname(__FILE__)
@@ -10,13 +9,7 @@ module Pulsar
 
       FileUtils.cp_r(File.expand_path(initial_repo), context.directory)
     rescue
-      context.fail! error: $!.message
-    end
-
-    private
-
-    def validate_input!
-      context.fail! if context.directory.nil?
+      context_fail! $!.message
     end
   end
 end

data/lib/pulsar/interactors/create_capfile.rb

@@ -1,8 +1,10 @@
 module Pulsar
   class CreateCapfile
     include Interactor
+    include Pulsar::Validator
 
-    before :validate_input!, :prepare_context
+    validate_context_for! :config_path, :cap_path, :application, :applications
+    before :validate_application!, :prepare_context
 
     def call
       default_capfile = "#{context.config_path}/apps/Capfile"
@@ -14,7 +16,7 @@ module Pulsar
       Rake.sh("cat #{app_capfile}     >> #{context.capfile_path}") if File.exist?(app_capfile)
       Rake.sh("echo '#{import_tasks}' >> #{context.capfile_path}")
     rescue
-      context.fail! error: $!.message
+      context_fail! $!.message
     end
 
     private
@@ -23,13 +25,16 @@ module Pulsar
       context.capfile_path = "#{context.cap_path}/Capfile"
     end
 
-    def validate_input!
-      context.fail! if context.config_path.nil? ||
-                       context.cap_path.nil? ||
-                       context.application.nil?
-      unless context.applications.keys.include? context.application
-        context.fail! error: "The application #{context.application} does not exist in your repository"
-      end
+    def validate_application!
+      fail_on_missing_application! unless application_exists?
+    end
+
+    def application_exists?
+      context.applications.keys.include? context.application
+    end
+
+    def fail_on_missing_application!
+      context_fail! "The application #{context.application} does not exist in your repository"
     end
   end
 end

data/lib/pulsar/interactors/create_deploy_file.rb

@@ -1,8 +1,9 @@
 module Pulsar
   class CreateDeployFile
     include Interactor
+    include Pulsar::Validator
 
-    before :validate_input!, :prepare_context
+    before :prepare_context
 
     def call
       default_deploy = "#{context.config_path}/apps/deploy.rb"
@@ -13,7 +14,7 @@ module Pulsar
       Rake.sh("cat #{default_deploy} >> #{context.deploy_file_path}") if File.exist?(default_deploy)
       Rake.sh("cat #{app_deploy}     >> #{context.deploy_file_path}") if File.exist?(app_deploy)
     rescue
-      context.fail! error: $!.message
+      context_fail!$!.message
     end
 
     private
@@ -22,11 +23,5 @@ module Pulsar
       context.cap_config_path = "#{context.cap_path}/config"
       context.deploy_file_path = "#{context.cap_config_path}/deploy.rb"
     end
-
-    def validate_input!
-      context.fail! if context.config_path.nil? ||
-                       context.cap_path.nil? ||
-                       context.application.nil?
-    end
   end
 end

data/lib/pulsar/interactors/create_run_dirs.rb

@@ -1,6 +1,7 @@
 module Pulsar
   class CreateRunDirs
     include Interactor
+    include Pulsar::Validator
 
     def call
       context.timestamp   = Time.now.to_f

data/lib/pulsar/interactors/identify_repository_location.rb

@@ -1,8 +1,7 @@
 module Pulsar
   class IdentifyRepositoryLocation
     include Interactor
-
-    before :validate_input!
+    include Pulsar::Validator
 
     def call
       context.repository_location = if File.exist?(context.repository)
@@ -11,13 +10,7 @@ module Pulsar
                                       :remote
                                     end
     rescue
-      context.fail! error: $!.message
-    end
-
-    private
-
-    def validate_input!
-      context.fail! if context.repository.nil?
+      context_fail! $!.message
     end
   end
 end

data/lib/pulsar/interactors/identify_repository_type.rb

@@ -1,8 +1,9 @@
 module Pulsar
   class IdentifyRepositoryType
     include Interactor
+    include Pulsar::Validator
 
-    before :validate_input!
+    validate_context_for! :repository, :repository_location
 
     def call
       case context.repository_location
@@ -11,17 +12,10 @@ module Pulsar
       when :remote
         context.repository_type = github_repository? ? :github : :git
       end
-    rescue
-      context.fail! error: $!.message
     end
 
     private
 
-    def validate_input!
-      context.fail! if context.repository.nil?
-      context.fail! if context.repository_location.nil?
-    end
-
     def github_repository?
       context.repository =~ %r{^[\w-]+\/[\w-]+$}
     end

data/lib/pulsar/interactors/run_bundle_install.rb

@@ -1,8 +1,9 @@
 module Pulsar
   class RunBundleInstall
     include Interactor
+    include Pulsar::Validator
 
-    before :validate_input!
+    validate_context_for! :config_path, :bundle_path
 
     def call
       gemfile_env = "BUNDLE_GEMFILE=#{context.config_path}/Gemfile"
@@ -15,14 +16,7 @@ module Pulsar
         Rake.sh("#{bundle_cmd}#{out_redir}")
       end
     rescue
-      context.fail!
-    end
-
-    private
-
-    def validate_input!
-      context.fail! if context.config_path.nil? ||
-                       context.bundle_path.nil?
+      context_fail! $!.message
     end
   end
 end

data/lib/pulsar/interactors/run_capistrano.rb

@@ -1,8 +1,9 @@
 module Pulsar
   class RunCapistrano
     include Interactor
+    include Pulsar::Validator
 
-    before :validate_input!
+    validate_context_for! :cap_path, :config_path, :bundle_path, :environment
 
     def call
       Dir.chdir(context.cap_path) do
@@ -10,21 +11,12 @@ module Pulsar
         bundle_env  = "BUNDLE_PATH=#{context.bundle_path}"
         cap_opts    = ENV['DRY_RUN'] ? '--dry-run ' : nil
         out_redir   = ENV['DRY_RUN'] ? '> /dev/null 2>&1' : nil
-        cap_cmd     = "bundle exec cap #{cap_opts}#{context.environment} deploy"
+        cap_cmd     = "bundle exec cap #{cap_opts}#{context.environment} #{context.task}"
 
         Rake.sh("#{gemfile_env} #{bundle_env} #{cap_cmd}#{out_redir}")
       end
     rescue
-      context.fail! error: $!.message
-    end
-
-    private
-
-    def validate_input!
-      context.fail! if context.cap_path.nil? ||
-                       context.config_path.nil? ||
-                       context.bundle_path.nil? ||
-                       context.environment.nil?
+      context_fail! $!.message
     end
   end
 end

data/lib/pulsar/organizers/{deploy.rb → task.rb}

@@ -1,5 +1,5 @@
 module Pulsar
-  class Deploy
+  class Task
     include Interactor::Organizer
 
     organize IdentifyRepositoryLocation,

data/lib/pulsar/validator.rb

@@ -0,0 +1,33 @@
+module Pulsar
+  module Validator
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.before :validate_context!
+    end
+
+    def validate_context!
+      validable_properties.each do |property|
+        result = context.send property.to_sym
+        context_fail! "Invalid context for #{property} [#{result}]" unless result
+      end
+    end
+
+    def context_fail!(msg)
+      context.fail! error: Pulsar::ContextError.new(msg)
+    end
+
+    def validable_properties
+      self.class.validable_properties
+    end
+
+    module ClassMethods
+      def validate_context_for!(*args)
+        validable_properties.concat args
+      end
+
+      def validable_properties
+        @validable_properties ||= []
+      end
+    end
+  end
+end

data/lib/pulsar/version.rb

@@ -1,3 +1,3 @@
 module Pulsar
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/pulsar.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pulsar/version'
@@ -29,7 +28,8 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake', '~> 10.4'
   gem.add_development_dependency 'rspec', '~> 3.2'
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
   gem.add_development_dependency 'rubocop', '~> 0.47'
   gem.add_development_dependency 'timecop', '~> 0.8'
+  gem.add_development_dependency 'simplecov', '~> 0.14.0'
+  gem.add_development_dependency 'coveralls', '~> 0.8.20'
 end

data/spec/features/task_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+RSpec.describe 'Task' do
+  subject { -> { command } }
+
+  let(:command) do
+    `DRY_RUN=true #{RSpec.configuration.pulsar_command} task #{options} #{arguments} #{task}`
+  end
+
+  let(:repo)        { RSpec.configuration.pulsar_conf_path }
+  let(:task)        { 'deploy:check' }
+  let(:options)     { "--conf-repo #{repo}" }
+  let(:app)         { 'blog' }
+  let(:environment) { 'production' }
+  let(:arguments)   { "#{app} #{environment}" }
+
+  context 'via a subcommand named task' do
+    let(:error) { /Could not find command/ }
+
+    it { is_expected.not_to output(error).to_stderr_from_any_process }
+  end
+
+  context 'requires a --conf-repo option' do
+    let(:options) { nil }
+    let(:error)   { /No value provided for required options '--conf-repo'/ }
+
+    it { is_expected.to output(error).to_stderr_from_any_process }
+
+    context 'can be specified via the alias -c' do
+      let(:options) { "-c #{repo}" }
+
+      it { is_expected.not_to output(error).to_stderr_from_any_process }
+    end
+
+    context 'can be specified via the environment variable PULSAR_CONF_REPO' do
+      before { ENV['PULSAR_CONF_REPO'] = repo }
+
+      it { is_expected.not_to output(error).to_stderr_from_any_process }
+    end
+  end
+
+  context 'requires application and environment arguments' do
+    let(:app)         { nil }
+    let(:environment) { nil }
+    let(:error)       { /Usage: "pulsar task APPLICATION ENVIRONMENT TASK"/ }
+
+    it { is_expected.to output(error).to_stderr_from_any_process }
+  end
+
+  context 'when succeeds' do
+    subject { command }
+
+    context 'deploys an application on a environment in the pulsar configuration' do
+      let(:output) { /Executed task deploy:check for blog on production!/ }
+
+      context 'from a local folder' do
+        let(:repo) { Dir.mktmpdir }
+
+        before do
+          FileUtils.cp_r("#{RSpec.configuration.pulsar_conf_path}/.", repo)
+        end
+
+        context 'with Capistrano parameters passed via command line' do
+          let(:task)   { "deploy:check[param1,param2]" }
+          let(:output) { /Executed task deploy:check\[param1,param2\] for blog on production!\n/ }
+
+          it { is_expected.to match(output) }
+        end
+
+        context 'without Capistrano parameters' do
+          it { is_expected.to match(output) }
+        end
+
+        context 'leaves the tmp folder empty' do
+          subject { Dir.glob("#{Pulsar::PULSAR_TMP}/*") }
+
+          before { command }
+
+          it { is_expected.to be_empty }
+        end
+      end
+
+      context 'from a remote Git repository' do
+        let(:repo)        { RSpec.configuration.pulsar_remote_git_conf }
+        let(:app)         { 'your_app' }
+        let(:environment) { 'staging' }
+        let(:output)      { /Executed task deploy:check for your_app on staging!\n/ }
+
+        context 'with Capistrano parameters passed via command line' do
+          let(:task)   { "deploy:check[param1,param2]" }
+          let(:output) { /Executed task deploy:check\[param1,param2\] for your_app on staging!\n/ }
+
+          it { is_expected.to match(output) }
+        end
+
+        context 'without Capistrano parameters' do
+          it { is_expected.to match(output) }
+        end
+
+        context 'leaves the tmp folder empty' do
+          subject { Dir.glob("#{Pulsar::PULSAR_TMP}/*") }
+
+          before { command }
+
+          it { is_expected.to be_empty }
+        end
+      end
+
+      context 'from a remote GitHub repository' do
+        let(:repo)        { RSpec.configuration.pulsar_remote_github_conf }
+        let(:app)         { 'your_app' }
+        let(:environment) { 'staging' }
+        let(:output)      { /Executed task deploy:check for your_app on staging!\n/ }
+
+        context 'with Capistrano parameters passed via command line' do
+          let(:task)   { "deploy:check[param1,param2]" }
+          let(:output) { /Executed task deploy:check\[param1,param2\] for your_app on staging!\n/ }
+
+          it { is_expected.to match(output) }
+        end
+
+        context 'without Capistrano parameters' do
+          it { is_expected.to match(output) }
+        end
+
+        context 'leaves the tmp folder empty' do
+          subject { Dir.glob("#{Pulsar::PULSAR_TMP}/*") }
+
+          before { command }
+
+          it { is_expected.to be_empty }
+        end
+      end
+    end
+  end
+
+  context 'when fails' do
+    subject { command }
+
+    context 'because of wrong directory' do
+      let(:repo) { './some-wrong-directory' }
+
+      it { is_expected.to match(/Failed to execute task deploy:check for blog on production.\n/) }
+    end
+
+    context 'because of empty directory' do
+      let(:repo) { RSpec.configuration.pulsar_empty_conf_path }
+
+      it { is_expected.to match(/Failed to execute task deploy:check for blog on production.\n/) }
+      it { is_expected.to match "No application found on repository #{RSpec.configuration.pulsar_empty_conf_path}\n" }
+    end
+
+    context 'because Bundler failed' do
+      let(:repo) { RSpec.configuration.pulsar_wrong_bundle_conf_path }
+
+      it { is_expected.to match(/Failed to execute task deploy:check for blog on production.\n/) }
+    end
+
+    context 'because Capistrano failed' do
+      let(:repo) { RSpec.configuration.pulsar_wrong_cap_conf_path }
+
+      it { is_expected.to match(/Failed to execute task deploy:check for blog on production.\n/) }
+    end
+
+    context 'because the application does not exists in the repository' do
+      let(:repo)        { RSpec.configuration.pulsar_conf_path }
+      let(:app)         { 'foobuzz' }
+      let(:environment) { 'staging' }
+
+      it { is_expected.to match(/The application foobuzz does not exist in your repository/) }
+    end
+
+    context 'because the environment does not exists for the application' do
+      let(:repo)        { RSpec.configuration.pulsar_conf_path }
+      let(:app)         { 'blog' }
+      let(:environment) { 'foobuzz' }
+
+      it { is_expected.to match(/The application blog does not have an environment called foobuzz/) }
+
+      context 'but \'no application error\' message takes precedence' do
+        let(:app) { 'foobuzz' }
+
+        it { is_expected.to match(/The application foobuzz does not exist in your repository/) }
+      end
+    end
+  end
+end