bosh-template 1.3262.24.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1412630af5e936ad0684c3a26de987c2a51d4895
-  data.tar.gz: 3f61c19de023c59e19a81af462b6af46518bebfc
+  metadata.gz: 2378abe7a780eedfde0662cecff0c3431262493b
+  data.tar.gz: 0d007a700bb85ba2bef9a076e63ae45a29dd447b
 SHA512:
-  metadata.gz: 5022ecdd77d1c0783f0b0ca18062703bf83ae9a8ce33a7b80439aa016fc3ace3569fdec26bb757247e574e53ce1b672c0e8726f620b0a1fe786e8ae93163b74f
-  data.tar.gz: 2cc3308812842ba9362bcc7e0579f4e6771e9691485a24207ff436029c481393ea1c69970f53f564bc0453308c911cd839a832ad3f189abd9bf147651c99e61c
+  metadata.gz: f96497f3c1d86cd259ef7fb1d1b70f02c5196553660d39c95be450c431e7eebbe076fc246ef409fd5bd056d1611203f07bbef7284625279848334c593abb689d
+  data.tar.gz: e3b70178abec3413f4dbd0008d8883534860a05f88011b0201ac20cbe996428219e4d9648c309c89b21e3097a22e8caa92c60771b9369eb5ef37f03f1cc8f508

data/README.md

@@ -9,3 +9,31 @@ gem install bosh-template
 
 bosh-template <template.erb> --context '{ "...": ... }'
 ```
+
+## Unit-testing your release ERB templates
+
+The `Bosh::Template::Test` package provides classes to unit-test your templates. These classes can be used to mock out different combinations of links, instances, etc., without the need to script a `create-release` and `deploy` against a running director.
+
+Examples of usage are provided in `src/spec/config.erb_spec.rb` in `template-test-release`.
+
+When you create your own release, you can likewise create a tests folder in your release and use these classes. A release author can create a test and call the template rendering like such:
+
+```ruby
+let(:job) {release.job('JOB-NAME')}  # e.g. 'web-server;
+let(:template) {job.template('PATH-TO-TEMPLATE')}  # e.g. 'config/config-with-nested'
+let(:manifest) {
+  'cert' => '----- BEGIN ... -----',
+  'port' => 42,
+}
+let(:instance) { InstanceSpec.new(name:'instance-name', az: 'az1', bootstrap: true) }
+let(:link_instance) { InstanceSpec.new(name:'link-instance-name', az: 'az2') }
+let(:link_properties){
+   'link-key' => 'link-value',
+}
+let(:link) { Link.new(name:'link-name', instances:[link_instance], properties: link_properties)}
+
+
+rendered_template = JSON.parse(template.render(manifest, spec: instance, consumes: [link]))
+```
+
+And then check that their template rendered as they expected.

data/lib/bosh/template.rb

@@ -4,3 +4,4 @@ module Bosh
 end
 
 require 'bosh/template/evaluation_context'
+require 'bosh/template/test'

data/lib/bosh/template/evaluation_context.rb

@@ -5,6 +5,7 @@ require 'bosh/template/unknown_link'
 require 'bosh/template/property_helper'
 require 'bosh/template/evaluation_link_instance'
 require 'bosh/template/evaluation_link'
+require 'bosh/template/manual_link_dns_encoder'
 
 module Bosh
   module Template
@@ -28,7 +29,7 @@ module Bosh
       attr_reader :spec
 
       # @param [Hash] spec Template spec
-      def initialize(spec)
+      def initialize(spec, dns_encoder)
         unless spec.is_a?(Hash)
           raise EvaluationFailed,
                 'Invalid spec provided for template evaluation context, ' +
@@ -45,6 +46,7 @@ module Bosh
         @spec = openstruct(spec, BackCompatOpenStruct)
         @raw_properties = spec['properties'] || {}
         @properties = openstruct(@raw_properties)
+        @dns_encoder = dns_encoder
 
         @links = spec['links'] || {}
       end
@@ -94,14 +96,29 @@ module Bosh
       end
 
       def link(name)
-        result = lookup_property(@links, name)
-        raise UnknownLink.new(name) if result.nil?
+        link_spec = lookup_property(@links, name)
+        raise UnknownLink.new(name) if link_spec.nil?
 
-        if result.has_key?("instances")
-          instance_array = result["instances"].map do |link_spec|
-            EvaluationLinkInstance.new(link_spec["name"], link_spec["index"], link_spec["id"], link_spec["az"], link_spec["address"], link_spec["properties"], link_spec["bootstrap"])
+        if link_spec.has_key?('instances')
+          link_instances = link_spec['instances'].map do |instance_link_spec|
+            EvaluationLinkInstance.new(instance_link_spec['name'], instance_link_spec['index'], instance_link_spec['id'], instance_link_spec['az'], instance_link_spec['address'], instance_link_spec['properties'], instance_link_spec['bootstrap'])
           end
-          return EvaluationLink.new(instance_array, result["properties"])
+
+          if link_spec.has_key?('address')
+            encoder_to_inject = ManualLinkDnsEncoder.new(link_spec['address'])
+          else
+            encoder_to_inject = @dns_encoder
+          end
+
+          return EvaluationLink.new(
+            link_instances,
+            link_spec['properties'],
+            link_spec['instance_group'],
+            link_spec['default_network'],
+            link_spec['deployment_name'],
+            link_spec['domain'],
+            encoder_to_inject,
+          )
         end
         raise UnknownLink.new(name)
       end
@@ -124,15 +141,15 @@ module Bosh
       # @param [String] name of the link
       # @yield [Object] link, which is an array of instances
       def if_link(name)
-        link_found = lookup_property(@links, name)
-        if link_found.nil? || !link_found.has_key?("instances")
+        link_spec = lookup_property(@links, name)
+        if link_spec.nil? || !link_spec.has_key?('instances')
           return ActiveElseBlock.new(self)
         else
-          instance_array = link_found["instances"].map do |link_spec|
-            EvaluationLinkInstance.new(link_spec["name"], link_spec["index"], link_spec["id"], link_spec["az"], link_spec["address"], link_spec["properties"], link_spec["bootstrap"])
+          link_instances = link_spec['instances'].map do |instance_link_spec|
+            EvaluationLinkInstance.new(instance_link_spec['name'], instance_link_spec['index'], instance_link_spec['id'], instance_link_spec['az'], instance_link_spec['address'], instance_link_spec['properties'], instance_link_spec['bootstrap'])
           end
 
-          yield EvaluationLink.new(instance_array, link_found["properties"])
+          yield EvaluationLink.new(link_instances, link_spec['properties'], link_spec['instance_group'], link_spec['default_network'], link_spec['deployment_name'], link_spec['root_domain'], @dns_encoder)
           InactiveElseBlock.new
         end
       end

data/lib/bosh/template/evaluation_link.rb

@@ -1,3 +1,5 @@
+require 'bosh/template/property_helper'
+
 module Bosh
   module Template
     class EvaluationLink
@@ -6,9 +8,14 @@ module Bosh
       attr_reader :instances
       attr_reader :properties
 
-      def initialize(instances, properties)
+      def initialize(instances, properties, instance_group, default_network, deployment_name, root_domain, dns_encoder)
         @instances = instances
         @properties = properties
+        @instance_group = instance_group
+        @default_network = default_network
+        @deployment_name = deployment_name
+        @root_domain = root_domain
+        @dns_encoder = dns_encoder
       end
 
       def p(*args)
@@ -33,6 +40,19 @@ module Bosh
         yield *values
         Bosh::Template::EvaluationContext::InactiveElseBlock.new
       end
+
+      def address(criteria = {})
+        raise NotImplementedError.new('link.address requires bosh director') if @dns_encoder.nil?
+
+        full_criteria = criteria.merge(
+          instance_group: @instance_group,
+          default_network: @default_network,
+          deployment_name: @deployment_name,
+          root_domain: @root_domain,
+        )
+
+        @dns_encoder.encode_query(full_criteria)
+      end
     end
   end
-end
+end

data/lib/bosh/template/manual_link_dns_encoder.rb

@@ -0,0 +1,13 @@
+module Bosh
+  module Template
+    class ManualLinkDnsEncoder
+      def initialize(manual_link_address)
+        @manual_link_address = manual_link_address
+      end
+
+      def encode_query(_)
+        @manual_link_address
+      end
+    end
+  end
+end

data/lib/bosh/template/property_helper.rb

@@ -45,6 +45,46 @@ module Bosh
 
         ref
       end
+
+      def sort_property(property)
+        if property.is_a?(Hash)
+          property.each do |k, v|
+            property[k] = sort_property(v)
+          end.sort.to_h
+        else
+          property
+        end
+      end
+
+      # Inject property with a given name and value to dst.
+      # @param [Hash] dst Property destination
+      # @param [String] name Property name (dot-separated)
+      # @param [Object] value Property value to be set
+      def set_property(dst, name, value)
+        keys = name.split('.')
+        dst_ref = dst
+
+        keys[0..-2].each do |key|
+          dst_ref[key] ||= {}
+          dst_ref = dst_ref[key]
+        end
+
+        dst_ref[keys[-1]] = value
+      end
+      
+      def validate_properties_format(properties, name)
+        keys = name.split('.')
+        properties_ref = properties
+
+        keys.each do |key|
+          unless properties_ref.is_a?(Hash)
+            raise Bosh::Template::InvalidPropertyType,
+                  "Property '#{name}' expects a hash, but received '#{properties_ref.class}'"
+          end
+          properties_ref = properties_ref[key]
+          break if properties_ref.nil? # no property with this name is src
+        end
+      end
     end
   end
 end

data/lib/bosh/template/renderer.rb

@@ -11,7 +11,7 @@ module Bosh
 
       def render(template_name)
         spec = JSON.parse(@context)
-        evaluation_context = EvaluationContext.new(spec)
+        evaluation_context = EvaluationContext.new(spec, nil)
         template = ERB.new(File.read(template_name), safe_level = nil, trim_mode = "-")
         template.result(evaluation_context.get_binding)
       end

data/lib/bosh/template/test.rb

@@ -0,0 +1,14 @@
+module Bosh
+  module Template
+    module Test
+
+    end
+  end
+end
+
+require 'bosh/template/test/job'
+require 'bosh/template/test/link'
+require 'bosh/template/test/link_instance'
+require 'bosh/template/test/release_dir'
+require 'bosh/template/test/instance_spec'
+require 'bosh/template/test/template'

data/lib/bosh/template/test/instance_spec.rb

@@ -0,0 +1,40 @@
+module Bosh::Template::Test
+  class InstanceSpec
+    def initialize(
+        address: 'my.bosh.com',
+        az: 'az1',
+        bootstrap: false,
+        deployment: 'my-deployment',
+        id: 'xxxxxx-xxxxxxxx-xxxxx',
+        index: 0,
+        ip: '192.168.0.0',
+        name: 'me',
+        networks: {'network1' => {'foo' => 'bar', 'ip' => '192.168.0.0'}}
+    )
+      @address = address
+      @az = az
+      @bootstrap = bootstrap
+      @deployment = deployment
+      @id = id
+      @index = index
+      @ip = ip
+      @name = name
+      @networks = networks
+    end
+
+    def to_h
+      {
+        'address' => @address,
+        'az' => @az,
+        'bootstrap' => @bootstrap,
+        'deployment' => @deployment,
+        'id' => @id,
+        'index' => @index,
+        'ip' => @ip,
+        'name' => @name,
+        'networks' => @networks,
+        'job' => {'name' => @name}
+      }
+    end
+  end
+end

data/lib/bosh/template/test/job.rb

@@ -0,0 +1,20 @@
+module Bosh::Template::Test
+  class Job
+    def initialize(release_path, name)
+      @release_path = release_path
+      @name = name
+      @job_path = File.join(@release_path, 'jobs', @name)
+      # raise "No such job at path: #{@job_path}" if !File.exist?(@job_path)
+      spec_path = File.join(@job_path, 'spec')
+      @spec = YAML.load(File.read(spec_path))
+      @templates = @spec['templates']
+    end
+
+    def template(rendered_file_name)
+      @templates.each_pair do |k, v|
+        return Template.new(@spec, File.join(@job_path, 'templates', k)) if v == rendered_file_name
+      end
+      raise "Template for rendered path filename not found: #{rendered_file_name}. Possible values are: [#{@templates.values.join(', ')}]"
+    end
+  end
+end

data/lib/bosh/template/test/link.rb

@@ -0,0 +1,19 @@
+module Bosh::Template::Test
+  class Link
+    attr_reader :instances, :name, :properties
+
+    def initialize(name:, instances: [], properties: {})
+      @instances = instances
+      @name = name
+      @properties = properties
+    end
+
+    def to_h
+      {
+        'instances' => instances.map(&:to_h),
+        'name' => name,
+        'properties' => properties,
+      }
+    end
+  end
+end

data/lib/bosh/template/test/link_instance.rb

@@ -0,0 +1,31 @@
+module Bosh::Template::Test
+  class LinkInstance
+    attr_reader :name, :id, :index, :az, :address, :bootstrap
+
+    def initialize(
+      name: 'i-name',
+        id: 'jkl8098',
+        index: 4,
+        az: 'az4',
+        address: 'link.instance.address.com',
+        bootstrap: false)
+      @bootstrap = bootstrap
+      @address = address
+      @az = az
+      @index = index
+      @id = id
+      @name = name
+    end
+
+    def to_h
+      {
+        'name' => name,
+        'id' => id,
+        'index' => index,
+        'az' => az,
+        'address' => address,
+        'bootstrap' => bootstrap
+      }
+    end
+  end
+end

data/lib/bosh/template/test/release_dir.rb

@@ -0,0 +1,11 @@
+module Bosh::Template::Test
+  class ReleaseDir
+    def initialize(path)
+      @path = path
+    end
+
+    def job(name)
+      Bosh::Template::Test::Job.new(@path, name)
+    end
+  end
+end

data/lib/bosh/template/test/template.rb

@@ -0,0 +1,77 @@
+require 'bosh/template/evaluation_context'
+require 'bosh/template/evaluation_context'
+
+module Bosh::Template
+  module Test
+    class Template
+      include PropertyHelper
+
+      def initialize(job_spec_hash, template_path)
+        @job_spec_hash = job_spec_hash
+        @template_path = template_path
+      end
+
+      def render(manifest_properties_hash, spec: InstanceSpec.new, consumes: [])
+        spec_hash = {}
+        spec_hash['properties'] = hash_with_defaults(manifest_properties_hash)
+        sanitized_hash_with_spec = spec_hash.merge(spec.to_h)
+        sanitized_hash_with_spec['links'] = links_hash(consumes)
+
+        binding = Bosh::Template::EvaluationContext.new(sanitized_hash_with_spec, nil).get_binding
+        raise "No such file at #{@template_path}" unless File.exist?(@template_path)
+        ERB.new(File.read(@template_path)).result(binding)
+      end
+
+      private
+
+      def hash_with_defaults(manifest_properties_hash)
+        hash_properties = {}
+        spec_properties = @job_spec_hash['properties']
+
+        spec_properties.each_pair do |dotted_spec_key, property_def|
+          property_val = lookup_property(manifest_properties_hash, dotted_spec_key)
+          if property_val.nil? && !property_def['default'].nil?
+            property_val = property_def['default']
+          end
+          insert_property(hash_properties, dotted_spec_key, property_val)
+        end
+
+        hash_properties
+      end
+
+      def links_hash(links)
+        links_hash = {}
+        known_links = []
+
+        consumes = @job_spec_hash.fetch('consumes', [])
+        consumes.each do |consume|
+          known_links << consume['name']
+          link = links.find {|l| l.name == consume['name']}
+          links_hash[link.name] = link.to_h unless link.nil?
+        end
+
+        links.each do |link|
+          unless known_links.include?(link.name)
+            raise "Link '#{link.name}' is not declared as a consumed link in this job."
+          end
+        end
+
+        links_hash
+      end
+
+      def insert_property(nested_hash, dotted_key, value)
+        property_segments = dotted_key.split('.')
+        current_level = nested_hash
+
+        property_segments.each_with_index do |property_segment, i|
+          if i == property_segments.count - 1
+            current_level[property_segment] = value
+          else
+            current_level[property_segment] ||= {}
+            current_level = current_level[property_segment]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bosh/template/version.rb

@@ -1,5 +1,5 @@
 module Bosh
   module Template
-    VERSION = '1.3262.24.0'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bosh-template
 version: !ruby/object:Gem::Version
-  version: 1.3262.24.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Pivotal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2017-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semi_semantic
@@ -24,48 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-its
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Renders bosh templates
 email: support@cloudfoundry.com
 executables:
@@ -81,14 +39,22 @@ files:
 - lib/bosh/template/evaluation_link.rb
 - lib/bosh/template/evaluation_link_instance.rb
 - lib/bosh/template/invalid_property_type.rb
+- lib/bosh/template/manual_link_dns_encoder.rb
 - lib/bosh/template/property_helper.rb
 - lib/bosh/template/renderer.rb
+- lib/bosh/template/test.rb
+- lib/bosh/template/test/instance_spec.rb
+- lib/bosh/template/test/job.rb
+- lib/bosh/template/test/link.rb
+- lib/bosh/template/test/link_instance.rb
+- lib/bosh/template/test/release_dir.rb
+- lib/bosh/template/test/template.rb
 - lib/bosh/template/unknown_link.rb
 - lib/bosh/template/unknown_property.rb
 - lib/bosh/template/version.rb
 homepage: https://github.com/cloudfoundry/bosh
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -106,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Renders bosh templates