heroploy 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de74cf40268ad2d31c7e06ef60d7f8312ee936a6
-  data.tar.gz: e2257f2a4f5d83970c43942db5e4b16d95c963d7
+  metadata.gz: 105eedfe09a02a9d37fa4f51a66a85be998488ab
+  data.tar.gz: eb15f7c1627dc9cfdef4f6531aaf675f145b7bbe
 SHA512:
-  metadata.gz: 87a969dad8ff6d44f9370fcb78fb15151ba6abcd2a6401938244c2fb323ec0f05fec7ab6717b5e2825d6b427ea48b23242918f38936955e8032f09e9cf4ef0e5
-  data.tar.gz: 1c9678265b500863c37074c97ed9b4fe897915554d236ed8f509387ad1c3e27e2ad67e624a1e5041287533a7dccecedb044f351e43397e0b18676e6b1eae0ea5
+  metadata.gz: a3357bd2d6a57371ed2b33609baf2b867debdd1fa3798df6dbd89628f028cb5c8110333e08f4868cb06c464dd034af4d37f03f3f498598a2490944b41849554c
+  data.tar.gz: 5f8b1062cab707cd0c540810f07c6df7919d6a51ab3eed7fed078ed0627bbde45d6edd19b9dce2372763c9ee520ca4e468763b8d6431b8190a178cf560bcc40f

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store
+

data/README.md

@@ -23,6 +23,9 @@ Or install it yourself as:
 
 ## Usage
 
+**See [Configuring Heroploy](https://github.com/jbrunton/heroploy/wiki/Configuring-Heroploy) for a more detailed description of the options available.**
+
+
 Add a ```heroploy.yml``` file to your application's config directory which describes the Heroku apps you will deploy to, and the checks you would like when deploying to each.
 
 If you're running Rails, you can use this generator to add an example config file:

data/lib/generators/heroploy/install/templates/config/heroploy.yml

@@ -1,3 +1,30 @@
+# This file shows you how to configure your Heroploy environments.  For more
+# details see https://github.com/jbrunton/heroploy/wiki/Configuring-Heroploy
+
+load_configs:
+  
+# If you wish to define parts of your config file (e.g. secret keys) in a
+# private repository, you can load these files here:
+#
+# my_private_config:
+#   repo: git.example.com:my-private-repo
+#   file: config/heroploy.yml
+
+common:
+  required:
+
+# List any configuration variables which should be defined for each environment
+# here.  For example, if you require each to have a facebook_app_key:
+#
+#   - facebook_app_key
+
+  variables:
+
+# If you wish to define any variables which should be common to all
+# environments, add them here:
+#
+#   facebook_app_key: a1b2c3
+  
 environments:
 
 # Add a development environment, to which you can deploy anything:
@@ -25,6 +52,15 @@ environments:
 #     branch: master
 #     staged: true
 
+# If you want to set any config vars on your Heroku apps, you can define them
+# on a per-environment basis:
+
+# development:
+#   app: my-development-app
+#   variables:
+#     facebook_app_key: a1b2c3
+
+
 # Finally, if you have a single Heroku app, this should work for now:
 
   heroku:

data/lib/heroploy/commands/checks.rb

@@ -28,6 +28,15 @@ module Heroploy
           raise "Changes not yet staged on #{env_name}"
         end
       end
+      
+      def check_config(shared_env, env_config)
+        merged_keys = shared_env.variables.keys.concat(env_config.variables.keys)
+        shared_env.required.each do |key|
+          unless merged_keys.include?(key)
+            raise "Missing config value for '#{key}'"
+          end
+        end
+      end
     end
   end
 end

data/lib/heroploy/commands/git.rb

@@ -43,6 +43,17 @@ module Heroploy
       def git_push_tag(tag)
         Shell.exec("git push origin #{tag}")
       end
+      
+      def git_clone(repository, destination)
+        Dir.mktmpdir do |dir|
+          Dir.chdir(dir) do
+            Shell.exec("git clone #{repository} #{destination}")
+            if block_given?
+              yield
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/heroploy/commands/heroku.rb

@@ -4,7 +4,9 @@ module Heroploy
   module Commands
     module Heroku
       def heroku_exec(cmd, app_name)
-        Shell.exec "heroku #{cmd} --app #{app_name}"
+        Bundler.with_clean_env do
+          Shell.exec "heroku #{cmd} --app #{app_name}"
+        end
       end
   
       def heroku_run(cmd, app_name)
@@ -12,9 +14,13 @@ module Heroploy
       end
   
       def heroku_migrate(app_name)
-        Bundler.with_clean_env do
-          heroku_run("rake db:migrate", app_name)
-        end
+        heroku_run("rake db:migrate", app_name)
+      end
+      
+      def heroku_config_set(shared_vars, env_vars, app_name)
+        merged_vars = shared_vars.merge(env_vars)
+        vars_string = merged_vars.collect.map{|key,value| "#{key}=#{value}"}.join(" ")
+        heroku_exec("config:set #{vars_string}", app_name)
       end
     end
   end

data/lib/heroploy/config/deployment_config.rb

@@ -1,10 +1,14 @@
 require 'heroploy/config/deployment_config'
 require 'heroploy/config/environment'
+require 'heroploy/config/shared_env'
+require 'heroploy/config/remote_config'
 
 module Heroploy
   module Config
     class DeploymentConfig
       attr_accessor :environments
+      attr_accessor :shared_env
+      attr_accessor :remote_configs
 
       def [](env_name)
         environments.select{ |env| env.name == env_name }.first
@@ -12,12 +16,22 @@ module Heroploy
 
       def initialize(attrs = {})
         unless attrs['environments'].nil?
-          @environments = attrs['environments'].map { |name, attrs| Environment.new(name, attrs) }
+          @environments = attrs['environments'].map { |name, env_attrs| Environment.new(name, env_attrs) }
         end
+        unless attrs['load_configs'].nil?
+          @remote_configs = attrs['load_configs'].map { |name, remote_config_attrs| RemoteConfig.new(name, remote_config_attrs) }
+        end
+        @shared_env = SharedEnv.new(attrs['common'])
       end
   
-      def self.load
-        DeploymentConfig.new(YAML::load(File.open('config/heroploy.yml')))
+      def self.load(filename = 'config/heroploy.yml')
+        DeploymentConfig.new(YAML::load(File.open(filename)))
+      end
+      
+      def merge_config(deployment_config)
+        deployment_config.environments.each do |env_config|
+          self[env_config.name].variables.merge!(env_config.variables)
+        end
       end
     end
   end

data/lib/heroploy/config/environment.rb

@@ -8,12 +8,14 @@ module Heroploy
       attr_accessor :app
       attr_accessor :tag
       attr_accessor :checks
+      attr_accessor :variables
       
       def initialize(name = nil, attrs = {})
         @name = name
         @remote = attrs['remote'] || name
         @app = attrs['app']
         @tag = attrs['tag']
+        @variables = attrs['variables'] || {}
         @checks = EnvironmentChecks.new(attrs['checks'])
       end
     end

data/lib/heroploy/config/remote_config.rb

@@ -0,0 +1,15 @@
+module Heroploy
+  module Config  
+    class RemoteConfig
+      attr_accessor :name
+      attr_accessor :repository
+      attr_accessor :files
+      
+      def initialize(name, attrs = {})
+        @name = name
+        @repository = attrs['repository']
+        @files = attrs['file'] ? [attrs['file']] : attrs['files']
+      end
+    end
+  end
+end

data/lib/heroploy/config/shared_env.rb

@@ -0,0 +1,14 @@
+module Heroploy
+  module Config  
+    class SharedEnv
+      attr_accessor :required
+      attr_accessor :variables
+      
+      def initialize(attrs)
+        attrs ||= {}
+        @required = attrs['required'] || []
+        @variables = attrs['variables'] || {}
+      end
+    end
+  end
+end

data/lib/heroploy/tasks/check_task_lib.rb

@@ -29,6 +29,7 @@ module Heroploy
         define_pushed_check
         define_branch_check
         define_staged_check
+        define_config_check
         define_all_check
       end
     
@@ -73,6 +74,14 @@ module Heroploy
           @defined_tasks << :staged
         end
       end
+      
+      def define_config_check
+        desc "check all required config variables are defined"
+        task :config => :load_remote_configs do
+          check_config(deploy_config.shared_env, env_config)
+        end
+        @defined_tasks << :config
+      end
     
       def define_all_check
         desc "do all the checks for #{env_config.name}"

data/lib/heroploy/tasks/deploy_task_lib.rb

@@ -2,6 +2,7 @@ require 'rake/tasklib'
 
 require 'heroploy/commands/git'
 require 'heroploy/tasks/env_task_lib'
+require 'heroploy/config/deployment_config'
 
 module Heroploy
   module Tasks
@@ -18,6 +19,7 @@ module Heroploy
 
       def define
         define_fetch_task
+        define_load_configs_task
         define_env_tasks
       end
     
@@ -27,6 +29,22 @@ module Heroploy
           git_fetch
         end
       end
+      
+      def define_load_configs_task
+        desc 'load remote configs'
+        task :load_remote_configs do
+          unless deployment_config.remote_configs.nil?
+            deployment_config.remote_configs.each do |remote_config|
+              git_clone(remote_config.repository, remote_config.name) do
+                remote_config.files.each do |filename|
+                  config_file = File.join(Dir.pwd, remote_config.name, filename)
+                  deployment_config.merge_config(Heroploy::Config::DeploymentConfig.load(config_file))
+                end
+              end
+            end
+          end
+        end
+      end
     
       def define_env_tasks
         deployment_config.environments.each do |env|

data/lib/heroploy/tasks/env_task_lib.rb

@@ -59,9 +59,14 @@ module Heroploy
         task :migrate do
           heroku_migrate(env.app)
         end
+        
+        desc "set config variables"
+        task :config => :load_remote_configs do
+          heroku_config_set(deployment_config.shared_env.variables, env.variables, env.app)
+        end
 
         desc "deploy to #{env.name}"
-        task :deploy => ['check:all', :push, :migrate, :tag]
+        task :deploy => ['check:all', :push, :config, :migrate, :tag]
       end
     end
   end

data/lib/heroploy/tasks/env_var_task_lib.rb

@@ -0,0 +1,79 @@
+# require 'rake/tasklib'
+# 
+# require 'heroploy/commands/heroku'
+# require 'heroploy/commands/git'
+# require 'heroploy/commands/checks'
+# 
+# module Heroploy
+#   module Tasks
+#     class EnvVarTaskLib < ::Rake::TaskLib
+#       include ::Rake::DSL if defined?(::Rake::DSL)
+#     
+#       include Commands::Git
+#       include Commands::Heroku
+#       include Commands::Checks
+#     
+#       def initialize(deploy_config)
+#         @deploy_config = deploy_config
+#         @env_config = env_config
+#         @defined_tasks = []
+#         define      
+#       end
+#     
+#       def define
+#         define_remote_check
+#         define_pushed_check
+#         define_branch_check
+#         define_staged_check
+#         define_all_check
+#       end
+#     
+#       def define_remote_check
+#         desc "check remote exists for #{env_config.name}"
+#         task :remote do
+#           remote = env_config.remote
+#           check_remote(remote)
+#         end
+#       
+#         @defined_tasks << :remote
+#       end
+#     
+#       def define_pushed_check
+#         if env_config.checks.pushed then
+#           desc "check changes have been pushed to origin"
+#           task :pushed do
+#             check_pushed(current_branch)
+#           end
+#           @defined_tasks << :pushed
+#         end
+#       end
+#     
+#       def define_branch_check
+#         if env_config.checks.branch then
+#           desc "check we can deploy to #{env_config.name} from the current branch"
+#           task :branch do
+#             valid_branch = env_config.checks.branch
+#             check_branch(current_branch, valid_branch, env_config.name)
+#           end
+#           @defined_tasks << :branch
+#         end
+#       end
+#     
+#       def define_staged_check
+#         if env_config.checks.staged then
+#           desc "check the changes have already been staged"
+#           task :staged do
+#             staging_env_config = deploy_config[env_config.checks.staged]
+#             check_staged(staging_env_config.remote, current_branch, staging_env_config.name)
+#           end
+#           @defined_tasks << :staged
+#         end
+#       end
+#     
+#       def define_all_check
+#         desc "do all the checks for #{env_config.name}"
+#         task :all => @defined_tasks
+#       end
+#     end
+#   end
+# end

data/lib/heroploy/version.rb

@@ -1,3 +1,3 @@
 module Heroploy
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/lib/heroploy/commands/checks_spec.rb

@@ -95,4 +95,45 @@ describe Heroploy::Commands::Checks do
       end
     end
   end
+  
+  describe "#check_config" do
+    context "given a required variable" do
+      let(:required) { ['my-var'] }
+      
+      context "if the shared environment defines the variable" do
+        let(:shared_attrs) { {'required' => required, 'variables' => {'my-var' => 'some-value'}} }
+        let(:env_vars) { {} }
+        let(:shared_env) { Heroploy::Config::SharedEnv.new(shared_attrs) }
+        let(:env) { Heroploy::Config::Environment.new('my-env', {'variables' => env_vars}) }
+      
+        it "it executes successfully if the variables " do
+          commands.check_config(shared_env, env)
+        end
+      end
+      
+      context "if the Heroku environment defines the variable" do
+        let(:shared_attrs) { {'required' => required, 'variables' => {}} }
+        let(:env_vars) { {'my-var' => 'some-value'} }
+        let(:shared_env) { Heroploy::Config::SharedEnv.new(shared_attrs) }
+        let(:env) { Heroploy::Config::Environment.new('my-env', {'variables' => env_vars}) }
+      
+        it "it executes successfully if the variables " do
+          commands.check_config(shared_env, env)
+        end
+      end
+      
+      context "if a required variable is missing a value" do
+        let(:shared_attrs) { {'required' => required, 'variables' => {}} }
+        let(:env_vars) { {} }
+        let(:shared_env) { Heroploy::Config::SharedEnv.new(shared_attrs) }
+        let(:env) { Heroploy::Config::Environment.new('my-env', {'variables' => env_vars}) }
+
+        it "raises an error" do
+          expect{
+            commands.check_config(shared_env, env)
+          }.to raise_error("Missing config value for 'my-var'")
+        end
+      end
+    end    
+  end
 end

data/spec/lib/heroploy/commands/git_spec.rb

@@ -122,4 +122,11 @@ describe Heroploy::Commands::Git do
       commands.git_push_tag("my-tag")
     end
   end
+  
+  context "#git_clone" do
+    it "clones the given repository" do
+      expect_command("git clone git.example.com:my-repo destination-path")
+      commands.git_clone("git.example.com:my-repo", "destination-path")
+    end
+  end
 end

data/spec/lib/heroploy/commands/heroku_spec.rb

@@ -27,4 +27,13 @@ describe Heroploy::Commands::Heroku do
       commands.heroku_migrate("my-app")
     end    
   end
+  
+  context "#heroku_config_set" do
+    it "sets the values for the given config variables" do
+      common_vars = {'foo' => 'foo'}
+      env_vars = {'bar' => 'bar'}
+      expect_command("heroku config:set foo=foo bar=bar --app my-app")
+      commands.heroku_config_set(common_vars, env_vars, "my-app")
+    end
+  end
 end

data/spec/lib/heroploy/config/deployment_config_spec.rb

@@ -3,18 +3,36 @@ require 'spec_helper'
 describe Heroploy::Config::DeploymentConfig do
   before(:each) { stub_shell }
   
-  let(:attrs) { {'environments' => {'staging' => {}, 'production' => {}}} }
+  let(:attrs) do
+    {
+      'environments' => {
+        'staging' => {},
+        'production' => {
+          'variables' => {'foo' => 'foo'}
+        }
+      },
+      'common' => {
+        'required' => ['my-var'],
+        'variables' => {'my-var' => 'some-value'}
+      }
+    }
+  end
   
   subject(:deployment_config) { Heroploy::Config::DeploymentConfig.new(attrs) }
   
-  context "#initialize" do
+  describe "#initialize" do
     context "it initializes its environments" do
       its(:environments) { should include an_environment_named(:staging) }
       its(:environments) { should include an_environment_named(:production) }
     end
+    
+    context "it initializes its environment variables" do
+      its('shared_env.required') { should eq(['my-var']) }
+      its('shared_env.variables') { should eq({'my-var' => 'some-value'}) }
+    end
   end
   
-  context "#[]" do
+  describe "#[]" do
     it "returns the environment with the given name, if one exists" do
       expect(deployment_config['staging']).to be_an_environment_named(:staging)
     end
@@ -24,19 +42,45 @@ describe Heroploy::Config::DeploymentConfig do
     end
   end
   
-  context ".load" do
+  describe "#merge_config" do
+    let(:other_config) do
+      build(:deployment_config, environments: [
+        build(:environment, :production, variables: {'bar' => 'bar'})
+      ])
+    end
+    
+    it "merges the environment variables defined by the other config" do
+      deployment_config.merge_config(other_config)
+      expect(deployment_config['production'].variables).to include('foo' => 'foo')
+      expect(deployment_config['production'].variables).to include('bar' => 'bar')
+    end
+  end
+  
+  describe ".load" do
     let(:yaml_config) do
       <<-END
+      common:
+        required:
+          - my-var
+        variables:
+          my-var: some-value
       environments:
         heroku:
           app: my-app
       END
     end
     
-    it "returns a new instance of DeploymentConfig initialized by the heroploy config file" do
-      File.stub(:open).with('config/heroploy.yml').and_return(yaml_config)
-      deployment_config = Heroploy::Config::DeploymentConfig.load
+    before { File.stub(:open).with('config/heroploy.yml').and_return(yaml_config) }
+    
+    let(:deployment_config) { deployment_config = Heroploy::Config::DeploymentConfig.load }
+    
+    it "it initializes the list of environments" do
       expect(deployment_config.environments).to include an_environment_named(:heroku)
     end
+    
+    it "initializes the shared environment variables" do
+      expect(deployment_config.shared_env.required).to eq(['my-var'])
+      expect(deployment_config.shared_env.variables).to eq({ 'my-var' => 'some-value' })
+    end
   end
 end

data/spec/lib/heroploy/config/environment_checks_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper'
 
 describe Heroploy::Config::EnvironmentChecks do
-  attr_accessor :pushed
-  attr_accessor :branch
-  attr_accessor :staged
-  
   describe "#initialize" do
     context "it initializes the accessors" do
       let(:pushed) { true }

data/spec/lib/heroploy/config/environment_spec.rb

@@ -8,7 +8,8 @@ describe Heroploy::Config::Environment do
       let(:remote_name) { 'my-remote' }
       let(:app_name) { 'my-app' }
       let(:tag) { 'my-tag' }
-      let(:attrs) { {'remote' => remote_name, 'app' => app_name, 'tag' => tag} }
+      let(:variables) { {'my-var' => 'some-value'} }
+      let(:attrs) { {'remote' => remote_name, 'app' => app_name, 'tag' => tag, 'variables' => variables} }
       
       subject(:environment) { Heroploy::Config::Environment.new(env_name, attrs) }
 
@@ -16,6 +17,7 @@ describe Heroploy::Config::Environment do
       its(:remote) { should eq(remote_name) }
       its(:app) { should eq(app_name) }
       its(:tag) { should eq(tag) }
+      its(:variables) { should eq(variables) }
       its(:checks) { should be_instance_of(Heroploy::Config::EnvironmentChecks) }      
     end
     

data/spec/lib/heroploy/config/remote_config_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Heroploy::Config::RemoteConfig do
+  describe "#initialize" do
+    context "it initializes the accessors" do
+      let(:attrs) { {'repository' => 'my-repo.git'} }
+      subject(:remote_config) { Heroploy::Config::RemoteConfig.new('my-config', attrs) }
+
+      its(:name) { should eq('my-config') }
+      its(:repository) { should eq('my-repo.git') }      
+    end    
+    
+    context "if a single file is defined" do
+      let(:attrs) { {'file' => 'config.yml'} }  
+      subject(:remote_config) { Heroploy::Config::RemoteConfig.new('my-config', attrs) }
+
+      it "defines the :files accessor correctly" do
+        expect(remote_config.files).to eq(['config.yml'])
+      end
+    end
+    
+    context "if multiple files are defined" do
+      let(:attrs) { {'files' => ['config1.yml', 'config2.yml']} }  
+      subject(:remote_config) { Heroploy::Config::RemoteConfig.new('my-config', attrs) }
+
+      it "defines the :files accessor correctly" do
+        expect(remote_config.files).to include('config1.yml')
+        expect(remote_config.files).to include('config2.yml')
+      end
+    end   
+  end
+end

data/spec/lib/heroploy/config/shared_env_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Heroploy::Config::SharedEnv do
+  describe "#initialize" do
+    context "it initializes the accessors" do
+      let(:variables) { {'my-var' => 'some-value'} }
+      let(:required) { ['my-var'] }
+      let(:attrs) { {'required' => required, 'variables' => variables} }
+      
+      subject(:shared_env) { Heroploy::Config::SharedEnv.new(attrs) }
+
+      its(:required) { should eq(required) }
+      its(:variables) { should eq(variables) }
+    end    
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroploy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - John Brunton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-08 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,10 +135,13 @@ files:
 - lib/heroploy/config/deployment_config.rb
 - lib/heroploy/config/environment.rb
 - lib/heroploy/config/environment_checks.rb
+- lib/heroploy/config/remote_config.rb
+- lib/heroploy/config/shared_env.rb
 - lib/heroploy/engine.rb
 - lib/heroploy/tasks/check_task_lib.rb
 - lib/heroploy/tasks/deploy_task_lib.rb
 - lib/heroploy/tasks/env_task_lib.rb
+- lib/heroploy/tasks/env_var_task_lib.rb
 - lib/heroploy/tasks/tasks.rake
 - lib/heroploy/version.rb
 - spec/factories.rb
@@ -150,6 +153,8 @@ files:
 - spec/lib/heroploy/config/deployment_config_spec.rb
 - spec/lib/heroploy/config/environment_checks_spec.rb
 - spec/lib/heroploy/config/environment_spec.rb
+- spec/lib/heroploy/config/remote_config_spec.rb
+- spec/lib/heroploy/config/shared_env_spec.rb
 - spec/lib/heroploy/tasks/check_all_spec.rb
 - spec/lib/heroploy/tasks/check_branch_spec.rb
 - spec/lib/heroploy/tasks/check_pushed_spec.rb
@@ -195,6 +200,8 @@ test_files:
 - spec/lib/heroploy/config/deployment_config_spec.rb
 - spec/lib/heroploy/config/environment_checks_spec.rb
 - spec/lib/heroploy/config/environment_spec.rb
+- spec/lib/heroploy/config/remote_config_spec.rb
+- spec/lib/heroploy/config/shared_env_spec.rb
 - spec/lib/heroploy/tasks/check_all_spec.rb
 - spec/lib/heroploy/tasks/check_branch_spec.rb
 - spec/lib/heroploy/tasks/check_pushed_spec.rb