cf_script 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b3fcbadbf41b6e1480c5762c3f7552b438b4a15
-  data.tar.gz: 5674005bd8d20ad77fecadf0b0480226e955bbee
+  metadata.gz: fd6cd4eb945b6b74fff8b461e908883512e809bc
+  data.tar.gz: d549971b2a9657953ba7da7c28c6ee35a19a6953
 SHA512:
-  metadata.gz: d7ea902b29a98636d2bd71e7dad70b58aa35cdfd133f461ff93121c54afa2592fe2dc70a3d82f1fd1b858cbdfa11449ca7fd40d076fa9cdc4df29d22c9fda156
-  data.tar.gz: b82c13b445f07e7b92c9882404c9185d9931e25fb0c375eb0838d0cc62519a78f45db737b0c6b72e7376c92e974e919731875477f4c9c746901c16c7ed843076
+  metadata.gz: 1ed916530ac4a0260ef8919e30b8e6599de8df214ddcedb2ce468392a38c6b254e7922d0a9c8b98ba788e0acc13a1cf664340211af5ec94318a4d32c74a7285a
+  data.tar.gz: 9df684146a0a002d47d8150bcc5b9d450893260069f040c25a7021332fbdf8bc33c2ff290292fa66c134d6500819b4f0ea1a9a05481652c58c71d8585e4cd55f

data/.travis.yml

@@ -5,14 +5,13 @@ branches:
     - master
 
 before_script:
-  - wget http://go-cli.s3-website-us-east-1.amazonaws.com/releases/latest/cf-linux-amd64.tgz -O /tmp/cf-linux-amd64.tgz
-  - tar -xvf /tmp/cf-linux-amd64.tgz
+  - curl -o /tmp/cf-linux-64.tgz https://s3-us-west-1.amazonaws.com/cf-cli-releases/releases/v6.23.1/cf-cli_6.23.1_linux_x86-64.tgz
+  - tar -xvf /tmp/cf-linux-64.tgz
   - export PATH=$PATH:$PWD/
 
 rvm:
-  - '2.0.0'
-  - '2.1.8'
-  - '2.2.4'
-  - '2.3.0'
+  - '2.2.6'
+  - '2.3.3'
+  - '2.4.0'
 
 script: 'bundle exec rake test'

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+## [v0.0.1](https://github.com/ammar/cf_script/tree/v0.0.1) (2016-01-17)
+- Added `rename` and `delete` commands
+- One, simple, PTY-based executor
+- Echo `cf`'s output by default (`show_output` config option)
+- Correctly handle `push` with `--no-start`
+- _[Commits](https://github.com/ammar/cf_script/compare/v0.0.1.beta.1...v0.0.1)_
+
+## [v0.0.1.beta.1](https://github.com/ammar/cf_script/tree/v0.0.1.beta.1) (2016-01-01)
+- First beta release

data/README.md

@@ -35,19 +35,19 @@ TRACE=1 ruby example.rb
 ---
 ## Requirements
 
-* `ruby` >= 2.0
-* `cf` >= 16.0
+* `ruby` >= 2.2
+* `cf` >= 6.0
 
 ---
 ## Install
 
 Install the gem with:
 
-```gem install cf_script --pre```
+```gem install cf_script```
 
 Or, add it to your project's `Gemfile`:
 
-```gem 'cf_script', '0.0.1.beta.1'```
+```gem 'cf_script'```
 
 ---
 ## Execution Scopes
@@ -120,12 +120,12 @@ end
 
 The `app` method accepts a string or an AppInfo object as a name argument.
 
-## Command Methods
 
 ### The `apps` Method
 The `apps` method mirrors the `cf apps` command. When called without a block,
-it returns an AppList object that acts as an array of AppInfo objects, each
-of which contains the information in each row output by `cf apps`.
+it returns an [AppList](https://github.com/ammar/cf_script/blob/master/lib/cf_script/object/app_list.rb)
+object that acts as an array of [AppInfo](https://github.com/ammar/cf_script/blob/master/lib/cf_script/object/app_info.rb)
+objects, each of which contains the information in each row output by `cf apps`.
 
 ```ruby
 cf do
@@ -181,11 +181,13 @@ end
 |   restart                   | `cf restart APP_NAME`                                   | ✓ |
 |   push                      | `cf push APP_NAME [OPTIONS]`                            | ✓ |
 |   restage                   | `cf restage APP_NAME`                                   | ✓ |
+|   scale                     | `cf scale APP_NAME [OPTIONS]`                           | ✓ |
 |   rename                    | `cf rename APP_NAME NEW_APP_NAME`                       | ✓ |
 |   delete                    | `cf delete APP_NAME [-f -r]`                            | ✓ |
 |   env                       | `cf env APP_NAME`                                       | ✓ |
 |   set-env                   | `cf set-env APP_NAME VAR_NAME VAR_VALUE`                | ✓ |
 |   unset-env                 | `cf unset-env APP_NAME VAR_NAME`                        | ✓ |
+|   restart-app-instance      | `cf restart-app-instance APP_NAME INDEX`                | ✓ |
 | _**Routes**_                          |                                                         |          |
 |   routes                    | `cf routes`                                             | ✓ |
 |   check-route               | `cf check-route HOST DOMAIN`                            | ✓ |

data/lib/cf_script/command/base.rb

@@ -25,13 +25,17 @@ module CfScript::Command
       raise "run called in base command class"
     end
 
+    def option_value(options, key, default)
+      options.key?(key) ? options[key] : default
+    end
+
     def good_run?(output, options = {})
-      options[:check_status] = options.key?(:check_status) ? options[:check_status] : true
-      options[:check_failed] = options.key?(:check_failed) ? options[:check_failed] : true
+      options[:check_status] = option_value(options, :check_status, true)
+      options[:check_failed] = option_value(options, :check_failed, true)
 
       if options[:check_status] == true && !output.good?
         error 'cf exited with error'
-        output.dump
+        output.dump unless CfScript.config.runtime.echo_output
         return false
       end
 
@@ -47,7 +51,7 @@ module CfScript::Command
 
       if options[:check_failed] == true && output.failed?
         error 'FAILED'
-        output.dump
+        output.dump unless CfScript.config.runtime.echo_output
         return false
       end
 

data/lib/cf_script/command/cf/apps.rb

@@ -37,11 +37,13 @@ require 'cf_script/command/cf/apps/stop'
 require 'cf_script/command/cf/apps/restart'
 require 'cf_script/command/cf/apps/push'
 require 'cf_script/command/cf/apps/restage'
+require 'cf_script/command/cf/apps/scale'
 require 'cf_script/command/cf/apps/env'
 require 'cf_script/command/cf/apps/set_env'
 require 'cf_script/command/cf/apps/unset_env'
 require 'cf_script/command/cf/apps/rename'
 require 'cf_script/command/cf/apps/delete'
+require 'cf_script/command/cf/apps/restart_app_instance'
 
 module CfScript::Command::Apps
   CfScript::Command.register AppsCommand
@@ -51,9 +53,11 @@ module CfScript::Command::Apps
   CfScript::Command.register RestartCommand
   CfScript::Command.register PushCommand
   CfScript::Command.register RestageCommand
+  CfScript::Command.register ScaleCommand
   CfScript::Command.register EnvCommand
   CfScript::Command.register SetEnvCommand
   CfScript::Command.register UnsetEnvCommand
   CfScript::Command.register RenameCommand
   CfScript::Command.register DeleteCommand
+  CfScript::Command.register RestartAppInstanceCommand
 end

data/lib/cf_script/command/cf/apps/restart_app_instance.rb

@@ -0,0 +1,20 @@
+module CfScript::Command
+  class Apps::RestartAppInstanceCommand < CfScript::Command::Apps::Base
+    def initialize
+      super(:apps, :restart_app_instance)
+    end
+
+    def run(app_name, instance_index, &block)
+      run_cf self, app_name, instance_index do |output|
+        return false unless good_run?(output, check_failed: false)
+
+        if output.ok?
+          block_given? ? yield(true) : true
+        else
+          error "failed to restart app instance #{instance_index}"
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/cf_script/command/cf/apps/scale.rb

@@ -0,0 +1,39 @@
+module CfScript::Command
+  class Apps::ScaleCommand < CfScript::Command::Apps::Base
+    LONG_OPTIONS_MAP = {
+      force_restart:      :f,
+      instances:          :i,
+      disk:               :k,
+      memory:             :m,
+    }
+
+    def initialize
+      super(:apps, :scale)
+    end
+
+    def run(app_name, options = {}, &block)
+      run_cf self, app_name, translate_options(options) do |output|
+        return unless good_run?(output, check_failed: false)
+
+        if output.ok?
+          block_given? ? yield(true) : true
+        else
+          error "failed to scale app"
+          return false
+        end
+      end
+    end
+
+    def translate_options(options)
+      opts = options.dup
+
+      LONG_OPTIONS_MAP.each do |long, short|
+        if opts.key?(long)
+          opts[short] = opts.delete(long)
+        end
+      end
+
+      opts
+    end
+  end
+end

data/lib/cf_script/command/cf/routes/check_route.rb

@@ -8,7 +8,7 @@ module CfScript::Command
       run_cf self, host, domain do |output|
         return false unless good_run?(output)
 
-        exists = output.matches? /^Route #{host}.#{domain} does exist/
+        exists = output.matches?(/^Route #{host}.#{domain} does exist/)
 
         block_given? ? yield(exists) : exists
       end

data/lib/cf_script/command/cf/spaces/space.rb

@@ -22,7 +22,7 @@ module CfScript::Command
       attrs = output.attributes
 
       unless attrs.empty?
-        space = CfScript::Space.new(
+        CfScript::Space.new(
           space_name,
           attrs[:org].value,
           attrs[:apps].to_a,

data/lib/cf_script/command/registry.rb

@@ -10,7 +10,7 @@ module CfScript::Command
     end
 
     def catalog
-      catalog = Hash.new{ |types, type| types[type] = [] }
+      catalog = Hash.new { |types, type| types[type] = [] }
 
       commands.each do |name, command|
         catalog[command.type] << name

data/lib/cf_script/command/runner.rb

@@ -33,19 +33,21 @@ module CfScript::Command
     end
 
     def cf_path
+      @cf_path = nil unless defined? @cf_path
+
       unless @cf_path
         @cf_path = ENV['CF_BINARY'] || which_cf
 
         if @cf_path.nil? || @cf_path.empty?
           puts "Could not find the cf binary".colorize(:red)
           puts
-          puts "If it isn't installed you need to install it first. You can find"
-          puts "the latest release at:"
+          puts "If it isn't installed you need to install it first. You can "
+          puts "find the latest release at:"
           puts
           puts "  https://github.com/cloudfoundry/cli/releases".colorize(:cyan)
           puts
-          puts "If cf is already installed, make sure its location is included "
-          puts "in $PATH."
+          puts "If cf is already installed, make sure its location is "
+          puts "included in $PATH."
 
           raise "Could not find the cf binary"
         end

data/lib/cf_script/executor/simple.rb

@@ -14,7 +14,7 @@ class CfScript::Executor::Simple
           echo(line)
 					out << line
 				end
-			rescue Errno::EIO => e
+			rescue Errno::EIO
 				# Ignored
 			ensure
 				::Process.wait pid

data/lib/cf_script/object/app_info.rb

@@ -41,18 +41,18 @@ class CfScript::AppInfo
   alias :cold? :stopped?
 
   def update(attrs)
-    @requested_state = attrs[:requested_state].value if attrs.key?(:requested_state)
-    @instances       = attrs[:instances].value if attrs.key?(:instances)
+    @requested_state = attrs.key?(:requested_state) ? attrs[:requested_state].value : nil
+    @instances       = attrs.key?(:instances) ? attrs[:instances].value : nil
 
     @urls            = attrs.key?(:urls) ? attrs[:urls].to_a : []
 
-    @usage           = attrs[:usage].value if attrs.key?(:usage)
-    @last_uploaded   = attrs[:last_uploaded].value if attrs.key?(:last_uploaded)
-    @stack           = attrs[:stack].value if attrs.key?(:stack)
-    @buildpack       = attrs[:buildpack].value if attrs.key?(:buildpack)
+    @usage           = attrs.key?(:usage) ? attrs[:usage].value : nil
+    @last_uploaded   = attrs.key?(:last_uploaded) ? attrs[:last_uploaded].value : nil
+    @stack           = attrs.key?(:stack) ? attrs[:stack].value : nil
+    @buildpack       = attrs.key?(:buildpack) ? attrs[:buildpack].value : nil
 
-    @memory          = attrs[:memory].value if attrs.key?(:memory)
-    @disk            = attrs[:disk].value if attrs.key?(:disk)
+    @memory          = attrs.key?(:memory) ? attrs[:memory].value : nil
+    @disk            = attrs.key?(:disk) ? attrs[:disk].value :  nil
 
     if @memory.nil? and @usage
       @memory = @usage.split(' ').first

data/lib/cf_script/output/buffer.rb

@@ -46,7 +46,7 @@ module CfScript
     end
 
     def contains?(text)
-      matches? /#{text}/
+      matches?(/#{text}/)
     end
 
     def last_line_matches?(regexp)

data/lib/cf_script/output/parser/attributes.rb

@@ -9,7 +9,7 @@ module CfScript
 
         CfScript::Attribute.new(
           symbolize_name ? symbolize(name) : name,
-          Regexp.last_match['value'].strip
+          value
         )
       end
     end

data/lib/cf_script/output/tests.rb

@@ -9,11 +9,11 @@ module CfScript
     end
 
     def ok?
-      out.last_line_matches? /^OK$/
+      out.last_line_matches?(/^OK$/)
     end
 
     def authenticated?
-      matches? /Authenticating\.\.\.\nOK/m
+      matches?(/Authenticating\.\.\.\nOK/m)
     end
 
     def failed?
@@ -21,7 +21,7 @@ module CfScript
     end
 
     def no_api_endpoint?
-      contains? 'No API endpoint set.'
+      contains? 'No API endpoint set'
     end
 
     def not_logged_in?
@@ -37,15 +37,15 @@ module CfScript
     end
 
     def not_found?(type, name)
-      out.last_line_matches? /#{type} #{name} not found/
+      out.last_line_matches?(/#{type} #{name} not found/)
     end
 
     def is_already?(name, state)
-      out.last_line_matches? /#{name} is already #{state}/
+      out.last_line_matches?(/#{name} is already #{state}/)
     end
 
     def already_exists?(type, name)
-      out.last_line_matches? /#{type} #{name} already exists/
+      out.last_line_matches?(/#{type} #{name} already exists/)
     end
   end
 end

data/lib/cf_script/scope/app/state.rb

@@ -29,5 +29,17 @@ module CfScript::Scope
         @app_info = app_info if app_info
       end
     end
+
+    def scale(options)
+      CfScript::Command.scale name, options do |scaled|
+        cf_self
+      end
+    end
+
+    def restart_instance(index)
+      CfScript::Command.restart_app_instance name, index do |restarted|
+        cf_self
+      end
+    end
   end
 end

data/lib/cf_script/scope/script.rb

@@ -32,7 +32,7 @@ module CfScript::Scope
 
       # If api is given and there are no username or password, set the api
       if options[:api] and (options[:username].nil? or options[:password].nil?)
-        unless endpoint = CfScript::Command.api(options[:api])
+        unless CfScript::Command.api(options[:api])
           error :cf, "Could not set the API endpoint: #{options[:api]}"
           raise "Could not set the API endpoint: #{options[:api]}"
         end

data/lib/cf_script/version.rb

@@ -1,3 +1,3 @@
 module CfScript
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/test/fixtures/commands/apps/restart_app_instance/good.yml

@@ -0,0 +1,8 @@
+---
+stdout: |
+  Restarting instance 0 of application development-worker as user@example.com
+  OK
+
+stderr: ''
+status:
+  exitstatus: 0

data/test/fixtures/commands/apps/restart_app_instance/not_found.yml

@@ -0,0 +1,8 @@
+---
+stdout: |
+  FAILED
+  App bogus not found
+
+stderr: ''
+status:
+  exitstatus: 0

data/test/fixtures/commands/apps/scale/good.yml

@@ -0,0 +1,8 @@
+---
+stdout: |
+  Scaling app worker in org ACME / space development as user@example.com...
+  OK
+
+stderr: ''
+status:
+  exitstatus: 0

data/test/lib/cf_script/command/base_test.rb

@@ -1,21 +1,146 @@
 require 'test_helper'
 
 describe CfScript::Command::Base do
+  include MockExecution
+
   class TestCommand < CfScript::Command::Base
     def initialize
       super(:test, :dummy)
     end
   end
 
+  subject { TestCommand.instance }
+
   it "defines a line method that returns a Command::Line object" do
-    line = TestCommand.instance.line({}, 'cf', [])
+    line = subject.line({}, 'cf', [])
 
     assert_instance_of CfScript::Command::Line, line
   end
 
   it "raises an exception if run is called" do
     assert_raises(RuntimeError) {
-      TestCommand.instance.run
+      subject.run
     }
   end
+
+  describe "option_value" do
+    it "returns option value if present" do
+      options = { test: true }
+
+      result = subject.option_value(options, :test, false)
+
+      assert_equal true, result
+    end
+
+    it "returns default value if option is not present" do
+      options = {}
+
+      result = subject.option_value(options, :test, false)
+
+      assert_equal false, result
+    end
+  end
+
+  describe "good_run?" do
+    describe "exit status is zero" do
+      it "returns true" do
+        output = fake_output
+
+        assert_equal true, subject.good_run?(output)
+      end
+    end
+
+    describe "exit status is not zero" do
+      before { @output = fake_output('', '', 1) }
+
+      it "returns false" do
+        fake_io do |stdout, stderr|
+          assert_equal false, subject.good_run?(@output)
+        end
+      end
+
+      it "prints an error message" do
+        fake_io do |stdout, stderr|
+          subject.good_run?(@output)
+
+          assert_match(/\{dummy\}/, stderr.lines.last)
+          assert_match(/cf exited with error/, stderr.lines.last)
+        end
+      end
+
+      describe "and check_status is false" do
+        it "returns true" do
+          fake_io do |stdout, stderr|
+            result = subject.good_run?(@output, check_status: false)
+
+            assert_equal true, result
+          end
+        end
+
+        it "doesn't print an error message" do
+          fake_io do |stdout, stderr|
+            subject.good_run?(@output, check_status: false)
+
+            assert_equal 0, stderr.lines.length
+          end
+        end
+      end
+    end
+
+    describe "output contains FAILED" do
+      before { @output = fake_output('FAILED') }
+
+      it "returns false" do
+        fake_io do |stdout, stderr|
+          assert_equal false, subject.good_run?(@output)
+        end
+      end
+
+      it "returns true when check_failed is false" do
+        fake_io do |stdout, stderr|
+          result = subject.good_run?(@output, check_failed: false)
+
+          assert_equal true, result
+        end
+      end
+    end
+
+    describe "output contains 'No API endpoint set'" do
+      before { @output = fake_output('No API endpoint set') }
+
+      it "returns false" do
+        fake_io do |stdout, stderr|
+          assert_equal false, subject.good_run?(@output)
+        end
+      end
+
+      it "prints an error message" do
+        fake_io do |stdout, stderr|
+          subject.good_run?(@output)
+
+          assert_match(/\{dummy\}/, stderr.lines.last)
+          assert_match(/No API endpoint set/, stderr.lines.last)
+        end
+      end
+    end
+
+    describe "output contains 'Not logged in'" do
+      before { @output = fake_output('Not logged in') }
+
+      it "returns false" do
+        fake_io do |stdout, stderr|
+          assert_equal false, subject.good_run?(@output)
+        end
+      end
+
+      it "prints an error message" do
+        fake_io do |stdout, stderr|
+          subject.good_run?(@output)
+
+          assert_match(/\{dummy\}/, stderr.lines.last)
+          assert_match(/Not logged in/, stderr.lines.last)
+        end
+      end
+    end
+  end
 end