qops 1.6.1 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae573e99371d225d3eca19d41a48f13a8a013819
-  data.tar.gz: 7feba6d8f128cf7e6a62bf80cf5306d4827db491
+SHA256:
+  metadata.gz: af7b1d924423be4fadd918150bc5bfc948012cb6db284b7fcb2bc1a9bf153937
+  data.tar.gz: 2ef7d27d6daaba3f569847cb2650d8b861d5690e9c79784b3dc8369d0cd12e1a
 SHA512:
-  metadata.gz: 102be14735cf3aaf894bcc5b502f4c9bf5d9652651a592428f19978f779f740612bb6b74224273f39618427028a80c6e0f13dd4fc2a5b929d1b0959eec993831
-  data.tar.gz: dfe5b532a6da97e65b66474267b843c50d4c1fb8d321ec4dc0ae2894b16a51eed086136b559f92958bd1eb1e59146a307022f5f9499a1689c4555d5b2d966dd9
+  metadata.gz: 10eb2ea844656184d4e74559237ab2486329a3e01f44dc51a847d0ec02222398addc664956cc2c41725599b78f10a73e565a97e59ce8debaf1075b101d3fc7ee
+  data.tar.gz: 6d5465f49155bd01622e52f2ace9a882feab6cee327f5e07aee05a84397cf9b51cf03850d596062ac6775a6b8cb1ccdcd358c35ca1aecc2ea402ecd29f634839

data/README.md

@@ -9,13 +9,16 @@
 
 ## FAQ:
 
-### Q: The `qops` gem is currently not public. How do I access it?
+### Q: Can I Override Built-In Templates
 
-Please add your personal gemfury source to the gem path to install it.
+You can create a overridden_built_in_templates folder within you cookbooks folder.
+/cookbooks/overridden_built_in_templates/unicorn/templates/default/unicorn.conf.erb
 
 ### Q: For the `qops qops:instance:run_command` command, it provides two options: one is run commands against all instances of the stack all in once, one is run commands on each instances of the stack one by one randomly. How do I use this?
 
-When running commands one by one, between each execution of the command, there will be a delay. The delay is config by wait_deploy. By default it is 180 seconds when it is not defined. For now, run_command command will only support commends `setup` `configure` `install_dependencies` `update_dependencies`, since commands `update_custom_cookbooks` `deploy` was implemented before.
+When running commands one by one, between each execution of the command, there will be a delay. The delay is config by wait_deploy. By default it is 180 seconds when it is not defined. For now, run_command command will only support commends `setup` `configure` `install_dependencies` `update_dependencies`, `execute_recipes`, since commands `update_custom_cookbooks` `deploy` was implemented before.
+
+When run command `execute_recipes`, a comma separated recipes should be supply, for example: cookbookname::recipename_one,cookbookname::recipename_two 
 
 ### Q: How do I use QOPS to override env variables on my opsworks CHEF 11 stack?
 

data/lib/qops.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'thor/group'
 require 'aws-sdk'
@@ -17,6 +19,7 @@ require_relative 'qops/deployment/helpers'
 require_relative 'qops/deployment/app'
 require_relative 'qops/deployment/instances'
 require_relative 'qops/deployment/stacks'
+require_relative 'qops/cookbook/helpers'
 require_relative 'qops/cookbook/cookbook'
 
 # Migrate this into quandl config project

data/lib/qops/cookbook/cookbook.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class Qops::Cookbook < Thor
-  include Qops::Helpers
+  include Qops::CookbookHelpers
 
   desc 'vendor', 'Generate vendor directory to contain the cookbooks'
   def vendor
@@ -13,6 +15,7 @@ class Qops::Cookbook < Thor
   desc 'package', 'Package the cookbooks into a zip file in vendor'
   def package
     initialize_run
+    move_custom_templates
     Dir.chdir(config.cookbook_dir) do
       remove_zip_files
       system("zip -r #{artifact_name} vendor/*")
@@ -115,20 +118,6 @@ class Qops::Cookbook < Thor
     config
   end
 
-  def config
-    return @_config if @_config
-
-    @_config ||= Qops::Environment.new
-
-    %w[cookbook_dir cookbook_s3_bucket cookbook_s3_path cookbook_name cookbook_version].each do |var|
-      fail ArgumentError.new("Must specify a '#{var}' in the config") if !@_config.respond_to?(var) && !@_config.configuration.respond_to?(var)
-    end
-
-    fail ArgumentError.new("Cannot find/do not have access to cookbook directory: #{@_config.cookbook_dir}") unless Dir.exist?(@_config.cookbook_dir)
-
-    @_config
-  end
-
   def s3
     @s3 ||= Aws::S3::Client.new(**aws_configs)
   end
@@ -156,6 +145,17 @@ class Qops::Cookbook < Thor
     File.join(config.cookbook_dir, 'vendor')
   end
 
+  def move_custom_templates
+    Dir.chdir(config.cookbook_dir) do
+      custom_template_directory = File.join('vendor', config.cookbook_name, 'overridden_built_in_templates')
+      if File.directory?(custom_template_directory)
+        say('Moving Custom Templates:', :green)
+        system("mv #{custom_template_directory}/* vendor")
+        system("rm -rf #{custom_template_directory}")
+      end
+    end
+  end
+
   def remove_zip_files
     FileUtils.rm Dir.glob("#{config.cookbook_name}*.zip")
     say("Cleaned up directory '#{config.cookbook_dir}/*.zip'", :green)

data/lib/qops/cookbook/helpers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Qops::CookbookHelpers
+  extend ActiveSupport::Concern
+
+  include Qops::Helpers
+
+  included do
+    class_option :profile, type: :string, aliases: '-p', desc: 'An AWS profile to use'
+    class_option :force_config, type: :boolean, aliases: '-f', desc: 'Force qops to read options from config. by default qops will search aws opsworks stack'
+    class_option :verbose, type: :boolean, aliases: '-v', desc: 'Provides additional information when running for debugging purposes.'
+  end
+
+  private
+
+  def config
+    return @_config if @_config
+
+    @_config ||= Qops::Environment.new(profile: options[:profile], force_config: options[:force_config], verbose: options[:verbose])
+
+    %w[cookbook_dir cookbook_s3_bucket cookbook_s3_path cookbook_name cookbook_version].each do |var|
+      fail ArgumentError.new("Must specify a '#{var}' in the config") if !@_config.respond_to?(var) && !@_config.configuration.respond_to?(var)
+    end
+
+    fail ArgumentError.new("Cannot find/do not have access to cookbook directory: #{@_config.cookbook_dir}") unless Dir.exist?(@_config.cookbook_dir)
+
+    @_config
+  end
+
+end

data/lib/qops/deployment/app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Qops::Deploy < Thor
   include Qops::DeployHelpers
 
@@ -8,9 +10,7 @@ class Qops::Deploy < Thor
     instances = config.deploy_type == 'staging' ? [retrieve_instance].compact : retrieve_instances
     online_instances = instances.select { |instance| instance.status == 'online' }
 
-    if online_instances.empty?
-      raise 'Could not find any running instance(s) to deploy to. Perhaps you need to run "qops:instance:up" first'
-    end
+    raise 'Could not find any running instance(s) to deploy to. Perhaps you need to run "qops:instance:up" first' if online_instances.empty?
 
     if config.deploy_type == 'staging'
       puts "Preparing to deploy branch #{revision_used} to instance #{online_instances.first.hostname}"
@@ -32,9 +32,7 @@ class Qops::Deploy < Thor
       base_deployment_params[:app_id] = config.application_id
     end
 
-    if config.deploy_type != 'production'
-      base_deployment_params[:custom_json] = custom_json.to_json
-    end
+    base_deployment_params[:custom_json] = custom_json.to_json if config.deploy_type != 'production'
 
     manifest = {
       environment: config.deploy_type

data/lib/qops/deployment/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Qops::DeployHelpers
   extend ActiveSupport::Concern
 
@@ -8,7 +10,11 @@ module Qops::DeployHelpers
     class_option :branch, type: :string, aliases: '-b', desc: 'The branch to use when deploying to staging type environments'
     class_option :hostname, type: :string, aliases: '-h', desc: 'Fully override the hostname that qops would normally give the instance'
     class_option :profile, type: :string, aliases: '-p', desc: 'An AWS profile to use'
-    class_option :force_config, type: :boolean, aliases: '-f', desc: 'force qops to read options from config. by default qops will search aws opsworks stack'
+    class_option :force_config, type: :boolean, aliases: '-f', desc: 'Force qops to read options from config. by default qops will search aws opsworks stack'
+    class_option :verbose, type: :boolean, aliases: '-v', desc: 'Provides additional information when running for debugging purposes.'
+    class_option :command_for_run_command, type: :string, aliases: '-c', desc: 'The command to use when run_command'
+    class_option :recipes, type: :string, aliases: '-r', desc: 'The recipes to use when run_command execute_recipes'
+    class_option :options_for_run_command, type: :string, aliases: '-o', desc: 'options for run_command such as current, all_in_once or one_by_one'
   end
 
   private
@@ -16,7 +22,7 @@ module Qops::DeployHelpers
   def config
     return @_config if @_config
     Qops::Environment.notifiers
-    @_config ||= Qops::Environment.new(profile: options[:profile], force_config: options[:force_config])
+    @_config ||= Qops::Environment.new(profile: options[:profile], force_config: options[:force_config], verbose: options[:verbose])
 
     fail "Invalid configure deploy_type detected: #{@_config.deploy_type}" unless %w[staging production].include?(@_config.deploy_type)
 
@@ -108,7 +114,7 @@ module Qops::DeployHelpers
     return 'master' unless config.deploy_type == 'staging'
     if options[:branch].present?
       options[:branch]
-    elsif `git --version` # rubocop:disable Lint/LiteralInCondition
+    elsif `git --version` # rubocop:disable Lint/LiteralAsCondition
       `git symbolic-ref --short HEAD`.strip
     else
       'master'

data/lib/qops/deployment/instances.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Qops::Instance < Thor # rubocop:disable Metrics/ClassLength
   include Qops::DeployHelpers
 
@@ -55,9 +57,7 @@ class Qops::Instance < Thor # rubocop:disable Metrics/ClassLength
 
     # Start the instance if necessary
     print 'Booting instance ...'
-    unless %w[online booting].include?(instance.status)
-      config.opsworks.start_instance(instance_id: instance_id)
-    end
+    config.opsworks.start_instance(instance_id: instance_id) unless %w[online booting].include?(instance.status)
 
     manifest = {
       environment: config.deploy_type,
@@ -144,9 +144,7 @@ class Qops::Instance < Thor # rubocop:disable Metrics/ClassLength
   def clean
     initialize_run
 
-    if config.deploy_type == 'production'
-      fail "Cannot clean instances in a #{config.deploy_type} environment"
-    end
+    fail "Cannot clean instances in a #{config.deploy_type} environment" if config.deploy_type == 'production'
 
     terminated_instances = []
 
@@ -194,20 +192,42 @@ class Qops::Instance < Thor # rubocop:disable Metrics/ClassLength
     initialize_run
     instances = retrieve_instances
 
-    puts "Preparing to run command to all servers (#{instances.map(&:hostname).join(', ')})"
+    command = options[:command_for_run_command] || ask('Which command you want to execute?', limited_to: %w[setup configure install_dependencies update_dependencies execute_recipes])
+
+    option = options[:options_for_run_command] || ask('Which command you want to execute?', limited_to: %w[current all_in_once one_by_one])
 
-    command = ask('Which command you want to execute?', limited_to: %w[setup configure install_dependencies update_dependencies])
+    puts "Preparing to run command to all servers (#{instances.map(&:hostname).join(', ')})" if option != 'current'
 
-    option = ask('Which command you want to execute?', limited_to: %w[all_in_once one_by_one])
+    recipes = options[:recipes] || ask('Recipes list?') if command == 'execute_recipes'
 
     base_deployment_params = {
       stack_id: config.stack_id,
-      command: { name: command.to_s }
+      command: {
+        name: command.to_s
+      }
     }
 
+    base_deployment_params[:command][:args] = { recipes: recipes.split(',') } if recipes
+
+    puts "#{base_deployment_params}"
+
     manifest = { environment: config.deploy_type }
 
     case option
+    when 'current'
+
+      instance = retrieve_instance if config.deploy_type == 'staging'
+
+      if instance.nil?
+        puts 'No instance available to execute_recipes'
+        exit(0)
+      else
+        instance_id = instance.instance_id
+      end
+
+      print "Run command #{command} on instance #{instance_id}"
+      deployment_params = base_deployment_params.deep_dup
+      run_opsworks_command(base_deployment_params, [instance_id])
     when 'all_in_once'
       print "Run command #{command} on all instances at once ..."
       deployment_params = base_deployment_params.deep_dup
@@ -297,9 +317,7 @@ class Qops::Instance < Thor # rubocop:disable Metrics/ClassLength
 
   def terminate_instance(instance_id)
     # Remove schedule if time based instance
-    if config.autoscale_type == 'timer'
-      config.opsworks.set_time_based_auto_scaling(instance_id: instance_id, auto_scaling_schedule: {})
-    end
+    config.opsworks.set_time_based_auto_scaling(instance_id: instance_id, auto_scaling_schedule: {}) if config.autoscale_type == 'timer'
 
     # Get the instance from the id
     instance = retrieve_instance(instance_id)
@@ -314,9 +332,7 @@ class Qops::Instance < Thor # rubocop:disable Metrics/ClassLength
 
     # Attempt to shutdown the instance
     print "Attempting instance #{instance_id} - #{instance.hostname} shutdown ..."
-    unless instance.status == 'stopped'
-      config.opsworks.stop_instance(instance_id: instance_id)
-    end
+    config.opsworks.stop_instance(instance_id: instance_id) unless instance.status == 'stopped'
 
     manifest = {
       environment: config.deploy_type,

data/lib/qops/deployment/stacks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Qops::Stack < Thor
   include Qops::DeployHelpers
 

data/lib/qops/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'quandl/config'
 
 module Qops
@@ -26,17 +28,35 @@ module Qops
         puts Rainbow(message).bg(:black).red
       when :warning
         puts Rainbow(message).bg(:black).yellow
+      when :good
+        puts Rainbow(message).bg(:black).green
       else
         puts message
       end
     end
 
-    def initialize(profile: nil, force_config: false)
+    def initialize(profile: nil, force_config: false, verbose: false)
       @_aws_config = { region: configuration.region }
       @_aws_config[:profile] = profile unless profile.nil?
+
       @_force_config = force_config
-      profile.nil? ? opsworks.config.credentials.credentials : @_aws_config[:profile] = profile
-      puts Rainbow("using aws profile #{profile}").bg(:black).green unless profile.nil?
+      @_verbose = verbose
+
+      if profile.nil?
+        opsworks.config.credentials.credentials
+      else
+        parsed_creds = Aws.shared_config.instance_variable_get('@parsed_credentials')[profile]
+        role_credentials = Aws::AssumeRoleCredentials.new(
+          role_arn: parsed_creds['role_arn'],
+          role_session_name: profile
+        )
+        @_aws_config[:credentials] = role_credentials
+
+        puts Rainbow("Using AWS profile #{profile}").bg(:black).green
+      end
+
+      Aws.config.update(@_aws_config)
+
       puts Rainbow('Forcing Qops to read the opsworks parameter strictly from yaml') if force_config
       %w[deploy_type region app_name].each do |v|
         fail "Please configure #{v} before continuing." unless option?(v)
@@ -55,12 +75,12 @@ module Qops
     end
 
     def stack_id(options = {})
-      return configuration.stack_id if @_force_config
+      return configuration.stack_id if force_config?
       stack(options).stack_id
     end
 
     def subnet(options = {})
-      return configuration.subnet if @_force_config
+      return configuration.subnet if force_config?
       stack(options).default_subnet_id
     end
 
@@ -69,9 +89,9 @@ module Qops
     end
 
     def layer_id(_options = {})
-      return configuration.layer_id if @_force_config
+      return configuration.layer_id if force_config?
       name = configuration.layer_name
-      puts "searching for #{name}"
+      verbose_output("Searching for layer : #{name}")
       layer = layers.find { |l| l.name.match(/#{name}/i) }
       layer.layer_id
     end
@@ -85,7 +105,7 @@ module Qops
     end
 
     def application_id(options = {})
-      return configuration.application_id if @_force_config
+      return configuration.application_id if force_config?
       apps(options).first.app_id
     end
 
@@ -136,13 +156,25 @@ module Qops
     end
 
     def elb
-      @_elb_client ||= Aws::ElasticLoadBalancing::Client.new(region: 'us-east-1', profile: @_aws_config[:profile])
+      @_elb_client ||= Aws::ElasticLoadBalancing::Client.new(**@_aws_config)
     end
 
     def cookbook_json
       configuration.cookbook_json || 'custom.json'
     end
 
+    def verbose?
+      @_verbose
+    end
+
+    def verbose_output(text)
+      self.class.print_with_colour(text, :warning) if verbose?
+    end
+
+    def force_config?
+      @_force_config
+    end
+
     def option?(key)
       respond_to?(key.to_sym) || configuration.instance_variable_get(:@table).keys.include?(key.to_sym)
     end
@@ -172,18 +204,24 @@ module Qops
         :stack_id
       else
         id = identity_from_config
-        msg = Rainbow("Using opsworks.yml config #{id}: #{configuration.send(id)}")
-        puts(msg.bg(:black).green)
+        self.class.print_with_colour("Using opsworks.yml config #{id}: #{configuration.send(id)}", :good)
         id
       end
     end
 
     def search_stack(key, value)
-      stack = opsworks.describe_stacks.stacks.find { |s| s.send(key) == value }
+      verbose_output("Searching for stack : #{value}")
+
+      stack = opsworks.describe_stacks.stacks.find do |s|
+        verbose_output("Found stack: #{s.send(key)}")
+        s.send(key) == value
+      end
+
       unless stack
-        puts Rainbow("Could not find stack with #{key} = #{value}").bg(:black).red
+        self.class.print_with_colour("Could not find stack with #{key} = #{value}", :error)
         exit(-1)
       end
+
       stack
     end
 

data/lib/qops/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Qops::Helpers
   extend ActiveSupport::Concern
 

data/lib/qops/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Qops
-  VERSION = '1.6.1'.freeze
+  VERSION = '1.8.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qops
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.8.1
 platform: ruby
 authors:
 - Matthew Basset
@@ -12,22 +12,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: qthor
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1.4
+        version: 4.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1.4
+        version: 4.2.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -46,58 +52,58 @@ dependencies:
   name: quandl-config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: quandl-slack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.20.0
 description: Help to automate opsworks project deployments with single commands.
 email:
 - support@quandl.com
@@ -110,6 +116,7 @@ files:
 - bin/qops
 - lib/qops.rb
 - lib/qops/cookbook/cookbook.rb
+- lib/qops/cookbook/helpers.rb
 - lib/qops/deployment/app.rb
 - lib/qops/deployment/helpers.rb
 - lib/qops/deployment/instances.rb
@@ -136,8 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Helper commands for deployment of opsworks projects.