lorj 0.2.0 → 1.0.0

data/spec/02_prc_base_config_spec.rb

@@ -0,0 +1,216 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# require 'byebug'
+
+$LOAD_PATH << File.join('..', 'lib')
+
+require 'rh.rb'
+require 'prc.rb'
+require 'prc_base_config.rb' # Load PRC_core framework
+
+describe 'class: PRC::BaseConfig,' do
+  context 'when creating a new instance' do
+    it 'should be loaded' do
+      config = PRC::BaseConfig.new
+      expect(config).to be
+    end
+
+    it 'should be initialized with Hash data.' do
+      config = PRC::BaseConfig.new(:test => :toto)
+      expect(config.data).to eq(:test => :toto)
+    end
+  end
+
+  context 'config[*keys] = value' do
+    before(:all) do
+      @config = PRC::BaseConfig.new
+    end
+
+    it 'should be able to create a key/value in the config object.' do
+      @config[:test1] = 'value'
+      expect(@config.data).to eq(:test1 => 'value')
+    end
+
+    it 'should be able to create a key tree/value in the config object.' do
+      @config[:test1, :test2] = 'value'
+      expect(@config.data).to eq(:test1 => { :test2 => 'value' })
+    end
+  end
+
+  context 'config.del(*keys)' do
+    before(:all) do
+      @config = PRC::BaseConfig.new(:test1 => 'value',
+                                    :test2 => { :test2 => 'value' })
+    end
+
+    it 'should be able to delete a key/value in the config object.' do
+      expect(@config.del(:test1)).to eq('value')
+      expect(@config.data).to eq(:test2 => { :test2 => 'value' })
+    end
+
+    it 'should be able to delete a key/value in the config object.' do
+      expect(@config.del(:test2)).to eq(:test2 => 'value')
+      expect(@config.data).to eq({})
+    end
+  end
+
+  context 'config[*keys]' do
+    before(:all) do
+      @config = PRC::BaseConfig.new(:test1 => { :test2 => 'value' })
+    end
+
+    it 'with no parameter should return nil' do
+      expect(@config[]).to equal(nil)
+    end
+
+    it "with keys = [:test1], should return {:test2 =>'value'}." do
+      expect(@config[:test1]).to eq(:test2 => 'value')
+    end
+
+    it "with keys = [:test1, :test2], should return {:test2 =>'value'}." do
+      expect(@config[:test1, :test2]).to eq('value')
+    end
+  end
+
+  context 'config.exist?(*keys)' do
+    before(:all) do
+      @config = PRC::BaseConfig.new(:test1 => { :test2 => 'value' })
+    end
+
+    it 'with no parameter should return nil' do
+      expect(@config.exist?).to equal(nil)
+    end
+
+    it 'with keys = [test1], should return true.' do
+      expect(@config.exist?(:test1)).to equal(true)
+    end
+
+    it 'with keys = [:test1, :test2], should return true.' do
+      expect(@config.exist?(:test1, :test2)).to equal(true)
+    end
+
+    it 'with keys = [:test], should return false.' do
+      expect(@config.exist?(:test)).to equal(false)
+    end
+
+    it 'with keys = [:test1, :test], should return false.' do
+      expect(@config.exist?(:test1, :test)).to equal(false)
+    end
+
+    it 'with keys = [:test1, :test2, :test3], should return false.' do
+      expect(@config.exist?(:test1, :test2, :test3)).to equal(false)
+    end
+  end
+
+  context "config.erase on :test1 => { :test2 => 'value' }" do
+    it 'with no parameter should return {} and cleanup internal data.' do
+      config = PRC::BaseConfig.new(:test1 => { :test2 => 'value' })
+      expect(config.erase).to eq({})
+      expect(config.data).to eq({})
+    end
+  end
+
+  context 'config.save and config.load' do
+    before(:all) do
+      @config = PRC::BaseConfig.new(:test1 => { :test2 => 'value' })
+    end
+
+    it 'save with no parameter should fail' do
+      expect { @config.save }.to raise_error RuntimeError
+    end
+
+    it 'save with filename set, save should true' do
+      file = '~/.lorj_rspec.yaml'
+      @config.filename = file
+      filename = File.expand_path(file)
+
+      expect(@config.filename).to eq(filename)
+      expect(@config.save).to equal(true)
+
+      File.delete(filename)
+    end
+
+    it 'save with filename given, returns true, and file saved.' do
+      file = '~/.lorj_rspec2.yaml'
+      old_file = @config.filename
+      filename = File.expand_path(file)
+
+      expect(@config.save(file)).to equal(true)
+      expect(@config.filename).not_to eq(old_file)
+      expect(@config.filename).to eq(filename)
+    end
+
+    it 'load returns true and file is loaded.' do
+      @config.erase
+
+      expect(@config.load).to equal(true)
+      expect(@config.data).to eq(:test1 => { :test2 => 'value' })
+
+      File.delete(@config.filename)
+    end
+
+    it 'load raises if file given is not found.' do
+      @config.erase
+
+      expect { @config.load('~/.lorj_rspec.yaml') }.to raise_error
+    end
+  end
+
+  context 'config.data_options(options)' do
+    it 'with no parameter should return {} ie no options.' do
+      config = PRC::BaseConfig.new
+      expect(config.data_options).to eq({})
+    end
+
+    it 'with :readonly => true should return {} ie no options.' do
+      config = PRC::BaseConfig.new
+      expect(config.data_options(:readonly => true)).to eq(:readonly => true)
+    end
+
+    it 'with any unknown options like :section => "test" should return '\
+       '{:section => "test"}.' do
+      config = PRC::BaseConfig.new
+      expect(config.data_options(:section => 'test')).to eq(:section => 'test')
+    end
+
+    it 'with any existing options set we replace it all.' do
+      config = PRC::BaseConfig.new
+      config.data_options(:section => 'test')
+      expect(config.data_options(:toto => 'tata')).to eq(:toto => 'tata')
+    end
+
+    it 'with :data_readonly => true, we cannot set a data.' do
+      config = PRC::BaseConfig.new(:test => 'toto')
+      config.data_options(:data_readonly => true)
+      config[:test] = 'titi'
+      expect(config.data).to eq(:test => 'toto')
+    end
+
+    it 'with :file_readonly => true, we cannot save data to a file.' do
+      config = PRC::BaseConfig.new(:test => 'toto')
+      file = '~/.rspec_test.yaml'
+      file_path = File.expand_path(file)
+      config.data_options(:file_readonly => true)
+      system('rm -f ~/.rspec_test.yaml')
+      expect(config.save(file)).to equal(false)
+      expect(config.filename).to equal(nil)
+      expect { config.load(file) }.to raise_error
+      expect(config.filename).to eq(file_path)
+    end
+  end
+end

data/spec/04_prc_core_config_spec.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+#  require 'byebug'
+
+$LOAD_PATH << File.join('..', 'lib')
+
+require 'rh.rb'
+require 'prc.rb'
+require 'prc_base_config.rb'
+require 'prc_core_config.rb'
+
+describe 'class: PRC::CoreConfig,' do
+  context 'when creating a new instance' do
+    before(:all) do
+      @config = PRC::CoreConfig.new
+    end
+
+    it 'should be loaded' do
+      expect(@config).to be
+    end
+
+    it 'runtime set works' do
+      expect(@config[:test] = :toto).to eq(:toto)
+      expect(@config.exist?(:test)).to eq(true)
+      expect(@config[:test]).to eq(:toto)
+    end
+  end
+
+  context 'from a child class, with local layer set to :test => :found_local'\
+          ' and runtime layer' do
+    before(:all) do
+      # Child class definition for rSpec.
+      class Test1 < PRC::CoreConfig
+        def initialize
+          local = PRC::BaseConfig.new(:test => :found_local)
+          layers = []
+          layers << PRC::CoreConfig.define_layer(:name => 'local',
+                                                 :config => local)
+          layers << PRC::CoreConfig.define_layer # runtime
+
+          initialize_layers(layers)
+        end
+      end
+      @config = Test1.new
+    end
+
+    it 'should be loaded' do
+      expect(@config).to be
+      expect(@config.layers).to eq(%w(runtime local))
+    end
+
+    it 'config.where?(:test) should be ["local"]' do
+      expect(@config.where?(:test)).to eq(['local'])
+    end
+
+    it 'config.[:test] = :where set in "runtime".' do
+      expect(@config[:test] = :where).to eq(:where)
+      expect(@config.where?(:test)).to eq(%w(runtime local))
+      expect(@config[:test]).to equal(:where)
+    end
+
+    it 'config.del(:test) remove the data from runtime, '\
+       'and restore from local.' do
+      expect(@config.del(:test)).to eq(:where)
+      expect(@config[:test]).to equal(:found_local)
+    end
+  end
+end

data/spec/11_lorj_config_spec.rb

@@ -0,0 +1,263 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+app_path = File.dirname(__FILE__)
+
+$LOAD_PATH << File.join('..', 'lib')
+
+require 'lorj' # Load lorj framework
+
+describe 'class: Lorj::Config,' do
+  context 'new instance, with no default local config files, ' do
+    before(:all) do
+      PrcLib.log_file = 'lorj-rspec.log'
+      PrcLib.level = Logger::FATAL
+      PrcLib.app_name = 'lorj-spec'
+      PrcLib.app_defaults = File.expand_path(File.join(app_path, '..',
+                                                       'lorj-spec'))
+      @local = File.join(PrcLib.data_path, 'config.yaml')
+      File.delete(@local) if File.exist?(@local)
+    end
+
+    it 'should be loaded' do
+      expect(File.exist?(@local)).to equal(false)
+      config = Lorj::Config.new
+      expect(config).to be
+    end
+    it 'local config file gets created.' do
+      expect(File.exist?(@local)).to equal(true)
+    end
+    it 'local config is empty.' do
+      expect(YAML.load_file(@local)).to eq(:default => nil)
+    end
+  end
+
+  context 'CoreConfig original functions,' do
+    before(:all) do
+      @config = Lorj::Config.new
+    end
+
+    it 'config.file return nil. (runtime)' do
+      expect(@config.file).to equal(nil)
+    end
+
+    it "config.file(nil, :name => 'local') return local config file." do
+      file = File.join(PrcLib.data_path, 'config.yaml')
+      expect(@config.file(nil, :name => 'local')).to eq(file)
+    end
+
+    it "config.file(nil, :name => 'default') return default "\
+       'application file.' do
+      file = File.join(PrcLib.app_defaults, 'defaults.yaml')
+      expect(@config.file(nil, :name => 'default')).to eq(file)
+    end
+
+    it 'config.layers returns all config names.' do
+      expect(@config.layers).to eq(%w(runtime local default))
+    end
+
+    it 'config.where?(:test1) return false' do
+      expect(@config.where?(:test1)).to equal(false)
+    end
+
+    it 'config.exist?(:test1) returns false' do
+      expect(@config.exist?(:test1)).to equal(false)
+    end
+
+    it "config.where?(:maestro_url) return ['defaults'] "\
+       '(see lorj-spec/defaults.yaml)' do
+      expect(@config.where?(:maestro_url)).to eq(['default'])
+    end
+
+    it 'config.exist?(:maestro_url) returns true' do
+      expect(@config.exist?(:maestro_url)).to equal(true)
+    end
+  end
+
+  context 'redefined CoreConfig functions' do
+    before(:all) do
+      @config = Lorj::Config.new
+    end
+
+    it "config[:maestro_url] returns 'http://example.org'" do
+      expect(@config[:maestro_url]).to eq('http://example.org')
+    end
+
+    it "config.get(:maestro_url) returns 'http://example.org'" do
+      expect(@config.get(:maestro_url)).to eq('http://example.org')
+    end
+
+    it 'config[:test1, :none] returns :none' do
+      expect(@config[:test1, :none]).to equal(:none)
+    end
+
+    it "config[:maestro_url, :none] returns 'http://example.org'" do
+      expect(@config[:maestro_url, :none]).to eq('http://example.org')
+    end
+
+    it 'config[:maestro_url] = :none returns :none' do
+      expect(@config[:maestro_url] = :none).to eq(:none)
+    end
+
+    it 'config[:maestro_url, :none] returns :none' do
+      expect(@config[:maestro_url]).to eq(:none)
+    end
+
+    it 'config.where?(:maestro_url) returns [runtime, default]' do
+      expect(@config.where?(:maestro_url)).to eq(%w(runtime default))
+    end
+
+    it 'config.del(:maestro_url) returns :none' do
+      expect(@config.del(:maestro_url)).to eq(:none)
+    end
+    it 'config.where?(:maestro_url) now returns [default]' do
+      expect(@config.where?(:maestro_url)).to eq(%w(default))
+    end
+
+    it 'config.set(:maestro_url, :none) is equivalent as '\
+       'config[:maestro_url] = :none' do
+      expect(@config.set(:maestro_url, :none)).to eq(:none)
+      expect(@config.where?(:maestro_url)).to eq(%w(runtime default))
+    end
+  end
+
+  context 'Lorj::Config specific functions' do
+    before(:all) do
+      @config = Lorj::Config.new
+    end
+
+    it 'config.config_filename is identical than '\
+       "config.file(nil, :name => 'local')" do
+      file = @config.file(nil, :name => 'local')
+      expect(@config.config_filename).to eq(file)
+    end
+
+    it "config.config_filename('default') is identical than "\
+       "config.file(nil, :name => 'default')" do
+      file = @config.file(nil, :name => 'default')
+      expect(@config.config_filename('default')).to eq(file)
+    end
+
+    it "config.file('test2.yaml', 'runtime') returns false - not authorized." do
+      expect(@config.file('test2.yaml', :name => 'runtime')).to equal(false)
+      expect(@config.config_filename('runtime')).to equal(nil)
+    end
+
+    it "config.file('test2.yaml', 'local') returns false - not authorized." do
+      expect(@config.file('test2.yaml', :name => 'local')).to equal(false)
+      file = File.join(PrcLib.data_path, 'config.yaml')
+      expect(@config.config_filename).to eq(file)
+    end
+
+    it "config.file('test2.yaml', 'default') returns false - not authorized." do
+      expect(@config.file('test2.yaml', :name => 'default')).to equal(false)
+      file = File.join(PrcLib.app_defaults, 'defaults.yaml')
+      expect(@config.config_filename('default')).to eq(file)
+    end
+
+    it 'config.local_exist?(:test1) returns false' do
+      expect(@config.local_exist?(:test1)).to equal(false)
+    end
+
+    it "config.local_set(:test1, 'value') returns 'value' and saved in"\
+       " 'local' config" do
+      expect(@config.local_set(:test1, 'value')).to eq('value')
+      expect(@config.where?(:test1)).to eq(%w(local))
+    end
+
+    it 'config.local_exist?(:test1) returns true' do
+      expect(@config.local_exist?(:test1)).to equal(true)
+    end
+
+    it "config.local_get(:test1) returns 'value'" do
+      expect(@config.local_get(:test1)).to eq('value')
+    end
+
+    it 'config.save_local_config returns true and is really saved.' do
+      config = Lorj::Config.new
+      expect(config.where?(:test1)).to equal(false)
+      expect(@config.save_local_config).to equal(true)
+      config2 = Lorj::Config.new
+      expect(config2.where?(:test1)).to eq(%w(local))
+    end
+
+    it "config.local_del(:test1) returns 'value'" do
+      expect(@config.local_del(:test1)).to eq('value')
+      expect(@config.where?(:test1)).to equal(false)
+    end
+
+    it 'default_dump return all in a Hash' do
+      default_file = @config.config_filename('default')
+      default = YAML.load_file(default_file)
+
+      res = { 'local' => { :default => {} },
+              'default' => default
+            }
+
+      expect(@config.config_dump).to eq(res)
+    end
+
+    it 'config.get_section(:maestro_url) returns :maestro' do
+      expect(@config.get_section(:maestro_url)).to equal(:maestro)
+    end
+
+    it 'config.get_section(:test1, :default) returns :default' do
+      expect(@config.get_section(:test1)).to equal(nil)
+    end
+
+    it 'config.runtime_exist?(:test1) returns false - no :test1 available in '\
+       'runtime.' do
+      expect(@config.runtime_exist?(:test1)).to equal(false)
+    end
+
+    context 'setting :test1 => :value,' do
+      before(:all) do
+        @config[:test1] = :value
+      end
+      it 'config.runtime_get(:test1) returns :value' do
+        expect(@config.runtime_get(:test1)).to equal(:value)
+      end
+      it 'config.runtime_exist?(:test1) returns true' do
+        expect(@config.runtime_exist?(:test1)).to equal(true)
+      end
+    end
+    context 'app default functions' do
+      before(:all) do
+        default_file = @config.config_filename('default')
+        @default = YAML.load_file(default_file)
+      end
+      it 'config.app_default(:default) returns :default of defaults.yaml' do
+        expect(@config.app_default(:default)).to eq(@default[:default])
+      end
+
+      it 'config.app_default(:sections) returns :section of defaults.yaml' do
+        expect(@config.app_default(:sections)).to eq(@default[:sections])
+      end
+      it 'config.meta_each provides the wanted list of section/key/values' do
+        # The defaults.yaml MUST have data exclusive set to true
+        expect(@default.rh_get(:sections, :credentials, :data,
+                               :account_exclusive)).to equal(true)
+        @config.meta_each do | section, key, value |
+          expect(@default.rh_exist?(:sections, section, key)).to equal(true)
+          expect(@default.rh_get(:sections, section, key)).to equal(value)
+          expect([section, key,
+                  value]).not_to eq([:sections, :credentials, :data])
+        end
+      end
+    end
+  end
+end