falcore 0.1.0

data/lib/falcore/nodes/base.rb

@@ -0,0 +1,118 @@
+#
+# Author: Seth Vargo <sethvargo@gmail.com>
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Falcore
+  class Node::Base
+    def initialize(data = {})
+      @data = data.dup
+    end
+
+    #
+    # The unique ID for this node. This is the {display_name}, but any dots
+    # (+.+) are substituted with dashes (+-+), because dots are the delimiters
+    # for StatsD and other common dumpers.
+    #
+    # @return [String]
+    #
+    def id
+      "jenkins.#{display_name.gsub(/\./, '-')}"
+    end
+
+    # @return [String]
+    def display_name
+      @data['displayName']
+    end
+
+    # @return [true, false]
+    def idle?
+      !!@data['idle']
+    end
+
+    # @return [Integer]
+    def executors
+      @data['numExecutors'].to_i
+    end
+
+    # @return [true, false]
+    def offline?
+      !!@data['offline']
+    end
+
+    # @return [true, false]
+    def temporarily_offline?
+      !!@data['temporarilyOffline']
+    end
+
+    # @return [Integer]
+    def response_time
+      Util.deep_fetch(@data, 'monitorData',
+        'hudson.node_monitors.ResponseTimeMonitor', 'average').to_f
+    end
+
+    # @return [Integer]
+    def temporary_space
+      Util.deep_fetch(@data, 'monitorData',
+        'hudson.node_monitors.TemporarySpaceMonitor', 'size').to_i
+    end
+
+    # @return [Integer]
+    def disk_space
+      Util.deep_fetch(@data, 'monitorData',
+        'hudson.node_monitors.DiskSpaceMonitor', 'size').to_i
+    end
+
+    # @return [Integer]
+    def free_memory
+      Util.deep_fetch(@data, 'monitorData',
+        'hudson.node_monitors.SwapSpaceMonitor', 'availablePhysicalMemory').to_i
+    end
+
+    # @return [Integer]
+    def total_memory
+      Util.deep_fetch(@data, 'monitorData',
+        'hudson.node_monitors.SwapSpaceMonitor', 'totalPhysicalMemory').to_i
+    end
+
+    # @return [Integer]
+    def free_swap
+      Util.deep_fetch(@data, 'monitorData',
+        'hudson.node_monitors.SwapSpaceMonitor', 'availableSwapSpace').to_i
+    end
+
+    # @return [Integer]
+    def total_swap
+      Util.deep_fetch(@data, 'monitorData',
+        'hudson.node_monitors.SwapSpaceMonitor', 'totalSwapSpace').to_i
+    end
+
+    # @private
+    def to_s
+      "#<#{self.class}>"
+    end
+
+    # @private
+    def inspect
+      list = Node::Base.public_instance_methods(false)
+        .reject { |name| [:to_s, :inspect].include?(name) }
+        .sort
+        .map { |name| "#{name}: #{public_send(name).inspect}" }
+
+      "#<#{self.class} #{list.join(', ')}>"
+    end
+  end
+end

data/lib/falcore/nodes/master.rb

@@ -0,0 +1,48 @@
+#
+# Author: Seth Vargo <sethvargo@gmail.com>
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Falcore
+  class Node::Master < Node::Base
+    #
+    # @param data (see Node::Base#initialize)
+    #
+    def initialize(data = {})
+      super(data)
+      @slaves = {}
+    end
+
+    #
+    # @param [Node::Slave] slave
+    #
+    def add_slave(slave)
+      unless slave.is_a?(Node::Slave)
+        raise ArgumentError, "#{slave.class} is not an Falcore::Node::Slave"
+      end
+
+      @slaves[slave.id] = slave
+      self
+    end
+
+    #
+    # @return [Array<Node::Slave>]
+    #
+    def slaves
+      @slaves.values
+    end
+  end
+end

data/lib/falcore/nodes/slave.rb

@@ -0,0 +1,48 @@
+#
+# Author: Seth Vargo <sethvargo@gmail.com>
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Falcore
+  class Node::Slave < Node::Base
+    # @return [Node::Master]
+    attr_reader :master
+
+    #
+    # @param [Node::Master] master
+    # @param data (see Node::Base#initialize)
+    #
+    def initialize(master, data = {})
+      super(data)
+
+      unless master.is_a?(Node::Master)
+        raise ArgumentError, "#{master.class} is not an Falcore::Node::Master!"
+      end
+
+      @master = master
+      @master.add_slave(self)
+    end
+
+    #
+    # Namespace the slave under it's master.
+    #
+    # @return (see Base#id)
+    #
+    def id
+      "#{@master.id}.#{display_name.gsub(/\./, '-')}"
+    end
+  end
+end

data/lib/falcore/null_object.rb

@@ -0,0 +1,56 @@
+#
+# Author: Seth Vargo <sethvargo@gmail.com>
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Falcore
+  class NullObject < BasicObject
+    ARRAY   = []
+    INTEGER = 0
+    FLOAT   = 0.0
+    STRING  = ''
+    INSPECT = 'nil'
+
+    def nil?
+      true
+    end
+    alias_method :empty?, :nil?
+
+    def to_a
+      ARRAY.dup
+    end
+
+    def to_i
+      INTEGER
+    end
+
+    def to_f
+      FLOAT
+    end
+
+    def to_s
+      STRING.dup
+    end
+
+    def inspect
+      INSPECT.dup
+    end
+
+    def method_missing(m, *args, &block)
+      self
+    end
+  end
+end

data/lib/falcore/util.rb

@@ -0,0 +1,39 @@
+#
+# Author: Seth Vargo <sethvargo@gmail.com>
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Falcore
+  module Util
+    extend self
+
+    #
+    # Deeply fech the nested keys, returning +nil+ if an item along the
+    # pathway returns +nil+.
+    #
+    # @param [Hash] hash
+    #   the hash to deep fetch
+    # @param [Array] keys
+    #   the list of keys to fetch (in order)
+    #
+    def deep_fetch(hash = {}, *keys)
+      keys.inject(hash.dup) do |hash, key|
+        return nil if hash.nil?
+        hash[key]
+      end
+    end
+  end
+end

data/lib/falcore/version.rb

@@ -0,0 +1,21 @@
+#
+# Author: Seth Vargo <sethvargo@gmail.com>
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Falcore
+  VERSION = '0.1.0'
+end

data/spec/fixtures/computer.json

@@ -0,0 +1,180 @@
+{
+  "busyExecutors": 0,
+  "computer": [
+    {
+      "actions": [],
+      "displayName": "master.jenkins.example.com",
+      "executors": [
+        {},
+        {}
+      ],
+      "icon": "computer.png",
+      "idle": true,
+      "jnlpAgent": false,
+      "launchSupported": true,
+      "loadStatistics": {
+      },
+      "manualLaunchAllowed": true,
+      "monitorData": {
+        "hudson.node_monitors.SwapSpaceMonitor": {
+          "availablePhysicalMemory": 1977520128,
+          "availableSwapSpace": 0,
+          "totalPhysicalMemory": 8374779904,
+          "totalSwapSpace": 0
+        },
+        "hudson.node_monitors.ArchitectureMonitor": "Linux (amd64)",
+        "hudson.node_monitors.ResponseTimeMonitor": {
+          "average": 0
+        },
+        "hudson.node_monitors.TemporarySpaceMonitor": {
+          "path": "/tmp",
+          "size": 72230727680
+        },
+        "hudson.node_monitors.DiskSpaceMonitor": {
+          "path": "/var/lib/jenkins",
+          "size": 72230727680
+        },
+        "hudson.node_monitors.ClockMonitor": {
+          "diff": 0
+        }
+      },
+      "numExecutors": 2,
+      "offline": false,
+      "offlineCause": null,
+      "offlineCauseReason": "",
+      "oneOffExecutors": [],
+      "temporarilyOffline": false
+    },
+    {
+      "actions": [],
+      "displayName": "slave1.jenkins.example.com",
+      "executors": [
+        {}
+      ],
+      "icon": "computer.png",
+      "idle": true,
+      "jnlpAgent": true,
+      "launchSupported": false,
+      "loadStatistics": {
+      },
+      "manualLaunchAllowed": true,
+      "monitorData": {
+        "hudson.node_monitors.SwapSpaceMonitor": {
+          "availablePhysicalMemory": 1072775168,
+          "availableSwapSpace": 0,
+          "totalPhysicalMemory": 4152627200,
+          "totalSwapSpace": 0
+        },
+        "hudson.node_monitors.ArchitectureMonitor": "Linux (amd64)",
+        "hudson.node_monitors.ResponseTimeMonitor": {
+          "average": 30
+        },
+        "hudson.node_monitors.TemporarySpaceMonitor": {
+          "path": "/tmp",
+          "size": 16421466112
+        },
+        "hudson.node_monitors.DiskSpaceMonitor": {
+          "path": "/home/jenkins",
+          "size": 16421466112
+        },
+        "hudson.node_monitors.ClockMonitor": {
+          "diff": 4
+        }
+      },
+      "numExecutors": 1,
+      "offline": false,
+      "offlineCause": null,
+      "offlineCauseReason": "",
+      "oneOffExecutors": [],
+      "temporarilyOffline": false
+    },
+    {
+      "actions": [],
+      "displayName": "slave2.jenkins.example.com",
+      "executors": [
+        {}
+      ],
+      "icon": "computer.png",
+      "idle": true,
+      "jnlpAgent": true,
+      "launchSupported": false,
+      "loadStatistics": {
+      },
+      "manualLaunchAllowed": true,
+      "monitorData": {
+        "hudson.node_monitors.SwapSpaceMonitor": {
+          "availablePhysicalMemory": 1197740032,
+          "availableSwapSpace": 0,
+          "totalPhysicalMemory": 4152627200,
+          "totalSwapSpace": 0
+        },
+        "hudson.node_monitors.ArchitectureMonitor": "Linux (amd64)",
+        "hudson.node_monitors.ResponseTimeMonitor": {
+          "average": 9
+        },
+        "hudson.node_monitors.TemporarySpaceMonitor": {
+          "path": "/tmp",
+          "size": 19061014528
+        },
+        "hudson.node_monitors.DiskSpaceMonitor": {
+          "path": "/home/jenkins",
+          "size": 19061014528
+        },
+        "hudson.node_monitors.ClockMonitor": {
+          "diff": 34
+        }
+      },
+      "numExecutors": 1,
+      "offline": false,
+      "offlineCause": null,
+      "offlineCauseReason": "",
+      "oneOffExecutors": [],
+      "temporarilyOffline": false
+    },
+    {
+      "actions": [],
+      "displayName": "slave3.jenkins.example.com",
+      "executors": [
+        {}
+      ],
+      "icon": "computer.png",
+      "idle": true,
+      "jnlpAgent": true,
+      "launchSupported": false,
+      "loadStatistics": {
+      },
+      "manualLaunchAllowed": true,
+      "monitorData": {
+        "hudson.node_monitors.SwapSpaceMonitor": {
+          "availablePhysicalMemory": -1,
+          "availableSwapSpace": 1038090240,
+          "totalPhysicalMemory": -1,
+          "totalSwapSpace": 1074790400
+        },
+        "hudson.node_monitors.ArchitectureMonitor": "Mac OS X (x86_64)",
+        "hudson.node_monitors.ResponseTimeMonitor": {
+          "average": 23
+        },
+        "hudson.node_monitors.TemporarySpaceMonitor": {
+          "path": "/private/var/folders/4p/tv3nqk6j1gg19vhb6slz6dpw00007h/T",
+          "size": 15131881472
+        },
+        "hudson.node_monitors.DiskSpaceMonitor": {
+          "path": "/Users/jenkins",
+          "size": 15131881472
+        },
+        "hudson.node_monitors.ClockMonitor": {
+          "diff": 7812
+        }
+      },
+      "numExecutors": 1,
+      "offline": false,
+      "offlineCause": null,
+      "offlineCauseReason": "",
+      "oneOffExecutors": [],
+      "temporarilyOffline": false
+    }
+  ],
+  "displayName": "nodes",
+  "totalExecutors": 14
+}