flo 0.0.2 → 0.0.3

data/lib/flo/task.rb

@@ -21,7 +21,7 @@ module Flo
       @provider = provider
       @method_sym = method_sym
 
-      raise ArgumentError.new("Expected provider_options to be a hash") unless provider_options.is_a? Hash
+      raise ArgumentError.new("Expected provider_options to be a Hash") unless provider_options.is_a? Hash
       @provider_options = provider_options
     end
 
@@ -29,25 +29,43 @@ module Flo
     # passed in that are merged into the parameters that were provided in {initialize}.
     # Proc values will be evaluated before being passed to the provider.
     #
-    # @param [Hash] args={} Additional arguments to pass to the provider method
+    # @param [Array] args=[] Additional arguments to pass to the provider method
     # @return [#success?] Response of the provider's method
-    def call(args={})
-      @provider.public_send(method_sym, merged_evaluated_args(args))
+    def call(args=[])
+      raise ArgumentError.new("Expected Array") unless args.is_a? Array
+      @provider.public_send(method_sym, *merged_evaluated_args(args))
     end
 
     private
     attr_reader :provider, :method_sym, :provider_options
 
     def merged_evaluated_args(args)
-      evaluate_proc_values(provider_options.merge args)
+      unless args[-1].is_a? Hash
+        args.push Hash.new
+      end
+
+      args[-1] = provider_options.merge(args[-1])
+      evaluate_proc_values(args)
     end
 
-    def evaluate_proc_values(args={})
-      hsh = {}
-      args.each do |k, v|
-        hsh[k] = v.is_a?(Proc) ? v.call : v
+    # For each value in the args array, evaluate any procs.
+    # If the value is a hash, evaluate any values in the hash
+    # that are procs.
+    def evaluate_proc_values(args=[])
+      args.collect do |arg|
+        case arg
+        when Proc
+          arg.call
+        when Hash
+          hsh = {}
+          arg.each do |k, v|
+            hsh[k] = v.is_a?(Proc) ? v.call : v
+          end
+          hsh
+        else
+          arg
+        end
       end
-      hsh
     end
   end
 end

data/lib/flo/version.rb

@@ -4,5 +4,5 @@
 # For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 
 module Flo
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/flo.rb

@@ -3,8 +3,7 @@
 # Licensed under the BSD 3-Clause license.
 # For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 
-require "flo/version"
-require "flo/runner"
+require 'flo/version'
 
 # Parent module for all Flo related functionality.  Should not be used directly.
 # See {file:README.md} or {Runner} for information on overall usage.
@@ -12,3 +11,5 @@ require "flo/runner"
 module Flo
 
 end
+
+require 'flo/runner'

data/test/fixtures/basic_setup.rb

@@ -6,9 +6,14 @@
 require 'flo/provider/developer'
 
 config do |cfg|
-  cfg.provider :developer
+  cfg.cred_store = Flo::CredStore::YamlStore.new(File.join(FIXTURES_ROOT, "cred_example.yml"))
+  cfg.provider :developer, password: cfg.creds['some_value']
 end
 
-register_command([:task, :start]) do |success: true|
+register_command('task:start') do |success: true|
   perform :developer, :is_successful, { success: state(:developer).return_true }
 end
+
+register_command(:validate_password) do |success: true|
+  perform :developer, :has_option, { option: :password }
+end

data/test/fixtures/cred_example.yml

@@ -0,0 +1,3 @@
+:provider:
+  key: 'foo'
+some_value: 'bar'

data/test/flo/cli_test.rb

@@ -0,0 +1,115 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../minitest_helper'
+require 'flo/cli'
+require 'ostruct'
+
+module Flo
+  class CliTest < Flo::UnitTest
+
+    def subject
+      @subject ||= begin
+        runner_class_mock = OpenStruct.new(new: runner_mock)
+        Flo::Cli.new(runner_class: runner_class_mock)
+      end
+    end
+
+    def runner_mock
+      @runner_mock ||= begin
+        mock = Minitest::Mock.new
+        mock.expect(:load_default_config_files, true)
+        mock
+      end
+    end
+
+    def test_call_without_options_returns_help
+      runner_mock.expect(:commands, {})
+
+      # This is a portion of the output from the help command.
+      # We're only asserting that it outputs some help text
+      assert_output(/Use `flo help \[command\]` for usage on individual commands/, nil) do
+        subject.call([])
+      end
+
+      runner_mock.verify
+    end
+
+    def test_call_runs_command
+      runner_mock.expect(:commands, { 'expected_command' => empty_command } )
+      runner_mock.expect(:execute, true, ['expected_command', Array])
+
+      subject.call(['expected_command'])
+
+      runner_mock.verify
+    end
+
+    def test_help_includes_command_description
+      cmd = empty_command
+      cmd[:description] = 'This is the description'
+
+      runner_mock.expect(:commands, { 'expected_command' => cmd } )
+
+      assert_output(/This is the description/, nil) do
+        subject.call(['help', 'expected_command'])
+      end
+    end
+
+    def test_help_includes_command_summary
+      cmd = empty_command
+      cmd[:summary] = 'This is the summary'
+
+      runner_mock.expect(:commands, { 'expected_command' => cmd } )
+
+      assert_output(/This is the summary/, nil) do
+        subject.call(['help', 'expected_command'])
+      end
+    end
+
+    def test_required_parameters_show_up_in_help
+      cmd = empty_command
+      cmd[:command].required_parameters = ['foo', 'bar']
+
+      runner_mock.expect(:commands, { 'expected_command' => cmd } )
+
+      assert_output(/USAGE\s+flo expected_command foo bar/, nil) do
+        subject.call(['help', 'expected_command'])
+      end
+    end
+
+    def test_optional_parameters_show_up_in_help
+      cmd = empty_command
+      cmd[:command].optional_parameters = [:foo, :bar]
+
+      runner_mock.expect(:commands, { 'expected_command' => cmd } )
+
+      # The options are shown in alphabetical order
+      # The output should look something like this:
+      # --bar[=<value>]       bar
+      # --foo[=<value>]       foo
+      assert_output(/--bar\[=<value>\]\s+bar\s+--foo\[=<value>\]\s+foo/, nil) do
+        subject.call(['help', 'expected_command'])
+      end
+    end
+
+    def test_options_and_args_are_passed_on
+      cmd = empty_command
+      cmd[:command].optional_parameters = ['baz']
+      runner_mock.expect(:commands, { 'expected_command' => cmd } )
+
+      runner_mock.expect(:execute, true, ['expected_command', ['foo', 'bar', {baz: 'something'}]])
+
+      subject.call(['expected_command', 'foo', 'bar', '--baz=something'])
+    end
+
+
+    def empty_command
+      cmd = OpenStruct.new
+      cmd.required_parameters = []
+      cmd.optional_parameters = []
+      { command: cmd }
+    end
+  end
+end

data/test/flo/command_collection_test.rb

@@ -19,22 +19,6 @@ module Flo
       assert_same command, subject[:command_name]
     end
 
-    def test_an_array_of_symbols_can_be_used_as_a_storage_key
-      command = Object.new
-      subject[:name, :spaced, :command] = command
-      assert_same command, subject[:name, :spaced, :command]
-    end
-
-    def test_properly_selects_correct_command
-      command1 = Object.new
-      command2 = Object.new
-      subject[:name, :spaced, :command1] = command1
-      subject[:name, :spaced, :command2] = command2
-
-      assert_same command1, subject[:name, :spaced, :command1]
-      assert_same command2, subject[:name, :spaced, :command2]
-    end
-
     def test_selecting_a_command_that_doesnt_exist_raises_error
       assert_raises(Flo::CommandNotDefinedError) do
         subject[:undefined_command]

data/test/flo/command_test.rb

@@ -72,6 +72,18 @@ module Flo
       subject.perform :mocked_provider, :provider_method, {evaluated_later: subject.state(:mocked_provider).state_method }
     end
 
+    def test_required_parameters_returns_array
+      @subject_block = lambda{|a,b,c: nil, d: 'foo'| }
+      assert_equal [:a, :b], subject.required_parameters
+    end
+
+
+
+    def test_optional_parameters_returns_array
+      @subject_block = lambda{|a,b,c: nil, d: 'foo'| }
+      assert_equal [:c, :d], subject.optional_parameters
+    end
+
     class MockProvider
       attr_reader :args, :state_method_called
 

data/test/flo/config_test.rb

@@ -5,12 +5,17 @@
 
 require_relative '../minitest_helper'
 require 'flo/config'
+require 'yaml'
 
 module Flo
   class ConfigTest < Flo::UnitTest
 
     def subject
-      @subject ||= Flo::Config.new
+      @subject ||= begin
+        subj = Flo::Config.new()
+        subj.cred_store = MockCredStore.new
+        subj
+      end
     end
 
     def test_provider_instantiates_new_provider
@@ -25,11 +30,33 @@ module Flo
       end
     end
 
+    def test_cred_store_defaults_to_yaml
+      assert_kind_of Flo::CredStore::YamlStore, Flo::Config.new.cred_store
+    end
+
+    def test_cred_store_can_be_assigned
+      expected_cred_store = Object.new
+
+      subject.cred_store = expected_cred_store
+
+      assert_same expected_cred_store, subject.cred_store
+    end
+
+    def test_creds_returns_a_lambda
+      assert_respond_to subject.creds[:some_value], :call
+    end
   end
+
   module Provider
     class MockProvider
+      attr_writer :cred_store
       def initialize(args={})
       end
     end
   end
+  class MockCredStore
+    def credentials_for(provider)
+      {}
+    end
+  end
 end

data/test/flo/cred_store/creds_test.rb

@@ -0,0 +1,29 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../../minitest_helper'
+require 'flo/cred_store/yaml_store'
+
+module Flo
+  module CredStore
+    class CredsTest < Flo::UnitTest
+
+      def subject
+        @subject ||= Flo::CredStore::Creds.new(key: 'foo')
+      end
+
+      def test_element_reference_fetches_a_value_from_yaml_file
+        assert_equal 'foo', subject[:key]
+      end
+
+      def test_element_reference_raises_on_missing_value
+        assert_raises(Flo::MissingCredentialError) do
+          subject[:missing_key]
+        end
+      end
+
+    end
+  end
+end

data/test/flo/cred_store/pw_protected_store_test.rb

@@ -0,0 +1,91 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../../minitest_helper'
+require 'flo/cred_store/pw_protected_store'
+require 'gpgme'
+require 'yaml'
+
+module Flo
+  module CredStore
+    class PwProtectedStoreTest < Flo::UnitTest
+
+      def subject
+        @password ||= 'blah'
+        @subject ||= Flo::CredStore::PwProtectedStore.new(password: @password, cred_file_location: cred_file_location)
+      end
+
+      def encryptor
+        @password ||= 'blah'
+        GPGME::Crypto.new(password: @password)
+      end
+
+      def cred_file_location
+        @cred_file_location ||= Tempfile.new('cred_store.yml.gpg')
+      end
+
+      # Must use GPG 1.4, otherwise interactive password prompt
+      # will always pop up in the middle of the tests.
+      def ensure_gpg_version!
+        @testable_version ||= GPGME::Engine.info.select { |e| e.version && e.version.match(/^1\.4/) }.first
+        skip('GPG 1.4 not found, skipping gpg tests') unless @testable_version
+        GPGME::gpgme_set_engine_info(GPGME::PROTOCOL_OpenPGP, @testable_version.file_name, nil)
+      end
+
+      def teardown
+        if cred_file_location.is_a? Tempfile
+          cred_file_location.close
+          cred_file_location.unlink
+        end
+      end
+
+      def yaml_fixture
+        @yaml_fixture ||= File.join(FIXTURES_ROOT, 'cred_example.yml')
+      end
+
+      # # TODO: Make this test work with GPG 2.0 or 2.1
+      # def test_element_reference_fetches_a_value_from_yaml_file
+      #   ensure_gpg_version!
+
+      #   fixture_content = File.read(yaml_fixture)
+      #   assert_equal 'foo', ::YAML.load(fixture_content)['provider']['key'], "Yaml fixture doesn't contain the required value, test will fail for the wrong reason"
+      #   encryptor.encrypt(fixture_content, symmetric: true, output: cred_file_location)
+
+      #   assert_equal 'foo', subject['provider']['key'], "The key either doesn't exist or the file did not decrypt properly"
+      # end
+
+      def test_credentials_for_fetches_credentials_for_provider
+        ensure_gpg_version!
+
+        fixture_content = File.read(yaml_fixture)
+        assert_equal 'foo', ::YAML.load(fixture_content)[:provider]['key'], "Yaml fixture doesn't contain the required value, test will fail for the wrong reason"
+        encryptor.encrypt(fixture_content, symmetric: true, output: cred_file_location)
+
+        assert_equal 'foo', subject.credentials_for(:provider)['key'], "The key either doesn't exist or the file did not decrypt properly"
+      end
+
+      def test_can_initialize_with_file_path_string
+        @cred_file_location = yaml_fixture
+        assert_kind_of File, subject.cred_file
+      end
+
+      def test_inspect_does_not_reveal_password
+        @password = 'should_not_be_revealed'
+        refute_match(/#{@password}/, subject.inspect)
+      end
+
+      def test_encrypt_file_properly_encrypts_existing_file
+        ensure_gpg_version!
+
+        expected = File.read(yaml_fixture)
+
+        encrypted_outcome = subject.encrypt_file(yaml_fixture)
+
+        decrypted_outcome = encryptor.decrypt(encrypted_outcome).to_s
+        assert_equal expected, decrypted_outcome
+      end
+    end
+  end
+end

data/test/flo/cred_store/yaml_store_test.rb

@@ -0,0 +1,34 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../../minitest_helper'
+require 'flo/cred_store/yaml_store'
+
+module Flo
+  module CredStore
+    class YamlStoreTest < Flo::UnitTest
+
+      def subject
+        @subject ||= Flo::CredStore::YamlStore.new(yaml_fixture)
+      end
+
+      def yaml_fixture
+        @yaml_fixture ||= File.join(FIXTURES_ROOT, 'cred_example.yml')
+      end
+
+      def test_credentials_for_returns_credentials_object
+        refute_nil ::YAML.load(File.read(yaml_fixture))[:provider]
+        assert_kind_of Flo::CredStore::Creds, subject.credentials_for(:provider)
+      end
+
+      def test_credentials_for_returns_creds_object_if_provider_is_not_present
+        assert_nil ::YAML.load(File.read(yaml_fixture))[:missing_provider]
+
+        assert_kind_of Flo::CredStore::Creds, subject.credentials_for(:missing_provider)
+      end
+
+    end
+  end
+end

data/test/flo/provider/base_test.rb

@@ -0,0 +1,51 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require_relative '../../minitest_helper'
+require 'flo/provider/base'
+
+module Flo
+  module Provider
+    class BaseTest < Flo::UnitTest
+
+      def subject
+        @subject ||= begin
+          klass = Class.new(Flo::Provider::Base)
+          klass.class_eval do
+            def fetch_option(name)
+              options.fetch name
+            end
+          end
+          klass
+        end
+      end
+
+      def test_option_adds_configuration_to_class
+        subject.class_eval { option :some_option }
+
+        instance = subject.new(some_option: :foo)
+
+        assert_equal :foo, instance.fetch_option(:some_option)
+      end
+
+      def test_option_allows_for_a_default_value
+        subject.class_eval { option :default_option, :default_value }
+
+        instance = subject.new
+
+        assert_equal :default_value, instance.fetch_option(:default_option)
+      end
+
+      def test_required_options_raise_when_option_not_provided
+        subject.class_eval { option :required_option, nil, required: true }
+
+        assert_raises(Flo::Provider::MissingOptionError) do
+          subject.new
+        end
+      end
+
+    end
+  end
+end

data/test/flo/runner_integration_test.rb

@@ -19,17 +19,23 @@ module Flo
     end
 
     def test_execute_returns_success
-      response = subject.execute([:task, :start])
+      response = subject.execute('task:start')
 
       assert_equal true, response.success?
     end
 
     def test_execute_success_is_false_when_perform_fails
-      response = subject.execute([:task, :start], success: false)
+      response = subject.execute('task:start', [{success: false}])
 
       assert_equal false, response.success?
     end
 
+    def test_credentials_are_utilized
+      response = subject.execute(:validate_password)
+
+      assert_equal true, response.success?
+    end
+
   end
 end
 

data/test/flo/runner_test.rb

@@ -56,21 +56,7 @@ module Flo
 
       subject.register_command(:foo) { }
 
-      assert_equal new_command, subject.commands[:foo]
-
-      command_class_mock.verify
-    end
-
-    def test_register_command_namespaced_adds_new_command_to_collection
-      config_mock.expect(:providers, {})
-      new_command = Object.new
-      command_class_mock.expect(:new, new_command, [{ providers: {} }])
-
-      @command_collection_mock = {}
-
-      subject.register_command([:foo, :bar]) { }
-
-      assert_equal(new_command, subject.commands[[:foo, :bar]])
+      assert_equal new_command, subject.commands[:foo][:command]
 
       command_class_mock.verify
     end
@@ -78,7 +64,7 @@ module Flo
     def test_execute_calls_command_with_args
       args = {foo: :bar}
       providers_hash = Object.new
-      new_command = lambda { |args| true }
+      new_command = lambda { |_args| true }
 
       command_class_mock.expect(:new, new_command, [{ providers: providers_hash }])
       config_mock.expect(:providers, providers_hash)
@@ -95,6 +81,17 @@ module Flo
       config_mock.verify
     end
 
+    def test_load_default_config_files_loads_available_config_files
+      File.stub(:exist?, true) do
+        loaded_files = []
+        subject.stub(:load_config_file, lambda { |file| loaded_files << file } ) do
+
+          subject.load_default_config_files
+        end
+
+        assert_equal [File.join(Dir.pwd, '.flo'), File.join(Dir.home, '.flo')], loaded_files
+      end
+    end
 
   end
 end

data/test/flo/task_test.rb

@@ -31,14 +31,14 @@ module Flo
 
     def test_passes_on_args
       provider.expect(:foo, true, [{ bar: 1 }])
-      subject.call(bar: 1)
+      subject.call([{bar: 1}])
       provider.verify
     end
 
     def test_merges_args_with_provider_options
       @provider_options = { baz: 2 }
       provider.expect(:foo, true, [{ bar: 1, baz: 2 }])
-      subject.call(bar: 1)
+      subject.call([{bar: 1}])
       provider.verify
     end
 
@@ -50,14 +50,24 @@ module Flo
     def test_called_args_override_provider_options
       @provider_options = { bar: 2 }
       provider.expect(:foo, true, [{ bar: 1 }])
-      subject.call(bar: 1)
+      subject.call([{bar: 1}])
       provider.verify
     end
 
     def test_procs_in_options_are_evaluated_before_provider_method_is_called
-      @provider_options = { baz: Proc.new { 2 }}
+      @provider_options = { baz: Proc.new { 2 } }
+      provider.expect(:foo, true, [:sym, :proc_result, { baz: 2 }])
+      subject.call([:sym, Proc.new { :proc_result }])
+
+      provider.verify
+    end
+
+    def test_procs_in_args_are_evaluated_before_provider_method_is_called
+      @provider_options = { baz: Proc.new { 2 } }
       provider.expect(:foo, true, [{ bar: 1, baz: 2 }])
-      subject.call(bar: Proc.new { 1 })
+      subject.call([{bar: Proc.new { 1 }}])
+
+      provider.verify
     end
   end
 end

data/test/minitest_helper.rb

@@ -17,6 +17,7 @@ ENV["MT_NO_SKIP_MSG"] = "true"
 
 require 'minitest/autorun'
 require 'pry'
+require 'minitest/hell'
 
 module Flo
   class UnitTest < Minitest::Test