opsup 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc178acdd70bf25302010af889f45a52d95d2f1f1fa841ab7f6534cb98d024a
-  data.tar.gz: 3a063657be7b128f9b4dc47e0c91d4f42a0e0dce978e71d4f89fee9c94f22ca3
+  metadata.gz: '0698811d56d95cb68cd1e4bc1575bacaff650c46ed2e22e4ccb84a5d2196a769'
+  data.tar.gz: 4e65ac9d6515e35a4c5f71ed72bacda9bb17c7b188b3dd0412a76344bc4403bc
 SHA512:
-  metadata.gz: b29e1e1e7842bda942d3ff0c0921b09f47a69aab108f34481e73e7bf520d87820a36d02bc9c6c49e793bb0e16d4fab7688f1281e5e15b39a7b79c627abd6ed63
-  data.tar.gz: 70231d0c02c3e1fd9c135bceae0e41e39cc601bc03e8875e6c50f6c3be88c6c572fbcb37714a05520f75d6269270a8e1cb3b5b3e7be4e73b2a7ef5b4a02b6ab0
+  metadata.gz: 6453421cf1c5ef732f00e21c243eb8f324ca8e486564663166fa5a892402ec041cecf1b7f160bc3e207da5c4d64267fa6d3232d7012e8020b008f6a8eb8ec2a7
+  data.tar.gz: 76af537846ec040151228949946efdd8e3b5c93dff6dee1eedaa127d01a5e8919a8ca45c2aaa62b4f27939a157313afc7be23b37348e41d1b42990dbec939cea

data/lib/opsup.rb

@@ -1,5 +1,8 @@
+# typed: strong
 # frozen_string_literal: true
 
+require 'sorbet-runtime'
+
 require_relative 'opsup/version'
 require_relative 'opsup/error'
 require_relative 'opsup/config'

data/lib/opsup/app.rb

@@ -1,32 +1,40 @@
+# typed: strict
 # frozen_string_literal: true
 
 require 'aws-sdk-opsworks'
 
 module Opsup
   class App
-    private_class_method :new
+    extend T::Sig
 
+    sig { returns(Opsup::App) }
     def self.create
       new(
         logger: Opsup::Logger.instance,
       )
     end
 
+    sig { params(logger: ::Logger).void }
     def initialize(logger:)
-      @logger = logger
+      @logger = T.let(logger, ::Logger)
     end
 
-    AVAILABLE_COMMANDS = %w[
-      update_cookbooks
-      setup
-      configure
-      deploy
-    ].freeze
+    AVAILABLE_COMMANDS = T.let(
+      %w[
+        update_cookbooks
+        setup
+        configure
+        deploy
+      ].freeze,
+      T::Array[String],
+    )
 
+    sig { returns(T::Array[String]) }
     def available_commands
       AVAILABLE_COMMANDS
     end
 
+    sig { params(commands: T::Array[String], config: Opsup::Config).void }
     def run(commands, config)
       validate_commands(commands)
       @logger.warn('Started in DRYRUN MODE') if config.dryrun
@@ -46,6 +54,7 @@ module Opsup
       @logger.warn('Finished in DRYRUN MODE') if config.dryrun
     end
 
+    sig { params(commands: T::Array[String]).void }
     private def validate_commands(commands)
       raise Opsup::Error, 'No commands specified' if commands.empty?
 
@@ -53,12 +62,14 @@ module Opsup
       raise Opsup::Error, "Unknown commands: #{unknown_cmds.join(' ')}" unless unknown_cmds.empty?
     end
 
+    sig { params(config: Opsup::Config).returns(Aws::OpsWorks::Client) }
     private def new_opsworks_client(config)
       creds = Aws::Credentials.new(config.aws_access_key_id, config.aws_secret_access_key)
       Aws::OpsWorks::Client.new(region: config.opsworks_region, credentials: creds)
     end
 
     # Assumes the command is a valid value.
+    sig { params(command: String).returns(String) }
     private def command_to_opsworks_command(command)
       command == 'update_cookbooks' ? 'update_custom_cookbooks' : command
     end

data/lib/opsup/cli.rb

@@ -1,11 +1,13 @@
+# typed: strict
 # frozen_string_literal: true
 
 require 'optparse'
 
 module Opsup
   class CLI
-    private_class_method :new
+    extend T::Sig
 
+    sig { returns(Opsup::CLI) }
     def self.create
       new(
         app: Opsup::App.create,
@@ -13,11 +15,13 @@ module Opsup
       )
     end
 
+    sig { params(app: Opsup::App, option_builder: Opsup::CLI::OptionBuilder).void }
     def initialize(app:, option_builder:)
-      @app = app
-      @option_builder = option_builder
+      @app = T.let(app, Opsup::App)
+      @option_builder = T.let(option_builder, Opsup::CLI::OptionBuilder)
     end
 
+    sig { params(argv: T::Array[String]).returns(T::Boolean) }
     def run(argv)
       parser = create_parser
       @option_builder.define_options(parser)
@@ -42,6 +46,7 @@ module Opsup
       true
     end
 
+    sig { returns(OptionParser) }
     private def create_parser
       # ref: https://docs.ruby-lang.org/en/2.1.0/OptionParser.html
       OptionParser.new do |p|
@@ -61,14 +66,16 @@ module Opsup
     end
 
     class OptionBuilder
-      private_class_method :new
+      extend T::Sig
 
+      sig { returns(Opsup::CLI::OptionBuilder) }
       def self.create
         new
       end
 
       DEFAULT_OPSWORKS_REGION = 'ap-northeast-1'
 
+      sig { params(parser: OptionParser).returns(OptionParser) }
       def define_options(parser)
         parser.tap do |p|
           p.on('-s', '--stack STACK_NAME', 'target stack name')
@@ -79,6 +86,7 @@ module Opsup
         end
       end
 
+      sig { params(options: T::Hash[Symbol, T.untyped]).returns(Opsup::Config) }
       def generate_config(options)
         %w[stack aws-cred].each do |key|
           raise Opsup::Error, "missing required option: --#{key}" unless options[key.to_sym]

data/lib/opsup/config.rb

@@ -1,16 +1,40 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Opsup
   class Config
+    extend T::Sig
+
+    sig { returns(String) }
     attr_reader :stack_name
+
+    sig { returns(String) }
     attr_reader :aws_access_key_id
+
+    sig { returns(String) }
     attr_reader :aws_secret_access_key
+
+    sig { returns(String) }
     attr_reader :opsworks_region
+
+    sig { returns(Symbol) }
     attr_reader :running_mode
+
+    sig { returns(T::Boolean) }
     attr_reader :dryrun
 
-    MODES = %i[parallel serial one_then_all].freeze
+    MODES = T.let(%i[parallel serial one_then_all].freeze, T::Array[Symbol])
 
+    sig do
+      params(
+        stack_name: String,
+        aws_access_key_id: String,
+        aws_secret_access_key: String,
+        opsworks_region: String,
+        running_mode: T.nilable(Symbol),
+        dryrun: T::Boolean,
+      ).void
+    end
     def initialize(
       stack_name:,
       aws_access_key_id:,
@@ -19,14 +43,15 @@ module Opsup
       running_mode: nil,
       dryrun: false
     )
-      @stack_name = stack_name
-      @aws_access_key_id = aws_access_key_id
-      @aws_secret_access_key = aws_secret_access_key
-      @opsworks_region = opsworks_region
-      @running_mode = running_mode || MODES[0]
-      @dryrun = dryrun
+      @stack_name = T.let(stack_name, String)
+      @aws_access_key_id = T.let(aws_access_key_id, String)
+      @aws_secret_access_key = T.let(aws_secret_access_key, String)
+      @opsworks_region = T.let(opsworks_region, String)
+      @running_mode = T.let(running_mode || MODES.fetch(0), Symbol)
+      @dryrun = T.let(dryrun, T::Boolean)
     end
 
+    sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h
       {
         stack_name: stack_name,

data/lib/opsup/error.rb

@@ -1,3 +1,4 @@
+# typed: strong
 # frozen_string_literal: true
 
 module Opsup

data/lib/opsup/logger.rb

@@ -1,9 +1,15 @@
+# typed: strict
 # frozen_string_literal: true
 
 require 'logger'
 
 module Opsup
   class Logger
+    extend T::Sig
+
+    @instance = T.let(nil, T.nilable(::Logger))
+
+    sig { returns(::Logger) }
     def self.instance
       env_log_level = ENV['OPSUP_LOG_LEVEL']
       log_level =

data/lib/opsup/stack_operator.rb

@@ -1,9 +1,11 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Opsup
   class StackOperator
-    private_class_method :new
+    extend T::Sig
 
+    sig { params(opsworks: Aws::OpsWorks::Client).returns(Opsup::StackOperator) }
     def self.create(opsworks:)
       new(
         opsworks: opsworks,
@@ -11,11 +13,20 @@ module Opsup
       )
     end
 
+    sig { params(opsworks: Aws::OpsWorks::Client, logger: ::Logger).void }
     def initialize(opsworks:, logger:)
-      @opsworks = opsworks
-      @logger = logger
+      @opsworks = T.let(opsworks, Aws::OpsWorks::Client)
+      @logger = T.let(logger, ::Logger)
     end
 
+    sig do
+      params(
+        commands: T::Array[String],
+        stack_name: String,
+        mode: Symbol,
+        dryrun: T::Boolean,
+      ).void
+    end
     def run_commands(commands, stack_name:, mode:, dryrun: false)
       # Find the target stack.
       @logger.debug('Verifying the specified stack exists...')
@@ -32,6 +43,9 @@ module Opsup
       @logger.debug('Finding all working instances in the stack...')
       instances = @opsworks.describe_instances(stack_id: stack.stack_id).instances
       instances = instances.reject { |inst| inst.status == 'stopped' }
+
+      raise Opsup::Error, 'No available instances found' if instances.empty?
+
       @logger.debug(
         "#{instances.size} #{instances.size == 1 ? 'instance is' : 'instances are'} found",
       )
@@ -54,6 +68,16 @@ module Opsup
       end
     end
 
+    sig do
+      params(
+        command: String,
+        dryrun: T::Boolean,
+        mode: Symbol,
+        stack: Aws::OpsWorks::Types::Stack,
+        app: Aws::OpsWorks::Types::App,
+        instance_ids: T::Array[String],
+      ).void
+    end
     private def run_command(command, dryrun:, mode:, stack:, app:, instance_ids:)
       case mode
       when :parallel
@@ -66,9 +90,9 @@ module Opsup
         end
       when :one_then_all
         @logger.info("Creating deployment for the first instance (#{instance_ids[0]})...")
-        create_deployment(command, stack, app, [instance_ids[0]]) unless dryrun
+        create_deployment(command, stack, app, [T.must(instance_ids[0])]) unless dryrun
 
-        rest = instance_ids[1..-1]
+        rest = T.must(instance_ids[1..-1])
         if !rest.empty?
           @logger.info("Creating deployment for the other #{rest.size} instances...")
           create_deployment(command, stack, app, rest) unless dryrun
@@ -80,6 +104,14 @@ module Opsup
       end
     end
 
+    sig do
+      params(
+        command: String,
+        stack: Aws::OpsWorks::Types::Stack,
+        app: Aws::OpsWorks::Types::App,
+        instance_ids: T::Array[String],
+      ).void
+    end
     private def create_deployment(command, stack, app, instance_ids)
       res = @opsworks.create_deployment(
         stack_id: stack.stack_id,

data/lib/opsup/version.rb

@@ -1,5 +1,6 @@
+# typed: strong
 # frozen_string_literal: true
 
 module Opsup
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opsup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ryym
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-12 00:00:00.000000000 Z
+date: 2019-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-opsworks
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.71'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: 
 email:
 - ryym.64@gmail.com