cfhighlander 0.12.5.alpha.1620862522 → 0.12.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e34cde3f6ad0999503b44f5bd8fb03344d02d0eace4eed5ed0044837f62355a
-  data.tar.gz: '0088fbf56d21e7cbd9d5f84f3039f0e383491a32e837b7eb411373e12b621273'
+  metadata.gz: 027f0a6c56f3a766b3e3a4a9d95bdfbc39b45c23b1611f486276778393096d83
+  data.tar.gz: b1d84694799ade5e1fbd1d3b0c4f3f6639415cc9f5fe26e2c71dc3b2d0844df8
 SHA512:
-  metadata.gz: 0271d23aae856b674bb75bff5eca63d3004ce265042f3012f39ccb7ed76e508da04880c583934952cb03b4487f770d77f8a400c767d2cdc443d71aa5a686333a
-  data.tar.gz: 29d8410d47e67bbaa45a7232b0f71e410e6ddaa71457576755de77a80d97317b4ef9c4bb94bf6bcff32d175181520d2d65e47972a21ddaf935d8bef46c492cc3
+  metadata.gz: '00423813c66c9fb442ae1fc56e8bae4479d2db9b2d4c0eaf55a55cdae59e4e0e9e582c2e14353e43fdbcb6e0531e33be3757892ce3a1929a5632b851d17e4e29'
+  data.tar.gz: d6ae0381d9707121d3c96eb3359828306aeef62220176d147bd1d44e20d1c536863f34f040ae44d619db83d7c291d16fe7f363ad32608a203e3790478069730f

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/theonestack/cfhighlander.svg?branch=develop)](https://travis-ci.org/theonestack/cfhighlander) [![Join the chat at https://gitter.im/theonestack/cfhighlander](https://badges.gitter.im/theonestack/cfhighlander.svg)](https://gitter.im/theonestack/cfhighlander?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+![Build Status](https://github.com/theonestack/cfhighlander/actions/workflows/build-gem.yml/badge.svg) [![Join the chat at https://gitter.im/theonestack/cfhighlander](https://badges.gitter.im/theonestack/cfhighlander.svg)](https://gitter.im/theonestack/cfhighlander?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 # Intro
 
@@ -863,6 +863,27 @@ end
 
 ```
 
+### Publishing Additonal Artifacts
+
+If you need to publish additonal files along with your cloudformation templates you can use the following DSL:
+
+```ruby
+CfhighlanderTemplate do
+    Name 'my_app'
+    PublishArtifact file: "my-apigateway-spec.yaml"
+end
+```
+
+This will upload the file `my-apigateway-spec.yaml` to the s3 destnation/distribution bucket using the default s3 prefix. If you want to override the s3 key you can use
+
+```ruby
+CfhighlanderTemplate do
+    Name 'my_app'
+    PublishArtifact file: "my-apigateway-spec.yaml", key: '/my-custom-path/my-custom-file.yaml'
+end
+```
+
+
 ## Finding templates and creating components
 
 
@@ -1038,3 +1059,4 @@ Test Highlander component with test case config
 ### Reports
 
 By default test will print the output to stdout. You can output to a file with a format of xml or json using the `-r` option
+

data/lib/cfhighlander.dsl.subcomponent.rb

@@ -155,7 +155,7 @@ module Cfhighlander
           param_ovr[:minLength] = minLength unless minLength.nil?
           param_ovr[:minValue] = minValue unless minValue.nil?
           @component_loaded.highlander_dsl.Parameters do
-            ComponentParam name, value, param_ovr
+            ComponentParam name, value, **param_ovr
           end
         else
           parameter.default_value = defaultValue unless defaultValue.nil?

data/lib/cfhighlander.dsl.template.rb

@@ -37,7 +37,8 @@ module Cfhighlander
           :lambda_functions_keys,
           :description,
           :dependson_components,
-          :template_dir
+          :template_dir,
+          :publish_artifacts
 
       attr_reader :conditions,
           :subcomponents,
@@ -63,6 +64,7 @@ module Cfhighlander
         # execution blocks for subcomponents
         @subcomponents_exec = {}
         @template_dir = nil
+        @publish_artifacts = []
       end
 
       # DSL statements
@@ -207,6 +209,11 @@ module Cfhighlander
         @lambda_functions_keys << config_key
       end
 
+      def PublishArtifact(file: nil, key: key=nil)
+        puts "INFO: adding artifact #{file} to publishing list"
+        @publish_artifacts << {file: file, key: key}
+      end
+
       # Internal and interface functions
 
       def loadComponents

data/lib/cfhighlander.error.rb

@@ -0,0 +1,3 @@
+module Cfhighlander
+    class Error < StandardError; end
+end

data/lib/cfhighlander.publisher.rb

@@ -1,6 +1,6 @@
 require_relative './cfhighlander.compiler'
 require 'aws-sdk-s3'
-require 'uri'
+
 module Cfhighlander
 
   module Publisher
@@ -53,7 +53,7 @@ module Cfhighlander
         template_url = getTemplateUrl
         region = s3_bucket_region(@component.highlander_dsl.distribution_bucket)
         return "https://console.aws.amazon.com/cloudformation/home?region=#{region}#/stacks/create/review?filter=active&templateURL=" +
-            "#{URI::encode(template_url)}&stackName=#{@component.name}"
+            "#{CGI::escape(template_url)}&stackName=#{@component.name}"
       end
 
       def publishFiles(file_list)
@@ -83,6 +83,16 @@ module Cfhighlander
         end
         print "\n"
 
+        @component.highlander_dsl.publish_artifacts.each do |artifact|
+          s3_key = artifact[:key].nil? ? "#{prefix}/#{version}/#{artifact[:file]}" : artifact[:key]
+          print "\nPublishing artifact: #{artifact[:file]} to s3://#{bucket}/#{s3_key} ..."
+          s3.put_object({
+            body: File.read(artifact[:file]),
+            bucket: bucket,
+            key: s3_key
+          })
+          print ' [OK] '
+        end
       end
 
     end

data/lib/cfhighlander.version.rb

@@ -1,3 +1,3 @@
 module Cfhighlander
-  VERSION="0.12.5".freeze
+  VERSION="0.12.6".freeze
 end

data/lib/util/cloudformation.util.rb

@@ -1,4 +1,5 @@
 require_relative '../cfhighlander.model.component'
+require_relative '../cfhighlander.error'
 require_relative './debug.util'
 require 'duplicate'
 
@@ -57,7 +58,6 @@ module Cfhighlander
         template.subcomponents.each do |sub_component|
           next unless sub_component.inlined
           model = sub_component.component_loaded.cfn_model_raw
-
           model[element_type].keys.each do |key|
             if keys_taken.include? key
               candidate = "#{sub_component.component_loaded.name}#{key}"
@@ -109,6 +109,16 @@ module Cfhighlander
           next unless sub_component.inlined
           model = sub_component.component_loaded.cfn_model_raw
           model[element_name].each do |resource, value|
+            if sub_component.conditional
+              # If the resource already has a conditon we need to combine it with the stack condition
+              if element_name == 'Conditions'
+                value = { "Fn::And" => [{"Condtion" => sub_component.condition}, value]}
+              end
+              # Adds the condition to the inlined resource if it doesn't already have a condition
+              if element_name == 'Resources'
+                value['Condition'] = sub_component.condition unless value.has_key?('Condition')
+              end
+            end
             # effective extraction of child resource into parent
             # allows for line components to use - or _ in the component name
             # and still generate valid references
@@ -295,6 +305,11 @@ module Cfhighlander
               outval_refs.each do |out_ref|
                 component_name = out_ref[:component]
                 ref_sub_component = template.subcomponents.find {|sc| sc.name == component_name}
+
+                if ref_sub_component.nil?
+                  raise Cfhighlander::Error, "unable to find outputs from component #{component_name} reference by parameters in component #{sub_component.name}"
+                end
+
                 if ref_sub_component.inlined
                   # out refs here need to be replaced with actual values
                   replacement = output_values[out_ref[:component]][out_ref[:outputName]]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfhighlander
 version: !ruby/object:Gem::Version
-  version: 0.12.5.alpha.1620862522
+  version: 0.12.6
 platform: ruby
 authors:
 - Nikola Tosic
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -247,6 +247,7 @@ files:
 - lib/cfhighlander.dsl.params.rb
 - lib/cfhighlander.dsl.subcomponent.rb
 - lib/cfhighlander.dsl.template.rb
+- lib/cfhighlander.error.rb
 - lib/cfhighlander.factory.rb
 - lib/cfhighlander.factory.templatefinder.rb
 - lib/cfhighlander.helper.rb
@@ -277,11 +278,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: DSL on top of cfndsl. Manage libraries of cloudformation components