ey-core 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d7bcd4cab04e3baa4a9d4f97d007a8bcd62d6c5
-  data.tar.gz: f897fde6a12166f73c6a2c0100531c8649736b23
+  metadata.gz: 919ebc8c77b103ddfd55db2ba29a66639dfddf34
+  data.tar.gz: 3ebcb90ae295acb131ef4412e4f44b91b87542b0
 SHA512:
-  metadata.gz: 021ac450b91dc03a331ab9115c774c3d8573dc5a81cec1e98af8c1980928b33b7b54b81108a23876164803b2efbb18808003dbb25113b9393da1f4a9484fecfe
-  data.tar.gz: 194bb3a534230d94ed4be5afec22c8bc80a9341410da7bf56892d6824b3831d77237e9ab70876f7f0bb7a8f6c36ed2b48ec5eb3e53a3842aa394c2cb201de221
+  metadata.gz: 698694cdad540b7c271401dfb3917d93a7bdad374affd8bdd05da34690566de0331c13894fd8b57c4e438038664b6107385e4e6ae1ca2ca48b9f3567c478f3a5
+  data.tar.gz: 2b3c997104b8e9e8925ef60848bcbe88da61f21ebda4ed19dd6e27f950378d046ef7137f0dc276477bd4c76444a4f4026571467b10a9fc9d3d61c664a85479f1

data/.ruby-gemset

@@ -0,0 +1 @@
+core-client-rb-upstream

data/.ruby-version

@@ -1 +1 @@
-2.3
+2.3.0

data/bin/ey-core

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require File.expand_path('../../lib/ey-core/cli', __FILE__)
+require File.expand_path('../../lib/ey-core/cli/main', __FILE__)
 
-Ey::Core::Cli.new(ARGV).execute!
+Ey::Core::Cli::Main.new(ARGV).execute!

data/ey-core.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "faraday", "~> 0.9"
   gem.add_dependency "faraday_middleware", "~> 0.9"
   gem.add_dependency "faye"
+  gem.add_dependency "highline"
   gem.add_dependency "mime-types", "~> 2.99" #maintain ruby 1.9 compatibility
   gem.add_dependency "oj"
   gem.add_dependency "oj_mimic_json"

data/lib/ey-core/cli.rb

@@ -1,24 +1,8 @@
-require 'optparse'
-require 'ostruct'
-require 'ey-core'
-require 'awesome_print'
-require 'pry'
-require 'belafonte'
-require 'table_print'
-require 'rubygems/package'
-require 'escape'
+module Ey
+  module Core
 
-Cistern.formatter = Cistern::Formatter::AwesomePrint
-
-
-class Ey::Core::Cli < Belafonte::App
-  title "Engineyard CLI"
-  summary "Successor to the engineyard gem"
-
-  require_relative "cli/subcommand"
-  Dir[File.dirname(__FILE__) + '/cli/*.rb'].each {|file| load file }
-
-  Ey::Core::Cli::Subcommand.descendants.each do |d|
-    mount d
+    # The overall namespace for CLI-related code
+    module Cli
+    end
   end
 end

data/lib/ey-core/cli/helpers/server_sieve.rb

@@ -0,0 +1,76 @@
+module Ey
+  module Core
+    module Cli
+      module Helpers
+        class ServerSieve
+          ROLES = [
+            :app_servers,
+            :db_servers,
+            :db_master,
+            :utilities
+          ]
+
+          attr_reader :servers_api, :options
+
+          def self.filter(servers_api, options = {})
+            new(servers_api, options).filtered
+          end
+
+          def initialize(servers_api, options = {})
+            @servers_api = servers_api
+            @options = options
+          end
+
+          def filtered
+            return all_servers if requested?(:all)
+
+            requested_roles.map {|role|
+              role == :utilities ? utils_named(option(:utilities)) : send(role)
+            }.flatten.uniq
+          end
+
+          private
+          def requested_roles
+            #self.class::
+            ROLES.select {|role| requested?(role)}
+          end
+
+          def option(name)
+            options[name]
+          end
+
+          def requested?(name)
+            option(name)
+          end
+
+          def all_servers
+            servers_api.all.to_a.uniq
+          end
+
+          def app_servers
+            ['app_master', 'app', 'solo'].
+              map {|role| servers_api.all(role: role).to_a}.
+              flatten
+          end
+
+          def db_servers
+            db_master + servers_api.all(role: 'db_slave').to_a
+          end
+
+          def db_master
+            ['db_master', 'solo'].
+              map {|role| servers_api.all(role: role).to_a}.
+              flatten
+          end
+
+          def utils_named(name)
+            filter = {role: 'util'}
+            filter[:name] = name unless name.downcase == 'all'
+
+            servers_api.all(filter).to_a
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ey-core/cli/login.rb

@@ -3,8 +3,8 @@ class Ey::Core::Cli::Login < Ey::Core::Cli::Subcommand
   summary "Retrieve API token from Engine Yard Cloud"
 
   def handle
-    email    = ENV["EMAIL"]    || ask("Email:")
-    password = ENV["PASSWORD"] || ask("Password:", echo: false)
+    email    = ENV["EMAIL"]    || ask("Email: ")
+    password = ENV["PASSWORD"] || ask("Password: ") { |q| q.echo = false }
 
     token = unauthenticated_core_client.get_api_token(email, password).body["api_token"]
 

data/lib/ey-core/cli/main.rb

@@ -0,0 +1,28 @@
+require 'optparse'
+require 'ostruct'
+require 'ey-core'
+require 'ey-core/cli'
+require 'awesome_print'
+require 'pry'
+require 'belafonte'
+require 'table_print'
+require 'rubygems/package'
+require 'escape'
+require 'highline/import'
+
+Cistern.formatter = Cistern::Formatter::AwesomePrint
+
+
+class Ey::Core::Cli::Main < Belafonte::App
+  title "Engineyard CLI"
+  summary "Successor to the engineyard gem"
+
+  require_relative "subcommand"
+  Dir[File.dirname(__FILE__) + '/*.rb'].
+    reject {|file| file =~ /.*\/main\.rb$/}.
+    each {|file| load file }
+
+  Ey::Core::Cli::Subcommand.descendants.each do |d|
+    mount d
+  end
+end

data/lib/ey-core/cli/recipes/apply.rb

@@ -5,30 +5,52 @@ class Ey::Core::Cli::Recipes::Apply < Ey::Core::Cli::Recipes
   option :environment, short: "e", long: "environment", description: "Name or id of environment", argument: "environment"
 
   switch :main, short: "m", long: "main", description: "Apply main recipes only"
-  switch :custom, long: "custom", description: "Apply custom recipes only"
+  switch :custom, short: "u", long: "custom", description: "Apply custom recipes only"
   switch :quick, short: "q", long: "quick", description: "Quick chef run"
   switch :full, short: "f", long: "full", description: "Run main and custom chef"
 
   def handle
+    validate_run_type_flags
+
     operator, environment = core_operator_and_environment_for(options)
     raise "Unable to find matching environment" unless environment
 
-    run_type = if switch_active?(:main)
-                 "main"
-               elsif switch_active?(:custom)
-                 "custom"
-               elsif switch_active?(:quick)
-                 "quick"
-               elsif switch_active?(:full)
-                 "main"
-               else
-                 "main"
-               end
-
     run_chef(run_type, environment)
 
     if switch_active?(:full)
       run_chef("custom", environment)
     end
   end
+
+  private
+  def validate_run_type_flags
+    if active_run_type_flags.length > 1
+      kernel.abort(
+        'Only one of --main, --custom, --quick, and --full may be specified.'
+      )
+    end
+  end
+
+  def run_type
+    secondary_run_types[active_run_type] || default_run_type
+  end
+
+  def active_run_type
+    active_run_type_flags.first
+  end
+
+  def active_run_type_flags
+    [:main, :custom, :quick, :full].select {|switch| switch_active?(switch)}
+  end
+
+  def secondary_run_types
+    {
+      custom: 'custom',
+      quick: 'quick'
+    }
+  end
+
+  def default_run_type
+    'main'
+  end
 end

data/lib/ey-core/cli/ssh.rb

@@ -1,3 +1,5 @@
+require 'ey-core/cli/helpers/server_sieve'
+
 class Ey::Core::Cli::Ssh < Ey::Core::Cli::Subcommand
   title "ssh"
   summary "Open an SSH session to the environment's application master"
@@ -27,8 +29,6 @@ class Ey::Core::Cli::Ssh < Ey::Core::Cli::Subcommand
     user     = environment.username
     servers  = []
 
-
-
     if option(:command)
       if shell = option(:shell)
         cmd = Escape.shell_command([shell,'-lc',cmd])
@@ -40,29 +40,14 @@ class Ey::Core::Cli::Ssh < Ey::Core::Cli::Subcommand
         puts "sudo commands often need a tty to run correctly. Use -t option to spawn a tty.".yellow
       end
 
-      if switch_active?(:all)
-        servers += environment.servers.all.to_a
-      end
-
-      if switch_active?(:app_servers)
-        servers += (environment.servers.all(role: "app_master") + environment.servers.all(role: "app") + environment.servers.all(role: "solo")).to_a
-      end
-
-      if switch_active?(:db_servers)
-        servers += (environment.servers.all(role: "db_master") + environment.servers.all(role: "db_slave") + environment.servers.all(role: "solo")).to_a
-      end
-
-      if switch_active?(:db_master)
-        servers += (environment.servers.all(role: "db_master") + environment.servers.all(role: "solo")).to_a
-      end
-
-      if utils = option(:utilities)
-        if utils == 'all'
-          servers += environment.servers.all(role: "util").to_a
-        else
-          servers += environment.servers.all(role: "util", name: utils).to_a
-        end
-      end
+      servers += Ey::Core::Cli::Helpers::ServerSieve.filter(
+        environment.servers,
+        all: switch_active?(:all),
+        app_servers: switch_active?(:app_servers),
+        db_servers: switch_active?(:db_servers),
+        db_master: switch_active?(:db_master),
+        utilities: option(:utilities)
+      )
     else
       if option(:bind_address)
         ssh_opts += ["-L", option(:bind_address)]
@@ -79,6 +64,8 @@ class Ey::Core::Cli::Ssh < Ey::Core::Cli::Subcommand
       abort "Unable to find any matching servers. Aborting.".red
     end
 
+    servers.uniq!
+
     servers.each do |server|
       host = server.public_hostname
       name = server.name ? "#{server.role} (#{server.name})" : server.role

data/lib/ey-core/version.rb

@@ -1,5 +1,5 @@
 module Ey
   module Core
-    VERSION = "3.1.1"
+    VERSION = "3.1.2"
   end
 end

data/spec/ey-core/cli/helpers/server_sieve_spec.rb

@@ -0,0 +1,226 @@
+require 'spec_helper'
+require 'ey-core/cli/helpers/server_sieve'
+
+module Ey
+  module Core
+    module Cli
+      module Helpers
+        describe ServerSieve do
+          # Set up individual servers
+          let(:app_master_server) {Object.new}
+          let(:app_slave_server) {Object.new}
+          let(:solo_server) {Object.new}
+          let(:db_master_server) {Object.new}
+          let(:db_slave_server) {Object.new}
+          let(:util_frank_server) {Object.new}
+          let(:util_johnny_server) {Object.new}
+
+          # Set up server groups
+          let(:all_apps) {[app_master_server, app_slave_server, solo_server]}
+          let(:all_db_master) {[db_master_server, solo_server]}
+          let(:all_dbs) {[db_master_server, db_slave_server, solo_server]}
+          let(:all_utils) {[util_frank_server, util_johnny_server]}
+          let(:all_servers) {all_apps + all_dbs + all_utils}
+
+          # Set up the upstream servers API
+          let(:servers_api) {Object.new}
+          before(:each) do
+            allow(servers_api).
+              to receive(:all).
+              with(no_args).
+              and_return(all_servers)
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'app_master').
+              and_return([app_master_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'solo').
+              and_return([solo_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'app').
+              and_return([app_slave_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'db_master').
+              and_return([db_master_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'solo').
+              and_return([solo_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'db_slave').
+              and_return([db_slave_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'db_master').
+              and_return([db_master_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'solo').
+              and_return([solo_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'db_slave').
+              and_return([db_slave_server])
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'util').
+              and_return(all_utils)
+
+            allow(servers_api).
+              to receive(:all).
+              with(role: 'util', name: 'frank').
+              and_return([util_frank_server])
+
+          end
+
+          describe '.filter' do
+            let(:dummy) {Object.new}
+            let(:options) {{foo: 'bar'}}
+            let(:filtered) {['servers bruh']}
+
+            it 'is the same as creating a new sieve and filtering it' do
+              expect(described_class).
+                to receive(:new).
+                with(servers_api, options).
+                and_return(dummy)
+
+              expect(dummy).
+                to receive(:filtered).
+                and_return(filtered)
+
+              expect(described_class.filter(servers_api, options)).
+                to eql(filtered)
+            end
+          end
+
+          describe '#filtered' do
+            let(:options) {{}}
+            let(:sieve) {described_class.new(servers_api, options)}
+            let(:filtered_servers) {sieve.filtered}
+
+            context 'when all servers are requested' do
+              let(:options) {{all: true}}
+
+              it 'is all of the servers known to the server api' do
+                all_servers.each do |server|
+                  expect(filtered_servers).to include(server)
+                end
+              end
+            end
+
+            context 'when app servers are requested' do
+              let(:options) {{app_servers: true}}
+
+              it 'includes app_master servers' do
+                expect(filtered_servers).to include(app_master_server)
+              end
+
+              it 'includes app (slave) servers' do
+                expect(filtered_servers).to include(app_slave_server)
+              end
+
+              it 'includes solo servers' do
+                expect(filtered_servers).to include(solo_server)
+              end
+            end
+
+            context 'when db servers are requested' do
+              let(:options) {{db_servers: true}}
+
+              it 'includes db_master servers' do
+                expect(filtered_servers).to include(db_master_server)
+              end
+
+              it 'includes db_slave servers' do
+                expect(filtered_servers).to include(db_slave_server)
+              end
+
+              it 'includes solo servers' do
+                expect(filtered_servers).to include(solo_server)
+              end
+            end
+
+            context 'when db master is requested' do
+              let(:options) {{db_master: true}}
+
+              it 'includes db_master servers' do
+                expect(filtered_servers).to include(db_master_server)
+              end
+
+              it 'includes solo servers' do
+                expect(filtered_servers).to include(solo_server)
+              end
+
+              it 'excludes db_slave servers' do
+                expect(filtered_servers).not_to include(db_slave_server)
+              end
+            end
+
+            context 'when all utils are requested' do
+              let(:options) {{utilities: 'all'}}
+
+              it 'includes all utility servers' do
+                all_utils.each do |server|
+                  expect(filtered_servers).to include(server)
+                end
+              end
+            end
+
+            context 'when a specific util is requested' do
+              let(:options) {{utilities: 'frank'}}
+
+              it 'includes the requested util' do
+                expect(filtered_servers).to include(util_frank_server)
+              end
+
+              it 'excludes all other utils' do
+                expect(filtered_servers).not_to include(util_johnny_server)
+              end
+            end
+
+            context 'when multiple filters are active' do
+              
+              # Release the Kraken!
+              let(:options) {
+                {
+                  all: true,
+                  app_servers: true,
+                  db_servers: true,
+                  db_master: true,
+                  utilities: 'all'
+                }
+              }
+
+              it 'contains no duplicates' do
+                all_servers.each do |server|
+                  count = filtered_servers.select {|item| item == server}.length
+                  expect(count).to eql(1)
+                end
+              end
+            end
+
+            context 'when no filters are provided' do
+              it 'is empty' do
+                expect(filtered_servers).to be_empty
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/ey-core/cli/recipes/apply_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'stringio'
+require 'belafonte'
+require 'ey-core/cli'
+require 'ey-core/cli/subcommand'
+require 'ey-core/cli/recipes'
+require 'ey-core/cli/recipes/apply'
+
+describe Ey::Core::Cli::Recipes::Apply do
+  set_up_cli
+
+  before(:each) do
+    allow_any_instance_of(described_class).
+      to receive(:core_operator_and_environment_for).
+      with(any_args).
+      and_return([operator, environment])
+
+    allow_any_instance_of(described_class).
+      to receive(:run_chef).
+      with(any_args).
+      and_return(true)
+  end
+
+  context 'ey-core recipes apply --main' do
+    let(:argv) {['--main']}
+
+    it 'performs a main chef run' do
+      expect(cli).to receive(:run_chef).with('main', environment)
+
+      execute
+      expect(kernel.exit_status).to eql(0)
+    end
+  end
+
+  context 'ey-core recipes apply --custom' do
+    let(:argv) {['--custom']}
+
+    it 'performs a custom chef run' do
+      expect(cli).to receive(:run_chef).with('custom', environment)
+      
+      execute
+      expect(kernel.exit_status).to eql(0)
+    end
+  end
+
+  context 'ey-core recipes apply --quick' do
+    let(:argv) {['--quick']}
+
+    it 'performs a quick chef run' do
+      expect(cli).to receive(:run_chef).with('quick', environment)
+      
+      execute
+      expect(kernel.exit_status).to eql(0)
+    end
+  end
+
+  context 'ey-core recipes apply --full' do
+    let(:argv) {['--full']}
+
+    it 'performs both a main and a custom chef run' do
+      expect(cli).to receive(:run_chef).with('main', environment)
+      expect(cli).to receive(:run_chef).with('custom', environment)
+      
+      execute
+      expect(kernel.exit_status).to eql(0)
+    end
+  end
+
+  context 'attempting to use more than one run type flag' do
+    let(:run_type_flags) {['--main', '--custom', '--quick', '--full']}
+    let(:combinations) {run_type_flags.combination(2).to_a}
+
+    it 'aborts with advice regarding the run type flags' do
+      expect(kernel).
+        to receive(:abort).
+        with('Only one of --main, --custom, --quick, and --full may be specified.').
+        and_call_original.
+        exactly(combinations.length).
+        times
+
+      combinations.each do |combination|
+        attempt = described_class.new(combination, stdin, stdout, stderr, kernel)
+
+        expect(attempt.execute!).not_to eql(0)
+
+
+
+      end
+    end
+  end
+end

data/spec/support/cli_helpers.rb

@@ -0,0 +1,11 @@
+def set_up_cli
+  let(:argv) {[]}
+  let(:stdout) {StringIO.new}
+  let(:stderr) {StringIO.new}
+  let(:stdin) {StringIO.new}
+  let(:kernel) {FakeKernel.new}
+  let(:cli) {described_class.new(argv, stdin, stdout, stderr, kernel)}
+  let(:execute) {cli.execute!}
+  let(:operator) {Object.new}
+  let(:environment) {Object.new}
+end

data/spec/support/fake_kernel.rb

@@ -0,0 +1,21 @@
+class FakeKernel
+  attr_reader :exit_status
+
+  def system(*args)
+    system_commands.push(args.join(' '))
+  end
+
+  def system_commands
+    @system_commands ||= []
+  end
+
+  def abort(msg)
+    self.exit(false)
+    #exit(false)
+  end
+
+  def exit(whatevs)
+    whatevs = -1 unless whatevs.is_a?(Integer)
+    @exit_status ||= whatevs
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ey-core
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -300,6 +314,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
@@ -320,10 +335,12 @@ files:
 - lib/ey-core/cli/deploy.rb
 - lib/ey-core/cli/environments.rb
 - lib/ey-core/cli/errors.rb
+- lib/ey-core/cli/helpers/server_sieve.rb
 - lib/ey-core/cli/init.rb
 - lib/ey-core/cli/login.rb
 - lib/ey-core/cli/logout.rb
 - lib/ey-core/cli/logs.rb
+- lib/ey-core/cli/main.rb
 - lib/ey-core/cli/recipes.rb
 - lib/ey-core/cli/recipes/apply.rb
 - lib/ey-core/cli/recipes/download.rb
@@ -685,6 +702,8 @@ files:
 - spec/deployments_spec.rb
 - spec/environment_plan_usage_spec.rb
 - spec/environments_spec.rb
+- spec/ey-core/cli/helpers/server_sieve_spec.rb
+- spec/ey-core/cli/recipes/apply_spec.rb
 - spec/features_spec.rb
 - spec/firewalls_spec.rb
 - spec/gems_spec.rb
@@ -713,9 +732,11 @@ files:
 - spec/storages_spec.rb
 - spec/support/account_helper.rb
 - spec/support/alert_helper.rb
+- spec/support/cli_helpers.rb
 - spec/support/client_helper.rb
 - spec/support/core.rb
 - spec/support/coverage.rb
+- spec/support/fake_kernel.rb
 - spec/support/resource_helper.rb
 - spec/support/timecop.rb
 - spec/support_trial_spec.rb
@@ -742,7 +763,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Client library providing real and mock functionality for accessing Engine
@@ -769,6 +790,8 @@ test_files:
 - spec/deployments_spec.rb
 - spec/environment_plan_usage_spec.rb
 - spec/environments_spec.rb
+- spec/ey-core/cli/helpers/server_sieve_spec.rb
+- spec/ey-core/cli/recipes/apply_spec.rb
 - spec/features_spec.rb
 - spec/firewalls_spec.rb
 - spec/gems_spec.rb
@@ -797,9 +820,11 @@ test_files:
 - spec/storages_spec.rb
 - spec/support/account_helper.rb
 - spec/support/alert_helper.rb
+- spec/support/cli_helpers.rb
 - spec/support/client_helper.rb
 - spec/support/core.rb
 - spec/support/coverage.rb
+- spec/support/fake_kernel.rb
 - spec/support/resource_helper.rb
 - spec/support/timecop.rb
 - spec/support_trial_spec.rb