bosh-verify-manifest 0.1.0

data/lib/bosh-verify-manifest.rb

@@ -0,0 +1,30 @@
+require_relative 'bosh-verify-manifest/helpers'
+require_relative 'bosh-verify-manifest/assertions'
+require_relative 'bosh-verify-manifest/infections'
+require_relative 'bosh-verify-manifest/version'
+
+module BoshVerifyManifest
+  require 'minitest/spec'
+
+  class Spec < MiniTest::Spec
+    include Assertions
+    include Infections
+
+    def manifest_path
+      "#{self.class.name.split('::').last}.yml"
+    end
+
+    def manifest
+      YAML::load(File.read(manifest_path))
+    end
+
+  end
+
+  MiniTest::Spec.register_spec_type(/^bosh_manifest::/, BoshVerifyManifest::Spec)
+end
+
+module Kernel
+  def describe_bosh_manifest(desc, additional_desc = nil, &block)
+    describe("bosh_manifest::#{desc}", additional_desc, &block)
+  end
+end

data/lib/bosh-verify-manifest/assertions.rb

@@ -0,0 +1,92 @@
+require 'ipaddr'
+require 'uuidtools'
+require 'yaml'
+
+module BoshVerifyManifest
+  module Assertions
+
+    include Helpers
+
+    def assert_declares_all_resource_pools(manifest)
+      undeclared_pools(manifest).each do |pool|
+        flunk "The '#{pool}' pool referred to does not exist"
+      end
+    end
+
+    def assert_fills_resource_pools(manifest)
+      usage = pool_usage(manifest)
+      pool_sizes(manifest).each_pair do |pool, instances|
+        assert instances == usage[pool],
+          "The '#{pool}' pool is not full (size: #{instances}, wanted: #{usage[pool]})"
+      end
+    end
+
+    def assert_has_name(manifest)
+      assert manifest.key?('name'), 'The manifest does not have a name'
+    end
+
+    def assert_job_addresses_are_appropriate(manifest)
+      manifest['jobs'].each do |job|
+        job['networks'].select{|n| n['static_ips']}.each do |network|
+          ranges = network(manifest, network['name'])['subnets'].map{|s| s['range']}
+	  assert ranges.any?{|r| addresses_in_range?(network['static_ips'], r)},
+            "The job '#{job['name']}' has static_ips that are not valid for the network '#{network['name']}'"
+        end
+      end
+    end
+
+    def assert_range_includes_gateway(subnet)
+      if subnet['gateway']
+        assert IPAddr.new(subnet['range']).include?(IPAddr.new(subnet['gateway']))
+      end
+    end
+
+    def assert_specifies_director_uuid(manifest)
+      assert manifest.key?('director_uuid'), 'The manifest does not specify the UUID of the bosh director'
+      begin
+        UUIDTools::UUID.parse(manifest['director_uuid'])
+      rescue ArgumentError
+        flunk 'The bosh director UUID is not a well-formed UUID'
+      end
+    end
+
+    def assert_subnet_addresses_in_range(subnet)
+      %w{reserved static}.each do |address_type|
+        Array(subnet[address_type]).each do |addresses|
+          assert addresses_in_range?(addresses, subnet['range']),
+            "The subnet #{address_type} addresses are not within the range #{subnet['range']}"
+        end
+      end
+    end
+
+    def assert_subnet_ranges_do_not_overlap(subnets)
+      ranges = subnets.map{|s| s['range']}
+      ranges.permutation(2).each do |range_a, range_b|
+        refute IPAddr.new(range_a).include?(IPAddr.new(range_b)),
+          "The subnet ranges #{[range_a, range_b].sort.join(' and ')} overlap"
+      end
+    end
+
+    def assert_subnets_are_consistent(networks)
+      networks.each do |network|
+        if network['subnets']
+          network['subnets'].each do |subnet|
+            assert_range_includes_gateway(subnet)
+	    assert_subnet_addresses_in_range(subnet)
+          end
+          assert_subnet_ranges_do_not_overlap(network['subnets'])
+        end
+      end
+    end
+
+    def refute_exceeds_resource_pools(manifest)
+      usage = pool_usage(manifest)
+      pool_sizes(manifest).each_pair do |pool, instances|
+        assert instances >= usage[pool],
+          "The '#{pool}' pool is not large enough (size: #{instances}, wanted: #{usage[pool]})"
+      end
+    end
+
+  end
+
+end

data/lib/bosh-verify-manifest/helpers.rb

@@ -0,0 +1,58 @@
+require 'ipaddr'
+
+module BoshVerifyManifest
+  module Assertions
+    module Helpers
+
+      def addresses_in_range?(addresses, range)
+	unless range.include?('/') and range =~ %r{/[0-9]+$}
+          raise ArgumentError, 'Range must be specified in CIDR format.'
+        end
+        # Can't get the netmask from an IPAddr instance without monkey patching
+	# Consider using an alternate library for this functionality
+        mask = range.split('/').last.to_i
+        if addresses.include?('-')
+          first_and_last_addresses = addresses.split('-').map do |address|
+	    IPAddr.new(address.strip).to_s
+	  end.uniq
+          expanded_range = IPAddr.new(range).to_range.to_a.map{|i| i.to_s}
+          (first_and_last_addresses & expanded_range) == first_and_last_addresses
+        else
+          Array(addresses).all? do |address|
+            if address.include?('-')
+              addresses_in_range?(address, range)
+            else
+              IPAddr.new(range).include?(address)
+            end
+          end
+        end
+      end
+
+      def network(manifest, name)
+        manifest['networks'].find{|n| n['name'] == name} || raise(
+	  "Network '#{name}' not found in the manifest")
+      end
+
+      def pool_names(manifest)
+        manifest['resource_pools'].map{|pool| pool['name']}
+      end
+
+      def pool_sizes(manifest)
+        Hash[manifest['resource_pools'].map{|pool| [pool['name'], pool['size']]}]
+      end
+
+      def pool_usage(manifest)
+        Hash[manifest['jobs'].group_by do |job|
+          job['resource_pool']
+        end.map do |pool, jobs|
+          [pool, jobs.inject(0){|count, job| count += job['instances']}]
+        end]
+      end
+
+      def undeclared_pools(manifest)
+        pool_usage(manifest).keys.sort - pool_names(manifest).sort
+      end
+
+    end
+  end
+end

data/lib/bosh-verify-manifest/infections.rb

@@ -0,0 +1,13 @@
+module BoshVerifyManifest
+  module Infections
+
+    Hash.infect_an_assertion :assert_fills_resource_pools, 'must_fill_resource_pools', :only_one_argument
+    Hash.infect_an_assertion :assert_has_name, 'must_be_named', :only_one_argument
+    Hash.infect_an_assertion :assert_job_addresses_are_appropriate, 'must_have_appropriate_job_addresses', :only_one_argument
+    Hash.infect_an_assertion :assert_specifies_director_uuid, 'must_specify_director_uuid', :only_one_argument
+    Array.infect_an_assertion :assert_subnets_are_consistent, 'must_have_consistent_subnets', :only_one_argument
+    Hash.infect_an_assertion :refute_exceeds_resource_pools, 'wont_exceed_resource_pools', :only_one_argument
+    Hash.infect_an_assertion :assert_declares_all_resource_pools, 'must_declare_all_resource_pools', :only_one_argument
+
+  end
+end

data/lib/bosh-verify-manifest/version.rb

@@ -0,0 +1,4 @@
+module BoshVerifyManifest
+  # The current version of bosh-verify-manifest
+  VERSION = '0.1.0'
+end

data/lib/bosh/cli/commands/verify.rb

@@ -0,0 +1,33 @@
+require 'minitest/spec'
+require 'bosh-verify-manifest/helpers'
+require 'bosh-verify-manifest/assertions'
+
+module Bosh::Cli::Command
+  class VerifyManifest < Base
+
+    include MiniTest::Assertions
+    include BoshVerifyManifest::Assertions
+
+    def manifest
+      @manifest ||= YAML::load(File.read(deployment))
+    end
+
+    usage "verify manifest"
+    desc "Check the BOSH manifest for common errors"
+    def verify_manifest
+      deployment_required
+      begin
+        assert_has_name(manifest)
+        assert_specifies_director_uuid(manifest)
+        assert_subnets_are_consistent(manifest['networks'])
+        assert_job_addresses_are_appropriate(manifest)
+        assert_declares_all_resource_pools(manifest)
+        refute_exceeds_resource_pools(manifest)
+        assert_fills_resource_pools(manifest)
+      rescue MiniTest::Assertion => a
+        err a.to_s
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: bosh-verify-manifest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Crump
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bosh_cli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.4
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+description: Validate BOSH deployment manifests.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bosh-verify-manifest.rb
+- lib/bosh/cli/commands/verify.rb
+- lib/bosh-verify-manifest/infections.rb
+- lib/bosh-verify-manifest/version.rb
+- lib/bosh-verify-manifest/assertions.rb
+- lib/bosh-verify-manifest/helpers.rb
+homepage: http://github.com/cloudcredo/bosh-verify-manifest
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1852599430210049349
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1852599430210049349
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: bosh-verify-manifest-0.1.0
+test_files: []