kuby-core 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b7d982098e06b6e511fe3404385d6762c9f37fdf7df2ac91ce9775f40ce809e
-  data.tar.gz: b23e5c83e32a488ba8effb2ff3a8fd0f2834c305f6046072bcd6dd1e54c1f0e9
+  metadata.gz: 63e975e73abc299262e996d4bc336f951633d993c8fe56ce997543fb442abe57
+  data.tar.gz: 1a662d6ff200ecf2b9b8fdd7446d0936329599d940afd06800166537bf82005e
 SHA512:
-  metadata.gz: d64e1c94a33045be652d9bbea27d68ec905779f8e67339a03f3e5a10729e2f9c0622f120cf66a08ab8978152dc2ae4bd863d74cca60588e9d4f0b96d484ca72a
-  data.tar.gz: acd984606d103c17d5150cca2fbba13757051c277733d360868cc79145472dd77e7f536fd8c71687d62da09c7eaad59fc5071aa590d95d08c4367a2ba61d1b35
+  metadata.gz: 30d01ba9e76b0bc79c0d22c63ab65a4edbec0f35add876935233402ae6c96077adeb1b91cef3003858f0534441b1939beae31872860ba453ef3b9ef13aa84d76
+  data.tar.gz: bb75588789e02dc6bf4135ab59fb401d1ce8e07d8169460ff86282128d1ea610e01de01c44e564c4a9196959a9f6975640f0c14407bd3d02e8257499b0723099

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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.

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?
@@ -20,11 +22,11 @@ Kuby embraces the same convention-over-configuration approach that Rails does. I
 
 ## 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
 

data/kuby-core.gemspec

@@ -20,11 +20,12 @@ Gem::Specification.new do |s|
   # 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 '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'
 

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
@@ -69,6 +72,10 @@ module Kuby
         env.kubernetes.after_configuration
       end
 
+      @definition.environments.each do |_, env|
+        env.configured = true
+      end
+
       @definition
     end
 

data/lib/kuby/basic_logger.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'logger'
 require 'colorized_string'
 

data/lib/kuby/cli_base.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'open3'
 require 'thread'
 

data/lib/kuby/commands.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'kuby/version'
 require 'gli'
 

data/lib/kuby/definition.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Kuby
   class Definition
     attr_reader :app_name

data/lib/kuby/dev_setup.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Kuby
   class Spinner
     PIECES = %w(- \\ | /).freeze

data/lib/kuby/docker.rb

@@ -1,3 +1,5 @@
+# typed: strict
+
 require 'kuby/docker/errors'
 
 module Kuby
@@ -10,6 +12,7 @@ module Kuby
     autoload :Credentials,    'kuby/docker/credentials'
     autoload :Debian,         'kuby/docker/debian'
     autoload :DevSpec,        'kuby/docker/dev_spec'
+    autoload :Distro,         'kuby/docker/distro'
     autoload :Dockerfile,     'kuby/docker/dockerfile'
     autoload :InlineLayer,    'kuby/docker/inline_layer'
     autoload :Layer,          'kuby/docker/layer'

data/lib/kuby/docker/alpine.rb

@@ -1,40 +1,43 @@
+# typed: strict
+
 module Kuby
   module Docker
-    class Alpine
-      SHELL_EXE = '/bin/sh'.freeze
+    class Alpine < Distro
+      SHELL_EXE = T.let('/bin/sh'.freeze, String)
 
-      DEFAULT_PACKAGES = [
-        [:ca_certificates],
+      DEFAULT_PACKAGES = T.let([
+        [:ca_certificates, nil],
         [:nodejs, '12.14.1'],
         [:yarn, '1.21.1'],
-        [:c_toolchain],
-        [:tzdata]
-      ].freeze
+        [:c_toolchain, nil],
+        [:tzdata, nil]
+      ].freeze, T::Array[[Symbol, T.nilable(String)]])
 
+      sig { returns(Layer) }
       attr_reader :phase
 
-      def initialize(phase)
-        @phase = phase
-      end
-
+      sig { override.params(packages: T::Array[Distro::PackageImpl], into: Dockerfile).void }
       def install(packages, into:)
         dockerfile = into
         install_managed(packages, dockerfile)
         install_unmanaged(packages, dockerfile)
       end
 
+      sig { override.returns(T::Array[[Symbol, T.nilable(String)]]) }
       def default_packages
         DEFAULT_PACKAGES
       end
 
+      sig { override.returns(String) }
       def shell_exe
         SHELL_EXE
       end
 
       private
 
+      sig { params(packages: T::Array[Distro::PackageImpl], dockerfile: Dockerfile).void }
       def install_managed(packages, dockerfile)
-        pkgs = packages.select(&:managed?)
+        pkgs = T.cast(packages.select(&:managed?), T::Array[Distro::ManagedPackageImpl])
 
         unless pkgs.empty?
           package_names = pkgs.map { |pkg| pkg.package_name_for(:alpine) }
@@ -44,6 +47,7 @@ module Kuby
         end
       end
 
+      sig { params(packages: T::Array[Distro::PackageImpl], dockerfile: Dockerfile).void }
       def install_unmanaged(packages, dockerfile)
         packages
           .reject(&:managed?)

data/lib/kuby/docker/assets_phase.rb

@@ -1,6 +1,11 @@
+# typed: strict
+
 module Kuby
   module Docker
     class AssetsPhase < Layer
+      extend T::Sig
+
+      sig { override.params(dockerfile: Dockerfile).void }
       def apply_to(dockerfile)
         dockerfile.run(
           'bundle', 'exec', 'rake', 'assets:precompile'

data/lib/kuby/docker/bundler_phase.rb

@@ -1,12 +1,44 @@
+# typed: strict
+
 require 'pathname'
 
 module Kuby
   module Docker
     class BundlerPhase < Layer
-      DEFAULT_WITHOUT = ['development', 'test', 'deploy'].freeze
+      extend T::Sig
+
+      DEFAULT_WITHOUT = T.let(
+        ['development', 'test', 'deploy'].freeze, T::Array[String]
+      )
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :gemfile
 
-      attr_accessor :version, :gemfile, :without
+      sig { params(gemfile: String).void }
+      attr_writer :gemfile
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :without
+
+      sig { params(without: T::Array[String]).void }
+      attr_writer :without
+
+      sig { params(environment: Environment).void }
+      def initialize(environment)
+        super
+
+        @version = T.let(@version, T.nilable(String))
+        @gemfile = T.let(@gemfile, T.nilable(String))
+        @without = T.let(@without, T.nilable(T::Array[String]))
+      end
 
+      sig { override.params(dockerfile: Dockerfile).void }
       def apply_to(dockerfile)
         gf = gemfile || default_gemfile
         lf = "#{gf}.lock"
@@ -41,10 +73,12 @@ module Kuby
 
       private
 
+      sig { returns(String) }
       def default_version
         Bundler::VERSION
       end
 
+      sig { returns(String) }
       def default_gemfile
         Bundler
           .definition

data/lib/kuby/docker/cli.rb

@@ -1,3 +1,5 @@
+# typed: strict
+
 require 'json'
 require 'open3'
 require 'shellwords'
@@ -5,22 +7,29 @@ require 'shellwords'
 module Kuby
   module Docker
     class CLI < CLIBase
+      extend T::Sig
+
+      sig { returns(String) }
       attr_reader :executable
 
+      sig { params(executable: T.nilable(String)).void }
       def initialize(executable = nil)
-        @executable = executable || `which docker`.strip
+        @executable = T.let(executable || `which docker`.strip, String)
       end
 
+      sig { returns(T.nilable(String)) }
       def config_file
         if File.exist?(default_config_file)
           default_config_file
         end
       end
 
+      sig { returns(String) }
       def default_config_file
         File.join(Dir.home, '.docker', 'config.json')
       end
 
+      sig { params(url: String, username: String, password: String).void }
       def login(url:, username:, password:)
         cmd = [
           executable, 'login', url, '--username', username, '--password-stdin'
@@ -36,13 +45,23 @@ module Kuby
         end
       end
 
+      sig { returns(T::Array[String]) }
       def auths
         return [] unless config_file
 
-        config = JSON.parse(File.read(config_file))
+        config = JSON.parse(File.read(T.must(config_file)))
         config.fetch('auths', {}).keys
       end
 
+      sig {
+        params(
+          dockerfile: Dockerfile,
+          image_url: String,
+          tags: T::Array[String],
+          build_args: T::Hash[T.any(Symbol, String), String]
+        )
+        .void
+      }
       def build(dockerfile:, image_url:, tags:, build_args: {})
         cmd = [
           executable, 'build',
@@ -63,6 +82,15 @@ module Kuby
         end
       end
 
+      sig {
+        params(
+          image_url: String,
+          tag: String,
+          env: T::Hash[T.any(Symbol, String), String],
+          ports: T::Array[T.any(String, Integer)]
+        )
+        .void
+      }
       def run(image_url:, tag: 'latest', env: {}, ports: [])
         cmd = [
           executable, 'run',
@@ -76,6 +104,7 @@ module Kuby
         execc(cmd)
       end
 
+      sig { params(image_url: String).returns(T::Array[T::Hash[Symbol, String]]) }
       def images(image_url)
         cmd = [
           executable, 'images', image_url,
@@ -89,6 +118,7 @@ module Kuby
         end
       end
 
+      sig { params(image_url: String, tag: String).void }
       def push(image_url, tag)
         systemm([
           executable, 'push', "#{image_url}:#{tag}"
@@ -100,6 +130,7 @@ module Kuby
         end
       end
 
+      sig { params(image_url: String, tag: String).void }
       def pull(image_url, tag)
         systemm([
           executable, 'pull', "#{image_url}:#{tag}"
@@ -111,14 +142,17 @@ module Kuby
         end
       end
 
+      sig { returns(Symbol) }
       def status_key
         :kuby_docker_cli_last_status
       end
 
+      sig { returns(Symbol) }
       def stdout_key
         :kuby_docker_stdout
       end
 
+      sig { returns(Symbol) }
       def stderr_key
         :kuby_docker_stderr
       end

data/lib/kuby/docker/copy_phase.rb

@@ -1,19 +1,27 @@
+# typed: strict
+
 module Kuby
   module Docker
     class CopyPhase < Layer
-      DEFAULT_PATHS = ['./'].freeze
+      extend T::Sig
+
+      DEFAULT_PATHS = T.let(['./'].freeze, T::Array[String])
 
+      sig { returns(T::Array[String]) }
       attr_reader :paths
 
-      def initialize(*args)
+      sig { params(environment: Environment).void }
+      def initialize(environment)
         super
-        @paths = []
+        @paths = T.let([], T::Array[String])
       end
 
+      sig { params(path: String).void }
       def <<(path)
         paths << path
       end
 
+      sig { params(dockerfile: Dockerfile).void }
       def apply_to(dockerfile)
         to_copy = paths.empty? ? DEFAULT_PATHS : paths
         to_copy.each { |path| dockerfile.copy(path, '.') }

data/lib/kuby/docker/credentials.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require 'kube-dsl'
 
 module Kuby

data/lib/kuby/docker/debian.rb

@@ -1,38 +1,41 @@
+# typed: strict
+
 module Kuby
   module Docker
-    class Debian
-      SHELL_EXE = '/bin/bash'
+    class Debian < Distro
+      SHELL_EXE = T.let('/bin/bash'.freeze, String)
 
-      DEFAULT_PACKAGES = [
-        [:ca_certificates],
+      DEFAULT_PACKAGES = T.let([
+        [:ca_certificates, nil],
         [:nodejs, '12.14.1'],
         [:yarn, '1.21.1']
-      ].freeze
+      ].freeze, T::Array[[Symbol, T.nilable(String)]])
 
+      sig { returns(Layer) }
       attr_reader :phase
 
-      def initialize(phase)
-        @phase = phase
-      end
-
+      sig { override.params(packages: T::Array[Distro::PackageImpl], into: Dockerfile).void }
       def install(packages, into:)
         dockerfile = into
         install_managed(packages, dockerfile)
         install_unmanaged(packages, dockerfile)
       end
 
+      sig { override.returns(T::Array[[Symbol, T.nilable(String)]]) }
       def default_packages
         DEFAULT_PACKAGES
       end
 
+      sig { override.returns(String) }
       def shell_exe
         SHELL_EXE
       end
 
       private
 
+      sig { params(packages: T::Array[Distro::PackageImpl], dockerfile: Dockerfile).void }
       def install_managed(packages, dockerfile)
-        pkgs = packages.select(&:managed?)
+        pkgs = T.cast(packages.select(&:managed?), T::Array[Distro::ManagedPackageImpl])
 
         pkg_cmd = <<~CMD.strip
           apt-get update -qq && \\
@@ -49,6 +52,7 @@ module Kuby
         dockerfile.run(pkg_cmd)
       end
 
+      sig { params(packages: T::Array[Distro::PackageImpl], dockerfile: Dockerfile).void }
       def install_unmanaged(packages, dockerfile)
         packages
           .reject(&:managed?)