kuby-core 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac73b245f1fb75244ed166e23a6441cc56dabaec66f532f67517b4dd8d412091
-  data.tar.gz: 6418a3fbca89fdc195e277aeb8309caa2b519e1d3df0fccd53f3ae8b2e9f166f
+  metadata.gz: a0f3610dd2dc149fb09e589c56dc477534ece66a752106b251a94ac265cb1e34
+  data.tar.gz: 673285ecde402c63a461ef4c4374a1353be45ff33610db840590658cc6cab5ed
 SHA512:
-  metadata.gz: 6f7bc8616cfdf23805bf9177198f62888b17372ae67b4fb4a77c4d325adbbcf6d734385edb0614094be95bb443d84b28f6d79fe70a8acaecdfb44b547bcf86b0
-  data.tar.gz: 815fd1ae302c35fdd0fb31f43bb1d607073a9cfb1f24d3c849578b0b8a5271bca5cbe49f2747bdf7bb22d1a4b98d1fa455c3a917e7d27f059f5a4778da215f87
+  metadata.gz: 6c8e407acf3a35f21b4446b0c0752a754720a7fbd03b887b64c4fe0991e61e6f107f61a2adb2394ac88d24470be5c814c6168cd96106295c777f50a35f77820a
+  data.tar.gz: 1871572ccb876d772eec874ed224235905ba7265ced27319f4e7abd678a65e1862584bd88f0223e2f87ba1b99158342e6c6a2c4d033d758b28338296153f5e4b

data/CHANGELOG.md

@@ -1,3 +1,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/.
+
 ## 0.8.0
 * Upgrade to Krane >= 1.1.4, < 2.0.
 * Remove Krane monkeypatch in ext/.

data/Gemfile

@@ -9,4 +9,5 @@ end
 
 group :test do
   gem 'rspec', '~> 3.0'
+  gem 'timecop', '~> 0.9'
 end

data/lib/kuby.rb

@@ -37,6 +37,8 @@ module Kuby
       @definition.environments.each do |_, env|
         env.kubernetes.after_configuration
       end
+
+      @definition
     end
 
     def environment(name = env)

data/lib/kuby/docker/metadata.rb

@@ -5,6 +5,7 @@ module Kuby
     class Metadata
       DEFAULT_DISTRO = :debian
       DEFAULT_REGISTRY_HOST = 'https://www.docker.com'.freeze
+      DEFAULT_REGISTRY_SCHEME = 'https'
       LATEST_TAG = 'latest'
 
       attr_accessor :image_url
@@ -20,12 +21,7 @@ module Kuby
       end
 
       def image_host
-        @image_host ||= if image_url.include?('/')
-          uri = parse_url(image_url)
-          "#{uri.scheme}://#{uri.host}"
-        else
-          DEFAULT_REGISTRY_HOST
-        end
+        @image_host ||= "#{full_image_uri.scheme}://#{full_image_uri.host}"
       end
 
       def image_hostname
@@ -33,11 +29,7 @@ module Kuby
       end
 
       def image_repo
-        @image_repo ||= if image_url.include?('/')
-          parse_url(image_url).path.sub(/\A\//, '')
-        else
-          image_url
-        end
+        @image_repo ||= full_image_uri.path.sub(/\A[\/]+/, '')
       end
 
       def tags
@@ -76,6 +68,16 @@ module Kuby
 
       private
 
+      def full_image_uri
+        @full_image_uri ||= if image_url.include?('://')
+          URI.parse(image_url)
+        elsif image_url =~ /\A[^.]+\.[^\/]+\//
+          URI.parse("#{DEFAULT_REGISTRY_SCHEME}://#{image_url}")
+        else
+          URI.parse("#{DEFAULT_REGISTRY_HOST}/#{image_url.sub(/\A[\/]+/, '')}")
+        end
+      end
+
       def default_image_url
         # assuming dockerhub by not specifying full url
         @default_image_url ||= environment.app_name.downcase
@@ -92,7 +94,7 @@ module Kuby
         return uri if uri.scheme
 
         # force a scheme because URI.parse won't work properly without one
-        URI.parse("https://#{url}")
+        URI.parse("#{DEFAULT_REGISTRY_SCHEME}://#{url}")
       end
     end
   end

data/lib/kuby/docker/timestamp_tag.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module Kuby
   module Docker
     class TimestampTag
@@ -27,6 +29,10 @@ module Kuby
         time <=> other.time
       end
 
+      def ==(other)
+        time == other.time
+      end
+
       def hash
         time.hash
       end

data/lib/kuby/plugins/rails_app/tasks.rake

@@ -9,8 +9,8 @@ namespace :kuby do
         config_file = File.join(Kuby.environment.kubernetes.plugin(:rails_app).root, 'config', 'database.yml')
         database = Kuby.environment.kubernetes.plugin(:rails_app).database
 
-        if database.respond_to?(:rewritten_configs)
-          File.write(config_file, YAML.dump(database.rewritten_configs))
+        if database.plugin.respond_to?(:rewritten_configs)
+          File.write(config_file, YAML.dump(database.plugin.rewritten_configs))
           Kuby.logger.info("Wrote #{config_file}")
         end
       end

data/lib/kuby/version.rb

@@ -1,3 +1,3 @@
 module Kuby
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/spec/docker/metadata_spec.rb

@@ -0,0 +1,192 @@
+require 'spec_helper'
+require 'timecop'
+
+describe Kuby::Docker::Metadata do
+  let(:metadata) { definition.environment.docker.metadata }
+
+  describe '#image_url' do
+    subject { metadata.image_url }
+
+    it { is_expected.to eq(docker_image_url) }
+
+    context 'when no image URL is configured' do
+      let(:docker_image_url) { nil }
+      it { is_expected.to eq(definition.app_name) }
+    end
+  end
+
+  describe '#image_host' do
+    subject { metadata.image_host }
+
+    it { is_expected.to eq(described_class::DEFAULT_REGISTRY_HOST) }
+
+    context 'when the image URL contains an explicit host' do
+      let(:docker_image_url) { 'registry.foo.com/foo/testapp' }
+
+      it { is_expected.to eq('https://registry.foo.com') }
+    end
+
+    context 'when the image URL contains an explicit host with scheme' do
+      let(:docker_image_url) { 'http://registry.foo.com/foo/testapp' }
+
+      it { is_expected.to eq('http://registry.foo.com') }
+    end
+  end
+
+  describe '#image_repo' do
+    subject { metadata.image_repo }
+
+    it { is_expected.to eq('foo/testapp') }
+
+    context 'when the image URL contains an explicit host' do
+      let(:docker_image_url) { 'registry.foo.com/foo/testapp' }
+
+      it { is_expected.to eq('foo/testapp') }
+    end
+  end
+
+  describe '#image_hostname' do
+    subject { metadata.image_hostname }
+
+    it { is_expected.to eq('www.docker.com') }
+
+    context 'when the image URL contains an explicit host' do
+      let(:docker_image_url) { 'registry.foo.com/foo/testapp' }
+
+      it { is_expected.to eq('registry.foo.com') }
+    end
+  end
+
+  describe '#tags' do
+    subject { metadata.tags }
+
+    it 'specifies the current timestamp tag and the default tag' do
+      Timecop.freeze do
+        expect(subject).to eq([
+          Time.now.strftime('%Y%m%d%H%M%S'),
+          Kuby::Docker::Metadata::LATEST_TAG
+        ])
+      end
+    end
+  end
+
+  describe '#tag' do
+    let(:tag) { make_ts_tag(Time.now) }
+
+    subject { metadata.tag }
+
+    context 'with no local or remote tags' do
+      it 'raises an error' do
+        expect { subject }.to raise_error(Kuby::Docker::MissingTagError)
+      end
+    end
+
+    context 'with an available remote tag' do
+      before { docker_remote_client.tags << tag }
+
+      it { is_expected.to eq(tag) }
+    end
+
+    context 'with an available local tag' do
+      before do
+        docker_cli.build(
+          dockerfile: nil,
+          image_url: docker_image_url,
+          tags: [tag]
+        )
+      end
+
+      it { is_expected.to eq(tag) }
+    end
+
+    context 'with multiple remote tags' do
+      let(:time) { Time.now }
+
+      before do
+        docker_remote_client.tags +=
+          [time - 5, time + 10, time - 10, time + 15].map do |t|
+            make_ts_tag(t)
+          end
+      end
+
+      it { is_expected.to eq(make_ts_tag(time + 15)) }
+    end
+
+    context 'with multiple local and remote tags' do
+      let(:time) { Time.now }
+
+      before do
+        docker_remote_client.tags +=
+          [time - 5, time + 10, time - 10, time + 15].map do |t|
+            make_ts_tag(t)
+          end
+
+        docker_cli.build(
+          dockerfile: nil,
+          image_url: docker_image_url,
+          tags: [time - 3, time + 6, time - 6, time + 18].map do |t|
+            make_ts_tag(t)
+          end
+        )
+      end
+
+      it { is_expected.to eq(make_ts_tag(time + 18)) }
+    end
+  end
+
+  describe '#previous_tag' do
+    let(:time) { Time.now }
+    let(:current_tag) { make_ts_tag(time) }
+
+    before do
+      docker_remote_client.tags << current_tag
+      docker_cli.build(
+        dockerfile: nil,
+        image_url: docker_image_url,
+        tags: [current_tag]
+      )
+    end
+
+    subject { metadata.previous_tag(current_tag) }
+
+    context 'with no previous local or remote tag' do
+      it 'raises an error' do
+        expect { subject }.to raise_error(Kuby::Docker::MissingTagError)
+      end
+    end
+
+    context 'with an available previous remote tag' do
+      let(:previous_tag) { make_ts_tag(time - 5) }
+
+      before { docker_remote_client.tags << previous_tag }
+
+      it { is_expected.to eq(previous_tag) }
+    end
+
+    context 'with an available previous local tag' do
+      let(:previous_tag) { make_ts_tag(time - 5) }
+
+      before do
+        docker_cli.build(
+        dockerfile: nil,
+        image_url: docker_image_url,
+        tags: [previous_tag]
+        )
+      end
+
+      it { is_expected.to eq(previous_tag) }
+    end
+  end
+
+  describe '#distro' do
+    subject { metadata.distro }
+
+    it { is_expected.to eq(Kuby::Docker::Metadata::DEFAULT_DISTRO) }
+
+    context 'with a distro set manually' do
+      before { metadata.distro = :alpine }
+
+      it { is_expected.to eq(:alpine) }
+    end
+  end
+end

data/spec/docker/timestamp_tag_spec.rb

@@ -1,11 +1,61 @@
 require "spec_helper"
 
 describe Kuby::Docker::TimestampTag do
-  context ".try_parse" do
-    it "returns a new timestamp tag" do
-      tag = described_class.try_parse("20200810165134")
+  context '.try_parse' do
+    let(:tag_str) { '20200810165134' }
 
-      expect(tag).to be_kind_of(described_class)
+    it 'creates a new timestamp tag' do
+      tag = described_class.try_parse(tag_str)
+      expect(tag).to be_a(described_class)
+    end
+
+    it 'correctly parses the timestamp contained in the tag' do
+      time = described_class.try_parse(tag_str).time
+      expect([time.year, time.month, time.day, time.hour, time.min, time.sec]).to(
+        eq([2020, 8, 10, 16, 51, 34])
+      )
+    end
+
+    context 'with an invalid tag' do
+      let(:tag_str) { 'abc123' }
+
+      it 'returns nil' do
+        expect(described_class.try_parse(tag_str)).to eq(nil)
+      end
+    end
+  end
+
+  context '#to_s' do
+    it 'serializes the tag as a timestamp' do
+      tag = described_class.new(Time.new(2020, 8, 10, 16, 51, 34))
+      expect(tag.to_s).to eq('20200810165134')
+    end
+  end
+
+  context 'comparison' do
+    it 'ensures tags can be compared by their timestamp values' do
+      seed_time = Time.now
+      times = [seed_time, seed_time + 5, seed_time + 10, seed_time + 15].shuffle
+      tags = times.map { |t| described_class.new(t) }
+      expect(tags.sort.map(&:time)).to eq(times.sort)
+    end
+  end
+
+  context 'equality' do
+    it 'ensures tags with equal times are considered equal' do
+      time = Time.now
+      tag1 = described_class.new(time)
+      tag2 = described_class.new(time)
+      expect(tag1).to eq(tag2)
+      expect(tag1.hash).to eq(tag2.hash)
+    end
+
+    it 'ensures tags with inequal times are not considered equal' do
+      time = Time.now
+      tag1 = described_class.new(time)
+      tag2 = described_class.new(time + 5)
+      expect(tag1).to_not eq(tag2)
+      expect(tag1.hash).to_not eq(tag2.hash)
     end
   end
 end

data/spec/dummy/Gemfile

@@ -0,0 +1,54 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.5.8'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 6.0.3', '>= 6.0.3.2'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3', '~> 1.4'
+# Use Puma as the app server
+gem 'puma', '~> 4.1'
+# Use SCSS for stylesheets
+gem 'sass-rails', '>= 6'
+# Transpile app-like JavaScript. Read more: https://github.com/rails/webpacker
+gem 'webpacker', '~> 4.0'
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+gem 'turbolinks', '~> 5'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.7'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.4.2', require: false
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '~> 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+group :test do
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '>= 2.15'
+  gem 'selenium-webdriver'
+  # Easy installation and use of web drivers to run system tests with browsers
+  gem 'webdrivers'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]