cf_script 0.0.1.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 760492ef86eb59b8e5fdcb8275227fc8e8e884e4
+  data.tar.gz: 3d347022f374182c81c52cfaa69b24986a620406
+SHA512:
+  metadata.gz: 1d430f863f77eebe4188a6891fb2e609abdc0e2e1a168920e23ac0f6ee50feee970ef3c9d16b7052011597977131a0c8c671b01df7e5d9a5f94036bbca9ae01a
+  data.tar.gz: 42a1de9c7fbd5d2cdee6affafa8c53862112057aaad50d0daaba59df433e7298b393ae0fd06b87e5c0f6ec301e417d96d8c02d6b5b5f4805f7cd797cd0f72bb1

data/.gitignore

@@ -0,0 +1,15 @@
+*.DS_Store
+*.swp
+
+.env
+.ruby-version
+.editorconfig
+
+Gemfile.lock
+
+pkg/*
+coverage/
+.bundle/*
+vendor/
+
+sandbox/

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'rake'
+  gem 'minitest'
+  gem 'minitest-focus'
+end
+
+gem 'simplecov', require: false, group: :test

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010, 2015-2016,  Ammar Ali
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# CfScript
+
+CfScript is a DSL for scripting and automating the Cloud Foundry CLI.
+
+```ruby
+require 'cf_script'
+
+cf space: 'staging' do
+  workers = apps ending_with: 'worker'
+
+  workers.each do |worker|
+    app worker do
+      set_env 'SOME_NAME', 'SOME_VALUE'
+
+      restart if started?
+    end
+  end
+end
+```
+
+## Requirements
+
+* `ruby` >= 2.0
+* `cf` >= 16.0
+
+---
+## Install
+
+Install the gem with:
+
+  `gem install cf_script --pre`
+
+Or, add it to your project's `Gemfile`:
+
+```gem 'cf_script', '0.1.0.pre'```
+
+---
+
+## 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`                                             | ✓ |
+
+---
+
+## Building
+The project uses the standard rubygems package tasks, so:
+
+To build your cloned copy of the gem, run:
+```
+rake build
+```
+
+To install the gem from the cloned project, run:
+```
+rake install
+```

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+
+require 'rake'
+require 'rake/testtask'
+
+require 'bundler'
+require 'rubygems/package_task'
+
+Bundler::GemHelper.install_tasks
+
+task :default => [:test]
+
+Rake::TestTask.new('test') do |t|
+  if t.respond_to?(:description)
+    t.description = "Run all unit tests under the test directory"
+  end
+
+  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/cf_script.gemspec

@@ -0,0 +1,34 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'cf_script/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'cf_script'
+  gem.version       = ::CfScript::VERSION
+
+  gem.summary       = 'A DSL for scripting the Cloud Foundry CLI'
+  gem.description   = ''
+  gem.homepage      = 'http://github.com/ammar/cf_script'
+
+  if gem.respond_to?(:metadata)
+    gem.metadata    = { 'issue_tracker' => 'https://github.com/ammar/cf_script/issues' }
+  end
+
+  gem.authors       = ['Ammar Ali']
+  gem.email         = ['ammar@syntax.ps']
+
+  gem.license       = 'MIT'
+
+  gem.require_paths = ['lib']
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = Dir.glob('test/**/*.rb')
+
+  gem.rdoc_options  = ["--inline-source", "--charset=UTF-8"]
+
+  gem.platform      = Gem::Platform::RUBY
+
+  gem.required_ruby_version = '>= 2.0.0'
+
+  gem.add_dependency('colorize', '>= 0.7.7')
+end

data/lib/cf_script/callbacks.rb

@@ -0,0 +1,43 @@
+module CfScript::Callbacks
+  def callbacks
+    @callbacks ||= { before: {}, after: {} }
+  end
+
+  def before(step, &block)
+    callbacks[:before][step] ||= []
+    callbacks[:before][step] << block
+  end
+
+  def after(step, &block)
+    callbacks[:after][step] ||= []
+    callbacks[:after][step] << block
+  end
+
+  def callbacks_for(type, step)
+    return [] unless callbacks.key?(type) && callbacks[type].key?(step)
+
+    callbacks[type][step]
+  end
+
+  def run_callbacks(type, step)
+    return unless callbacks[type].key?(step)
+
+    callbacks[type][step].each do |callback|
+      instance_eval(&callback)
+    end
+  end
+
+  def run_before(step)
+    run_callbacks(:before, step)
+  end
+
+  def run_after(step)
+    run_callbacks(:after, step)
+  end
+
+  def run_around(step, &block)
+    run_before(step)
+    yield
+    run_after(step)
+  end
+end

data/lib/cf_script/command/base.rb

@@ -0,0 +1,57 @@
+require 'singleton'
+
+module CfScript::Command
+  class Base
+    include ::Singleton
+
+    attr_reader :type
+    attr_reader :name
+
+    include CfScript::Command::Runner
+
+    include CfScript::UI
+    include CfScript::UI::NameTag
+
+    def initialize(type, name)
+      @type = type
+      @name = name
+    end
+
+    def line(env, bin, args)
+      Line.new(env, bin, type, name, args)
+    end
+
+    def run(*args, &block)
+      raise "run called in base command class"
+    end
+
+    def can_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
+
+      if options[:check_status] == true && !output.good?
+        error 'cf exited with error'
+        output.dump
+        return false
+      end
+
+      if output.no_api_endpoint?
+        error "No API endpoint set"
+        return false
+      end
+
+      if output.not_logged_in?
+        error 'Not logged in'
+        return false
+      end
+
+      if options[:check_failed] == true && output.failed?
+        error 'FAILED'
+        output.dump
+        return false
+      end
+
+      true
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module CfScript::Command
+  class Apps::AppCommand < CfScript::Command::Apps::Base
+    def initialize
+      super(:apps, :app)
+    end
+
+    def run(app_name, options = {}, &block)
+      run_cf self, app_name do |output|
+        return nil unless can_run?(output)
+
+        if app_info = build_app_info(app_name, output)
+          block_given? ? yield(app_info) : app_info
+        else
+          error 'attributes is nil'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module CfScript::Command
+  class Apps::AppsCommand < CfScript::Command::Base
+    NO_APPS_FOUND = 'No apps found'
+
+    APPS_TABLE = [
+      'name',
+      'requested state',
+      'instances',
+      'memory',
+      'disk',
+      'urls'
+    ]
+
+    def initialize
+      super(:apps, :apps)
+    end
+
+    def run(options = {}, &block)
+      run_cf self do |output|
+        return [] unless can_run?(output)
+        return [] if output.contains? NO_APPS_FOUND
+
+        if rows = output.table(APPS_TABLE)
+          list = build_app_list(rows)
+
+          block_given? ? yield(list) : list
+        else
+          error 'rows is nil'
+          return []
+        end
+      end
+    end
+
+    private
+
+    def build_app_list(rows)
+      apps = rows.map do |row|
+        CfScript::AppInfo.new(row[:name].value, row)
+      end
+
+      CfScript::AppList.new(apps)
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module CfScript::Command
+  class Apps::EnvCommand < CfScript::Command::Base
+    def initialize
+      super(:apps, :env)
+    end
+
+    def run(app_name, &block)
+      run_cf self, app_name do |output|
+        return {} unless can_run?(output)
+
+        if vars = output.section_attributes('User-Provided')
+          block_given? ? yield(vars.to_h) : vars.to_h
+        else
+          error 'vars is nil'
+          return {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module CfScript::Command
+  class Apps::PushCommand < CfScript::Command::Apps::Base
+    LONG_OPTIONS_MAP = {
+      manifest:           :f,
+      instances:          :i,
+      memory:             :m,
+      command:            :c,
+      buildpack:          :b,
+      hostname:           :n,
+      domain:             :d,
+      disk:               :k,
+      path:               :p,
+      stack:              :s,
+      timeout:            :t,
+      docker_image:       :o,
+      health_check_type:  :u,
+    }
+
+    def initialize
+      super(:apps, :push)
+    end
+
+    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)
+
+        if app = build_app_info(app_name, output)
+          block_given? ? yield(app) : app
+        else
+          error "app is nil"
+        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/apps/restage.rb

@@ -0,0 +1,19 @@
+module CfScript::Command
+  class Apps::RestageCommand < CfScript::Command::Apps::Base
+    def initialize
+      super(:apps, :restage)
+    end
+
+    def run(app_name, &block)
+      run_cf self, app_name do |output|
+        return unless can_run?(output)
+
+        if app = build_app_info(app_name, output)
+          block_given? ? yield(app) : app
+        else
+          error "app is nil"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module CfScript::Command
+  class Apps::RestartCommand < CfScript::Command::Apps::Base
+    def initialize
+      super(:apps, :restart)
+    end
+
+    def run(app_name, &block)
+      run_cf self, app_name do |output|
+        return unless can_run?(output)
+
+        if app = build_app_info(app_name, output)
+          block_given? ? yield(app) : app
+        else
+          error "app is nil"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module CfScript::Command
+  class Apps::SetEnvCommand < CfScript::Command::Base
+    def initialize
+      super(:apps, :set_env)
+    end
+
+    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 true if output.contains?("\nOK\n")
+
+        error 'Could not set env variable'
+        return false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module CfScript::Command
+  class Apps::StartCommand < CfScript::Command::Apps::Base
+    def initialize
+      super(:apps, :start)
+    end
+
+    def run(app_name, &block)
+      run_cf self, app_name do |output|
+        return unless can_run?(output)
+
+        if app = build_app_info(app_name, output)
+          block_given? ? yield(app) : app
+        else
+          error "app is nil"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module CfScript::Command
+  class Apps::StopCommand < CfScript::Command::Base
+    def initialize
+      super(:apps, :stop)
+    end
+
+    def run(app_name, &block)
+      run_cf self, app_name do |output|
+        return false unless can_run?(output, check_failed: false)
+
+        if output.ok?
+          block_given? ? yield(true) : true
+        else
+          error "failed to stop"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module CfScript::Command
+  class Apps::UnsetEnvCommand < CfScript::Command::Base
+    def initialize
+      super(:apps, :unset_env)
+    end
+
+    def run(app_name, var_name, &block)
+      run_cf self, app_name, var_name do |output|
+        return false unless can_run?(output)
+
+        return true if output.contains?("\nOK\n")
+
+        error 'Could not unset env variable'
+        return false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+CfScript::Command.const_set(:Apps, Module.new)
+
+module CfScript::Command
+  class Apps::Base < CfScript::Command::Base
+    INSTANCE_STATUS_TABLE = [
+      '',
+      'state',
+      'since',
+      'cpu',
+      'memory',
+      'disk',
+      'details'
+    ]
+
+    def build_app_info(app_name, output)
+      attributes = output.attributes_from(
+        'Showing health and status for app'
+      )
+
+      if attributes
+        app = CfScript::AppInfo.new(app_name, attributes)
+
+        if rows = output.table(INSTANCE_STATUS_TABLE)
+          app.set_instance_status rows
+        end
+
+        app
+      end
+    end
+  end
+end
+
+require 'cf_script/command/cf/apps/apps'
+require 'cf_script/command/cf/apps/app'
+require 'cf_script/command/cf/apps/start'
+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/env'
+require 'cf_script/command/cf/apps/set_env'
+require 'cf_script/command/cf/apps/unset_env'
+
+module CfScript::Command::Apps
+  CfScript::Command.register AppsCommand
+  CfScript::Command.register AppCommand
+  CfScript::Command.register StartCommand
+  CfScript::Command.register StopCommand
+  CfScript::Command.register RestartCommand
+  CfScript::Command.register PushCommand
+  CfScript::Command.register RestageCommand
+  CfScript::Command.register EnvCommand
+  CfScript::Command.register SetEnvCommand
+  CfScript::Command.register UnsetEnvCommand
+end

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

@@ -0,0 +1,36 @@
+module CfScript::Command::General
+  class ApiCommand < CfScript::Command::Base
+    API_NOT_SET = 'No api endpoint set'
+
+    API_ENDPOINT_REGEX = %r|API endpoint:\s+(?<url>https?://[\S]+)\s+\(API version:\s+(?<version>[^)]+)\)|
+
+    def initialize
+      super(:general, :api)
+    end
+
+    def run(url = nil, &block)
+      run_cf self, url do |output|
+        return unless can_run?(output)
+
+        if output.contains? API_NOT_SET
+          error API_NOT_SET
+        else
+          build_endpoint(output)
+        end
+      end
+    end
+
+    private
+
+    def build_endpoint(output)
+      attrs = output.line_attributes API_ENDPOINT_REGEX
+
+      unless attrs.nil? or attrs.empty?
+        CfScript::ApiEndpoint.new(
+          attrs[:url].value,
+          attrs[:version].value
+        )
+      end
+    end
+  end
+end