hecks 2.6.0 → 2.8.0

data/lib/hecks/projections/deploy/fargate/check.rb

@@ -0,0 +1,172 @@
+module Hecks
+  module Projections
+    module Deploy
+      module Fargate
+        # Validation for the optional settings a `deployed_to("AwsFargate")`
+        # block accepts beyond the required ones.
+        #
+        # `FargateTarget.Declare` in deploy.bluebook owns the baseline
+        # settings (`cpu`, `memory`, `port`, `database`, `web`). The keys added
+        # for multi-container stacks are nested shapes (lists of hashes, maps),
+        # which that aggregate's flat attributes cannot describe, so they are
+        # checked here. Every check raises `ArgumentError` naming the setting
+        # it was reading, so a mistake in a `.world` file points at its line.
+        module Check
+          module_function
+
+          LOGICAL_ID = /\A[A-Za-z][A-Za-z0-9]*\z/
+          RESOURCE_NAME = %r{\A[A-Za-z0-9][A-Za-z0-9_./-]*\z}
+
+          # Checks that a value is a hash with only known keys and returns it symbol-keyed.
+          #
+          # @param value [Object] the setting as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @param allowed [Array<Symbol>] every key the hash may carry
+          # @param required [Array<Symbol>] the keys the hash must carry
+          # @return [Hash{Symbol => Object}] the hash with its keys as symbols
+          # @raise [ArgumentError] if the value is not a hash, names an unknown key, or lacks a
+          #   required one
+          def hash!(value, where, allowed:, required: [])
+            raise ArgumentError, "#{where} must be a hash, got #{value.inspect}" unless value.is_a?(Hash)
+
+            found = value.transform_keys(&:to_sym)
+            unknown = found.keys - allowed
+            unless unknown.empty?
+              raise ArgumentError,
+                    "#{where} has unknown key(s) #{unknown.join(', ')}; allowed: #{allowed.join(', ')}"
+            end
+
+            missing = required.reject { |key| found.key?(key) }
+            raise ArgumentError, "#{where} needs #{missing.join(', ')}" unless missing.empty?
+
+            found
+          end
+
+          # Checks that a value is a list of hashes, each valid for `hash!`.
+          #
+          # @param value [Object] the setting as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @param allowed [Array<Symbol>] every key an entry may carry
+          # @param required [Array<Symbol>] the keys each entry must carry
+          # @return [Array<Hash{Symbol => Object}>] the entries with symbol keys
+          # @raise [ArgumentError] if the value is not an array or an entry is invalid
+          def hashes!(value, where, allowed:, required: [])
+            raise ArgumentError, "#{where} must be a list of hashes, got #{value.inspect}" unless value.is_a?(Array)
+
+            value.each_with_index.map { |entry, index| hash!(entry, "#{where}[#{index}]", allowed: allowed, required: required) }
+          end
+
+          # Checks that a value is a CloudFormation logical id.
+          #
+          # @param value [Object] the id as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @return [String] the id
+          # @raise [ArgumentError] if the id has anything but letters and digits, or starts with a
+          #   digit
+          def logical_id!(value, where)
+            text = value.to_s
+            return text if LOGICAL_ID.match?(text)
+
+            raise ArgumentError, "#{where} must be a CloudFormation logical id " \
+                                 "(letters and digits, starting with a letter), got #{value.inspect}"
+          end
+
+          # Checks that a value is a name AWS accepts for a container, repository or stack resource.
+          #
+          # @param value [Object] the name as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @return [String] the name
+          # @raise [ArgumentError] if the name has characters outside letters, digits and `_ . / -`
+          def resource_name!(value, where)
+            text = value.to_s
+            return text if RESOURCE_NAME.match?(text)
+
+            raise ArgumentError, "#{where} must be a name of letters, digits, and _ . / - characters, got #{value.inspect}"
+          end
+
+          # Checks that a value is a whole number in a range.
+          #
+          # @param value [Object] the number as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @param range [Range<Integer>] the accepted values
+          # @return [Integer] the number
+          # @raise [ArgumentError] if the value is not an integer inside `range`
+          def integer!(value, where, range:)
+            return value if value.is_a?(Integer) && range.cover?(value)
+
+            raise ArgumentError, "#{where} must be a whole number from #{range.min} to #{range.max}, got #{value.inspect}"
+          end
+
+          # Checks that a value is true or false.
+          #
+          # @param value [Object] the flag as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @return [Boolean] the flag
+          # @raise [ArgumentError] if the value is neither `true` nor `false`
+          def boolean!(value, where)
+            return value if [true, false].include?(value)
+
+            raise ArgumentError, "#{where} must be true or false, got #{value.inspect}"
+          end
+
+          # Checks that a value is a list of non-empty strings.
+          #
+          # @param value [Object] the list as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @param min [Integer] the fewest entries allowed
+          # @param max [Integer, nil] the most entries allowed, or nil for no limit
+          # @return [Array<String>] the entries as strings
+          # @raise [ArgumentError] if the value is not a list of strings or its size is out of range
+          def strings!(value, where, min: 0, max: nil)
+            list = value.is_a?(Array) ? value : nil
+            ok = list&.all? { |item| (item.is_a?(String) || item.is_a?(Symbol)) && !item.to_s.empty? }
+            raise ArgumentError, "#{where} must be a list of strings, got #{value.inspect}" unless ok
+            raise ArgumentError, "#{where} needs at least #{min} entr#{min == 1 ? 'y' : 'ies'}" if list.size < min
+            raise ArgumentError, "#{where} takes at most #{max} entries, got #{list.size}" if max && list.size > max
+
+            list.map(&:to_s)
+          end
+
+          # Checks that a value is a map of names to strings and returns it string-keyed.
+          #
+          # A `nil` value is kept: for the domain container's environment it
+          # removes a default variable.
+          #
+          # @param value [Object] the map as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @param nil_ok [Boolean] whether a `nil` value is accepted
+          # @return [Hash{String => Object}] the map with string keys
+          # @raise [ArgumentError] if the value is not a hash or a key is not an
+          #   environment-variable style name
+          def map!(value, where, nil_ok: false)
+            raise ArgumentError, "#{where} must be a hash, got #{value.inspect}" unless value.is_a?(Hash)
+
+            value.to_h do |key, item|
+              name = key.to_s
+              unless name.match?(/\A[A-Za-z_][A-Za-z0-9_]*\z/)
+                raise ArgumentError,
+                      "#{where} key #{key.inspect} must be a name of letters, digits and underscores"
+              end
+              raise ArgumentError, "#{where}.#{name} needs a value" if item.nil? && !nil_ok
+
+              [name, item]
+            end
+          end
+
+          # Checks that a value is one of a fixed set.
+          #
+          # @param value [Object] the value as written in the world file
+          # @param where [String] the setting's name, used in the error message
+          # @param choices [Array<String>] the accepted values
+          # @return [String] the value as a string
+          # @raise [ArgumentError] if the value is not among `choices`
+          def one_of!(value, where, choices)
+            return value.to_s if choices.include?(value.to_s)
+
+            raise ArgumentError, "#{where} must be one of #{choices.join(', ')}, got #{value.inspect}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hecks/projections/deploy/fargate/containers.rb

@@ -0,0 +1,412 @@
+require_relative "check"
+require_relative "yaml"
+
+module Hecks
+  module Projections
+    module Deploy
+      module Fargate
+        # The containers of one Fargate task and how the load balancer reaches them.
+        #
+        # A stack always has the domain container: `rust/host` built from the
+        # domain itself. The world's `containers` setting adds more containers
+        # to the same task (a website, a content admin), each with its own ECR
+        # repository, image-tag parameter, target group and health check.
+        # `routes` sends URL path patterns to a container through listener
+        # rules on the one load balancer, and `default_container` names the
+        # container that answers everything else.
+        #
+        # ## Settings
+        #
+        # `domain_container` renames the domain container's own pieces:
+        # `name`, `repository`, `image_tag_parameter` and `health_path`. Its `essential`
+        # writes an explicit `Essential` flag; the container is essential either way,
+        # since that is `ECS`'s default.
+        #
+        # Each `containers` entry takes `name` and `repository` (required),
+        # and `port`, `health_path`, `env`, `secrets`, `image_tag_parameter`,
+        # `essential`, `cpu`, `memory`, `repository_id` and `target_group_id`.
+        # A container without a `port` receives no load-balancer traffic.
+        # `env` values and `secrets` values may be CloudFormation intrinsics
+        # written as strings (`"!Ref Name"`, `"!Sub \"...\""`).
+        #
+        # Each `routes` entry takes `container`, `paths` (one to five path
+        # patterns, since a listener rule condition holds at most five),
+        # `priority` and an optional `id`.
+        module Containers
+          module_function
+
+          Container = Struct.new(
+            :name, :repository_id, :repository_name, :tag_parameter, :port, :health_path,
+            :env, :secrets, :cpu, :memory, :essential, :target_group_id,
+            keyword_init: true
+          )
+          Route = Struct.new(:id, :container, :paths, :priority, keyword_init: true)
+          Layout = Struct.new(:domain, :extras, :routes, :default_container, keyword_init: true) do
+            # Lists the domain container followed by every added container.
+            #
+            # @return [Array<Container>] every container of the task
+            def all = [domain, *extras]
+
+            # Lists the containers that receive load-balancer traffic.
+            #
+            # @return [Array<Container>] the containers with a port
+            def balanced = all.select(&:port)
+
+            # Tells whether the stack has any container besides the domain's own.
+            #
+            # @return [Boolean] true when `containers` added at least one
+            def multi? = !extras.empty?
+
+            # Finds the container the listener forwards to by default.
+            #
+            # @return [Container] the default container
+            def default = all.find { |container| container.name == default_container }
+          end
+
+          DOMAIN_KEYS = [:name, :repository, :image_tag_parameter, :health_path, :essential].freeze
+          CONTAINER_KEYS = [
+            :name, :repository, :port, :health_path, :env, :secrets, :image_tag_parameter, :essential,
+            :cpu, :memory, :repository_id, :target_group_id
+          ].freeze
+          ROUTE_KEYS = [:container, :paths, :priority, :id].freeze
+
+          # Reads the container-related settings into a `Layout`.
+          #
+          # @param settings [Hash{Symbol => Object}] the world's `deployed_to("AwsFargate")`
+          #   settings
+          # @param infra_name [String] the domain's own AWS-facing name, the default container name
+          # @param port [Integer] the validated port of the domain container
+          # @param ids [Hash{Symbol => String}] the resolved logical ids, for the domain container's
+          #   own
+          # @return [Layout] the containers, routes and default container
+          # @raise [ArgumentError] if a container, route or the default container is invalid
+          def normalize(settings, infra_name:, port:, ids:)
+            domain = domain_container(settings[:domain_container], infra_name: infra_name, port: port, ids: ids)
+            extras = Check.hashes!(settings.fetch(:containers, []), "containers", allowed:  CONTAINER_KEYS,
+                                                                                  required: [:name, :repository])
+                          .map do |entry|
+              extra_container(entry)
+            end
+            layout = Layout.new(domain: domain, extras: extras, routes: [], default_container: domain.name)
+            layout.default_container = default_name(settings, layout)
+            layout.routes = routes(settings.fetch(:routes, []), layout)
+            check_unique!(layout)
+            check_reachable!(layout)
+            layout
+          end
+
+          # Renders the ECR repository of every added container.
+          #
+          # @param layout [Layout] the stack's containers
+          # @return [String] flush-left resources separated by blank lines, or empty
+          def repositories_yaml(layout)
+            layout.extras.map do |container|
+              <<~REPOSITORY.rstrip
+                #{container.repository_id}:
+                  Type: AWS::ECR::Repository
+                  Properties:
+                    RepositoryName: #{container.repository_name}
+                    ImageScanningConfiguration:
+                      ScanOnPush: true
+              REPOSITORY
+            end.join("\n\n")
+          end
+
+          # Renders the image-tag parameter of every added container.
+          #
+          # @param layout [Layout] the stack's containers
+          # @return [String] flush-left parameters, each ending in a newline, or empty
+          def parameters_yaml(layout)
+            layout.extras.map do |container|
+              <<~PARAMETER
+                #{container.tag_parameter}:
+                  Type: String
+                  Default: latest
+                  Description: ECR image tag the #{container.name} container pulls.
+              PARAMETER
+            end.join
+          end
+
+          # Renders the added containers as `ContainerDefinitions` list entries.
+          #
+          # @param layout [Layout] the stack's containers
+          # @param log_group_id [String] the logical id of the shared log group
+          # @return [String] flush-left list entries separated by blank lines, or empty
+          def definitions_yaml(layout, log_group_id)
+            layout.extras.map { |container| definition_yaml(container, log_group_id) }.join("\n\n")
+          end
+
+          # Renders the target group of every added container.
+          #
+          # @param layout [Layout] the stack's containers
+          # @param vpc_ref [String] the `!Ref` expression for the VPC the targets live in
+          # @param deregistration_delay [Integer, nil] seconds the load balancer drains a target, or
+          #   nil for the default
+          # @return [String] flush-left resources separated by blank lines, or empty
+          def target_groups_yaml(layout, vpc_ref, deregistration_delay)
+            layout.extras.select(&:port).map do |container|
+              [
+                "#{container.target_group_id}:",
+                "  Type: AWS::ElasticLoadBalancingV2::TargetGroup",
+                "  Properties:",
+                "    TargetType: ip",
+                "    Port: #{container.port}",
+                "    Protocol: HTTP",
+                "    VpcId: #{vpc_ref}",
+                "    HealthCheckPath: #{container.health_path}",
+                "    HealthCheckPort: \"#{container.port}\"",
+                target_group_attributes_yaml(deregistration_delay).gsub(/^/, "    ")
+              ].join("\n").rstrip
+            end.join("\n\n")
+          end
+
+          # Renders the `TargetGroupAttributes` property for a drain delay.
+          #
+          # @param deregistration_delay [Integer, nil] seconds the load balancer drains a target
+          # @return [String] flush-left property lines ending in a newline, or empty for nil
+          def target_group_attributes_yaml(deregistration_delay)
+            return "" unless deregistration_delay
+
+            <<~ATTRIBUTES
+              TargetGroupAttributes:
+                - Key: deregistration_delay.timeout_seconds
+                  Value: "#{deregistration_delay}"
+            ATTRIBUTES
+          end
+
+          # Renders one listener rule per route.
+          #
+          # @param layout [Layout] the stack's containers and routes
+          # @param listener_id [String] the logical id of the HTTP listener
+          # @return [String] flush-left resources separated by blank lines, or empty
+          def listener_rules_yaml(layout, listener_id)
+            layout.routes.map do |route|
+              target = layout.all.find { |container| container.name == route.container }
+              <<~RULE.rstrip
+                #{route.id}:
+                  Type: AWS::ElasticLoadBalancingV2::ListenerRule
+                  Properties:
+                    ListenerArn: !Ref #{listener_id}
+                    Priority: #{route.priority}
+                    Conditions:
+                      - Field: path-pattern
+                        Values: #{Yaml.flow_list(route.paths)}
+                    Actions:
+                      - Type: forward
+                        TargetGroupArn: !Ref #{target.target_group_id}
+              RULE
+            end.join("\n\n")
+          end
+
+          # Renders the service's `LoadBalancers` entries for the added containers.
+          #
+          # @param layout [Layout] the stack's containers
+          # @return [String] flush-left list entries, or empty
+          def load_balancers_yaml(layout)
+            layout.extras.select(&:port).map do |container|
+              <<~ENTRY
+                - ContainerName: #{container.name}
+                  ContainerPort: #{container.port}
+                  TargetGroupArn: !Ref #{container.target_group_id}
+              ENTRY
+            end.join
+          end
+
+          # Writes the `DependsOn` value that holds the service until the listener and its rules
+          # exist.
+          #
+          # @param layout [Layout] the stack's containers and routes
+          # @param listener_id [String] the logical id of the HTTP listener
+          # @return [String] a single id, or a flow list of ids
+          def depends_on(layout, listener_id)
+            return listener_id if layout.routes.empty?
+
+            Yaml.flow_list([listener_id, *layout.routes.map(&:id)])
+          end
+
+          # Finds the first and last container port the load balancer must reach.
+          #
+          # @param layout [Layout] the stack's containers
+          # @return [Range<Integer>] the security-group ingress port range
+          def port_range(layout)
+            ports = layout.balanced.map(&:port)
+            ports.min..ports.max
+          end
+
+          def domain_container(setting, infra_name:, port:, ids:)
+            given = setting ? Check.hash!(setting, "domain_container", allowed: DOMAIN_KEYS) : {}
+            name = Check.resource_name!(given.fetch(:name, infra_name), "domain_container name")
+            repository = Check.resource_name!(given.fetch(:repository, infra_name), "domain_container repository")
+            Container.new(
+              name: name, repository_id: ids.fetch(:ecr_repository), repository_name: repository,
+              tag_parameter: Check.logical_id!(given.fetch(:image_tag_parameter, "ImageTag"),
+                                               "domain_container image_tag_parameter"),
+              port: port, health_path: health_path(given, "domain_container"), env: {}, secrets: {},
+              essential: given.key?(:essential) ? Check.boolean!(given[:essential], "domain_container essential") : nil,
+              target_group_id: ids.fetch(:target_group)
+            )
+          end
+          private_class_method :domain_container
+
+          def extra_container(entry)
+            name = Check.resource_name!(entry.fetch(:name), "containers name")
+            where = "containers[#{name}]"
+            base = Yaml.camel(name)
+            Container.new(
+              name: name, repository_name: Check.resource_name!(entry.fetch(:repository), "#{where} repository"),
+              repository_id: Check.logical_id!(entry.fetch(:repository_id, "#{base}Repository"), "#{where} repository_id"),
+              target_group_id: Check.logical_id!(entry.fetch(:target_group_id, "#{base}TargetGroup"), "#{where} target_group_id"),
+              tag_parameter: Check.logical_id!(entry.fetch(:image_tag_parameter, "#{base}ImageTag"),
+                                               "#{where} image_tag_parameter"),
+              port: optional_port(entry, where), health_path: health_path(entry, where),
+              env: Check.map!(entry.fetch(:env, {}), "#{where} env"),
+              secrets: Check.map!(entry.fetch(:secrets, {}), "#{where} secrets"),
+              cpu: optional_size(entry, :cpu, where), memory: optional_size(entry, :memory, where),
+              essential: Check.boolean!(entry.fetch(:essential, true), "#{where} essential")
+            )
+          end
+          private_class_method :extra_container
+
+          def optional_port(entry, where)
+            entry.key?(:port) ? Check.integer!(entry[:port], "#{where} port", range: 1..65_535) : nil
+          end
+          private_class_method :optional_port
+
+          def optional_size(entry, key, where)
+            entry.key?(key) ? Check.integer!(entry[key], "#{where} #{key}", range: 1..1_000_000) : nil
+          end
+          private_class_method :optional_size
+
+          def health_path(entry, where)
+            path = entry.fetch(:health_path, "/").to_s
+            raise ArgumentError, "#{where} health_path must start with /, got #{path.inspect}" unless path.start_with?("/")
+
+            path
+          end
+          private_class_method :health_path
+
+          def default_name(settings, layout)
+            name = settings.fetch(:default_container, layout.domain.name).to_s
+            target = layout.all.find { |container| container.name == name }
+            unless target
+              raise ArgumentError,
+                    "default_container #{name.inspect} is not a container; have #{layout.all.map(&:name).join(', ')}"
+            end
+            unless target.port
+              raise ArgumentError,
+                    "default_container #{name.inspect} has no port, so the listener cannot forward to it"
+            end
+
+            name
+          end
+          private_class_method :default_name
+
+          def routes(entries, layout)
+            counts = Hash.new(0)
+            Check.hashes!(entries, "routes", allowed: ROUTE_KEYS, required: [:container, :paths, :priority]).map do |entry|
+              container = entry.fetch(:container).to_s
+              counts[container] += 1
+              route(entry, container, counts[container], layout)
+            end
+          end
+          private_class_method :routes
+
+          def route(entry, container, nth, layout)
+            target = layout.balanced.find { |candidate| candidate.name == container }
+            raise ArgumentError, "routes name container #{container.inspect}, which is not a container with a port" unless target
+
+            suffix = nth == 1 ? "" : nth.to_s
+            Route.new(
+              id: Check.logical_id!(entry.fetch(:id, "ListenerRule#{Yaml.camel(container)}#{suffix}"), "routes id"),
+              container: container, priority: Check.integer!(entry.fetch(:priority), "routes priority", range: 1..50_000),
+              paths: route_paths(entry.fetch(:paths), container)
+            )
+          end
+          private_class_method :route
+
+          def route_paths(value, container)
+            paths = Check.strings!(value, "routes[#{container}] paths", min: 1, max: 5)
+            bad = paths.reject { |path| path.start_with?("/", "*") }
+            raise ArgumentError, "routes[#{container}] paths must start with / or *, got #{bad.join(', ')}" unless bad.empty?
+
+            paths
+          end
+          private_class_method :route_paths
+
+          def check_unique!(layout)
+            {
+              "container names"      => layout.all.map(&:name),
+              "repository names"     => layout.all.map(&:repository_name),
+              "image tag parameters" => layout.all.map(&:tag_parameter),
+              "repository ids"       => layout.all.map(&:repository_id),
+              "target group ids"     => layout.balanced.map(&:target_group_id),
+              "container ports"      => layout.balanced.map(&:port),
+              "route ids"            => layout.routes.map(&:id),
+              "route priorities"     => layout.routes.map(&:priority)
+            }.each do |what, values|
+              repeated = values.tally.select { |_value, count| count > 1 }.keys
+              raise ArgumentError, "#{what} must be unique; repeated: #{repeated.join(', ')}" unless repeated.empty?
+            end
+          end
+          private_class_method :check_unique!
+
+          def check_reachable!(layout)
+            routed = layout.routes.map(&:container) + [layout.default_container]
+            stranded = layout.balanced.map(&:name) - routed
+            return if stranded.empty?
+
+            raise ArgumentError, "container(s) #{stranded.join(', ')} have a port but no route and are not the " \
+                                 "default_container, so the load balancer never reaches them; add a routes entry or drop the port"
+          end
+          private_class_method :check_reachable!
+
+          # Renders one added container as a `ContainerDefinitions` entry.
+          def definition_yaml(container, log_group_id)
+            lines = [
+              "- Name: #{container.name}",
+              "  Image: !Sub \"${#{container.repository_id}.RepositoryUri}:${#{container.tag_parameter}}\"",
+              "  Essential: #{container.essential}"
+            ]
+            lines << "  Cpu: #{container.cpu}" if container.cpu
+            lines << "  Memory: #{container.memory}" if container.memory
+            lines.concat(port_lines(container), log_lines(container, log_group_id), env_lines(container), secret_lines(container))
+            lines.join("\n")
+          end
+          private_class_method :definition_yaml
+
+          def port_lines(container)
+            container.port ? ["  PortMappings:", "    - ContainerPort: #{container.port}"] : []
+          end
+          private_class_method :port_lines
+
+          def log_lines(container, log_group_id)
+            [
+              "  LogConfiguration:", "    LogDriver: awslogs", "    Options:",
+              "      awslogs-group: !Ref #{log_group_id}", "      awslogs-region: !Ref AWS::Region",
+              "      awslogs-stream-prefix: #{container.name}"
+            ]
+          end
+          private_class_method :log_lines
+
+          def env_lines(container)
+            return [] if container.env.empty?
+
+            ["  Environment:"] + container.env.flat_map do |name, value|
+              ["    - Name: #{name}", "      Value: #{Yaml.string(value)}"]
+            end
+          end
+          private_class_method :env_lines
+
+          def secret_lines(container)
+            return [] if container.secrets.empty?
+
+            ["  Secrets:"] + container.secrets.flat_map do |name, value|
+              ["    - Name: #{name}", "      ValueFrom: #{Yaml.string(value)}"]
+            end
+          end
+          private_class_method :secret_lines
+        end
+      end
+    end
+  end
+end