falcore 0.1.0

data/falcore.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'falcore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'falcore'
+  spec.version       = Falcore::VERSION
+  spec.authors       = ['Seth Vargo']
+  spec.email         = ['sethvargo@gmail.com']
+  spec.summary       = 'A Ruby application for collecting Jenkins node slave ' \
+                       'status and aggregating to multiple output formats.'
+  spec.description   = 'Falcore is a Ruby library and CLI for collecting ' \
+                       'Jenkins slave information from a Jenkins master and ' \
+                       'aggregating to multiple output formats and checks ' \
+                       'as StatsD or Nagios.'
+  spec.homepage      = 'https://github.com/opscode/falcore'
+  spec.license       = 'Apache 2.0'
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'statsd-ruby', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rspec',   '~> 2.14'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sinatra', '~> 1.4'
+  spec.add_development_dependency 'webmock', '~> 1.17'
+end

data/lib/falcore.rb

@@ -0,0 +1,38 @@
+#
+# 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.
+#
+
+require 'falcore/version'
+
+module Falcore
+  autoload :Aggregator, 'falcore/aggregator'
+  autoload :Config,     'falcore/config'
+  autoload :Fetcher,    'falcore/fetcher'
+  autoload :NullObject, 'falcore/null_object'
+  autoload :Util,       'falcore/util'
+
+  module Dumper
+    autoload :Base,   'falcore/dumpers/base'
+    autoload :Statsd, 'falcore/dumpers/statsd'
+  end
+
+  module Node
+    autoload :Base,   'falcore/nodes/base'
+    autoload :Master, 'falcore/nodes/master'
+    autoload :Slave,  'falcore/nodes/slave'
+  end
+end

data/lib/falcore/aggregator.rb

@@ -0,0 +1,41 @@
+#
+# 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 Aggregator
+    attr_reader :config
+
+    #
+    #
+    #
+    def initialize(config)
+      @config = config
+    end
+
+    def run
+      hash = Fetcher.get("#{config.jenkins.endpoint}/computer/api/json")
+
+      master = Node::Master.new(hash['computer'][0])
+      slaves = hash['computer'][1..-1].map do |slave|
+        Node::Slave.new(master, slave)
+      end
+
+      master
+    end
+  end
+end

data/lib/falcore/config.rb

@@ -0,0 +1,125 @@
+#
+# 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 Config < Hash
+    class << self
+      def from_file(path)
+        contents = File.read(File.expand_path(path))
+        parse(contents)
+      rescue Errno::ENOENT
+        raise "No config found at '#{path}'!"
+      end
+
+      def parse(contents)
+        Parser.new(contents).parse
+      end
+
+      private
+
+      class Parser
+        CONFIG_SECTION = /\[(.+)\]/.freeze
+        CONFIG_OPTION  = /[[:space:]]{2,}(.+) = (.+)/.freeze
+
+        def initialize(contents)
+          @contents = contents
+          @result   = Config.new
+        end
+
+        def parse
+          @contents.split(/\r?\n/).each do |line|
+            next if line.strip.empty?
+            next if line.strip.start_with?('#')
+
+            if line =~ CONFIG_SECTION
+              @current_key = $1
+            elsif line =~ CONFIG_OPTION
+              match = line.match(CONFIG_OPTION)
+              key   = match[1]
+              value = match[2]
+
+              # Make sure we are keyed
+              @result[@current_key] ||= Config.new
+              @result[@current_key][key] = coerce(value)
+            else
+              raise "Could not parse line '#{line}'"
+            end
+          end
+
+          @result
+        end
+
+        private
+
+        #
+        # Coerce the value into it's appropiate Ruby type.
+        #
+        # @param [Object] value
+        # @return [Object]
+        #   the coerced value
+        #
+        def coerce(value)
+          case value
+          when /^[[:digit:]]+$/
+            value.to_i
+          when /^[[:digit:]]+\.[[:digit:]]+$/
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+    end
+
+    # @private
+    def method_missing(m, *args, &block)
+      key = m.to_s
+
+      if key.include?('=')
+        set(key.delete('='), args.first)
+      else
+        if has_key?(key)
+          get(key)
+        else
+          NullObject.new
+        end
+      end
+    end
+
+    # @private
+    def respond_to_missing?(m, include_private = false)
+      key = m.to_s
+
+      if key.include?('=')
+        true
+      else
+        has_key?(key) || super
+      end
+    end
+
+    private
+
+    def get(key)
+      self[key]
+    end
+
+    def set(key, value)
+      self[key] = value
+    end
+  end
+end

data/lib/falcore/dumpers/base.rb

@@ -0,0 +1,84 @@
+#
+# 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 Dumper::Base
+    class << self
+      def run(&block)
+        block ? @run = block : @run || Proc.new
+      end
+
+      def validate(&block)
+        block ? @validate = block : @validate || Proc.new
+      end
+    end
+
+    # @return [Falcore::Config]
+    attr_reader :config
+
+    # @return [Falcore::Node::Master]
+    attr_reader :master
+
+    #
+    # @param [Config] config
+    #   the config object
+    # @param [Node::Master] master
+    #   the master node
+    #
+    def initialize(config, master)
+      unless config.is_a?(Config)
+        raise ArgumentError, "#{config.class} is not an Falcore::Config"
+      end
+
+      unless master.is_a?(Node::Master)
+        raise ArgumenError, "#{config.class} is not an Falcore::Node::Master"
+      end
+
+      @config = config
+      @master = master
+    end
+
+    #
+    # Run this dumper. This method should be overridden in subclasses.
+    #
+    def run
+      instance_eval(&self.class.validate)
+      instance_eval(&self.class.run)
+    end
+
+    private
+
+    #
+    # Ensure the thing called in the block is not +nil+.
+    #
+    # @param [String] thing
+    #   the thing to check (used for the error message)
+    # @param [Proc] block
+    #   the block to call
+    #
+    # @return [true]
+    #
+    def presence!(thing, &block)
+      if block.call(self).nil?
+        raise "Expected '#{thing}' to be set!"
+      end
+
+      true
+    end
+  end
+end

data/lib/falcore/dumpers/statsd.rb

@@ -0,0 +1,76 @@
+#
+# 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.
+#
+
+require 'statsd'
+
+module Falcore
+  class Dumper::Statsd < Dumper::Base
+    validate do
+      presence!('Statsd host') { config.statsd.host }
+      presence!('Statsd port') { config.statsd.port }
+    end
+
+    run do
+      stat(master)
+      master.slaves.each(&method(:stat))
+    end
+
+    private
+
+    def statsd
+      @statsd ||= Statsd.new(config.statsd.host, config.statsd.port)
+    end
+
+    #
+    # @private
+    #
+    # Push stats to statsd for this particular +node+.
+    #
+    # @param [Node::Base] node
+    #   the node to examine
+    #
+    def stat(node)
+      # Up/down
+      statsd.gauge("#{node.id}.offline", node.offline? ? 1 : 0)
+
+      # Idle
+      statsd.gauge("#{node.id}.idle", node.idle? ? 1 : 0)
+
+      # Response time
+      statsd.timing("#{node.id}.response_time", node.response_time)
+
+      # Temporary space
+      statsd.gauge("#{node.id}.temporary_space", node.temporary_space)
+
+      # Disk space
+      statsd.gauge("#{node.id}.disk_space", node.disk_space)
+
+      # Free memory
+      statsd.gauge("#{node.id}.free_memory", node.free_memory)
+
+      # Total memory
+      statsd.gauge("#{node.id}.total_memory", node.total_memory)
+
+      # Free swap
+      statsd.gauge("#{node.id}.free_swap", node.free_swap)
+
+      # Total swap
+      statsd.gauge("#{node.id}.total_swap", node.total_swap)
+    end
+  end
+end

data/lib/falcore/fetcher.rb

@@ -0,0 +1,50 @@
+#
+# 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.
+#
+
+require 'json'
+require 'open-uri'
+require 'socket'
+
+module Falcore
+  class Fetcher
+    class << self
+      #
+      # Get the JSON at the given URL and parse it as such. This method is just
+      # a very thin wrapper around Ruby's native +OpenURI+ with some error-
+      # handling magic.
+      #
+      # @raise [RuntimeError]
+      #   if the request fails (40X, 50X, bad-URL) or if the JSON is invalid
+      #
+      # @param [String] url
+      #   the url to get
+      #
+      # @return [Hash]
+      #   the parsed JSON hash
+      #
+      def get(url)
+        response = open(url)
+        JSON.parse(response.read)
+      rescue Errno::ENOENT, OpenURI::HTTPError, SocketError => e
+        raise "Failed to GET '#{url}': #{e.class} - #{e.message}"
+      rescue JSON::ParserError
+        raise 'Invalid JSON!'
+      end
+    end
+  end
+end