dream-ops 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b8aa9f131724802c240a24e1d23dbf37eb8c70e
-  data.tar.gz: 513e26443ce943be5ec10c4251a90794364ce536
+  metadata.gz: fe5971e39855c322c3680d7495452950f6e129ac
+  data.tar.gz: 6d7b6cd6b14ae02429694879aa34d7656ecd2228
 SHA512:
-  metadata.gz: d95f1f526da0bcc544dfcb06af87576571b46cf4ad75e14d1b68b36085084121ec5f14a1c561a9da5197fad733a9c2ad934d0ea5a6e3f2d73e4ad98c928f0341
-  data.tar.gz: 42e9083c9b3d6038548bd5b4897a91c861eb673a84bb2e46d0f675eef5166e74802bc17d7a0fe674082b5e067a7fc08509beed271cb178e59ad70b9644a5465d
+  metadata.gz: 04e7efd3f5108eb2f547265bee1b326a1523d4e19b8cd49eea62b0d45c7331509ec380d5a7d4e996312bf6d90fcd3665226d4fa220fb8f81644e93d24be31ac5
+  data.tar.gz: 642468eaabb2ec607aa1c3415dc21052884927d6e8835bca5849a9d08eee1edf966cc66db02993962a34438b73f0649f776ca786c077f23e89ee43b03cda8d22

data/README.md

@@ -1,8 +1,9 @@
 # DreamOps
+[![Gem Version](https://img.shields.io/gem/v/dream-ops.svg)][gem]
 
-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/dream-ops`. To experiment with that code, run `bin/console` for an interactive prompt.
+[gem]: https://rubygems.org/gems/dream-ops
 
-TODO: Delete this and the text above, and describe your gem
+CLI for Dream projects based on the [berkshelf](https://github.com/berkshelf/berkshelf) project.
 
 ## Installation
 
@@ -22,7 +23,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```bash
+dream help
+```
+
+### Deploying to OpsWorks
+
+```bash
+dream deploy opsworks --stacks 08137c03-1e85-4787-b82c-cb825638cdfa
+Stack: nodeapp
+--- Cookbook: chef-nodeapp
+--- Apps: ["nodeapp"]
+...Building cookbook [chef-nodeapp]
+...Deploying cookbook [chef-nodeapp]
+...Updating custom cookbooks [stack="nodeapp"]
+...Running setup command [stack="nodeapp"]
+...Deploying [stack="nodeapp"] [app="nodeapp"]
+```
 
 ## Development
 
@@ -32,8 +49,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dream-ops.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dream-ops.

data/lib/dream-ops.rb

@@ -11,24 +11,28 @@ end
 require "berkshelf"
 require "thor"
 
-Berkshelf.ui.mute!
-
 module DreamOps
 
   require_relative "dream-ops/version"
   require_relative "dream-ops/errors"
 
-  autoload :Shell,      "dream-ops/shell"
+  module Mixin
+    autoload :Logging,        "dream-ops/mixin/logging"
+  end
+
+  autoload :Shell,            "dream-ops/shell"
 
-  autoload :BaseFormatter,  "dream-ops/formatters/base"
-  autoload :HumanFormatter, "dream-ops/formatters/human"
-  # autoload :JsonFormatter,  "dream-ops/formatters/json"
-  # autoload :NullFormatter,  "dream-ops/formatters/null"
+  autoload :BaseFormatter,    "dream-ops/formatters/base"
+  autoload :HumanFormatter,   "dream-ops/formatters/human"
+  # autoload :JsonFormatter,    "dream-ops/formatters/json"
+  # autoload :NullFormatter,    "dream-ops/formatters/null"
 
-  autoload :BaseDeployer,  "dream-ops/deployment/base"
+  autoload :BaseDeployer,     "dream-ops/deployment/base"
   autoload :OpsWorksDeployer, "dream-ops/deployment/opsworks"
 
   class << self
+    include Mixin::Logging
+
     # @return [DreamOps::Shell]
     def ui
       @ui ||= DreamOps::Shell.new
@@ -57,4 +61,8 @@ module DreamOps
   end
 end
 
-require_relative "dream-ops/cli"
+require_relative "dream-ops/cli"
+require_relative "dream-ops/logger"
+
+Ridley.logger          = DreamOps.logger
+DreamOps.logger.level  = Logger::WARN

data/lib/dream-ops/cli.rb

@@ -27,12 +27,8 @@ module DreamOps
         @kernel.exit(0)
       rescue DreamOps::DreamOpsError => e
         DreamOps.ui.error e
-        DreamOps.ui.error "\t" + e.backtrace.join("\n\t") if ENV["BERKSHELF_DEBUG"]
+        DreamOps.ui.error "\t" + e.backtrace.join("\n\t") if ENV["DREAMOPS_DEBUG"]
         @kernel.exit(e.status_code)
-      # rescue Ridley::Errors::RidleyError => e
-      #   DreamOps.ui.error "#{e.class} #{e}"
-      #   DreamOps.ui.error "\t" + e.backtrace.join("\n\t") if ENV["BERKSHELF_DEBUG"]
-      #   @kernel.exit(47)
       end
     end
 
@@ -56,17 +52,11 @@ module DreamOps
     def initialize(*args)
       super(*args)
 
-      # if @options[:config]
-      #   unless File.exist?(@options[:config])
-      #     raise ConfigNotFound.new(:berkshelf, @options[:config])
-      #   end
-
-      #   DreamOps.config = DreamOps::Config.from_file(@options[:config])
-      # end
-
       if @options[:debug]
-        ENV["BERKSHELF_DEBUG"] = "true"
+        ENV["DREAMOPS_DEBUG"] = "true"
         DreamOps.logger.level = ::Logger::DEBUG
+      else
+        Berkshelf.ui.mute!
       end
 
       if @options[:quiet]
@@ -77,19 +67,13 @@ module DreamOps
       @options = options.dup # unfreeze frozen options Hash from Thor
     end
 
-    namespace "berkshelf"
+    namespace "dream-ops"
 
-    map "ls"   => :list
-    map "book" => :cookbook
+    # map "ls"   => :list
     map ["ver", "-v", "--version"] => :version
 
-    default_task :install
+    default_task :version
 
-    class_option :config,
-      type: :string,
-      desc: "Path to DreamOps configuration to use.",
-      aliases: "-c",
-      banner: "PATH"
     class_option :format,
       type: :string,
       default: "human",
@@ -115,8 +99,9 @@ module DreamOps
     method_option :stacks,
       type: :array,
       desc: "Only these stack IDs.",
-      aliases: "-s"
-    desc "deploy", "Creates deploy"
+      aliases: "-s",
+      required: true
+    desc "deploy [TYPE]", "Deploys to specified targets"
     def deploy(type)
       deployer = nil
 
@@ -125,26 +110,14 @@ module DreamOps
         deployer = OpsWorksDeployer.new
         stack_ids = options[:stacks]
         args = [*stack_ids]
+      else
+        DreamOps.ui.error "Deployment of type '#{type}' is not supported"
+        exit(1)
       end
 
       if !deployer.nil?
         deployer.deploy(*args)
       end
     end
-
-    # tasks["cookbook"].options = DreamOps::CookbookGenerator.class_options
-
-    private
-
-      # Print a list of the given cookbooks. This is used by various
-      # methods like {list} and {contingent}.
-      #
-      # @param [Array<CachedCookbook>] cookbooks
-      #
-    def print_list(cookbooks)
-      Array(cookbooks).sort.each do |cookbook|
-        DreamOps.formatter.msg "  * #{cookbook.cookbook_name} (#{cookbook.version})"
-      end
-    end
   end
-end
+end

data/lib/dream-ops/deployment/base.rb

@@ -20,13 +20,47 @@ module DreamOps
       end
     end
 
-    # These MUST be implemented by subclasses
+    # This method MUST be implemented by subclasses.
+    #
+    # @return [Hash]
+    #   a hash containing cookbooks that need to be built/updated
+    #   and deploy targets
+    #
+    #   Example:
+    #     {
+    #       :cookbooks => [
+    #         {
+    #           :bucket => "chef-app",
+    #           :cookbook_key => "chef-app-dev.zip",
+    #           :sha_key => "chef-app-dev_SHA.txt",
+    #           :name => "chef-app",
+    #           :path => "./chef",
+    #           :local_sha => "7bfa19491170563f422a321c144800f4435323b1",
+    #           :remote_sha => ""
+    #         }
+    #       ],
+    #       deploy_targets: [
+    #         #<Hash>,
+    #         #<Hash>
+    #       ]
+    #     }
     deployer_method :analyze
+
+    # This method MUST be implemented by subclasses.
+    #
+    # @param [Hash] cookbook
+    #   a hash containing the cookbook details
     deployer_method :deploy_cookbook
+
+
+    # This method MUST be implemented by subclasses.
+    #
+    # @param [Hash] target
+    #   a hash containing the deploy target details
     deployer_method :deploy_target
 
     # It may turn out that cookbook building will be different for different
-    # deployments, but for now all deployments build them the same way.
+    # deployments, but for now all deployments will build them the same way.
     def build_cookbook(cookbook)
       berksfile = Berkshelf::Berksfile.from_file(File.join(cookbook[:path], "Berksfile"))
       berksfile.vendor("berks-cookbooks")
@@ -69,11 +103,13 @@ module DreamOps
       deploy_threads.each do |t|
         begin
           t.join
-        rescue DreamOps::FatalDeployError
+        rescue DreamOps::DreamOpsError
+          DreamOps.ui.error "#{$!}"
           deploy_success = deploy_success && false
         end
       end
 
+      # If ANY deploy threads failed, exit with failure
       exit(1) if !deploy_success
     end
   end

data/lib/dream-ops/deployment/opsworks.rb

@@ -6,13 +6,48 @@ Aws.use_bundled_cert!
 module DreamOps
   class OpsWorksDeployer < BaseDeployer
 
-    # Output the version of DreamOps
+    # Analyze the OpsWorks stacks for deployment
+    #
+    # @return [Hash]
+    #   a hash containing cookbooks that need to be built/updated
+    #   and deploy targets
+    #
+    #   Example:
+    #     {
+    #       :cookbooks => [
+    #         {
+    #           :bucket => "chef-app",
+    #           :cookbook_key => "chef-app-dev.zip",
+    #           :sha_key => "chef-app-dev_SHA.txt",
+    #           :name => "chef-app",
+    #           :path => "./chef",
+    #           :local_sha => "7bfa19491170563f422a321c144800f4435323b1",
+    #           :remote_sha => ""
+    #         }
+    #       ],
+    #       deploy_targets: [
+    #         {
+    #           :stack => #<Stack: name="my-stack">,
+    #           :apps => [
+    #             #<App: name="my-app"
+    #           ],
+    #           :cookbook => {
+    #             :bucket => "chef-app",
+    #             :cookbook_key => "chef-app-dev.zip",
+    #             :sha_key => "chef-app-dev_SHA.txt",
+    #             :name => "chef-app",
+    #             :path => "./chef",
+    #             :local_sha => "7bfa19491170563f422a321c144800f4435323b1",
+    #             :remote_sha => ""
+    #           }
+    #         }
+    #       ]
+    #     }
     def analyze(stack_ids)
       begin
         @opsworks = Aws::OpsWorks::Client.new
         stacks = @opsworks.describe_stacks({ stack_ids: stack_ids, }).stacks
       rescue => e
-        DreamOps.ui.error "Failed to fetch OpsWorks stacks\n"
         DreamOps.ui.error "#{$!}"
         exit(1)
       end
@@ -42,8 +77,6 @@ module DreamOps
       return result
     end
 
-    ################## OpsWorks specific methods ##################
-
     # Retrieves stack apps and gets all information about remote/local cookbook
     def analyze_stack(stack)
       cookbook = nil
@@ -118,13 +151,8 @@ module DreamOps
       # If this stack has a new cookbook
       if !target[:cookbook].nil?
         if __cookbook_in_array(target[:cookbook], cookbooks)
-          begin
-            # Grab a fresh copy of the cookbook on all instances in the stack
-            update_custom_cookbooks(target[:stack])
-          rescue Aws::OpsWorks::Errors::ValidationException
-            DreamOps.ui.error "Stack \"#{target[:stack].name}\" has no running instances."
-            __bail_with_fatal_error
-          end
+          # Grab a fresh copy of the cookbook on all instances in the stack
+          update_custom_cookbooks(target[:stack])
 
           # Re-run the setup step for all layers
           setup(target[:stack])
@@ -133,22 +161,27 @@ module DreamOps
 
       # Deploy all apps for stack
       target[:apps].each do |app|
-        begin
-          deploy_app(app, target[:stack])
-        rescue Aws::OpsWorks::Errors::ValidationException
-          DreamOps.ui.error "Stack \"#{target[:stack].name}\" has no running instances."
-          __bail_with_fatal_error
-        end
+        deploy_app(app, target[:stack])
       end
     end
 
     def update_custom_cookbooks(stack)
       DreamOps.ui.info "...Updating custom cookbooks [stack=\"#{stack.name}\"]"
-      response = @opsworks.create_deployment({
-        stack_id: stack.stack_id,
-        command: { name: "update_custom_cookbooks" }
-      })
-      return wait_for_deployment(response.deployment_id)
+      begin
+        response = @opsworks.create_deployment({
+          stack_id: stack.stack_id,
+          command: { name: "update_custom_cookbooks" }
+        })
+      rescue Aws::OpsWorks::Errors::ValidationException
+        bail_with_fatal_error(NoRunningInstancesError.new(stack))
+      end
+
+      status = wait_for_deployment(response.deployment_id)
+      if status != 'successful'
+        bail_with_fatal_error(OpsWorksCommandFailedError.new(
+          stack, response.deployment_id, 'update_custom_cookbooks')
+        )
+      end
     end
 
     def setup(stack)
@@ -157,17 +190,33 @@ module DreamOps
         stack_id: stack.stack_id,
         command: { name: "setup" }
       })
-      return wait_for_deployment(response.deployment_id)
+      
+      status = wait_for_deployment(response.deployment_id)
+      if status != 'successful'
+        bail_with_fatal_error(OpsWorksCommandFailedError.new(
+          stack, response.deployment_id, 'setup')
+        )
+      end
     end
 
     def deploy_app(app, stack)
       DreamOps.ui.info "...Deploying [stack=\"#{stack.name}\"] [app=\"#{app.name}\"]"
-      response = @opsworks.create_deployment({
-        stack_id: stack.stack_id,
-        app_id: app.app_id,
-        command: { name: "deploy" }
-      })
-      return wait_for_deployment(response.deployment_id)
+      begin
+        response = @opsworks.create_deployment({
+          stack_id: stack.stack_id,
+          app_id: app.app_id,
+          command: { name: "deploy" }
+        })
+      rescue Aws::OpsWorks::Errors::ValidationException
+        bail_with_fatal_error(NoRunningInstancesError.new(stack))
+      end
+
+      status = wait_for_deployment(response.deployment_id)
+      if status != 'successful'
+        bail_with_fatal_error(OpsWorksCommandFailedError.new(
+          stack, response.deployment_id, 'deploy')
+        )
+      end
     end
 
     def get_deployment_status(deployment_id)
@@ -188,8 +237,8 @@ module DreamOps
       return status
     end
 
-    def __bail_with_fatal_error
-      raise FatalDeployError
+    def bail_with_fatal_error(ex)
+      raise ex
       Thread.exit
     end
 

data/lib/dream-ops/errors.rb

@@ -11,5 +11,35 @@ module DreamOps
     alias_method :message, :to_s
   end
 
-  class FatalDeployError < DreamOpsError; set_status_code(10); end
+  class NoRunningInstancesError < DreamOpsError
+    set_status_code(10)
+
+    def initialize(stack)
+      @stack = stack
+    end
+
+    def to_s
+      "Stack \"#{@stack.name}\" has no running instances."
+    end
+  end
+
+  class OpsWorksCommandFailedError < DreamOpsError
+    set_status_code(11)
+
+    def initialize(stack, deployment_id, command)
+      @stack         = stack
+      @deployment_id = deployment_id
+      @command       = command
+    end
+
+    def to_s
+      [
+        "Stack \"#{@stack.name}\" failed running command '#{@command}'. To view the failure log, visit:",
+        "",
+        "https://console.aws.amazon.com/opsworks/home?region=#{@stack.region}#/stack/#{@stack.stack_id}/deployments/#{@deployment_id}",
+      ].join("\n")
+    end
+
+    alias_method :message, :to_s
+  end
 end

data/lib/dream-ops/formatters/human.rb

@@ -2,7 +2,7 @@ module DreamOps
   class HumanFormatter < BaseFormatter
     # Output the version of DreamOps
     def version
-      DreamOps.ui.info DreamOps::VERSION
+      DreamOps.ui.info "Dream Ops v#{DreamOps::VERSION}"
     end
 
     # @param [DreamOps::Dependency] dependency

data/lib/dream-ops/logger.rb

@@ -0,0 +1,18 @@
+module DreamOps
+  class Logger < Ridley::Logging::Logger
+    alias_method :fatal, :error
+
+    def deprecate(message)
+      trace = caller.join("\n\t")
+      warn "DEPRECATION WARNING: #{message}\n\t#{trace}"
+    end
+
+    # Log an exception and its backtrace to FATAL
+    #
+    # @param [Exception] ex
+    def exception(ex)
+      fatal("#{ex.class}: #{ex}")
+      fatal(ex.backtrace.join("\n")) unless ex.backtrace.nil?
+    end
+  end
+end

data/lib/dream-ops/mixin/logging.rb

@@ -0,0 +1,12 @@
+module DreamOps
+  module Mixin
+    module Logging
+      attr_writer :logger
+
+      def logger
+        @logger ||= DreamOps::Logger.new(STDOUT)
+      end
+      alias_method :log, :logger
+    end
+  end
+end

data/lib/dream-ops/version.rb

@@ -1,3 +1,3 @@
 module DreamOps
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dream-ops
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Allen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2017-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,6 +152,8 @@ files:
 - lib/dream-ops/errors.rb
 - lib/dream-ops/formatters/base.rb
 - lib/dream-ops/formatters/human.rb
+- lib/dream-ops/logger.rb
+- lib/dream-ops/mixin/logging.rb
 - lib/dream-ops/shell.rb
 - lib/dream-ops/utils/zip.rb
 - lib/dream-ops/version.rb
@@ -175,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: This is the summary