on_container 0.0.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f61b63568e23e08af3c0129b1df76cc8a74afa5b8eb9e26ed844e1569329776e
-  data.tar.gz: a861e643c984f81524645ab76001871da968b5225a7a04d1f3183a186fdd008e
+SHA1:
+  metadata.gz: 49a6b84a56344cf0119b822fd9f12277bb66fe70
+  data.tar.gz: 6676d161e20a802d3f75c765e04bfd6b0969972c
 SHA512:
-  metadata.gz: 29c67a715453468d37fad0651d1e2e44874221d9610487ef201167d918ef30d27fcf0c96377c3ccf449f0c1684027ca8934e8f248fc9c07a5f5a74f03a1b42a6
-  data.tar.gz: a9487e81209640d5e6927f8f764d51649fcd7d7c06b9d48efa6083e00cdeff78be0804f0f69168c5eb205c76afff98003ce6eba42e6f40e862060110f2fab554
+  metadata.gz: 9aa5a059a7ba11f6f658c08d32ead851ab667ad3c894f5442cd795febc3c8e6c9e65f1e8d126708a6a2a0702d18661e043a600768522caadc8cf90ae119f0c90
+  data.tar.gz: 6916cb665fa674c90a43634f2cf5bce4632c105c862f44caf8b08200b486440f305fc9f2ca01af4220ba59e87ef15b43969072b900e0c198f290c336ff341580

data/README.md

@@ -22,7 +22,71 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Development Routines & Docker Entrypoint Scripts
+
+We use some routines included in this gem to create compelling development entrypoint scripts for docker development containers.
+
+In this example, we'll be using the `on_container/dev/rails` routine bundle to create our dev entrypoint:
+
+```ruby
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'on_container/dev/rails'
+
+set_given_or_default_command
+
+# `on_setup_lock_acquired` prevents multiple app containers from running
+# the setup process concurrently:
+on_setup_lock_acquired do
+  ensure_project_gems_are_installed
+  ensure_project_node_packages_are_installed
+
+  wait_for_service_to_accept_connections 'tcp://postgres:5432'
+  setup_activerecord_database unless activerecord_database_ready?
+
+  remove_rails_pidfile if rails_server?
+end if command_requires_setup?
+
+execute_given_or_default_command
+```
+
+### Loading secrets into environment variables, and inserting credentials into URL environment variables
+
+When using Docker Swarm, the secrets are loaded as files mounted into the container's filesystem.
+
+The `on_container/load_env_secrets` runs a couple of routines that reads these files into environment variables.
+
+For our Rails example app, we added the following line to the `config/boot.rb` file:
+
+```ruby
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'on_container/load_env_secrets' # Load secrets injected by Kubernetes/Swarm
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+require 'bootsnap/setup' # Speed up boot time by caching expensive operations.
+```
+
+The `on_container/load_env_secrets` also merges any credential available in environment variables into any matching
+`_URL` environment variable. For example, consider the following environment variables:
+
+```shell
+DATABASE_URL=postgres://postgres:5432/?encoding=unicode
+DATABASE_USER=postgres
+DATABASE_PASS=3x4mpl3P455w0rd
+```
+
+The routine will merge `DATABASE_USER` and `DATABASE_PASS` into `DATABASE_URL`:
+
+```ruby
+puts ENV['DATABASE_URL']
+> postgres://postgres:3x4mpl3P455w0rd@postgres:5432/?encoding=unicode
+```
+
 
 ## Development
 

data/lib/on_container/dev/active_record_ops.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+
+module OnContainer
+  module Dev
+    module ActiveRecordOps
+      def app_setup_wait
+        ENV.fetch('APP_SETUP_WAIT', '5').to_i
+      end
+
+      def parse_activerecord_config_file
+        require 'erb'
+        require 'yaml'
+
+        database_yaml = Pathname.new File.expand_path('config/database.yml')
+        loaded_yaml = YAML.load(ERB.new(database_yaml.read).result) || {}
+        shared = loaded_yaml.delete('shared')
+      
+        loaded_yaml.each { |_k, values| values.reverse_merge!(shared) } if shared
+        Hash.new(shared).merge(loaded_yaml)
+      end
+      
+      def activerecord_config
+        @activerecord_config ||= parse_activerecord_config_file 
+          .fetch ENV.fetch('RAILS_ENV', 'development')
+      end
+      
+      def establish_activerecord_database_connection
+        require 'active_record' unless defined?(ActiveRecord)
+        ActiveRecord::Base.establish_connection activerecord_config
+        ActiveRecord::Base.connection_pool.with_connection { |connection| }
+      end
+      
+      def activerecord_database_initialized?
+        ActiveRecord::Base.connection_pool.with_connection do |connection|
+          connection.data_source_exists? :schema_migrations
+        end
+      end
+      
+      def activerecord_database_ready?
+        connection_tries ||= 3
+
+        establish_activerecord_database_connection
+        activerecord_database_initialized?
+      
+      rescue PG::ConnectionBad
+        unless (connection_tries -= 1).zero?
+          puts "Retrying DB connection #{connection_tries} more times..."
+          sleep app_setup_wait
+          retry
+        end
+        false
+      
+      rescue ActiveRecord::NoDatabaseError
+        false
+      end
+      
+      def setup_activerecord_database
+        system 'rails db:setup'
+      end
+    end
+  end
+end
+

data/lib/on_container/dev/bundler_ops.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OnContainer
+  module Dev
+    module BundlerOps
+      def bundle_path
+        '/usr/local/bundle'
+      end
+  
+      def bundle_owner_id
+        File.stat(bundle_path).uid
+      end
+  
+      def current_user_id
+        Etc.getpwuid.uid
+      end
+  
+      def bundle_belongs_to_current_user?
+        bundle_owner_id == current_user_id
+      end
+      
+      def make_bundle_belong_to_current_user
+        target_ownership = "#{current_user_id}:#{current_user_id}"
+        system "sudo chown -R #{target_ownership} #{bundle_path}"
+      end
+      
+      def ensure_bundle_belongs_to_current_user
+        return if bundle_belongs_to_current_user?
+      
+        make_bundle_belong_to_current_user
+      end
+
+      def ensure_project_gems_are_installed
+        ensure_bundle_belongs_to_current_user
+
+        system 'bundle check || bundle install'
+      end
+    end
+  end
+end

data/lib/on_container/dev/container_command_ops.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OnContainer
+  module Dev
+    module ContainerCommandOps
+      def set_given_or_default_command
+        ARGV.concat %w[rails server -p 3000 -b 0.0.0.0] if ARGV.empty?
+      end
+      
+      def execute_given_or_default_command
+        exec(*ARGV)
+      end
+    end
+  end
+end
+

data/lib/on_container/dev/node_modules_ops.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'etc'
+
+module OnContainer
+  module Dev
+    module NodeModulesOps
+      APP_PATH = File.expand_path '.'
+  
+      def node_modules_path
+        "#{APP_PATH}/node_modules"
+      end
+  
+      def node_modules_owner_id
+        File.stat(node_modules_path).uid
+      end
+  
+      def current_user_id
+        Etc.getpwuid.uid
+      end
+  
+      def node_modules_belong_to_current_user?
+        node_modules_owner_id == current_user_id
+      end
+      
+      def make_node_modules_belong_to_current_user
+        target_ownership = "#{current_user_id}:#{current_user_id}"
+        system "sudo chown -R #{target_ownership} #{node_modules_path}"
+      end
+      
+      def ensure_node_modules_belong_to_current_user
+        return if node_modules_belong_to_current_user?
+      
+        make_node_modules_belong_to_current_user
+      end
+  
+      def ensure_project_node_packages_are_installed
+        ensure_node_modules_belong_to_current_user
+
+        system 'yarn check --integrity || yarn install'
+      end
+    end
+  end
+end

data/lib/on_container/dev/rails.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'on_container/dev/rails_ops'
+require 'on_container/dev/setup_ops'
+require 'on_container/dev/bundler_ops'
+require 'on_container/dev/node_modules_ops'
+require 'on_container/dev/active_record_ops'
+require 'on_container/dev/container_command_ops'
+
+include OnContainer::Dev::RailsOps
+include OnContainer::Dev::SetupOps
+include OnContainer::Dev::BundlerOps
+include OnContainer::Dev::NodeModulesOps
+include OnContainer::Dev::ActiveRecordOps
+include OnContainer::Dev::ContainerCommandOps
+
+require 'on_container/ops/service_connection_checks'
+
+include OnContainer::Ops::ServiceConnectionChecks

data/lib/on_container/dev/rails_ops.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OnContainer
+  module Dev
+    module RailsOps
+      def remove_rails_pidfile
+        system "rm -rf #{File.expand_path('tmp/pids/server.pid')}"
+      end
+      
+      def rails_server?
+        ARGV[0] == 'rails' && %w[server s].include?(ARGV[1])
+      end
+    end
+  end
+end

data/lib/on_container/dev/setup_ops.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module OnContainer
+  module Dev
+    module SetupOps
+      APP_PATH = File.expand_path '.'
+  
+      def app_temp_path; "#{APP_PATH}/tmp"; end
+      def app_setup_wait; ENV.fetch('APP_SETUP_WAIT', '5').to_i; end
+      def app_setup_lock_path; "#{app_temp_path}/setup.lock"; end
+  
+      def lock_setup
+        system "mkdir -p #{app_temp_path} && touch #{app_setup_lock_path};"
+      end
+      
+      def unlock_setup
+        system "rm -rf #{app_setup_lock_path}"
+      end
+      
+      def wait_setup
+        puts 'Waiting for app setup to finish...'
+        sleep app_setup_wait
+      end
+
+      def on_setup_lock_acquired
+        wait_setup while File.exist?(app_setup_lock_path)
+
+        lock_setup
+
+        %w[HUP INT QUIT TERM EXIT].each do |signal_string|
+          Signal.trap(signal_string) { unlock_setup }
+        end
+
+        yield
+
+      ensure
+        unlock_setup
+      end
+
+      def command_requires_setup?
+        %w[
+          rails rspec sidekiq hutch puma rake webpack webpack-dev-server
+        ].include?(ARGV[0])
+      end
+    end
+  end
+end

data/lib/on_container/load_env_secrets.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Reads the specified secret paths (i.e. Docker Secrets) into environment
+# variables:
+
+require 'active_support'
+require 'active_support/core_ext/object'
+
+# Process only a known list of env vars that can filled by reading a file (i.e.
+# a docker secret):
+Dir["#{ENV.fetch('SECRETS_PATH', '/run/secrets/')}*"].each do |secret_filepath|
+  next unless File.file?(secret_filepath)
+
+  secret_envvarname = File.basename(secret_filepath, '.*').upcase
+
+  # Skip if variable is already set - already-set variables have precedence over
+  # the secret files:
+  next if ENV.key?(secret_envvarname) && ENV[secret_envvarname].present?
+
+  ENV[secret_envvarname] = File.read(secret_filepath).strip
+end
+
+# For each *_URL environment variable where there's also a *_(USER|USERNAME) or
+# *_(PASS|PASSWORD), update the URL environment variable with the given
+# credentials. For example:
+#
+# DATABASE_URL: postgres://postgres:5432/demo_production
+# DATABASE_USERNAME: lalito
+# DATABASE_PASSWORD: lepass
+#
+# Results in the following updated DATABASE_URL:
+#  DATABASE_URL = postgres://lalito:lepass@postgres:5432/demo_production
+require 'uri' if (url_keys = ENV.keys.select { |key| key =~ /_URL/ }).any?
+
+url_keys.each do |url_key|
+  credential_pattern_string = url_key.gsub('_URL', '_(USER(NAME)?|PASS(WORD)?)')
+  credential_pattern = Regexp.new "\\A#{credential_pattern_string}\\z"
+  credential_keys = ENV.keys.select { |key| key =~ credential_pattern }
+  next unless credential_keys.any?
+
+  uri = URI(ENV[url_key])
+  username = URI.encode_www_form_component ENV[credential_keys.detect { |key| key =~ /USER/ }]
+  password = URI.encode_www_form_component ENV[credential_keys.detect { |key| key =~ /PASS/ }]
+
+  uri.user = username if username
+  uri.password = password if password
+  ENV[url_key] = uri.to_s
+end
+
+# STDERR.puts ENV.inspect

data/lib/on_container/ops/service_connection_checks.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'timeout'
+require 'uri'
+
+module OnContainer
+  module Ops
+    module ServiceConnectionChecks
+      def service_accepts_connections?(service_uri, seconds_to_wait = 30)
+        uri = URI(service_uri)
+
+        Timeout::timeout(seconds_to_wait) do
+          TCPSocket.new(uri.host, uri.port).close
+        rescue Errno::ECONNREFUSED
+          retry
+        end
+
+        true
+
+      rescue => e
+        puts "Connection to #{uri.to_s} failed: '#{e.inspect}'"
+      end
+      
+      def wait_for_service_to_accept_connections(service_uri, seconds_to_wait = 30, exit_on_fail = true)
+        wait_loop = Thread.new do
+          loop do
+            sleep(5)
+            puts "Waiting for #{service_uri} to accept connections..."
+          end
+        end
+
+        if service_accepts_connections?(service_uri, seconds_to_wait)
+          return wait_loop.exit
+        else
+          exit 1 if exit_on_fail
+        end
+      end
+    end
+  end
+end

data/lib/on_container/step_down_from_root.rb

@@ -26,11 +26,11 @@ module OnContainer
     end
 
     def developer_uid?
-      developer_uid_as_integer > 0
+      developer_uid > 0
     end
 
     def developer_uid
-      @developer_uid ||= ENV['DEVELOPER_UID'].to_i
+      @developer_uid ||= ENV.fetch('DEVELOPER_UID', '').to_i
     end
 
     protected
@@ -38,7 +38,7 @@ module OnContainer
     def switch_to_developer_user
       target_user_name = target_user.name
       puts "Switching from 'root' user to '#{target_user_name}'..."
-      exec 'su-exec', target_user_name, $0, *$*
+      Kernel.exec 'su-exec', target_user_name, $0, *$*
     end
 
     def warn_no_developer_uid

data/lib/on_container/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OnContainer
-  VERSION = '0.0.1'
+  VERSION = '0.0.7'
 end

data/spec/on_container_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe OnContainer do
+  it "has a version number" do
+    expect(OnContainer::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "on_container"
+
+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

data/spec/step_down_from_root_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'on_container/step_down_from_root'
+
+RSpec.describe OnContainer::StepDownFromRoot do
+  let(:root_user) do
+    instance_double "struct Etc::Passwd",
+                    name: 'root',
+                    passwd: 'x',
+                    uid: 0,
+                    gid: 0,
+                    gecos: 'root',
+                    dir: '/root',
+                    shell: '/bin/bash'
+  end
+
+  let(:developer_user) do
+    instance_double "struct Etc::Passwd",
+                    name: 'developer',
+                    passwd: 'x',
+                    uid: 1000,
+                    gid: 1000,
+                    gecos: 'Developer User,,,',
+                    dir: '/usr/src',
+                    shell: '/bin/bash'
+  end
+
+  let(:example_current_user) { root_user }
+  let(:example_target_user) { developer_user }
+  let(:example_developer_uid) { '1000' }
+
+  before do
+    allow(ENV).to receive(:fetch).with('DEVELOPER_UID', '') { example_developer_uid }
+    allow(Etc).to receive(:getpwuid) { example_current_user }
+    allow(Etc).to receive(:getpwuid).with(example_target_user.uid) { example_target_user }
+    allow(Kernel).to receive(:exec).with('su-exec', example_target_user.name, any_args)
+  end
+
+  describe '#perform' do
+    it 'changes to the target user' do
+      subject.perform
+      expect(Kernel).to have_received(:exec).with 'su-exec', example_target_user.name, any_args
+    end
+
+    context 'without a developer uid' do
+      let(:example_developer_uid) { '' }
+      
+      example 'does not change the current user' do
+        subject.perform
+        expect(Kernel).not_to have_received(:exec)
+      end
+    end
+
+    context 'when not as root' do
+      let(:example_current_user) { developer_user }
+      
+      example 'does not change the current user' do
+        subject.perform
+        expect(Kernel).not_to have_received(:exec)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: on_container
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.7
 platform: ruby
 authors:
 - Roberto Quintanilla
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,9 +38,21 @@ files:
 - README.md
 - Rakefile
 - lib/on_container.rb
+- lib/on_container/dev/active_record_ops.rb
+- lib/on_container/dev/bundler_ops.rb
+- lib/on_container/dev/container_command_ops.rb
+- lib/on_container/dev/node_modules_ops.rb
+- lib/on_container/dev/rails.rb
+- lib/on_container/dev/rails_ops.rb
+- lib/on_container/dev/setup_ops.rb
+- lib/on_container/load_env_secrets.rb
+- lib/on_container/ops/service_connection_checks.rb
 - lib/on_container/step_down_from_root.rb
 - lib/on_container/version.rb
 - on_container.gemspec
+- spec/on_container_spec.rb
+- spec/spec_helper.rb
+- spec/step_down_from_root_spec.rb
 homepage: https://github.com/IcaliaLabs/on-container-for-ruby
 licenses:
 - MIT
@@ -64,9 +76,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: A small collection of scripts and routines to help ruby development within
   containers
-test_files: []
+test_files:
+- spec/on_container_spec.rb
+- spec/spec_helper.rb
+- spec/step_down_from_root_spec.rb