guard-bosh 0.1.0

data/lib/guard/bosh/notifier.rb

@@ -0,0 +1,19 @@
+require 'guard/compat'
+
+module Guard
+  class Bosh
+    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.notify(
+            'Failed', title: 'BOSH', image: :failed, priority: 2)
+        end
+      end
+    end
+  end
+end

data/lib/guard/bosh/package_resolver.rb

@@ -0,0 +1,14 @@
+module Guard
+  class Bosh
+    class PackageResolver
+      def initialize(release_dir)
+        @release_dir = release_dir
+      end
+
+      def resolve(job)
+        job_spec = @release_dir + 'jobs' + job + 'spec'
+        YAML.load_file(job_spec)['packages']
+      end
+    end
+  end
+end

data/lib/guard/bosh/template_checker.rb

@@ -0,0 +1,44 @@
+module Guard
+  class Bosh
+    class TemplateChecker
+      def initialize(deployment_manifest:,
+                     properties_calculator:,
+                     apply_specification:,
+                     template_renderer:)
+        @deployment_manifest = deployment_manifest
+        @properties_calculator = properties_calculator
+        @apply_specification = apply_specification
+        @template_renderer = template_renderer
+      end
+
+      def check(manifest_job_name:, job_name:, template:)
+        properties = @properties_calculator.calculate_effective_properties(
+          manifest_job_name: manifest_job_name, job_name: job_name)
+        apply_spec = @apply_specification.generate(
+          properties: properties,
+          job_name: manifest_job_name
+        )
+        @template_renderer.render(context: apply_spec, template: template)
+      end
+
+      def self.build(deployment_manifest:, release_dir:)
+        properties_calculator = 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(
+          deployment_manifest: deployment_manifest,
+          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
+end

data/lib/guard/bosh/template_renderer.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'bosh/template/renderer'
+require 'bosh/template/unknown_property'
+
+module Guard
+  class Bosh
+    class TemplateRenderer
+      def render(context:, template:)
+        renderer = ::Bosh::Template::Renderer.new(
+          context: JSON.generate(context))
+        begin
+          renderer.render(template)
+          { template: template, status: :success, detail: '' }
+        rescue ::Bosh::Template::UnknownProperty => e
+          {
+            template: template,
+            status: :failure,
+            detail: "Missing property: #{e.name}"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/guard/bosh/templates/Guardfile

@@ -0,0 +1,10 @@
+clearing :on
+directories %w(jobs templates)
+
+manifest_path = 'path/to/manifest.yml'
+guard :bosh, deployment_manifest: manifest_path do
+  watch(%r{^jobs/.*})
+  watch(manifest_path)
+end
+
+notification :tmux, display_message: true

data/spec/guard/bosh/apply_specification_spec.rb

@@ -0,0 +1,184 @@
+require 'guard/bosh/apply_specification'
+
+describe Guard::Bosh::ApplySpecification do
+  let(:package_resolver) { double }
+  subject do
+    Guard::Bosh::ApplySpecification.new(
+      deployment_manifest: manifest_stub,
+      package_resolver: package_resolver
+    )
+  end
+
+  let(:manifest_stub) do
+    {
+      'name' => 'redis-deployment',
+      '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',
+            'version' => '389'
+          }
+        }
+      ]
+    }
+  end
+
+  before do
+    allow(package_resolver).to receive(:resolve).with('redis').and_return(['redis'])
+  end
+
+  it 'includes the effective properties provided' do
+    effective_properties = {
+      'redis' => {
+        'master' => '203.0.113.2'
+      }
+    }
+    apply_spec = subject.generate(
+      properties: effective_properties, job_name: 'redis_leader_z1')
+    expect(apply_spec['properties']).to include(effective_properties)
+  end
+
+  it 'includes a job index' do
+    apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
+    expect(apply_spec['index']).to eq(0)
+  end
+
+  it 'includes the job details' do
+    expected_job = {
+      'name' => 'redis_leader_z1',
+      'template' => 'redis',
+      'version' => '1',
+      'sha1' => 'c7f277de5b283e5ceffe55674dc56fad2257ecab',
+      'blobstore_id' => '8a66ab45-4831-4ce3-aa8f-313fe33a9891',
+      'templates' => [
+        {
+          'name' => 'redis',
+          'version' => '1',
+          'sha1' => '88d6ea417857efda58916f9cb9bd5dd3a0f76f00',
+          'blobstore_id' => '2356dff1-18fd-4314-a9bd-199b9d6c5c45'
+        }
+      ]
+    }
+    apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
+    expect(apply_spec['job']).to eq(expected_job)
+  end
+
+  it 'includes the package details' do
+    expected_packages = {
+      'redis' => {
+        'name' => 'redis',
+        'version' => '1.0',
+        'sha1' => 'b945ce51b3635bb0ebfb2207323514381bcee824',
+        'blobstore_id' => '608c41bc-d491-4773-9812-8f24276eace1'
+      }
+    }
+    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
+
+  it 'includes a dummy configuration hash' do
+    apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
+    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
+  end
+
+  it 'includes the resource pool' do
+    resource_pool = {
+      'cloud_properties' => {
+        'name' => 'random'
+      },
+      'name' => 'small_z1',
+      'stemcell' => {
+        'name' => 'bosh-warden-boshlite-ubuntu-trusty-go_agent',
+        'version' => '389'
+      }
+    }
+    apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
+    expect(apply_spec['resource_pool']).to eq(resource_pool)
+  end
+
+  it 'includes the deployment name' do
+    apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
+    expect(apply_spec['deployment']).to eq('redis-deployment')
+  end
+
+  it 'includes the persistent disk' do
+    apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
+    expect(apply_spec['persistent_disk']).to eq(0)
+  end
+
+  it 'includes a dummy rendered templates archive' do
+    apply_spec = subject.generate(properties: {}, job_name: 'redis_leader_z1')
+    expect(apply_spec['rendered_templates_archive']).to eq(
+      'sha1' => 'c299ead74faf9ee9b47b3548e5df427e3e9a2c70',
+      'blobstore_id' => '72fb06ef-0f40-4280-85e8-b5930e672308'
+    )
+  end
+end

data/spec/guard/bosh/change_assessor_spec.rb

@@ -0,0 +1,65 @@
+require 'guard/bosh/change_assessor'
+
+require 'pathname'
+
+describe Guard::Bosh::ChangeAssessor do
+  subject do
+    Guard::Bosh::ChangeAssessor.new(Pathname.new('templates/manifest.yml'))
+  end
+
+  context 'when a final.yml has been modified' do
+    it 'reports a 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
+      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
+      change_scope, _ = subject.determine_scope(['jobs/redis/spec'])
+      expect(change_scope).to eq(:all_templates_for_job)
+    end
+    it 'reports the correct job name' do
+      _, job_name = subject.determine_scope(['jobs/redis/spec'])
+      expect(job_name).to eq('redis')
+    end
+  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'])
+      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'])
+      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
+      change_scope, _ = subject.determine_scope([
+        'jobs/redis/spec',
+        'jobs/postgresql/spec'
+      ])
+      expect(change_scope).to eq(:all)
+    end
+  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
+      change_scope, _ = subject.determine_scope([
+        'jobs/redis/templates/config/redis.conf.erb',
+        'jobs/postgresql/templates/config/pg_hba.conf.erb'
+      ])
+      expect(change_scope).to eq(:all)
+    end
+  end
+end

data/spec/guard/bosh/effective_properties_calculator_spec.rb

@@ -0,0 +1,64 @@
+require 'guard/bosh/job_properties_loader'
+require 'guard/bosh/job_default_properties_loader'
+require 'guard/bosh/global_properties_loader'
+require 'guard/bosh/effective_properties_calculator'
+
+describe Guard::Bosh::EffectivePropertiesCalculator do
+  let(:job_defaults_loader) do
+    instance_double(Guard::Bosh::JobDefaultPropertiesLoader)
+  end
+
+  let(:global_properties_loader) do
+    instance_double(Guard::Bosh::GlobalPropertiesLoader)
+  end
+
+  let(:job_properties_loader) do
+    instance_double(Guard::Bosh::JobPropertiesLoader)
+  end
+
+  subject do
+    Guard::Bosh::EffectivePropertiesCalculator.new(loaders: [
+      job_defaults_loader,
+      global_properties_loader,
+      job_properties_loader
+    ])
+  end
+
+  it 'merges the properties' do
+    expect(job_defaults_loader).to receive(:load_properties).and_return(
+
+        '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'
+
+    )
+    expect(job_properties_loader).to receive(:load_properties).and_return(
+
+        'redis' => {
+          'master' => '203.0.113.2'
+        }
+
+    )
+
+    properties = subject.calculate_effective_properties(manifest_job_name: 'redis_z1')
+    expect(properties).to eq(
+      'redis' => {
+        'password' => 'secure-password',
+        'port' => 6379,
+        'master' => '203.0.113.2',
+        'slaves' => ['203.0.113.3', '203.0.113.4']
+      },
+      'network' => 'redis1'
+    )
+  end
+end

data/spec/guard/bosh/global_properties_loader_spec.rb

@@ -0,0 +1,38 @@
+require 'guard/bosh/global_properties_loader'
+
+describe Guard::Bosh::GlobalPropertiesLoader do
+  let(:deployment_manifest) do
+    {
+      'jobs' => %w(some jobs),
+      'networks' => %w(some networks),
+      'properties' => {
+        'global' => 'property'
+      }
+    }
+  end
+  let(:deployment_manifest_without_global_properties) do
+    deployment_manifest.tap do |manifest|
+      manifest.delete('properties')
+    end
+  end
+  subject do
+    Guard::Bosh::GlobalPropertiesLoader.new(
+      deployment_manifest: deployment_manifest)
+  end
+
+  context 'when the manifest contains global properties section' do
+    it 'returns them' do
+      expect(subject.load_properties('ignored')).to eq('global' => 'property')
+    end
+  end
+
+  context 'when the manifest does not contain a global properties section' do
+    subject do
+      Guard::Bosh::GlobalPropertiesLoader.new(
+        deployment_manifest: deployment_manifest_without_global_properties)
+    end
+    it 'returns an empty' do
+      expect(subject.load_properties('ignored')).to be_empty
+    end
+  end
+end