ufo 4.5.11 → 5.0.0

data/lib/ufo/stack/custom_properties.rb

@@ -0,0 +1,59 @@
+class Ufo::Stack
+  class CustomProperties
+    include Ufo::Settings
+
+    def initialize(template, stack_name)
+      @template, @stack_name = template, stack_name
+    end
+
+    def apply
+      customizations = camelize(cfn)
+      @template["Resources"].each do |logical_id, attrs|
+        custom_props = customizations[logical_id]
+        next unless custom_props
+        attrs["Properties"].deeper_merge!(custom_props, {overwrite_arrays: true})
+      end
+
+      substitute_variables!(@template["Resources"])
+      @template
+    end
+
+    # Keep backward compatiablity but encouraging CamelCase now because in the ufo init generator
+    # the .ufo/settings/cfn/default.yml is now CamelCase
+    def camelize(properties)
+      if ENV['UFO_CAMELIZE'] == '0' || settings[:auto_camelize] == false # provide a way to quickly test full camelize disable
+        return properties.deep_stringify_keys
+      end
+
+      # transform keys: camelize
+      properties.deep_stringify_keys.deep_transform_keys do |key|
+        if key == key.upcase # trying to generalize special rule for dns.TTL
+          key # leave key alone if key is already in all upcase
+        else
+          key.camelize
+        end
+      end
+    end
+
+    # Substitute special variables that cannot be baked into the template
+    # because they are dynamically assigned. Only one special variable:
+    #
+    #   {stack_name}
+    def substitute_variables!(properties)
+      # transform values and substitute for special values
+      # https://stackoverflow.com/questions/34595142/process-nested-hash-to-convert-all-values-to-strings
+      #
+      # Examples:
+      #   "{stack_name}.stag.boltops.com." => development-demo-web.stag.boltops.com.
+      #   "{stack_name}.stag.boltops.com." => dev-demo-web-2.stag.boltops.com.
+      properties.deep_merge(properties) do |_,_,v|
+        if v.is_a?(String)
+          v.sub!('{stack_name}', @stack_name) # need shebang, updating in-place
+        else
+          v
+        end
+      end
+      properties
+    end
+  end
+end

data/lib/ufo/stack/helper.rb

@@ -2,6 +2,7 @@ class Ufo::Stack
   module Helper
     include Ufo::AwsService
     include Ufo::Util
+    include Ufo::Settings
     extend Memoist
 
     def find_stack(stack_name)
@@ -34,15 +35,11 @@ class Ufo::Stack
       when "append_nothing", "prepend_nothing"
         [service, Ufo.env_extra]
       else # new default. ufo v4.5 and above
-        [service, Ufo.env, Ufo.env_extra]
+        [service, Ufo.env.to_s, Ufo.env_extra]
       end
       parts.reject {|x| x==''}.compact.join('-') # stack_name
     end
 
-    def cfn
-      Ufo::Setting::Profile.new(:cfn, settings[:cfn_profile]).data
-    end
-
     def status
       Status.new(@stack_name)
     end

data/lib/ufo/stack/template_body.rb

@@ -0,0 +1,13 @@
+class Ufo::Stack
+  class TemplateBody
+    def initialize(context)
+      @context = context
+    end
+
+    def build
+      builder = Builder.new(@context)
+      builder.build
+    end
+  end
+end
+

data/lib/ufo/task.rb

@@ -2,8 +2,9 @@ module Ufo
   class Task < Base
     extend Memoist
 
-    include Util
     include AwsService
+    include Ufo::Settings
+    include Util
 
     def initialize(task_definition, options)
       @task_definition = task_definition
@@ -139,12 +140,6 @@ module Ufo
       options
     end
 
-    def network
-      settings = Ufo.settings
-      Setting::Profile.new(:network, settings[:network_profile]).data
-    end
-    memoize :network
-
     def cloudwatch_info(task_arn)
       config = container_definition[:log_configuration]
       container_name = container_definition[:name]

data/lib/ufo/tasks.rb

@@ -2,7 +2,7 @@ module Ufo
   class Tasks < Command
     desc "build", "Build task definitions."
     long_desc Help.text("tasks:build")
-    option :pretty, type: :boolean, default: true, desc: "Pretty format the json for the task definitions"
+    option :image_override, desc: "Override image in task definition for quick testing"
     def build
       Tasks::Builder.new(options).build
     end

data/lib/ufo/tasks/builder.rb

@@ -6,7 +6,6 @@ module Ufo
       # build and register task definitions. There is little point of running them independently
       # This method helps us do that.
       build(options)
-      Tasks::Register.register(task_definition, options)
     end
 
     # ship: build and registers task definitions together

data/lib/ufo/tasks/register.rb

@@ -70,15 +70,18 @@ module Ufo
 
       definitions = data[:container_definitions]
       definitions.each_with_index do |definition, i|
-        next unless definition[:log_configuration]
-        options = definition[:log_configuration][:options]
-        next unless options
+        next unless definition[:log_configuration] || definition[:firelens_configuration]
+        { log_configuration: 'logConfiguration',
+          firelens_configuration: 'firelensConfiguration' }.each_pair do |key, value|
 
-        # LogConfiguration options do not get transformed and keep their original
-        # structure:
-        #   https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Types/ContainerDefinition.html
-        original_definition = original_data["containerDefinitions"][i]
-        definition[:log_configuration][:options] = original_definition["logConfiguration"]["options"]
+          next unless definition.dig(key, :options)
+
+          # LogConfiguration and firelensConfiguration options do not get transformed and
+          # keep their original structure:
+          #   https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Types/ContainerDefinition.html
+          original_definition = original_data["containerDefinitions"][i]
+          definition[key][:options] = original_definition[value]["options"]
+        end
       end
 
       data

data/lib/ufo/template_scope.rb

@@ -1,6 +1,7 @@
 module Ufo
   class TemplateScope
     extend Memoist
+    include Ufo::Settings
 
     attr_reader :helper
     attr_reader :task_definition_name
@@ -44,72 +45,6 @@ module Ufo
       end
     end
 
-    def network
-      Ufo::Setting::Profile.new(:network, settings[:network_profile]).data
-    end
-    memoize :network
-
-    def cfn
-      Ufo::Setting::Profile.new(:cfn, settings[:cfn_profile]).data
-    end
-    memoize :cfn
-
-    def settings
-      Ufo.settings
-    end
-
-    def custom_properties(resource)
-      resource = resource.to_s.underscore
-      properties = cfn[resource.to_sym]
-      return unless properties
-
-      # transform keys: camelize
-      properties = properties.deep_stringify_keys.deep_transform_keys do |key|
-        if key == key.upcase # trying to generalize special rule for dns.TTL
-          key # leave key alone if key is already in all upcase
-        else
-          key.camelize
-        end
-      end
-
-      substitute_variables!(properties)
-
-      yaml = YAML.dump(properties)
-      # add spaces in front on each line
-      yaml.split("\n")[1..-1].map do |line|
-        "      #{line}"
-      end.join("\n") + "\n"
-    end
-
-    # Substitute special variables that cannot be baked into the template
-    # because they are dynamically assigned. Only one special variable:
-    #
-    #   {stack_name}
-    def substitute_variables!(properties)
-      # transform values and substitute for special values
-      # https://stackoverflow.com/questions/34595142/process-nested-hash-to-convert-all-values-to-strings
-      #
-      # Examples:
-      #   "{stack_name}.stag.boltops.com." => development-demo-web.stag.boltops.com.
-      #   "{stack_name}.stag.boltops.com." => dev-demo-web-2.stag.boltops.com.
-      properties.deep_merge(properties) do |_,_,v|
-        if v.is_a?(String)
-          v.sub!('{stack_name}', @stack_name) # unsure why need shebang, but it works
-        else
-          v
-        end
-      end
-      properties
-    end
-
-    def default_target_group_protocol
-      default_elb_protocol
-    end
-
-    def default_elb_protocol
-      @elb_type == "application" ? "HTTP" : "TCP"
-    end
-
     def pretty_name?
       # env variable takes highest precedence
       if ENV["STATIC_NAME"]

data/lib/ufo/utils/squeezer.rb

@@ -0,0 +1,24 @@
+module Ufo::Utils
+  class Squeezer
+    def initialize(data)
+      @data = data
+    end
+
+    def squeeze(new_data=nil)
+      data = new_data.nil? ? @data : new_data
+
+      case data
+      when Array
+        data.map! { |v| squeeze(v) }
+      when Hash
+        data.each_with_object({}) do |(k,v), squeezed|
+          # only remove nil and empty Array values within Hash structures
+          squeezed[k] = squeeze(v) unless v.nil? || v.is_a?(Array) && v.empty?
+          squeezed
+        end
+      else
+        data # do not transform
+      end
+    end
+  end
+end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.5.11"
+  VERSION = "5.0.0"
 end

data/spec/fixtures/iam_roles/task_role.rb

@@ -0,0 +1,17 @@
+iam_policy("AmazonS3ReadOnlyAccess",
+  Action: [
+    "s3:Get*",
+    "s3:List*"
+  ],
+  Effect: "Allow",
+  Resource: "*"
+)
+iam_policy("CloudwatchWrite",
+  Action: [
+    "cloudwatch:PutMetricData",
+  ],
+  Effect: "Allow",
+  Resource: "*"
+)
+
+managed_iam_policy("AmazonS3ReadOnlyAccess", "AmazonEC2ReadOnlyAccess")

data/spec/fixtures/mocks/logs/awslogs.json

@@ -0,0 +1,70 @@
+{
+  "task_definition": {
+    "task_definition_arn": "arn:aws:ecs:us-west-2:112233445566:task-definition/demo-web:1",
+    "container_definitions": [
+      {
+        "name": "web",
+        "image": "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra:ufo-2020-01-16T22-56-26-a28378e80",
+        "cpu": 256,
+        "memory": 1024,
+        "memory_reservation": 1024,
+        "port_mappings": [
+          {
+            "container_port": 4567,
+            "host_port": 4567,
+            "protocol": "tcp"
+          }
+        ],
+        "essential": true,
+        "command": [
+          "bin/web"
+        ],
+        "environment": [],
+        "log_configuration": {
+          "log_driver": "awslogs",
+          "options": {
+            "awslogs-group": "ecs/demo-web",
+            "awslogs-region": "us-west-2",
+            "awslogs-stream-prefix": "demo"
+          }
+        }
+      }
+    ],
+    "family": "demo-web",
+    "task_role_arn": "arn:aws:iam::112233445566:role/demo",
+    "network_mode": "awsvpc",
+    "revision": 1,
+    "volumes": [
+    ],
+    "status": "ACTIVE",
+    "requires_attributes": [
+      {
+        "name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.ecr-auth"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.task-iam-role"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
+      },
+      {
+        "name": "ecs.capability.task-eni"
+      }
+    ],
+    "placement_constraints": [
+
+    ],
+    "compatibilities": [
+      "EC2"
+    ]
+  }
+}

data/spec/fixtures/mocks/logs/no-awslogs.json

@@ -0,0 +1,70 @@
+{
+  "task_definition": {
+    "task_definition_arn": "arn:aws:ecs:us-west-2:112233445566:task-definition/demo-web:1",
+    "container_definitions": [
+      {
+        "name": "web",
+        "image": "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra:ufo-2020-01-16T22-56-26-a28378e80",
+        "cpu": 256,
+        "memory": 1024,
+        "memory_reservation": 1024,
+        "port_mappings": [
+          {
+            "container_port": 4567,
+            "host_port": 4567,
+            "protocol": "tcp"
+          }
+        ],
+        "essential": true,
+        "command": [
+          "bin/web"
+        ],
+        "environment": [],
+        "log_configuration": {
+          "log_driver": "whatever",
+          "options": {
+            "awslogs-group": "ecs/demo-web",
+            "awslogs-region": "us-west-2",
+            "awslogs-stream-prefix": "demo"
+          }
+        }
+      }
+    ],
+    "family": "demo-web",
+    "task_role_arn": "arn:aws:iam::112233445566:role/demo",
+    "network_mode": "awsvpc",
+    "revision": 1,
+    "volumes": [
+    ],
+    "status": "ACTIVE",
+    "requires_attributes": [
+      {
+        "name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.ecr-auth"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.task-iam-role"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
+      },
+      {
+        "name": "ecs.capability.task-eni"
+      }
+    ],
+    "placement_constraints": [
+
+    ],
+    "compatibilities": [
+      "EC2"
+    ]
+  }
+}

data/spec/lib/logs_spec.rb

@@ -0,0 +1,55 @@
+describe Ufo::Logs do
+  let(:logs) do
+    logs = Ufo::Logs.new("test-web", {})
+    allow(logs).to receive(:exit).and_return(null)
+    allow(logs).to receive(:info).and_return(null)
+    allow(logs).to receive(:ecs).and_return(ecs)
+    logs
+  end
+  let(:ecs) do
+    ecs = double(:ecs).as_null_object
+    allow(ecs).to receive(:describe_task_definition).and_return(mock_response(fixture))
+    ecs
+  end
+  let(:null) { double(:null).as_null_object }
+
+  context "awslogs conf" do
+    let(:fixture) { "spec/fixtures/mocks/logs/awslogs.json" }
+    it "find_log_group_name" do
+      log_group_name = logs.find_log_group_name
+      expect(log_group_name).to eq({"awslogs-group" => "ecs/demo-web", "awslogs-region" => "us-west-2", "awslogs-stream-prefix" => "demo" })
+    end
+  end
+
+  context "not a awslogs conf" do
+    let(:fixture) { "spec/fixtures/mocks/logs/no-awslogs.json" }
+    it "find_log_group_name" do
+      log_group_name = logs.find_log_group_name
+      expect(log_group_name).to be nil
+    end
+  end
+
+  def mock_response(file)
+    data = JSON.load(IO.read(file))
+
+    td = data["task_definition"]
+    container_definitions = td["container_definitions"].map do |c|
+      l = c["log_configuration"]
+      log_configuration = Aws::ECS::Types::LogConfiguration.new(
+        log_driver: l["log_driver"],
+        options: l["options"],
+      )
+      Aws::ECS::Types::ContainerDefinition.new(
+        name: c["name"],
+        log_configuration: log_configuration,
+      )
+    end
+    task_definition = Aws::ECS::Types::TaskDefinition.new(
+      task_definition_arn: td["task_definition_arn"],
+      container_definitions: container_definitions,
+    )
+    Aws::ECS::Types::DescribeTaskDefinitionResponse.new(
+      task_definition: task_definition,
+    )
+  end
+end