wslc-wip 0.17.1 → 0.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d462bf5f1448a0488b717c963bccd77fc7c9719d29b74b990226179fd26e75f8
-  data.tar.gz: 7c05922ab0abc42995ed495c99704d2dbab435d8ab88ed46c9094a402052abed
+  metadata.gz: c00368614ae5c01c7f514957368d9533f2faf9be114cfd17c676fc70ebfec138
+  data.tar.gz: 86d094ead585366c91633a963d0436a0c68af10f5bda3dace5ab46485f714a4a
 SHA512:
-  metadata.gz: 0cfc54266fde234fceac4dffc6f43968ab27123704040eaf6183dec8c54f25bc33daad08a5bd03a7552554474dc14848162dca40b0ebcde6a785c721632cc0b1
-  data.tar.gz: f4bfd8777b2f23b9f5c688b2d5794219914df74f42e44bb3a99b5c209e32fc262f240803ff5b8c505f427e19c3ee494d035a58fb407a8769c7ef7e9d723c1d14
+  metadata.gz: 99cd7c6e59ccd6b64667ab7a179c240d96577f24296a93b801484f994570d6262ccc30d1535853a6cd7b4fb2a31f5e8145fa227aa637d7d9960f0aa794756a67
+  data.tar.gz: 13a319d2b312f709a5937711bb65d69a560e098bed809e3f5f76fc83bae419983f5f4dbb0ae541e5afa3c93b9a7fd290b9c963378b6f405cd4bb0ceb3900e274

data/lib/wip/build_context.rb

@@ -14,37 +14,39 @@ module Wip
       @ignore = ignore || DockerIgnore.load(@root.join('.dockerignore'))
     end
 
-    def stage
+    # on_progress fires once per file copied, as `|count, total|` — so a caller
+    # can show that staging a large context (thousands of small files can take
+    # tens of seconds) is still moving instead of looking hung.
+    def stage(on_progress: nil)
       return yield @root.to_s if @ignore.empty?
 
       Dir.mktmpdir('wip-build-context-') do |dir|
-        copy_included_files(Pathname(dir))
+        copy_included_files(Pathname(dir), on_progress)
         yield dir
       end
     end
 
     private
 
-    def copy_included_files(destination)
-      each_included_file do |relative_path|
+    def copy_included_files(destination, on_progress)
+      files = included_files
+      files.each_with_index do |relative_path, index|
         target = destination.join(relative_path)
         FileUtils.mkdir_p(target.dirname)
         # Keep links as links. Dereferencing a link here could copy arbitrary
         # host files outside the build context (for example, ~/.ssh/id_rsa)
         # into the staged directory and expose them to the image build.
         FileUtils.copy_entry(@root.join(relative_path), target, false, false, false)
+        on_progress&.call(index + 1, files.size)
       end
     end
 
-    def each_included_file
-      Dir.glob('**/*', File::FNM_DOTMATCH, base: @root.to_s).each do |entry|
-        next if %w[. ..].include?(entry)
+    def included_files
+      Dir.glob('**/*', File::FNM_DOTMATCH, base: @root.to_s).select do |entry|
+        next false if %w[. ..].include?(entry)
 
         path = @root.join(entry)
-        next unless path.file? || path.symlink?
-        next if @ignore.ignored?(entry)
-
-        yield entry
+        (path.file? || path.symlink?) && !@ignore.ignored?(entry)
       end
     end
   end

data/lib/wip/cli.rb

@@ -70,9 +70,14 @@ module Wip
       extra.shift if extra.first == '--'
       settings = load_config.command('build') || {}
       context = settings['context'] || '.'
-      BuildContext.new(context).stage do |staged_context|
+      warn "wip: staging build context (#{context})"
+      progress = StagingProgress.new
+      BuildContext.new(context).stage(on_progress: progress.method(:tick)) do |staged_context|
+        progress.finish
         execute(builder.build(settings: settings.merge('context' => staged_context), extra: extra))
       end
+    ensure
+      progress&.finish
     end
 
     desc 'up', 'Start the configured container and its dependencies, creating them if necessary'
@@ -188,7 +193,11 @@ module Wip
 
     private
 
-    def loader = ConfigLoader.new(path: options[:config])
+    def loader
+      env_file = options[:env_file] && Pathname(options[:env_file]).expand_path
+      ConfigLoader.new(path: options[:config], env_file: env_file)
+    end
+
     def load_config = (@load_config ||= loader.load)
     def resolver = CommandResolver.new
 

data/lib/wip/compose_file.rb

@@ -30,8 +30,11 @@ module Wip
     BUILD_KEYS = %w[context dockerfile args].freeze
     SUPPORTED_CONDITIONS = %w[service_started].freeze
 
-    def self.load(path)
-      raw = YAML.safe_load_file(path, aliases: true)
+    # env interpolates compose.yml's ${VAR} references the way `docker compose` does,
+    # so values like `user: ${USER_ID}:${GROUP_ID}` reach wslc already substituted
+    # instead of literally (see Config#compose_interpolation_env for what's passed in).
+    def self.load(path, env: {})
+      raw = VariableInterpolation.tree(YAML.safe_load_file(path, aliases: true), env)
       raise ConfigError, "#{path}: services: must be a mapping" unless raw.is_a?(Hash) && raw['services'].is_a?(Hash)
 
       new(raw['services'], path: path)

data/lib/wip/config.rb

@@ -19,9 +19,10 @@ module Wip
     MODES = %w[container compose compose-native].freeze
     attr_reader :path
 
-    def initialize(raw, path = nil)
+    def initialize(raw, path = nil, env_file = nil)
       @raw = stringify(raw)
       @path = path
+      @env_file = env_file
       validate!
     end
 
@@ -202,7 +203,20 @@ module Wip
     def presence(value) = value.to_s.empty? ? nil : value.to_s
 
     def parsed_compose_file
-      @parsed_compose_file ||= ComposeFile.load(ComposeBridge.file_path(self))
+      @parsed_compose_file ||= ComposeFile.load(ComposeBridge.file_path(self), env: compose_interpolation_env)
+    end
+
+    # Compose interpolates ${VAR} references in compose.yml from the shell environment
+    # and a project .env file, shell values winning on conflict — mirror that here so
+    # `wip` doesn't need the value duplicated into wip.yml just to resolve a compose.yml
+    # reference. Uses the same dotenv file --env-file/DotenvLoader would (explicit
+    # override, else .env next to wip.yml), so compose interpolation and the env
+    # actually passed to containers never see two different .env files.
+    def compose_interpolation_env
+      env_file = @env_file || (path && Pathname(path).dirname.join('.env'))
+      return ENV.to_h unless env_file
+
+      DotenvLoader.new(env_file).load.merge(ENV.to_h)
     end
 
     def default_compose_network = path && Pathname(path).dirname.basename.to_s

data/lib/wip/config_loader.rb

@@ -8,9 +8,10 @@ module Wip
   class ConfigLoader
     FILENAME = 'wip.yml'
 
-    def initialize(start_dir: Dir.pwd, path: nil)
+    def initialize(start_dir: Dir.pwd, path: nil, env_file: nil)
       @start_dir = Pathname(start_dir).expand_path
       @path = path
+      @env_file = env_file
     end
 
     def find
@@ -28,7 +29,7 @@ module Wip
       raise ConfigError, "wip.yml was not found (searched from #{@start_dir} to the filesystem root)" unless path&.file?
 
       data = YAML.safe_load_file(path, permitted_classes: [], aliases: false) || {}
-      Config.new(data, path)
+      Config.new(data, path, @env_file)
     rescue Psych::Exception => e
       raise ConfigError, "Could not parse #{path}: #{e.message}"
     end

data/lib/wip/staging_progress.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Wip
+  # Prints a self-overwriting "copying build context files: N/total" line, at
+  # most every half second, while a slow, silent step (staging a large build
+  # context file by file can take tens of seconds) is still moving — so it
+  # doesn't read as hung.
+  class StagingProgress
+    def initialize(out: $stderr, interval: 0.5)
+      @out = out
+      @interval = interval
+      # Backdated so the very first tick always prints immediately, rather
+      # than waiting a full interval before the first sign of life.
+      @last = Process.clock_gettime(Process::CLOCK_MONOTONIC) - interval
+      @printed = false
+    end
+
+    def tick(count, total)
+      now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      return if now - @last < @interval && count != total
+
+      @last = now
+      @printed = true
+      @out.print "\rwip: copying build context files: #{count}/#{total}"
+    end
+
+    # Idempotent: a caller can't know in advance whether tick ever fired.
+    def finish
+      return unless @printed
+
+      @printed = false
+      @out.puts
+    end
+  end
+end

data/lib/wip/variable_interpolation.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Wip
+  # Interpolates ${VAR} references the way `docker compose` does when reading
+  # compose.yml: ${VAR}, ${VAR:-default}/${VAR-default}, bare $VAR, and $$ as an
+  # escaped literal dollar sign. ${VAR:?err}/${VAR:+alt} aren't recognized by
+  # PATTERN at all, so — unlike an unset $VAR/${VAR}, which this resolves to an
+  # empty string — they pass through completely unchanged, "${...}" and all.
+  module VariableInterpolation
+    PATTERN = /\$\$|\$\{([A-Za-z_][A-Za-z0-9_]*)((:-|-)([^}]*))?\}|\$([A-Za-z_][A-Za-z0-9_]*)/
+
+    def self.call(text, env)
+      text.gsub(PATTERN) do |matched|
+        next '$' if matched == '$$'
+
+        name, _, operator, default, bare_name = Regexp.last_match.captures
+        resolve(env[name || bare_name], operator, default)
+      end
+    end
+
+    # Walks an already-parsed YAML structure and interpolates string values only —
+    # real Compose interpolates YAML values, never mapping keys (its docs call this
+    # out explicitly), and doing this after parsing means a substituted value can't
+    # introduce YAML syntax (e.g. a literal "#" turning into a comment marker).
+    #
+    # `seen` tracks Hash/Array objects on the current recursion path (by identity,
+    # not #==) so a self-referential YAML alias — ComposeFile.load parses with
+    # aliases: true — raises instead of recursing until SystemStackError. The same
+    # object reached again from a *different* branch (an anchor reused, not a
+    # cycle) is fine: it's removed from `seen` once its own subtree finishes.
+    def self.tree(value, env, seen = {}.compare_by_identity)
+      case value
+      when String then call(value, env)
+      when Hash, Array then walk_container(value, env, seen)
+      else value
+      end
+    end
+
+    def self.walk_container(value, env, seen)
+      raise ConfigError, 'compose.yml contains a self-referential YAML alias' if seen.key?(value)
+
+      seen[value] = true
+      begin
+        value.is_a?(Hash) ? value.transform_values { |v| tree(v, env, seen) } : value.map { |v| tree(v, env, seen) }
+      ensure
+        seen.delete(value)
+      end
+    end
+    private_class_method :walk_container
+
+    def self.resolve(value, operator, default)
+      case operator
+      when ':-' then value.nil? || value.empty? ? default.to_s : value
+      when '-' then value.nil? ? default.to_s : value
+      else value.to_s
+      end
+    end
+    private_class_method :resolve
+  end
+end

data/lib/wip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wip
-  VERSION = '0.17.1'
+  VERSION = '0.17.3'
 end

data/lib/wip.rb

@@ -9,10 +9,12 @@ require_relative 'wip/environment'
 require_relative 'wip/dotenv_loader'
 require_relative 'wip/docker_ignore'
 require_relative 'wip/build_context'
+require_relative 'wip/staging_progress'
 require_relative 'wip/command_resolver'
 require_relative 'wip/error_interpreter'
 require_relative 'wip/command_builder'
 require_relative 'wip/compose_bridge'
+require_relative 'wip/variable_interpolation'
 require_relative 'wip/compose_file'
 require_relative 'wip/initializer'
 require_relative 'wip/command_display'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wslc-wip
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.17.3
 platform: ruby
 authors:
 - Wip contributors
@@ -52,7 +52,9 @@ files:
 - lib/wip/errors.rb
 - lib/wip/initializer.rb
 - lib/wip/resource_monitor.rb
+- lib/wip/staging_progress.rb
 - lib/wip/sync_settings.rb
+- lib/wip/variable_interpolation.rb
 - lib/wip/version.rb
 homepage: https://wslc-wip.slidict.com/
 licenses: