cf 4.0.1.rc2 → 4.1.0rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f7db873a3433f6a41a5b6b2373560e6638651e2
+  data.tar.gz: ee5511a3f2188b76047fe98e7d5b40de804e36da
+SHA512:
+  metadata.gz: e587cae8a1feef4fc85c5ab0f691449d692376c5c16ebe587a75afa3cdd4deed45227cdda180947d7103d431dd35eb068ac8e3ceaa4891d3e5222be6cac61a56
+  data.tar.gz: 1f6e73117e955a892551126c3c52069a9856e8d5aa2ce2e122fc061d6cc66d6f2bd65d253956671f6780cb898c347e2ca1a90289021df2453b59805130ccd60f

data/Rakefile

@@ -1,5 +1,6 @@
 require "rake"
 require "rspec/core/rake_task"
+Dir.glob("lib/tasks/**/*").sort.each { |ext| load(ext) }
 
 specfile, _ = Dir["*.gemspec"]
 SPEC = Gem::Specification.load(specfile)

data/lib/cf.rb

@@ -11,3 +11,4 @@ require "admin/plugin"
 require "console/plugin"
 require "tunnel/plugin"
 require "manifests/plugin"
+require "micro/plugin"

data/lib/cf/cli.rb

@@ -14,6 +14,7 @@ require "cf/spacing"
 
 require "cf/cli/help"
 require "cf/cli/interactive"
+require "cf/cli/login_requirements"
 
 
 $cf_asked_auth = false
@@ -72,6 +73,7 @@ module CF
     end
 
     def check_logged_in
+      check_target
       unless client.logged_in?
         if force?
           fail "Please log in with 'cf login'."
@@ -84,17 +86,42 @@ module CF
       end
     end
 
-    def precondition
-      check_target
-      check_logged_in
+    desc "Help!"
+    input :command, :argument => :optional
+    input :all, :type => :boolean
+    def help
+      if name = input[:command]
+        if cmd = @@commands[name.gsub("-", "_").to_sym]
+          Mothership::Help.command_help(cmd)
+        else
+          unknown_command(name)
+        end
+      elsif Help.has_groups?
+        unless input[:all]
+          puts "#{help_header}"
+        end
 
-      unless client.current_organization
-        fail "Please select an organization with 'cf target --organization ORGANIZATION_NAME'. (Get organization names from 'cf orgs'.)"
+        Mothership::Help.print_help_groups(@@global, input[:all])
+      else
+        Mothership::Help.basic_help(@@commands, @@global)
       end
+    end
 
-      unless client.current_space
-        fail "Please select a space with 'cf target --space SPACE_NAME'. (Get space names from 'cf spaces'.)"
-      end
+    def help_header
+    <<EOS
+Cloud Foundry Command Line Interface, version [#{CF::VERSION}]
+Showing basic commands. Use 'cf help --all' to list all commands, or
+'cf help [command]' for help detailed help on a command.
+
+For docs and support visit http://support.cloudfoundry.com
+
+USAGE EXAMPLES
+  $ cf target api.run.pivotal.io    <-- sets target API endpoint (the CF instance where you want to push apps) to 'api.run.pivotal.io'
+  $ cf login                        <-- logs into currently targeted CF instance, will also prompt for target org and app space
+  $ cf push                         <-- deploys app to current target
+  $ cf target -s staging            <-- changes currently targeted app space to 'staging'
+
+EOS
     end
 
     def wrap_errors
@@ -160,7 +187,7 @@ module CF
       else
         wrap_errors do
           @command = cmd
-          precondition
+          precondition if respond_to? :precondition
 
           save_token_if_it_changes do
             super

data/lib/cf/cli/app/base.rb

@@ -3,6 +3,8 @@ require "cf/cli"
 module CF
   module App
     class Base < CLI
+      include LoginRequirements
+
       # choose the right color for app/instance state
       def state_color(s)
         case s

data/lib/cf/cli/domain/base.rb

@@ -3,6 +3,7 @@ require "cf/cli"
 module CF
   module Domain
     class Base < CLI
+      include LoginRequirements
     end
   end
 end

data/lib/cf/cli/login_requirements.rb

@@ -0,0 +1,13 @@
+module LoginRequirements
+  def precondition
+    check_logged_in
+
+    unless client.current_organization
+      fail "Please select an organization with 'cf target --organization ORGANIZATION_NAME'. (Get organization names from 'cf orgs'.)"
+    end
+
+    unless client.current_space
+      fail "Please select a space with 'cf target --space SPACE_NAME'. (Get space names from 'cf spaces'.)"
+    end
+  end
+end

data/lib/cf/cli/populators/base.rb

@@ -3,6 +3,8 @@ require "cf/cli"
 module CF
   module Populators
     class Base < CF::CLI
+      include LoginRequirements
+
       attr_reader :input, :info
 
       def initialize(input)

data/lib/cf/cli/route/base.rb

@@ -3,6 +3,7 @@ require "cf/cli"
 module CF
   module Route
     class Base < CLI
+      include LoginRequirements
     end
   end
 end

data/lib/cf/cli/route/map.rb

@@ -2,8 +2,6 @@ require "cf/cli/route/base"
 
 module CF::Route
   class Map < Base
-    def precondition; end
-
     desc "Add a URL mapping"
     group :apps, :info, :hidden => true
     input :app, :desc => "Application to add the URL to",

data/lib/cf/cli/service/base.rb

@@ -3,6 +3,7 @@ require "cf/cli"
 module CF
   module Service
     class Base < CLI
+      include LoginRequirements
     end
   end
 end

data/lib/cf/cli/start/base.rb

@@ -3,6 +3,7 @@ require "cf/cli"
 module CF
   module Start
     class Base < CLI
+
       # Make sure we only show the target once
       @@displayed_target = false
 
@@ -10,11 +11,6 @@ module CF
         @@displayed_target
       end
 
-
-      # These commands don't require authentication.
-      def precondition;
-      end
-
       private
 
       def show_context

data/lib/cf/version.rb

@@ -1,3 +1,3 @@
 module CF
-  VERSION = "4.0.1.rc2".freeze
+  VERSION = "4.1.0rc1".freeze
 end

data/lib/manifests/manifests.rb

@@ -7,32 +7,21 @@ module CFManifests
   MANIFEST_FILE = "manifest.yml"
 
   @@showed_manifest_usage = false
-  
-  class BadManifestError < StandardError
-
-    def initialize(attr)
-      @attr = attr
-    end
-
-    def to_s
-      "#{@attr} is not a valid attribute, please visit the Manifest " + 
-      "Documentation for a list of valid attributes." 
-    end
-  end
+  @@manifest = nil
 
   def manifest
-    return @manifest if @manifest
+    return @@manifest if @@manifest
 
     if manifest_file && File.exists?(manifest_file)
-      @manifest = load_manifest(manifest_file)
+      @@manifest = load_manifest(manifest_file)
     end
   end
 
   def save_manifest(save_to = manifest_file)
-    fail "No manifest to save!" unless @manifest
+    fail "No manifest to save!" unless @@manifest
 
     File.open(save_to, "w") do |io|
-      YAML.dump(@manifest, io)
+      YAML.dump(@@manifest, io)
     end
   end
 
@@ -64,22 +53,27 @@ module CFManifests
   def load_manifest(file)
     check_manifest! Loader.new(file, self).manifest
   end
-  
-  def check_manifest!(manifest_hash)
-    manifest_hash[:applications].each{|app| check_attributes! app} 
+
+  def check_manifest!(manifest_hash, output = $stdout)
+    manifest_hash[:applications].each{ |app| check_attributes!(app, output) }
     manifest_hash
   end
-  
-  def check_attributes!(app)
+
+  def check_attributes!(app, output = $stdout)
     app.each do |k, v|
-      raise BadManifestError.new(k) unless known_manifest_attributes.include? k 
-    end  
+      output.puts error_message_for_attribute(k) unless known_manifest_attributes.include? k
+    end
+  end
+
+  def error_message_for_attribute(attribute)
+    "\e[31mWarning: #{attribute} is not a valid manifest attribute. Please " +
+    "remove this attribute from your manifest to get rid of this warning\e[0m"
   end
 
   def known_manifest_attributes
-    [:path, :name, :memory, :instances, :host, :domain, 
-     :command, :buildpack, :services, :env, :properties, 
-     :inherit, :mem, :disk, :runtime, :applications]
+    [:applications, :buildpack, :command, :disk, :domain, :env,
+     :host, :inherit, :instances, :mem, :memory, :name,
+     :path, :properties, :runtime, :services, :stack]
   end
 
   # dynamic symbol resolution

data/lib/micro/README.md

@@ -0,0 +1,25 @@
+[![Build Status](https://travis-ci.org/cloudfoundry/micro-cf-plugin.png)](https://travis-ci.org/cloudfoundry/micro-cf-plugin)
+[![Gem Version](https://badge.fury.io/rb/micro-cf-plugin.png)](http://badge.fury.io/rb/micro-cf-plugin)
+
+## Micro Cloud Foundry
+### Info
+This plugin allows you to manage your Micro Cloud Foundry VM.
+
+### Installation
+
+If you have installed CF via gem install, use:
+```
+gem install micro-cf-plugin
+```
+
+If you have installed CF through bundler and the Gemfile, add the following to your Gemfile:
+```
+gem "micro-cf-plugin"
+```
+
+### Usage
+```
+micro-status VMX [PASSWORD]   Display Micro Cloud Foundry VM status
+micro-offline VMX [PASSWORD]	Micro Cloud Foundry offline mode
+micro-online VMX [PASSWORD] 	Micro Cloud Foundry online mode
+```

data/lib/micro/errors.rb

@@ -0,0 +1,4 @@
+module CFMicro
+  class MCFError < RuntimeError
+  end
+end

data/lib/micro/micro.rb

@@ -0,0 +1,56 @@
+require 'find'
+require "micro/errors"
+
+module CFMicro
+  def config_file(file)
+    File.expand_path("../../../../config/#{file}", __FILE__)
+  end
+
+  def escape_path(path)
+    path = File.expand_path(path)
+    if RUBY_PLATFORM =~ /mingw|mswin32|cygwin/
+      if path.include?(' ')
+        '"' + path + '"'
+      else
+        path
+      end
+    else
+      path.gsub(' ', '\ ')
+    end
+  end
+
+  def locate_file(file, directory, search_paths)
+    search_paths.each do |path|
+      expanded_path = File.expand_path(path)
+      next unless File.exists?(expanded_path)
+      Find.find(expanded_path) do |current|
+        if File.directory?(current) && current.include?(directory)
+          full_path = File.join(current, file)
+          return escape_path(full_path) if File.exists?(full_path)
+        end
+      end
+    end
+
+    false
+  end
+
+  def run_command(command, args=nil)
+    # TODO switch to using posix-spawn instead
+    result = %x{#{command} #{args} 2>&1}
+    if $?.exitstatus == 0
+      result.split(/\n/)
+    else
+      if block_given?
+        yield
+      else
+        raise CFMicro::MCFError, "failed to execute #{command} #{args}:\n#{result}"
+      end
+    end
+  end
+
+  module_function :config_file
+  module_function :escape_path
+  module_function :locate_file
+  module_function :run_command
+
+end

data/lib/micro/plugin.rb

@@ -0,0 +1,197 @@
+require "yaml"
+require "multi_json"
+require "cf/cli"
+require "micro/micro"
+require "micro/vmrun"
+require "micro/switcher/base"
+require "micro/switcher/darwin"
+require "micro/switcher/linux"
+require "micro/switcher/windows"
+
+module CFMicro
+  class McfCommand < CF::CLI
+    MICRO_FILE = '~/.cf/micro.yml'
+
+    desc "Display Micro Cloud Foundry VM status"
+    input :vmx, :argument => :required,
+      :desc => "Path to micro.vmx"
+    input :password, :argument => :optional,
+      :desc => "Cleartext password for guest VM vcap user"
+    def micro_status
+      mode = runner.offline? ? 'offline' : 'online'
+
+      line "Micro Cloud Foundry VM currently in #{b(mode)} mode"
+      line "VMX Path: #{c(runner.vmx, :good)}"
+      line "Domain: #{c(runner.domain, :good)}"
+      line "IP Address: #{c(runner.ip, :good)}"
+    end
+
+    desc "Micro Cloud Foundry offline mode"
+    input :vmx, :argument => :required,
+      :desc => "Path to micro.vmx"
+    input :password, :argument => :optional,
+      :desc => "Cleartext password for guest VM vcap user"
+    def micro_offline
+      if !runner.nat?
+        if ask("Reconfigure MCF VM network to nat mode and reboot?", :default => true)
+          with_progress("Rebooting MCF VM") do
+            runner.reset_to_nat!
+          end
+        else
+          fail "Aborted"
+        end
+      end
+
+      with_progress("Setting MCF VM to offline mode") do
+        runner.offline!
+      end
+
+      with_progress("Setting host DNS server") do
+        runner.set_host_dns!
+      end
+    end
+
+    desc "Micro Cloud Foundry online mode"
+    input :vmx, :argument => :required,
+      :desc => "Path to micro.vmx"
+    input :password, :argument => :optional,
+      :desc => "Cleartext password for guest VM vcap user"
+    def micro_online
+      runner
+      with_progress("Unsetting host DNS server") do
+        runner.unset_host_dns!
+      end
+
+      with_progress("Setting MCF VM to online mode") do
+        runner.online!
+      end
+    end
+
+    def runner
+      return @runner if @runner
+
+      config = build_config
+      @runner = switcher(config)
+      check_vm_running
+      store_config(config)
+
+      @runner
+    end
+
+    def check_vm_running
+      unless runner.running?
+        if ask("MCF VM is not running. Do you want to start it?", :default => true)
+          with_progress("Starting MCF VM") do
+            runner.start!
+          end
+        else
+          fail "MCF VM needs to be running."
+        end
+      end
+
+      unless runner.ready?
+        fail "MCF VM initial setup needs to be completed before using 'cf micro'"
+      end
+    end
+
+    def switcher(config)
+      case McfCommand.platform
+      when :darwin
+        CFMicro::Switcher::Darwin.new(config)
+      when :linux
+        CFMicro::Switcher::Linux.new(config)
+      when :windows
+        CFMicro::Switcher::Windows.new(config)
+      when :dummy # for testing only
+        CFMicro::Switcher::Dummy.new(config)
+      else
+        fail "unsupported platform: #{McfCommand.platform}"
+      end
+    end
+
+    # Returns the configuration needed to run the micro related subcommands.
+    # First loads saved config from file (if there is any), then overrides
+    # loaded values with command line arguments, and finally tries to guess
+    # in case neither was used:
+    #   vmx       location of micro.vmx file
+    #   vmrun     location of vmrun command
+    #   password  password for vcap user (in the guest vm)
+    #   platform  current platform
+    def build_config
+      conf = micro # returns {} if there isn't a saved config
+
+      override(conf, :vmx, true) do
+        locate_vmx(McfCommand.platform)
+      end
+
+      override(conf, :vmrun, true) do
+        CFMicro::VMrun.locate(McfCommand.platform)
+      end
+
+      override(conf, :password) do
+        ask("Please enter your MCF VM password (vcap user) password", :echo => "*")
+      end
+
+      conf[:platform] = McfCommand.platform
+
+      conf
+    end
+
+    # Save the cleartext password if --save is supplied.
+    # Note: it is due to vix we have to use a cleartext password :(
+    # Only if --password is used and not --save is the password deleted from the
+    # config file before it is stored to disk.
+    def store_config(config)
+      if input[:save]
+        warn("cleartext password saved in: #{MICRO_FILE}")
+      end
+
+      store_micro(config)
+    end
+
+    # override with command line arguments and yield the block in case the option isn't set
+    def override(config, option, escape=false, &blk)
+      # override if given on the command line
+      if opt = input[option]
+        opt = CFMicro.escape_path(opt) if escape
+        config[option] = opt
+      end
+      config[option] = yield unless config[option]
+    end
+
+    def locate_vmx(platform)
+      paths = YAML.load_file(CFMicro.config_file('paths.yml'))
+      vmx_paths = paths[platform.to_s]['vmx']
+      vmx = CFMicro.locate_file('micro.vmx', 'micro', vmx_paths)
+      fail "Unable to locate micro.vmx, please supply --vmx option" unless vmx
+      vmx
+    end
+
+    def self.platform
+      case RUBY_PLATFORM
+      when /darwin/  # x86_64-darwin11.2.0
+        :darwin
+      when /linux/   # x86_64-linux
+        :linux
+      when /mingw|mswin32|cygwin/ # i386-mingw32
+        :windows
+      else
+        RUBY_PLATFORM
+      end
+    end
+
+    def micro
+      micro_file = File.expand_path(MICRO_FILE)
+      return {} unless File.exists? micro_file
+      contents = File.read(micro_file).strip
+      MultiJson.load(contents)
+    end
+
+    def store_micro(micro)
+      micro_file = File.expand_path(MICRO_FILE)
+      File.open(micro_file, 'w') do |file|
+        file.write(MultiJson.dump(micro))
+      end
+    end
+  end
+end