cf_script 0.0.1.beta.1 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 760492ef86eb59b8e5fdcb8275227fc8e8e884e4
-  data.tar.gz: 3d347022f374182c81c52cfaa69b24986a620406
+  metadata.gz: 3b3fcbadbf41b6e1480c5762c3f7552b438b4a15
+  data.tar.gz: 5674005bd8d20ad77fecadf0b0480226e955bbee
 SHA512:
-  metadata.gz: 1d430f863f77eebe4188a6891fb2e609abdc0e2e1a168920e23ac0f6ee50feee970ef3c9d16b7052011597977131a0c8c671b01df7e5d9a5f94036bbca9ae01a
-  data.tar.gz: 42a1de9c7fbd5d2cdee6affafa8c53862112057aaad50d0daaba59df433e7298b393ae0fd06b87e5c0f6ec301e417d96d8c02d6b5b5f4805f7cd797cd0f72bb1
+  metadata.gz: d7ea902b29a98636d2bd71e7dad70b58aa35cdfd133f461ff93121c54afa2592fe2dc70a3d82f1fd1b858cbdfa11449ca7fd40d076fa9cdc4df29d22c9fda156
+  data.tar.gz: b82c13b445f07e7b92c9882404c9185d9931e25fb0c375eb0838d0cc62519a78f45db737b0c6b72e7376c92e974e919731875477f4c9c746901c16c7ed843076

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+branches:
+  only:
+    - 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
+  - export PATH=$PATH:$PWD/
+
+rvm:
+  - '2.0.0'
+  - '2.1.8'
+  - '2.2.4'
+  - '2.3.0'
+
+script: 'bundle exec rake test'

data/README.md

@@ -1,23 +1,38 @@
 # CfScript
+[![Gem Version](https://img.shields.io/gem/v/cf_script.svg)](https://rubygems.org/gems/cf_script) [![Build Status](https://secure.travis-ci.org/ammar/cf_script.png?branch=master)](http://travis-ci.org/ammar/cf_script)
 
-CfScript is a DSL for scripting and automating the Cloud Foundry CLI.
+CfScript is a DSL for scripting the Cloud Foundry CLI, with a focus
+on application deployment and management. _[See Supported Commands](#supported-commands)_
 
 ```ruby
+# example.rb
 require 'cf_script'
 
-cf space: 'staging' do
+cf space: :development do
   workers = apps ending_with: 'worker'
 
   workers.each do |worker|
     app worker do
+      show :state, :memory, :instances
+
+      stop if started?
+
+      progress 'Setting ENV variable...'
       set_env 'SOME_NAME', 'SOME_VALUE'
 
-      restart if started?
+      progress "Restaging #{name} in #{current_space}..."
+      restage
     end
   end
 end
 ```
 
+To see the cf commands that get executed, run with TRACE=1.
+```
+TRACE=1 ruby example.rb
+```
+
+---
 ## Requirements
 
 * `ruby` >= 2.0
@@ -28,48 +43,161 @@ end
 
 Install the gem with:
 
-  `gem install cf_script --pre`
+```gem install cf_script --pre```
 
 Or, add it to your project's `Gemfile`:
 
-```gem 'cf_script', '0.1.0.pre'```
+```gem 'cf_script', '0.0.1.beta.1'```
 
 ---
+## Execution Scopes
+
+There are three execution scopes/blocks; `cf`, `space`, and `app`:
+
+### The `cf` Block Scope
+The `cf` scope is the top-level scope, it includes evertything between the
+`do/end` following a call to `cf`. The scope saves the current target on
+entry and restores it on exit.
+
+```ruby
+# cf target => staging
+
+cf space: :development do
+	# cf target => development
+end
+
+# cf target => staging
+```
+
+The `cf` block accepts the following options:
+
+- `api`: Sets the API endpoint _(optional)_
+- `org`: Sets the target organization _(optional)_
+- `username`/`password`: Credentials to use for logging in. _(optional)_
+- `space`: Sets the target space _(optional)_
+
+_**Note**: To save the current target the `cf` block will execute `cf target`
+on entry, and if it changed within the block, it wil execute `cf target SPACE`
+on exit to restore it._
 
+
+### The `space` Block Scope
+The `space` scope is a sub-scope and can only appear within a `cf` block. It
+also saves the current target on entry and restores, if changed, it on exit.
+
+```ruby
+# before cf block, target => staging
+
+cf space: :development do
+  # inside cf block, target => development
+
+  space :production do
+    # inside space block, target => production
+  end
+
+  # still inside cf block, target => development
+end
+
+# after cf block, target => staging
+```
+
+### The `app` Block Scope
+The `app` scope can appear within a `cf` or `space` blocks. Within the block
+the selected app is the target of commands, this means that commands that take
+an application name as their first argument can be called without it.
+
+```ruby
+cf do
+  app :api do
+    env.each do |name, value|
+      unset_env name
+    end
+
+    started? ? restart : start
+  end
+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`.
+
+```ruby
+cf do
+  # Get the list of AppInfo objects
+  space_apps = apps
+
+  # Iterate over the AppInfo objects
+  apps.each do |app_info|
+    # ...
+  end
+end
+```
+
+When the `apps` method is called with a block, it excutes the block within the
+context of each app.
+
+```ruby
+cf do
+  apps do
+    started? ? restart : start
+  end
+end
+```
+
+This is equivalent to:
+
+```ruby
+cf do
+  apps.each do |app_info|
+    app app_info do
+      started? ? restart : start
+    end
+  end
+end
+```
+
+---
 ## Supported Commands
 
 | Commands                              | CLI command                                             | ⋯ |
-| ------------------------------------- | ------------------------------------------------------- |:--------:|
-| **General**                           |                                                         | ⋱ |
-|   _**api**_                 | `cf api URL`                                            | ✓ |
-|   _**auth**_                | `cf auth USER PASSWORD`                                 | ✓ |
-|   _**login**_               | `cf login -u USER -p PASSWORD [OPTIONS]`                | ✓ |
-|   _**logout**_              | `cf logout`                                             | ✓ |
-|   _**target**_              | `cf target [-s SPACE -o ORG]`                           | ✓ |
-| **Applications**                      |                                                         | ⋱ |
-|   _**app**_                 | `cf app APP_NAME`                                       | ✓ |
-|   _**apps**_                | `cf apps`                                               | ✓ |
-|   _**start**_               | `cf start APP_NAME`                                     | ✓ |
-|   _**stop**_                | `cf stop APP_NAME`                                      | ✓ |
-|   _**restart**_             | `cf restart APP_NAME`                                   | ✓ |
-|   _**push**_                | `cf push [OPTIONS]`                                     | ✓ |
-|   _**restage**_             | `cf restage APP_NAME`                                   | ✓ |
-|   _**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`                        | ✓ |
-| **Routes**                            |                                                         | ⋱ |
-|   _**routes**_              | `cf routes`                                             | ✓ |
-|   _**check-route**_         | `cf check-route HOST DOMAIN`                            | ✓ |
-|   _**create-route**_        | `cf create-route SPACE DOMAIN [-n HOSTNAME]`            | ✓ |
-|   _**map-route**_           | `cf map-route APP_NAME DOMAIN [-n HOSTNAME]`            | ✓ |
-|   _**unmap-route**_         | `cf unmap-route APP_NAME DOMAIN [-n HOSTNAME]`          | ✓ |
-|   _**delete-route**_        | `cf delete-route DOMAIN [-n HOSTNAME] [-f]`             | ✓ |
-| **Spaces**                            |                                                         | ⋱ |
-|   _**space**_               | `cf space SPACE`                                        | ✓ |
-|   _**spaces**_              | `cf spaces`                                             | ✓ |
+|:--------------------------------------|:--------------------------------------------------------|:--------:|
+| _**General**_                         |                                                         |          |
+|   api                       | `cf api URL`                                            | ✓ |
+|   auth                      | `cf auth USER PASSWORD`                                 | ✓ |
+|   login                     | `cf login -u USER -p PASSWORD [OPTIONS]`                | ✓ |
+|   logout                    | `cf logout`                                             | ✓ |
+|   target                    | `cf target [-s SPACE -o ORG]`                           | ✓ |
+| _**Applications**_                    |                                                         |          |
+|   apps                      | `cf apps`                                               | ✓ |
+|   app                       | `cf app APP_NAME`                                       | ✓ |
+|   start                     | `cf start APP_NAME`                                     | ✓ |
+|   stop                      | `cf stop APP_NAME`                                      | ✓ |
+|   restart                   | `cf restart APP_NAME`                                   | ✓ |
+|   push                      | `cf push APP_NAME [OPTIONS]`                            | ✓ |
+|   restage                   | `cf restage APP_NAME`                                   | ✓ |
+|   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`                        | ✓ |
+| _**Routes**_                          |                                                         |          |
+|   routes                    | `cf routes`                                             | ✓ |
+|   check-route               | `cf check-route HOST DOMAIN`                            | ✓ |
+|   create-route              | `cf create-route SPACE DOMAIN [-n HOSTNAME]`            | ✓ |
+|   map-route                 | `cf map-route APP_NAME DOMAIN [-n HOSTNAME]`            | ✓ |
+|   unmap-route               | `cf unmap-route APP_NAME DOMAIN [-n HOSTNAME]`          | ✓ |
+|   delete-route              | `cf delete-route DOMAIN [-n HOSTNAME] [-f]`             | ✓ |
+| _**Spaces**_                          |                                                         |          |
+|   spaces                    | `cf spaces`                                             | ✓ |
+|   space                     | `cf space SPACE`                                        | ✓ |
 
 ---
-
 ## Building
 The project uses the standard rubygems package tasks, so:
 
@@ -82,3 +210,23 @@ To install the gem from the cloned project, run:
 ```
 rake install
 ```
+
+---
+## Known Problems/Limitations
+
+* Obviously everything depends on the output of `cf`, so if that changes
+  things will break. This is not unique to cf_script, but it is something
+  worth noting. The centralized parsing of `cf`'s output should reduce
+  the impact of change on scripts, but there is no guarantee.
+
+* The fixtures were collected manually and they might become a pain to
+  manage. Will investigate creating a tool/script that automates their
+  collection from `cf`.
+
+* I18N, n'existe pas, mais, it's not impossible. If implemented, it should
+  be based on the latest [translation files from the `cf` repository](https://github.com/cloudfoundry/cli/tree/master/cf/i18n/resources),
+  and the process of pulling the files automated. In the meantime, might
+  explicity add LANG to the ENV variables passed to `cf`.
+
+* Windows? No clues. Probably not without some changes.
+

data/Rakefile

@@ -18,16 +18,3 @@ Rake::TestTask.new('test') do |t|
   t.libs << "test"
   t.test_files = FileList['test/**/*.rb']
 end
-
-namespace :test do
-  %w{commands runner parser}.each do |component|
-    Rake::TestTask.new(component) do |t|
-      if t.respond_to?(:description)
-        t.description = "Run all #{component} unit tests under the test/#{component} directory"
-      end
-
-      t.libs << "test"
-      t.test_files = ["test/#{component}/**/*.rb"]
-    end
-  end
-end

data/lib/cf_script/command/base.rb

@@ -25,7 +25,7 @@ module CfScript::Command
       raise "run called in base command class"
     end
 
-    def can_run?(output, options = {})
+    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
 

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

@@ -6,7 +6,7 @@ module CfScript::Command
 
     def run(app_name, options = {}, &block)
       run_cf self, app_name do |output|
-        return nil unless can_run?(output)
+        return nil unless good_run?(output)
 
         if app_info = build_app_info(app_name, output)
           block_given? ? yield(app_info) : app_info

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

@@ -17,8 +17,10 @@ module CfScript::Command
 
     def run(options = {}, &block)
       run_cf self do |output|
-        return [] unless can_run?(output)
-        return [] if output.contains? NO_APPS_FOUND
+        blank_list = CfScript::AppList.new
+
+        return blank_list unless good_run?(output)
+        return blank_list if output.contains? NO_APPS_FOUND
 
         if rows = output.table(APPS_TABLE)
           list = build_app_list(rows)
@@ -26,7 +28,7 @@ module CfScript::Command
           block_given? ? yield(list) : list
         else
           error 'rows is nil'
-          return []
+          return blank_list
         end
       end
     end

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

@@ -0,0 +1,25 @@
+module CfScript::Command
+  class Apps::DeleteCommand < CfScript::Command::Base
+    def initialize
+      super(:apps, :delete)
+    end
+
+    def run(app_name, force = false, delete_routes = false, &block)
+      options = { flags: [] }
+
+      options[:flags] << :f if force
+      options[:flags] << :r if delete_routes
+
+      run_cf self, app_name, options do |output|
+        return false unless good_run?(output)
+
+        if output.ok?
+          block_given? ? yield(true) : true
+        else
+          error "failed to delete app"
+          return false
+        end
+      end
+    end
+  end
+end

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

@@ -6,12 +6,14 @@ module CfScript::Command
 
     def run(app_name, &block)
       run_cf self, app_name do |output|
-        return {} unless can_run?(output)
+        return {} unless good_run?(output)
 
         if vars = output.section_attributes('User-Provided')
           block_given? ? yield(vars.to_h) : vars.to_h
+        elsif output.contains?('No user-defined env variables have been set')
+          return {}
         else
-          error 'vars is nil'
+          error 'could not get environment variables'
           return {}
         end
       end

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

@@ -22,9 +22,14 @@ module CfScript::Command
 
     def run(app_name, options = {}, &block)
       run_cf self, app_name, translate_options(options.dup) do |output|
-        return unless can_run?(output, check_failed: false)
+        return unless good_run?(output, check_failed: false)
 
-        if app = build_app_info(app_name, output)
+        no_start = options.key?(:flags) &&
+                   options[:flags].include?(:no_start)
+
+        if no_start && output.ok?
+          return true
+        elsif app = build_app_info(app_name, output)
           block_given? ? yield(app) : app
         else
           error "app is nil"

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

@@ -0,0 +1,20 @@
+module CfScript::Command
+  class Apps::RenameCommand < CfScript::Command::Base
+    def initialize
+      super(:apps, :rename)
+    end
+
+    def run(old_name, new_name, &block)
+      run_cf self, old_name, new_name do |output|
+        return false unless good_run?(output, check_failed: false)
+
+        if output.ok?
+          block_given? ? yield(true) : true
+        else
+          error "failed to rename app"
+          return false
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module CfScript::Command
 
     def run(app_name, &block)
       run_cf self, app_name do |output|
-        return unless can_run?(output)
+        return unless good_run?(output)
 
         if app = build_app_info(app_name, output)
           block_given? ? yield(app) : app

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

@@ -6,7 +6,7 @@ module CfScript::Command
 
     def run(app_name, &block)
       run_cf self, app_name do |output|
-        return unless can_run?(output)
+        return unless good_run?(output)
 
         if app = build_app_info(app_name, output)
           block_given? ? yield(app) : app

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

@@ -6,7 +6,7 @@ module CfScript::Command
 
     def run(app_name, var_name, var_value, &block)
       run_cf self, app_name, var_name, var_value do |output|
-        return false unless can_run?(output)
+        return false unless good_run?(output)
 
         return true if output.contains?("\nOK\n")
 

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

@@ -6,7 +6,7 @@ module CfScript::Command
 
     def run(app_name, &block)
       run_cf self, app_name do |output|
-        return unless can_run?(output)
+        return unless good_run?(output)
 
         if app = build_app_info(app_name, output)
           block_given? ? yield(app) : app

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

@@ -6,12 +6,13 @@ module CfScript::Command
 
     def run(app_name, &block)
       run_cf self, app_name do |output|
-        return false unless can_run?(output, check_failed: false)
+        return false unless good_run?(output, check_failed: false)
 
         if output.ok?
           block_given? ? yield(true) : true
         else
-          error "failed to stop"
+          error "failed to stop app"
+          return false
         end
       end
     end

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

@@ -6,7 +6,7 @@ module CfScript::Command
 
     def run(app_name, var_name, &block)
       run_cf self, app_name, var_name do |output|
-        return false unless can_run?(output)
+        return false unless good_run?(output)
 
         return true if output.contains?("\nOK\n")
 

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

@@ -17,7 +17,7 @@ module CfScript::Command
         'Showing health and status for app'
       )
 
-      if attributes
+      unless attributes.empty?
         app = CfScript::AppInfo.new(app_name, attributes)
 
         if rows = output.table(INSTANCE_STATUS_TABLE)
@@ -40,6 +40,8 @@ require 'cf_script/command/cf/apps/restage'
 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'
 
 module CfScript::Command::Apps
   CfScript::Command.register AppsCommand
@@ -52,4 +54,6 @@ module CfScript::Command::Apps
   CfScript::Command.register EnvCommand
   CfScript::Command.register SetEnvCommand
   CfScript::Command.register UnsetEnvCommand
+  CfScript::Command.register RenameCommand
+  CfScript::Command.register DeleteCommand
 end

data/lib/cf_script/command/cf/general/api.rb

@@ -10,7 +10,7 @@ module CfScript::Command::General
 
     def run(url = nil, &block)
       run_cf self, url do |output|
-        return unless can_run?(output)
+        return unless good_run?(output)
 
         if output.contains? API_NOT_SET
           error API_NOT_SET

data/lib/cf_script/command/cf/general/auth.rb

@@ -6,7 +6,7 @@ module CfScript::Command::General
 
     def run(username, password, &block)
       run_cf self, username, password do |output|
-        unless can_run?(output, check_failed: false)
+        unless good_run?(output, check_failed: false)
           if output.credentials_rejected?
             error 'Credentials were rejected'
           else

data/lib/cf_script/command/cf/general/login.rb

@@ -20,7 +20,7 @@ module CfScript::Command::General
       end
 
       run_cf self, *args do |output|
-        unless can_run?(output, check_failed: false)
+        unless good_run?(output, check_failed: false)
           if output.credentials_rejected?
             error 'Credentials were rejected'
           else

data/lib/cf_script/command/cf/general/logout.rb

@@ -6,7 +6,7 @@ module CfScript::Command::General
 
     def run(*args, &block)
       run_cf self, *args do |output|
-        return false unless can_run?(output)
+        return false unless good_run?(output)
 
         block_given? ? yield(output.ok?) : output.ok?
       end

data/lib/cf_script/command/cf/general/target.rb

@@ -11,7 +11,7 @@ module CfScript::Command
       space = args.first && args.first.key?(:s) ? args.first[:s] : ''
 
       run_cf self, *args do |output|
-        return nil unless can_run?(output, check_failed: false)
+        return nil unless good_run?(output, check_failed: false)
 
         # TODO: check org not found too
 

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

@@ -6,7 +6,7 @@ module CfScript::Command
 
     def run(host, domain, &block)
       run_cf self, host, domain do |output|
-        return false unless can_run?(output)
+        return false unless good_run?(output)
 
         exists = output.matches? /^Route #{host}.#{domain} does exist/
 

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

@@ -8,7 +8,7 @@ module CfScript::Command
       options = host ? { n: host } : {}
 
       run_cf self, space, domain, options do |output|
-        return false unless can_run?(output)
+        return false unless good_run?(output)
 
         if exists = output.contains?(/^OK$/)
           block_given? ? yield(exists) : exists

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

@@ -5,10 +5,13 @@ module CfScript::Command
     end
 
     def run(domain, host = nil, force = true, &block)
-      options = host ? { n: host, flags: [:f] } : { flags: [:f] }
+      options = {}
+
+      options[:n] = host if host
+      options[:flags] = [:f] if force
 
       run_cf self, domain, options do |output|
-        return false unless can_run?(output)
+        return false unless good_run?(output)
 
         if deleted = output.ok?
           block_given? ? yield(deleted) : deleted

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

@@ -8,7 +8,7 @@ module CfScript::Command
       options = host ? { n: host } : {}
 
       run_cf self, app_name, domain, options do |output|
-        return false unless can_run?(output,
+        return false unless good_run?(output,
           check_status: false,
           check_failed: false,
         )

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

@@ -8,7 +8,7 @@ module CfScript::Command
 
     def run(*args, &block)
       run_cf self do |output|
-        return unless can_run?(output)
+        return unless good_run?(output)
 
         if rows = output.table(ROUTES_TABLE)
           routes = build_route_info(rows)

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

@@ -8,7 +8,7 @@ module CfScript::Command
       options = host ? { n: host } : {}
 
       run_cf self, app_name, domain, options do |output|
-        return false unless can_run?(output,
+        return false unless good_run?(output,
           check_status: false,
           check_failed: false,
         )

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

@@ -6,7 +6,7 @@ module CfScript::Command
 
     def run(space_name, &block)
       run_cf self, space_name do |output|
-        return unless can_run?(output)
+        return unless good_run?(output)
 
         if space = build_space(space_name, output)
           block_given? ? yield(space) : space