wslc-wip 0.17.6 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adf27a8bafbb2482bfe25b393e3623a39fd0c8d77f92a7c6e6e60286506c8f17
-  data.tar.gz: 77d180849706ea0915e82c03a7bfcae6d5ee0c581a87db808e3eceacdb0b8210
+  metadata.gz: 44cc7065b814848fed40e76cd95c640a7722a3b56834c76be1382f99fc8881bf
+  data.tar.gz: fc400d2a47818ec0a70d0bc5afba7b13afe93bbfbc54728c1446b844351873c9
 SHA512:
-  metadata.gz: f894b61d72a792604221a0bc41c5bef018cb2257ee7469d958f17f96fd5de57e52f2a1665b74e51bfbbd3e6cea6ba9f684f42a4ab64747462098c4742b7cd350
-  data.tar.gz: 68201cce4009583ffee442f06858d930a9d618a399553fbf04523281c8012630e0c8bedc1517012b5f9afca9896612d42829206303943b5548118d0a2d960d17
+  metadata.gz: bf14d601c1e35a60deb8d242b072d76f87fdd40e14381e9f890d2f0f6235daf43eddab7692fce1e90d1dc199892b3b935f2452d3d101cffc39b8767798115275
+  data.tar.gz: 2a995ceea7b96839811d2de3f99619174bc215b78303b2061ca9c95995d62e992949fbfd1cf39e03e9ea3314a2f036a9149dcd0c78ebdfa3939b8bc17e86a6d1

data/README.md

@@ -370,8 +370,9 @@ valid compose.yml over sections it doesn't need to look at:
 | `wip version` | wip's version, plus WSLC's if it can be detected |
 | `wip doctor` | Diagnose WSL2, interop, WSLC, config, architecture, and Git |
 | `wip config` | Print the effective configuration (secrets masked) |
-| `wip build [--no-cache] [-- OPTIONS]` | Build the image from the `build` definition. By default, wip passes the target tag as `--cache-from` so previous layers can be reused; `--no-cache` disables that cache path. |
+| `wip build [--no-cache] [-- OPTIONS]` | Build the image from the `build` definition. `wslc build` reuses matching local layers by default; `--no-cache` disables that. |
 | `wip up [-d] [--no-sync] [--no-cache]` | Start the primary `dependencies:` entry (`container:` names which one) and its sidecars (creating any that are missing, on `network:` if set). `-d` runs the main container in the background; with `sync:` configured, the source is mirrored into the volume first unless `--no-sync` |
+| `wip stop` | Stop the primary container and its sidecar `dependencies:` without removing them |
 | `wip down` | Stop and remove the primary container and its sidecar `dependencies:` |
 | `wip exec [--no-interactive] COMMAND...` | Run a command in the existing container |
 | `wip run [--no-interactive] COMMAND...` | Run a command in a new `--rm` container (mode: compose `exec`s into `compose.service` instead — see "Compose mode" above) |

data/lib/wip/cli.rb

@@ -119,14 +119,22 @@ module Wip
       warn "\nwip: sync stopped"
     end
 
+    desc 'stop', 'Stop the configured container and its dependencies without removing them'
+    def stop
+      return execute(compose_bridge.stop, exit_on_failure: false) if load_config.compose?
+
+      execute(builder.stop, exit_on_failure: false)
+      sidecar_names.each do |name|
+        execute(builder.dependency_stop(name), exit_on_failure: false)
+      end
+    end
+
     desc 'down', 'Stop and remove the configured container and its dependencies'
     def down
       return execute(compose_bridge.down, exit_on_failure: false) if load_config.compose?
 
-      execute(builder.down, exit_on_failure: false)
       execute(builder.remove, exit_on_failure: false)
       sidecar_names.each do |name|
-        execute(builder.dependency_down(name), exit_on_failure: false)
         execute(builder.dependency_remove(name), exit_on_failure: false)
       end
     end

data/lib/wip/command_builder.rb

@@ -84,10 +84,6 @@ module Wip
       [@wslc, 'exec', required_container, *required_sync.mirror_command]
     end
 
-    def down
-      [@wslc, 'stop', required_container]
-    end
-
     # Only reachable under mode: compose-native — mode: compose delegates `wip logs`
     # to the external compose command's own `logs` (ComposeBridge#logs) instead.
     # Single container only, mirroring `wslc`/docker's own `logs`: there's no
@@ -98,6 +94,10 @@ module Wip
       command.push(name.to_s)
     end
 
+    def stop
+      [@wslc, 'stop', required_container]
+    end
+
     def remove
       [@wslc, 'remove', '-f', required_container]
     end
@@ -128,7 +128,7 @@ module Wip
       [@wslc, 'list', '--all', '--filter', "name=#{name}", '--format', 'json']
     end
 
-    def dependency_down(name)
+    def dependency_stop(name)
       [@wslc, 'stop', name.to_s]
     end
 
@@ -136,14 +136,16 @@ module Wip
       [@wslc, 'remove', '-f', name.to_s]
     end
 
+    # `wslc build` reuses matching local layers by default (like `docker build`
+    # without `--pull`) — it has no `--cache-from` flag to ask for that explicitly,
+    # and passing one is a hard error (unrecognized argument).
     def build(settings:, extra: [])
       values = primary_values.merge(settings)
       context = values['context'] || '.'
       tag = values['tag'] || values['image']
       raise ConfigError, 'Build image/tag must not be empty' if tag.to_s.empty?
 
-      cache_options = extra.include?('--no-cache') ? [] : ['--cache-from', tag]
-      [@wslc, 'build', '-t', tag, *cache_options, *extra, context]
+      [@wslc, 'build', '-t', tag, *extra, context]
     end
 
     def custom(name, arguments)

data/lib/wip/compose_bridge.rb

@@ -45,6 +45,8 @@ module Wip
       command
     end
 
+    def stop = base.push('stop')
+
     def down = base.push('down')
 
     def exec(service, arguments, interactive: true)

data/lib/wip/compose_file.rb

@@ -15,20 +15,18 @@ module Wip
   # "Compose mode (native)") — once wslc ships that support, or a
   # compose-for-wslc tool reliably supports `run`.
   class ComposeFile
-    Service = Struct.new(:image, :build, :command, :env, :ports, :volumes, :workdir, :user, :depends_on,
+    Service = Struct.new(:image, :build, :command, :env, :ports, :volumes, :workdir, :user, :depends_on, :profiles,
                          keyword_init: true)
 
-    SERVICE_KEYS = %w[image build command environment ports volumes working_dir user depends_on].freeze
+    SERVICE_KEYS = %w[image build command environment ports volumes working_dir user depends_on profiles].freeze
     # Real Compose keys that read as meaningful here but have nothing to map onto: TTY/stdin
-    # allocation is already decided per invocation (see CommandBuilder#tty?), not fixed per
-    # service; there's no per-service network to join beyond the one project network `network`
-    # (config.rb) already puts every service on; `wslc run`/`exec` has no restart-policy or
-    # capability flag to forward `restart:`/`cap_add:` to; and `profiles:` gates which services a
-    # real `docker compose up` starts by default, which doesn't apply here since wip never starts
-    # "every service" — only `compose.service` and whatever it reaches via `depends_on`.
-    IGNORED_SERVICE_KEYS = %w[tty stdin_open networks restart cap_add profiles].freeze
+    # allocation is decided per invocation (CommandBuilder#tty?), not per service; every
+    # service already shares one project network (config.rb); and `wslc run`/`exec` has no
+    # restart-policy or capability flag to forward `restart:`/`cap_add:` to.
+    IGNORED_SERVICE_KEYS = %w[tty stdin_open networks restart cap_add].freeze
     BUILD_KEYS = %w[context dockerfile args].freeze
     SUPPORTED_CONDITIONS = %w[service_started].freeze
+    LIST_HINT = 'only supports short syntax ("host:container"), not long-syntax mappings'
 
     # env interpolates compose.yml's ${VAR} references the way `docker compose` does,
     # so values like `user: ${USER_ID}:${GROUP_ID}` reach wslc already substituted
@@ -53,9 +51,13 @@ module Wip
 
     def service_names_in_dependency_order = @order.dup
 
+    # True if `name` is gated behind profiles: (wip has no --profile flag); false for an unknown name.
+    def profiled?(name) = @services[name.to_s]&.profiles&.any? || false
+
     # name => {context:, dockerfile:, tag:} for every service with a build:.
+    # Profile-gated services are skipped — see #startable_order.
     def build_specs
-      @order.filter_map do |name|
+      startable_order.filter_map do |name|
         service = @services.fetch(name)
         next unless service.build
 
@@ -66,7 +68,7 @@ module Wip
     # Shaped like Config::DEPENDENCY_DEFAULTS expects: image/command/env/ports/volumes/workdir,
     # in dependency order so callers iterating sidecars start them before their dependents.
     def to_dependencies_hash
-      @order.to_h do |name|
+      startable_order.to_h do |name|
         service = @services.fetch(name)
         [name, { 'image' => service.build ? image_tag(name, service) : service.image, 'command' => service.command,
                  'env' => service.env, 'ports' => service.ports, 'volumes' => service.volumes,
@@ -76,6 +78,10 @@ module Wip
 
     private
 
+    # A profile-gated service (see #profiled?) is never among the ones wip starts
+    # on its own, but still participates in #topological_order/depends_on validation.
+    def startable_order = @order.reject { |name| profiled?(name) }
+
     # A service naming both `build:` and `image:` builds via the former and tags the
     # result with the latter (real Compose's own rule for that combination), instead
     # of the auto-generated tag a build:-only service gets.
@@ -96,7 +102,8 @@ module Wip
 
     def normalize_service_lists(name, entry)
       { ports: normalize_list(name, entry['ports'], 'ports'),
-        volumes: normalize_list(name, entry['volumes'], 'volumes') }
+        volumes: normalize_list(name, entry['volumes'], 'volumes'),
+        profiles: normalize_list(name, entry['profiles'], 'profiles', hint: 'must be an array of strings') }
     end
 
     def image_or_build(name, entry)
@@ -129,10 +136,8 @@ module Wip
 
     def normalize_build_mapping(name, value)
       unknown = value.keys.map(&:to_s) - BUILD_KEYS
-      if unknown.any?
-        raise ConfigError,
-              "#{@path}: services.#{name}.build has unsupported key(s): #{unknown.join(', ')}"
-      end
+      raise ConfigError, "#{@path}: services.#{name}.build has unsupported key(s): #{unknown.join(', ')}" \
+        unless unknown.empty?
 
       context = resolve_context(presence(value['context']) || '.')
       dockerfile = presence(value['dockerfile'])
@@ -179,13 +184,12 @@ module Wip
       end
     end
 
-    def normalize_list(name, value, key)
+    def normalize_list(name, value, key, hint: LIST_HINT)
       return [] unless value
       raise ConfigError, "#{@path}: services.#{name}.#{key} must be an array" unless value.is_a?(Array)
-      if value.any?(Hash)
-        raise ConfigError, "#{@path}: services.#{name}.#{key} only supports short syntax (\"host:container\"), " \
-                           'not long-syntax mappings'
-      end
+
+      nested = value.any? { |item| item.is_a?(Hash) || item.is_a?(Array) }
+      raise ConfigError, "#{@path}: services.#{name}.#{key} #{hint}" if nested
 
       value.map(&:to_s)
     end
@@ -209,10 +213,18 @@ module Wip
       dep.to_s
     end
 
+    # Also rejects a startable (unprofiled) service depending on a profile-gated one —
+    # with no profile activation, real Compose treats that as an invalid model, since
+    # the dependency would silently never start.
     def validate_depends_on!
       @services.each do |name, service|
         service.depends_on.each do |dep|
           raise ConfigError, "#{@path}: services.#{name} depends_on unknown service '#{dep}'" unless @services.key?(dep)
+          next if service.profiles.any? || !profiled?(dep)
+
+          raise ConfigError, "#{@path}: services.#{name} depends_on '#{dep}', gated behind profiles: " \
+                             "(#{@services.fetch(dep).profiles.join(', ')}) wip never activates " \
+                             '(no --profile flag)'
         end
       end
     end

data/lib/wip/config.rb

@@ -204,6 +204,19 @@ module Wip
 
     def parsed_compose_file
       @parsed_compose_file ||= ComposeFile.load(ComposeBridge.file_path(self), env: compose_interpolation_env)
+                                          .tap { |file| validate_compose_service_startable!(file) }
+    end
+
+    # compose.service is what wip always starts by default (container:) — wip has no
+    # --profile flag to activate one, so naming a profile-gated service here would
+    # otherwise fail later with a misleading "No dependencies.<name> entry" instead
+    # of pointing at the real cause.
+    def validate_compose_service_startable!(file)
+      return unless file.profiled?(compose_service)
+
+      raise ConfigError, "compose.service '#{compose_service}' is gated behind profiles: in compose.yml, " \
+                         'but wip has no --profile flag to activate one — pick a service with no profiles: ' \
+                         'or remove profiles: from it'
     end
 
     # Compose interpolates ${VAR} references in compose.yml from the shell environment

data/lib/wip/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wslc-wip
 version: !ruby/object:Gem::Version
-  version: 0.17.6
+  version: 0.18.0
 platform: ruby
 authors:
 - Wip contributors