guard-bosh 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51ca6f0f55880bc7db9d36d693036a5626b228a0
-  data.tar.gz: 269d78e98809510e93ae63d48da0809f8e567270
+  metadata.gz: 55e6d1e34e436b7f4669fada4b65d4681947b44b
+  data.tar.gz: 6249a5b3b822a446e533fd0afc2cd4861f62ce70
 SHA512:
-  metadata.gz: 3a0ba80730401e7a0f7ec1d13c0fba3464fdea1c5c96f6f839bcbfa4f179103271a658bbb8d8f96c9f25b9fa2ced000d4ab50534ca0e72e54d555776f8c0cd5d
-  data.tar.gz: 96ab6eec2791ca84dc582eae3dece52d7a749f835f4646a3f7c3904cee6f2fed76f6a2c6bc0cec06eeade259af44814cd873a8030efcb7f8a887e26d5bb6412f
+  metadata.gz: 8f9f84431e819e25dcfa8676b6c47a4e8b728795539f1337b60f01c2372572bc8b3383bc99c972aea5b469d004d09c59d0813c99a4e977fd1a31e2b8b632d26b
+  data.tar.gz: 40deae949545a9a4fda3327835509d2c921808a1826e47e48a5adc7e1545f03572711d0e5238ba1b869232399747a483189e5e2a498197fea981fa9fa29da939

data/lib/guard/bosh.rb

@@ -1,6 +1,9 @@
 require 'guard/compat/plugin'
+require 'pathname'
+require 'yaml'
 
 module Guard
+  # Guard BOSH Plugin
   class Bosh < Plugin
     require 'pathname'
 
@@ -40,6 +43,7 @@ module Guard
       notify_errors(errors)
     end
 
+    # rubocop:disable Metrics/MethodLength
     def run_on_modifications(paths)
       change_scope, job_name = @change_assessor.determine_scope(paths)
       errors = case change_scope

data/lib/guard/bosh/apply_specification.rb

@@ -1,13 +1,15 @@
-require 'ipaddr'
-
 module Guard
   class Bosh
+    # Simulated BOSH Apply Spec.
     class ApplySpecification
-      def initialize(deployment_manifest:, package_resolver:)
+      def initialize(
+        deployment_manifest:, package_resolver:, network_generator:)
         @manifest = deployment_manifest
         @package_resolver = package_resolver
+        @network_generator = network_generator
       end
 
+      # rubocop:disable Metrics/MethodLength
       def generate(properties:, job_name:)
         {
           'deployment' => @manifest['name'],
@@ -46,12 +48,12 @@ module Guard
         all_packages.inject({}) do |result, package|
           result.merge(
 
-              package => {
-                'name' => package,
-                'version' => '1.0',
-                'sha1' => 'b945ce51b3635bb0ebfb2207323514381bcee824',
-                'blobstore_id' => '608c41bc-d491-4773-9812-8f24276eace1'
-              }
+            package => {
+              'name' => package,
+              'version' => '1.0',
+              'sha1' => 'b945ce51b3635bb0ebfb2207323514381bcee824',
+              'blobstore_id' => '608c41bc-d491-4773-9812-8f24276eace1'
+            }
 
           )
         end
@@ -79,40 +81,8 @@ module Guard
       end
 
       def network(job_name)
-        manifest_job = manifest_job_with_name(job_name)
-        job_network = manifest_job['networks'].first
-        network_definition = @manifest['networks'].find do |n|
-          n['name'] == job_network['name']
-        end
-        {
-          job_network['name'] => {
-            'cloud_properties' => network_definition['subnets'].first['cloud_properties'],
-            'dns_record_name' => dns_record_name(
-              job_name, job_network['name'], @manifest['name']),
-            'ip' => ip_address(job_network, network_definition),
-            'netmask' => netmask(network_definition['subnets'].first['range']),
-            'default' => %w(dns gateway)
-          }
-        }
-      end
-
-      def ip_address(job_network, network_definition)
-        if job_network.key?('static_ips') &&
-           Array(job_network['static_ips']).any?
-          job_network['static_ips'].first
-        else
-          # We could be better here and calculate the dynamic address properly
-          network_definition['subnets'].first['range'].split('/').first
-        end
-      end
-
-      def dns_record_name(job, network, deployment)
-        "0.#{job}.#{network}.#{deployment}.bosh".gsub('_', '-')
-      end
-
-      def netmask(range)
-        cidr = range.split('/').last
-        IPAddr.new('255.255.255.255').mask(cidr).to_s
+        @network_generator.generate(
+          deployment_manifest: @manifest, job_name: job_name)
       end
 
       def resource_pool(job_name)

data/lib/guard/bosh/change_assessor.rb

@@ -1,5 +1,9 @@
+require 'pathname'
+
 module Guard
   class Bosh
+    # Determines the impact of a code change to enable a subset of files to be
+    # re-evaluated.
     class ChangeAssessor
       def initialize(deployment_manifest)
         @deployment_manifest = deployment_manifest
@@ -9,11 +13,7 @@ module Guard
         paths = raw_paths.map { |p| Pathname.new(p) }
         return :all if paths.include?(@deployment_manifest)
 
-        jobs = paths.select { |p| spec_path?(p) }.map do |p|
-          p.dirname.basename.to_s
-        end
-
-        spec_scope = scope(jobs, :all_templates_for_job)
+        spec_scope = scope(jobs_for_paths(paths), :all_templates_for_job)
         return spec_scope if spec_scope
 
         jobs = paths.select { |p| template_path?(p) }.map do |t|
@@ -27,6 +27,12 @@ module Guard
 
       private
 
+      def jobs_for_paths(paths)
+        paths.select { |p| spec_path?(p) }.map do |p|
+          p.dirname.basename.to_s
+        end
+      end
+
       def spec_path?(path)
         path.basename.to_s == 'spec'
       end

data/lib/guard/bosh/effective_properties_calculator.rb

@@ -2,6 +2,10 @@ require 'deep_merge'
 
 module Guard
   class Bosh
+    # The effective set of properties is the union of:
+    # * The default properties declared in the job spec
+    # * The properties declared at the top-level of the manifest
+    # * The properties declared at the job-level of the manifest
     class EffectivePropertiesCalculator
       def initialize(loaders:)
         @loaders = loaders

data/lib/guard/bosh/global_properties_loader.rb

@@ -1,5 +1,7 @@
 module Guard
   class Bosh
+    # Properties defined at the top-level of the manifest. These may be shared
+    # by multiple BOSH jobs.
     class GlobalPropertiesLoader
       def initialize(deployment_manifest:)
         @deployment_manifest = deployment_manifest

data/lib/guard/bosh/job_default_properties_loader.rb

@@ -2,6 +2,7 @@ require 'yaml'
 
 module Guard
   class Bosh
+    # The property defaults (if any) defined for a BOSH job in the job spec.
     class JobDefaultPropertiesLoader
       def initialize(release_dir:)
         @release_dir = release_dir

data/lib/guard/bosh/job_properties_loader.rb

@@ -1,5 +1,6 @@
 module Guard
   class Bosh
+    # The properties defined in the manifest at the job level.
     class JobPropertiesLoader
       def initialize(deployment_manifest:)
         @manifest = deployment_manifest

data/lib/guard/bosh/job_repository.rb

@@ -1,7 +1,9 @@
 require 'pathname'
+require 'yaml'
 
 module Guard
   class Bosh
+    # Wraps access to manifest jobs and templates
     class JobRepository
       def initialize(deployment_manifest)
         @manifest = deployment_manifest

data/lib/guard/bosh/network_generator.rb

@@ -0,0 +1,57 @@
+require 'ipaddr'
+
+module Guard
+  class Bosh
+    # Generates a simulated network section for the apply spec
+    class NetworkGenerator
+      # rubocop:disable Metrics/MethodLength
+      def generate(deployment_manifest:, job_name:)
+        job_network, network_definition =
+          manifest_sections(deployment_manifest, job_name)
+        {
+          job_network['name'] => {
+            'cloud_properties' => network_definition['subnets'].first[
+              'cloud_properties'],
+            'dns_record_name' => dns_record_name(
+              job_name, job_network['name'], deployment_manifest['name']),
+            'ip' => ip_address(job_network, network_definition),
+            'netmask' => netmask(network_definition['subnets'].first['range']),
+            'default' => %w(dns gateway)
+          }
+        }
+      end
+
+      private
+
+      def manifest_sections(deployment_manifest, job_name)
+        manifest_job = deployment_manifest['jobs'].find do |job|
+          job['name'] == job_name
+        end
+        job_network = manifest_job['networks'].first
+        network_definition = deployment_manifest['networks'].find do |n|
+          n['name'] == job_network['name']
+        end
+        [job_network, network_definition]
+      end
+
+      def ip_address(job_network, network_definition)
+        if job_network.key?('static_ips') &&
+           Array(job_network['static_ips']).any?
+          job_network['static_ips'].first
+        else
+          # We could be better here and calculate the dynamic address properly
+          network_definition['subnets'].first['range'].split('/').first
+        end
+      end
+
+      def dns_record_name(job, network, deployment)
+        "0.#{job}.#{network}.#{deployment}.bosh".gsub('_', '-')
+      end
+
+      def netmask(range)
+        cidr = range.split('/').last
+        IPAddr.new('255.255.255.255').mask(cidr).to_s
+      end
+    end
+  end
+end

data/lib/guard/bosh/notifier.rb

@@ -2,18 +2,29 @@ require 'guard/compat'
 
 module Guard
   class Bosh
+    # Report success or failure to the user
     class Notifier
       def notify(errors)
         if errors.empty?
           Guard::Compat::UI.notify(
             'Succeeded', title: 'BOSH', image: :success, priority: -2)
         else
-          Guard::Compat::UI.error(
-            '%s: %s' % [errors.first[:template], errors.first[:detail]])
+          Guard::Compat::UI.error(error_line(errors))
           Guard::Compat::UI.notify(
             'Failed', title: 'BOSH', image: :failed, priority: 2)
         end
       end
+
+      private
+
+      def error_line(errors)
+        error = errors.first
+        [
+          error[:template],
+          error[:line] == :unknown ? '?' : error[:line],
+          " #{error[:detail]}"
+        ].join(':')
+      end
     end
   end
 end

data/lib/guard/bosh/package_resolver.rb

@@ -1,5 +1,8 @@
+require 'yaml'
+
 module Guard
   class Bosh
+    # Packages for a given BOSH job
     class PackageResolver
       def initialize(release_dir)
         @release_dir = release_dir

data/lib/guard/bosh/template_checker.rb

@@ -1,5 +1,16 @@
+require 'guard/bosh/apply_specification'
+require 'guard/bosh/effective_properties_calculator'
+require 'guard/bosh/global_properties_loader'
+require 'guard/bosh/job_default_properties_loader'
+require 'guard/bosh/job_properties_loader'
+require 'guard/bosh/network_generator'
+require 'guard/bosh/package_resolver'
+require 'guard/bosh/template_renderer'
+
 module Guard
   class Bosh
+    # Encapsulates building the apply spec, and rendering job templates against
+    # it to identify errors.
     class TemplateChecker
       def initialize(deployment_manifest:,
                      properties_calculator:,
@@ -22,22 +33,30 @@ module Guard
       end
 
       def self.build(deployment_manifest:, release_dir:)
-        properties_calculator = EffectivePropertiesCalculator.new(loaders: [
+        new(
+          deployment_manifest: deployment_manifest,
+          properties_calculator:
+            properties_calculator(deployment_manifest, release_dir),
+          apply_specification:
+            apply_specification(deployment_manifest, release_dir),
+          template_renderer: TemplateRenderer.new
+        )
+      end
+
+      def self.properties_calculator(deployment_manifest, release_dir)
+        EffectivePropertiesCalculator.new(loaders: [
           JobDefaultPropertiesLoader.new(release_dir: release_dir),
           GlobalPropertiesLoader.new(deployment_manifest: deployment_manifest),
           JobPropertiesLoader.new(deployment_manifest: deployment_manifest)
         ])
-        apply_specification = ApplySpecification.new(
+      end
+
+      def self.apply_specification(deployment_manifest, release_dir)
+        ApplySpecification.new(
           deployment_manifest: deployment_manifest,
+          network_generator: NetworkGenerator.new,
           package_resolver: PackageResolver.new(release_dir)
         )
-        template_renderer = TemplateRenderer.new
-        new(
-          deployment_manifest: deployment_manifest,
-          properties_calculator: properties_calculator,
-          apply_specification: apply_specification,
-          template_renderer: template_renderer
-        )
       end
     end
   end

data/lib/guard/bosh/template_renderer.rb

@@ -4,37 +4,65 @@ require 'bosh/template/unknown_property'
 
 module Guard
   class Bosh
+    # Render a template with the provided context and report any errors.
     class TemplateRenderer
       def render(context:, template:)
         renderer = ::Bosh::Template::Renderer.new(
           context: JSON.generate(context))
 
-        # The re-writing of messages we do here is intended to make the output
-        # more readable, but may not be wise.
         begin
           renderer.render(template)
           { template: template, status: :success, detail: '' }
-        rescue ::Bosh::Template::UnknownProperty => e
-          error(template, "missing property: #{e.name}")
-        rescue NoMethodError => e
-          error(template, e.message.sub(/ for #<[^>]+>$/, ''))
-        rescue NameError => e
-          error(template, e.message.sub(/ for #<[^>]+>$/, ''))
-        rescue SyntaxError => e
-          error(template, e.message.split("\n").first.sub(
-            /^\(erb\):[0-9]+: /, ''))
+        rescue StandardError, SyntaxError => e
+          generate_user_facing_error(template, e)
         end
       end
 
       private
 
-      def error(template, message)
+      def generate_user_facing_error(template, ex)
+        case ex
+        when ::Bosh::Template::UnknownProperty
+          error(template, "missing property: #{ex.name}", line(ex))
+        when NoMethodError, NameError
+          error(template, remove_bosh_template(ex.message), line(ex))
+        when SyntaxError
+          context = find_erb_error(ex.message)
+          error(template, context['message'], context['line'].to_i)
+        end
+      end
+
+      def error(template, message, line)
         {
           template: template,
           status: :failure,
-          detail: message
+          detail: message,
+          line: line
         }
       end
+
+      def line(error)
+        erb_error = find_erb_error(error.backtrace)
+        if erb_error.nil?
+          :unknown
+        else
+          erb_error['line'].to_i
+        end
+      end
+
+      ERB_LINE_PATTERN = /^\(erb\):(?<line>[0-9]+): ?(?<message>.*)/
+
+      def find_erb_error(error_lines)
+        # '(erb):4: syntax error, unexpected keyword_do_block'
+        Array(error_lines).lazy.grep(ERB_LINE_PATTERN) do |error_line|
+          ERB_LINE_PATTERN.match(error_line)
+        end.first
+      end
+
+      def remove_bosh_template(message)
+        # ' for #<Bosh::Template::EvaluationContext:0x00000000000000>'
+        message.sub(/ for #<Bosh::Template::[^>]+>$/, '')
+      end
     end
   end
 end

data/lib/guard/bosh/templates/Guardfile

@@ -3,7 +3,7 @@ directories %w(jobs templates)
 
 manifest_path = 'path/to/manifest.yml'
 guard :bosh, deployment_manifest: manifest_path do
-  watch(%r{^jobs/.*})
+  watch(/^jobs\/.*/)
   watch(manifest_path)
 end
 

data/spec/guard/bosh/apply_specification_spec.rb

@@ -1,11 +1,15 @@
 require 'guard/bosh/apply_specification'
+require 'guard/bosh/network_generator'
+require 'guard/bosh/package_resolver'
 
 describe Guard::Bosh::ApplySpecification do
-  let(:package_resolver) { double }
+  let(:package_resolver) { instance_double(Guard::Bosh::PackageResolver) }
+  let(:network_generator) { instance_double(Guard::Bosh::NetworkGenerator) }
   subject do
     Guard::Bosh::ApplySpecification.new(
       deployment_manifest: manifest_stub,
-      package_resolver: package_resolver
+      package_resolver: package_resolver,
+      network_generator: network_generator
     )
   end
 
@@ -15,26 +19,14 @@ describe Guard::Bosh::ApplySpecification do
       'jobs' => [{
         'instances' => 1,
         'name' => 'redis_leader_z1',
-        'networks' => [{ 'name' => 'redis1', 'static_ips' => ['203.0.113.2'] }],
         'persistent_disk' => 0,
         'resource_pool' => 'small_z1',
         'templates' => [{ 'name' => 'redis', 'release' => 'redis' }]
       }],
-      'networks' => [
-        {
-          'name' => 'redis1',
-          'subnets' =>  [{
-            'cloud_properties' => { 'name' => 'iaas_network_name' },
-            'range' => '203.0.113.2/24',
-            'static' => ['10.244.2.2']
-          }]
-        }
-      ],
       'resource_pools' => [
         {
           'cloud_properties' => { 'name' => 'random' },
           'name' => 'small_z1',
-          'network' => 'redis1',
           'size' => 3,
           'stemcell' => {
             'name' => 'bosh-warden-boshlite-ubuntu-trusty-go_agent',
@@ -46,7 +38,12 @@ describe Guard::Bosh::ApplySpecification do
   end
 
   before do
-    allow(package_resolver).to receive(:resolve).with('redis').and_return(['redis'])
+    allow(package_resolver).to receive(:resolve).with(
+      'redis').and_return(['redis'])
+    allow(network_generator).to receive(:generate).with(
+      deployment_manifest: manifest_stub,
+      job_name: 'redis_leader_z1'
+    )
   end
 
   it 'includes the effective properties provided' do
@@ -94,7 +91,8 @@ describe Guard::Bosh::ApplySpecification do
         'blobstore_id' => '608c41bc-d491-4773-9812-8f24276eace1'
       }
     }
-    expect(package_resolver).to receive(:resolve).with('redis').and_return(['redis'])
+    expect(package_resolver).to receive(:resolve).with(
+      'redis').and_return(['redis'])
     apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
     expect(apply_spec['packages']).to eq(expected_packages)
   end
@@ -104,49 +102,14 @@ describe Guard::Bosh::ApplySpecification do
     expect(apply_spec['configuration_hash']).to_not be_empty
   end
 
-  context 'when the job has a static ip' do
-    it 'includes the network config' do
-      expected_networks = {
-        'redis1' =>  {
-          'cloud_properties' => { 'name' => 'iaas_network_name' },
-          'dns_record_name' => '0.redis-leader-z1.redis1.redis-deployment.bosh',
-          'ip' => '203.0.113.2',
-          'netmask' => '255.255.255.0',
-          'default' => %w(dns gateway)
-        }
-      }
-      apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
-      expect(apply_spec['networks']).to eq(expected_networks)
-    end
-  end
-
-  context 'when the job has a dynamic ip' do
-    let(:manifest_stub_without_static_ip) do
-      manifest_stub.tap do |stub|
-        stub['jobs'].first['networks'].first.delete('static_ips')
-      end
-    end
-
-    subject do
-      Guard::Bosh::ApplySpecification.new(
-        deployment_manifest: manifest_stub_without_static_ip,
-        package_resolver: package_resolver
-      )
-    end
-
-    it 'includes the network config' do
-      expected_networks = {
-        'redis1' =>  {
-          'cloud_properties' => { 'name' => 'iaas_network_name' },
-          'dns_record_name' => '0.redis-leader-z1.redis1.redis-deployment.bosh',
-          'ip' => '203.0.113.2',
-          'netmask' => '255.255.255.0',
-          'default' => %w(dns gateway)
-        }
-      }
-      apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
-      expect(apply_spec['networks']).to eq(expected_networks)
-    end
+  it 'includes the network config' do
+    generated_networks = { 'redis1' => {} }
+    expect(network_generator).to receive(:generate).with(
+      deployment_manifest: manifest_stub,
+      job_name: 'redis_leader_z1'
+    ).and_return(generated_networks)
+    apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
+    expect(apply_spec['networks']).to eq(generated_networks)
   end
 
   it 'includes the resource pool' do

data/spec/guard/bosh/change_assessor_spec.rb

@@ -8,21 +8,21 @@ describe Guard::Bosh::ChangeAssessor do
   end
 
   context 'when a final.yml has been modified' do
-    it 'reports a scope that means the change can be ignored' do
+    it 'reports scope that means the change can be ignored' do
       change_scope, _ = subject.determine_scope(['config/final.yml'])
       expect(change_scope).to eq(:none)
     end
   end
 
   context 'when the deployment manifest has been modified' do
-    it 'reports a scope that means all jobs and templates must be re-evaluated' do
+    it 'reports scope meaning all jobs and templates must be re-evaluated' do
       change_scope, _ = subject.determine_scope(['templates/manifest.yml'])
       expect(change_scope).to eq(:all)
     end
   end
 
   context 'when a job spec has been modified' do
-    it 'reports a scope that means all templates must be evaluated for a single job' do
+    it 'reports scope meaning templates must be evaluated for a single job' do
       change_scope, _ = subject.determine_scope(['jobs/redis/spec'])
       expect(change_scope).to eq(:all_templates_for_job)
     end
@@ -33,18 +33,20 @@ describe Guard::Bosh::ChangeAssessor do
   end
 
   context 'when a job template has been modified' do
-    it 'reports a scope that means a single template must be evaluated for a single job' do
-      change_scope, _ = subject.determine_scope(['jobs/redis/templates/config/redis.conf.erb'])
+    it 'reports scope meaning a single template must be evaluated for a job' do
+      change_scope, _ = subject.determine_scope(
+        ['jobs/redis/templates/config/redis.conf.erb'])
       expect(change_scope).to eq(:single_template)
     end
     it 'reports the correct job name' do
-      _, job_name = subject.determine_scope(['jobs/redis/templates/config/redis.conf.erb'])
+      _, job_name = subject.determine_scope(
+        ['jobs/redis/templates/config/redis.conf.erb'])
       expect(job_name).to eq('redis')
     end
   end
 
   context 'when multiple job specs have been modified across jobs' do
-    it 'reports a scope that means all jobs and templates must be re-evaluated' do
+    it 'reports scope that means all jobs and templates must be re-evaluated' do
       change_scope, _ = subject.determine_scope([
         'jobs/redis/spec',
         'jobs/postgresql/spec'
@@ -54,7 +56,7 @@ describe Guard::Bosh::ChangeAssessor do
   end
 
   context 'when multiple templates have been modified across jobs' do
-    it 'reports a scope that means all jobs and templates must be re-evaluated' do
+    it 'reports scope that means all jobs and templates must be re-evaluated' do
       change_scope, _ = subject.determine_scope([
         'jobs/redis/templates/config/redis.conf.erb',
         'jobs/postgresql/templates/config/pg_hba.conf.erb'

data/spec/guard/bosh/effective_properties_calculator_spec.rb

@@ -27,30 +27,31 @@ describe Guard::Bosh::EffectivePropertiesCalculator do
   it 'merges the properties' do
     expect(job_defaults_loader).to receive(:load_properties).and_return(
 
-        'redis' => {
-          'password' => 'password',
-          'port' => 6379
-        }
+      'redis' => {
+        'password' => 'password',
+        'port' => 6379
+      }
 
     )
     expect(global_properties_loader).to receive(:load_properties).and_return(
 
-        'redis' => {
-          'password' => 'secure-password',
-          'slaves' => ['203.0.113.3', '203.0.113.4']
-        },
-        'network' => 'redis1'
+      'redis' => {
+        'password' => 'secure-password',
+        'slaves' => ['203.0.113.3', '203.0.113.4']
+      },
+      'network' => 'redis1'
 
     )
     expect(job_properties_loader).to receive(:load_properties).and_return(
 
-        'redis' => {
-          'master' => '203.0.113.2'
-        }
+      'redis' => {
+        'master' => '203.0.113.2'
+      }
 
     )
 
-    properties = subject.calculate_effective_properties(manifest_job_name: 'redis_z1')
+    properties = subject.calculate_effective_properties(
+      manifest_job_name: 'redis_z1')
     expect(properties).to eq(
       'redis' => {
         'password' => 'secure-password',

data/spec/guard/bosh/job_default_properties_loader_spec.rb

@@ -38,7 +38,8 @@ describe Guard::Bosh::JobDefaultPropertiesLoader do
 
   it 'returns the properties that have defaults in the job spec' do
     expect(YAML).to receive(:load_file).with(
-      Pathname.new('/path/to/a/release/jobs/job-name/spec')).and_return(job_spec_excerpt)
+      Pathname.new('/path/to/a/release/jobs/job-name/spec')).and_return(
+        job_spec_excerpt)
     job_defaults = subject.load_properties(job_name: 'job-name')
     expect(job_defaults).to include(
       'redis' => {
@@ -54,14 +55,16 @@ describe Guard::Bosh::JobDefaultPropertiesLoader do
 
   it 'ignores properties that do not have defaults defined' do
     expect(YAML).to receive(:load_file).with(
-      Pathname.new('/path/to/a/release/jobs/job-name/spec')).and_return(job_spec_excerpt)
+      Pathname.new('/path/to/a/release/jobs/job-name/spec')).and_return(
+        job_spec_excerpt)
     job_defaults = subject.load_properties(job_name: 'job-name')
     expect(job_defaults['redis'].keys).not_to include('master')
   end
 
   it 'includes an empty hash for intermediate keys' do
     expect(YAML).to receive(:load_file).with(
-      Pathname.new('/path/to/a/release/jobs/job-name/spec')).and_return(job_spec_excerpt)
+      Pathname.new('/path/to/a/release/jobs/job-name/spec')).and_return(
+        job_spec_excerpt)
     job_defaults = subject.load_properties(job_name: 'job-name')
     expect(job_defaults['redis'].keys).to include('blazingly')
     expect(job_defaults['redis']['blazingly']).to be_empty

data/spec/guard/bosh/job_properties_loader_spec.rb

@@ -7,7 +7,9 @@ describe Guard::Bosh::JobPropertiesLoader do
         {
           'instances' => 1,
           'name' => 'redis_leader_z1',
-          'networks' => [{ 'name' => 'redis1', 'static_ips' => ['10.244.2.6'] }],
+          'networks' => [
+            { 'name' => 'redis1', 'static_ips' => ['10.244.2.6'] }
+          ],
           'persistent_disk' => 0,
           'properties' => { 'network' => 'redis1', 'redis' => nil },
           'resource_pool' => 'small_z1',
@@ -16,9 +18,17 @@ describe Guard::Bosh::JobPropertiesLoader do
         {
           'instances' => 2,
           'name' => 'redis_z1',
-          'networks' => [{ 'name' => 'redis1', 'static_ips' => ['10.244.2.10', '10.244.2.14'] }],
+          'networks' => [
+            {
+              'name' => 'redis1',
+              'static_ips' => ['10.244.2.10', '10.244.2.14']
+            }
+          ],
           'persistent_disk' => 0,
-          'properties' => { 'network' => 'redis1', 'redis' => { 'master' => '10.244.2.6' } },
+          'properties' => {
+            'network' => 'redis1',
+            'redis' => { 'master' => '10.244.2.6' }
+          },
           'resource_pool' => 'small_z1',
           'templates' => [{ 'name' => 'redis', 'release' => 'redis' }],
           'update' => { 'canaries' => 10 }

data/spec/guard/bosh/job_repository_spec.rb

@@ -34,18 +34,20 @@ describe Guard::Bosh::JobRepository do
   describe '#find_by_template' do
     context 'when there are multiple jobs that use a job template' do
       it 'returns all jobs that use that template' do
-        expect(subject.find_by_template('redis')).to eq(%w(redis_leader_z1 redis_slave_z2))
+        expect(subject.find_by_template('redis')).to eq(
+          %w(redis_leader_z1 redis_slave_z2))
       end
     end
   end
 
   describe '#template_paths' do
     it 'looks up the template paths from the job specification' do
-      expect(YAML).to receive(:load_file).with(Pathname.new('jobs/redis/spec')).and_return(
-        'templates' => {
-          'redis_ctl.sh.erb' => 'bin/redis_ctl.sh',
-          'redis.conf.erb' => 'config/redis.conf'
-        }
+      expect(YAML).to receive(:load_file).with(
+        Pathname.new('jobs/redis/spec')).and_return(
+          'templates' => {
+            'redis_ctl.sh.erb' => 'bin/redis_ctl.sh',
+            'redis.conf.erb' => 'config/redis.conf'
+          }
       )
       expect(subject.template_paths('redis')).to eq([
         Pathname.new('jobs/redis/templates/redis_ctl.sh.erb'),

data/spec/guard/bosh/network_generator_spec.rb

@@ -0,0 +1,65 @@
+require 'guard/bosh/network_generator'
+
+describe Guard::Bosh::NetworkGenerator do
+  let(:manifest_stub) do
+    {
+      'name' => 'redis-deployment',
+      'jobs' => [{
+        'name' => 'redis_leader_z1',
+        'networks' => [{ 'name' => 'redis1', 'static_ips' => ['203.0.113.2'] }],
+        'templates' => [{ 'name' => 'redis', 'release' => 'redis' }]
+      }],
+      'networks' => [
+        {
+          'name' => 'redis1',
+          'subnets' =>  [{
+            'cloud_properties' => { 'name' => 'iaas_network_name' },
+            'range' => '203.0.113.2/24',
+            'static' => ['10.244.2.2']
+          }]
+        }
+      ]
+    }
+  end
+
+  context 'when the job has a static ip' do
+    it 'includes the network config' do
+      expected_networks = {
+        'redis1' =>  {
+          'cloud_properties' => { 'name' => 'iaas_network_name' },
+          'dns_record_name' => '0.redis-leader-z1.redis1.redis-deployment.bosh',
+          'ip' => '203.0.113.2',
+          'netmask' => '255.255.255.0',
+          'default' => %w(dns gateway)
+        }
+      }
+      generated_networks = subject.generate(
+        deployment_manifest: manifest_stub, job_name: 'redis_leader_z1')
+      expect(generated_networks).to eq(expected_networks)
+    end
+  end
+
+  context 'when the job has a dynamic ip' do
+    let(:manifest_stub_without_static_ip) do
+      manifest_stub.tap do |stub|
+        stub['jobs'].first['networks'].first.delete('static_ips')
+      end
+    end
+
+    it 'includes the network config' do
+      expected_networks = {
+        'redis1' =>  {
+          'cloud_properties' => { 'name' => 'iaas_network_name' },
+          'dns_record_name' => '0.redis-leader-z1.redis1.redis-deployment.bosh',
+          'ip' => '203.0.113.2',
+          'netmask' => '255.255.255.0',
+          'default' => %w(dns gateway)
+        }
+      }
+      generated_networks = subject.generate(
+        deployment_manifest: manifest_stub_without_static_ip,
+        job_name: 'redis_leader_z1')
+      expect(generated_networks).to eq(expected_networks)
+    end
+  end
+end

data/spec/guard/bosh/notifier_spec.rb

@@ -27,14 +27,38 @@ describe Guard::Bosh::Notifier do
         priority: 2
       )
       subject.notify([
-        { template: 'config.erb', status: :failure, detail: 'Missing property: redis.port' }
+        {
+          template: 'config.erb',
+          status: :failure,
+          detail: 'Missing property: redis.port'
+        }
       ])
     end
     it 'outputs the template the error occurred in and the detail' do
-      expect(Guard::Compat::UI).to receive(:error).with('config.erb: Missing property: redis.port')
+      expect(Guard::Compat::UI).to receive(:error).with(
+        'config.erb:10: missing property: redis.port')
       subject.notify([
-        { template: 'config.erb', status: :failure, detail: 'Missing property: redis.port' }
+        {
+          template: 'config.erb',
+          status: :failure,
+          detail: 'missing property: redis.port',
+          line: 10
+        }
       ])
     end
+    context 'when the line number is not known' do
+      it 'outputs the template the error occurred in and the detail' do
+        expect(Guard::Compat::UI).to receive(:error).with(
+          'config.erb:?: missing property: redis.port')
+        subject.notify([
+          {
+            template: 'config.erb',
+            status: :failure,
+            detail: 'missing property: redis.port',
+            line: :unknown
+          }
+        ])
+      end
+    end
   end
 end

data/spec/guard/bosh/template_checker_spec.rb

@@ -23,7 +23,8 @@ describe Guard::Bosh::TemplateChecker do
 
   before do
     allow(properties_calculator).to receive(:calculate_effective_properties)
-    allow(apply_specification).to receive(:generate).and_return('apply' => 'specification')
+    allow(apply_specification).to receive(:generate).and_return(
+      'apply' => 'specification')
     allow(template_renderer).to receive(:render)
   end
 
@@ -56,7 +57,8 @@ describe Guard::Bosh::TemplateChecker do
   end
 
   it 'returns any errors generated by the template render' do
-    expect(template_renderer).to receive(:render).and_return(['missing property'])
+    expect(template_renderer).to receive(:render).and_return(
+      ['missing property'])
     errors = subject.check(
       manifest_job_name: 'redis_leader_z1',
       job_name: 'redis',

data/spec/guard/bosh/template_renderer_spec.rb

@@ -21,15 +21,28 @@ describe Guard::Bosh::TemplateRenderer do
     end
   end
 
+  let(:backtrace) do
+    [
+      "gems/bosh-template-0/lib/bosh/template/evaluation_context.rb:00:in `p'",
+      "(erb):3:in `get_binding'",
+      "rubies/ruby-0.0.0/lib/ruby/0.0.0/erb.rb:000:in `eval'"
+    ]
+  end
+
+  def with_backtrace(error)
+    error.tap { |e| e.set_backtrace(backtrace) }
+  end
+
   context 'when the template refers to an unknown property' do
     it 'reports the missing property' do
       expect(bosh_renderer).to receive(:render).with('config.erb').and_raise(
-        ::Bosh::Template::UnknownProperty.new('redis.port'))
+        with_backtrace(::Bosh::Template::UnknownProperty.new('redis.port')))
       result = subject.render(context: {}, template: 'config.erb')
       expect(result).to eq(
         template: 'config.erb',
         status: :failure,
-        detail: 'missing property: redis.port'
+        detail: 'missing property: redis.port',
+        line: 3
       )
     end
   end
@@ -37,12 +50,19 @@ describe Guard::Bosh::TemplateRenderer do
   context 'when the template calls a misnamed helper method' do
     it 'reports the missing helper method' do
       expect(bosh_renderer).to receive(:render).with('config.erb').and_raise(
-        NoMethodError.new("undefined method `o' for #<Bosh::Template::EvaluationContext:0x00000000000000>"))
+        with_backtrace(
+          NoMethodError.new(
+            "undefined method `o' for "\
+            '#<Bosh::Template::EvaluationContext:0x00000000000000>'
+          )
+        )
+      )
       result = subject.render(context: {}, template: 'config.erb')
       expect(result).to eq(
         template: 'config.erb',
         status: :failure,
-        detail: "undefined method `o'"
+        detail: "undefined method `o'",
+        line: 3
       )
     end
   end
@@ -50,12 +70,19 @@ describe Guard::Bosh::TemplateRenderer do
   context 'when the template references a missing name' do
     it 'reports the missing name' do
       expect(bosh_renderer).to receive(:render).with('config.erb').and_raise(
-        NameError.new("undefined local variable or method `missing' for #<Bosh::Template::EvaluationContext:0x00000000000000>"))
+        with_backtrace(
+          NameError.new(
+            "undefined local variable or method `missing' for "\
+            '#<Bosh::Template::EvaluationContext:0x00000000000000>'
+          )
+        )
+      )
       result = subject.render(context: {}, template: 'config.erb')
       expect(result).to eq(
         template: 'config.erb',
         status: :failure,
-        detail: "undefined local variable or method `missing'"
+        detail: "undefined local variable or method `missing'",
+        line: 3
       )
     end
   end
@@ -63,13 +90,35 @@ describe Guard::Bosh::TemplateRenderer do
   context 'when the template is not well-formed' do
     it 'reports the template error' do
       expect(bosh_renderer).to receive(:render).with('config.erb').and_raise(
-        SyntaxError.new("(erb):7: syntax error, unexpected end-of-input, expecting keyword_end\n; _erbout.force_encoding(__ENCODING__)"))
+        with_backtrace(
+          SyntaxError.new(
+            '(erb):7: syntax error, unexpected end-of-input, '\
+            "expecting keyword_end\n; _erbout.force_encoding(__ENCODING__)"
+          )
+        )
+      )
       result = subject.render(context: {}, template: 'config.erb')
       expect(result).to eq(
         template: 'config.erb',
         status: :failure,
-        detail: 'syntax error, unexpected end-of-input, expecting keyword_end'
+        detail: 'syntax error, unexpected end-of-input, expecting keyword_end',
+        line: 7
       )
     end
   end
+
+  context 'when the backtrace does not include an (erb) line' do
+    it 'reports the template error but without a line number' do
+      error = NameError.new(
+        "undefined local variable or method `missing' for "\
+        '#<Bosh::Template::EvaluationContext:0x00000000000000>')
+      error.set_backtrace([
+        "gems/bosh-template-0/lib/bosh/template/evaluation_context.rb:00:in `p'"
+      ])
+      expect(bosh_renderer).to receive(:render).with(
+        'config.erb').and_raise(error)
+      result = subject.render(context: {}, template: 'config.erb')
+      expect(result).to include(line: :unknown)
+    end
+  end
 end

data/spec/guard/bosh_spec.rb

@@ -100,10 +100,11 @@ describe Guard::Bosh do
       expect(job_repository).to receive(:find_by_template).with(
         'redis').and_return(%w(redis_leader_z1 redis_slave_z2))
 
-      expect(job_repository).to receive(:template_paths).with('redis').and_return([
-        'jobs/redis/templates/redis_ctl.sh.erb',
-        'jobs/redis/templates/redis.conf.erb'
-      ])
+      expect(job_repository).to receive(:template_paths).with(
+        'redis').and_return([
+          'jobs/redis/templates/redis_ctl.sh.erb',
+          'jobs/redis/templates/redis.conf.erb'
+        ])
     end
     context 'when there are no errors' do
       it 'checks the template for errors' do
@@ -137,20 +138,22 @@ describe Guard::Bosh do
     before do
       expect(job_repository).to receive(:job_templates).and_return(
         %w(postgresql redis))
-      expect(job_repository).to receive(:template_paths).with('postgresql').and_return([
-        'jobs/postgresql/templates/pg_hba.conf.erb'
-      ])
-      expect(job_repository).to receive(:template_paths).with('redis').and_return([
-        'jobs/redis/templates/redis_ctl.sh.erb',
-        'jobs/redis/templates/redis.conf.erb'
-      ])
+      expect(job_repository).to receive(:template_paths).with(
+        'postgresql').and_return([
+          'jobs/postgresql/templates/pg_hba.conf.erb'
+        ])
+      expect(job_repository).to receive(:template_paths).with(
+        'redis').and_return([
+          'jobs/redis/templates/redis_ctl.sh.erb',
+          'jobs/redis/templates/redis.conf.erb'
+        ])
       expect(template_checker).to receive(:check).with(
         manifest_job_name: 'redis_slave_z2',
         job_name: 'redis',
         template: 'jobs/redis/templates/redis.conf.erb'
       ).and_return([])
       expect(job_repository).to receive(:find_by_template).with(
-      'redis').and_return(%w(redis_leader_z1 redis_slave_z2))
+        'redis').and_return(%w(redis_leader_z1 redis_slave_z2))
       expect(job_repository).to receive(:find_by_template).with(
         'postgresql').and_return(['postgresql_z1'])
       expect(template_checker).to receive(:check).with(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-bosh
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Crump
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bosh-template
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +137,7 @@ files:
 - lib/guard/bosh/job_default_properties_loader.rb
 - lib/guard/bosh/job_properties_loader.rb
 - lib/guard/bosh/job_repository.rb
+- lib/guard/bosh/network_generator.rb
 - lib/guard/bosh/notifier.rb
 - lib/guard/bosh/package_resolver.rb
 - lib/guard/bosh/template_checker.rb
@@ -135,6 +150,7 @@ files:
 - spec/guard/bosh/job_default_properties_loader_spec.rb
 - spec/guard/bosh/job_properties_loader_spec.rb
 - spec/guard/bosh/job_repository_spec.rb
+- spec/guard/bosh/network_generator_spec.rb
 - spec/guard/bosh/notifier_spec.rb
 - spec/guard/bosh/package_resolver_spec.rb
 - spec/guard/bosh/template_checker_spec.rb
@@ -161,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Fast feedback when developing BOSH releases