statistrano 1.2.0

data/spec/integration_tests/releases/prune_releases_integration_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe "Statistrano::Deployment::Strategy::Releases#prune_releases integration", :integration do
+
+  context "with multiple_targets target" do
+
+    before :each do
+      Given.fixture "releases-deployed"
+      @subject = define_deployment "releases", :releases do
+        build_task "remote:copy"
+        local_dir  "build"
+        hostname   "localhost"
+        remote_dir File.join( Dir.pwd, "deployment" )
+
+        release_count 1
+        remotes [
+          { remote_dir: File.join( Dir.pwd, "deployment", "target01" ) },
+          { remote_dir: File.join( Dir.pwd, "deployment", "target02" ) },
+          { remote_dir: File.join( Dir.pwd, "deployment", "target03" ) }
+        ]
+      end
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it "removes older releases beyond release count" do
+      @subject.prune_releases
+      expect( multi_release_folder_contents )
+        .to match_array [ "target01/releases/1372040000",
+                          "target02/releases/1372040000",
+                          "target03/releases/1372040000" ]
+    end
+
+    it "removes stray/untracked releases" do
+      Given.file "deployment/target01/releases/foo_bar/index.html", ''
+      Given.file "deployment/target02/releases/foo_bar/index.html", ''
+      Given.file "deployment/target03/releases/foo_bar/index.html", ''
+      @subject.prune_releases
+      expect( multi_release_folder_contents )
+        .to match_array [ "target01/releases/1372040000",
+                          "target02/releases/1372040000",
+                          "target03/releases/1372040000" ]
+    end
+
+    it "won't remove the currently symlinked release" do
+      Given.symlink "deployment/target01/releases/1372030000", "deployment/target01/current"
+      Given.symlink "deployment/target02/releases/1372030000", "deployment/target02/current"
+      Given.symlink "deployment/target03/releases/1372030000", "deployment/target03/current"
+
+      @subject.prune_releases
+
+      expect( multi_release_folder_contents )
+        .to match_array [ "target01/releases/1372030000",
+                          "target01/releases/1372040000",
+
+                          "target02/releases/1372030000",
+                          "target02/releases/1372040000",
+
+                          "target03/releases/1372030000",
+                          "target03/releases/1372040000" ]
+    end
+
+    it "won't remove the currently symlinked release even if untracked" do
+      Given.file    "deployment/target01/releases/foo_bar/index.html", ''
+      Given.file    "deployment/target02/releases/foo_bar/index.html", ''
+      Given.file    "deployment/target03/releases/foo_bar/index.html", ''
+      Given.symlink "deployment/target01/releases/foo_bar", "deployment/target01/current"
+      Given.symlink "deployment/target02/releases/foo_bar", "deployment/target02/current"
+      Given.symlink "deployment/target03/releases/foo_bar", "deployment/target03/current"
+
+      @subject.prune_releases
+
+      expect( multi_release_folder_contents )
+        .to match_array [ "target01/releases/foo_bar",
+                          "target01/releases/1372040000",
+
+                          "target02/releases/foo_bar",
+                          "target02/releases/1372040000",
+
+                          "target03/releases/foo_bar",
+                          "target03/releases/1372040000" ]
+    end
+  end
+end

data/spec/integration_tests/releases/rollback_release_integration_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe "Statistrano::Deployment::Strategy::Releases#rollback_release integration", :integration do
+
+  context "with multiple_targets target" do
+
+    before :each do
+      Given.fixture "releases-deployed"
+      @subject = define_deployment "releases", :releases do
+        build_task "remote:copy"
+        local_dir  "build"
+        hostname   "localhost"
+        remote_dir File.join( Dir.pwd, "deployment" )
+
+        release_count 2
+        remotes [
+          { remote_dir: File.join( Dir.pwd, "deployment", "target01" ) },
+          { remote_dir: File.join( Dir.pwd, "deployment", "target02" ) },
+          { remote_dir: File.join( Dir.pwd, "deployment", "target03" ) }
+        ]
+      end
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it "reverts to the previous release" do
+      # just to verify that 137204000 is the current release
+      # on all targets
+      ["target01","target02","target03"].each do |target|
+        ls_before = HereOrThere::Local.new.run("ls -la deployment/#{target}")
+        expect( ls_before.stdout ).to match /current ->(.+)tmp\/deployment\/#{target}\/releases\/1372040000/
+      end
+
+      @subject.rollback_release
+
+      ["target01","target02","target03"].each do |target|
+        ls_after = HereOrThere::Local.new.run("ls -la deployment/#{target}")
+        expect( ls_after.stdout ).to match /current ->(.+)tmp\/deployment\/#{target}\/releases\/1372030000/
+      end
+    end
+
+  end
+
+end

data/spec/lib/statistrano/config/configurable_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Statistrano::Config::Configurable do
+
+  before :each do
+    class Subject
+      extend ::Statistrano::Config::Configurable
+
+      option :foo, "bar"
+      option :wu
+      option :proc, -> { "hello" }
+
+      options :one, :two
+    end
+  end
+
+  let(:subject) { Subject.new }
+
+  describe "#option" do
+
+    it "sets the given default value" do
+      expect( subject.config.foo ).to eq("bar")
+    end
+
+    it "defaults to setting nil" do
+      expect( subject.config.wu ).to be_nil
+    end
+
+  end
+
+
+  describe "#options" do
+    it "creates an accessor for each given option" do
+      names = [:one,:two]
+
+      names.each do |meth|
+        expect( subject.config.respond_to? meth ).to be_truthy
+      end
+    end
+
+    it "defaults those values to nil" do
+      names = [:one,:two]
+
+      names.each do |meth|
+        expect( subject.config.public_send meth ).to be_nil
+      end
+    end
+  end
+
+  describe "option accessor" do
+    let(:config) { subject.config }
+
+    it "returns the value if given no arguments" do
+      expect( config.foo ).to eq("bar")
+    end
+
+    it "sets the value if given one argument" do
+      config.foo "baz"
+      expect( config.foo ).to eq("baz")
+    end
+
+    it "sets the value if given an #=" do
+      config.foo = "badazz"
+      expect( config.foo ).to eq("badazz")
+    end
+
+    it "sets the value to a block if given one" do
+      config.foo do
+        "badazz"
+      end
+      expect( config.foo.call ).to eq "badazz"
+    end
+
+    it "calls a block if `:call` is passed" do
+      config.foo :call do
+        "badazz"
+      end
+      expect( config.foo ).to eq "badazz"
+    end
+
+    it "raises and ArgumentError if given more than 1 argument" do
+      expect{ config.foo "bar", "baz" }.to raise_error ArgumentError
+    end
+
+  end
+
+
+end

data/spec/lib/statistrano/config/rake_task_with_context_creation_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Statistrano::Config::RakeTaskWithContextCreation do
+
+  before :each do
+    Subject = Class.new
+    Subject.send(:include, described_class)
+  end
+
+  describe "::included" do
+    it "creates user_task_namespaces method defaulting to []" do
+      expect( Subject.new.methods ).to include :user_task_namespaces
+      expect( Subject.new.user_task_namespaces ).to eq []
+    end
+
+    it "creates user_tasks method defaulting to []" do
+      expect( Subject.new.methods ).to include :user_tasks
+      expect( Subject.new.user_tasks ).to eq []
+    end
+  end
+
+  describe "#task" do
+    it "adds a task to the user_tasks store with name and namespaces" do
+      subject = Subject.new
+      block   = lambda { }
+      subject.task 'hello', &block
+
+      expect( subject.user_tasks ).to include name: 'hello',
+                                              namespaces: [],
+                                              block: block
+    end
+
+    it "adds optional desc to task" do
+      subject = Subject.new
+      block   = lambda { }
+      subject.task 'hello', 'I a method', &block
+
+      expect( subject.user_tasks ).to include name: 'hello',
+                                              desc: 'I a method',
+                                              namespaces: [],
+                                              block: block
+    end
+  end
+
+  describe "#namespace" do
+    it "evaluates given block appending the namespaces" do
+      subject = Subject.new
+      block   = lambda { }
+
+      subject.namespace 'hello' do
+        task 'world', &block
+
+        namespace 'foo' do
+          task 'bar',  &block
+          task 'bang', &block
+        end
+      end
+
+      expect( subject.user_tasks ).to include name: 'world',
+                                              namespaces: ['hello'],
+                                              block: block
+
+      expect( subject.user_tasks ).to include name: 'bar',
+                                              namespaces: ['hello', 'foo'],
+                                              block: block
+
+      expect( subject.user_tasks ).to include name: 'bang',
+                                              namespaces: ['hello', 'foo'],
+                                              block: block
+    end
+  end
+
+end

data/spec/lib/statistrano/config_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Statistrano::Config do
+
+  describe "#initialize" do
+    it "defaults options & tasks to a blank hash" do
+      subject = described_class.new
+
+      expect( subject.options ).to eq({})
+      expect( subject.tasks ).to eq({})
+    end
+
+    it "defines an accessor for each given option" do
+      subject = described_class.new foo: 'bar'
+      expect( subject.foo ).to eq 'bar'
+    end
+
+    it "uses given options & tasks, but clones so the originals don't get modified" do
+      options = { foo: 'bar' }
+      tasks   = { foo: 'bar' }
+      subject = described_class.new options, tasks
+
+      subject.foo         = 'baz'
+      subject.tasks[:foo] = 'baz'
+
+      expect( subject.foo ).to eq 'baz'
+      expect( options ).to eq foo: 'bar'
+
+      expect( subject.tasks ).to eq foo: 'baz'
+      expect( tasks ).to eq foo: 'bar'
+    end
+  end
+
+end

data/spec/lib/statistrano/deployment/log_file_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Statistrano::Deployment::LogFile do
+
+  before :each do
+    config  = double("Statistrano::Config", remote_dir: '/remote_dir')
+    @remote = instance_double("Statistrano::Remote", config: config)
+  end
+
+  describe "#initialize" do
+
+    it "sets :remote to the given remote" do
+      subject = described_class.new 'foo/bar', @remote
+      expect( subject.remote ).to eq @remote
+    end
+    it "sets resolved_path to given path if absolute" do
+      subject = described_class.new '/var/log', @remote
+      expect( subject.resolved_path ).to eq '/var/log'
+    end
+    it "sets resolved_path relative to remote.config.remote_dir if relative" do
+      subject = described_class.new 'var/log', @remote
+      expect( subject.resolved_path ).to eq '/remote_dir/var/log'
+    end
+    it "sets file to Remote::File created with resolved_path and remote" do
+      expect( Statistrano::Remote::File ).to receive(:new)
+                                         .with( '/var/log', @remote )
+
+      described_class.new '/var/log', @remote
+    end
+  end
+
+  describe "#append!" do
+    it "calls #append_content! on Remote::File with entry converted to json" do
+      remote_file_double = instance_double("Statistrano::Remote::File")
+      allow( Statistrano::Remote::File ).to receive(:new)
+                                        .with( '/var/log', @remote )
+                                        .and_return(remote_file_double)
+      subject = described_class.new '/var/log', @remote
+
+      expect( remote_file_double ).to receive(:append_content!)
+                                  .with('{"log":"entry"}')
+
+      subject.append! log: 'entry'
+    end
+  end
+
+  describe "#last_entry" do
+
+    before :each do
+      @remote_file_double = instance_double("Statistrano::Remote::File")
+      allow( Statistrano::Remote::File ).to receive(:new)
+                                        .with( '/var/log', @remote )
+                                        .and_return(@remote_file_double)
+      @subject = described_class.new '/var/log', @remote
+    end
+
+    it "returns hash of last entry data" do
+      allow( @remote_file_double ).to receive(:content)
+                                  .and_return "{\"log\":1}\n{\"log\":2}"
+
+      expect( @subject.last_entry ).to eq log: 2
+    end
+
+    it "returns empty hash if no entries" do
+      allow( @remote_file_double ).to receive(:content)
+                                  .and_return ""
+
+      expect( @subject.last_entry ).to eq({})
+    end
+  end
+
+  describe "#tail" do
+  end
+
+end

data/spec/lib/statistrano/deployment/manifest_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+describe Statistrano::Deployment::Manifest do
+
+  describe "#initialize" do
+    it "stores the provided remote_dir & remote" do
+      subject = described_class.new( "remote_dir", "remote" )
+
+      expect( subject.remote_dir ).to eq "remote_dir"
+      expect( subject.remote ).to eq "remote"
+    end
+  end
+
+  describe "#data" do
+    it "returns serialized data from remote" do
+      remote  = instance_double("Statistrano::Remote")
+      file    = instance_double("Statistrano::Remote::File")
+      expect( Statistrano::Remote::File ).to receive(:new)
+                                         .and_return(file)
+      subject = described_class.new '/var/www/proj', remote
+      expect( file ).to receive(:content)
+                    .and_return('[{"key":"val"}]')
+
+      expect( subject.data ).to match_array [{ key: 'val' }]
+    end
+
+    it "returns empty array if manifest file is missing" do
+      remote  = instance_double("Statistrano::Remote")
+      file    = instance_double("Statistrano::Remote::File")
+      expect( Statistrano::Remote::File ).to receive(:new)
+                                         .and_return(file)
+      expect( file ).to receive(:content)
+                    .and_return('')
+      subject = described_class.new '/var/www/proj', remote
+
+      expect( subject.data ).to match_array []
+    end
+
+    it "logs error when manifest contains invalid JSON" do
+      config  = double("Statistrano::Config", hostname: 'web01')
+      remote  = instance_double("Statistrano::Remote", config: config )
+      file    = instance_double("Statistrano::Remote::File")
+      expect( Statistrano::Remote::File ).to receive(:new)
+                                         .and_return(file)
+      subject = described_class.new '/var/www/proj', remote
+      expect( file ).to receive(:content)
+                    .and_return('invalid')
+      expect( Statistrano::Log ).to receive(:error)
+      subject.data
+    end
+
+    it "returns @_data if set" do
+      remote  = instance_double("Statistrano::Remote")
+      subject = described_class.new '/var/www/proj', remote
+
+      subject.instance_variable_set(:@_data, 'data')
+      expect( subject.data ).to eq 'data'
+    end
+
+    it "sets @_data with return" do
+      remote  = instance_double("Statistrano::Remote")
+      subject = described_class.new '/var/www/proj', remote
+      allow( remote ).to receive(:run).and_return( HereOrThere::Response.new('[{"key":"val"}]','',true) )
+
+      data = subject.data
+      expect( subject.instance_variable_get(:@_data) ).to eq data
+    end
+  end
+
+  describe "#push" do
+    it "adds data to the data array" do
+      remote  = instance_double("Statistrano::Remote")
+      allow( remote ).to receive(:run).and_return( HereOrThere::Response.new('[{"key":"val"}]','',true) )
+      subject = described_class.new '/var/www/proj', remote
+
+      new_data = {foo: 'bar'}
+      subject.push new_data
+      expect( subject.data ).to include new_data
+    end
+
+    it "symbolizes keys in passed data" do
+      remote  = instance_double("Statistrano::Remote")
+      allow( remote ).to receive(:run).and_return( HereOrThere::Response.new('[{"key":"val"}]','',true) )
+      subject = described_class.new '/var/www/proj', remote
+
+      new_data = {"foo" => 'bar'}
+      subject.push new_data
+      expect( subject.data ).to include foo: 'bar'
+    end
+
+    it "raises error if provided data cannot be converted to JSON" do
+      remote  = instance_double("Statistrano::Remote")
+      allow( remote ).to receive(:run).and_return( HereOrThere::Response.new('[{"key":"val"}]','',true) )
+      subject = described_class.new '/var/www/proj', remote
+
+      data = double
+      expect( data ).to receive(:respond_to?)
+                    .with(:to_json).and_return(false)
+
+      expect{
+        subject.push data
+      }.to raise_error ArgumentError, "data must be serializable as JSON"
+    end
+  end
+
+  describe "#put" do
+    # a "safer" version of `push`, will update a
+    # data_glob in place matched on key
+    let(:remote) { instance_double("Statistrano::Remote") }
+
+    context "when item doesn't exist" do
+      it "adds the item w/o disturbing existing data" do
+        subject = described_class.new "remote_dir", remote
+        allow( remote ).to receive(:run)
+                       .and_return( HereOrThere::Response.new('[{"key":"val"}]','',true) )
+
+        subject.put( { foo: "bar" }, :foo )
+        expect( subject.data ).to match_array [{key: "val"},{foo: "bar"}]
+      end
+    end
+
+    context "when item does exist" do
+      it "updates the item w/o distrubing existing data" do
+        subject = described_class.new "remote_dir", remote
+        allow( remote ).to receive(:run)
+                       .and_return( HereOrThere::Response.new('[{"key":"val"},{"key":"foo","marker":"orig"}]','',true) )
+
+        subject.put( {key:"foo",marker:"new"}, :key )
+        expect( subject.data ).to match_array [{key: "val"},{key:"foo",marker:"new"}]
+      end
+    end
+  end
+
+  describe "#remove_if" do
+    it "removes data that matches the condition" do
+      remote  = instance_double("Statistrano::Remote")
+      allow( remote ).to receive(:run).and_return( HereOrThere::Response.new('[{"key":"val"}]','',true) )
+      subject = described_class.new '/var/www/proj', remote
+
+      subject.remove_if { |item| item.has_key?(:key) }
+      expect( subject.data ).to match_array []
+    end
+    it "retains data that doesn't match condition" do
+      remote  = instance_double("Statistrano::Remote")
+      allow( remote ).to receive(:run).and_return( HereOrThere::Response.new('[{"key":"val"}]','',true) )
+      subject = described_class.new '/var/www/proj', remote
+
+      subject.remove_if { |item| !item.has_key?(:key) }
+      expect( subject.data ).to match_array [{key:"val"}]
+    end
+  end
+
+  describe "#save!" do
+    it "calls update_content! for the remote_file" do
+      remote  = instance_double("Statistrano::Remote")
+      file    = instance_double("Statistrano::Remote::File")
+
+      expect( Statistrano::Remote::File ).to receive(:new)
+                                         .with("/path/manifest.json", remote)
+                                         .and_return(file)
+      expect( file ).to receive(:update_content!)
+                    .with('[{"key":"val"}]')
+
+      subject = described_class.new "/path", remote
+      subject.instance_variable_set(:@_data, [{key: "val"}])
+
+      subject.save!
+    end
+  end
+
+end

data/spec/lib/statistrano/deployment/rake_tasks_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Statistrano::Deployment::RakeTasks do
+
+  describe "::register" do
+
+    context "config tasks" do
+      before :each do
+        class RakeTasksSubject
+          extend Statistrano::Config::Configurable
+          include Statistrano::Deployment::Strategy::InvokeTasks
+
+          attr_reader :name
+
+          task :foo, :bar, "baz"
+
+          def initialize name
+            @name = name
+          end
+
+          def bar
+            "baz"
+          end
+        end
+      end
+
+      after :each do
+        Rake::Task.clear
+      end
+
+      it "registers tasks using deployment's name as namespace" do
+        described_class.register RakeTasksSubject.new "woo"
+        expect( Rake::Task.tasks.map(&:to_s) ).to include 'woo:foo'
+      end
+
+      it "calls the tasks matching method on the deployment" do
+        subject = RakeTasksSubject.new "woo"
+        described_class.register subject
+
+        expect( subject ).to receive(:bar)
+
+        Rake::Task['woo:foo'].invoke
+      end
+    end
+
+    context "user_tasks" do
+
+      after :each do
+        Rake::Task.clear
+      end
+
+      it "adds the task in the correct namespace" do
+        config            = Statistrano::Config.new
+        deployment_double = instance_double("Statistrano::Deployment::Strategy::Base", name: 'name', config: config)
+        config.user_tasks.push name: 'start',
+                               namespaces: ['puma'],
+                               block: lambda { }
+
+        described_class.register deployment_double
+
+        expect( Rake::Task.tasks.map(&:to_s) ).to include 'name:puma:start'
+      end
+
+      it "registers the task at top level if no namespaces" do
+        config            = Statistrano::Config.new
+        deployment_double = instance_double("Statistrano::Deployment::Strategy::Base", name: 'name', config: config)
+        config.user_tasks.push name: 'start',
+                               namespaces: [],
+                               block: lambda { }
+
+        described_class.register deployment_double
+
+        expect( Rake::Task.tasks.map(&:to_s) ).to include 'name:start'
+      end
+
+      it "adds description if given" do
+        config            = Statistrano::Config.new
+        deployment_double = instance_double("Statistrano::Deployment::Strategy::Base", name: 'name', config: config)
+        config.user_tasks.push name: 'start',
+                               desc: 'start something',
+                               namespaces: [],
+                               block: lambda { }
+
+        described_class.register deployment_double
+
+        expect( Rake::Task.tasks.map(&:to_s) ).to include 'name:start'
+        expect( Rake::Task.tasks.select { |t| t.full_comment == 'start something' } ).not_to be_empty
+      end
+
+      it "yields the deployment if arity is given" do
+        config            = Statistrano::Config.new
+        deployment_double = instance_double("Statistrano::Deployment::Strategy::Base", name: 'name', config: config)
+        config.user_tasks.push name: 'start',
+                               namespaces: ['puma'],
+                               block: lambda { |dep| dep.remotes }
+        described_class.register deployment_double
+
+        expect( deployment_double ).to receive(:remotes)
+
+        Rake::Task['name:puma:start'].invoke
+      end
+
+    end
+
+  end
+
+end