cf 5.2.1.rc4 → 5.2.1.rc5

data/lib/admin/plugin.rb

@@ -5,3 +5,4 @@ require "admin/service_auth_token"
 require "admin/service_broker/add"
 require "admin/service_broker/remove"
 require "admin/service_broker/service_brokers"
+require "admin/service_broker/update"

data/lib/admin/service_broker/update.rb

@@ -0,0 +1,52 @@
+require "cf/cli"
+
+module CFAdmin::ServiceBroker
+  class Update < CF::CLI
+    def precondition
+      check_target
+    end
+
+    desc "Update a service broker"
+    group :admin
+    input :broker, :argument => :required,
+      :desc => "Service broker to update",
+      :from_given => by_name(:service_broker)
+    input :name, :argument => :optional,
+      :desc => "New name"
+    input :url,
+      :desc => "New URL"
+    input :token,
+      :desc => "New token"
+
+    def update_service_broker
+      broker = input[:broker]
+
+      old_name = broker.name
+
+      broker.name = input[:name]
+      finalize
+      broker.broker_url = input[:url]
+      finalize
+      broker.token = input[:token]
+      finalize
+
+      with_progress("Updating service broker #{old_name}") do
+        broker.update!
+      end
+    end
+
+    private
+
+    def ask_name
+      ask("Name")
+    end
+
+    def ask_url
+      ask("URL")
+    end
+
+    def ask_token
+      ask("Token")
+    end
+  end
+end

data/lib/cf/cli.rb

@@ -158,12 +158,18 @@ EOS
       formatted_exception_output(e, message)
 
     rescue Exception => e
-      formatted_exception_output(e, add_exception_name_to_msg(e))
+      log_error_and_dump_crashlog(e)
+    end
+
+    def log_error_and_dump_crashlog(e)
+      log_error(e)
+      err File.open(File.expand_path(CF::CRASH_FILE)).readlines.join("")
+
+      raise if debug?
     end
 
     def formatted_exception_output(e, msg)
       log_error(e)
-      msg << "\ncat #{CF::CRASH_FILE} # for more details"
       err msg
 
       raise if debug?

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

@@ -29,50 +29,71 @@ module CF::App
           :argument => true, :from_given => by_name(:app)
     input :name, :desc => "Variable name", :argument => true
     input :value, :desc => "Variable value", :argument => :optional
-    input :restart, :desc => "Restart app after updating?", :default => true
+    input :restart, :desc => "Restart app after updating?", :default => false
+
     def set_env
       app = input[:app]
-      name = input[:name]
-
-      if value = input[:value]
-        name = input[:name]
-      elsif name["="]
-        name, value = name.split("=")
-      end
-
-      unless name =~ VALID_ENV_VAR
-        fail "Invalid variable name; must match #{VALID_ENV_VAR.inspect}"
-      end
+      name, value = parse_name_and_value!
 
-      with_progress("Updating #{c(app.name, :name)}") do
+      with_progress("Updating env variable #{c(name, :name)} for app #{c(app.name, :name)}") do
         app.env[name] = value
         app.update!
       end
 
-      if app.started? && input[:restart]
-        invoke :restart, :app => app
-      end
+      restart_if_necessary(app)
     end
 
-
     desc "Remove an environment variable"
     group :apps, :info
     input :app, :desc => "Application to set the variable for",
           :argument => true, :from_given => by_name(:app)
     input :name, :desc => "Variable name", :argument => true
-    input :restart, :desc => "Restart app after updating?", :default => true
+    input :restart, :desc => "Restart app after updating?", :default => false
     def unset_env
       app = input[:app]
       name = input[:name]
 
-      with_progress("Updating #{c(app.name, :name)}") do
+      with_progress("Unsetting #{c(name, :name)} for app #{c(app.name, :name)}") do
         app.env.delete(name)
         app.update!
       end
 
-      if app.started? && input[:restart]
+      restart_if_necessary(app)
+    end
+
+    private
+
+    def restart_if_necessary(app)
+      unless input[:restart]
+        line c("TIP: Use 'cf push' to ensure your env variable changes take effect.", :warning)
+        return
+      end
+
+      if app.started?
         invoke :restart, :app => app
+      else
+        line "Your app was unstarted. Starting now."
+        invoke :start, :app => app
+      end
+    end
+
+    def parse_name_and_value!
+      name = input[:name]
+      value = input[:value]
+
+      if name["="]
+        name, new_value, extra_values = name.split("=")
+        fail "You attempted to specify the value of #{name} twice." if value
+        fail "Invalid format: environment variable definition contains too many occurences of '='" if extra_values
+        value = new_value
+      end
+
+      unless name =~ VALID_ENV_VAR
+        fail "Invalid format: environment variable names cannot start with a number" if name[0] =~ /\d/
+        fail "Invalid format: environment variable names can only contain alphanumeric characters and underscores"
       end
+
+      return name, value
     end
   end
 end

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

@@ -49,15 +49,6 @@ module CF::App
       end
     end
 
-    def sync_app(app, path)
-      upload_app(app, path)
-      apply_changes(app)
-      display_changes(app)
-      commit_changes(app)
-
-      warn "\n#{c(app.name, :name)} is currently stopped, start it with 'cf start'" unless app.started?
-    end
-
     def setup_new_app(path)
       self.path = path
       app = create_app(get_inputs)
@@ -70,6 +61,16 @@ module CF::App
 
     private
 
+    def sync_app(app, path)
+      upload_app(app, path)
+      apply_changes(app)
+      input[:path]
+      display_changes(app)
+      commit_changes(app)
+
+      warn "\n#{c(app.name, :name)} is currently stopped, start it with 'cf start'" unless app.started?
+    end
+
     def url_choices(name)
       client.current_space.domains.sort_by(&:name).collect do |d|
         # TODO: check availability

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

@@ -100,6 +100,7 @@ module CF::App
         while true
           if any_instance_flapping?(instances) || seconds == APP_CHECK_LIMIT
             err "Push unsuccessful."
+            line "#{c("TIP: The system will continue to attempt restarting all requested app instances that have crashed. Try 'cf app' to monitor app status. To troubleshoot crashes, try 'cf events' and 'cf crashlogs'.", :warning)}"
             return
           end
 
@@ -108,8 +109,9 @@ module CF::App
 
             indented { print_instances_summary(instances) }
 
-            if all_instances_running?(instances)
+            if one_instance_running?(instances)
               line "#{c("Push successful! App '#{app.name}' available at http://#{app.host}.#{app.domain}", :good)}"
+              line "#{c("TIP: The system will continue to start all requested app instances. Try 'cf app' to monitor app status.", :warning)}"
               return
             end
           rescue CFoundry::NotStaged
@@ -124,8 +126,8 @@ module CF::App
       end
     end
 
-    def all_instances_running?(instances)
-      instances.all? { |i| i.state == "RUNNING" }
+    def one_instance_running?(instances)
+      instances.any? { |i| i.state == "RUNNING" }
     end
 
     def any_instance_flapping?(instances)
@@ -145,9 +147,9 @@ module CF::App
       end
 
       states = []
-      %w{RUNNING STARTING DOWN FLAPPING}.each do |state|
+      %w{RUNNING STARTING FLAPPING DOWN}.each do |state|
         if (num = counts[state]) > 0
-          states << "#{b(num)} #{c(state.downcase, state_color(state))}"
+          states << "#{b(num)} #{c(for_output(state), state_color(state))}"
         end
       end
 
@@ -157,5 +159,11 @@ module CF::App
       ratio = "#{running}#{d(" of ")}#{total} instances running"
       line "#{ratio} (#{states.join(", ")})"
     end
+
+    private
+    def for_output(state)
+      state = "CRASHING" if state == "FLAPPING"
+      state.downcase
+    end
   end
 end

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

@@ -8,7 +8,6 @@ module CF::App
           :argument => true, :from_given => by_name(:app)
     def stats
       app = input[:app]
-
       stats =
         with_progress("Getting stats for #{c(app.name, :name)}") do |s|
           begin

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

@@ -1,11 +1,28 @@
-require 'active_support/core_ext/object/try'
-
 class TargetPrettifier
   def self.prettify(client, outputter)
+
+    target = nil
+    version = nil
+    current_user_email = nil
+    current_space_name = nil
+    current_org_name = nil
+
+    if client
+      target = client.target
+      version = client.version
+      current_user = client.current_user
+      current_space = client.current_space
+      current_org = client.current_organization
+
+      current_user_email = current_user.email if current_user
+      current_space_name = current_space.name if current_space
+      current_org_name = current_org.name if current_org
+    end
+
     outputter.line("Target Information (where will apps be pushed):")
-    outputter.line("  CF instance: #{print_var(client.try(:target), outputter)} (API version: #{print_var(client.try(:version), outputter)})")
-    outputter.line("  user: #{print_var(client.try(:current_user).try(:email), outputter)}")
-    outputter.line("  target app space: #{print_var(client.try(:current_space).try(:name), outputter)} (org: #{print_var(client.try(:current_organization).try(:name), outputter)})")
+    outputter.line("  CF instance: #{print_var(target, outputter)} (API version: #{print_var(version, outputter)})")
+    outputter.line("  user: #{print_var(current_user_email, outputter)}")
+    outputter.line("  target app space: #{print_var(current_space_name, outputter)} (org: #{print_var(current_org_name, outputter)})")
   end
 
   def self.print_var(object_name, outputter)

data/lib/cf/version.rb

@@ -1,3 +1,3 @@
 module CF
-  VERSION = "5.2.1.rc4".freeze
+  VERSION = "5.2.1.rc5".freeze
 end

data/spec/admin/service_broker/update_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe CFAdmin::ServiceBroker::Update do
+  let(:fake_home_dir) { "#{SPEC_ROOT}/fixtures/fake_admin_dir" }
+  stub_home_dir_with { fake_home_dir }
+
+  let(:client) { build(:client) }
+
+  let(:service_broker) { CFoundry::V2::ServiceBroker.new(nil, client) }
+
+  before do
+    CFAdmin::ServiceBroker::Update.client = client
+    client.stub(:service_broker_by_name).with('cf-mysql').and_return(service_broker)
+  end
+
+  it "updates a service broker when arguments are provided on the command line" do
+    service_broker.stub(:update!)
+
+    cf %W[update-service-broker --broker cf-mysql --name cf-othersql --url http://other.cfapp.io --token secret2]
+
+    service_broker.name.should == 'cf-othersql'
+    service_broker.broker_url.should == 'http://other.cfapp.io'
+    service_broker.token.should == 'secret2'
+
+    service_broker.should have_received(:update!)
+  end
+
+  it "updates a service broker when no change arguments are provided" do
+    service_broker.stub(:update!)
+
+    stub_ask("Name").and_return("cf-othersql")
+    stub_ask("URL").and_return("http://other.example.com")
+    stub_ask("Token").and_return("token2")
+
+    cf %W[update-service-broker cf-mysql]
+
+    service_broker.name.should == 'cf-othersql'
+    service_broker.broker_url.should == 'http://other.example.com'
+    service_broker.token.should == 'token2'
+
+    service_broker.should have_received(:update!)
+  end
+end

data/spec/assets/hello-sinatra/manifest.yml

@@ -0,0 +1,17 @@
+---
+applications:
+- name: hello-sinatra-1377212364_2782688
+  memory: 256M
+  instances: 1
+  host: hello-sinatra-subdomain-1377212364_2782688
+  domain: cfapps.io
+  path: .
+  services:
+    user-provided-1377212364_2782688:
+      label: user-provided
+      credentials:
+        username: abc123
+        password: sunshine
+        hostname: oracle.enterprise.com
+        port: 1234
+        name: myoracledb2

data/spec/cf/cli/app/env_spec.rb

@@ -0,0 +1,261 @@
+require "spec_helper"
+require "cf/cli/app/env"
+
+module CF
+  module App
+    describe Env do
+      before do
+        stub_client
+      end
+
+      describe '#set_env' do
+        let(:mock_restart_command) { MockRestartCommand.new }
+        let(:mock_start_command) { MockStartCommand.new }
+        let(:client) { build(:client) }
+        let(:app) { build(:app, client: client, name: 'puppies-r-us-website') }
+        let(:env) { Env.new(Mothership.commands[:set_env]) }
+
+        before do
+          client.stub(:app_by_name).and_return(app)
+          env.input = Mothership::Inputs.new(Mothership.commands[:set_env], env, inputs, {}, {})
+        end
+
+        context 'when name and value are specified' do
+          let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING', value: 'oh_what_a_value'} }
+
+          it 'updates the app with the new environment variable' do
+            expect(app.env['MY_LOVELY_SETTING']).to eq(nil)
+            expect(app).to receive(:update!) do
+              expect(app.env['MY_LOVELY_SETTING']).to eq('oh_what_a_value')
+            end
+
+            capture_output { env.set_env }
+          end
+        end
+
+        context "when the environment variable is specified with the 'VAR=VALUE' format" do
+          let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING=oh_what_a_value'} }
+
+          it 'updates the app with the new environment variable' do
+            expect(app.env['MY_LOVELY_SETTING']).to eq(nil)
+            expect(app).to receive(:update!) do
+              expect(app.env['MY_LOVELY_SETTING']).to eq('oh_what_a_value')
+            end
+
+            capture_output { env.set_env }
+          end
+        end
+
+        describe "environment variable format" do
+          context "when the name has only letters, numbers, and underscores" do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING123', value: "oh_what_a_value"} }
+            it "gets the value from the input[:value]" do
+              expect(app.env['MY_LOVELY_SETTING123']).to eq(nil)
+              app.stub(:update!)
+
+              capture_output { env.set_env }
+              expect(app.env['MY_LOVELY_SETTING123']).to eq("oh_what_a_value")
+            end
+          end
+
+          context "when the name has one equal sign, and is otherwise valid" do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING123=oh_what_a_value'} }
+            it "gets the value by parsing the name" do
+              expect(app.env['MY_LOVELY_SETTING123']).to eq(nil)
+              app.stub(:update!)
+
+              capture_output { env.set_env }
+              expect(app.env['MY_LOVELY_SETTING123']).to eq("oh_what_a_value")
+            end
+
+            context "but provides a value anyway" do
+              let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING123=oh_what_a_value', value: 'my_other_value'} }
+
+              it "gives the user an error" do
+                capture_exceptional_output { env.set_env }
+                expect(error_output).to say "You attempted to specify the value of MY_LOVELY_SETTING123 twice."
+              end
+            end
+          end
+
+          context "when the name has more than one equal sign" do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING123=oh_what_a_value=badbadbad'} }
+            it "gives the user an error" do
+              capture_exceptional_output { env.set_env }
+              expect(error_output).to say "Invalid format: environment variable definition contains too many occurences of '='"
+            end
+          end
+
+          context "when there are characters that are not letters, numbers, or underscores" do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING1?#$=value'} }
+            it "raises an error" do
+              capture_exceptional_output { env.set_env }
+              expect(error_output).to say "Invalid format: environment variable names can only contain alphanumeric characters and underscores"
+            end
+          end
+
+          context "when the name starts with a number" do
+            let(:inputs) { {app: app, name: '1MY_LOVELY_SETTING', value: 'oh_what_a_value'} }
+            it "raises an error" do
+              capture_exceptional_output { env.set_env }
+              expect(error_output).to say "Invalid format: environment variable names cannot start with a number"
+            end
+          end
+        end
+
+        context 'when the app is not started' do
+          context 'with the --restart flag' do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING', value: 'oh_what_a_value', restart: true} }
+            before { Start.stub(:new).and_return(mock_start_command) }
+
+            it 'starts the app' do
+              expect(app).to receive(:update!) do
+                expect(mock_start_command.started_apps).to be_empty
+              end
+
+              capture_output { env.set_env }
+              expect(output).to say "Your app was unstarted. Starting now."
+
+              expect(mock_start_command.started_apps).to eq [app]
+            end
+          end
+
+          context 'without the --restart flag' do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING', value: 'oh_what_a_value', restart: false} }
+
+            before do
+              app.stub(:update!)
+            end
+
+            it "suggests a 'cf push' to the user" do
+              capture_output { env.set_env }
+              expect(output).to say "TIP: Use 'cf push' to ensure your env variable changes take effect."
+            end
+          end
+        end
+
+        context 'when the app is already started' do
+          before do
+            app.stub(:started?) { true }
+            Restart.stub(:new).and_return(mock_restart_command)
+          end
+
+          context 'with the --restart flag' do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING', value: 'oh_what_a_value', restart: true} }
+
+            it 'restarts the app' do
+              expect(app).to receive(:update!) do
+                expect(mock_restart_command.restarted_apps).to be_empty
+              end
+
+              capture_output { env.set_env }
+
+              expect(mock_restart_command.restarted_apps).to eq([app])
+            end
+          end
+
+          context 'without the --restart flag' do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING', value: 'oh_what_a_value', restart: false} }
+            before do
+              app.stub(:update!)
+            end
+
+            it 'does not restart the app but suggests a cf push' do
+              capture_output { env.set_env }
+              expect(mock_restart_command.restarted_apps).to be_empty
+              expect(output).to say "TIP: Use 'cf push' to ensure your env variable changes take effect."
+            end
+          end
+        end
+      end
+
+      describe '#unset_env' do
+        let(:app) { build(:app, client: client, name: 'puppies-r-us-website', environment_json: {'MY_LOVELY_SETTING' => 'oh_so_lovely'}) }
+        let(:client) { build(:client) }
+        let(:env) { Env.new(Mothership.commands[:unset_env]) }
+        let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING'} }
+        let(:mock_start_command) { MockStartCommand.new }
+        let(:mock_restart_command) { MockRestartCommand.new }
+
+        before do
+          env.input = Mothership::Inputs.new(Mothership.commands[:unset_env], env, inputs, {}, {})
+        end
+
+        it 'unsets the environment variable and updates the app' do
+          expect(app.env['MY_LOVELY_SETTING']).to eq('oh_so_lovely')
+          expect(app).to receive(:update!) do
+            expect(app.env['MY_LOVELY_SETTING']).to be_nil
+          end
+
+          capture_output { env.unset_env }
+        end
+
+        context 'when the app is not started' do
+          context 'with the --restart flag' do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING', restart: true} }
+            before { Start.stub(:new).and_return(mock_start_command) }
+
+            it 'starts the app' do
+              expect(app).to receive(:update!) do
+                expect(mock_start_command.started_apps).to be_empty
+              end
+
+              capture_output { env.unset_env }
+              expect(output).to say "Your app was unstarted. Starting now."
+
+              expect(mock_start_command.started_apps).to eq [app]
+            end
+          end
+
+          context 'without the --restart flag' do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING'} }
+
+            before do
+              app.stub(:update!)
+            end
+
+            it "suggests a 'cf push' to the user" do
+              capture_output { env.unset_env }
+              expect(output).to say "TIP: Use 'cf push' to ensure your env variable changes take effect."
+            end
+          end
+        end
+
+        context 'when the app is already started' do
+          before do
+            app.stub(:started?) { true }
+            Restart.stub(:new).and_return(mock_restart_command)
+          end
+
+          context 'with the --restart flag' do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING', restart: true} }
+
+            it 'restarts the app' do
+              expect(app).to receive(:update!) do
+                expect(mock_restart_command.restarted_apps).to be_empty
+              end
+
+              capture_output { env.unset_env }
+
+              expect(mock_restart_command.restarted_apps).to eq([app])
+            end
+          end
+
+          context 'without the --restart flag' do
+            let(:inputs) { {app: app, name: 'MY_LOVELY_SETTING', restart: false} }
+            before do
+              app.stub(:update!)
+            end
+
+            it 'does not restart the app but suggests a cf push' do
+              capture_output { env.unset_env }
+              expect(mock_restart_command.restarted_apps).to be_empty
+              expect(output).to say "TIP: Use 'cf push' to ensure your env variable changes take effect."
+            end
+          end
+        end
+      end
+    end
+  end
+end
+