cody 0.1.0 → 0.7.0

data/lib/cody/help/completion.md

@@ -0,0 +1,22 @@
+Example:
+
+    cody completion
+
+Prints words for TAB auto-completion.
+
+Examples:
+
+    cody completion
+    cody completion hello
+    cody completion hello name
+
+To enable, TAB auto-completion add the following to your profile:
+
+    eval $(cody completion_script)
+
+Auto-completion example usage:
+
+    cody [TAB]
+    cody hello [TAB]
+    cody hello name [TAB]
+    cody hello name --[TAB]

data/lib/cody/help/completion_script.md

@@ -0,0 +1,3 @@
+To use, add the following to your `~/.bashrc` or `~/.profile`
+
+    eval $(cody completion_script)

data/lib/cody/help/deploy.md

@@ -0,0 +1,32 @@
+## Examples
+
+    cody deploy PROJECT_NAME # explicitly specify project-name
+    cody deploy # infers the CodeBuild name from the parent folder
+
+It is useful to just see the generated CloudFormation template with `--noop` mode:
+
+    cody deploy PROJECT_NAME --noop # see generated CloudFormation template
+
+## Types
+
+By default, cody looks up files in the `.cody` folder.  Example:
+
+    .cody/buildspec.yml
+    .cody/project.rb
+    .cody/role.rb
+
+### Examples
+
+    cody deploy PROJECT_NAME --type deploy
+
+This will look up buildspec.yml, project.rb, and role.rb files in the `.cody/deploy` folder. So:
+
+    .cody/deploy/buildspec.yml
+    .cody/deploy/project.rb
+    .cody/deploy/role.rb
+
+Likewise `cody deploy PROJECT_NAME --type unit` would result in:
+
+    .cody/unit/buildspec.yml
+    .cody/unit/project.rb
+    .cody/unit/role.rb

data/lib/cody/help/init.md

@@ -0,0 +1,71 @@
+## Examples
+
+    cody init # infers the name from the parent folder
+    cody init my-project # set the name
+
+## Type Option
+
+The type option is useful to generate subfolder under .cody that contain another codebuild project.  Example:
+
+    cody init --type unit
+
+Thi generates the cb files under the `.cody/unit` folder.
+
+    .cody
+    └── unit
+        ├── buildspec.yml
+        └── project.rb
+
+To tell cody to use these files, you specify the `--type` option as a part of the other commands. Examples:
+
+    cody deploy --type unit
+    cody start --type unit
+
+## Structure
+
+So if you need multiple CodeBuild projects that perform different tasks but are both related to the same code repo, you might have a structure like this:
+
+    .cody
+    ├── deploy
+    │   ├── buildspec.yml
+    │   └── project.rb
+    └── unit
+        ├── buildspec.yml
+        └── project.rb
+
+## Mode Option
+
+By default, `cody init` generates a very lightweight structure.  You can have it also generate a "full" structure with the `--mode` option.  Example.
+
+    $ cody init --mode full
+    $ tree .cody
+    .cody
+    ├── buildspec.yml
+    ├── project.rb
+    ├── role.rb
+    ├── schedule.rb
+    ├── settings.yml
+    └── variables
+        ├── base.rb
+        ├── development.rb
+        └── production.rb
+
+## Custom Templates
+
+If you would like the `cody init` command to use your own custom templates, you can achieve this with the `--template` and `--template-mode` options.  Example:
+
+    cody init --template=tongueroo/cody-custom-template
+
+This will clone the repo on GitHub into the `~/.cody/templates/tongueroo/cody-custom-template` and use that as an additional template source.  The default `--template-mode=additive` mode means that if there's a file in `tongueroo/cody-custom-template` that exists it will use that in place of the default template files.
+
+If you do not want to use any of the original default template files within the cody gem at all, you can use the `--template-mode=replace` mode. Replace mode will only use templates from the provided `--template` option.  Example:
+
+    cody init --template=tongueroo/cody-custom-template --template-mode=replace
+
+You can also specific the full GitHub url. Example:
+
+    cody init --template=https://github.com/tongueroo/cody-custom-template
+
+If you would like to use a local template that is not on GitHub, then created a top-level folder in `~/.cody/templates` without a subfolder. Example:
+
+    cody init --template=my-custom # uses ~/.cody/templates/my-custom

data/lib/cody/help/start.md

@@ -0,0 +1,12 @@
+# Examples
+
+    cody start # infers the name from the parent folder
+    cody start stack-name # looks up project via CloudFormation stack
+    cody start demo-project # looks up project via codebuild project name
+
+## Overriding Env Variables at Runtime
+
+You can override env variables at runtime with `--env-vars`. Examples:
+
+    cody start --type vpc --env-vars K1=v1 K2=v2
+    cody start --type vpc --env-vars K1=v1 K2=ssm:v2 # support for PARAMETER_STORE

data/lib/cody/init.rb

@@ -0,0 +1,102 @@
+module Cody
+  class Init < Sequence
+    # Ugly, this is how I can get the options from to match with this Thor::Group
+    def self.cli_options
+      [
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files"],
+        [:name, desc: "CodeBuild project name"],
+        [:mode, default: "light", desc: "Modes: light or full"],
+        [:template, desc: "Custom template to use"],
+        [:template_mode, desc: "Template mode: replace or additive"],
+        [:type, desc: "Type option creates a subfolder under .cody"],
+      ]
+    end
+    cli_options.each { |o| class_option(*o) }
+
+    def setup_template_repo
+      return unless @options[:template]&.include?('/')
+
+      sync_template_repo
+    end
+
+    def set_source_path
+      return unless @options[:template]
+
+      custom_template = "#{ENV['HOME']}/.cody/templates/#{full_repo_name}"
+
+      if @options[:template_mode] == "replace" # replace the template entirely
+        override_source_paths(custom_template)
+      else # additive: modify on top of default template
+        default_template = File.expand_path("../../template", __FILE__)
+        puts "default_template: #{default_template}"
+        override_source_paths([custom_template, default_template])
+      end
+    end
+
+    def copy_top_level
+      puts "Initialize codebuild top-level folder"
+      dest = ".cody"
+      excludes = %w[.git]
+      if @options[:mode] == "light"
+        excludes += %w[
+          settings.yml
+          variables
+        ]
+      end
+      pattern = Regexp.new(excludes.join('|'))
+      directory "top", dest, exclude_pattern: pattern
+    end
+
+    def copy_project
+      puts "Initialize codebuild project in .cody"
+      dest = ".cody"
+      dest = "#{dest}/#{@options[:type]}" if @options[:type]
+
+      excludes = %w[.git]
+      if @options[:mode] == "light"
+        excludes += %w[
+          role.rb
+          schedule.rb
+        ]
+      end
+
+      pattern = Regexp.new(excludes.join('|'))
+      directory "project", dest, exclude_pattern: pattern
+    end
+
+  private
+    def project_name
+      inferred_name = File.basename(Dir.pwd).gsub('_','-').gsub(/[^0-9a-zA-Z,-]/, '')
+      @options[:name] || inferred_name
+    end
+
+    def project_github_url
+      default = "https://github.com/user/repo"
+      return default unless File.exist?(".git/config") && git_installed?
+
+      url = `git config --get remote.origin.url`.strip
+      url = url.sub('git@github.com:','https://github.com/')
+      url == '' ? default : url
+    end
+
+    def lookup_managed_image(pattern=/ruby:/)
+      resp = codebuild.list_curated_environment_images
+
+      # Helpful for debugging:
+      #   aws codebuild list-curated-environment-images | jq -r '.platforms[].languages[].images[].versions[]' | sort
+
+      versions = []
+      resp.platforms.each do |platform|
+        platform.languages.each do |lang|
+          lang.images.each do |image|
+            versions += image.versions.compact
+          end
+        end
+      end
+      versions = versions.select { |v| v =~ pattern }
+      # IE: aws/codebuild/ruby:2.5.3-1.7.0
+      # Falls back to hard-coded image name since the API changed and looks like it's returning no ruby images
+      versions.sort.last || "aws/codebuild/ruby:2.5.3-1.7.0"
+    end
+  end
+end

data/lib/cody/project.rb

@@ -0,0 +1,72 @@
+require "yaml"
+
+module Cody
+  class Project
+    include Dsl::Project
+    include Evaluate
+    include Variables
+
+    attr_reader :project_name, :full_project_name, :project_path
+    def initialize(options={})
+      @options = options
+      @project_name = options[:project_name]
+      @full_project_name = options[:full_project_name] # includes -development at the end
+      @project_path = options[:project_path] || get_project_path
+      @properties = default_properties # defaults make project.rb simpler
+    end
+
+    def exist?
+      File.exist?(@project_path)
+    end
+
+    def run
+      load_variables
+      evaluate(@project_path)
+      resource = {
+        code_build: {
+          type: "AWS::CodeBuild::Project",
+          properties: @properties
+        }
+      }
+      CfnCamelizer.transform(resource)
+    end
+
+    def default_properties
+      {
+        name: @full_project_name,
+        description: @full_project_name,
+        artifacts: { type: "NO_ARTIFACTS" },
+        service_role: { ref: "IamRole" },
+        badge_enabled: true,
+        timeout_in_minutes: 20,
+        logs_config: {
+          cloud_watch_logs: {
+            status: "ENABLED",
+            # the default log group name is thankfully the project name
+          }
+        },
+        source: {
+          type: "GITHUB",
+          # location: "", # required
+          # git_clone_depth: 1,
+          git_submodules_config: { fetch_submodules: true },
+          build_spec: build_spec,
+          # auth doesnt seem to work, refer to https://github.com/tongueroo/cody/blob/master/readme/github_oauth.md
+          # auth: {
+          #   type: "OAUTH",
+          #   # resource: "", # required
+          # },
+          report_build_status: true,
+        }
+      }
+    end
+
+    def get_project_path
+      lookup_codebuild_file("project.rb")
+    end
+
+    def build_spec
+      lookup_codebuild_file("buildspec.yml")
+    end
+  end
+end

data/lib/cody/role.rb

@@ -0,0 +1,87 @@
+require "yaml"
+
+module Cody
+  class Role
+    include Cody::Dsl::Role
+    include Evaluate
+    include Variables
+
+    def initialize(options={})
+      @options = options
+      @role_path = options[:role_path] || get_role_path
+      @properties = default_properties
+      @iam_policy = {}
+    end
+
+    def run
+      load_variables
+      evaluate(@role_path) if File.exist?(@role_path)
+      @properties[:policies] = [{
+        policy_name: "CodeBuildAccess",
+        policy_document: {
+          version: "2012-10-17",
+          statement: derived_iam_statements
+        }
+      }]
+
+      if @managed_policy_arns && !@managed_policy_arns.empty?
+        @properties[:managed_policy_arns] = @managed_policy_arns
+      else
+        @properties[:managed_policy_arns] = default_managed_policy_arns
+      end
+
+      resource = {
+        IamRole: {
+          type: "AWS::IAM::Role",
+          properties: @properties
+        }
+      }
+      CfnCamelizer.transform(resource)
+    end
+
+  private
+    def get_role_path
+      lookup_codebuild_file("role.rb")
+    end
+
+    def default_properties
+      {
+        assume_role_policy_document: {
+          statement: [{
+            action: ["sts:AssumeRole"],
+            effect: "Allow",
+            principal: {
+              service: ["codebuild.amazonaws.com"]
+            }
+          }],
+          version: "2012-10-17"
+        },
+        path: "/"
+      }
+    end
+
+    def derived_iam_statements
+      @iam_statements || default_iam_statements
+    end
+
+    def default_iam_statements
+      [{
+        action: [
+          "logs:CreateLogGroup",
+          "logs:CreateLogStream",
+          "logs:PutLogEvents",
+          "ssm:DescribeDocumentParameters",
+          "ssm:DescribeParameters",
+          "ssm:GetParameter*",
+        ],
+        effect: "Allow",
+        resource: "*"
+      }]
+    end
+
+    def default_managed_policy_arns
+      # Useful when using with CodePipeline
+      ["arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess"]
+    end
+  end
+end

data/lib/cody/schedule.rb

@@ -0,0 +1,102 @@
+module Cody
+  class Schedule
+    include Cody::Dsl::Schedule
+    include Evaluate
+    include Variables
+
+    def initialize(options={})
+      @options = options
+      @schedule_path = options[:schedule_path] || get_schedule_path
+      @properties = default_properties
+      @iam_policy = {}
+    end
+
+    def run
+      return unless File.exist?(@schedule_path)
+
+      old_properties = @properties.clone
+      load_variables
+      evaluate(@schedule_path)
+
+      @properties[:schedule_expression] = @schedule_expression if @schedule_expression
+      set_rule_event! if @rule_event_props
+      return if old_properties == @properties # empty schedule.rb file
+
+      resource = {
+        events_rule: {
+          type: "AWS::Events::Rule",
+          properties: @properties
+        },
+        events_rule_role: events_rule_role,
+      }
+      CfnCamelizer.transform(resource)
+    end
+
+    def set_rule_event!
+      props = @rule_event_props
+      if props.key?(:detail)
+        description = props.key?(:description) ? props.delete(:description) : rule_description
+        rule_props = { event_pattern: props, description: description }
+      else # if props.key?(:event_pattern)
+        props[:description] ||= rule_description
+        rule_props = props
+      end
+
+      @properties.merge!(rule_props)
+    end
+
+    def default_properties
+      description = "Cody #{@options[:full_project_name]}"
+      name = description.gsub(" ", "-").downcase
+      {
+        description: "#{description} CodeBuild project",
+        # event_pattern: ,
+        name: name,
+        # schedule_expression: ,
+        state: "ENABLED",
+        targets: [{
+          arn: { "Fn::GetAtt": "CodeBuild.Arn" },
+          role_arn: { "Fn::GetAtt": "EventsRuleRole.Arn" }, # required for specific CodeBuild target.
+          id: "CodeBuildTarget",
+        }]
+      }
+    end
+
+  private
+    def get_schedule_path
+      lookup_codebuild_file("schedule.rb")
+    end
+
+    def events_rule_role
+      {
+        type: "AWS::IAM::Role",
+        properties: {
+          assume_role_policy_document: {
+            statement: [{
+              action: [ "sts:AssumeRole" ],
+              effect: "Allow",
+              principal: { service: [ "events.amazonaws.com" ] }
+            }],
+            version: "2012-10-17"
+          },
+          path: "/",
+          policies: [{
+            policy_name: "CodeBuildAccess",
+            policy_document: {
+              version: "2012-10-17",
+              statement: [{
+                action: "codebuild:StartBuild",
+                effect: "Allow",
+                resource: "arn:aws:codebuild:#{aws_data.region}:#{aws_data.account}:project/#{@options[:full_project_name]}"
+              }]
+            }
+          }]
+        }
+      }
+    end
+
+    def aws_data
+      @aws_data ||= AwsData.new
+    end
+  end
+end