refactor(linter): Obey Rubocop linter rules.

* Some violations still persist, as fixing them could create problems with how Hiera implements the backend.

Co-authored-by: Stephen Geller <[email protected]>
Co-authored-by: Alex Wilson <[email protected]>

Author: 3 people

Gemfile

@@ -1,11 +1,11 @@
 source 'https://rubygems.org'
 
-gem 'hiera', '1.3.4'
 gem 'aws-sdk-secretsmanager'
+gem 'hiera', '1.3.4'
 
 group :test, :development do
   gem 'mocha'
   gem 'rake'
   gem 'rspec'
   gem 'rubocop'
-end
+end

Rakefile

@@ -1,7 +1,7 @@
-require "rake"
-require "rspec/core/rake_task"
+require 'rake'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = Dir.glob("spec/**/*_spec.rb")
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
 end
-task default: :spec
+task default: :spec

lib/secrets_manager_backend.rb

@@ -1,37 +1,29 @@
 class Hiera
   module Backend
     class Secrets_manager_backend
-      def initialize()
+      def initialize
         require 'aws-sdk-secretsmanager'
 
         # Initialises a new instance of the AWS Secrets Manager client
-        @client = Aws::SecretsManager::Client.new(region: Config[:secrets_manager][:region])
+        @client = Aws::SecretsManager::Client.new(
+          region: Config[:secrets_manager][:region]
+        )
 
-        Hiera.debug("AWS Secrets Manager backend starting")
+        Hiera.debug('AWS Secrets Manager backend starting')
       end
 
-      # lookup() is called by Hiera to return a secret, and is required by Hiera to work
       def lookup(key, scope, order_override, resolution_type)
-
-        # If lookup() returns `nil`, it will proceed to the next available backend (possible Hiera)
         answer = nil
 
-        # begin / rescue / end is like a try / catch,
-        # and will ensure Hiera doesn't break if the Secrets Manager library doesn't work properly
         begin
+          answer = @client.get_secret_value(secret_id: key)['secret_string']
 
-          # queries Secrets Manager for the value of the key passed
-          # 'secret_string' contains the actual plaintext secret
-          answer = @client.get_secret_value({secret_id: key})['secret_string']
-
-        #   Catches any errors, and outputs a debug message
         rescue Aws::SecretsManager::Errors::ResourceNotFoundException => error
           Hiera.debug("#{key} not found: #{error.message}")
         end
 
-        # Implicitly returns answer, which will either be nil or the actual answer!
         answer
       end
     end
   end
-end
+end

spec/secrets_manager_backend_spec.rb

@@ -5,57 +5,72 @@ class Hiera
   module Backend
     describe Secrets_manager_backend do
       before do
-        @config_object = { :secrets_manager => { :region => "some_region" } }
+        @config_object = { secrets_manager: { region: 'some_region' } }
         Config.load(@config_object)
         Hiera.stubs(:debug)
-        Aws::SecretsManager::Client.stubs(:new).with(@config_object[:secrets_manager])
+        Aws::SecretsManager::Client
+          .stubs(:new)
+          .with(@config_object[:secrets_manager])
       end
 
-      describe "#initialize" do
-        it "should announce its creation" do
-          Hiera.expects(:debug).with("AWS Secrets Manager backend starting")
+      describe '#initialize' do
+        it 'should announce its creation' do
+          Hiera
+            .expects(:debug)
+            .with('AWS Secrets Manager backend starting')
           Secrets_manager_backend.new
         end
 
-        it "should set up a connection to AWS Secrets Manager" do
-          Aws::SecretsManager::Client.expects(:new).with(@config_object[:secrets_manager])
+        it 'should set up a connection to AWS Secrets Manager' do
+          Aws::SecretsManager::Client
+            .expects(:new)
+            .with(@config_object[:secrets_manager])
           Secrets_manager_backend.new
         end
-
       end
 
       describe '#lookup' do
         before do
           @mock_client = mock('client')
-          Aws::SecretsManager::Client.stubs(:new).with(@config_object[:secrets_manager]).returns(@mock_client)
+          Aws::SecretsManager::Client
+            .stubs(:new)
+            .with(@config_object[:secrets_manager]).returns(@mock_client)
           @backend = Secrets_manager_backend.new
         end
 
-        it "should return a secret that exists" do
-          secret_name = "secret_name"
-          secret_string = "i_am_a_secret"
+        it 'should return a secret that exists' do
+          secret_name = 'secret_name'
+          secret_string = 'i_am_a_secret'
 
           @mock_client.stubs(:get_secret_value)
-              .with({ secret_id: secret_name })
-              .returns('secret_string' => secret_string)
+                      .with(secret_id: secret_name)
+                      .returns('secret_string' => secret_string)
 
           answer = @backend.lookup(secret_name, nil, nil, nil)
           expect(answer).to eq(secret_string)
         end
 
-        it "should not return a secret that does not exist" do
-          nonexistent_secret = "does_not_exist"
+        it 'should not return a secret that does not exist' do
+          nonexistent_secret = 'does_not_exist'
           mock_context = {}
           error_message = 'Secrets Manager could not find this secret.'
+          error = Aws::
+                  SecretsManager::
+                  Errors::
+                  ResourceNotFoundException.new(
+                    mock_context,
+                    error_message
+                  )
           @mock_client.stubs(:get_secret_value)
-              .with({ secret_id: nonexistent_secret })
-              .raises(Aws::SecretsManager::Errors::ResourceNotFoundException.new(mock_context, error_message))
-
-          Hiera.expects(:debug).with("#{nonexistent_secret} not found: #{error_message}")
+                      .with(secret_id: nonexistent_secret)
+                      .raises(error)
+          Hiera
+            .expects(:debug)
+            .with("#{nonexistent_secret} not found: #{error_message}")
           answer = @backend.lookup(nonexistent_secret, nil, nil, nil)
           expect(answer).to eq(nil)
         end
       end
     end
   end
-end
+end

spec/spec_helper.rb

@@ -1,4 +1,4 @@
-$:.insert(0, File.join([File.dirname(__FILE__), "..", "lib"]))
+$LOAD_PATH.insert(0, File.join([File.dirname(__FILE__), '..', 'lib']))
 
 require 'rubygems'
 require 'rspec'
@@ -8,4 +8,4 @@
 
 RSpec.configure do |config|
   config.mock_with :mocha
-end
+end