cody 0.1.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88037feb65e59c09d4a534e959f96a16356a410913f2cb0bcd973e6f684dc063
-  data.tar.gz: 11b86d4d363b2ed593fbbd0de3ae81152507f049794b43a4b5e9fcfd2b2ca842
+  metadata.gz: 4026befb0df7ead4c4947e968b3cc889e367b447a87980b23016fcae680ed2d6
+  data.tar.gz: 6090a0d98004b6ca2c47d4b18f34c2e0de974e7e9a6055b448ab4ac19f9ed5af
 SHA512:
-  metadata.gz: b03704888f81c48d3c6961b8c8da8f961a41d13ec91fffcdd5f2622deb3d2fb332d5eade202e0328a6ec1cae45590d7c32726573b2245e2107e33ab894023d0e
-  data.tar.gz: d9784d3b3a9030456a135c814583430f62684b5edeb67d1cc3b4f869f81bfd8b9c98693e6aa9eb075f34be21d9b1bcc8119a9bf8dbe3c40eabff02c20d5db02f
+  metadata.gz: ee0b4aa46328c7e82a58cdb2ed85cf95fbd22e9092a4770b96975c9cef971977258370e864fc22d188d841532be11d2be20f43aea262df7f90bee48bd7264857
+  data.tar.gz: 1a275dacb13bab8c8f0e490058501275dd6fea0eda358fa3648201e982d6e5dc48a9168dd56ed7d4473ba809cde94479f17a1a216bfd323ad0153fe5b7b47370

data/.cody/buildspec.yml

@@ -0,0 +1,8 @@
+version: 0.2
+
+phases:
+  build:
+    commands:
+      - echo Build started on `date`
+      - bundle
+      - bundle exec rspec

data/.cody/project.rb

@@ -0,0 +1,4 @@
+github_url("https://github.com/tongueroo/cody")
+linux_image("aws/codebuild/ruby:2.5.3-1.7.0")
+triggers(webhook: true)
+local_cache(false)

data/.cody/settings.yml

@@ -0,0 +1,13 @@
+base:
+  # stack_naming:
+  #   append_env: true # default false
+
+development:
+  # cluster: development
+  # The aws_profile tightly binds CB_ENV to AWS_PROFILE and vice-versa.
+  # aws_profile: dev_profile
+
+production:
+  # cluster: production
+  # The aws_profile tightly binds CB_ENV to AWS_PROFILE and vice-versa.
+  # aws_profile: prod_profile

data/.gitignore

@@ -1,11 +1,18 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+_yardoc
+coverage
+doc/
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
 
-# rspec failure tracking
-.rspec_status
+Gemfile.lock

data/.gitmodules

@@ -0,0 +1,9 @@
+[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/.rspec

@@ -1,3 +1,3 @@
---format documentation
 --color
+--format documentation
 --require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.6

data/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Change Log
+
+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.
+
+## [0.7.0]
+- Rename to Cody
+- Breaking changes: .cody folder, CODY_ENV, -cody stack name suffix
+
+## [0.6.6]
+- add mode option: bare and full
+
+## [0.6.5]
+- allow no settings.yml file
+
+## [0.6.4]
+- fix vendor gem dependencies in gem package
+
+## [0.6.3]
+- add aws_data gem dependency
+
+## [0.6.2]
+- add s3 read-only access to default role
+- fix settings
+
+## [0.6.1]
+- cody init: no variables by default
+- fix handle rollback
+
+## [0.6.0]
+- named stack with -cody at the very end
+- add docs
+- cody init --no-variables option
+
+## [0.5.0]
+- add --wait option
+- change default append_env setting to false
+- fix default iam policy
+
+## [0.4.0]
+- Add managed_iam_policy support
+- #2 Add schedule dsl
+- starter template fix: add settings.yml for correct cb project detection
+
+## [0.3.0]
+- rework cb cli interface
+- project_name as cli main parameter
+- type option for subprojects in .cody folder
+- update to zeitwerk for autoloading
+
+## [0.2.0]
+- First good release.
+- Project and Role DSL
+- codebuild commands: init, deploy, start
+- lookup path support
+- Docs in main readme and readme folder
+
+## [0.1.0]
+- Initial release.

data/Gemfile

@@ -1,4 +1,6 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in cody.gemspec
+# Specify your gem dependencies in codebuild.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Guardfile

@@ -0,0 +1,19 @@
+guard "bundler", cmd: "bundle" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -1,21 +1,22 @@
-The MIT License (MIT)
-
 Copyright (c) 2019 Tung Nguyen
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,39 +1,166 @@
 # Cody
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cody`. To experiment with that code, run `bin/console` for an interactive prompt.
+![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiWWFRbjVNQlIvZGtSS2NMTGlRY3pWYm1lTGFFSG5acDc4b09hL2lHWGVxeHZaMGYxVTc0cGEwOHBHWHF6MjZiNlZNU0JqS0lvTnZkdWI5enRDczRZYStnPSIsIml2UGFyYW1ldGVyU3BlYyI6ImsyUDJNc2E3SlpYOGFYYy8iLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
+[![Gem Version](https://badge.fury.io/rb/cody.png)](http://badge.fury.io/rb/cody)
 
-TODO: Delete this and the text above, and describe your gem
+Cody lets you create a AWS CodeBuild projects with a beautiful DSL.
 
-## Installation
+The documentation site is at: [cody.run](https://cody.run/)
 
-Add this line to your application's Gemfile:
+## Quick Start
+
+    cody init
+    cody deploy
+    cody start
+
+## Private Repo
+
+IMPORTANT: Before deploying, if you are using a private repo, use [aws codebuild import-source-credentials](https://docs.aws.amazon.com/cli/latest/reference/codebuild/import-source-credentials.html) to add credentials so that codebuild can clone down the repo.  Refer to the [CodeBuilld Github Oauth/](https://cody.run/docs/github_oauth/) for more info.
+
+## Usage
+
+1. **init**: generate starter .cody files.
+2. **deploy**: deploy the CodeBuild project on AWS.
+3. **start**: kick off a CodeBuild project run.
+
+### Init and Structure
+
+First, run `cody init` to generate a starter `.cody` folder structure.
+
+    $ tree .cody
+    .cody
+    ├── buildspec.yml
+    ├── project.rb
+    └── role.rb
+
+File | Description
+--- | ---
+buildspec.yml | The build commands to run.  Here are the [buildspec.yml syntax docs](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html).
+project.rb | The codebuild project written as a DSL. Here are the [Project DSL docs](https://cody.run/docs/dsl/project/)
+role.rb | The IAM role associated with the codebuild project written as a DSL. Here are the [IAM Role DSL docs](https://cody.run/docs/dsl/role/)
+
+### Deploy
+
+Adjust the files in `.cody` to fit your needs. When you're ready, deploy the CodeBuild project with:
+
+    cody deploy PROJECT_NAME
+
+More examples:
+
+    cody deploy # infers the CodeBuild project name from the parent folder
+    cody deploy PROJECT_NAME # explicitly specify project name
+
+It is useful to just see the generated CloudFormation template with `--noop` mode:
+
+    cody deploy --noop # see generated CloudFormation template
+
+For more help:
+
+    cody deploy -h
+
+### Start
+
+When you are ready to start a codebuild project run, you can use `codebuild start`. Examples:
+
+    cody start # infers the name from the parent folder
+    cody start PROJECT_NAME # looks up project via CodeBuild project name
+
+The `cody start` command understands multiple identifiers. It will look up the codebuild project either via CloudFormation or the CodeBuild project name.
+
+## Project DSL
+
+The tool provides a DSL to create a codebuild project.  Here's an example.
+
+.cody/project.rb:
 
 ```ruby
-gem 'cody'
+# name("demo") # recommended to leave unset and use the conventional name that cody sets
+github_url("https://github.com/tongueroo/demo-ufo")
+linux_image("aws/codebuild/ruby:2.5.3-1.7.0")
+environment_variables(
+  UFO_ENV: "development",
+  API_KEY: "ssm:/codebuild/demo/api_key" # ssm param example
+)
 ```
 
-And then execute:
+Here's a list of some of the convenience shorthand DSL methods:
 
-    $ bundle
+* github_url(url)
+* github_source(options={})
+* linux_image(name)
+* linux_environment(options={})
+* environment_variables(vars)
+* local_cache(enable=true)
 
-Or install it yourself as:
+Please refer to [lib/codebuild/dsl/project.rb](lib/codebuild/dsl/project.rb) for the full list.
 
-    $ gem install cody
+More slightly more control, you may be interested in the `github_source` and `linux_environment` methods.  For even more control, see [DSL docs](https://cody.run/docs/dsl/).
 
-## Usage
+## IAM Role DSL
 
-TODO: Write usage instructions here
+Cody can create the IAM service role associated with the codebuild project. Here's an example:
 
-## Development
+.cody/role.rb:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+iam_policy("logs", "ssm")
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+For more control, here's a longer form:
 
-## Contributing
+```ruby
+iam_policy(
+  action: [
+    "logs:CreateLogGroup",
+    "logs:CreateLogStream",
+    "logs:PutLogEvents",
+    "ssm:*",
+  ],
+  effect: "Allow",
+  resource: "*"
+)
+```
+
+You can also create managed iam policy.
+
+```ruby
+managed_iam_policy("AmazonS3ReadOnlyAccess")
+```
+
+## Schedule Support
+
+.cody/schedule.rb:
+
+```ruby
+rate "1 day"
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cody.
+## Full DSL
 
-## License
+The convenience DSL methods shown above are short and clean.  They merely wrap a DSL that map to the properties of CloudFormation resources like [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) and [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). Refer the [DSL docs](https://cody.run/docs/dsl/) for more info.
+
+## Type Option
+
+By default, cody looks up files in the `.cody` folder.  You can affect the behavior of the Type logic with the `--Type` option.  More info [Type docs](https://cody.run/docs/type-option/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "cody"
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install cody
+
+## Contributing
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,6 +1,13 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+task default: :spec
 
-task :default => :spec
+RSpec::Core::RakeTask.new
+
+require_relative "lib/cody"
+require "cli_markdown"
+desc "Generates cli reference docs as markdown"
+task :docs do
+  CliMarkdown::Creator.create_all(cli_class: Cody::CLI, cli_name: "cody")
+end

data/cody.gemspec

@@ -1,4 +1,5 @@
-lib = File.expand_path("lib", __dir__)
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "cody/version"
 
@@ -7,23 +8,36 @@ Gem::Specification.new do |spec|
   spec.version       = Cody::VERSION
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
-
-  spec.summary       = %q{Cody}
+  spec.summary       = "Cody provides a beautiful DSL to create and manage AWS CodeBuild projects"
   spec.homepage      = "https://github.com/tongueroo/cody"
   spec.license       = "MIT"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  vendor_files       = Dir.glob("vendor/**/*")
+  gem_files          = `git -C "#{File.dirname(__FILE__)}" ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|docs)/})
   end
+  spec.files         = gem_files + vendor_files
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "aws-sdk-cloudformation"
+  spec.add_dependency "aws-sdk-codebuild"
+  spec.add_dependency "aws-sdk-ssm"
+  spec.add_dependency "memoist"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "render_me_pretty"
+  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"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end