cody 0.9.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f84323d071291727d2b3bdf96dbcb4e2bc1e1059f67bcf55dc0a062fbd326e0
-  data.tar.gz: e83e848a9b35fff1b555472c0fbcc5ec48f3068f5cae3c33b244b710928d1416
+  metadata.gz: affa968f8c18562b877c26f70abbc6c747b7ef3542fbc2c714218e44e017b114
+  data.tar.gz: 74d95d28f13744a40c759844f46046e443eb1f0446f330683864eb19357baa65
 SHA512:
-  metadata.gz: d2ddb7689115463ee43717d0f647f73e320d17b3a468f9b6ba40d4c806bc8bd8f448e18c66d66d1674b28ca90d6898369523b4b16a3de02f11a2d68256c65768
-  data.tar.gz: 4c21a9d3ab5019335dd2f11453efcc7e6726815d41d5a0dc68531c07ca2c3e11b7eff174d1c5d93808f9647ab257f137df3078abdc6ce49e5d301f387390c9fd
+  metadata.gz: 76c6feeb50683d4d5eea4e4944fd0385f698d91e013f5917be219302dd9aa12fa1b46213dc7695a9390e3c1bd5a2f5b200f4b83eff2b2f285f73d2049833ed55
+  data.tar.gz: df3d1926d50125b9f7b21537e973c63e4309f9407c538f78fe9f2e2501f2f3228d3ad8ec8e852241fc0379ee8ba46c200275555e5f45e32475953a9981e083fb

data/.gitmodules

@@ -1,9 +0,0 @@
-[submodule "vendor/cfn-status"]
-	path = vendor/cfn-status
-	url = https://github.com/tongueroo/cfn-status
-[submodule "vendor/cfn_camelizer"]
-	path = vendor/cfn_camelizer
-	url = https://github.com/tongueroo/cfn_camelizer
-[submodule "vendor/aws_data"]
-	path = vendor/aws_data
-	url = https://github.com/tongueroo/aws_data

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.0.0]
+* Breaking changes: CamelCase for properties instead of underscore. Map straight to the CloudFormation resource to remove mental overhead.
+* Use unfrozen gems instead of vendors gems: aws_data, cfn-status, cfn_camelizer.
+* Update templates to use the latest
+* Restructure classes to use CLI namespace
+* Change delete: `--sure` to `--yes` option. `-y` shorthand.
+* Rename CODY_EXTRA env variable
+
 ## [0.9.8]
 - add minimal deploy iam policy docs
 - list: add --status filter option

data/Gemfile

@@ -2,5 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem dependencies in codebuild.gemspec
 gemspec
-
-gem "codeclimate-test-reporter", group: :test, require: nil

data/cody.gemspec

@@ -28,6 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "aws-sdk-cloudformation"
   spec.add_dependency "aws-sdk-codebuild"
   spec.add_dependency "aws-sdk-ssm"
+  spec.add_dependency "aws_data"
+  spec.add_dependency "cfn-status"
+  spec.add_dependency "cfn_camelizer"
   spec.add_dependency "cli-format"
   spec.add_dependency "memoist"
   spec.add_dependency "rainbow"
@@ -35,9 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
   spec.add_dependency "zeitwerk"
 
-  # spec.add_dependency "aws_data" # using vendor/cfn_camelizer for now
-  # spec.add_dependency "cfn_camelizer" # using vendor/cfn_camelizer for now
-
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "cli_markdown"

data/lib/cody.rb

@@ -1,19 +1,15 @@
 $:.unshift(File.expand_path("../", __FILE__))
+require "aws_data"
+require "cfn_camelizer"
+require "cfn_status"
 require "cody/version"
+require "memoist"
 require "rainbow/ext/string"
 require "yaml"
 
 require "cody/autoloader"
 Cody::Autoloader.setup
 
-gem_root = File.dirname(__dir__)
-$:.unshift("#{gem_root}/vendor/aws_data/lib")
-require "aws_data"
-$:.unshift("#{gem_root}/vendor/cfn_camelizer/lib")
-require "cfn_camelizer"
-$:.unshift("#{gem_root}/vendor/cfn-status/lib")
-require "cfn/status"
-
 module Cody
   class Error < StandardError; end
   extend Core

data/lib/cody/aws_services.rb

@@ -15,4 +15,4 @@ module Cody
       @cfn ||= Aws::CloudFormation::Client.new
     end
   end
-end
+end

data/lib/cody/aws_services/helpers.rb

@@ -1,5 +1,18 @@
 module Cody::AwsServices
   module Helpers
+    def find_stack(stack_name)
+      return if ENV['TEST']
+      resp = cfn.describe_stacks(stack_name: stack_name)
+      resp.stacks.first
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      # example: Stack with id demo-web does not exist
+      if e.message =~ /Stack with/ && e.message =~ /does not exist/
+        nil
+      else
+        raise
+      end
+    end
+
     def stack_exists?(stack_name)
       return false if ENV['TEST']
 
@@ -26,7 +39,7 @@ module Cody::AwsServices
     end
 
     def project_name_convention(name_base)
-      items = [@project_name, @options[:type], Cody.env_extra]
+      items = [@project_name, @options[:type], Cody.extra]
       items.insert(2, Cody.env) if Cody.settings.dig(:stack_naming, :append_env)
       items.reject(&:blank?).compact.join("-")
     end
@@ -44,13 +57,13 @@ module Cody::AwsServices
     #
     def inferred_stack_name(project_name)
       append_stack_name = Cody.settings.dig(:stack_naming, :append_stack_name) || "cody"
-      items = [project_name, @options[:type], Cody.env_extra, append_stack_name]
+      items = [project_name, @options[:type], Cody.extra, append_stack_name]
       items.insert(3, Cody.env) if Cody.settings.dig(:stack_naming, :append_env)
       items.reject(&:blank?).reject {|i| i == false}.compact.join("-")
     end
 
     def are_you_sure?(stack_name, action)
-      if @options[:sure]
+      if @options[:yes]
         sure = 'y'
       else
         message = case action
@@ -68,5 +81,9 @@ module Cody::AwsServices
         exit 0
       end
     end
+
+    def normalize_stack_name(name)
+      name.gsub('_','-') # cloudformation stack names dont allow _
+    end
   end
 end

data/lib/cody/cli.rb

@@ -27,7 +27,7 @@ module Cody
 
     desc "delete", "Delete codebuild project."
     long_desc Help.text(:delete)
-    option :sure, desc: "Bypass are you sure prompt"
+    option :yes, aliases: %w[y], desc: "Bypass are you sure prompt"
     common_options.call
     def delete(project_name=nil)
       Delete.new(options.merge(project_name: project_name)).run
@@ -64,6 +64,7 @@ module Cody
     option :format, desc: "Output formats: #{CliFormat.formats.join(', ')}"
     option :sort_by, desc: "Sort by column: name, status, time"
     option :status, desc: "status filter. IE: SUCCEEDED, FAILED, FAULT, TIMED_OUT, IN_PROGRESS, STOPPED. Both upper and lowercase works."
+    option :select, desc: "select filter on the project name. The select option gets converted to an Ruby regexp"
     def list
       List.new(options).run
     end
@@ -85,18 +86,6 @@ module Cody
       Badge.new(options.merge(project_name: project_name)).run
     end
 
-    desc "completion *PARAMS", "Prints words for auto-completion."
-    long_desc Help.text(:completion)
-    def completion(*params)
-      Completer.new(CLI, *params).run
-    end
-
-    desc "completion_script", "Generates a script that can be eval to setup auto-completion."
-    long_desc Help.text(:completion_script)
-    def completion_script
-      Completer::Script.generate
-    end
-
     desc "version", "prints version"
     def version
       puts VERSION

data/lib/cody/{badge.rb → cli/badge.rb}

@@ -1,4 +1,4 @@
-module Cody
+class Cody::CLI
   class Badge < Base
     def run
       resp = codebuild.batch_get_projects(names: [@full_project_name])

data/lib/cody/{base.rb → cli/base.rb}

@@ -1,7 +1,7 @@
 # Base only for Stop and Start currently.
-module Cody
+class Cody::CLI
   class Base
-    include AwsServices
+    include Cody::AwsServices
 
     def initialize(options)
       @options = options
@@ -24,5 +24,11 @@ module Cody
       resp = codebuild.list_builds_for_project(project_name: @full_project_name)
       resp.ids.first # most recent build_id
     end
+
+    def check_build_id!
+      return if build_id
+      puts "WARN: No builds found for #{@project_name.color(:green)} project"
+      exit
+    end
   end
-end
+end

data/lib/cody/{delete.rb → cli/delete.rb}

@@ -1,11 +1,11 @@
-module Cody
+class Cody::CLI
   class Delete
-    include AwsServices
+    include Cody::AwsServices
 
     def initialize(options)
       @options = options
       @project_name = options[:project_name] || inferred_project_name
-      @stack_name = options[:stack_name] || inferred_stack_name(@project_name)
+      @stack_name = normalize_stack_name(options[:stack_name] || inferred_stack_name(@project_name))
     end
 
     def run

data/lib/cody/cli/deploy.rb

@@ -0,0 +1,7 @@
+class Cody::CLI
+  class Deploy < Base
+    def run
+      Cody::Stack.new(@options).run
+    end
+  end
+end

data/lib/cody/cli/help.rb

@@ -0,0 +1,11 @@
+class Cody::CLI
+  module Help
+    class << self
+      def text(namespaced_command)
+        path = namespaced_command.to_s.gsub(':','/')
+        path = File.expand_path("../help/#{path}.md", __FILE__)
+        IO.read(path) if File.exist?(path)
+      end
+    end
+  end
+end

data/lib/cody/{init.rb → cli/init.rb}

@@ -1,4 +1,4 @@
-module Cody
+class Cody::CLI
   class Init < Sequence
     # Ugly, this is how I can get the options from to match with this Thor::Group
     def self.cli_options
@@ -28,7 +28,6 @@ module Cody
         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

data/lib/cody/{list.rb → cli/list.rb}

@@ -1,8 +1,8 @@
 require 'cli-format'
 
-module Cody
+class Cody::CLI
   class List
-    include AwsServices
+    include Cody::AwsServices
     extend Memoist
 
     def initialize(options)
@@ -34,7 +34,7 @@ module Cody
     end
 
     def projects
-      projects = list_projects.map { |p| Project.new(p) }
+      projects = list_projects.map { |p| Cody::List::Project.new(p) }
       if @options[:sort_by]
         projects.sort_by { |p| p.send(@options[:sort_by]) }
       else
@@ -55,6 +55,10 @@ module Cody
         next_token = resp.next_token
         projects += resp.projects
       end
+      if @options[:select]
+        regexp = Regexp.new(@options[:select])
+        projects.select! { |p| p =~ regexp }
+      end
       projects
     end
     memoize :list_projects

data/lib/cody/cli/logs.rb

@@ -0,0 +1,10 @@
+class Cody::CLI
+  class Logs < Base
+    def run
+      check_build_id!
+      run_with_exception_handling do
+        Cody::Tailer.new(@options, build_id).run
+      end
+    end
+  end
+end

data/lib/cody/{sequence.rb → cli/sequence.rb}

@@ -1,16 +1,16 @@
 require 'fileutils'
 require 'thor'
 
-module Cody
+class Cody::CLI
   class Sequence < Thor::Group
-    include AwsServices
+    include Cody::AwsServices
     include Thor::Actions
 
     add_runtime_options! # force, pretend, quiet, skip options
       # https://github.com/erikhuda/thor/blob/master/lib/thor/actions.rb#L49
 
     def self.source_paths
-      [File.expand_path("../../template", __FILE__)]
+      [File.expand_path("../../../template", __FILE__)]
     end
 
   private

data/lib/cody/{start.rb → cli/start.rb}

@@ -1,6 +1,6 @@
-module Cody
+class Cody::CLI
   class Start
-    include AwsServices
+    include Cody::AwsServices
 
     def initialize(options)
       @options = options
@@ -24,7 +24,7 @@ module Cody
     end
 
     def tail_logs(build_id)
-      Tailer.new(@options, build_id).run
+      Cody::Tailer.new(@options, build_id).run
     end
 
     def environment_variables_override

data/lib/cody/{status.rb → cli/status.rb}

@@ -1,6 +1,7 @@
-module Cody
+class Cody::CLI
   class Status < Base
     def run
+      check_build_id!
       run_with_exception_handling do
         puts "Build id: #{build_id}"
         resp = codebuild.batch_get_builds(ids: [build_id])

data/lib/cody/{stop.rb → cli/stop.rb}

@@ -1,6 +1,7 @@
-module Cody
+class Cody::CLI
   class Stop < Base
     def run
+      check_build_id!
       run_with_exception_handling do
         codebuild.stop_build(id: build_id)
         puts "Build has been stopped: #{build_id}"

data/lib/cody/command.rb

@@ -13,6 +13,17 @@ class Thor
   end
 end
 
+# Gets rid of the c_l_i extra commands in the help menu. Seems like thor_classes_in is only used
+# for this purpose. More details: https://gist.github.com/tongueroo/ee92ec28a4d3eed301d88e8ccdd2fe10
+module ThorPrepend
+  module Util
+    def thor_classes_in(klass)
+      klass.name.include?("CLI") ? [] : super
+    end
+  end
+end
+Thor::Util.singleton_class.prepend(ThorPrepend::Util)
+
 module Cody
   class Command < Thor
     class << self

data/lib/cody/core.rb

@@ -19,12 +19,12 @@ module Cody
     end
     memoize :env
 
-    def env_extra
-      env_extra = ENV['CODY_ENV_EXTRA'] if ENV['CODY_ENV_EXTRA'] # highest precedence
-      return if env_extra&.empty?
-      env_extra
+    def extra
+      extra = ENV['CODY_EXTRA'] if ENV['CODY_EXTRA'] # highest precedence
+      return if extra&.empty?
+      extra
     end
-    memoize :env_extra
+    memoize :extra
 
     # Overrides AWS_PROFILE based on the Cody.env if set in configs/settings.yml
     # 2-way binding.

data/lib/cody/dsl/base.rb

@@ -7,5 +7,14 @@ module Cody::Dsl
       @full_project_name = options[:full_project_name] # includes -development at the end
       @properties = default_properties # defaults make project.rb simpler
     end
+
+    # In v1.0.0 defaults to not auto-camelize
+    def auto_camelize(data)
+      if Cody.settings[:auto_camelize]
+        CfnCamelizer.transform(data)
+      else
+        data.deep_stringify_keys!
+      end
+    end
   end
 end

data/lib/cody/dsl/project.rb

@@ -3,35 +3,40 @@ module Cody::Dsl
     include Ssm
 
     PROPERTIES = %w[
-      artifacts
-      badge_enabled
-      cache
-      description
-      encryption_key
-      environment
-      logs_config
-      name
-      queued_timeout_in_minutes
-      secondary_artifacts
-      secondary_sources
-      service_role
-      source
-      tags
-      timeout_in_minutes
-      triggers
-      vpc_config
+      Artifacts
+      BadgeEnabled
+      Cache
+      Description
+      EncryptionKey
+      Environment
+      LogsConfig
+      Name
+      QueuedTimeoutInMinutes
+      SecondaryArtifacts
+      SecondarySources
+      ServiceRole
+      Source
+      Tags
+      TimeoutInMinutes
+      Triggers
+      VpcConfig
     ]
     PROPERTIES.each do |prop|
-      define_method(prop) do |v|
+      define_method(prop.underscore) do |v|
         @properties[prop.to_sym] = v
       end
     end
 
     # Convenience wrapper methods
     def github_url(url)
-      @properties[:source][:location] = url
+      @properties[:Source][:Location] = url
     end
 
+    def buildspec(file=".cody/buildspec.yaml")
+      @properties[:Source][:BuildSpec] = file
+    end
+    alias_method :build_spec, :buildspec
+
     # So it looks like the auth resource property doesnt really get used.
     # Instead an account level credential is worked.  Refer to:
     # https://github.com/tongueroo/cody/blob/master/readme/github_oauth.md
@@ -39,47 +44,47 @@ module Cody::Dsl
     # Keeping this method around in case the CloudFormation method works one day,
     # or end up figuring out to use it properly.
     def github_token(token)
-      @properties[:source][:auth][:resource] = token
+      @properties[:Source][:Auth][:Resource] = token
     end
 
     def github_source(options={})
       source = {
-        type: "GITHUB",
-        location: options[:location],
-        git_clone_depth: 1,
-        git_submodules_config: { fetch_submodules: true },
-        build_spec: options[:buildspec] || ".cody/buildspec.yml", # options[:buildspec] accounts for type already
-        report_build_status: true,
+        Type: "GITHUB",
+        Location: options[:Location],
+        GitCloneDepth: 1,
+        GitSubmodulesConfig: { fetch_submodules: true },
+        BuildSpec: options[:BuildSpec] || ".cody/buildspec.yml", # options[:Buildspec] accounts for type already
+        ReportBuildStatus: true,
       }
 
-      if options[:oauth_token]
-        source[:auth] = {
-          type: "OAUTH",
-          resource: options[:oauth_token],
+      if options[:OauthToken]
+        source[:Auth] = {
+          Type: "OAUTH",
+          Resource: options[:OauthToken],
         }
       end
 
-      @properties[:source] = source
+      @properties[:Source] = source
     end
 
     def linux_image(name)
-      linux_environment(image: name)
+      linux_environment(Image: name)
     end
 
     def linux_environment(options={})
-      image = options[:image] || "aws/codebuild/amazonlinux2-x86_64-standard:2.0"
+      image = options[:Image] || "aws/codebuild/amazonlinux2-x86_64-standard:2.0"
       env = {
-        compute_type: options[:compute_type] || "BUILD_GENERAL1_SMALL",
-        image_pull_credentials_type: "CODEBUILD", # https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-imagepullcredentialstype
-        privileged_mode: true,
-        image: image,
-        type: "LINUX_CONTAINER"
+        ComputeType: options[:ComputeType] || "BUILD_GENERAL1_SMALL",
+        ImagePullCredentialsType: "CODEBUILD", # https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-imagepullcredentialstype
+        PrivilegedMode: true,
+        Image: image,
+        Type: "LINUX_CONTAINER"
       }
       # @mapped_env_vars is in memory
-      env[:environment_variables] = @mapped_env_vars if @mapped_env_vars
+      env[:EnvironmentVariables] = @mapped_env_vars if @mapped_env_vars
       # options has highest precedence
-      env[:environment_variables] = options[:environment_variables] if options[:environment_variables]
-      @properties[:environment] = env
+      env[:EnvironmentVariables] = options[:EnvironmentVariables] if options[:EnvironmentVariables]
+      @properties[:Environment] = env
     end
 
     def environment_variables(vars)
@@ -87,20 +92,20 @@ module Cody::Dsl
       @mapped_env_vars = vars.map { |k,v|
         k, v = k.to_s, v.to_s
         if v =~ /^ssm:/
-          { type: "PARAMETER_STORE", name: k, value: v.sub('ssm:','') }
+          { Type: "PARAMETER_STORE", Name: k, Value: v.sub('ssm:','') }
         else
-          { type: "PLAINTEXT", name: k, value: v }
+          { Type: "PLAINTEXT", Name: k, Value: v }
         end
       }
-      @properties[:environment] ||= {}
-      @properties[:environment][:environment_variables] = @mapped_env_vars
+      @properties[:Environment] ||= {}
+      @properties[:Environment][:EnvironmentVariables] = @mapped_env_vars
     end
 
     def local_cache(enable=true)
       cache = if enable
         {
-          type: "LOCAL",
-          modes: [
+          Type: "LOCAL",
+          Modes: [
               "LOCAL_DOCKER_LAYER_CACHE",
               "LOCAL_SOURCE_CACHE",
               "LOCAL_CUSTOM_CACHE"
@@ -109,11 +114,11 @@ module Cody::Dsl
       else
         {type: "NO_CACHE"}
       end
-      @properties[:cache] = cache
+      @properties[:Cache] = cache
     end
 
     def type
-      @options[:type]
+      @options[:type] # should be lowercase
     end
   end
 end