bosh-template 0.0.1 → 1.2669.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09977444d10e0c549c9b8bf1308937c64af24044
-  data.tar.gz: 170dd775f88c18db31cabdd6e4f04dc0154b42ac
+  metadata.gz: f3b5dbb72c1cd5c73eb0557337a197a303582484
+  data.tar.gz: 37cddbea32e509042374ad442946f867c639b14d
 SHA512:
-  metadata.gz: 5d5790815e3644abd9fbe7ada1e3f750eee5e00c7a883bbf900f8bf30853ac71f26b9cb9ccf7556e73e03d9eee9c941efc39cba3b56fa7daec1ca0f6669550a7
-  data.tar.gz: b50b9726628cda738bc2b615c984ecff936c4ea7c15149422543568e1a800cf277a482d19759f748d7392e447caaa10379729ef11489092cd468caab7c5a1dc7
+  metadata.gz: 265be7f9939e627fa7d64bcc5d788cf5a265202a4b03cec864402d63c15d73b1f68cf5e7379c71cb05b42f1b14e8bd34033323d01dcbedde98c068b146840204
+  data.tar.gz: b67bc88147ee581359f2a7b1a9ae81de565b656dc934e46728edcc768a5ad4240ff261b99e959f46d75f6cc3280b210befb1ec1311ebb1baadb1bf6053698c40

data/README

@@ -0,0 +1,21 @@
+# Bosh::Template
+
+Renders bosh templates
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bosh-template'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bosh-template
+
+## Usage
+
+    $ bosh-template <template.erb> --context '{ "...": ... }'

data/lib/bosh/template.rb

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

data/lib/bosh/template/evaluation_context.rb

@@ -1,11 +1,7 @@
 require 'ostruct'
 require 'bosh/template/evaluation_failed'
 require 'bosh/template/unknown_property'
-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
@@ -29,7 +25,7 @@ module Bosh
       attr_reader :spec
 
       # @param [Hash] spec Template spec
-      def initialize(spec, dns_encoder)
+      def initialize(spec)
         unless spec.is_a?(Hash)
           raise EvaluationFailed,
                 'Invalid spec provided for template evaluation context, ' +
@@ -43,12 +39,9 @@ module Bosh
         end
 
         @index = spec['index']
-        @spec = openstruct(spec, BackCompatOpenStruct)
+        @spec = openstruct(spec)
         @raw_properties = spec['properties'] || {}
         @properties = openstruct(@raw_properties)
-        @dns_encoder = dns_encoder
-
-        @links = spec['links'] || {}
       end
 
       # @return [Binding] Template binding
@@ -95,34 +88,6 @@ module Bosh
         raise UnknownProperty.new(names)
       end
 
-      def link(name)
-        link_spec = lookup_property(@links, name)
-        raise UnknownLink.new(name) if link_spec.nil?
-
-        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
-
-          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
-
       # Run a block of code if all given properties are defined
       # @param [Array<String>] names Property names
       # @yield [Object] property values
@@ -137,52 +102,21 @@ module Bosh
         InactiveElseBlock.new
       end
 
-      # Run a block of code if the link given exists
-      # @param [String] name of the link
-      # @yield [Object] link, which is an array of instances
-      def if_link(name)
-        link_spec = lookup_property(@links, name)
-        if link_spec.nil? || !link_spec.has_key?('instances')
-          return ActiveElseBlock.new(self)
-        else
-          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(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
-
-      private
-
       # @return [Object] Object representation where all hashes are unrolled
       #   into OpenStruct objects. This exists mostly for backward
       #   compatibility, as it doesn't provide good error reporting.
-      def openstruct(object, open_struct_klass=OpenStruct)
+      def openstruct(object)
         case object
           when Hash
-            mapped = object.inject({}) do |h, (k, v)|
-              h[k] = openstruct(v, open_struct_klass); h
-            end
-            open_struct_klass.new(mapped)
+            mapped = object.inject({}) { |h, (k, v)| h[k] = openstruct(v); h }
+            OpenStruct.new(mapped)
           when Array
-            object.map { |item| openstruct(item, open_struct_klass) }
+            object.map { |item| openstruct(item) }
           else
             object
         end
       end
 
-      class BackCompatOpenStruct < OpenStruct
-        def methods(regular=true)
-          if regular
-            super(regular)
-          else
-            marshal_dump.keys.map(&:to_sym)
-          end
-        end
-      end
-
       class ActiveElseBlock
         def initialize(template_context)
           @context = template_context
@@ -195,10 +129,6 @@ module Bosh
         def else_if_p(*names, &block)
           @context.if_p(*names, &block)
         end
-
-        def else_if_link(name, &block)
-          @context.if_link(name, &block)
-        end
       end
 
       class InactiveElseBlock
@@ -208,10 +138,6 @@ module Bosh
         def else_if_p(*names)
           InactiveElseBlock.new
         end
-
-        def else_if_link(name)
-          InactiveElseBlock.new
-        end
       end
     end
   end

data/lib/bosh/template/property_helper.rb

@@ -1,5 +1,3 @@
-require 'bosh/template/invalid_property_type'
-
 module Bosh
   module Template
     module PropertyHelper
@@ -14,10 +12,6 @@ module Bosh
         dst_ref = dst
 
         keys.each do |key|
-          unless src_ref.is_a?(Hash)
-            raise Bosh::Template::InvalidPropertyType,
-              "Property '#{name}' expects a hash, but received '#{src_ref.class}'"
-          end
           src_ref = src_ref[key]
           break if src_ref.nil? # no property with this name is src
         end
@@ -34,7 +28,6 @@ module Bosh
       # @param [Hash] collection Property collection
       # @param [String] name Dot-separated property name
       def lookup_property(collection, name)
-        return nil if collection.nil?
         keys = name.split(".")
         ref = collection
 
@@ -45,46 +38,6 @@ 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,8 +11,8 @@ module Bosh
 
       def render(template_name)
         spec = JSON.parse(@context)
-        evaluation_context = EvaluationContext.new(spec, nil)
-        template = ERB.new(File.read(template_name), safe_level = nil, trim_mode = "-")
+        evaluation_context = EvaluationContext.new(spec)
+        template = ERB.new(File.read(template_name))
         template.result(evaluation_context.get_binding)
       end
     end

data/lib/bosh/template/unknown_property.rb

@@ -5,7 +5,7 @@ module Bosh
 
       def initialize(name)
         @name = name
-        super("Can't find property '#{name}'")
+        super("Can't find property `#{name}'")
       end
     end
   end

data/lib/bosh/template/version.rb

@@ -1,5 +1,5 @@
 module Bosh
   module Template
-    VERSION = '0.0.1'
+    VERSION = '1.2669.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bosh-template
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.2669.0
 platform: ruby
 authors:
 - Pivotal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semi_semantic
@@ -16,45 +16,33 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
-description: Renders bosh templates
+        version: 1.1.0
+description: |-
+  Renders bosh templates
+  bf0b96
 email: support@cloudfoundry.com
-executables:
-- bosh-template
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- bin/bosh-template
+- README
 - lib/bosh/template.rb
 - lib/bosh/template/evaluation_context.rb
 - lib/bosh/template/evaluation_failed.rb
-- 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: []
@@ -72,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Renders bosh templates

data/README.md

@@ -1,39 +0,0 @@
-# bosh-template
-
-Renders BOSH templates
-
-## Usage
-
-```
-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/bin/bosh-template

@@ -1,24 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bosh/template/renderer'
-require 'optparse'
-
-template_name = ARGV[0]
-
-options = {}
-OptionParser.new do |opts|
-  opts.banner = 'Usage: bosh-templates template.erb [options]'
-  opts.separator('Command-line renderer BOSH templates')
-
-  opts.separator('')
-  opts.separator('Options:')
-
-  opts.on('-C', '--context STRING', 'JSON string containing property values for template context') do |v|
-    options[:context] = v
-  end
-end.parse!
-
-raise OptionParser::MissingArgument.new('--context') if options[:context].nil?
-
-renderer = Bosh::Template::Renderer.new(options)
-puts renderer.render(template_name)

data/lib/bosh/template/evaluation_link.rb

@@ -1,58 +0,0 @@
-require 'bosh/template/property_helper'
-
-module Bosh
-  module Template
-    class EvaluationLink
-      include PropertyHelper
-
-      attr_reader :instances
-      attr_reader :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)
-        names = Array(args[0])
-
-        names.each do |name|
-          result = lookup_property(@properties, name)
-          return result unless result.nil?
-        end
-
-        return args[1] if args.length == 2
-        raise UnknownProperty.new(names)
-      end
-
-      def if_p(*names)
-        values = names.map do |name|
-          value = lookup_property(@properties, name)
-          return Bosh::Template::EvaluationContext::ActiveElseBlock.new(self) if value.nil?
-          value
-        end
-
-        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

data/lib/bosh/template/evaluation_link_instance.rb

@@ -1,50 +0,0 @@
-require 'bosh/template/property_helper'
-
-module Bosh
-  module Template
-    class EvaluationLinkInstance
-      include PropertyHelper
-
-      attr_reader :name
-      attr_reader :index
-      attr_reader :id
-      attr_reader :az
-      attr_reader :address
-      attr_reader :properties
-      attr_reader :bootstrap
-
-      def initialize(name, index, id, az, address, properties, bootstrap)
-        @name = name
-        @index = index
-        @id = id
-        @az = az
-        @address = address
-        @properties = properties
-        @bootstrap = bootstrap
-      end
-
-      def p(*args)
-        names = Array(args[0])
-
-        names.each do |name|
-          result = lookup_property(@properties, name)
-          return result unless result.nil?
-        end
-
-        return args[1] if args.length == 2
-        raise UnknownProperty.new(names)
-      end
-
-      def if_p(*names)
-        values = names.map do |name|
-          value = lookup_property(@properties, name)
-          return ActiveElseBlock.new(self) if value.nil?
-          value
-        end
-
-        yield *values
-        InactiveElseBlock.new
-      end
-    end
-  end
-end

data/lib/bosh/template/invalid_property_type.rb

@@ -1,6 +0,0 @@
-module Bosh
-  module Template
-    class InvalidPropertyType < StandardError
-    end
-  end
-end

data/lib/bosh/template/manual_link_dns_encoder.rb

@@ -1,13 +0,0 @@
-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/test.rb

@@ -1,14 +0,0 @@
-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

@@ -1,40 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,31 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,77 +0,0 @@
-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/unknown_link.rb

@@ -1,9 +0,0 @@
-module Bosh
-  module Template
-    class UnknownLink < StandardError
-      def initialize(name)
-        super("Can't find link '#{name}'")
-      end
-    end
-  end
-end