tools-cf-plugin 2.4.0 → 3.0.0

data/lib/tools-cf-plugin/app-placement.rb

@@ -0,0 +1,145 @@
+require "cf/cli"
+require "nats/client"
+require "set"
+
+module CFTools
+  class AppPlacement < CF::App::Base
+    def precondition; end
+
+    desc "Show placement of running applications."
+    group :admin
+    input :host, :alias => "-h", :default => "127.0.0.1",
+          :desc => "NATS server address"
+    input :port, :alias => "-P", :default => 4222, :type => :integer,
+          :desc => "NATS server port"
+    input :user, :alias => "-u", :default => "nats",
+          :desc => "NATS server user"
+    input :password, :alias => "-p", :default => "nats",
+          :desc => "NATS server password"
+    input :time, :alias => "-t", :default => 12,
+          :desc => "Seconds to watch heartbeats"
+    input :zeros, :alias => "-z", :default => false,
+          :desc => "If set, include zero-value DEAs in output"
+    def app_placement
+      host = input[:host]
+      port = input[:port]
+      user = input[:user]
+      pass = input[:password]
+
+      render_apps(
+        "nats://#{user}:#{pass}@#{host}:#{port}",
+        input[:time]
+      )
+    end
+
+    private
+    def apps
+      @apps ||= {}
+    end
+
+    def known_app_ids
+      @known_app_ids ||= Set.new
+    end
+
+    def known_dea_ids
+      @known_dea_ids ||= Set.new
+    end
+
+    def render_zeros?
+      !!input[:zeros]
+    end
+
+    def render_apps(uri, seconds_to_watch, options = {})
+      NATS.start(:uri => uri) do
+        NATS.subscribe("dea.heartbeat") do |msg|
+          payload = JSON.parse(msg)
+          dea_id = payload["dea"].to_i
+          register_heartbeat(dea_id, payload["droplets"])
+        end
+
+        EM.add_timer(seconds_to_watch) do
+          NATS.stop
+        end
+      end
+
+      fill_in_zeros
+      render_table
+    rescue NATS::ServerError => e
+      if e.to_s =~ /connection dropped/i
+        line c("dropped by server; reconnecting...", :error)
+        retry
+      else
+        raise
+      end
+    end
+
+    def register_heartbeat(dea_id, droplets)
+      known_dea_ids << dea_id
+      app_id_to_num_instances = Hash.new(0)
+      droplets.each do |droplet|
+        next unless droplet["state"] == "RUNNING"
+        app_id = droplet["droplet"]
+        app_id_to_num_instances[app_id] += 1
+
+        known_app_ids << app_id
+      end
+
+      app_id_to_num_instances.each do |app_id, num_instances|
+        apps[app_id] ||= {}
+        apps[app_id][dea_id] = num_instances
+      end
+    end
+
+    def fill_in_zeros
+      known_app_ids.each do |app_id|
+        known_dea_ids.each do |dea_id|
+          apps[app_id][dea_id] ||= 0
+        end
+      end
+    end
+
+    def render_table
+      print("%-36s placement\n" % "guid")
+      apps.each do |app_id, dea_id_to_num_instances|
+        render_app(app_id, dea_id_to_num_instances)
+      end
+
+      render_total
+    end
+
+    def render_app(app_id, dea_id_to_num_instances)
+      total_instances = 0
+      placements = []
+      0.upto(known_dea_ids.max) do |dea_id|
+        if dea_id_to_num_instances.has_key?(dea_id)
+          num_instances = dea_id_to_num_instances[dea_id]
+          total_instances += num_instances
+          placements << "#{dea_id}:#{num_instances}" if num_instances > 0 || render_zeros?
+        else
+          placements << "#{dea_id}:?" if render_zeros?
+        end
+      end
+
+      print("%-36s %s T:%s\n" % [app_id, placements.join(" "), total_instances])
+    end
+
+    def render_total
+      totals = []
+      grand_total = 0
+      0.upto(known_dea_ids.max) do |dea_id|
+        if known_dea_ids.include?(dea_id)
+          total_for_dea = 0
+
+          apps.each do |app_id, dea_id_to_num_instances|
+            total_for_dea += dea_id_to_num_instances[dea_id]
+          end
+          totals << "#{dea_id}:#{total_for_dea}"
+          grand_total += total_for_dea
+        else
+          totals << "#{dea_id}:?" if render_zeros?
+        end
+      end
+      print("%-36s %s T:%s\n" % ["total", totals.join(" "), grand_total])
+    end
+  end
+end

data/lib/tools-cf-plugin/plugin.rb

@@ -1,5 +1,6 @@
 require "tools-cf-plugin/watch"
 require "tools-cf-plugin/shell"
+require "tools-cf-plugin/app-placement"
 require "tools-cf-plugin/dea-ads"
 require "tools-cf-plugin/dea-apps"
 require "tools-cf-plugin/tunnel/tunnel-nats"

data/lib/tools-cf-plugin/tunnel/base.rb

@@ -63,12 +63,55 @@ module CFTools
       end
 
       def tunnel_to(address, remote_port, gateway)
-        user, host = gateway.split("@", 2)
-        Net::SSH::Gateway.new(host, user).open(address, remote_port)
+        local_port = grab_ephemeral_port
+
+        Process.spawn("ssh -o StrictHostKeyChecking=no -N -L #{local_port}:#{address}:#{remote_port} #{gateway}")
+
+        wait_for_port_open(local_port)
+
+        local_port
+      end
+
+      def current_deployment(director)
+        deployments =
+          with_progress("Getting deployments") do
+            director.list_deployments
+          end
+
+        fail "No deployments." if deployments.empty?
+
+        cf_deployments = deployments.select do |d|
+          d["releases"].any? { |r| ["cf-release", "cf"].include?(r["name"]) }
+        end
+
+        return cf_deployments.first if cf_deployments.size == 1
+
+        ask("Which deployment?",
+            :choices => deployments,
+            :display => proc { |x| x["name"] })
       end
 
       private
 
+      def grab_ephemeral_port
+        socket = TCPServer.new('0.0.0.0', 0)
+
+        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
+
+        Socket.do_not_reverse_lookup = true
+
+        port = socket.addr[1]
+        socket.close
+
+        port
+      end
+
+      def wait_for_port_open(port)
+        Timeout.timeout(10) do
+          sleep 0.5 until address_reachable?("127.0.0.1", port)
+        end
+      end
+
       def address_reachable?(host, port)
         Timeout.timeout(1) do
           TCPSocket.new(host, port).close
@@ -92,17 +135,12 @@ module CFTools
         auth
       end
 
-      def current_deployment(director)
-        deployments = director.list_deployments
-
-        deployments.find do |d|
-          d["releases"].any? { |r| r["name"] == "cf-release" }
-        end
-      end
-
       def current_deployment_manifest(director)
         deployment = current_deployment(director)
-        YAML.load(director.get_deployment(deployment["name"])["manifest"])
+
+        with_progress("Downloading #{c(deployment["name"], :name)} manifest") do
+          YAML.load(director.get_deployment(deployment["name"])["manifest"])
+        end
       end
 
       def save_auth(director, auth)

data/lib/tools-cf-plugin/tunnel/tunnel-nats.rb

@@ -31,10 +31,7 @@ module CFTools::Tunnel
 
       line "Director: #{director.director_uri}"
 
-      manifest =
-        with_progress("Downloading deployment manifest") do
-          current_deployment_manifest(director)
-        end
+      manifest = current_deployment_manifest(director)
 
       nats = manifest["properties"]["nats"]
 

data/lib/tools-cf-plugin/tunnel/watch-logs.rb

@@ -8,10 +8,13 @@ require "tools-cf-plugin/tunnel/stream_location"
 module CFTools::Tunnel
   class WatchLogs < Base
     LOGS = {
-      "cloud_controller" => ["cloud_controller_ng/cloud_controller_ng.log"],
-      "dea_next" => ["dea_next/dea_next.log"],
-      "health_manager" => ["health_manager_next/health_manager_next.log"],
-      "router" => ["gorouter/gorouter.log"]
+      "api_z1" => ["cloud_controller_ng/cloud_controller_ng.log"],
+      "api_z2" => ["cloud_controller_ng/cloud_controller_ng.log"],
+      "runner_z1" => ["dea_next/dea_next.log"],
+      "runner_z2" => ["dea_next/dea_next.log"],
+      "hm_z1" => ["health_manager_next/health_manager_next.log"],
+      "router_z1" => ["gorouter/gorouter.log"],
+      "router_z2" => ["gorouter/gorouter.log"],
     }
 
     # colorize if told to; don't check if output is tty
@@ -31,10 +34,7 @@ module CFTools::Tunnel
 
       director = connected_director(director_host, gateway)
 
-      deployment =
-        with_progress("Getting deployment info") do
-          current_deployment(director)
-        end
+      deployment = current_deployment(director)
 
       locations =
         with_progress("Finding logs for #{c(deployment["name"], :name)}") do

data/lib/tools-cf-plugin/version.rb

@@ -1,3 +1,3 @@
 module CFTools
-  VERSION = "2.4.0".freeze
+  VERSION = "3.0.0".freeze
 end

data/lib/tools-cf-plugin/watch.rb

@@ -439,7 +439,11 @@ module CFTools
     end
 
     def pretty_version(guid)
-      guid.split("-").first
+      if guid
+        guid.split("-").first
+      else
+        d("none")
+      end
     end
 
     def pretty_app(guid)

data/spec/app-placement_spec.rb

@@ -0,0 +1,164 @@
+require "spec_helper"
+
+describe CFTools::AppPlacement do
+  let(:client) { fake_client :apps => [app1, app2, app3] }
+
+  let(:app1) do
+    fake :app, :name => "myapp1", :guid => "myappguid-1",
+      :memory => 128, :total_instances => 2
+  end
+
+  let(:app2) do
+    fake :app, :name => "myapp2", :guid => "myappguid-2",
+      :memory => 256, :total_instances => 2
+  end
+
+  let(:app3) do
+    fake :app, :name => "myapp3", :guid => "myappguid-3",
+      :memory => 1024, :total_instances => 4
+  end
+
+  before { stub_client }
+
+  before do
+    NATS.stub(:start).and_yield
+    EM.stub(:add_timer).and_yield
+  end
+
+  let(:dea1_heartbeat) { <<PAYLOAD }
+{
+  "prod": false,
+  "dea": "1-3b293b726167fbc895af5a7927c0973a",
+  "droplets": [
+    {
+      "state_timestamp": 1369251231.3436642,
+      "state": "RUNNING",
+      "index": 0,
+      "instance": "app1-instance2",
+      "version": "5c0e0e10-8384-4a35-915e-872fe91ffb95",
+      "droplet": "#{app1.guid}",
+      "cc_partition": "default"
+    }
+  ]
+}
+PAYLOAD
+
+  let(:dea2_heartbeat) { <<PAYLOAD }
+{
+  "prod": false,
+  "dea": "2-4b293b726167fbc895af5a7927c0973a",
+  "droplets": [
+    {
+      "state_timestamp": 1369251231.3436642,
+      "state": "RUNNING",
+      "index": 0,
+      "instance": "app1-instance1",
+      "version": "5c0e0e10-8384-4a35-915e-872fe91ffb95",
+      "droplet": "#{app1.guid}",
+      "cc_partition": "default"
+    },
+    {
+      "state_timestamp": 1369251231.3436642,
+      "state": "CRASHED",
+      "index": 1,
+      "instance": "app2-dead-isntance",
+      "version": "deadbeef-8384-4a35-915e-872fe91ffb95",
+      "droplet": "#{app2.guid}",
+      "cc_partition": "default"
+    },
+    {
+      "state_timestamp": 1369251231.3436642,
+      "state": "RUNNING",
+      "index": 1,
+      "instance": "app2-instance1",
+      "version": "deadbeef-8384-4a35-915e-872fe91ffb95",
+      "droplet": "#{app2.guid}",
+      "cc_partition": "default"
+    },
+    {
+      "state_timestamp": 1369251231.3436642,
+      "state": "RUNNING",
+      "index": 1,
+      "instance": "app2-instance2",
+      "version": "deadbeef-8384-4a35-915e-872fe91ffb95",
+      "droplet": "#{app2.guid}",
+      "cc_partition": "default"
+    },
+    {
+      "state_timestamp": 1369251225.2800167,
+      "state": "RUNNING",
+      "index": 0,
+      "instance": "app3-instance1",
+      "version": "bdc3b7d7-5a55-455d-ac66-ba82a9ad43e7",
+      "droplet": "#{app3.guid}",
+      "cc_partition": "default"
+    },
+    {
+      "state_timestamp": 1369251225.2800167,
+      "state": "RUNNING",
+      "index": 0,
+      "instance": "app3-instance2",
+      "version": "bdc3b7d7-5a55-455d-ac66-ba82a9ad43e7",
+      "droplet": "#{app3.guid}",
+      "cc_partition": "default"
+    },
+    {
+      "state_timestamp": 1369251225.2800167,
+      "state": "RUNNING",
+      "index": 0,
+      "instance": "app3-instance3",
+      "version": "bdc3b7d7-5a55-455d-ac66-ba82a9ad43e7",
+      "droplet": "#{app3.guid}",
+      "cc_partition": "default"
+    },
+    {
+      "state_timestamp": 1369251225.2800167,
+      "state": "RUNNING",
+      "index": 0,
+      "instance": "app3-instance4",
+      "version": "bdc3b7d7-5a55-455d-ac66-ba82a9ad43e7",
+      "droplet": "#{app3.guid}",
+      "cc_partition": "default"
+    }
+  ]
+}
+PAYLOAD
+
+  before do
+    NATS.stub(:subscribe) do |&callback|
+      callback.call(dea2_heartbeat)
+      callback.call(dea1_heartbeat)
+      callback.call(dea2_heartbeat) # old dea2_heartbeat should be discarded
+    end
+  end
+
+  it "outputs the list of guids and placements, without zeros by default" do
+    cf %W[app-placement]
+    expect(output).to say(%r{guid\s+placement})
+    expect(output).to say(%r{myappguid-1\s+1:1\s+2:1\s+T:2\D})
+    expect(output).to say(%r{myappguid-2\s+2:2\s+T:2\D})
+    expect(output).to say(%r{myappguid-3\s+2:4\s+T:4\D})
+    expect(output).to say(%r{total      \s+1:1\s+2:7\s+T:8\D})
+  end
+
+  it "outputs the list of guids and placements, with a zero if requested" do
+    cf %W[app-placement -z]
+    expect(output).to say(%r{guid\s+placement})
+    expect(output).to say(%r{myappguid-1\s+0:\?\s+1:1\s+2:1\s+T:2\D})
+    expect(output).to say(%r{myappguid-2\s+0:\?\s+1:0\s+2:2\s+T:2\D})
+    expect(output).to say(%r{myappguid-3\s+0:\?\s+1:0\s+2:4\s+T:4\D})
+    expect(output).to say(%r{total      \s+0:\?\s+1:1\s+2:7\s+T:8\D})
+  end
+
+  describe "observation time" do
+    it "defaults to 12 seconds (slightly longer than a single heartbeat interval)" do
+      EM.should_receive(:add_timer).with(12)
+      cf %W[app-placement]
+    end
+
+    it "can be overridden" do
+      EM.should_receive(:add_timer).with(3)
+      cf %W[app-placement --time 3]
+    end
+  end
+end

data/spec/tunnel/base_spec.rb

@@ -63,20 +63,84 @@ module CFTools::Tunnel
     describe "#tunnel_to" do
       let(:gateway) { double }
 
-      before { gateway.stub(:open) }
+      before { Process.stub(:spawn) }
+
+      before { subject.stub(:wait_for_port_open) }
 
       it "creates a gateway using the given user/host" do
-        expect(Net::SSH::Gateway).to receive(:new).with("ghost", "guser") { gateway }
-        subject.tunnel_to("1.2.3.4", 1234, "guser@ghost")
-      end
+        subject.stub(:grab_ephemeral_port => 5678)
+
+        expect(Process).to receive(:spawn).with(
+          "ssh -o StrictHostKeyChecking=no -N -L 5678:1.2.3.4:1234 guser@ghost")
+
+        expect(subject).to receive(:wait_for_port_open).with(5678)
 
-      it "opens a local tunnel and returns its port" do
-        Net::SSH::Gateway.stub(:new).with("ghost", "guser") { gateway }
-        expect(gateway).to receive(:open).with("1.2.3.4", 1234) { 5678 }
         expect(subject.tunnel_to("1.2.3.4", 1234, "guser@ghost")).to eq(5678)
       end
     end
 
+    describe "#current_deployment" do
+      let(:director) { double }
+
+      before { director.stub(:list_deployments => deployments) }
+
+      let(:cf_deployment) do
+        { "name" => "a", "releases" => [{ "name" => "cf" }] }
+      end
+
+      let(:cf_release_deployment) do
+        { "name" => "b", "releases" => [{ "name" => "cf-release" }] }
+      end
+
+      let(:other_deployment) do
+        { "name" => "b", "releases" => [{ "name" => "some-release" }] }
+      end
+
+      context "when there are no deployments" do
+        let(:deployments) { [] }
+
+        it "fails" do
+          expect {
+            subject.current_deployment(director)
+          }.to raise_error(/no deployments/i)
+        end
+      end
+
+      context "when there is one deployment with release name 'cf'" do
+        let(:deployments) { [cf_deployment] }
+
+        it "returns that deployment" do
+          expect(subject.current_deployment(director)).to eq(cf_deployment)
+        end
+      end
+
+      context "when there is one deployment with release name 'cf-release'" do
+        let(:deployments) { [cf_release_deployment] }
+
+        it "returns that deployment" do
+          expect(subject.current_deployment(director)).to eq(cf_release_deployment)
+        end
+      end
+
+      context "when there are multiple deployments" do
+        let(:deployments) { [cf_deployment, cf_release_deployment, other_deployment] }
+
+        it "asks which deployment to use" do
+          called = false
+
+          should_ask("Which deployment?", anything) do |_, opts|
+            called = true
+            expect(opts[:choices]).to eq(deployments)
+            expect(opts[:display].call(deployments.first)).to eq("a")
+            cf_release_deployment
+          end
+
+          expect(subject.current_deployment(director)).to eq(cf_release_deployment)
+          expect(called).to be_true
+        end
+      end
+    end
+
     describe "#authenticate_with_director" do
       let(:director) { double }
 

data/spec/tunnel/watch-logs_spec.rb

@@ -9,9 +9,9 @@ module CFTools::Tunnel
     let(:stream) { double }
 
     let(:vms) do
-      [ { "ips" => ["1.2.3.4"], "job_name" => "cloud_controller", "index" => 0 },
-        { "ips" => ["1.2.3.5"], "job_name" => "dea_next", "index" => 0 },
-        { "ips" => ["1.2.3.6"], "job_name" => "dea_next", "index" => 1 }
+      [ { "ips" => ["1.2.3.4"], "job_name" => "api_z1", "index" => 0 },
+        { "ips" => ["1.2.3.5"], "job_name" => "runner_z1", "index" => 0 },
+        { "ips" => ["1.2.3.6"], "job_name" => "runner_z1", "index" => 1 }
       ]
     end
 
@@ -72,9 +72,9 @@ module CFTools::Tunnel
     context "when there are jobs to log" do
       it "streams their locations" do
         expect(stream).to receive(:stream).with(hash_including(
-          ["cloud_controller", 0] => anything,
-          ["dea_next", 0] => anything,
-          ["dea_next", 1] => anything))
+          ["api_z1", 0] => anything,
+          ["runner_z1", 0] => anything,
+          ["runner_z1", 1] => anything))
 
         cf %W[watch-logs some-director.com]
       end
@@ -85,17 +85,17 @@ module CFTools::Tunnel
         entry3_time = Time.new(2011, 06, 21, 1, 2, 5)
 
         entry1 = LogEntry.new(
-          "cloud_controller/0",
+          "api_z1/0",
           %Q[{"message":"a","timestamp":#{entry1_time.to_f},"log_level":"info"}],
           :stdout)
 
         entry2 = LogEntry.new(
-          "dea_next/1",
+          "runner_z1/1",
           %Q[{"message":"b","timestamp":#{entry2_time.to_f},"log_level":"warn","data":{"foo":"bar"}}],
           :stdout)
 
         entry3 = LogEntry.new(
-          "dea_next/0",
+          "runner_z1/0",
           %Q[{"message":"c","timestamp":#{entry3_time.to_f},"log_level":"error"}],
           :stdout)
 
@@ -103,15 +103,15 @@ module CFTools::Tunnel
 
         cf %W[watch-logs some-director.com]
 
-        expect(output).to say("cloud_controller/0   01:02:03 AM  info    a  \n")
-        expect(output).to say("dea_next/1           01:02:04 AM  warn    b  {\"foo\"=>\"bar\"}\n")
-        expect(output).to say("dea_next/0           01:02:05 AM  error   c  \n")
+        expect(output).to say("api_z1/0      01:02:03 AM  info    a  \n")
+        expect(output).to say("runner_z1/1   01:02:04 AM  warn    b  {\"foo\"=>\"bar\"}\n")
+        expect(output).to say("runner_z1/0   01:02:05 AM  error   c  \n")
       end
 
       context "and components were specified" do
         it "streams their locations" do
-          expect(stream).to receive(:stream).with(["cloud_controller", 0] => anything)
-          cf %W[watch-logs some-director.com cloud_controller]
+          expect(stream).to receive(:stream).with(["api_z1", 0] => anything)
+          cf %W[watch-logs some-director.com api_z1]
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tools-cf-plugin
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cfoundry
@@ -200,7 +200,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -208,7 +208,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -249,6 +249,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
+- lib/tools-cf-plugin/app-placement.rb
 - lib/tools-cf-plugin/dea-ads.rb
 - lib/tools-cf-plugin/dea-apps.rb
 - lib/tools-cf-plugin/plugin.rb
@@ -262,6 +263,7 @@ files:
 - lib/tools-cf-plugin/tunnel/watch-logs.rb
 - lib/tools-cf-plugin/version.rb
 - lib/tools-cf-plugin/watch.rb
+- spec/app-placement_spec.rb
 - spec/dea-ads_spec.rb
 - spec/dea-apps_spec.rb
 - spec/fixtures/dea-apps/stats_1.json
@@ -305,6 +307,7 @@ signing_key:
 specification_version: 3
 summary: Cloud Foundry tooling commands.
 test_files:
+- spec/app-placement_spec.rb
 - spec/dea-ads_spec.rb
 - spec/dea-apps_spec.rb
 - spec/fixtures/dea-apps/stats_1.json
@@ -323,4 +326,3 @@ test_files:
 - spec/tunnel/tunnel-nats_spec.rb
 - spec/tunnel/watch-logs_spec.rb
 - spec/watch_spec.rb
-has_rdoc: