borg-rb 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjdkOGNhMjJlZGQwOTc2NTVhZjMzYTkwODdlMDVjZWM1M2ExYjRlZA==
+    OWZmNWNmZDM1M2Y1YzdlNGIwNzQ4ZmJlNGI0NTVlMTMyODAyMTNiYw==
   data.tar.gz: !binary |-
-    OWEzNzg2OGIxNDE2YjdlNTM5NjE3Zjc5ZmFiMjZmNGFhZDlmOGZlOQ==
+    OTU4ZDg4MTQ3NjlkYjkyZTFhMWJmNTdhOTI2MWYyNWRmZDRmMzZlNA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Nzg3Y2QyMzhjYWZjZDQ1Zjc2ZWYyYzg1OGUxZmE2YmIwYzRiY2I5NWE4ZjJl
-    YjVkNTdkZTBiMWRkNDc2YmIxZTMzZTJlNTdjOTY4M2U2MWNhNzU1ZjQ5Yzgz
-    MTA4YmZmNDUwNTdjZWJjNjllYzMzMzUxMzVhMDk3MDQ4MDVjNGQ=
+    MTJjNmY1MjVhMTEzY2RlNWE5ZmI0ZTVlYWQ1OGE1OWFkMWM0ZjU5ZDZkOTRj
+    ZmFhNzY5ODE4MjBhNTQ3MTkwOWMzNjk0OGY1YjM4MDE5NWIzYjJmNTY1ZWEz
+    ZDRmMjkyM2IwZDcyZGYzYzA5MWYzNDEyZmU3MGE0NzhiNDcxNjQ=
   data.tar.gz: !binary |-
-    NmRlNWFlMGI5MGUwYjQ5MTJhM2I1YjQ3MGU3MDdlMDVmMDU5ZjAxODM5NjBk
-    NzRhNWViNzQ5NWRlNWIyNmMxYmU5NTA4NDE4MzExOWRlODhmNGJjMDYyODUy
-    ZjMxMDVkZjFjMjZjMjRlODQ5NzNlYTYzZDdjN2I1ZmE2NjU3NmI=
+    NjA5ZDBhMGU2ZmI0ODkwNTI0ZjI0OGU4YzlmNmQyMDc3ZjFhMTUxODBlMGUy
+    MmFmOTc5ZjE1ZjljZjA0MTIwOWIwOGE2ZTJiMTY4ZTVlYzg4YWM0ZDYwYTc5
+    Mzk2OWQ1ZmU2YWIzYWEzZWNmMjZlN2I0YzY0NTgyZjA4NDhjNzI=

data/CHANGELOG.md

@@ -1,9 +1,10 @@
-## Current (Unreleased)
+## HEAD
 
-## 0.0.3 / 3-22-2013
+## 0.0.4 / 3-22-2013
 
 * Fix load problem in Capfile in generated skeleton (0.0.2)
-* Change load borg-rb to a require
+* Change load borg-rb to a require (0.0.3)
+* Allow access to `application` and `stage` in an application configuration by creating a capistrano variable for them
 
 
 ## 0.0.1 / 3-21-2013

data/README.md

@@ -67,11 +67,11 @@ Borg provides a application and stage config setup.
 One can define applications with the format.
 ``` ruby
 application :app_name do
-  do things needed to setup the application environment.
+  # do things needed to setup the application environment.
 end
 
 stage :app_name, :stage_name do
-  do things for specific stage for the applications.
+  # do things for specific stage for the applications.
 end
 ```
 
@@ -90,3 +90,5 @@ to be load and the deploy task be run against all of them.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Ruby Style Guidelines: We like this one https://github.com/styleguide/ruby

data/bin/borg

@@ -13,6 +13,6 @@ require 'borg/server/base'
 require 'borg/servers/base'
 
 # Ensure ruby 1.9.X
-raise "Ruby 1.9.X required" unless RUBY_VERSION =~ /^1\.9\.\d$/
+raise "Ruby 1.9.X required" unless RUBY_VERSION =~ /^1\.9\.\d$/ || RUBY_VERSION =~ /^2\.0\.\d$/
 
 Capistrano::CLI.execute

data/lib/borg/cli/applications.rb

@@ -6,12 +6,10 @@ module Borg
         base.send :alias_method, :execute_requested_actions, :execute_requested_actions_with_applications
       end
 
+      # TODO: documentation for `options`, where does it come from?
       def execute_requested_actions_with_applications(config)
-
-        load_applications config
-
-        separate_actions_and_applications config
-
+        load_applications(config)
+        separate_actions_and_applications(config)
         if options[:applications].empty? or Thread.current[:borg_application]
           Thread.current[:borg_application].load_into config if Thread.current[:borg_application]
           execute_requested_actions_without_applications(config)
@@ -26,17 +24,14 @@ module Borg
 
       private
 
-      def load_applications config
-        # load applications
+      def load_applications(config)
         unless @apps_loaded
-          Dir["./cap/applications/**/*.rb"].each do |file|
-            config.load file
-          end
+          Dir["./cap/applications/**/*.rb"].each { |file| config.load(file) }
           @apps_loaded = true
         end
       end
 
-      def separate_actions_and_applications config
+      def separate_actions_and_applications(config)
         options[:applications] = []
         found_non_application = false
         options[:actions] = Array(options[:actions]).keep_if do |action|
@@ -63,4 +58,4 @@ module Borg
   end
 end
 
-Capistrano::CLI.send :include, Borg::CLI::Applications
+Capistrano::CLI.send(:include, Borg::CLI::Applications)

data/lib/borg/configuration/applications.rb

@@ -39,6 +39,14 @@ module Borg
         end
 
         def load_into config
+          if config.respond_to?(:application)
+            # Undefine the stage method now that the app:stage config is created
+            config_metaclass = class << config; self; end
+            config_metaclass.send(:undef_method, 'application')
+
+            # Create a capistrano variable for stage
+            config.instance_exec(@name, &(lambda { |name| set :application, name }))
+          end
           @execution_blocks.each {|blk| config.load &blk}
         end
       end

data/lib/borg/configuration/stages.rb

@@ -1,8 +1,7 @@
 module Borg
   module Configuration
     module Stages
-
-      def stage (app, name, &block)
+      def stage(app, name, &block)
         app = app.to_sym
         name = name.to_sym
         application app unless @applications[app]
@@ -20,23 +19,34 @@ module Borg
       class Stage
         attr_accessor :execution_blocks
         attr_accessor :parent
+
+        # TODO: We might want to name this differently
         def name
           "#{parent.name}:#{@name}"
         end
 
-        def initialize name, parent
+        def initialize(name, parent)
           @execution_blocks = []
           @name = name
           @parent = parent
         end
 
-        def load_into config
-          parent.load_into config
-          @execution_blocks.each {|blk| config.load &blk}
+        def load_into(config)
+          if config.respond_to?(:stage)
+            # Undefine the stage method now that the app:stage config is created
+            config_metaclass = class << config; self; end
+            config_metaclass.send(:undef_method, 'stage')
+
+            # Create a capistrano variable for stage
+            config.instance_exec(@name, &(lambda { |name| set :stage, name }))
+          end
+
+          parent.load_into(config)
+          @execution_blocks.each { |blk| config.load(&blk) }
         end
       end
     end
   end
 end
 
-Capistrano::Configuration.send :include, Borg::Configuration::Stages
+Capistrano::Configuration.send(:include, Borg::Configuration::Stages)

data/lib/borg/version.rb

@@ -1,3 +1,3 @@
 module Borg
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/acceptance/application_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe 'borg app:stage task' do
+  include_context 'acceptance'
+
+  # TODO: probably want to have some factory that generates what we want in an app config to DRY this out
+  let(:basic_app_config) {
+    <<-RUBY
+application :app do
+  task :some_task do
+  end
+end
+    RUBY
+  }
+
+  let(:app_config_with_stages) {
+    <<-RUBY
+application :app do
+  task :common_task do
+  end
+end
+stage :app, :prd do
+  task :prd_task do
+  end
+end
+stage :app, :stg do
+  task :stg_task do
+  end
+end
+    RUBY
+  }
+
+  let(:app_config_with_display_app_task) {
+    <<-RUBY
+application :app do
+  task :display_app do
+    puts "The application is set to: \#{application}"
+  end
+end
+    RUBY
+  }
+
+  let(:app_config_with_stage_with_display_app_task) {
+    <<-RUBY
+stage :app, :prd do
+  task :display_app do
+    puts "The application is set to: \#{application}"
+  end
+end
+    RUBY
+  }
+
+  before do
+    assert_execute('borgify')
+  end
+
+  context "app with no stages" do
+    before do
+      environment.create_file('cap/applications/app.rb', basic_app_config)
+    end
+
+    it "allows us to run tasks for that app" do
+      # a task defined for the app
+      assert_execute('borg', 'app', 'some_task')
+
+      # an undefined task
+      expect(execute('borg', 'app', 'undefined_task')).to_not succeed
+
+      # an undefined app
+      expect(execute('borg', 'undefined_app', 'some_task')).to_not succeed
+    end
+  end
+
+  context "app with stages: prd, stg" do
+    before do
+      environment.create_file('cap/applications/app.rb', app_config_with_stages)
+    end
+
+    it "allows us to set common/stage-specific tasks" do
+      # commonly defined tasks
+      assert_execute('borg', 'app:prd', 'common_task')
+      assert_execute('borg', 'app:stg', 'common_task')
+
+      # stage specific tasks in their respective stages
+      assert_execute('borg', 'app:prd', 'prd_task')
+      assert_execute('borg', 'app:stg', 'stg_task')
+
+      # stage specific tasks in other stages
+      expect(execute('borg', 'app:stg', 'prd_task')).to_not succeed
+      expect(execute('borg', 'app:prd', 'stg_task')).to_not succeed
+    end
+  end
+
+  context 'app with a task `display_app` which prints `application`' do
+    before do
+      environment.create_file('cap/applications/app.rb', app_config_with_display_app_task)
+    end
+
+    it 'the task prints `app`' do
+      result = execute('borg', 'app', 'display_app')
+      expect(result.stdout).to match(/The application is set to: app/)
+    end
+  end
+
+  context 'app with stages: prd, and a task `display_app` which prints `application`' do
+    before do
+      environment.create_file('cap/applications/app.rb', app_config_with_stage_with_display_app_task)
+    end
+
+    it 'the task prints `app`' do
+      result = execute('borg', 'app:prd', 'display_app')
+      expect(result.stdout).to match(/The application is set to: app/)
+    end
+  end
+
+end

data/spec/acceptance/stage_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'borg app:stage task' do
+  include_context 'acceptance'
+
+  let(:stage_test_config) {
+    <<-RUBY
+stage :app, :prd do
+  task :display_stage do
+    puts "The stage is set to: \#{stage}"
+  end
+end
+    RUBY
+  }
+
+  before do
+    assert_execute('borgify')
+  end
+
+  context 'app with stages: prd, and a task `display_stage` which prints `stage`' do
+    before do
+      environment.create_file('cap/applications/app.rb', stage_test_config)
+    end
+
+    it 'the task prints `prd`' do
+      result = execute('borg', 'app:prd', 'display_stage')
+      expect(result.stdout).to match(/The stage is set to: prd/)
+    end
+  end
+
+end

data/spec/support/isolated_environment.rb

@@ -3,8 +3,7 @@ require "pathname"
 require "childprocess"
 
 module Support
-  # This class creates a temporary directory to act as the working directory
-  #
+  # This class creates a temporary directory to act as the working directory for our tests
   # Modified from: https://github.com/mitchellh/vagrant/blob/master/spec/support/isolated_environment.rb
   class IsolatedEnvironment
     ROOT_DIR = Pathname.new(File.expand_path("../../", __FILE__))
@@ -12,24 +11,12 @@ module Support
     attr_reader :workdir, :workdir_path
 
     def initialize
-      # Create a temporary directory for our work
       @workdir = TempDir.new("borg")
-      @workdir_path = Pathname.new(TempDir.new("borg").path)
-      # puts "Initialize isolated environment: #{@workdir_path.to_s}"
-    end
-
-    # Copies a skeleton into this isolated environment. This is useful
-    # for testing environments that require a complex setup.
-    #
-    # @param [String] name Name of the skeleton in the root directory.
-    def skeleton!(name)
-      # Copy all the files into the home directory
-      source = Dir.glob(ROOT_DIR.join(name).join("*").to_s)
-      FileUtils.cp_r(source, @workdir.to_s)
+      @workdir_path = Pathname.new(@workdir.path)
     end
 
     # Executes a command in the context of this isolated environment.
-    # Any command executed will therefore see our temporary directory
+    # Any command executed will therefore see our working directory
     # as the home directory.
     def execute(command, *argN)
       # Determine the options
@@ -42,17 +29,47 @@ module Support
       # Add the options to be passed on
       argN << options
 
-      # Execute, logging out the stdout/stderr as we get it
-      # puts("Executing: #{[command].concat(argN).inspect}")
+      # Execute
       Support::Subprocess.execute(command, *argN) do |type, data|
         yield type, data if block_given?
       end
     end
 
-    # Closes the environment and cleans it up
+    # Remove everything created in the environment
     def close
-      # puts "Removing isolated environment: #{@workdir.path}"
-      FileUtils.rm_rf(@workdir.path)
+      FileUtils.rm_rf(@workdir_path)
+    end
+
+    # Creates a new file in the isolated environment
+    #
+    # @param [String] filename Name of destination file's path relative to the isolated environment's root
+    # @param [String] content The stuff
+    def create_file(filename, content)
+      Dir.chdir(@workdir_path) do
+        FileUtils.mkdir_p(File.dirname(filename)) unless File.directory?(File.dirname(filename))
+        File.open(filename, "w") { |file| file.write(content) }
+      end
+    end
+
+    # Copies a directory into this isolated environment.
+    #
+    # @param [String] src_dir Name of the source directory's path relative to the root directory.
+    # @param [String] dest_dir Name of path relative to the isolated environment's root
+    def copy_dir(src_dir, dest_dir = "/")
+      # Copy all the files into the home directory
+      source = Dir.glob(ROOT_DIR.join(name).join("*").to_s)
+      FileUtils.cp_r(source, @workdir_path.to_s)
+    end
+
+    # Copies a file into this isolated environment.
+    #
+    # @param [String] src_file Name of the source file's path relative to the root directory.
+    # @param [String] dest_file Name of destination file's path relative to the isolated environment's root
+    def copy_file(src_file, dest_file)
+      Dir.chdir(@workdir_path) do
+        FileUtils.mkdir_p(File.dirname(dest_file)) unless File.directory?(File.dirname(dest_file))
+        FileUtils.cp(ROOT_DIR.join(src_file), dest_file)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: borg-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Identified
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -135,8 +135,10 @@ files:
 - skeleton/cap/recipes/.gitkeep
 - skeleton/lib/.gitkeep
 - skeleton/mygem.gemspec.skeleton
+- spec/acceptance/application_spec.rb
 - spec/acceptance/borgify_plugin_spec.rb
 - spec/acceptance/borgify_spec.rb
+- spec/acceptance/stage_spec.rb
 - spec/lib/borg/cli/applications_spec.rb
 - spec/lib/borg/configuration/applications_spec.rb
 - spec/lib/borg/configuration/assimilator_spec.rb
@@ -173,8 +175,10 @@ signing_key:
 specification_version: 4
 summary: Ruby-based software provisioning and deployment framework
 test_files:
+- spec/acceptance/application_spec.rb
 - spec/acceptance/borgify_plugin_spec.rb
 - spec/acceptance/borgify_spec.rb
+- spec/acceptance/stage_spec.rb
 - spec/lib/borg/cli/applications_spec.rb
 - spec/lib/borg/configuration/applications_spec.rb
 - spec/lib/borg/configuration/assimilator_spec.rb