Add support for Cloud Foundry

Alan Yeo · Pair · commit 884cb7720980 · 2016-12-27T11:12:49.000+08:00
Signed-off-by: Gamaliel Amaudruz &lt;gamaudruz@pivotal.io&gt;
diff --git a/.ruby-version b/.ruby-version
@@ -1 +1 @@
-2.3.1
+2.3.3
diff --git a/.travis.yml b/.travis.yml
@@ -4,8 +4,9 @@ sudo: false
 rvm:
   - 2.0.0
   - 2.1.10
-  - 2.2.5
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0-rc1
 gemfile:
   - gemfiles/rails_3.gemfile
   - gemfiles/rails_4.gemfile
@@ -18,10 +19,18 @@ matrix:
       gemfile: gemfiles/rails_5.gemfile
     - rvm: 2.1.10
       gemfile: gemfiles/rails_5.gemfile
-    - rvm: 2.2.5
+    - rvm: 2.2.6
       gemfile: gemfiles/rails_3.gemfile
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       gemfile: gemfiles/rails_3.gemfile
+    - rvm: 2.4.0-rc1
+      gemfile: gemfiles/rails_3.gemfile
+    - rvm: 2.4.0-rc1
+      gemfile: gemfiles/rails_4.gemfile
+    - rvm: 2.4.0-rc1
+      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: 2.4.0-rc1
+      gemfile: gemfiles/rails_4.2.gemfile
 before_install:
   - gem install bundler
 script:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.4.0
+
+* Added support for passing a raw ruby hash into to both `Settings.add_source!` and `Settings.prepend_source!` ([#108](https://github.com/railsconfig/config/pull/159) thanks to [@halloffame](https://github.com/halloffame))
+* Added new reserved name `test` ([#158](https://github.com/railsconfig/config/pull/158) thanks to [@milushov](https://github.com/milushov))
+* `to_hash` should not replace nested config objects with Hash ([#160](https://github.com/railsconfig/config/issues/160) thanks to [@seikichi](https://github.com/seikichi))
+
 ## 1.3.0
 
 * **WARNING:** Overwrite arrays found in previously loaded settings file ([#137](https://github.com/railsconfig/config/pull/137) thanks to [@Fryguy](https://github.com/Fryguy) and [@dtaniwaki](https://github.com/dtaniwaki)) - this is a change breaking previous behaviour. If you want to keep Config to work as before, which is merging arrays found in following loaded settings file, please add `config.overwrite_arrays = false` to your Config initializer 
diff --git a/README.md b/README.md
@@ -193,6 +193,15 @@ Settings.reload!
 > Note: this is an example usage, it is easier to just use the default local files `settings.local.yml,
 settings/#{Rails.env}.local.yml and environments/#{Rails.env}.local.yml` for your developer specific settings.
 
+You also have the option to add a raw hash as a source. One use case might be storing settings in the database or in environment variables that overwrite what is in the YML files.
+
+```ruby
+Settings.add_source!({some_secret: ENV['some_secret']})
+Settings.reload!
+```
+
+You may pass a hash to `prepend_source!` as well.
+
 ## Embedded Ruby (ERB)
 
 Embedded Ruby is allowed in the configuration files. Consider the two following config files.
@@ -300,6 +309,16 @@ filesystem gets recreated from the git sources on each instance refresh. To use
 
 To upload your local values to Heroku you could ran `bundle exec rake config:heroku`.
 
+### Working with Cloud Foundry
+
+Cloud Foundry integration will generate a manifest adding to your CF manifest.yml the defined ENV variables under the `env` section of specified app in the yaml file.
+You must specify the app name and optionally the name of your CF manifest file:
+
+    bundle exec rake config:cf[app_name, cf_manifest.yml]
+    
+The result of this command will have the manifest file name suffixed with the environment you ran the task in. You can then push your app with the generated manifest.    
+
+
 ### Fine-tuning
 
 You can customize how environment variables are processed:
diff --git a/lib/config.rb b/lib/config.rb
@@ -5,6 +5,7 @@
 require 'config/version'
 require 'config/integrations/rails/engine' if defined?(::Rails)
 require 'config/sources/yaml_source'
+require 'config/sources/hash_source'
 require 'deep_merge'
 
 module Config
diff --git a/lib/config/integrations/cloud_foundry.rb b/lib/config/integrations/cloud_foundry.rb
@@ -0,0 +1,27 @@
+require 'bundler'
+require 'yaml'
+require_relative '../../../lib/config/integrations/helpers/cf_manifest_merger'
+
+module Config
+  module Integrations
+    class CloudFoundry < Struct.new(:app_name, :file_path)
+
+      def invoke
+        manifest_path = file_path || 'manifest.yml'
+        file_name, _ext = manifest_path.split('.yml')
+
+        manifest_hash = YAML.load(IO.read(File.join(::Rails.root, manifest_path)))
+
+        puts "Generating manifest... (base cf manifest: #{manifest_path})"
+
+        merged_hash = Config::CFManifestMerger.new(app_name, manifest_hash).add_to_env
+
+        target_manifest_path = File.join(::Rails.root, "#{file_name}-#{::Rails.env}.yml")
+        IO.write(target_manifest_path, merged_hash.to_yaml)
+
+        puts "File #{target_manifest_path} generated."
+      end
+
+    end
+  end
+end
diff --git a/lib/config/integrations/helpers/cf_manifest_merger.rb b/lib/config/integrations/helpers/cf_manifest_merger.rb
@@ -0,0 +1,38 @@
+require_relative 'helpers'
+
+module Config
+  class CFManifestMerger
+    include Integrations::Helpers
+
+    def initialize(app_name, manifest_hash)
+      @app_name = app_name
+      @manifest_hash = manifest_hash
+      raise ArgumentError.new("Manifest path & app name must be specified") unless @app_name && @manifest_hash
+    end
+
+    def add_to_env
+
+      settings_hash = Config.const_get(Config.const_name).to_hash.stringify_keys
+
+      prefix_keys_with_const_name_hash = to_dotted_hash(settings_hash, namespace: Config.const_name)
+
+      app_hash = @manifest_hash['applications'].detect { |hash| hash['name'] == @app_name }
+
+      raise ArgumentError, "Application '#{@app_name}' is not specified in your manifest" if app_hash.nil?
+
+      check_conflicting_keys(app_hash['env'], settings_hash)
+
+      app_hash['env'].merge!(prefix_keys_with_const_name_hash)
+
+      @manifest_hash
+    end
+
+    private
+
+    def check_conflicting_keys(env_hash, settings_hash)
+      conflicting_keys = env_hash.keys & settings_hash.keys
+      raise ArgumentError.new("Conflicting keys: #{conflicting_keys.join(', ')}") if conflicting_keys.any?
+    end
+
+  end
+end
diff --git a/lib/config/integrations/helpers/helpers.rb b/lib/config/integrations/helpers/helpers.rb
@@ -0,0 +1,21 @@
+module Config::Integrations::Helpers
+
+  def to_dotted_hash(source, target: {}, namespace: nil)
+    raise ArgumentError, "target must be a hash (given: #{target.class.name})" unless target.kind_of? Hash
+    prefix = "#{namespace}." if namespace
+    case source
+      when Hash
+        source.each do |key, value|
+          to_dotted_hash(value, target: target, namespace: "#{prefix}#{key}")
+        end
+      when Array
+        source.each_with_index do |value, index|
+          to_dotted_hash(value, target: target, namespace: "#{prefix}#{index}")
+        end
+      else
+        target[namespace] = source
+    end
+    target
+  end
+
+end
diff --git a/lib/config/integrations/heroku.rb b/lib/config/integrations/heroku.rb
@@ -1,8 +1,11 @@
 require 'bundler'
+require_relative 'helpers/helpers'
 
 module Config
   module Integrations
     class Heroku < Struct.new(:app)
+      include Integrations::Helpers
+
       def invoke
         puts 'Setting vars...'
         heroku_command = "config:set #{vars}"
@@ -14,13 +17,13 @@ def invoke
       def vars
         # Load only local options to Heroku
         Config.load_and_set_settings(
-            Rails.root.join("config", "settings.local.yml").to_s,
-            Rails.root.join("config", "settings", "#{environment}.local.yml").to_s,
-            Rails.root.join("config", "environments", "#{environment}.local.yml").to_s
+            ::Rails.root.join("config", "settings.local.yml").to_s,
+            ::Rails.root.join("config", "settings", "#{environment}.local.yml").to_s,
+            ::Rails.root.join("config", "environments", "#{environment}.local.yml").to_s
         )
 
         out = ''
-        dotted_hash = to_dotted_hash Kernel.const_get(Config.const_name).to_hash, {}, Config.const_name
+        dotted_hash = to_dotted_hash Kernel.const_get(Config.const_name).to_hash, namespace: Config.const_name
         dotted_hash.each {|key, value| out += " #{key}=#{value} "}
         out
       end
@@ -38,22 +41,6 @@ def `(command)
         Bundler.with_clean_env { super }
       end
 
-      def to_dotted_hash(source, target = {}, namespace = nil)
-        prefix = "#{namespace}." if namespace
-        case source
-          when Hash
-            source.each do |key, value|
-              to_dotted_hash(value, target, "#{prefix}#{key}")
-            end
-          when Array
-            source.each_with_index do |value, index|
-              to_dotted_hash(value, target, "#{prefix}#{index}")
-            end
-          else
-            target[namespace] = source
-        end
-        target
-      end
     end
   end
 end
diff --git a/lib/config/integrations/rails/railtie.rb b/lib/config/integrations/rails/railtie.rb
@@ -15,7 +15,7 @@ def preload
 
         # Load rake tasks (eg. Heroku)
         rake_tasks do
-          Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each { |f| load f }
+          Dir[File.join(File.dirname(__FILE__), '../../tasks/*.rake')].each { |f| load f }
         end
 
         config.before_configuration { preload }
diff --git a/lib/config/options.rb b/lib/config/options.rb
@@ -15,13 +15,15 @@ def empty?
     def add_source!(source)
       # handle yaml file paths
       source = (Sources::YAMLSource.new(source)) if source.is_a?(String)
+      source = (Sources::HashSource.new(source)) if source.is_a?(Hash)
 
       @config_sources ||= []
       @config_sources << source
     end
 
     def prepend_source!(source)
       source = (Sources::YAMLSource.new(source)) if source.is_a?(String)
+      source = (Sources::HashSource.new(source)) if source.is_a?(Hash)
 
       @config_sources ||= []
       @config_sources.unshift(source)
@@ -148,15 +150,15 @@ def []=(param, value)
     protected
 
     def descend_array(array)
-      array.length.times do |i|
-        value = array[i]
+      array.map do |value|
         if value.instance_of? Config::Options
-          array[i] = value.to_hash
+          value.to_hash
         elsif value.instance_of? Array
-          array[i] = descend_array(value)
+          descend_array(value)
+        else
+          value
         end
       end
-      array
     end
 
     # Recursively converts Hashes to Options (including Hashes inside Arrays)
diff --git a/lib/config/sources/hash_source.rb b/lib/config/sources/hash_source.rb
@@ -0,0 +1,16 @@
+module Config
+  module Sources
+    class HashSource
+      attr_accessor :hash
+
+      def initialize(hash)
+        @hash = hash
+      end
+
+      # returns hash that was passed in to initialize
+      def load
+        hash.is_a?(Hash) ? hash : {}
+      end
+    end
+  end
+end
diff --git a/lib/config/tasks/cloud_foundry.rake b/lib/config/tasks/cloud_foundry.rake
@@ -0,0 +1,10 @@
+require 'config/integrations/cloud_foundry'
+
+namespace 'config' do
+
+  desc 'Create a cf manifest with the env variables defined by config under current environment'
+  task :'cf', [:app_name, :file_path] => :environment do |_, args|
+    Config::Integrations::CloudFoundry.new(args[:app_name], args[:file_path]).invoke
+  end
+
+end
diff --git a/lib/config/tasks/heroku.rake b/lib/config/tasks/heroku.rake
@@ -1,7 +1,10 @@
 require 'config/integrations/heroku'
 
 namespace 'config' do
+
+  desc 'Upload to Heroku all env variables defined by config under current environment'
   task :heroku, [:app] => :environment do |_, args|
     Config::Integrations::Heroku.new(args[:app]).invoke
   end
+
 end
diff --git a/lib/config/version.rb b/lib/config/version.rb
@@ -1,3 +1,3 @@
 module Config
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end
diff --git a/spec/config_spec.rb b/spec/config_spec.rb
@@ -60,6 +60,15 @@
     expect(servers).to eq([{ name: "yahoo.com" }, { name: "amazon.com" }])
   end
 
+  it "should convert to a hash without modifying nested settings" do
+    config = Config.load_files("#{fixture_path}/development.yml")
+    config.to_hash
+    expect(config).to be_kind_of(Config::Options)
+    expect(config[:section]).to be_kind_of(Config::Options)
+    expect(config[:section][:servers][0]).to be_kind_of(Config::Options)
+    expect(config[:section][:servers][1]).to be_kind_of(Config::Options)
+  end
+
   it "should convert to a json" do
     config = Config.load_files("#{fixture_path}/development.yml").to_json
     expect(JSON.parse(config)["section"]["servers"]).to be_kind_of(Array)
diff --git a/spec/fixtures/cf/cf_conflict.yml b/spec/fixtures/cf/cf_conflict.yml
@@ -0,0 +1,2 @@
+DEFAULT_HOST: host
+DEFAULT_PORT: port
diff --git a/spec/fixtures/cf/cf_manifest.yml b/spec/fixtures/cf/cf_manifest.yml
@@ -0,0 +1,11 @@
+applications:
+- name: some-cf-app
+  instances: 1
+  env:
+    DEFAULT_HOST: host
+    DEFAULT_PORT: port
+    FOO: BAR
+
+- name: app_name
+  env:
+    DEFAULT_HOST: host
diff --git a/spec/fixtures/cf/cf_multilevel.yml b/spec/fixtures/cf/cf_multilevel.yml
@@ -0,0 +1,13 @@
+world:
+  capitals:
+    europe:
+      germany: 'Berlin'
+      poland: 'Warsaw'
+  array:
+  - name: 'Alan'
+  - name: 'Gam'
+  array_with_index:
+    0:
+      name: 'Bob'
+    1:
+      name: 'William'
diff --git a/spec/integrations/helpers/cf_manifest_merger_spec.rb b/spec/integrations/helpers/cf_manifest_merger_spec.rb
diff --git a/spec/integrations/helpers/helpers_spec.rb b/spec/integrations/helpers/helpers_spec.rb
diff --git a/spec/options_spec.rb b/spec/options_spec.rb
diff --git a/spec/sources/hash_source_spec.rb b/spec/sources/hash_source_spec.rb
diff --git a/spec/tasks/cloud_foundry_spec.rb b/spec/tasks/cloud_foundry_spec.rb
diff --git a/spec/tasks/db_spec.rb b/spec/tasks/db_spec.rb
diff --git a/spec/tasks/heroku_spec.rb b/spec/tasks/heroku_spec.rb
