pulsar 1.0.0 → 1.1.0

data/spec/spec_helper.rb

@@ -1,16 +1,11 @@
+require 'support/coverage_setup'
 require 'rspec'
 require 'stringio'
 require 'fileutils'
 require 'timecop'
 require 'tmpdir'
-require 'codeclimate-test-reporter'
 require 'pulsar'
 
-#
-# Code coverage
-#
-CodeClimate::TestReporter.start
-
 RSpec.configure do |config|
   config.mock_with :rspec
   config.raise_errors_for_deprecations!

data/spec/support/coverage_setup.rb

@@ -0,0 +1,39 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+# Save to CircleCI's artifacts directory if we're on CircleCI
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], "coverage")
+  SimpleCov.coverage_dir(dir)
+end
+
+SimpleCov.minimum_coverage 99
+SimpleCov.minimum_coverage_by_file 90
+SimpleCov.refuse_coverage_drop
+
+if ENV['FEATURE_TESTS']
+  SimpleCov.command_name 'features'
+
+  # This is needed because otherwise SimpleCov will output some text at exit
+  # and it will make most of the feature specs fail (that check the output).
+  SimpleCov.at_exit do
+    $stdout.reopen(File::NULL, 'w')
+    $stdout.sync = true
+    SimpleCov.result.format!
+    $stdout = STDOUT
+  end
+end
+
+if ENV['COVERAGE']
+  SimpleCov.start do
+    add_group 'Interactors', 'lib/pulsar/interactors'
+    add_group 'Organizers', 'lib/pulsar/organizers'
+
+    add_filter 'spec/*'
+  end
+end

data/spec/units/cli/deploy_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Pulsar::CLI do
-  subject { Pulsar::Deploy }
+  subject { Pulsar::Task }
 
   let(:described_instance) { described_class.new }
   let(:fail_text) { /Failed to deploy blog on production./ }
@@ -12,7 +12,7 @@ RSpec.describe Pulsar::CLI do
 
     before do
       allow($stdout).to receive(:puts)
-      allow(Pulsar::Deploy).to receive(:call).and_return(result)
+      allow(Pulsar::Task).to receive(:call).and_return(result)
     end
 
     context 'when using --conf-repo' do
@@ -24,7 +24,7 @@ RSpec.describe Pulsar::CLI do
 
       specify do
         is_expected.to have_received(:call)
-          .with(repository: repo, application: 'blog', environment: 'production')
+          .with(repository: repo, application: 'blog', environment: 'production', task: 'deploy')
       end
 
       context 'success' do
@@ -46,8 +46,10 @@ RSpec.describe Pulsar::CLI do
     end
 
     context 'when using configuration file' do
+      let(:options) { {} }
+
       before do
-        allow(described_instance).to receive(:options).and_return({})
+        allow(described_instance).to receive(:options).and_return(options)
         described_instance.deploy('blog', 'production')
       end
 
@@ -62,7 +64,7 @@ RSpec.describe Pulsar::CLI do
 
       specify do
         is_expected.to have_received(:call)
-          .with(repository: repo, application: 'blog', environment: 'production')
+          .with(repository: repo, application: 'blog', environment: 'production', task: 'deploy')
       end
 
       context 'success' do
@@ -72,6 +74,18 @@ RSpec.describe Pulsar::CLI do
         let(:result) { spy(success?: true) }
 
         it { is_expected.to output(/#{success}/).to_stdout }
+
+        context 'when file is unaccessible' do
+          let(:options) { { conf_repo: repo } }
+
+          around do |example|
+            system("chmod 000 #{RSpec.configuration.pulsar_dotenv_conf_path}")
+            example.run
+            system("chmod 644 #{RSpec.configuration.pulsar_dotenv_conf_path}")
+          end
+
+          it { is_expected.to output(/#{success}/).to_stdout }
+        end
       end
 
       context 'failure' do
@@ -92,7 +106,7 @@ RSpec.describe Pulsar::CLI do
 
       specify do
         is_expected.to have_received(:call)
-          .with(repository: repo, application: 'blog', environment: 'production')
+          .with(repository: repo, application: 'blog', environment: 'production', task: 'deploy')
       end
 
       context 'success' do
@@ -112,5 +126,13 @@ RSpec.describe Pulsar::CLI do
         it { is_expected.to output(fail_text).to_stdout }
       end
     end
+
+    context 'when no configuration repo is passed' do
+      context 'failure' do
+        subject { -> { described_instance.deploy('blog', 'production') } }
+
+        it { is_expected.to raise_error(Thor::RequiredArgumentMissingError) }
+      end
+    end
   end
 end

data/spec/units/cli/install_spec.rb

@@ -40,5 +40,27 @@ RSpec.describe Pulsar::CLI do
 
       it { is_expected.to output(/Failed to create intial repo./).to_stdout }
     end
+
+    context 'when an error is reported' do
+      subject { -> { described_instance.install } }
+      before do
+        allow(described_instance).to receive(:options).and_return(conf_repo: repo)
+        described_instance.list
+      end
+
+      let(:repo) { RSpec.configuration.pulsar_conf_path }
+
+      context 'as a string' do
+        let(:result) { spy(success?: false, error: "A stub sets this error") }
+
+        it { is_expected.to output(/A stub sets this error/).to_stdout }
+      end
+
+      context 'as an exception object' do
+        let(:result) { spy(success?: false, error: RuntimeError.new("A stub sets this error")) }
+
+        it { is_expected.to output(/A stub sets this error/).to_stdout }
+      end
+    end
   end
 end

data/spec/units/cli/list_spec.rb

@@ -43,8 +43,10 @@ RSpec.describe Pulsar::CLI do
     end
 
     context 'when using configuration file' do
+      let(:options) { {} }
+
       before do
-        allow(described_instance).to receive(:options).and_return({})
+        allow(described_instance).to receive(:options).and_return(options)
         described_instance.list
       end
 
@@ -66,6 +68,18 @@ RSpec.describe Pulsar::CLI do
         let(:result) { spy(success?: true, applications: applications) }
 
         it { is_expected.to output(/blog: staging/).to_stdout }
+
+        context 'when file is unaccessible' do
+          let(:options) { { conf_repo: repo } }
+
+          around do |example|
+            system("chmod 000 #{RSpec.configuration.pulsar_dotenv_conf_path}")
+            example.run
+            system("chmod 644 #{RSpec.configuration.pulsar_dotenv_conf_path}")
+          end
+
+          it { is_expected.to output(/blog: staging/).to_stdout }
+        end
       end
 
       context 'failure' do
@@ -103,5 +117,13 @@ RSpec.describe Pulsar::CLI do
         it { is_expected.to output(fail_text).to_stdout }
       end
     end
+
+    context 'when no configuration repo is passed' do
+      context 'failure' do
+        subject { -> { described_instance.deploy('blog', 'production') } }
+
+        it { is_expected.to raise_error(Thor::RequiredArgumentMissingError) }
+      end
+    end
   end
 end

data/spec/units/cli/task_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+RSpec.describe Pulsar::CLI do
+  subject { Pulsar::Task }
+
+  let(:described_instance) { described_class.new }
+  let(:fail_text) { /Failed to execute task deploy:check for blog on production./ }
+
+  context '#task' do
+    let(:result) { spy }
+    let(:repo)   { './conf_repo' }
+
+    before do
+      allow($stdout).to receive(:puts)
+      allow(Pulsar::Task).to receive(:call).and_return(result)
+    end
+
+    context 'when using --conf-repo' do
+      before do
+        allow(described_instance)
+          .to receive(:options).and_return(conf_repo: repo)
+        described_instance.task('blog', 'production', 'deploy:check')
+      end
+
+      specify do
+        is_expected.to have_received(:call)
+          .with(repository: repo, application: 'blog', environment: 'production', task: 'deploy:check')
+      end
+
+      context 'success' do
+        subject { -> { described_instance.task('blog', 'production', 'deploy:check') } }
+
+        let(:success) { "Executed task deploy:check for blog on production!" }
+        let(:result) { spy(success?: true) }
+
+        it { is_expected.to output(/#{success}/).to_stdout }
+      end
+
+      context 'failure' do
+        subject { -> { described_instance.task('blog', 'production', 'deploy:check') } }
+
+        let(:result) { spy(success?: false) }
+
+        it { is_expected.to output(fail_text).to_stdout }
+      end
+    end
+
+    context 'when using configuration file' do
+      let(:options) { {} }
+
+      before do
+        allow(described_instance).to receive(:options).and_return(options)
+        described_instance.task('blog', 'production', 'deploy:check')
+      end
+
+      around do |example|
+        old_const = Pulsar::PULSAR_CONF
+        Pulsar.send(:remove_const, 'PULSAR_CONF')
+        Pulsar::PULSAR_CONF = RSpec.configuration.pulsar_dotenv_conf_path
+        example.run
+        Pulsar.send(:remove_const, 'PULSAR_CONF')
+        Pulsar::PULSAR_CONF = old_const
+      end
+
+      specify do
+        is_expected.to have_received(:call)
+          .with(repository: repo, application: 'blog', environment: 'production', task: 'deploy:check')
+      end
+
+      context 'success' do
+        subject { -> { described_instance.task('blog', 'production', 'deploy:check') } }
+
+        let(:success) { "Executed task deploy:check for blog on production!" }
+        let(:result) { spy(success?: true) }
+
+        it { is_expected.to output(/#{success}/).to_stdout }
+
+        context 'when file is unaccessible' do
+          let(:options) { { conf_repo: repo } }
+
+          around do |example|
+            system("chmod 000 #{RSpec.configuration.pulsar_dotenv_conf_path}")
+            example.run
+            system("chmod 644 #{RSpec.configuration.pulsar_dotenv_conf_path}")
+          end
+
+          it { is_expected.to output(/#{success}/).to_stdout }
+        end
+      end
+
+      context 'failure' do
+        subject { -> { described_instance.task('blog', 'production', 'deploy:check') } }
+
+        let(:result) { spy(success?: false) }
+
+        it { is_expected.to output(fail_text).to_stdout }
+      end
+    end
+
+    context 'when using PULSAR_CONF_REPO' do
+      before do
+        allow(described_instance).to receive(:options).and_return({})
+        ENV['PULSAR_CONF_REPO'] = repo
+        described_instance.task('blog', 'production', 'deploy:check')
+      end
+
+      specify do
+        is_expected.to have_received(:call)
+          .with(repository: repo, application: 'blog', environment: 'production', task: 'deploy:check')
+      end
+
+      context 'success' do
+        subject { -> { described_instance.task('blog', 'production', 'deploy:check') } }
+
+        let(:success) { "Executed task deploy:check for blog on production!" }
+        let(:result) { spy(success?: true) }
+
+        it { is_expected.to output(/#{success}/).to_stdout }
+      end
+
+      context 'failure' do
+        subject { -> { described_instance.task('blog', 'production', 'deploy:check') } }
+
+        let(:result) { spy(success?: false) }
+
+        it { is_expected.to output(fail_text).to_stdout }
+      end
+    end
+
+    context 'when no configuration repo is passed' do
+      context 'failure' do
+        subject { -> { described_instance.task('blog', 'production', 'deploy:check') } }
+
+        it { is_expected.to raise_error(Thor::RequiredArgumentMissingError) }
+      end
+    end
+  end
+end

data/spec/units/cli/version_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+RSpec.describe Pulsar::CLI do
+  subject { Pulsar::Version }
+
+  let(:described_instance) { described_class.new }
+
+  context '#__print_version' do
+    subject { -> { described_instance.__print_version } }
+
+    it { is_expected.to output(/#{Pulsar::VERSION}/).to_stdout }
+  end
+end

data/spec/units/interactors/copy_environment_file_spec.rb

@@ -78,6 +78,31 @@ RSpec.describe Pulsar::CopyEnvironmentFile do
 
         it { is_expected.to be_a_failure }
       end
+
+      context 'when passing a missing environment' do
+        let(:args) do
+          {
+            config_path: RSpec.configuration.pulsar_conf_path,
+            cap_path: cap_path,
+            applications: { 'blog' => %w(production development) },
+            application: 'blog',
+            environment: 'staging'
+          }
+        end
+
+        it { is_expected.to be_a_failure }
+
+        context 'shows a proper error message' do
+          subject { command.error }
+
+          let(:error) do
+            'The application blog does not have an environment called staging'
+          end
+
+          it { is_expected.to be_an_instance_of Pulsar::ContextError }
+          it { expect(subject.message).to eql error }
+        end
+      end
     end
   end
 end

data/spec/units/interactors/create_capfile_spec.rb

@@ -72,6 +72,28 @@ RSpec.describe Pulsar::CreateCapfile do
 
         it { is_expected.to be_a_failure }
       end
+
+      context 'when passing a missing application' do
+        let(:args) do
+          {
+            config_path: RSpec.configuration.pulsar_conf_path,
+            cap_path: cap_path, application: 'wiki', applications: { 'blog' => %w(staging) }
+          }
+        end
+
+        it { is_expected.to be_a_failure }
+
+        context 'shows a proper error message' do
+          subject { command.error }
+
+          let(:error) do
+            'The application wiki does not exist in your repository'
+          end
+
+          it { is_expected.to be_an_instance_of Pulsar::ContextError }
+          it { expect(subject.message).to eql(error) }
+        end
+      end
     end
   end
 end

data/spec/units/interactors/run_capistrano_spec.rb

@@ -6,24 +6,51 @@ RSpec.describe Pulsar::RunCapistrano do
   it { is_expected.to be_kind_of(Interactor) }
 
   describe '.success' do
-    subject do
-      described_class.new(
+    subject { described_class.new context_params }
+    let(:context_params) do
+      {
         cap_path: RSpec.configuration.pulsar_conf_path, config_path: './config-path',
-        bundle_path: './bundle-path', environment: 'production'
-      )
+        bundle_path: './bundle-path', environment: 'production',
+        task: task
+      }
     end
-
-    let(:cap_cmd) { "cap production deploy" }
     let(:bundle_cmd) do
       "BUNDLE_GEMFILE=./config-path/Gemfile BUNDLE_PATH=./bundle-path bundle exec"
     end
 
-    before do
-      allow(Rake).to receive(:sh).and_return(true)
-      subject.run
+    context 'for plain old deploy command' do
+      let(:cap_cmd) { "cap production deploy" }
+      let(:task) { 'deploy' }
+      before do
+        allow(Rake).to receive(:sh).and_return(true)
+        subject.run
+      end
+
+      it { expect(Rake).to have_received(:sh).with("#{bundle_cmd} #{cap_cmd}") }
     end
 
-    it { expect(Rake).to have_received(:sh).with("#{bundle_cmd} #{cap_cmd}") }
+    context 'for other capistrano tasks' do
+      context 'without Capistrano arguments' do
+        let(:cap_cmd) { "cap production deploy:check" }
+        let(:task) { 'deploy:check' }
+        before do
+          allow(Rake).to receive(:sh).and_return(true)
+          subject.run
+        end
+
+        it { expect(Rake).to have_received(:sh).with("#{bundle_cmd} #{cap_cmd}") }
+      end
+      context 'with Capistrano arguments' do
+        let(:cap_cmd) { "cap production deploy:check[param1,param2]" }
+        let(:task) { 'deploy:check[param1,param2]' }
+        before do
+          allow(Rake).to receive(:sh).and_return(true)
+          subject.run
+        end
+
+        it { expect(Rake).to have_received(:sh).with("#{bundle_cmd} #{cap_cmd}") }
+      end
+    end
   end
 
   context 'failure' do
@@ -37,7 +64,7 @@ RSpec.describe Pulsar::RunCapistrano do
       subject do
         described_class.call(
           config_path: './config-path', bundle_path: './bundle-path',
-          environment: 'production'
+          environment: 'production', task: 'deploy:check'
         )
       end
 
@@ -48,17 +75,18 @@ RSpec.describe Pulsar::RunCapistrano do
       subject do
         described_class.call(
           cap_path: './cap-path', config_path: './config-path',
-          bundle_path: './bundle-path'
+          bundle_path: './bundle-path', task: 'deploy:check'
         )
       end
 
       it { is_expected.to be_a_failure }
     end
+
     context 'when no bundle_path context is passed' do
       subject do
         described_class.call(
           cap_path: './cap-path', config_path: './config-path',
-          environment: 'production'
+          environment: 'production', task: 'deploy:check'
         )
       end
 
@@ -69,14 +97,14 @@ RSpec.describe Pulsar::RunCapistrano do
       subject do
         described_class.call(
           cap_path: './cap-path', environment: 'production',
-          bundle_path: './bundle-path'
+          bundle_path: './bundle-path', task: 'deploy:check'
         )
       end
 
       it { is_expected.to be_a_failure }
     end
 
-    context 'when an exception is triggered' do
+    context 'when no task is passed' do
       subject do
         described_class.call(
           cap_path: './cap-path', config_path: './config-path',
@@ -84,6 +112,38 @@ RSpec.describe Pulsar::RunCapistrano do
         )
       end
 
+      it { is_expected.to be_a_failure }
+    end
+
+    context 'when the task does not exist' do
+      subject do
+        described_class.call(
+          cap_path: './cap-path', config_path: './config-path',
+          bundle_path: './bundle-path', environment: 'production',
+          task: 'unexistent:task'
+        )
+      end
+      it { is_expected.to be_a_failure }
+    end
+
+    context 'when the task is malformed' do
+      subject do
+        described_class.call(
+          cap_path: './cap-path', config_path: './config-path',
+          bundle_path: './bundle-path', environment: 'production',
+          task: 'unexistent:task[param1,pa'
+        )
+      end
+      it { is_expected.to be_a_failure }
+    end
+    context 'when an exception is triggered' do
+      subject do
+        described_class.call(
+          cap_path: './cap-path', config_path: './config-path',
+          bundle_path: './bundle-path', environment: 'production',
+          task: 'deploy:check'
+        )
+      end
       before { allow(Dir).to receive(:chdir).and_raise(RuntimeError) }
 
       it { is_expected.to be_a_failure }