Cleanup minor rubocop offenses

Cleaned up all the minor rubocop issues, the ones left relate to
complex logic and what I think is a bug in rubocop for nested
vs compact modules/class definitions.

Change-Id: Ic0c0677de44642e0994c0b95a3c270cbd4749b40

.rubocop_todo.yml

@@ -1,90 +1,28 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-02-27 11:18:27 -0600 using RuboCop version 0.29.1.
+# on 2015-05-28 12:53:22 -0500 using RuboCop version 0.29.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# Cop supports --auto-correct.
-Lint/UnusedBlockArgument:
-  Enabled: false
-
 # Offense count: 9
 Metrics/AbcSize:
   Max: 56
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 14
 
 # Offense count: 11
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/ClassAndModuleChildren:
   Enabled: false
 
-# Offense count: 10
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundBlockBody:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/FirstParameterIndentation:
-  Enabled: false
-
-# Offense count: 3
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/FormatString:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/IndentHash:
-  Enabled: false
-
-# Offense count: 5
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/MultilineOperationIndentation:
-  Enabled: false
-
 # Offense count: 2
 # Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
 Style/Next:
   Enabled: false
 
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-# Offense count: 13
-# Cop supports --auto-correct.
-Style/SingleSpaceBeforeFirstArg:
-  Enabled: false
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleInsidePipes, SupportedStyles.
-Style/SpaceAroundBlockParameters:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
-  Enabled: false
-
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoredMethods.

attributes/database.rb

@@ -172,7 +172,6 @@ node['openstack']['common']['services'].each do |service, project|
     default['openstack']['db'][service]['nosql']['used'] = false
     default['openstack']['db'][service]['nosql']['port'] = '27017'
   end
-
 end
 
 # DB key to the get_password library routine

attributes/default.rb

@@ -69,7 +69,7 @@ default['openstack']['vault_gem_version'] = '~> 2.3'
 
 # Default attributes when not using data bags (use_databags = false)
 node['openstack']['common']['services'].each_key do |service|
-  %w{user service db token}.each do |type|
+  %w(user service db token).each do |type|
     default['openstack']['secret'][service][type] = "#{service}-#{type}"
   end
 end

attributes/messaging.rb

@@ -34,8 +34,8 @@ default['openstack']['endpoints']['mq']['bind_interface'] = nil
 ###################################################################
 # Services to assign mq attributes for
 ###################################################################
-services = %w{bare-metal block-storage compute database image
+services = %w(bare-metal block-storage compute database image
-              identity telemetry network orchestration}
+              identity telemetry network orchestration)
 
 ###################################################################
 # Generic default attributes

libraries/cli.rb

@@ -23,7 +23,8 @@ require 'chef/mixin/shell_out'
 include Chef::Mixin::ShellOut
 require 'uri'
 
-module ::Openstack # rubocop:disable Documentation
+# CLI methods
+module ::Openstack
   # return an environment suitable for calling openstack commands.
   #
   # @param [String] user name

libraries/database.rb

@@ -19,7 +19,8 @@
 # limitations under the License.
 #
 
-module ::Openstack # rubocop:disable Documentation
+# Database methods
+module ::Openstack
   # Library routine that uses the database cookbook to create the
   # service's database and grant read/write access to the
   # given user and password.

libraries/endpoints.rb

@@ -21,7 +21,8 @@
 
 require 'uri'
 
-module ::Openstack # rubocop:disable Documentation
+# Endpoint methods
+module ::Openstack
   # Shortcut to get the full URI for an endpoint, and return it as a URI object
   # First we get the attribute hash for the endpoint, using endpoint_for().
   # Then we call uri_from_hash(). If the hash has a 'uri' key,
@@ -53,7 +54,7 @@ module ::Openstack # rubocop:disable Documentation
   # Shortcut to get the SQLAlchemy DB URI for a named service
   def db_uri(service, user, pass) # rubocop:disable MethodLength, CyclomaticComplexity
     info = db(service)
-    if info
+    return unless info
     host = info['host']
     port = info['port'].to_s
     type = info['service_type']
@@ -90,7 +91,6 @@ module ::Openstack # rubocop:disable Documentation
       "#{type}:///#{path}#{options}"
     end
   end
-  end
 
   # Return the address for the hash.
   #

libraries/network.rb

@@ -19,7 +19,8 @@
 # limitations under the License.
 #
 
-module ::Openstack # rubocop:disable Documentation
+# Network methods
+module ::Openstack
   # return the IPv4 (default) address of the given interface.
   #
   # @param [String] interface The interface to query.

libraries/parse.rb

@@ -18,7 +18,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module ::Openstack # rubocop:disable Documentation
+# Parse methods
+module ::Openstack
   # The current state of (at least some) OpenStack CLI tools do not provide a
   # mechanism for outputting data in formats other than PrettyTable output.
   # Therefore this function is intended to parse PrettyTable output into a

libraries/passwords.rb

@@ -20,7 +20,8 @@
 # limitations under the License.
 #
 
-module ::Openstack # rubocop:disable Documentation
+# Password methods
+module ::Openstack
   # Library routine that returns an encrypted data bag value
   # for a supplied string. The key used in decrypting the
   # encrypted value should be located at
@@ -65,7 +66,7 @@ module ::Openstack # rubocop:disable Documentation
   # attribute-specified openstack secrets databag.
   def get_secret(key)
     ::Chef::Log.warn(
-      "The get_secret method is DEPRECATED. "\
+      'The get_secret method is DEPRECATED. '\
       "Use get_password(key, 'token') instead")
 
     if node['openstack']['use_databags']
@@ -83,7 +84,7 @@ module ::Openstack # rubocop:disable Documentation
   # component name, but can also be a token name
   # e.g. openstack_identity_bootstrap_token
   def get_password(type, key)
-    unless %w{db user service token}.include?(type)
+    unless %w(db user service token).include?(type)
       ::Chef::Log.error("Unsupported type for get_password: #{type}")
       return
     end

libraries/search.rb

@@ -18,7 +18,8 @@
 # limitations under the License.
 #
 
-module ::Openstack # rubocop:disable Documentation
+# Search methods
+module ::Openstack
   # Search the nodes environment for the given role or recipe.
   #
   # @param [String] The role or recipe to be found.

libraries/uri.rb

@@ -21,7 +21,8 @@
 
 require 'uri'
 
-module ::Openstack # rubocop:disable Documentation
+# URI methods
+module ::Openstack
   # Returns a uri::URI from a hash. If the hash has a 'uri' key, the value
   # of that is returned. If not, then the routine attempts to construct
   # the URI from other parts of the hash.  The values of the 'port' and 'path'

libraries/wrappers.rb

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+
+# Wrapper methods
 module ::Openstack
   # Wrapper method to allow to easier spec testing
   def recipe_included?(recipe)

metadata.rb

@@ -12,7 +12,7 @@ recipe           'openstack-common::logging', 'Installs/Configures common loggin
 recipe 'openstack-common::sysctl', 'Configures sysctl settings'
 recipe 'openstack-common::openrc', 'Creates openrc file'
 
-%w{ ubuntu suse redhat centos }.each do |os|
+%w(ubuntu suse redhat centos).each do |os|
   supports os
 end
 

recipes/client.rb

@@ -18,10 +18,6 @@
 # limitations under the License.
 #
 
-class ::Chef::Recipe # rubocop:disable Documentation
-  include ::Openstack
-end
-
 platform_options = node['openstack']['common']['platform']
 platform_options['common_client_packages'].each do |pkg|
   package pkg do

recipes/openrc.rb

@@ -18,7 +18,8 @@
 # limitations under the License.
 #
 
-class ::Chef::Recipe # rubocop:disable Documentation
+# Chef
+class ::Chef::Recipe
   include ::Openstack
 end
 

recipes/set_endpoints_by_interface.rb

@@ -18,7 +18,8 @@
 # limitations under the License.
 #
 
-class ::Chef::Recipe # rubocop:disable Documentation
+# Chef
+class ::Chef::Recipe
   include ::Openstack
 end
 

spec/client-redhat_spec.rb

@@ -2,9 +2,7 @@
 require_relative 'spec_helper'
 
 describe 'openstack-common::client' do
-
   describe 'redhat' do
-
     let(:runner) { ChefSpec::SoloRunner.new(REDHAT_OPTS) }
     let(:node) { runner.node }
     let(:chef_run) do

spec/client_spec.rb

@@ -2,9 +2,7 @@
 require_relative 'spec_helper'
 
 describe 'openstack-common::client' do
-
   describe 'ubuntu' do
-
     let(:runner) { ChefSpec::SoloRunner.new(UBUNTU_OPTS) }
     let(:node) { runner.node }
     let(:chef_run) do

spec/database_spec.rb

@@ -12,7 +12,6 @@ describe 'openstack-common::default' do
     include_context 'library-stubs'
 
     describe '#db_create_with_user' do
-
       it 'returns nil when no such service was found' do
         expect(
           subject.db_create_with_user('nonexisting', 'user', 'pass')

spec/default_spec.rb

@@ -4,7 +4,7 @@ require_relative 'spec_helper'
 describe 'openstack-common::default' do
   describe 'ubuntu' do
     let(:runner) { ChefSpec::SoloRunner.new(UBUNTU_OPTS) }
-    let(:mq_services) { %w{bare-metal block-storage compute database image telemetry network orchestration} }
+    let(:mq_services) { %w(bare-metal block-storage compute database image telemetry network orchestration) }
     let(:node) { runner.node }
     let(:chef_run) do
       runner.converge(described_recipe)
@@ -57,32 +57,32 @@ describe 'openstack-common::default' do
     end
 
     it 'has correct host for endpoints' do
-      %w{identity-api identity-internal identity-admin compute-api compute-ec2-api compute-ec2-admin
+      %w(identity-api identity-internal identity-admin compute-api compute-ec2-api compute-ec2-admin
          compute-xvpvnc compute-novnc compute-vnc compute-metadata-api network-api network-linuxbridge
          network-openvswitch image-api block-storage-api object-storage-api telemetry-api orchestration-api
-         orchestration-api-cfn orchestration-api-cloudwatch database-api bare-metal-api}.each do |endpoint|
+         orchestration-api-cfn orchestration-api-cloudwatch database-api bare-metal-api).each do |endpoint|
         expect(chef_run.node['openstack']['endpoints'][endpoint]['host']).to eq('127.0.0.1')
       end
     end
 
     it 'allows bind_interface override for all bind endpoints' do
       node.set['openstack']['endpoints']['bind_interface'] = 'eth1'
-      %w{identity-bind identity-admin-bind compute-api-bind compute-ec2-api-bind compute-ec2-admin-bind
+      %w(identity-bind identity-admin-bind compute-api-bind compute-ec2-api-bind compute-ec2-admin-bind
          compute-xvpvnc-bind compute-novnc-bind compute-vnc-bind compute-vnc-proxy-bind compute-metadata-api-bind
          network-api-bind image-api-bind image-registry-bind block-storage-api-bind object-storage-api-bind
          telemetry-api-bind orchestration-api-bind orchestration-api-cfn-bind orchestration-api-cloudwatch-bind
-         database-api-bind bare-metal-api-bind dashboard-http-bind dashboard-https-bind}.each do |endpoint|
+         database-api-bind bare-metal-api-bind dashboard-http-bind dashboard-https-bind).each do |endpoint|
         expect(chef_run.node['openstack']['endpoints'][endpoint]['bind_interface']).to eq('eth1')
       end
     end
 
     it 'allows scheme for all bind endpoints' do
       node.set['openstack']['endpoints']['scheme'] = 'https'
-      %w{identity-api identity-internal identity-admin compute-api compute-ec2-api compute-ec2-admin
+      %w(identity-api identity-internal identity-admin compute-api compute-ec2-api compute-ec2-admin
          compute-xvpvnc compute-novnc compute-metadata-api
          network-api image-api image-registry block-storage-api object-storage-api
          telemetry-api orchestration-api orchestration-api-cfn orchestration-api-cloudwatch
-         database-api bare-metal-api}.each do |endpoint|
+         database-api bare-metal-api).each do |endpoint|
         expect(chef_run.node['openstack']['endpoints'][endpoint]['scheme']).to eq('https')
       end
     end

spec/endpoints_spec.rb

@@ -287,7 +287,7 @@ describe 'openstack-common::set_endpoints_by_interface' do
       it 'does nothing when empty endpoints' do
         allow(subject).to receive(:node).and_return('openstack' => { 'endpoints' => {} })
         count = 0
-        subject.endpoints do | ep |
+        subject.endpoints do
           count += 1
         end
         expect(count).to eq(0)
@@ -296,7 +296,7 @@ describe 'openstack-common::set_endpoints_by_interface' do
       it 'executes block count when have endpoints' do
         allow(subject).to receive(:node).and_return(chef_run.node)
         count = 0
-        subject.endpoints do |ep|
+        subject.endpoints do
           count += 1
         end
         expect(count).to be >= 1

spec/logging_spec.rb

@@ -11,16 +11,11 @@ describe 'openstack-common::logging' do
       let(:dir) { chef_run.directory('/etc/openstack') }
 
       it 'should create /etc/openstack' do
-        expect(chef_run).to create_directory('/etc/openstack')
+        expect(chef_run).to create_directory('/etc/openstack').with(
-      end
+          owner: 'root',
-
+          group: 'root',
-      it 'has proper owner' do
+          mode: 00755
-        expect(dir.owner).to eq('root')
+        )
-        expect(dir.group).to eq('root')
-      end
-
-      it 'has proper modes' do
-        expect(sprintf('%o', dir.mode)).to eq '755'
       end
     end
 
@@ -28,16 +23,11 @@ describe 'openstack-common::logging' do
       let(:file) { chef_run.template('/etc/openstack/logging.conf') }
 
       it 'should create /etc/openstack/logging.conf' do
-        expect(chef_run).to create_template(file.name)
+        expect(chef_run).to create_template(file.name).with(
-      end
+          owner: 'root',
-
+          group: 'root',
-      it 'has proper owner' do
+          mode: 00644
-        expect(file.owner).to eq('root')
+        )
-        expect(file.group).to eq('root')
-      end
-
-      it 'has proper modes' do
-        expect(sprintf('%o', file.mode)).to eq '644'
       end
 
       context 'loggers' do

spec/network_spec.rb

@@ -46,7 +46,6 @@ describe 'openstack-common::default' do
           subject.address_for('all')
         ).to eq('0.0.0.0')
       end
-
     end
 
     describe '#address_for ipv6' do

spec/password_spec.rb

@@ -126,7 +126,7 @@ describe 'openstack-common::default' do
       before { node.set['openstack']['use_databags'] = false }
 
       describe '#get_password' do
-        %w{service db user token}.each do |type|
+        %w(service db user token).each do |type|
           it "returns the set attribute for #{type}" do
             expect(subject.get_password(type, 'compute')).to eq("compute-#{type}")
           end

spec/sysctl_spec.rb

@@ -8,27 +8,20 @@ describe 'openstack-common::sysctl' do
     let(:chef_run) { runner.converge(described_recipe) }
 
     describe 'sysctl.d directory' do
-
       it 'should create /etc/systctl.d' do
         expect(chef_run).to create_directory('/etc/sysctl.d')
       end
-
     end
 
     describe '60-openstack.conf' do
       let(:file) { chef_run.template('/etc/sysctl.d/60-openstack.conf') }
 
       it 'should create the template /etc/systctl.d/60-openstack.conf' do
-        expect(chef_run).to create_template('/etc/sysctl.d/60-openstack.conf')
+        expect(chef_run).to create_template('/etc/sysctl.d/60-openstack.conf').with(
-      end
+          owner: 'root',
-
+          group: 'root',
-      it 'has proper owner' do
+          mode: 0644
-        expect(file.owner).to eq('root')
+        )
-        expect(file.group).to eq('root')
-      end
-
-      it 'has proper modes' do
-        expect(sprintf('%o', file.mode)).to eq '644'
       end
 
       it 'sets the sysctl attributes' do
@@ -39,17 +32,14 @@ describe 'openstack-common::sysctl' do
           expect(chef_run).to render_file(file.name).with_content(/^#{k} = #{v}$/)
         end
       end
-
     end
 
     describe 'execute sysctl' do
-
       it 'should execute sysctl for 60-openstack' do
         resource = chef_run.execute('sysctl -p /etc/sysctl.d/60-openstack.conf')
         expect(resource).to do_nothing
         expect(resource).to subscribe_to('template[/etc/sysctl.d/60-openstack.conf]').on(:run).immediately
       end
-
     end
   end
 end