jack-eb 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ece219aa57cc04f347291e94974577e996ca6a0
-  data.tar.gz: d17816bfe9436d2b0f60f34657350b24e36e6ca0
+  metadata.gz: 0b32fb136e9666d9c320b57a6e82dbd6265a88ca
+  data.tar.gz: c44513aa9ec470ae7345e6642a49f558c45554dc
 SHA512:
-  metadata.gz: de1afe023f535683a3fd2a5263e220c8c2634663748f7ee536f82d3b3be86c7c042c10facfe280623e50961c098ea9792fa39fab904672526550bf60ba224948
-  data.tar.gz: 7f549a7d2e9d0b8b639edce5bf228aabe710ea7a46ce4d258ffb543147b4650f2ac1d8d3e836a8cec9f1c3f1e647f25b3fb1314ad9497ea87a067e908a51b372
+  metadata.gz: 944f181ed9841d73ea420881a1ee995a9a0ac00a3db561591919abae4fedc163dbce4e48938071a8ab4ba2015258d141255dba12c11244a3ea6820b51d5658d7
+  data.tar.gz: adbf44aee62358dc8e9251fdc5d6da43744254c0a3c9ac6aacd8fc62820edf58b3a5d1eda27265434a57d72b45a7a5da9ab5d5b30093e65cb7da967f1ca51424

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.2.0]
+- add jack deploy command
+- rename commands to config get and config apply
+
 ## [1.1.2]
 - remove debugging from version checker
 

data/README.md

@@ -7,7 +7,7 @@
 
 Jack is a wrapper tool around the [aws eb cli3](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3.html) tool use for managing AWS Elastic Beanstalk, EB, environments.  It allows you to create environments using the  saved template configuration file generated by `eb config save`.  Jack moves the config file to the jack/cfg folder of your project and manages the the config files from there.
 
-Jack provides a `jack config upload` command to update the EB environment.   Before uploading the new configuration to EB jack first downloads the current configuration and then does a diff on the changes that are about to be applied.  This gives a very helpful preview of exactly what you are intending to change.  This particularly helpful when changes are made through the EB GUI and are out of sync with what is stored in the `jack/cfg` files.  The demo video is available [here](https://www.youtube.com/watch?v=t7EcAOf8h1o).
+Jack provides a `jack config apply` command to update the EB environment.   Before uploading the new configuration to EB jack first downloads the current configuration and then does a diff on the changes that are about to be applied.  This gives a very helpful preview of exactly what you are intending to change.  This particularly helpful when changes are made through the EB GUI and are out of sync with what is stored in the `jack/cfg` files.  The demo video is available [here](https://www.youtube.com/watch?v=t7EcAOf8h1o).
 
 This blog post also provides a good introduction and shows some useful examples of what you can do with the jack tool: [Jack and the Elastic Beanstalk — Tool to Manage AWS Elastic Beanstalk Environments](https://medium.com/@tongueroo/jack-and-the-elastic-beanstalk-easily-manage-aws-environments-3ab496f08ad2#.o7w3x0yd9).
 
@@ -16,7 +16,7 @@ For things that this tool does not cover like deploying code, it is recommended
 ## Use Cases
 
 * Downloading EB config to codified the EB infrastructure that has been built.
-* Allowing safe uploading of new configs since the preview feature allows you to inspect the changes before actually uploading the configuration.
+* Allowing safe applying of new configs since the preview feature allows you to inspect the changes before actually applying the configuration.
 * Moving EB enviroments from one EB application to another EB application.  EB provides a way to clone environments within an application but not to another entire application.  This is useful if you want to "rename" the EB application.
 
 ## Installation
@@ -109,7 +109,7 @@ $ jack create hi-web-stag-1
 The big benefit of using jack though is the ability to create EB environments based on previously saved configuration files.  So now you can download the configuration file from the newly created hi-web-stag-1 environment and version control them.
 
 ```bash
-$ jack config download hi-web-stag-1
+$ jack config get hi-web-stag-1
 ```
 
 This above saves the configuration file at `jack/cfg/hi-web-stag-1.cfg.yml`.  Here is an [example](https://gist.github.com/tongueroo/5791a4575a71cb664d48e4e8b29791b3) of what the config file.
@@ -117,7 +117,7 @@ This above saves the configuration file at `jack/cfg/hi-web-stag-1.cfg.yml`.  He
 If you would like to save the config file under a different path, you can use the `-c` option.
 
 ```bash
-$ jack config download hi-web-stag-1 -c my-config
+$ jack config get hi-web-stag-1 -c my-config
 ```
 
 This saves the config file to `jack/cfg/my-config.cfg.yml` looks like.
@@ -137,31 +137,31 @@ Here's an [example](https://gist.github.com/tongueroo/086e3c11c4d00d5c39b6). The
 
 Configuration templates hold all the options and settings that we can set for an EB environment.  Elastic Beanstalk surfaces a portion of settings available from the underlying AWS Resources.  These settings include ELB behavior, VPC, LaunchConfiguration, Autoscaling settings, hard drive size, environment variables, etc.  Here is an [example](https://gist.github.com/tongueroo/5791a4575a71cb664d48e4e8b29791b3).
 
-#### Download Config
+#### Get Elastic Beanstalk Configuration
 
-To download a template configuration.
+To download the Elastic Beanstalk configuration:
 
 ```
-$ jack config download hi-web-prod-1
+$ jack config get hi-web-prod-1
 
-$ jack config download hi-web-prod-1 --app customappname
+$ jack config get hi-web-prod-1 --app customappname
 ```
 
-This will save the config to jack/cfg/hi-web-prod-1.cfg.yml.
+This will save the config to `jack/cfg/hi-web-prod-1.cfg.yml`.
 
-#### Upload Config
+#### Apply Elastic Beanstalk Configuration
 
-To upload a template configuration.
+To apply a template configuration.
 
 ```
-$ jack config upload hi-web-prod-1
+$ jack config apply hi-web-prod-1
 
-$ jack config upload hi-web-prod-1 --app customappname
+$ jack config apply hi-web-prod-1 --app customappname
 ```
 
 This will save the config to `jack/cfg/hi-web-prod-1.cfg.yml`.
 
-You will notice that the `eb config upload` command prompts you with the diff and asks for confirmation before uploading.  You can bypass the prompt with the `--sure` option.
+You will notice that the `eb config apply` command prompts you with the diff and asks for confirmation before applying.  You can bypass the prompt with the `--sure` option.
 
 #### Diff Config - Comparing your local config to the live environment config
 
@@ -171,7 +171,7 @@ You can use the diff command directly to compare your local config to what confi
 $ jack config diff hi-web-prod-1
 ```
 
-A note about the configs.  They are formatted so that the keys are sorted.  This has been done so the diffs are actually useful.  It is also recommended you install colordiff so you can see the diff output colorized.  You can also specify your own diff viewer via the JACK_DIFF environment variable.
+A note about the configs.  They are formatted so that the keys are sorted.  This has been done so the diffs are actually useful.  It is also recommended you install colordiff so you can see the diff output colorized.  You can also specify your own diff viewer via the `JACK_DIFF` environment variable.
 
 To use a your own diff viewer, add this to your `~/.profile`:
 
@@ -185,8 +185,8 @@ You can get help information from the CLI.  Examples:
 
 <pre>
 $ jack help
-$ jack help create
-$ jack config help download
-$ jack config help upload
-$ jack config help sort
+$ jack create help
+$ jack config get help
+$ jack config apply help
+$ jack config sort help
 </pre>

data/lib/jack.rb

@@ -9,6 +9,7 @@ module Jack
   autoload :Help, 'jack/help'
   autoload :CLI, 'jack/cli'
   autoload :Create, 'jack/create'
+  autoload :Deploy, 'jack/deploy'
   autoload :Terminate, 'jack/terminate'
   autoload :Settings, 'jack/settings'
   autoload :EbConfig, 'jack/eb_config'

data/lib/jack/cli.rb

@@ -5,23 +5,23 @@ Jack::VersionChecker.new.run unless ENV['TEST']
 
 module Jack
   class Config < Command
-    desc "upload ENV_NAME", "upload and apply jack config changes to EB environment"
-    long_desc Help.upload
+    desc "apply ENV_NAME", "apply jack config changes to EB environment"
+    long_desc Help.apply
     option :sure, aliases: :f, type: :boolean, desc: "skip prompt"
-    def upload(env_name)
-      Upload.new(options.merge(env_name: env_name)).run
+    def apply(env_name)
+      Apply.new(options.merge(env_name: env_name)).run
     end
 
-    desc "download ENV_NAME", "downloads environment config to jack/cfg folder"
-    long_desc Help.download
-    option :dirty, type: :boolean, desc: "leave the remote eb config and download config behind"
-    def download(env_name)
-      Download.new(options.merge(env_name: env_name)).run
+    desc "get ENV_NAME", "downloads environment config to jack/cfg folder"
+    long_desc Help.get
+    option :dirty, type: :boolean, desc: "leave the remote eb config and downloaded config behind"
+    def get(env_name)
+      Get.new(options.merge(env_name: env_name)).run
     end
 
     desc "diff ENV_NAME", "diff jack config vs environment config"
     long_desc Help.diff
-    option :dirty, type: :boolean, desc: "leave the remote eb config and download config behind"
+    option :dirty, type: :boolean, desc: "leave the remote eb config and downloaded config behind"
     def diff(env_name)
       Diff.new(options.merge(env_name: env_name)).run
     end
@@ -48,6 +48,13 @@ module Jack
       Create.new(options.merge(env_name: env_name)).run
     end
 
+    desc "deploy ENV_NAME", "deploy to EB environment"
+    long_desc Help.deploy
+    option :eb_options, type: :string, desc: "Passthrough options to underlying called eb command"
+    def deploy(env_name)
+      Deploy.new(options.merge(env_name: env_name)).run
+    end
+
     desc "terminate ENV_NAME", "deletes EB environment"
     long_desc Help.terminate
     def terminate(env_name)

data/lib/jack/config.rb

@@ -6,10 +6,10 @@ module Jack
     autoload :Help, 'jack/config/help'
     autoload :Base, 'jack/config/base'
     autoload :Diff, 'jack/config/diff'
-    autoload :Download, 'jack/config/download'
+    autoload :Get, 'jack/config/get'
     autoload :Sort, 'jack/config/sort'
     autoload :Transmit, 'jack/config/transmit'
-    autoload :Upload, 'jack/config/upload'
+    autoload :Apply, 'jack/config/apply'
     autoload :YamlFormatter, 'jack/config/yaml_formatter'
   end
 end

data/lib/jack/config/{upload.rb → apply.rb}

@@ -2,7 +2,7 @@ require 'fileutils'
 
 module Jack
   class Config < Command
-    class Upload < Transmit
+    class Apply < Transmit
       include Util
 
       attr_reader :upload_path, :upload_name
@@ -37,8 +37,8 @@ module Jack
 If the difference is not what you expected, you should say no.
 If you want to download the config from the environment and get #{@local_config_path}
 back in sync, you can use this command:
-  $ jack config download #{@env_name}
-  $ jack config download -h # for more info
+  $ jack config get #{@env_name}
+  $ jack config get -h # for more info
 EOL
         message
       end

data/lib/jack/config/diff.rb

@@ -6,7 +6,7 @@ module Jack
         @options = options
         @root = options[:root] || '.'
         @env_name = options[:env_name]
-        @download = Jack::Config::Download.new(options)
+        @download = Jack::Config::Get.new(options)
       end
 
       def run

data/lib/jack/config/{download.rb → get.rb}

@@ -3,7 +3,7 @@ require 'yaml'
 
 module Jack
   class Config < Command
-    class Download < Transmit
+    class Get < Transmit
       include Util
 
       attr_reader :current_path, :current_name

data/lib/jack/config/help.rb

@@ -1,20 +1,20 @@
 class Jack::Config::Help
   class << self
-    def upload
+    def apply
 <<-EOL
-Uploads the specified template configuration in jack/cfg and applies it to the environment immediately.
+Apply the specified template configuration in jack/cfg to the Elastic Beanstalk environment.
 
 #{convention}
 
 Example:
 
-$ jack config upload hi-web-stag-1
+$ jack config apply hi-web-stag-1
 
-$ jack config upload myapp -c myconfig hi-web-stag-1
+$ jack config apply myapp -c myconfig hi-web-stag-1
 EOL
     end
 
-    def download
+    def get
 <<-EOL
 Downloads the environment's config to jack/cfg/[CONFIG_NAME].cfg.yml
 
@@ -22,9 +22,9 @@ Downloads the environment's config to jack/cfg/[CONFIG_NAME].cfg.yml
 
 Example:
 
-$ jack config download hi-web-stag-1
+$ jack config get hi-web-stag-1
 
-$ jack config download myapp -c myconfig hi-web-stag-1
+$ jack config get myapp -c myconfig hi-web-stag-1
 EOL
     end
 

data/lib/jack/create.rb

@@ -42,7 +42,7 @@ module Jack
     end
 
     def upload_cfg
-      @upload = Config::Upload.new(@options)
+      @upload = Config::Apply.new(@options)
       if @upload.local_cfg_exist?
         @upload.upload
         cfg = "--cfg #{@upload.upload_name} "

data/lib/jack/deploy.rb

@@ -0,0 +1,59 @@
+module Jack
+  class Deploy
+    include Util
+
+    def initialize(options={})
+      @options = options
+      @root = options[:root] || '.'
+      @env_name = options[:env_name]
+      @app_name = options[:app] || app_name_convention(@env_name)
+    end
+
+    def run
+      unless @options[:noop] || environment_exists?
+        UI.say("ERROR: Environment #{@env_name} does not appear to exist. Are you sure it exists?")
+        exit 1 unless ENV['TEST']
+      end
+
+      deploy
+    end
+
+    def environment_exists?
+      return true if @options[:noop]
+      r = eb.describe_environments(application_name: @app_name)
+      r.environments.collect(&:environment_name).include?(@env_name)
+    end
+
+    def deploy
+      # eb_options are passed through to the underlying eb deploy command
+      #
+      # optional arguments:
+      #   -h, --help            show this help message and exit
+      #   --debug               toggle debug output
+      #   --quiet               suppress all output
+      #   -v, --verbose         toggle verbose output
+      #   --profile PROFILE     use a specific profile from your credential file
+      #   -r REGION, --region REGION
+      #                         use a specific region
+      #   --no-verify-ssl       do not verify AWS SSL certificates
+      #   --modules [MODULES [MODULES ...]]
+      #                         modules to deploy
+      #   -g ENV_GROUP_SUFFIX, --env-group-suffix ENV_GROUP_SUFFIX
+      #                         group suffix
+      #   --version VERSION     existing version label to deploy
+      #   -l LABEL, --label LABEL
+      #                         label name which version will be given
+      #   -m MESSAGE, --message MESSAGE
+      #                         description for version
+      #   -nh, --nohang         return immediately, do not wait for deploy to be
+      #                         completed
+      #   --staged              deploy files staged in git rather than the HEAD commit
+      #   --timeout TIMEOUT     timeout period in minutes
+      #   --source SOURCE       source of code to deploy directly; example
+      #                         source_location/repo/branch
+      #   -p, --process         enable preprocessing of the application version
+      command = "#{eb_bin} deploy#{eb_base_flags} #{@env_name} #{@options[:eb_options]}"
+      sh(command)
+    end
+  end
+end

data/lib/jack/help.rb

@@ -17,6 +17,16 @@ $ jack create -a myapp -c myconfig hi-web-stag-1
 EOL
       end
 
+      def deploy
+<<-EOL
+Deploy code to the Elastic Beanstalk environment.
+
+Example:
+
+$ jack deploy hi-web-stag-1
+EOL
+      end
+
       def terminate
 <<-EOL
 Deletes Elastic Beanstalk environment.
@@ -31,11 +41,11 @@ EOL
       # Leaving here in case we figure out a way to override this Thor behavior.
       def config
 <<-EOL
-Manage the environment's config.  Can use this to download the environment's config to jack/cfg folder or upload config in jack/cfg folder and apply it to the environment.
+Manage the environment's config.  Can use this to download the environment's config to jack/cfg folder or upload and apply config in jack/cfg folder to the environment.
 
 Example:
 
-$ jack config download hi-web-stag-1
+$ jack config get hi-web-stag-1
 
 For more info:
 

data/lib/jack/util.rb

@@ -15,7 +15,7 @@ module Jack::Util
 
   def sh(command, options={})
     Jack::UI.say "=> #{command.colorize(:green)}"
-    return command if options[:noop]
+    return command if @options[:noop]
 
     if options[:backtick]
       out = `#{command}`

data/lib/jack/version.rb

@@ -1,3 +1,3 @@
 module Jack
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/spec/lib/cli_spec.rb

@@ -17,13 +17,13 @@ describe Jack::CLI do
     end
 
     it "should upload and apply config to environment" do
-      out = execute("bin/jack config upload #{@args}")
+      out = execute("bin/jack config apply #{@args}")
       # puts out
       expect(out).to include('eb config save')
     end
 
     it "should download config from environment" do
-      out = execute("bin/jack config download #{@args}")
+      out = execute("bin/jack config get #{@args}")
       # puts out
       expect(out).to include("Config downloaded")
     end
@@ -40,7 +40,13 @@ describe Jack::CLI do
       expect(out).to include("Reformatted the local config")
     end
 
-    it "should terminate enviornment" do
+    it "should deploy environment" do
+      out = execute("bin/jack deploy #{@args}")
+      # puts out
+      expect(out).to include("eb deploy")
+    end
+
+    it "should terminate environment" do
       out = execute("bin/jack terminate #{@args}")
       # puts out
       expect(out).to include("Whew that was close")

data/spec/lib/config/apply_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Jack::Config::Apply do
+  before(:all) do
+    Jack::UI.mute = true
+  end
+
+  let(:apply) { Jack::Config::Apply.new(test_options.merge(mute: true)) }
+
+  describe "jack config" do
+    it "apply code paths" do
+      exist = apply.local_cfg_exist?
+      expect(exist).to be true # checking fixture
+      # mock methods way down deep to test code paths, test reads weird though
+      expect(apply).to receive(:eb_config_put)
+      apply.upload
+    end
+
+    it "upload flow" do
+      allow(apply).to receive(:compare).and_return(true)
+
+      expect(apply).to receive(:compare)
+      expect(apply).to receive(:upload)
+      expect(apply).to receive(:update_env)
+      apply.run
+    end
+  end
+end

data/spec/lib/config/{download_spec.rb → get_spec.rb}

@@ -5,14 +5,14 @@ describe Jack::Config do
     Jack::UI.mute = true
   end
 
-  let(:download) { Jack::Config::Download.new(test_options) }
+  let(:get) { Jack::Config::Get.new(test_options) }
 
-  describe "download" do
-    it "download" do
+  describe "jack config" do
+    it "get" do
       # mock methods way down deep to test code paths, test reads weird though
-      expect(download).to receive(:eb_config_save)
-      expect(download).to receive(:do_copy_to_local_cfg)
-      download.download
+      expect(get).to receive(:eb_config_save)
+      expect(get).to receive(:do_copy_to_local_cfg)
+      get.download
     end
 
     # it "should add jack/cfg/*.yml to gitignore" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jack-eb
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Tung Nguyen
@@ -131,15 +131,16 @@ files:
 - lib/jack/cli.rb
 - lib/jack/command.rb
 - lib/jack/config.rb
+- lib/jack/config/apply.rb
 - lib/jack/config/diff.rb
-- lib/jack/config/download.rb
+- lib/jack/config/get.rb
 - lib/jack/config/help.rb
 - lib/jack/config/sort.rb
 - lib/jack/config/transmit.rb
-- lib/jack/config/upload.rb
 - lib/jack/config/yaml_formatter.rb
 - lib/jack/create.rb
 - lib/jack/default/settings.yml
+- lib/jack/deploy.rb
 - lib/jack/eb_config.rb
 - lib/jack/eb_config/base.rb
 - lib/jack/eb_config/create.rb
@@ -154,11 +155,11 @@ files:
 - lib/jack/version_checker.rb
 - spec/fixtures/project/jack/cfg/hi-web-stag-1.cfg.yml
 - spec/lib/cli_spec.rb
+- spec/lib/config/apply_spec.rb
 - spec/lib/config/diff_spec.rb
-- spec/lib/config/download_spec.rb
+- spec/lib/config/get_spec.rb
 - spec/lib/config/sort_spec.rb
 - spec/lib/config/transmit_spec.rb
-- spec/lib/config/upload_spec.rb
 - spec/lib/config/yaml_formatter_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/create_spec.rb
@@ -196,11 +197,11 @@ summary: Wrapper tool to manage AWS Elastic Beanstalk environments
 test_files:
 - spec/fixtures/project/jack/cfg/hi-web-stag-1.cfg.yml
 - spec/lib/cli_spec.rb
+- spec/lib/config/apply_spec.rb
 - spec/lib/config/diff_spec.rb
-- spec/lib/config/download_spec.rb
+- spec/lib/config/get_spec.rb
 - spec/lib/config/sort_spec.rb
 - spec/lib/config/transmit_spec.rb
-- spec/lib/config/upload_spec.rb
 - spec/lib/config/yaml_formatter_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/create_spec.rb

data/spec/lib/config/upload_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-describe Jack::Config::Upload do
-  before(:all) do
-    Jack::UI.mute = true
-  end
-
-  let(:upload) { Jack::Config::Upload.new(test_options.merge(mute: true)) }
-
-  describe "upload" do
-    it "upload code paths" do
-      exist = upload.local_cfg_exist?
-      expect(exist).to be true # checking fixture
-      # mock methods way down deep to test code paths, test reads weird though
-      expect(upload).to receive(:eb_config_put)
-      upload.upload
-    end
-
-    it "upload flow" do
-      allow(upload).to receive(:compare).and_return(true)
-
-      expect(upload).to receive(:compare)
-      expect(upload).to receive(:upload)
-      expect(upload).to receive(:update_env)
-      upload.run
-    end
-  end
-end