kuber_kit 0.3.8 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdefb838f103f417001c7ff0167d95bc985a1db8b8b97b505426e5f2b98db7f3
-  data.tar.gz: 13f8f1103796553e56a874064e36a33e66931e73917a141e6fad049c5ced73da
+  metadata.gz: f98d973c015745f6a4ccf054e3b97edbd8302683f747842ad6c9c5b3e4e49087
+  data.tar.gz: f2e8eb96e320bc73c1c3b03c611d1990515bd55182a93f30b28966b63da0c591
 SHA512:
-  metadata.gz: cbd45f1537f9ecc3b2d29a090f85921b47ffda91093aefa7f150d5101ff3bc147f30966febdb37352e6dfb3f7e245a84423a649a0f9d9cdd586dd597634be96c
-  data.tar.gz: 947ced5481b927993ed9462255fcf7ed656c718e9642fc0f8888b14a41aa630947b89d96f56d9b5a571956c5475c6e711c3a1b604e333b617a5208292e39e9ca
+  metadata.gz: d550a0a8738447c939b5f6085ef71c7b79898854ede9c6e526e07f73fd4cf6a660b5a18c4e9277f80b081dc41f21f3371aafa69099d6383c884e954b7d15d9ae
+  data.tar.gz: 8b8ae8685c357608a6db776443171a1ea34d387272fe72f4802164e3345c7b6bf37d558d7967e5315d8718dbcf2a6a902cad2c1e3e84bb4de0b5811b1d075574

data/.github/workflows/rspec.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Rspec
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec spec/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kuber_kit (0.3.8)
+    kuber_kit (0.4.1)
       cli-ui
       contracts-lite
       dry-auto_inject

data/README.md

@@ -1,6 +1,6 @@
 # KuberKit
 
-[![Codeship Status for ArtStation/kuber_kit](https://app.codeship.com/projects/1286f0a6-3f90-4c1b-b426-721ed8a6571b/status?branch=master)](https://app.codeship.com/projects/417264)
+[![Rspec](https://github.com/ArtStation/kuber_kit/workflows/Rspec/badge.svg)](https://github.com/ArtStation/kuber_kit/actions?query=workflow%3ARspec)
 
 Solution for building & deploying applications on Kubernetes, written in Ruby.
 

data/TODO.md

@@ -5,4 +5,5 @@
 - allow deploying only services enabled for specific configuration
 - find a way to always deploy some service, e.g. for migrations and env_files
 - template should be able to set default attributes
-- template should be able to depend on image?
+- template should be able to depend on image?
+- cleanup image builds older than some date

data/example/infrastructure/artifacts.rb

@@ -9,5 +9,5 @@ KuberKit.add_artifact(
 KuberKit.add_artifact(
   KuberKit::Core::Artifacts::Git
     .new(:kuber_kit_repo)
-    .setup(remote_url: "git@github.com:ArtStation/kuber_kit.git")
+    .setup(remote_url: "git@github.com:ArtStation/kuber_kit.git", branch: "main")
 )

data/example/services/docker_app.rb

@@ -0,0 +1,12 @@
+KuberKit
+  .define_service(:docker_app)
+  .images(:ruby_app)
+  .deployer_strategy(:docker)
+  .attributes(
+    deployer: {
+      detached:         true,
+      image_name:       :ruby_app,
+      container_name:   "test_docker_app",
+      delete_if_exists: true
+    }
+  )

data/lib/kuber_kit.rb

@@ -177,6 +177,8 @@ module KuberKit
   module UI
     autoload :Interactive, 'ui/interactive'
     autoload :Simple, 'ui/simple'
+    autoload :Debug, 'ui/debug'
+    autoload :Api, 'ui/api'
   end
 
   autoload :CLI, 'cli'
@@ -205,12 +207,12 @@ module KuberKit
       @current_configuration = nil
     end
 
-    def set_debug_mode(value)
-      @debug_mode = value
+    def set_ui_mode(value)
+      @ui_mode = value
     end
     
-    def debug_mode?
-      !!@debug_mode
+    def ui_mode
+      @ui_mode
     end
 
     def deprecation_warnings_disabled?

data/lib/kuber_kit/actions/configuration_loader.rb

@@ -1,13 +1,10 @@
 class KuberKit::Actions::ConfigurationLoader
-  APP_CONFIG_FILENAME = "config.rb".freeze
-
   include KuberKit::Import[
     "core.registry_store",
     "core.image_store",
     "core.service_store",
     "core.configuration_store",
     "artifacts_sync.artifacts_updater",
-    "tools.logger",
     "shell.local_shell",
     "ui",
     "configs"
@@ -16,29 +13,24 @@ class KuberKit::Actions::ConfigurationLoader
   Contract Hash => Any
   def call(options)
     root_path     = options[:path] || File.join(Dir.pwd, configs.kuber_kit_dirname)
-
-    # require config file first, in case if other dirs are overriden in config
-    config_file_path = File.join(root_path, APP_CONFIG_FILENAME)
-    if File.exists?(config_file_path)
-      require config_file_path
-    end
-
     images_path   = options[:images_path] || File.join(root_path, configs.images_dirname)
     services_path = options[:services_path] || File.join(root_path, configs.services_dirname)
     infra_path    = options[:infra_path]  || File.join(root_path, configs.infra_dirname)
     configurations_path  = options[:configurations_path]  || File.join(root_path, configs.configurations_dirname)
     configuration_name   = ENV["KUBER_KIT_CONFIGURATION"] || options[:configuration]
 
-    logger.info "Launching kuber_kit with:"
-    logger.info "  Root path: #{root_path.to_s.yellow}"
-    logger.info "  Images path: #{images_path.to_s.yellow}"
-    logger.info "  Services path: #{services_path.to_s.yellow}"
-    logger.info "  Infrastructure path: #{infra_path.to_s.yellow}"
-    logger.info "  Configurations path: #{configurations_path.to_s.yellow}"
-    logger.info "  Configuration name: #{configuration_name.to_s.yellow}"
+    ui.print_debug "ConfigurationLoader", "Launching kuber_kit with:"
+    ui.print_debug "ConfigurationLoader", "  Root path: #{root_path.to_s.yellow}"
+    ui.print_debug "ConfigurationLoader", "  Images path: #{images_path.to_s.yellow}"
+    ui.print_debug "ConfigurationLoader", "  Services path: #{services_path.to_s.yellow}"
+    ui.print_debug "ConfigurationLoader", "  Infrastructure path: #{infra_path.to_s.yellow}"
+    ui.print_debug "ConfigurationLoader", "  Configurations path: #{configurations_path.to_s.yellow}"
+    ui.print_debug "ConfigurationLoader", "  Configuration name: #{configuration_name.to_s.yellow}"
+
+    ui.print_info("Logs", "See logs at: #{configs.log_file_path}")
 
     unless File.exists?(root_path)
-      ui.print_warning "WARNING", "KuberKit root path #{root_path} doesn't exist. You may want to pass it --path parameter."
+      ui.print_warning "ConfigurationLoader", "KuberKit root path #{root_path} doesn't exist. You may want to pass it --path parameter."
     end
 
     if Gem::Version.new(KuberKit::VERSION) < Gem::Version.new(configs.kuber_kit_min_version)
@@ -72,6 +64,7 @@ class KuberKit::Actions::ConfigurationLoader
     true
   rescue KuberKit::Error => e
     ui.print_error("Error", e.message)
+    
     false
   end
   
@@ -104,6 +97,6 @@ class KuberKit::Actions::ConfigurationLoader
       require(path)
     end
   rescue KuberKit::Shell::AbstractShell::DirNotFoundError
-    logger.warn("Directory with infrastructure not found: #{infra_path}")
+    ui.print_warning("ConfigurationLoader", "Directory with infrastructure not found: #{infra_path}")
   end
 end

data/lib/kuber_kit/actions/env_file_reader.rb

@@ -15,6 +15,7 @@ class KuberKit::Actions::EnvFileReader
     true
   rescue KuberKit::Error => e
     ui.print_error("Error", e.message)
+    
     false
   end
 end

data/lib/kuber_kit/actions/image_compiler.rb

@@ -3,7 +3,6 @@ class KuberKit::Actions::ImageCompiler
     "image_compiler.image_dependency_resolver",
     "image_compiler.build_server_pool_factory",
     "shell.local_shell",
-    "tools.logger",
     "ui",
     image_compiler: "image_compiler.action_handler",
   ]
@@ -13,14 +12,17 @@ class KuberKit::Actions::ImageCompiler
     build_id = generate_build_id
     build_server_pool = build_server_pool_factory.create()
 
+    compiled_images = []
+    compilation_result = {}
     image_dependency_resolver.each_with_deps(image_names) do |dep_image_names|
       result = compile_simultaneously(dep_image_names, build_id, build_server_pool)
-      abort unless result
+      compiled_images += dep_image_names
+      compilation_result = compilation_result.merge(result)
     end
 
     build_server_pool.disconnect_all
 
-    true
+    { images: compiled_images, compilation: compilation_result }
   rescue KuberKit::Error => e
     ui.print_error("Error", e.message)
 
@@ -30,20 +32,22 @@ class KuberKit::Actions::ImageCompiler
   private
     def compile_simultaneously(image_names, build_id, build_server_pool)
       task_group = ui.create_task_group
+      compiler_result = {}
       image_names.map do |image_name|
 
-        logger.info("Started compiling: #{image_name.to_s.green}")
+        ui.print_debug("ImageCompiler", "Started compiling: #{image_name.to_s.green}")
         task_group.add("Compiling #{image_name.to_s.yellow}") do |task|
           shell = build_server_pool.get_shell
           
-          image_compiler.call(shell, image_name, build_id)
+          compiler_result[image_name] = image_compiler.call(shell, image_name, build_id)
 
           task.update_title("Compiled #{image_name.to_s.green}")
-          logger.info("Finished compiling: #{image_name.to_s.green}")
+          ui.print_debug("ImageCompiler", "Finished compiling: #{image_name}")
         end
         
       end
       task_group.wait
+      compiler_result
     end
 
     def generate_build_id

data/lib/kuber_kit/actions/service_deployer.rb

@@ -4,7 +4,6 @@ class KuberKit::Actions::ServiceDeployer
     "service_deployer.service_list_resolver",
     "core.service_store",
     "shell.local_shell",
-    "tools.logger",
     "ui",
     service_deployer: "service_deployer.action_handler",
   ]
@@ -25,7 +24,7 @@ class KuberKit::Actions::ServiceDeployer
     )
 
     unless service_names.any?
-      ui.print_warning "WARNING", "No service found with given options, nothing will be deployed."
+      ui.print_warning "ServiceDeployer", "No service found with given options, nothing will be deployed."
     end
 
     services = service_names.map do |service_name|
@@ -35,9 +34,9 @@ class KuberKit::Actions::ServiceDeployer
     images_names = services.map(&:images).flatten.uniq
 
     compile_images(images_names) unless skip_compile
-    deploy_services(service_names)
+    deployment_result = deploy_services(service_names)
 
-    true
+    { services: service_names, deployment: deployment_result }
   rescue KuberKit::Error => e
     ui.print_error("Error", e.message)
 
@@ -47,18 +46,22 @@ class KuberKit::Actions::ServiceDeployer
   def deploy_services(service_names)
     task_group = ui.create_task_group
 
+    deployer_result = {}
+
     service_names.each do |service_name|
 
-      logger.info("Started deploying: #{service_name.to_s.green}")
+      ui.print_debug("ServiceDeployer", "Started deploying: #{service_name.to_s.green}")
       task_group.add("Deploying #{service_name.to_s.yellow}") do |task|
-        service_deployer.call(local_shell, service_name.to_sym)
+        deployer_result[service_name] = service_deployer.call(local_shell, service_name.to_sym)
 
         task.update_title("Deployed #{service_name.to_s.green}")
-        logger.info("Finished deploying: #{service_name.to_s.green}")
+        ui.print_debug("ServiceDeployer", "Finished deploying: #{service_name.to_s.green}")
       end
     end
 
     task_group.wait
+
+    deployer_result
   end
 
   def compile_images(images_names)

data/lib/kuber_kit/actions/template_reader.rb

@@ -14,6 +14,7 @@ class KuberKit::Actions::TemplateReader
     true
   rescue KuberKit::Error => e
     ui.print_error("Error", e.message)
+    
     false
   end
 end

data/lib/kuber_kit/artifacts_sync/artifacts_updater.rb

@@ -4,7 +4,8 @@ class KuberKit::ArtifactsSync::ArtifactsUpdater
   include KuberKit::Import[
     "artifacts_sync.git_artifact_resolver",
     "artifacts_sync.null_artifact_resolver",
-    "tools.logger"
+
+    "ui"
   ]
 
   def use_resolver(artifact_resolver, artifact_class:)
@@ -23,7 +24,7 @@ class KuberKit::ArtifactsSync::ArtifactsUpdater
     artifacts.each do |artifact|
       resolver = @@resolvers[artifact.class]
 
-      logger.info "Updating artifact #{artifact.name.to_s.green}"
+      ui.print_debug "ArtifactUpdater", "Updating artifact #{artifact.name.to_s.green}"
       
       raise ResolverNotFoundError, "Can't find resolver for artifact #{artifact}" if resolver.nil?
 

data/lib/kuber_kit/cli.rb

@@ -1,16 +1,19 @@
 require 'thor'
 
 class KuberKit::CLI < Thor
+  APP_CONFIG_FILENAME = "config.rb".freeze
+
   class_option :path, :type => :string
   class_option :images_path, :type => :string
   class_option :infra_path, :type => :string
   class_option :configurations_path, :type => :string
+  class_option :ui, :type => :string, :desc => "UI mode (interactive|debug|simple)"
   class_option :debug, :type => :boolean, aliases: ["-d"]
   class_option :configuration, :type => :string, aliases: ["-C"]
 
   desc "compile IMAGE_NAMES", "Compile image with IMAGE_NAMES (comma-separated)"
   def compile(image_names_str)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
     
     image_names = image_names_str.split(",").map(&:strip).map(&:to_sym)
 
@@ -18,15 +21,10 @@ class KuberKit::CLI < Thor
       result = KuberKit::Container['actions.image_compiler'].call(image_names, options)
     end
 
-    logger = KuberKit::Container['tools.logger']
     if result
-      logger.info("---------------------------")
-      logger.info("Image compilation finished!")
-      logger.info("---------------------------")
+      print_result("Image compilation finished!", result: result)
     else
-      logger.info("-------------------------".red)
-      logger.info("Image compilation failed!".red)
-      logger.info("-------------------------".red)
+      exit 1
     end
   end
 
@@ -35,7 +33,7 @@ class KuberKit::CLI < Thor
   method_option :tags,          :type => :array,    aliases: ["-t"]
   method_option :skip_compile,  :type => :boolean,  aliases: ["-B"]
   def deploy
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       result = KuberKit::Container['actions.service_deployer'].call(
@@ -45,21 +43,16 @@ class KuberKit::CLI < Thor
       )
     end
 
-    logger = KuberKit::Container['tools.logger']
     if result
-      logger.info("---------------------------")
-      logger.info("Service deployment finished!")
-      logger.info("---------------------------")
+      print_result("Service deployment finished!", result: result)
     else
-      logger.info("-------------------------".red)
-      logger.info("Service deployment failed!".red)
-      logger.info("-------------------------".red)
+      exit 1
     end
   end
 
   desc "env ENV_FILE_NAME", "Return content of Env File ENV_FILE_NAME"
   def env(env_file_name)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.env_file_reader'].call(env_file_name.to_sym, options)
@@ -68,7 +61,7 @@ class KuberKit::CLI < Thor
 
   desc "template TEMPLATE_NAME", "Return content of Template TEMPLATE_NAME"
   def template(template_name)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.template_reader'].call(template_name.to_sym, options)
@@ -77,7 +70,7 @@ class KuberKit::CLI < Thor
 
   desc "service SERVICE_NAME", "Return content of Service SERVICE_NAME"
   def service(service_name)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.service_reader'].call(service_name.to_sym, options)
@@ -86,7 +79,7 @@ class KuberKit::CLI < Thor
 
   desc "apply FILE_PATH", "Apply FILE_PATH with kubectl"
   def apply(file_path)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.kubectl_applier'].call(File.expand_path(file_path), options)
@@ -95,26 +88,26 @@ class KuberKit::CLI < Thor
 
   desc "attach POD_NAME", "Attach to POD_NAME using kubectl"
   def attach(pod_name = nil)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.kubectl_attacher'].call(pod_name, options)
     end
   end
 
-  desc "launch console in POD_NAME", "Attach to POD_NAME using kubectl & launch bin/console"
+  desc "console POD_NAME", "Attach to POD_NAME using kubectl & launch bin/console"
   def console(pod_name = nil)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.kubectl_console'].call(pod_name, options)
     end
   end
 
-  desc "show logs for POD_NAME", "Show logs for POD_NAME using kubectl"
+  desc "logs POD_NAME", "Show logs for POD_NAME using kubectl"
   method_option :follow,  :type => :boolean,  aliases: ["-f"]
   def logs(pod_name = nil)
-    KuberKit.set_debug_mode(options[:debug])
+    setup(options)
 
     if KuberKit::Container['actions.configuration_loader'].call(options)
       KuberKit::Container['actions.kubectl_logs'].call(pod_name, options)
@@ -129,4 +122,24 @@ class KuberKit::CLI < Thor
   def self.exit_on_failure?
     true
   end
+
+  private
+    def setup(options)
+      if options[:debug]
+        KuberKit.set_ui_mode(:debug)
+      elsif options[:ui]
+        KuberKit.set_ui_mode(options[:ui].to_sym)
+      end
+
+      # We should load config before loading any bean, to make sure that bean won't be built with default config
+      root_path     = options[:path] || File.join(Dir.pwd, KuberKit::Container['configs'].kuber_kit_dirname)
+      config_file_path = File.join(root_path, APP_CONFIG_FILENAME)
+      if File.exists?(config_file_path)
+        require config_file_path
+      end
+    end
+
+    def print_result(message, data = {})
+      KuberKit::Container['ui'].print_result(message, data)
+    end
 end