capistrano 3.0.0.pre14 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d396873548e6dd9e20c1853f741bc8808e7a529
-  data.tar.gz: 24aa535d127498013298938e5effb7e38bd26fbb
+  metadata.gz: 6e84be755bb1beb1fa002d555a2a237a569fe0b0
+  data.tar.gz: 2fdcff3917f21ed061bc94fa74d09fb06e4b8bd0
 SHA512:
-  metadata.gz: 828006f69722330dcfbf09833922f0547a00fde78bd2d59948b4ebd59b139afa779f69c87e7d69e22e1fff7e9377d84484594dc5edaa544919a644c39d9d9338
-  data.tar.gz: 8cfb03d51c92cac8ab9c6bd8cd7ba4d3416731de893927db8ab1b0117e5478af71c4e9256aaea8350a7cf23f663432ae1f7b1b19b5cad80e10890a607bb4c245
+  metadata.gz: 9d330918070791f930fc5254574f633ec354b87ebd2b194b16392771f1d135c1d1352f412ca915e8c194b8776fa0b820e023f88829782807bb2c4d41cf37981d
+  data.tar.gz: bd9b0c4d70a9b420decc32592d7fd5d59e93d40e01558318e5f969dfb5add69ccb813a10a3518224940d8da6f40f1d6e30699e072ada18b97925a08aaa6426a5

data/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 Reverse Chronological Order:
 
+## `3.0.0`
+
+If you are coming here to wonder why your Capfile doesn't work anymore, please
+vendor lock your Capistrano at 2.5.x, whichever version was working for you
+until today.
+
+Capistrano 3 is a ground-up rewrite with modularity, stability, speed and
+future proofing in mind. It's a big change, but now the code is 10x smaller,
+runs faster, is easier to read, and quicker to extend. In the reduction we've
+come up with a great gem based modular system for plugins and we're really
+proud of this release.
+
+The 3.0.0 release contains 38 patches from the following amazing people:
+
+  * Tom `seenmyfate` Clements: more than 28 patches including cucumber integration tests! Not to
+    mention Rails asset pipeline code, and bundler integrations.
+  * Lee Hambley: Small changes around compatibility and log formatting
+  * Kir Shatrov: for improvements in the core to make it easier to write extensions, for
+    improving documentation, and for effectively building the chruby, rvm and rbenv integrations.
+  * Michael Nikitochkin: Fixing a bug around linked files and directories.
+  * Jack Thorne: for improvements to the default `Capfile` to fix some bad example syntax.
+  * Erik Hetzner: for (what looks like great) work on the Mercurial (Hg) support. The Hg and Git
+    source control mechanisms do not work the same way, but rather lean on the strengths of the
+    underlying tools.
+
+    (If I missed anyone, I'm sorry, your contributions have been awesome)
+
+The 2.x branch of code is now no longer maintained. Towards the end of it's
+useful life there were an increasing number of features and pieces of code
+which didn't make sense for certain groups of people, in certain situations,
+leading a to a ping-pong tennis effect with pull requests every few weeks
+"fixing" a use-case which had already been "fixed" shortly before. As many of
+the use-cases are outside the scope of the testing environments I (and by
+extension the trusted contributors and IRC regulars) were able to test for.
+
+There's a more extensive post about my failure to be able to keep up with the
+demands of maintaining v2 whilst trying to build something which is appropriate
+for the current landscape. If you are affected by the unsupported 2 branch,
+please contact me (Lee Hambley) to dicsuss how my company can help support you.
+Otherwise, please try v3, we're sure you'll like it, and the code is designed
+to be so simple that anyone can work on it.
+
 ## `3.0.0.pre14`
 
  * Thanks to numerous contributors, in particular (@teohm) for a series of improvements.

data/README.md

@@ -19,7 +19,7 @@ $ bundle --binstubs
 ```
 
 Capify:
-*make sure there's no "Capfile" or "capfile" present* 
+*make sure there's no "Capfile" or "capfile" present*
 ``` shell
 $ cap install
 ```

data/bin/cap

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-require 'capistrano'
+require 'capistrano/all'
 Capistrano::Application.new.run

data/capistrano.gemspec

@@ -28,5 +28,8 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'vagrant', '~> 1.0.7'
+  gem.add_development_dependency 'kuroko'
+  gem.add_development_dependency 'cucumber'
 
 end

data/features/deploy.feature

@@ -0,0 +1,52 @@
+Feature: Deploy
+
+  Background:
+    Given a test app with the default configuration
+    And servers with the roles app and web
+
+  Scenario: Creating the repo
+    When I run cap "git:check"
+    Then references in the remote repo are listed
+
+  Scenario: Creating the directory structure
+    When I run cap "deploy:check:directories"
+    Then the shared path is created
+    And the releases path is created
+
+  Scenario: Creating linked directories
+    When I run cap "deploy:check:linked_dirs"
+    Then directories in :linked_dirs are created in shared
+
+  Scenario: Creating linked directories for linked files
+    When I run cap "deploy:check:make_linked_dirs"
+    Then directories referenced in :linked_files are created in shared
+
+  Scenario: Checking linked files - missing file
+    Given a required file
+    But the file does not exist
+    When I run cap "deploy:check:linked_files"
+    Then the task will exit
+
+  Scenario: Checking linked files - file exists
+    Given a required file
+    And that file exists
+    When I run cap "deploy:check:linked_files"
+    Then the task will be successful
+
+  Scenario: Creating a release
+    When I run cap "git:create_release" as part of a release
+    Then the repo is cloned
+    And the release is created
+
+  Scenario: Symlink linked files
+    When I run cap "deploy:symlink:linked_files" as part of a release
+    Then file symlinks are created in the new release
+
+  Scenario: Symlink linked dirs
+    When I run cap "deploy:symlink:linked_dirs" as part of a release
+    Then directory symlinks are created in the new release
+
+  Scenario: Publishing
+    When I run cap "deploy:symlink:release"
+    Then the current directory will be a symlink to the release
+

data/features/installation.feature

@@ -0,0 +1,16 @@
+Feature: Installation
+
+  Background:
+    Given a test app with the default configuration
+
+  Scenario: With default stages
+    When I run cap "install"
+    Then the deploy.rb file is created
+    And the default stage files are created
+    And the tasks folder is created
+
+  Scenario: With specified stages
+    When I run cap "install STAGES=qa,production"
+    Then the deploy.rb file is created
+    And the specified stage files are created
+    And the tasks folder is created

data/features/remote_file_task.feature

@@ -0,0 +1,14 @@
+Feature: Remote file task
+
+  Background:
+    Given a test app with the default configuration
+    And a custom task to generate a file
+    And servers with the roles app and web
+
+  Scenario: Where the file does not exist
+    When I run cap "deploy:check:linked_files"
+    Then it creates the file with the remote_task prerequisite
+
+  Scenario: Where the file already exists
+    When I run cap "deploy:check:linked_files"
+    Then it will not recreate the file

data/features/step_definitions/assertions.rb

@@ -0,0 +1,90 @@
+Then(/^references in the remote repo are listed$/) do
+end
+
+Then(/^the shared path is created$/) do
+  run_vagrant_command(test_dir_exists(TestApp.shared_path))
+end
+
+Then(/^the releases path is created$/) do
+  run_vagrant_command(test_dir_exists(TestApp.releases_path))
+end
+
+Then(/^directories in :linked_dirs are created in shared$/) do
+  TestApp.linked_dirs.each do |dir|
+    run_vagrant_command(test_dir_exists(TestApp.shared_path.join(dir)))
+  end
+end
+
+Then(/^directories referenced in :linked_files are created in shared$/) do
+  dirs = TestApp.linked_files.map { |path| TestApp.shared_path.join(path).dirname }
+  dirs.each do | dir|
+    run_vagrant_command(test_dir_exists(dir))
+  end
+end
+
+Then(/^the task will be successful$/) do
+end
+
+
+Then(/^the task will exit$/) do
+end
+
+Then(/^the repo is cloned$/) do
+  run_vagrant_command(test_dir_exists(TestApp.repo_path))
+end
+
+Then(/^the release is created$/) do
+  run_vagrant_command("ls -g #{TestApp.releases_path}")
+end
+
+Then(/^file symlinks are created in the new release$/) do
+  pending
+  TestApp.linked_files.each do |file|
+    run_vagrant_command(test_symlink_exists(TestApp.release_path.join(file)))
+  end
+end
+
+Then(/^directory symlinks are created in the new release$/) do
+  pending
+  TestApp.linked_dirs.each do |dir|
+    run_vagrant_command(test_symlink_exists(TestApp.release_path.join(dir)))
+  end
+end
+
+Then(/^the current directory will be a symlink to the release$/) do
+  run_vagrant_command(test_symlink_exists(TestApp.current_path))
+end
+
+Then(/^the deploy\.rb file is created$/) do
+  file = TestApp.test_app_path.join('config/deploy.rb')
+  expect(File.exists?(file)).to be_true
+end
+
+Then(/^the default stage files are created$/) do
+  staging = TestApp.test_app_path.join('config/deploy/staging.rb')
+  production = TestApp.test_app_path.join('config/deploy/production.rb')
+  expect(File.exists?(staging)).to be_true
+  expect(File.exists?(production)).to be_true
+end
+
+Then(/^the tasks folder is created$/) do
+  path = TestApp.test_app_path.join('lib/capistrano/tasks')
+  expect(Dir.exists?(path)).to be_true
+end
+
+Then(/^the specified stage files are created$/) do
+  qa = TestApp.test_app_path.join('config/deploy/qa.rb')
+  production = TestApp.test_app_path.join('config/deploy/production.rb')
+  expect(File.exists?(qa)).to be_true
+  expect(File.exists?(production)).to be_true
+end
+
+Then(/^it creates the file with the remote_task prerequisite$/) do
+  TestApp.linked_files.each do |file|
+    run_vagrant_command(test_file_exists(TestApp.shared_path.join(file)))
+  end
+end
+
+Then(/^it will not recreate the file$/) do
+  #
+end

data/features/step_definitions/cap_commands.rb

@@ -0,0 +1,8 @@
+When(/^I run cap "(.*?)"$/) do |task|
+  TestApp.cap(task)
+end
+
+When(/^I run cap "(.*?)" as part of a release$/) do |task|
+  TestApp.cap("deploy:new_release_path #{task}")
+end
+

data/features/step_definitions/setup.rb

@@ -0,0 +1,25 @@
+Given(/^a test app with the default configuration$/) do
+  TestApp.install
+end
+
+Given(/^servers with the roles app and web$/) do
+  vagrant_cli_command('up')
+end
+
+Given(/^a required file$/) do
+end
+
+Given(/^that file exists$/) do
+  run_vagrant_command("touch #{TestApp.linked_file}")
+end
+
+Given(/^the file does not exist$/) do
+  pending
+  file = TestApp.linked_file
+  run_vagrant_command("[ -f #{file} ] && rm #{file}")
+end
+
+Given(/^a custom task to generate a file$/) do
+  TestApp.copy_task_to_test_app('spec/support/tasks/database.cap')
+end
+

data/features/support/env.rb

@@ -0,0 +1,12 @@
+require 'kuroko'
+
+project_root = File.expand_path('../../../', __FILE__)
+vagrant_root = File.join(project_root, 'spec/support')
+
+Kuroko.configure do |config|
+  config.vagrant_root = 'spec/support'
+end
+
+puts vagrant_root.inspect
+
+require_relative '../../spec/support/test_app'

data/features/support/remote_command_helpers.rb

@@ -0,0 +1,20 @@
+module RemoteCommandHelpers
+
+  def test_dir_exists(path)
+    exists?('d', path)
+  end
+
+  def test_symlink_exists(path)
+    exists?('L', path)
+  end
+
+  def test_file_exists(path)
+    exists?('f', path)
+  end
+
+  def exists?(type, path)
+    %{[ -#{type} "#{path}" ] && echo "#{path} exists." || echo "Error: #{path} does not exist."}
+  end
+end
+
+World(RemoteCommandHelpers)

data/lib/Capfile

@@ -1,2 +1,3 @@
 #!/usr/bin/env cap
+include Capistrano::DSL
 require 'capistrano/install'

data/lib/capistrano.rb

@@ -1,14 +0,0 @@
-require 'rake'
-require 'sshkit'
-
-Rake.application.options.trace = true
-
-require 'capistrano/version'
-require 'capistrano/version_validator'
-require 'capistrano/i18n'
-require 'capistrano/dsl'
-require 'capistrano/application'
-require 'capistrano/configuration'
-
-module Capistrano
-end

data/lib/capistrano/all.rb

@@ -0,0 +1,16 @@
+require 'rake'
+require 'sshkit'
+require 'sshkit/dsl'
+
+Rake.application.options.trace = true
+
+require 'capistrano/version'
+require 'capistrano/version_validator'
+require 'capistrano/i18n'
+require 'capistrano/dsl'
+require 'capistrano/application'
+require 'capistrano/configuration'
+
+module Capistrano
+
+end

data/lib/capistrano/application.rb

@@ -26,7 +26,7 @@ module Capistrano
       if tasks_without_stage_dependency.include?(@top_level_tasks.first)
         @top_level_tasks
       else
-        @top_level_tasks.unshift('deploy:ensure_stage')
+        @top_level_tasks.unshift(ensure_stage)
       end
     end
 
@@ -37,15 +37,6 @@ module Capistrano
       File.expand_path(File.join(File.dirname(__FILE__),'..','Capfile'))
     end
 
-    def tasks_without_stage_dependency
-      defined_stages = Dir['config/deploy/*.rb'].map { |f| File.basename(f, '.rb') }
-      defined_stages + default_tasks
-    end
-
-    def default_tasks
-      %w{install}
-    end
-
     def version
       ['--version', '-V',
        "Display the program version.",

data/lib/capistrano/configuration.rb

@@ -20,6 +20,10 @@ module Capistrano
       config[key] = value
     end
 
+    def delete(key)
+      config.delete(key)
+    end
+
     def fetch(key, default=nil, &block)
       value = fetch_for(key, default, &block)
       if value.respond_to?(:call)

data/lib/capistrano/configuration/server.rb

@@ -22,6 +22,11 @@ module Capistrano
         hostname == Server.new(host).hostname
       end
 
+      def select?(options)
+        selector = Selector.new(options)
+        selector.call(self)
+      end
+
       def primary
         self if fetch(:primary)
       end
@@ -41,6 +46,20 @@ module Capistrano
       alias_method :netssh_options_without_options, :netssh_options
       alias_method :netssh_options, :netssh_options_with_options
 
+      def roles_array
+        roles.to_a
+      end
+
+      private
+
+      def add_property(key, value)
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
+        else
+          set(key, value)
+        end
+      end
+
       class Properties
 
         def initialize
@@ -79,15 +98,34 @@ module Capistrano
 
       end
 
+      class Selector
+        def initialize(options)
+          @options = options
+        end
 
-      private
+        def callable
+          if key.respond_to?(:call)
+            key
+          else
+            ->(server) { server.fetch(key) }
+          end
+        end
 
-      def add_property(key, value)
-        if respond_to?("#{key}=")
-          send("#{key}=", value)
-        else
-          set(key, value)
+        def call(server)
+          callable.call(server)
         end
+
+        private
+        attr_reader :options
+
+        def key
+          options[:filter] || options[:select] || all
+        end
+
+        def all
+          ->(server) { :all }
+        end
+
       end
 
     end