kuby-core 0.8.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0f3610dd2dc149fb09e589c56dc477534ece66a752106b251a94ac265cb1e34
-  data.tar.gz: 673285ecde402c63a461ef4c4374a1353be45ff33610db840590658cc6cab5ed
+  metadata.gz: 63e975e73abc299262e996d4bc336f951633d993c8fe56ce997543fb442abe57
+  data.tar.gz: 1a662d6ff200ecf2b9b8fdd7446d0936329599d940afd06800166537bf82005e
 SHA512:
-  metadata.gz: 6c8e407acf3a35f21b4446b0c0752a754720a7fbd03b887b64c4fe0991e61e6f107f61a2adb2394ac88d24470be5c814c6168cd96106295c777f50a35f77820a
-  data.tar.gz: 1871572ccb876d772eec874ed224235905ba7265ced27319f4e7abd678a65e1862584bd88f0223e2f87ba1b99158342e6c6a2c4d033d758b28338296153f5e4b
+  metadata.gz: 30d01ba9e76b0bc79c0d22c63ab65a4edbec0f35add876935233402ae6c96077adeb1b91cef3003858f0534441b1939beae31872860ba453ef3b9ef13aa84d76
+  data.tar.gz: bb75588789e02dc6bf4135ab59fb401d1ce8e07d8169460ff86282128d1ea610e01de01c44e564c4a9196959a9f6975640f0c14407bd3d02e8257499b0723099

data/CHANGELOG.md

@@ -1,10 +1,50 @@
+## 0.11.0
+* Defer evaluation of database config until after Kuby has been configured.
+  - The issue that prompted this was that the `database` block was being evaluated before the Rails root had been set via `root`. Kuby couldn't find database.yml in a non-standard location and blew up with an error.
+* Fix tests broken in 0.10.1.
+* Set up Travis CI builds.
+* Add a few tests for custom build phases.
+* Add the `Environment#configured?` method that will return `true` if Kuby has been configured and `false` if configuration hasn't happened or is in progress.
+* Add sorbet typedefs for some classes.
+* Fix issue in Rails generator (hadn't been updated with new `environment` block).
+* Add kuby-core.rb so Bundler setup works for Kuby without having to add a Rails initializer.
+
+## 0.10.1
+* Fix bug causing some `rails` and `rake` commands to not be executed.
+* Fix issue restricting Docker CLI output.
+
+## 0.10.0
+* Set default database user and password in dev environment.
+* Add ability to run rake tasks in dev environment.
+* Disallow running rails and rake tasks in non-dev environments.
+* Don't run database config through ERB.
+  - Rails env often isn't loaded, so ERB rendering can blow up with `NoMethodError`s, etc.
+  - All we really need to know is what database engine to stand up.
+* Require database user/password to be added manually to Kuby config.
+
+## 0.9.1
+* Run dev setup when asked to.
+  - Bug caused dev setup to be skipped even when requested.
+* Deployer should be tolerant of missing namespace.
+
+## 0.9.0
+* Add support for developing your app using a local Kubernetes cluster.
+  - Includes a default `:development` Kuby environment.
+* Remove rake tasks in favor of a `kuby` executable powered by [GLI](https://github.com/davetron5000/gli).
+* Rename the `minikube` provider to `docker_desktop`, which is more accurate.
+* Add more tests.
+* Avoid running commands inside pods that aren't running or that are marked for deletion (#15).
+* Pass `RAILS_MASTER_KEY` to Docker build (#14).
+* Add `kuby remote restart` command for manually restarting Rails pods.
+* Automatically restart Rails pods if deploy doesn't change the Docker image URL (#11).
+
 ## 0.8.1
 * Fix database config rewriter task.
   - Broke with refactoring of database config code.
 * More correctly parse Docker image URLs.
   - It can be challenging to identify the hostname in image URLs because 1) the host can be omitted, and 2) the scheme is often omitted.
   - The new strategy is to look for a "." in the first segment of the URL if there is no scheme.  It's not bulletproof but is better than what we had before, which was to assume the first segment was the host. Eg. for an image URL like camertron/foo, we would identify the host as "camertron."
-* Added a number of tests and a Rails dummy app in spec/.
+* Add a number of tests and a Rails dummy app in spec/.
 
 ## 0.8.0
 * Upgrade to Krane >= 1.1.4, < 2.0.

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 group :development, :test do
   gem 'pry-byebug'
   gem 'rake'
+  gem 'sorbet', '~> 0.5'
 end
 
 group :test do

data/README.md

@@ -1,5 +1,7 @@
 ## Kuby
 
+[![Build Status](https://travis-ci.com/getkuby/kuby-core.svg?branch=master)](https://travis-ci.com/getkuby/kuby-core)
+
 Deploy your Rails app the easy way.
 
 ## What is Kuby?
@@ -8,17 +10,27 @@ At its core, Kuby is a set of tools and smart defaults that encapsulate and codi
 
 Under the hood, Kuby leverages the power of Docker and Kubernetes. It tries to make these technologies accessible to the average Rails dev without requiring a devops black belt.
 
+## Why Kuby?
+
+Kuby embraces the same convention-over-configuration approach that Rails does. It aims to reduce the cognitive overhead associated with learning a bunch of ops tools to get your app onto the internet. In other words, Kuby does a whole lot for you. Specifically, it:
+
+* leverages Docker and Kubernetes, industry-leading infrastructure tools.
+* automatically configures your app with a TLS certificate from [LetsEncrypt](https://letsencrypt.org/).
+* automatically spins up a database instance based on what's in your database.yml.
+* runs a separate server for your static assets.
+* features a powerful plugin system that allows, for example, easy [Sidekiq integration](https://github.com/getkuby/kuby-sidekiq).
+
 ## Getting Started
 
-See the [Quick Start Guide](https://github.com/getkuby/kuby-core/wiki/Quick-Start-Guide)
+See the [Quick Start Guide](https://getkuby.io/docs)
 
 ## More Info
 
-See the [wiki](https://github.com/getkuby/kuby-core/wiki).
+Check out [getkuby.io](https://getkuby.io).
 
 ## Running Tests
 
-`bundle exec rspec` should do the trick... or at least it would if there were any tests. Don't worry, it's on my radar.
+`bundle exec rspec` should do the trick. Test coverage is very minimal at the moment, however.
 
 ## License
 

data/bin/kuby

@@ -0,0 +1,4 @@
+#! /usr/bin/env ruby
+
+require 'kuby'
+exit Kuby::Commands.run(ARGV)

data/kuby-core.gemspec

@@ -14,19 +14,23 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'colorize', '~> 0.8'
   s.add_dependency 'docker-remote', '~> 0.1'
+  s.add_dependency 'gli', '~> 2.0'
+  s.add_dependency 'helm-cli', '~> 0.3'
   # See: https://github.com/Shopify/krane/pull/720
   # See: https://github.com/Shopify/krane/blob/master/CHANGELOG.md#114
   s.add_dependency 'krane', '>= 1.1.4', '< 2.0'
   s.add_dependency 'kuby-cert-manager', '>= 0.3'
-  s.add_dependency 'kube-dsl', '~> 0.3'
-  s.add_dependency 'kuby-kube-db', '>= 0.5'
-  s.add_dependency 'kubernetes-cli', '~> 0.2'
+  s.add_dependency 'kube-dsl', '~> 0.4'
+  s.add_dependency 'kuby-kube-db', '>= 0.6'
+  s.add_dependency 'kubernetes-cli', '~> 0.3'
   s.add_dependency 'railties', '>= 5.1'
   s.add_dependency 'rouge', '~> 3.0'
+  s.add_dependency 'sorbet-runtime-stub', '~> 0.2'
 
   s.add_development_dependency 'rspec'
 
   s.require_path = 'lib'
+  s.executables << 'kuby'
 
   s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'LICENSE', 'CHANGELOG.md', 'README.md', 'Rakefile', 'kuby-core.gemspec']
 end

data/lib/kuby-core.rb

@@ -0,0 +1 @@
+require 'kuby'

data/lib/kuby.rb

@@ -1,3 +1,6 @@
+# typed: false
+
+require 'sorbet-runtime-stub'
 require 'kuby/railtie'
 
 begin
@@ -6,26 +9,41 @@ rescue NameError
 end
 
 module Kuby
-  autoload :BasicLogger,  'kuby/basic_logger'
-  autoload :CLIBase,      'kuby/cli_base'
-  autoload :Definition,   'kuby/definition'
-  autoload :Docker,       'kuby/docker'
-  autoload :Environment,  'kuby/environment'
-  autoload :Kubernetes,   'kuby/kubernetes'
-  autoload :Middleware,   'kuby/middleware'
-  autoload :Plugin,       'kuby/plugin'
-  autoload :Plugins,      'kuby/plugins'
-  autoload :Tasks,        'kuby/tasks'
-  autoload :TrailingHash, 'kuby/trailing_hash'
+  autoload :BasicLogger,    'kuby/basic_logger'
+  autoload :CLIBase,        'kuby/cli_base'
+  autoload :Commands,       'kuby/commands'
+  autoload :Definition,     'kuby/definition'
+  autoload :DevSetup,       'kuby/dev_setup'
+  autoload :Docker,         'kuby/docker'
+  autoload :Environment,    'kuby/environment'
+  autoload :Kubernetes,     'kuby/kubernetes'
+  autoload :Middleware,     'kuby/middleware'
+  autoload :Plugin,         'kuby/plugin'
+  autoload :PluginRegistry, 'kuby/plugin_registry'
+  autoload :Plugins,        'kuby/plugins'
+  autoload :RailsCommands,  'kuby/rails_commands'
+  autoload :Tasks,          'kuby/tasks'
+  autoload :TrailingHash,   'kuby/trailing_hash'
+
+  DEFAULT_ENV = 'development'.freeze
+  DEFAULT_DB_USER = 'root'.freeze
+  DEFAULT_DB_PASSWORD = 'password'.freeze
 
   class UndefinedEnvironmentError < StandardError; end
+  class MissingConfigError < StandardError; end
 
   class << self
     attr_reader :definition
     attr_writer :logger
 
-    def load!
-      require ENV['KUBY_CONFIG'] || File.join('.', 'kuby.rb')
+    def load!(config_file = nil)
+      config_file ||= ENV['KUBY_CONFIG'] || File.join('.', 'kuby.rb')
+
+      unless File.exist?(config_file)
+        raise MissingConfigError, "couldn't find Kuby config file at #{config_file}"
+      end
+
+      require config_file
     end
 
     def define(name, &block)
@@ -34,10 +52,30 @@ module Kuby
       @definition = Definition.new(name.to_s)
       @definition.instance_eval(&block)
 
+      # default development environment
+      @definition.environment(:development) do
+        kubernetes do
+          add_plugin(:rails_app) do
+            tls_enabled false
+
+            database do
+              user(DEFAULT_DB_USER) if respond_to?(:user)
+              password(DEFAULT_DB_PASSWORD) if respond_to?(:password)
+            end
+          end
+
+          provider :docker_desktop
+        end
+      end
+
       @definition.environments.each do |_, env|
         env.kubernetes.after_configuration
       end
 
+      @definition.environments.each do |_, env|
+        env.configured = true
+      end
+
       @definition
     end
 
@@ -56,8 +94,8 @@ module Kuby
       @providers ||= {}
     end
 
-    def register_plugin(plugin_name, plugin_klass)
-      plugins[plugin_name] = plugin_klass
+    def register_plugin(*args, **kwargs)
+      plugins.register(*args, **kwargs)
     end
 
     def register_distro(distro_name, distro_klass)
@@ -69,7 +107,7 @@ module Kuby
     end
 
     def plugins
-      @plugins ||= {}
+      @plugins ||= PluginRegistry.new
     end
 
     def logger
@@ -99,16 +137,20 @@ module Kuby
       @packages ||= {}
     end
 
+    def env=(env_name)
+      @env = env_name.to_s
+    end
+
     def env
       ENV.fetch('KUBY_ENV') do
-        (definition.environments.keys.first || Rails.env).to_s
+        (@env || Rails.env rescue nil || DEFAULT_ENV).to_s
       end
     end
   end
 end
 
 # providers
-Kuby.register_provider(:minikube, Kuby::Kubernetes::MinikubeProvider)
+Kuby.register_provider(:docker_desktop, Kuby::Kubernetes::DockerDesktopProvider)
 
 # plugins
 Kuby.register_plugin(:rails_app, Kuby::Plugins::RailsApp::Plugin)

data/lib/kuby/basic_logger.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'logger'
 require 'colorized_string'
 
@@ -18,5 +19,18 @@ module Kuby
     def fatal(msg, *args)
       super(ColorizedString[msg].red, *args)
     end
+
+    # adhere to the "CLI" interface
+    def with_pipes(out = STDOUT, err = STDERR)
+      previous_logdev = @logdev || STDERR
+      reopen(err)
+      yield
+    ensure
+      reopen(previous_logdev)
+    end
+
+    def last_status
+      nil
+    end
   end
 end

data/lib/kuby/cli_base.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'open3'
 require 'thread'
 
@@ -17,17 +18,59 @@ module Kuby
       @after_execute << block
     end
 
+    def with_pipes(out = STDOUT, err = STDERR)
+      previous_stdout = self.stdout
+      previous_stderr = self.stderr
+      self.stdout = out
+      self.stderr = err
+      yield
+    ensure
+      self.stdout = previous_stdout
+      self.stderr = previous_stderr
+    end
+
+    def stdout
+      Thread.current[stdout_key] || STDOUT
+    end
+
+    def stdout=(new_stdout)
+      Thread.current[stdout_key] = new_stdout
+    end
+
+    def stderr
+      Thread.current[stderr_key] || STDERR
+    end
+
+    def stderr=(new_stderr)
+      Thread.current[stderr_key] = new_stderr
+    end
+
     private
 
     def open3_w(env, cmd, opts = {}, &block)
       run_before_callbacks(cmd)
       cmd_s = cmd.join(' ')
 
-      Open3.pipeline_w([env, cmd_s], opts) do |stdin, wait_threads|
-        yield(stdin, wait_threads).tap do
-          stdin.close
-          self.last_status = wait_threads.last.value
+      Open3.popen3(env, cmd_s, opts) do |p_stdin, p_stdout, p_stderr, wait_thread|
+        Thread.new(stdout) do |t_stdout|
+          begin
+            p_stdout.each { |line| t_stdout.puts(line) }
+          rescue IOError
+          end
+        end
+
+        Thread.new(stderr) do |t_stderr|
+          begin
+            p_stderr.each { |line| t_stderr.puts(line) }
+          rescue IOError
+          end
+        end
+
+        yield(p_stdin).tap do
+          p_stdin.close
+          self.last_status = wait_thread.value
           run_after_callbacks(cmd)
+          wait_thread.join
         end
       end
     end
@@ -39,6 +82,14 @@ module Kuby
     end
 
     def systemm(cmd)
+      if stdout == STDOUT && stderr == STDERR
+        systemm_default(cmd)
+      else
+        systemm_open3(cmd)
+      end
+    end
+
+    def systemm_default(cmd)
       run_before_callbacks(cmd)
       cmd_s = cmd.join(' ')
       system(cmd_s).tap do
@@ -47,7 +98,41 @@ module Kuby
       end
     end
 
+    def systemm_open3(cmd)
+      run_before_callbacks(cmd)
+      cmd_s = cmd.join(' ')
+
+      Open3.popen3(cmd_s) do |p_stdin, p_stdout, p_stderr, wait_thread|
+        Thread.new(stdout) do |t_stdout|
+          begin
+            p_stdout.each { |line| t_stdout.puts(line) }
+          rescue IOError
+          end
+        end
+
+        Thread.new(stderr) do |t_stderr|
+          begin
+            p_stderr.each { |line| t_stderr.puts(line) }
+          rescue IOError
+          end
+        end
+
+        p_stdin.close
+        self.last_status = wait_thread.value
+        run_after_callbacks(cmd)
+        wait_thread.join
+      end
+    end
+
     def backticks(cmd)
+      if stdout == STDOUT && stderr == STDERR
+        backticks_default(cmd)
+      else
+        backticks_open3(cmd)
+      end
+    end
+
+    def backticks_default(cmd)
       run_before_callbacks(cmd)
       cmd_s = cmd.join(' ')
       `#{cmd_s}`.tap do
@@ -56,6 +141,35 @@ module Kuby
       end
     end
 
+    def backticks_open3(cmd)
+      run_before_callbacks(cmd)
+      cmd_s = cmd.join(' ')
+      result = StringIO.new
+
+      Open3.popen3(cmd_s) do |p_stdin, p_stdout, p_stderr, wait_thread|
+        Thread.new do
+          begin
+            p_stdout.each { |line| result.puts(line) }
+          rescue IOError
+          end
+        end
+
+        Thread.new(stderr) do |t_stderr|
+          begin
+            p_stderr.each { |line| t_stderr.puts(line) }
+          rescue IOError
+          end
+        end
+
+        p_stdin.close
+        self.last_status = wait_thread.value
+        run_after_callbacks(cmd)
+        wait_thread.join
+      end
+
+      result.string
+    end
+
     def run_before_callbacks(cmd)
       (@before_execute || []).each { |cb| cb.call(cmd) }
     end
@@ -71,5 +185,13 @@ module Kuby
     def status_key
       raise NotImplementedError, "#{__method__} must be defined in derived classes"
     end
+
+    def stdout_key
+      raise NotImplementedError, "#{__method__} must be defined in derived classes"
+    end
+
+    def stderr_key
+      raise NotImplementedError, "#{__method__} must be defined in derived classes"
+    end
   end
 end