indocker 0.1.6 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e124a571ae32781f28cbe640d3f406914c9cbbf88ebe5178d31280844c0ea6
-  data.tar.gz: 78f3b3a06fd08188b48ad8fedae468a62ea6d9dc348442bf22fc9fdd1b6cf93d
+  metadata.gz: 8625d37ada817f2f83c30f154bd2ed9a104a023e5b554f4c91f3708ed4aa2770
+  data.tar.gz: 24950eb94bd956f7f10ad81da4330bffa78495a4852733a1bec5d0713cce4896
 SHA512:
-  metadata.gz: d169e30efdcf9ae6c97bf01a836be681c9bdc6cf9515fc61d30b4ae57ad9368a96e7619703fe0ad54cba968123de6ce6da6b96f1272cd7eab95ea73e7ed6416c
-  data.tar.gz: e4b61302d306cc10d85edfffd37db51b668399a6c0ebb214451693394318b389bcf106fc116ee9f2ad1cf17f301c9ba17b1b4d6031a1218351f6c5210b3bd7b0
+  metadata.gz: e50ef7ed88a688bb1119e55b1d1662d6827e5667cc66c61dc85933687e9d4834c785c03c7fb917a2709adf04d909f7e611f8c844741b1532211dddad340dc149
+  data.tar.gz: 1e52f25fff3bf09ddb7f1d097b46ad0e858555892d3b4721a628c8817a16e165694dbf3650e940eb83cb6ac05d8ded47c6359ada9d3cba39d3885ff95e9e88d0

data/Gemfile

@@ -4,3 +4,8 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in indocker.gemspec
 gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'pry'
+end

data/Gemfile.lock

@@ -1,15 +1,20 @@
 PATH
   remote: .
   specs:
-    indocker (0.1.6)
+    indocker (0.1.11)
       net-ssh
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.3)
     diff-lcs (1.3)
+    method_source (1.0.0)
     net-ssh (6.1.0)
-    rake (10.5.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -30,8 +35,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.17)
   indocker!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  pry
+  rake (~> 12.3.3)
+  rspec
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -1,5 +1,7 @@
 # InDocker
 
+[![Codeship Status for ArtStation/indocker](https://app.codeship.com/projects/bf8888c0-b7e4-0138-fc1f-7e2faa53772a/status?branch=master)](https://app.codeship.com/projects/404716)
+
 Docker Containers Deployment
 
 ## Installation
@@ -8,11 +10,20 @@ Docker Containers Deployment
 $ gem install indocker
 ```
 
-## Development: Launch example app
+## Development: Launch example app locally
+
+```ruby
+cd example
+indocker/bin/deploy -C dev -c ruby -d
+```
+
+## Development: Launch example with external host
+
+NOTE: Default external host requires extra permissions.
 
 ```ruby
 cd example
-bundle exec indocker/bin/deploy -C dev -c ruby -d
+indocker/bin/deploy -C external -c ruby -d
 ```
 
 ## License

data/example/indocker/bin/deploy

@@ -8,9 +8,10 @@ configurations = list_configurations(File.expand_path(File.join(__dir__, '../con
 ARGV << '-h' if ARGV.empty?
 
 options = {
-  skip_build: false,
-  force_restart: false,
-  skip_tags: [],
+  skip_build:         false,
+  skip_deploy:        false,
+  force_restart:      false,
+  skip_tags:          [],
   skip_force_restart: [],
 }
 
@@ -61,6 +62,10 @@ OptionParser.new do |opts|
     options[:skip_build] = true
   end
 
+  opts.on("-b", "--skip-deploy", "Skip image deploy") do |val|
+    options[:skip_deploy] = true
+  end
+
   opts.on("-y", "--auto-confirm", "Automatically confirm deployment") do |val|
     options[:auto_confirm] = true
   end
@@ -106,15 +111,16 @@ Indocker.set_configuration_name(options[:configuration])
 require_relative '../setup'
 
 Indocker.deploy(
-  containers: options[:containers] || [],
-  tags: options[:tags] || [],
-  skip_containers: options[:skip_containers] || [],
-  skip_dependent: !!options[:skip_dependent],
-  servers: options[:servers] || [],
-  skip_build: options[:skip_build],
-  force_restart: options[:force_restart],
-  skip_tags: options[:skip_tags] || [],
-  skip_force_restart: options[:skip_force_restart] || [],
-  auto_confirm: !!options[:auto_confirm],
+  containers:           options[:containers] || [],
+  tags:                 options[:tags] || [],
+  skip_containers:      options[:skip_containers] || [],
+  skip_dependent:       !!options[:skip_dependent],
+  servers:              options[:servers] || [],
+  skip_build:           options[:skip_build],
+  skip_deploy:          options[:skip_deploy],
+  force_restart:        options[:force_restart],
+  skip_tags:            options[:skip_tags] || [],
+  skip_force_restart:   options[:skip_force_restart] || [],
+  auto_confirm:         !!options[:auto_confirm],
   require_confirmation: !!options[:require_confirmation],
 )

data/example/indocker/bounded_contexts/shared/bad_container_build/Dockerfile

@@ -0,0 +1,3 @@
+FROM ruby:2.5.0
+
+RUN some-unexisting-command

data/example/indocker/bounded_contexts/shared/bad_container_build/container.rb

@@ -0,0 +1,5 @@
+Indocker
+  .define_container(:bad_container_build)
+  .tags('bad_container_build', 'console=true')
+  .image(:bad_container_build)
+  .networks(:app_net)

data/example/indocker/bounded_contexts/shared/bad_container_build/image.rb

@@ -0,0 +1,3 @@
+Indocker
+  .define_image(:bad_container_build)
+  .registry(:default)

data/example/indocker/bounded_contexts/shared/bad_container_start/Dockerfile

@@ -0,0 +1,8 @@
+FROM ruby:2.5.0
+
+RUN mkdir /app
+WORKDIR /app
+
+COPY bin bin
+
+CMD ["bin/run"]

data/example/indocker/bounded_contexts/shared/bad_container_start/build_context/bin/run

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+raise "Some error"

data/example/indocker/bounded_contexts/shared/bad_container_start/container.rb

@@ -0,0 +1,5 @@
+Indocker
+  .define_container(:bad_container_start)
+  .tags('bad_container_start', 'console=true')
+  .image(:bad_container_start)
+  .networks(:app_net)

data/example/indocker/bounded_contexts/shared/bad_container_start/image.rb

@@ -0,0 +1,3 @@
+Indocker
+  .define_image(:bad_container_start)
+  .registry(:default)

data/example/indocker/bounded_contexts/shared/good_container/Dockerfile

@@ -0,0 +1,4 @@
+FROM ruby:2.5.0
+
+RUN mkdir /app
+WORKDIR /app

data/example/indocker/bounded_contexts/shared/good_container/container.rb

@@ -0,0 +1,5 @@
+Indocker
+  .define_container(:good_container)
+  .tags('good_container', 'console=true')
+  .image(:good_container)
+  .networks(:app_net)

data/example/indocker/bounded_contexts/shared/good_container/image.rb

@@ -0,0 +1,3 @@
+Indocker
+  .define_image(:good_container)
+  .registry(:default)

data/example/indocker/configurations/external.rb

@@ -0,0 +1,18 @@
+Indocker
+  .build_configuration(:external)
+  .use_registry(:dev, as: :default)
+  .use_build_server(:external_bs)
+  .enabled_containers(
+    ruby: {
+      servers: [:external],
+    },
+    good_container: {
+      servers: [:external],
+    },
+    bad_container_build: {
+      servers: [:external],
+    },
+    bad_container_start: {
+      servers: [:external],
+    }
+  )

data/example/indocker/infrastructure/build_servers.rb

@@ -5,4 +5,15 @@ Indocker.add_build_server(
     user: `whoami`.strip,
     port: 22
   )
+)
+
+external_host = ENV['INDOCKER_EXTERNAL_HOST'] || 'indocker.artstn.ninja'
+external_user = ENV['INDOCKER_EXTERNAL_USER'] || 'indocker'
+Indocker.add_build_server(
+  Indocker::BuildServer.new(
+    name: :external_bs,
+    host: external_host,
+    user: external_user,
+    port: 22
+  )
 )

data/example/indocker/infrastructure/servers.rb

@@ -5,4 +5,15 @@ Indocker.add_server(
     user: `whoami`.strip,
     port: 22
   )
+)
+
+external_host = ENV['INDOCKER_EXTERNAL_HOST'] || 'indocker.artstn.ninja'
+external_user = ENV['INDOCKER_EXTERNAL_USER'] || 'indocker'
+Indocker.add_server(
+  Indocker::Server.new(
+    name: :external,
+    host: external_host,
+    user: external_user,
+    port: 22
+  )
 )

data/example/indocker/setup.rb

@@ -3,7 +3,7 @@ require 'indocker'
 root_dir = File.join(__dir__, '..', '..')
 
 Indocker.set_root_dir(__dir__)
-Indocker.set_deploy_dir(File.join(root_dir, 'tmp', 'deployment'))
+Indocker.set_deploy_dir('~/deployment')
 
 Indocker.set_dockerignore [
   'Dockerfile',

data/example/spec/indocker_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+RSpec.describe Indocker do
+  it "has a version number" do
+    expect(Indocker::VERSION).not_to be nil
+  end
+
+  describe "successful deployment" do
+    it "doesn't raise any error" do
+      expect{
+        launch_deployment(containers: [:good_container])
+      }.to_not raise_error
+    end
+
+    it "shows a message about successful deploy" do
+      allow(Indocker.global_logger).to receive(:info).at_least(:once)
+      
+      launch_deployment(containers: [:good_container])
+
+      expect(Indocker.global_logger).to have_received(:info).at_least(:once).with(/Deployment finished/)
+    end
+  end
+
+  describe "failed build" do
+    it "exits with an error" do
+      expect{
+        launch_deployment(containers: [:bad_container_build])
+      }.to raise_error(SystemExit)
+    end
+  end
+
+  describe "failed start" do
+    it "exits without error" do
+      expect{
+        launch_deployment(containers: [:bad_container_start])
+      }.to_not raise_error(SystemExit)
+    end
+  end
+end

data/example/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require "bundler/setup"
+require "indocker"
+require "pry"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def launch_deployment(options = {})
+  require_relative '../indocker/bin/utils/configurations'
+
+  Indocker.set_configuration_name(options[:configuration] || "external")
+  require_relative '../indocker/setup'
+
+  Indocker.set_log_level(options[:debug] ? Logger::DEBUG : Logger::INFO)
+
+  Indocker.deploy(
+    containers:           options[:containers] || [],
+    tags:                 options[:tags] || [],
+    skip_containers:      options[:skip_containers] || [],
+    skip_dependent:       !!options[:skip_dependent],
+    servers:              options[:servers] || [],
+    skip_build:           options[:skip_build],
+    skip_deploy:          options[:skip_deploy],
+    force_restart:        options[:force_restart],
+    skip_tags:            options[:skip_tags] || [],
+    skip_force_restart:   options[:skip_force_restart] || [],
+    auto_confirm:         !!options[:auto_confirm],
+    require_confirmation: !!options[:require_confirmation],
+  )
+end

data/indocker.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "net-ssh"
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/indocker.rb

@@ -85,10 +85,11 @@ module Indocker
   autoload :IndockerHelper, 'indocker_helper'
   autoload :ImagesCompiler, 'images_compiler'
   autoload :ContainerRunner, 'container_runner'
-  autoload :SshResultLogger, 'ssh_result_logger'
   autoload :DeploymentProgress, 'deployment_progress'
   autoload :DeploymentChecker, 'deployment_checker'
+  autoload :DeploymentPolicy, 'deployment_policy'
   autoload :CrontabRedeployRulesBuilder, 'crontab_redeploy_rules_builder'
+  autoload :LoggerFactory, 'logger_factory'
 
   class << self
     def set_export_command(command)
@@ -318,22 +319,31 @@ module Indocker
       builder
     end
 
-    def deploy(containers: [], skip_tags: [], tags: [], skip_dependent: false, skip_containers: [], servers: [], skip_build: false, force_restart: false, skip_force_restart: [], auto_confirm: false, require_confirmation: false)
+    def deploy(containers: [], skip_tags: [], tags: [], skip_dependent: false, 
+      skip_containers: [], servers: [], skip_build: false, skip_deploy: false,
+      force_restart: false, skip_force_restart: [], auto_confirm: false, 
+      require_confirmation: false)
+
+      deployment_policy = Indocker::DeploymentPolicy.new(
+        deploy_containers:    containers,
+        deploy_tags:          tags,
+        servers:              servers,
+        skip_dependent:       skip_dependent,
+        skip_containers:      skip_containers,
+        skip_build:           skip_build,
+        skip_deploy:          skip_deploy,
+        skip_tags:            skip_tags,
+        force_restart:        force_restart,
+        skip_force_restart:   skip_force_restart,
+        auto_confirm:         auto_confirm,
+        require_confirmation: require_confirmation,
+      )
+
       Indocker::ConfigurationDeployer
-        .new(Indocker.logger)
+        .new(logger: Indocker.logger, global_logger: Indocker.global_logger)
         .run(
-          configuration: configuration,
-          deploy_containers: containers,
-          deploy_tags: tags,
-          skip_dependent: skip_dependent,
-          skip_containers: skip_containers,
-          servers: servers,
-          skip_build: skip_build,
-          force_restart: force_restart,
-          skip_tags: skip_tags,
-          skip_force_restart: skip_force_restart,
-          auto_confirm: auto_confirm,
-          require_confirmation: require_confirmation,
+          configuration:     configuration,
+          deployment_policy: deployment_policy
         )
     end
 
@@ -385,56 +395,26 @@ module Indocker
       Indocker::BuildContextHelper.new(Indocker.configuration, nil)
     end
 
+    # This logger outputs progress of the deployment
+    # It will not output anything for deployment without debug option
     def logger
       @logger ||= begin
-        logger = if @log_level == Logger::DEBUG
-          Logger.new(STDOUT)
+        logger_stdout = if @log_level == Logger::DEBUG
+          STDOUT
         else
-          Logger.new(File.open(File::NULL, "w"))
-        end
-
-        logger.level = @log_level || Logger::INFO
-
-        logger.formatter = proc do |severity, datetime, progname, msg|
-          level = Logger::SEV_LABEL.index(severity)
-
-          severity = case level
-          when Logger::INFO
-            severity.green
-          when Logger::WARN
-            severity.purple
-          when Logger::DEBUG
-            severity.yellow
-          when Logger::ERROR
-            severity.red
-          when Logger::FATAL
-            severity.red
-          else
-            severity
-          end
-
-          severity = severity.downcase
-
-          if logger.debug?
-            if msg == "{timestamp}"
-              ""
-            else
-              "#{datetime.strftime("%Y/%m/%d %H:%M:%S")} #{severity}: #{msg}\n"
-            end
-          else
-            # Use a nicer logging for not debug
-            if msg == "{timestamp}"
-              datetime.strftime("%Y/%m/%d %H:%M:%S\n").grey
-            else
-              "  #{severity}: #{msg}\n"
-            end
-          end
+          File.open(File::NULL, "w")
         end
 
-        logger
+        Indocker::LoggerFactory.create(logger_stdout, @log_level)
       end
     end
 
+    # Global logger would output data without dependency on how we deploy the progress
+    # Currently it will always output data to stdout
+    def global_logger
+      @global_logger ||= Indocker::LoggerFactory.create(STDOUT, @log_level)
+    end
+
     def set_log_level(level)
       @log_level = level
     end