jets 0.2.0 → 0.5.0

data/lib/jets/cfn/template_builders/job_builder.rb

@@ -0,0 +1,63 @@
+class Jets::Cfn::TemplateBuilders
+  class JobBuilder < BaseChildBuilder
+    def compose
+      add_common_parameters
+      add_functions
+      add_scheduled_tasks
+    end
+
+    def add_scheduled_tasks
+      # @app_klass is PostsController, HardJob, Hello, or HelloFunction
+      @app_klass.tasks.each do |task|
+        map = Jets::Cfn::TemplateMappers::EventsRuleMapper.new(task)
+
+        # If there's no scheduled expression dont add a scheduled Events::Rule
+        if task.schedule_expression
+          add_event_rule(task, map)
+          add_permission(map)
+        end
+      end
+    end
+
+    def add_event_rule(task, map)
+      add_resource(map.logical_id, "AWS::Events::Rule",
+        ScheduleExpression: task.schedule_expression,
+        State: task.state,
+        Targets: [
+          {
+            Arn: "!GetAtt #{map.lambda_function_logical_id}.Arn",
+            Id: map.rule_target_id
+          }
+        ]
+      )
+      # Example:
+      # add_resource("HardJobDigScheduledEvent", "AWS::Events::Rule",
+      #   ScheduleExpression: "rate(1 minute)",
+      #   State: "ENABLED",
+      #   Targets: [
+      #     {
+      #       Arn: "!GetAtt HardJobDigLambdaFunction.Arn",
+      #       Id: "RuleTargetHardJobDig"
+      #     }
+      #   ]
+      # )
+    end
+
+    def add_permission(map)
+      add_resource(map.permission_logical_id, "AWS::Lambda::Permission",
+        FunctionName: "!GetAtt #{map.lambda_function_logical_id}.Arn",
+        Action: "lambda:InvokeFunction",
+        Principal: "events.amazonaws.com",
+        SourceArn: "!GetAtt #{map.logical_id}.Arn"
+      )
+      # Example:
+      # add_resource("HardJobDigEventsRulePermission", "AWS::Lambda::Permission",
+      #   FunctionName: "!GetAtt HardJobDigLambdaFunction.Arn",
+      #   Action: "lambda:InvokeFunction",
+      #   Principal: "events.amazonaws.com",
+      #   SourceArn: "!GetAtt HardJobDigScheduledEvent.Arn"
+      # )
+    end
+  end
+end
+

data/lib/jets/cfn/template_builders/parent_builder.rb

@@ -0,0 +1,97 @@
+require 'erb'
+
+class Jets::Cfn::TemplateBuilders
+  class ParentBuilder
+    include Interface
+    include Jets::AwsServices
+
+    def initialize(options={})
+      @options = options
+      @template = ActiveSupport::HashWithIndifferentAccess.new(Resources: {})
+    end
+
+    # compose is an interface method
+    def compose
+      puts "Building parent template."
+
+      add_minimal_resources
+      add_child_resources unless @options[:stack_type] == :minimal
+    end
+
+    # template_path is an interface method
+    def template_path
+      Jets::Naming.parent_template_path
+    end
+
+    def add_minimal_resources
+      # variables for minimal-stack.yml
+      path = File.expand_path("../templates/minimal-stack.yml", __FILE__)
+      variables = {
+        policy_name: "lambda-#{Jets.config.project_namespace}-policy",
+        role_name: "lambda-#{Jets.config.project_namespace}-role",
+      }
+      rendered_result = Jets::Erb.result(path, variables)
+      minimal_template = YAML.load(rendered_result)
+
+      # minimal_template = YAML.load(IO.read(path))
+      @template.deep_merge!(minimal_template)
+    end
+
+    def add_child_resources
+      expression = "#{Jets::Naming.template_path_prefix}-*"
+      # IE: path: #{Jets.build_root}/templates/demo-dev-2-comments_controller.yml
+      Dir.glob(expression).each do |path|
+        next unless File.file?(path)
+        next if path =~ /api-gateway/ # treated specially
+
+        # Example of produced code:
+        #
+        #   map = Jets::Cfn::TemplateMappers::ControllerMapper.new(path, s3_bucket)
+        #   map = Jets::Cfn::TemplateMappers::JobMapper.new(path, s3_bucket)
+        #   map = Jets::Cfn::TemplateMappers::FunctionMapper.new(path, s3_bucket)
+        #
+        mapper_class_name = File.basename(path, '.yml').split('_').last
+        mapper_class_name = mapper_class_name.classify
+        mapper_class = "Jets::Cfn::TemplateMappers::#{mapper_class_name}Mapper".constantize # ControllerMapper or JobMapper
+        map = mapper_class.new(path, @options[:s3_bucket])
+
+        # map.logical_id example: PostsController, HardJob, Hello, HelloFunction
+        add_resource(map.logical_id, "AWS::CloudFormation::Stack",
+          TemplateURL: map.template_url,
+          Parameters: map.parameters,
+        )
+      end
+
+      if @options[:stack_type] == :full and !Jets::Router.routes.empty?
+        add_api_gateway
+        add_api_gateway_deployment
+      end
+    end
+
+    # Each shared stacks has different logic.
+    # Handle in ugly case statement until we see the common patterns between them.
+    # TODO: clean up the add_shared_stack logical after we figure out the common interface pattern
+    def add_api_gateway
+      path = "#{Jets.config.project_namespace}-api-gateway.yml"
+      map = Jets::Cfn::TemplateMappers::ApiGatewayMapper.new(path, @options[:s3_bucket])
+
+      add_resource(map.logical_id, "AWS::CloudFormation::Stack",
+        Properties: { TemplateURL: map.template_url }
+      )
+
+      add_output(map.logical_id, Value: "!Ref #{map.logical_id}")
+    end
+
+    def add_api_gateway_deployment
+      path = "#{Jets.config.project_namespace}-api-gateway-deployment.yml"
+      map = Jets::Cfn::TemplateMappers::ApiGatewayDeploymentMapper.new(path, @options[:s3_bucket])
+      add_resource(map.logical_id, "AWS::CloudFormation::Stack",
+        Properties: {
+          TemplateURL: map.template_url,
+          Parameters: map.parameters
+        },
+        DependsOn: map.depends_on
+      )
+    end
+  end
+end

data/lib/jets/cfn/template_builders/rule_builder.rb

@@ -0,0 +1,55 @@
+class Jets::Cfn::TemplateBuilders
+  class RuleBuilder < BaseChildBuilder
+    def compose
+      add_common_parameters
+      add_functions
+      add_config_rules
+    end
+
+    def add_config_rules
+      # @app_klass is PostsController, HardRule, Hello, or HelloFunction, or GameRule
+      @app_klass.tasks.each do |task|
+        map = Jets::Cfn::TemplateMappers::ConfigRuleMapper.new(task)
+
+        add_config_rule(task, map)
+        add_permission(map)
+      end
+    end
+
+
+    def add_config_rule(task, map)
+      # Usually we build the properties with the mappers but in the case for
+      # a config_rule it makes more sense to grab properties from the task
+      # using config_rule_properties
+      add_resource(map.logical_id, "AWS::Config::ConfigRule",
+        Properties: task.config_rule_properties,
+        DependsOn: map.permission_logical_id
+      )
+      # Example:
+      # add_resource("GameRuleProtectConfigRule", "AWS::Config::ConfigRule",
+      #   "ConfigRuleName" : String,
+      #   "Description" : String,
+      #   "InputParameters" : { ParameterName : Value },
+      #   "MaximumExecutionFrequency" : String,
+      #   "Scope" : Scope,
+      #   "Source" : Source
+      # )
+    end
+
+    def add_permission(map)
+      add_resource(map.permission_logical_id, "AWS::Lambda::Permission",
+        FunctionName: "!GetAtt #{map.lambda_function_logical_id}.Arn",
+        Action: "lambda:InvokeFunction",
+        Principal: "config.amazonaws.com"
+      )
+      # Example:
+      # add_resource("GameRuleProtectConfigRulePermission", "AWS::Lambda::Permission",
+      #   FunctionName: "!GetAtt GameRuleProtectLambdaFunction.Arn",
+      #   Action: "lambda:InvokeFunction",
+      #   Principal: "config.amazonaws.com",
+      #   SourceArn: "!GetAtt ScheduledEventHardRuleDig.Arn"
+      # )
+    end
+  end
+end
+

data/lib/jets/cfn/template_builders/templates/minimal-stack.yml

@@ -0,0 +1,45 @@
+---
+Resources:
+  S3Bucket:
+    Type: AWS::S3::Bucket
+  IamRole:
+    Type: AWS::IAM::Role
+    Properties:
+      AssumeRolePolicyDocument:
+        Version: '2012-10-17'
+        Statement:
+        - Effect: Allow
+          Principal:
+            Service:
+            - lambda.amazonaws.com
+          Action:
+          - sts:AssumeRole
+      Policies:
+      - PolicyName: <%= @policy_name %>
+        PolicyDocument:
+          Version: '2012-10-17'
+          Statement:
+          - Effect: Allow
+            Action:
+            - logs:*
+            Resource: '*'
+            # TODO: Make IAM permissions more fine grain for mimimal stack
+            # - Fn::Sub: arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/lambda/quiz-dev-hello:*:*
+            # - Fn::Sub: arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/lambda/quiz-dev-quiz:*:*
+            # TODO: Allow hook so user can configure IAM themselves and support managed polices
+          - Effect: Allow
+            Action:
+            - dynamodb:*
+            Resource: "*"
+            # required for PreheatJob which calls the other lambda functions repeatedly
+          - Effect: Allow
+            Action:
+            - lambda:*
+            Resource: "*"
+      Path: "/"
+      RoleName: <%= @role_name %>
+Outputs:
+  S3Bucket:
+    Value: "!Ref S3Bucket" # not a valid cfn notation, surrounding double quotes is handled by post processing.
+  IamRole:
+    Value: "!Ref IamRole"

data/lib/jets/cfn/template_mappers.rb

@@ -0,0 +1,23 @@
+require 'active_support/core_ext/hash'
+require 'yaml'
+
+class Jets::Cfn
+  class TemplateMappers
+    # used in the parent_template.rb
+    autoload :ChildMapper, "jets/cfn/template_mappers/child_mapper"
+    autoload :ControllerMapper, "jets/cfn/template_mappers/controller_mapper"
+    autoload :JobMapper, "jets/cfn/template_mappers/job_mapper"
+    autoload :FunctionMapper, "jets/cfn/template_mappers/function_mapper"
+    autoload :RuleMapper, "jets/cfn/template_mappers/rule_mapper"
+
+    autoload :ApiGatewayMapper, "jets/cfn/template_mappers/api_gateway_mapper"
+    autoload :ApiGatewayDeploymentMapper, "jets/cfn/template_mappers/api_gateway_deployment_mapper"
+    # used in the child_template.rb
+    autoload :GatewayMethodMapper, "jets/cfn/template_mappers/gateway_method_mapper"
+    autoload :GatewayResourceMapper, "jets/cfn/template_mappers/gateway_resource_mapper"
+    autoload :LambdaFunctionMapper, "jets/cfn/template_mappers/lambda_function_mapper"
+
+    autoload :EventsRuleMapper, "jets/cfn/template_mappers/events_rule_mapper"
+    autoload :ConfigRuleMapper, "jets/cfn/template_mappers/config_rule_mapper"
+  end
+end

data/lib/jets/cfn/template_mappers/api_gateway_deployment_mapper.rb

@@ -0,0 +1,48 @@
+class Jets::Cfn::TemplateMappers
+  class ApiGatewayDeploymentMapper < ChildMapper
+    def logical_id
+      self.class.logical_id
+    end
+
+    def timestamp
+      self.class.timestamp
+    end
+
+    # stage_name: stag, stag-1, stag-2, etc
+    def stage_name
+      self.class.stage_name
+    end
+
+    def parameters
+      {
+        RestApi: "!GetAtt ApiGateway.Outputs.RestApi"
+      }
+    end
+
+    def depends_on
+      expression = "#{Jets::Naming.template_path_prefix}-*_controller*"
+      controller_logical_ids = []
+      Dir.glob(expression).each do |path|
+        next unless File.file?(path)
+        # @s3_bucket is available from the inherited ChildMapper class
+        map = ChildMapper.new(path, @s3_bucket)
+        controller_logical_ids << map.logical_id
+      end
+      controller_logical_ids
+    end
+
+    # Returns: "ApiGatewayDeployment[timestamp]"
+    def self.logical_id
+      "ApiGatewayDeployment#{timestamp}"
+    end
+
+    @@timestamp = nil
+    def self.timestamp
+      @@timestamp ||= Time.now.strftime("%Y%m%d%H%M%S")
+    end
+
+    def self.stage_name
+      [Jets.config.short_env, Jets.config.env_extra].compact.join('_').gsub('-','_') # Stage name only allows a-zA-Z0-9_
+    end
+  end
+end

data/lib/jets/cfn/template_mappers/api_gateway_mapper.rb

@@ -0,0 +1,4 @@
+class Jets::Cfn::TemplateMappers
+  class ApiGatewayMapper < ChildMapper
+  end
+end

data/lib/jets/cfn/template_mappers/child_mapper.rb

@@ -0,0 +1,41 @@
+class Jets::Cfn::TemplateMappers
+  class ChildMapper
+    attr_reader :path
+    def initialize(path, s3_bucket)
+      # "#{Jets.build_root}/templates/demo-dev-posts_controller.yml"
+      @path = path
+      @s3_bucket = s3_bucket
+    end
+
+    # common parameters to all child stacks
+    def parameters
+      parameters = {
+        # YAML.dump converts it to a string
+        # !GetAtt Base.Outputs.IamRole => "!GetAtt Base.Outputs.IamRole"
+        # But post processing of the template fixes this
+        IamRole: "!GetAtt IamRole.Arn",
+        S3Bucket: "!Ref S3Bucket",
+      }
+    end
+
+    # Example: PostsController
+    def logical_id
+      regexp = Regexp.new(".*#{Jets.config.project_namespace}-")
+      contoller_name = @path.sub(regexp, '').sub('.yml', '')
+      # map the path to a camelized logical_id. Example:
+      #   /tmp/jets/demo/templates/demo-dev-2-posts_controller.yml to
+      #   PostsController
+      contoller_name.underscore.camelize
+    end
+
+    def template_url
+      # here's where it gets interesting with the bucket. The bucket will
+      # need to exist for the child templates.  But wont be created until the stack
+      # has been first launched.  We can create the bucket in a separate stack
+      # And then grab it and then store it in a cache file.
+      basename = File.basename(@path)
+      # IE: https://s3.amazonaws.com/[bucket]/jets/cfn-templates/demo-dev-posts_controller.yml"
+      "https://s3.amazonaws.com/#{@s3_bucket}/jets/cfn-templates/#{basename}"
+    end
+  end
+end

data/lib/jets/cfn/template_mappers/config_rule_mapper.rb

@@ -0,0 +1,34 @@
+# Used in cfn/template_builders/rule_builder.rb to build AWS::Config::ConfigRule
+class Jets::Cfn::TemplateMappers
+  class ConfigRuleMapper
+    # task is a Jets::Job::Task
+    def initialize(task)
+      @task = task
+    end
+
+    # Example: "ConfigRuleGameRuleProtect"
+    def logical_id
+      "#{full_task_name}ConfigRule"
+    end
+
+    # Example: "GameRuleProtectLambdaFunction"
+    def lambda_function_logical_id
+      "#{full_task_name}LambdaFunction"
+    end
+
+    # Example: GameRuleProtectConfigRulePermission
+    def permission_logical_id
+      "#{full_task_name}ConfigRulePermission"
+    end
+
+  private
+    # Full camelized task name including the class
+    # Example: GameRuleProtect
+    def full_task_name
+      class_name = @task.class_name
+      task_name = @task.meth.to_s.camelize
+      "#{class_name}#{task_name}"
+    end
+  end
+end
+

data/lib/jets/cfn/template_mappers/controller_mapper.rb

@@ -0,0 +1,36 @@
+class Jets::Cfn::TemplateMappers
+  class ControllerMapper < ChildMapper
+    # Parameters that are common to all controller stacks
+    def parameters
+      parameters = super
+      return parameters if Jets::Router.routes.empty?
+
+      # Add the API Gateway parameters
+      parameters[:RestApi] = "!GetAtt ApiGateway.Outputs.RestApi"
+      scoped_routes.each do |route|
+        map = GatewayResourceMapper.new(route.path)
+        parameters[map.logical_id] = "!GetAtt ApiGateway.Outputs.#{map.logical_id}"
+      end
+
+      parameters
+    end
+
+    def scoped_routes
+      @routes ||= Jets::Router.routes.select do |route|
+        route.controller_name == current_class
+      end
+    end
+
+      # Example:
+      #   1. demo-stag-admin-related_pages_controller.yml
+      #   2. admin/posts_controller
+      #   3. Admin::PostsController
+    def current_class
+      templates_prefix = "#{Jets::Naming.template_path_prefix}-"
+      @path.sub(templates_prefix, '')
+        .sub(/\.yml$/,'')
+        .gsub('-','/')
+        .classify
+    end
+  end
+end