psychic-runner 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69224ee73f0d75190d851b16319792a4dc766f34
-  data.tar.gz: 1cddbfe6844bf53e58a6b15113b57c18b823a9f6
+  metadata.gz: 0c7368904ef64ffdf44ad5037d40e0a94b91148f
+  data.tar.gz: f6d93730030b6d77ac4b702fa10432e0dba6893c
 SHA512:
-  metadata.gz: 7784c2bf1669787a6dc29eb096dd21e6afec25204a5d44e43c6f92bd342490065d3fbb4f5acad414865e8637023812f6b1a284a5fce5309251e1ee6f61b946e7
-  data.tar.gz: e42b2f1153877d7d04fb91a0c7cd19438e35f30b5f82669cb776b27fe5768ab17a93c15404a947fcbd44258d843d02510eafcca1825d14066b8bcfdb834a2d43
+  metadata.gz: b318bf6e0204400ff58acc0683316a9dfd64264214bf7a11143224c905e3870b2d8b2d5bb8886efedab8027314d98b88b0e88726695d988d34062d199e215dfb
+  data.tar.gz: e8e491d518e1b2fdec5b5dd66fc9384cd8592af0d3a2fc48185fc5cec051540f79cf3478930a3902219d6bfc9f7c3c4cfec108d0837d3c14ee4a9de6e1181137

data/.travis.yml

@@ -1,30 +1,10 @@
-language: php
-php:
-  - "5.6"
-  - "5.5"
-  - "5.4"
-  - "5.3"
-  - hhvm
-
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby
 matrix:
   allow_failures:
-    - php: hhvm
-
-branches:
-  only:
-    - master
-    - working
-
-before_script:
-  - composer install --prefer-source
-  - vendor/bin/parallel-lint --exclude vendor .
-  - vendor/bin/php-cs-fixer fix --dry-run --level psr2 .
-
-after_script:
-  - php vendor/bin/coveralls -v
+    - rvm: jruby
 
-notifications:
-  email:
-    - jamie.hannaford@rackspace.com
-    - glen.campbell@rackspace.com
-    - shaunak.kashyap@rackspace.com

data/lib/psychic/cli.rb

@@ -1,11 +1,33 @@
+require 'English'
 require 'thor'
 require 'psychic/runner'
 
 module Psychic
   class CLI < Thor
-    desc 'run_task <name>', 'Executes a custom task by name'
-    def run_task(task_name, *args)
-      result = runner.execute_task(task_name, *args)
+    BUILT_IN_TASKS = %w(bootstrap)
+
+    class << self
+      # Override Thor's start to strip extra_args from ARGV before it's processed
+      attr_accessor :extra_args
+
+      def start(given_args = ARGV, config = {})
+        if given_args && (split_pos = given_args.index('--'))
+          @extra_args = given_args.slice(split_pos + 1, given_args.length)
+          given_args = given_args.slice(0, split_pos)
+        end
+        super given_args, config
+      end
+    end
+
+    no_commands do
+      def extra_args
+        self.class.extra_args
+      end
+    end
+
+    desc 'task <name>', 'Executes any task by name'
+    def task(task_name)
+      result = runner.execute_task(task_name, *extra_args)
       result.error!
       say_status :success, task_name
     rescue Psychic::Shell::ExecutionError => e
@@ -13,25 +35,49 @@ module Psychic
       say e.execution_result if e.execution_result
     end
 
-    desc 'run_sample <name>', 'Executes a code sample'
-    def run_sample(sample_name, *args)
-      result = runner.run_sample(sample_name, *args)
-      result.error!
-      say_status :success, sample_name
-    rescue Errno::ENOENT => e
-      say_status :failed, "No code sample found for #{sample_name}", :red
-    rescue Psychic::Shell::ExecutionError => e
-      say_status :failed, "Executing sample #{sample_name}", :red
-      say e.execution_result if e.execution_result
+    BUILT_IN_TASKS.each do |task_name|
+      desc task_name, "Executes the #{task_name} task"
+      define_method(task_name) do
+        task(task_name)
+      end
+    end
+
+    desc 'sample <name>', 'Executes a code sample'
+    # rubocop:disable Metrics/LineLength
+    method_option :interactive, desc: 'Prompt for parameters?', enum: %w(always missing), lazy_default: 'missing'
+    method_option :parameters, desc: 'YAML file containing key/value parameters. Default: psychic-parameters.yaml'
+    method_option :parameter_mode, desc: 'How should the parameters be passed?', enum: %w(tokens arguments env)
+    method_option :dry_run, desc: 'Do not execute - just show what command would be run', lazy_default: true
+    # rubocop:enable Metrics/LineLength
+    def sample(*sample_names)
+      sample_names.each do | sample_name |
+        say_status :executing, sample_name
+        begin
+          run_sample sample_name
+        rescue Errno::ENOENT
+          say_status :failed, "No code sample found for #{sample_name}", :red
+          # TODO: Fail on missing? Fail fast?
+        end
+      end
     end
 
     private
 
+    def run_sample(sample_name)
+      result = runner.run_sample(sample_name, *extra_args)
+      if options.dry_run
+        say_status :dry_run, sample_name
+      else
+        result.error!
+        say_status :success, sample_name
+      end
+    end
+
     def runner
-      # Psychic::Shell.shell = shell
-      @runner ||= Psychic::Runner.new
+      runner_opts = Util.symbolized_hash(options).merge(
+        cwd: Dir.pwd, cli: shell, parameters: options.parameters
+      )
+      @runner ||= Psychic::Runner.new(runner_opts)
     end
   end
 end
-
-# require 'psychic/commands/exec'

data/lib/psychic/runner/base_runner.rb

@@ -1,11 +1,15 @@
 module Psychic
   class Runner
     module BaseRunner
+      DEFAULT_PARAMS_FILE = 'psychic-parameters.yaml'
+
       include Psychic::Shell
       include Psychic::Logger
 
       attr_reader :known_tasks
       attr_reader :cwd
+      attr_reader :env
+      attr_reader :hints
 
       module ClassMethods
         attr_accessor :magic_file_pattern
@@ -23,11 +27,19 @@ module Psychic
         base.extend(ClassMethods)
       end
 
-      def initialize(opts = {})
-        opts[:cwd] ||= Dir.pwd
+      def initialize(opts = {}, _hints = {})
+        @cwd = opts[:cwd] ||= Dir.pwd
+        @hints = Psychic::Util.stringified_hash(opts[:hints] || load_hints || {})
+        if @hints['options']
+          opts.merge! Psychic::Util.symbolized_hash(@hints['options'])
+        end
         @logger = opts[:logger] || new_logger
-        @cwd = opts[:cwd]
-        @opts = opts
+        @env = opts[:env] || ENV.to_hash
+        @parameters = load_parameters(opts[:parameters])
+        @cli, @interactive_mode = opts[:cli], opts[:interactive]
+        @parameter_mode, @restore_mode, @dry_run = opts[:parameter_mode], opts[:restore_mode], opts[:dry_run]
+        # Make sure to delete any option that isn't a MixLib::ShellOut option
+        @shell_opts = opts.select { |key, _| Psychic::Shell::AVAILABLE_OPTIONS.include? key }
       end
 
       def respond_to_missing?(task, include_all = false)
@@ -46,7 +58,7 @@ module Psychic
       def execute(command, *args)
         full_cmd = [command, *args].join(' ')
         logger.info("Executing #{full_cmd}")
-        shell.execute(full_cmd, @opts)
+        shell.execute(full_cmd, @shell_opts) unless dry_run?
       end
 
       def command_for_task(task, *_args)
@@ -63,6 +75,34 @@ module Psychic
       def active?
         self.class.magic_file_pattern ? false : Dir["#{@cwd}/#{self.class.magic_file_pattern}"]
       end
+
+      def dry_run?
+        @dry_run == true
+      end
+
+      private
+
+      def load_hints
+        hints_file = Dir["#{@cwd}/psychic-hints.{yaml,yml}"].first
+        YAML.load(File.read(hints_file)) unless hints_file.nil?
+      end
+
+      def load_parameters(parameters)
+        if parameters.nil? || parameters.is_a?(String)
+          load_parameters_file(parameters)
+        else
+          parameters
+        end
+      end
+
+      def load_parameters_file(file = nil)
+        if file.nil?
+          file ||= File.expand_path(DEFAULT_PARAMS_FILE, cwd)
+          return {} unless File.exist? file
+        end
+        parameters = Psychic::Util.replace_tokens(File.read(file), @env)
+        YAML.load(parameters)
+      end
     end
   end
 end

data/lib/psychic/runner/hot_runner.rb

@@ -3,23 +3,14 @@ module Psychic
     class HotRunner
       include BaseRunner
       def initialize(opts = {})
-        hints = opts.delete :hints
         super
-        @hints = Psychic::Util.stringified_hash(hints || load_hints || {})
-        @tasks = @hints['tasks'] || {}
+        @tasks = hints['tasks'] || {}
         @known_tasks = @tasks.keys
       end
 
       def [](task_name)
         @tasks[task_name]
       end
-
-      private
-
-      def load_hints
-        hints_file = Dir["#{@cwd}/psychic-hints.{yaml,yml}"].first
-        YAML.load(File.read(hints_file)) unless hints_file.nil?
-      end
     end
   end
 end

data/lib/psychic/runner/sample_runner.rb

@@ -1,13 +1,16 @@
 module Psychic
   class Runner
     module SampleRunner
+      def find_sample(code_sample)
+        find_in_hints(code_sample) || Psychic::Util.find_file_by_alias(code_sample, cwd)
+      end
+
       def run_sample(code_sample, *args)
-        sample_file = Psychic::Util.find_file_by_alias(code_sample, cwd)
-        process_template(sample_file) if templated?
-        command = command_for_task('run_sample')
+        sample_file = find_sample(code_sample)
+        absolute_sample_file = File.expand_path(sample_file, cwd)
+        process_parameters(absolute_sample_file)
+        command = build_command(code_sample, sample_file)
         if command
-          variables = { sample: code_sample, sample_file: sample_file }
-          command = Psychic::Util.replace_tokens(command, variables)
           execute(command, *args)
         else
           run_sample_file(sample_file)
@@ -18,32 +21,78 @@ module Psychic
         execute("./#{sample_file}", *args) # Assuming Bash, but should detect Windows and use PowerShell
       end
 
-      def process_template(sample_file)
-        absolute_sample_file = File.expand_path(sample_file, cwd)
-        template = File.read(absolute_sample_file)
-        # Default token pattern/replacement (used by php-opencloud) should be configurable
-        content = Psychic::Util.replace_tokens(template, variables, /'\{(\w+)\}'/, "'\\1'")
+      def process_parameters(sample_file)
+        if templated?
+          backup_and_overwrite(sample_file)
 
-        # Backup and overwrite
-        backup_file = "#{absolute_sample_file}.bak"
-        fail 'Please clear out old backups before rerunning' if File.exist? backup_file
-        FileUtils.cp(absolute_sample_file, backup_file)
-        File.write(absolute_sample_file, content)
+          template = File.read(sample_file)
+          # Default token pattern/replacement (used by php-opencloud) should be configurable
+          token_handler = RegexpTokenHandler.new(template, /'\{(\w+)\}'/, "'\\1'")
+          confirm_or_update_parameters(token_handler.tokens)
+          File.write(sample_file, token_handler.render(@parameters))
+        end
       end
 
       def templated?
-        # Probably not the best way to turn this on/off
-        true unless variables.nil?
-      end
-
-      def variables
-        # ... or
-        variables_file = Dir["#{cwd}/psychic-variables.{yaml,yml}"].first
-        return nil unless variables_file
-        environment_variables = ENV.to_hash
-        environment_variables.merge!(@opts[:env]) if @opts[:env]
-        variables = Psychic::Util.replace_tokens(File.read(variables_file), environment_variables)
-        YAML.load(variables)
+        @parameter_mode == 'tokens'
+      end
+
+      def interactive?
+        !@interactive_mode.nil?
+      end
+
+      protected
+
+      def find_in_hints(code_sample)
+        return unless hints['samples']
+        hints['samples'].each do |k, v|
+          return v if k.downcase == code_sample.downcase
+        end
+        nil
+      end
+
+      def build_command(code_sample, sample_file)
+        command = command_for_task('run_sample')
+        return nil if command.nil?
+
+        command_params = { sample: code_sample, sample_file: sample_file }
+        command_params.merge!(@parameters) unless @parameters.nil?
+        Psychic::Util.replace_tokens(command, command_params)
+      end
+
+      def backup_and_overwrite(file)
+        backup_file = "#{file}.bak"
+        if File.exist? backup_file
+          if should_restore?(backup_file, file)
+            FileUtils.mv(backup_file, file)
+          else
+            abort 'Please clear out old backups before rerunning' if File.exist? backup_file
+          end
+        end
+        FileUtils.cp(file, backup_file)
+      end
+
+      def should_restore?(file, orig, timing = :before)
+        return true if [timing, 'always']. include? restore_mode
+        if interactive?
+          @cli.yes? "Would you like to #{file} to #{orig} before running the sample?"
+        end
+      end
+
+      def prompt(key)
+        if value
+          return value unless @interactive_mode == 'always'
+          new_value = @cli.ask "Please set a value for #{key} (or enter to confirm #{value.inspect}): "
+          new_value.empty? ? value : new_value
+        else
+          @cli.ask "Please set a value for #{key}: "
+        end
+      end
+
+      def confirm_or_update_parameters(required_parameters)
+        required_parameters.each do | key |
+          @parameters[key] = prompt(key)
+        end if interactive?
       end
     end
   end

data/lib/psychic/runner/version.rb

@@ -1,5 +1,5 @@
 module Psychic
   class Runner
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/lib/psychic/shell.rb

@@ -4,6 +4,13 @@ module Psychic
     autoload :ExecutionError, 'psychic/shell/execution_result'
     autoload :MixlibShellOutExecutor, 'psychic/shell/mixlib_shellout_executor'
 
+    AVAILABLE_OPTIONS = [
+      # All MixLib::ShellOut options - though we don't use most of these
+      :cwd, :domain, :password, :user, :group, :umask,
+      :timeout, :returns, :live_stream, :live_stdout,
+      :live_stderr, :input, :logger, :log_level, :log_tag, :env
+    ]
+
     class << self
       attr_writer :shell
     end

data/lib/psychic/tokens.rb

@@ -12,7 +12,7 @@ module Psychic
       @template.scan(@token_pattern).flatten.uniq
     end
 
-    def replace(variables = {})
+    def render(variables = {})
       @template.gsub(@token_pattern) do
         full_match = Regexp.last_match[0]
         key = Regexp.last_match[1]
@@ -32,7 +32,7 @@ module Psychic
       @template.tags
     end
 
-    def replace(variables = {})
+    def render(variables = {})
       Mustache.render(@template, variables)
     end
   end

data/lib/psychic/util.rb

@@ -4,8 +4,8 @@ module Psychic
   class Util
     module Hashable
       def to_hash
-        instance_variables.each_with_object({}) do |var,hash|
-          hash[var.to_s.delete("@")] = instance_variable_get(var)
+        instance_variables.each_with_object({}) do |var, hash|
+          hash[var.to_s.delete('@')] = instance_variable_get(var)
         end
       end
     end
@@ -30,6 +30,20 @@ module Psychic
       end
     end
 
+    def self.symbolized_hash(obj)
+      if obj.is_a?(Hash)
+        obj.each_with_object({}) do |(k, v), h|
+          h[k.to_sym] = symbolized_hash(v)
+        end
+      elsif obj.is_a?(Array)
+        obj.each_with_object([]) do |e, a|
+          a << symbolized_hash(e)
+        end
+      else
+        obj
+      end
+    end
+
     def self.relativize(file, base_path)
       absolute_file = File.absolute_path(file)
       absolute_base_path = File.absolute_path(base_path)
@@ -48,9 +62,9 @@ module Psychic
 
     def self.replace_tokens(template, variables, token_regexp = nil, token_replacement = nil)
       if token_regexp.nil?
-        MustacheTokenHandler.new(template).replace(variables)
+        MustacheTokenHandler.new(template).render(variables)
       else
-        RegexpTokenHandler.new(template, token_regexp, token_replacement).replace(variables)
+        RegexpTokenHandler.new(template, token_regexp, token_replacement).render(variables)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: psychic-runner
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Max Lincoln
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-03 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -185,11 +185,9 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
-- README.md
 - Rakefile
 - bin/psychic
 - lib/psychic/cli.rb
-- lib/psychic/commands/exec.rb
 - lib/psychic/logger.rb
 - lib/psychic/runner.rb
 - lib/psychic/runner/base_runner.rb

data/README.md

@@ -1,70 +0,0 @@
-**php-opencloud**
-=============
-PHP SDK for OpenStack/Rackspace APIs
-
-[![Latest Stable Version](https://poser.pugx.org/rackspace/php-opencloud/v/stable.png)](https://packagist.org/packages/rackspace/php-opencloud) [![Travis CI](https://secure.travis-ci.org/rackspace/php-opencloud.png)](https://travis-ci.org/rackspace/php-opencloud) [![Total Downloads](https://poser.pugx.org/rackspace/php-opencloud/downloads.png)](https://packagist.org/packages/rackspace/php-opencloud)
-
-For SDKs in different languages, see http://developer.rackspace.com.
-
-The PHP SDK should work with most OpenStack-based cloud deployments,
-though it specifically targets the Rackspace public cloud. In
-general, whenever a Rackspace deployment is substantially different
-than a pure OpenStack one, a separate Rackspace subclass is provided
-so that you can still use the SDK with a pure OpenStack instance
-(for example, see the `OpenStack` class (for OpenStack) and the
-`Rackspace` subclass).
-
-Requirements
-------------
-* PHP >=5.3.3
-* cURL extension for PHP
-
-Installation
-------------
-You must install this library through Composer:
-
-```bash
-# Install Composer
-curl -sS https://getcomposer.org/installer | php
-
-# Require php-opencloud as a dependency
-php composer.phar require rackspace/php-opencloud
-```
-
-Once you have installed the library, you will need to load Composer's autoloader (which registers all the required
-namespaces):
-
-```php
-require 'vendor/autoload.php';
-```
-
-And you're ready to go!
-
-You can also check out the [Getting Started guide](docs/getting-started.md) for a quick tutorial.
-
-- - -
-
-Alternatively, if you would like to fork or clone the repository into a directory (to work and submit pull requests),
-you will need to execute:
-
-```bash
-php composer.phar install
-```
-
-Instead of the `require` command. You can also specify the `--no-dev` option if you do not want to install phpDocumentor
-(which has lots of vendor folders).
-
-Support and Feedback
---------------------
-Your feedback is appreciated! If you have specific problems or bugs with this SDK, please file an issue on Github. We
-also have a [mailing list](https://groups.google.com/forum/#!forum/php-opencloud), so feel free to join to keep up to
-date with all the latest changes and announcements to the library.
-
-For general feedback and support requests, send an email to sdk-support@rackspace.com.
-
-You can also find assistance via IRC on #rackspace at freenode.net.
-
-Contributing
-------------
-If you'd like to contribute to the project, or require help running the unit/acceptance tests, please view the
-[contributing guidelines](https://github.com/rackspace/php-opencloud/blob/master/CONTRIBUTING.md).

data/lib/psychic/commands/exec.rb

@@ -1,19 +0,0 @@
-module Psychic
-  module Commands
-    class Exec < Thor
-      desc 'task <name>', 'Executes a custom task by name'
-      def task(task_name)
-        # Psychic::Shell.shell = shell
-        runner = Psychic::Runner.new
-        result = runner.public_send(task_name.to_sym)
-        result.error!
-        say_status :success, task_name
-      rescue Psychic::Shell::ExecutionError => e
-        say_status :failed, task_name, :red
-        say e.execution_result if e.execution_result
-      end
-    end
-  end
-end
-
-Psychic::CLI.register(Psychic::Commands::Exec, 'exec', 'exec <task>', 'Execute things via psychic')