wslc-wip 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9b186a9b511381675ce6b5c7073292bc3ba8401287807c2f088d722f7cc1d7c
-  data.tar.gz: 84a5b9b0ed0c9a3ada3ffe06eb793c12192d36d76b22197c9310776ddbe28c18
+  metadata.gz: 5808f27cf9f20fab582caacc33a35f4727d1b74764b8e541fe9f10a82ec8ceaa
+  data.tar.gz: 79c031022523b9ea21dfc79d7b160bcc46ab71cebe9f98d89050758ba581d986
 SHA512:
-  metadata.gz: b46b8daa014806f40f361a5a8fb696cfbfa66f7e0652be23de5d328aaa13401248d640126767c39f1d87ca0329e2428e4a3abe7e19fb5d94e139209e43421646
-  data.tar.gz: ed2eb9f43b08a29f8ac48d16e2820f7aa088bd8d8eb2e8db5f27c22b145f4e26e082f6b0efda81db9e04d395dc7a90a96a9b211b5d723ebd859fd0605899f28d
+  metadata.gz: 4b64f0d01f0f54476b5acacc7094dc6c54f2ea5ed480272644b20839a9a1d3217d9c32748935eb20d75f5ee3672012d6c8799dfba8192b1fa656e16a7c65380f
+  data.tar.gz: 5ab533ffee65252d885c20862c32450f3d4b7c5c4a8019cf2314e5075b9c3f5ea49efd551f08cf73c170663b90cebe420533be7041e5d20c6eff1988e6b3a758

data/README.md

@@ -50,6 +50,7 @@ defaults:
   workdir: /app
   interactive: false
   remove: true
+  network: app-tier # optional; shared with `dependencies` so containers can resolve each other by name
   env:
     RAILS_ENV: development
     PORT: "3000"
@@ -60,6 +61,15 @@ defaults:
 up:
   command: server # command `wip up` passes to the image when it creates the container
                    # (omit to use the image's default CMD)
+dependencies:
+  redis:
+    image: redis:latest
+  development.mysql:
+    image: mysql:8.0
+    command: --default-authentication-plugin=mysql_native_password
+    env:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: development
 commands:
   rails:
     type: exec
@@ -91,6 +101,16 @@ commands:
 credential, or auth. Keep real secrets out of the config file and in your runtime environment
 instead.
 
+### Dependency containers
+
+If your app needs sidecar services (a database, Redis, ...), declare them under `dependencies`
+and set `defaults.network`. `wip up` creates the network first (if it doesn't exist), then brings
+up each dependency by name before the main container — so `bin/rails c` (or anything else run
+inside the main container) can reach `development.mysql`/`redis`/etc. by their dependency name,
+the same way Compose's service names resolve. `wip down` tears the main container and all
+dependencies down (the network itself is left in place). Each dependency entry accepts `image`
+(required), `command`, `env`, `ports`, `volumes`, and `workdir` — the same shape as `defaults`.
+
 ## Commands
 
 | Command | Description |
@@ -99,8 +119,8 @@ instead.
 | `wip doctor` | Diagnose WSL2, interop, WSLC, config, architecture, and Git |
 | `wip config` | Print the effective configuration (secrets masked) |
 | `wip build -- --no-cache` | Build the image from the `build` definition |
-| `wip up [-d]` | Start `defaults.container` (creating it with `up.command` if missing). `-d` runs it in the background |
-| `wip down` | Stop and remove `defaults.container` |
+| `wip up [-d]` | Start `defaults.container` and its `dependencies` (creating any that are missing, on `defaults.network` if set). `-d` runs the main container in the background |
+| `wip down` | Stop and remove `defaults.container` and its `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 |
 | `wip shell` | Open the configured shell, falling back to `bash` then `sh` |
@@ -165,10 +185,10 @@ checklist.
 
 ## Not in the initial release
 
-Compose compatibility, a resident/daemon process, a GUI, PowerShell-specific tuning, direct
-registry API/manifest parsing, self-update, and plugins are all unimplemented. Likely future
-additions: a richer config schema, lifecycle hooks, multi-container support, platform selection,
-and more detailed diagnostics.
+Full Compose compatibility (multiple networks, `depends_on` ordering/health checks, profiles), a
+resident/daemon process, a GUI, PowerShell-specific tuning, direct registry API/manifest parsing,
+self-update, and plugins are all unimplemented. Likely future additions: a richer config schema,
+lifecycle hooks, platform selection, and more detailed diagnostics.
 
 ## License
 

data/lib/wip/cli.rb

@@ -53,24 +53,22 @@ module Wip
       execute(builder.build(settings: load_config.command('build') || {}, extra: extra))
     end
 
-    desc 'up', 'Start the configured container, creating it if necessary'
+    desc 'up', 'Start the configured container and its dependencies, creating them if necessary'
     option :detach, type: :boolean, default: false, aliases: '-d'
     def up
-      container = load_config.defaults['container']
-      interactive = builder.tty?(!options[:detach])
-      if container_exists?
-        warn "wip: starting existing container '#{container}'"
-        execute(builder.start(detach: options[:detach]), interactive: interactive)
-      else
-        warn "wip: container '#{container}' not found, creating it"
-        execute(builder.up(detach: options[:detach]), interactive: interactive)
-      end
+      ensure_network
+      load_config.dependencies.each_key { |name| ensure_dependency(name) }
+      ensure_container
     end
 
-    desc 'down', 'Stop and remove the configured container'
+    desc 'down', 'Stop and remove the configured container and its dependencies'
     def down
       execute(builder.down, exit_on_failure: false)
       execute(builder.remove, exit_on_failure: false)
+      load_config.dependencies.each_key do |name|
+        execute(builder.dependency_down(name), exit_on_failure: false)
+        execute(builder.dependency_remove(name), exit_on_failure: false)
+      end
     end
 
     desc 'exec COMMAND...', 'Execute a command in the running container'
@@ -126,12 +124,53 @@ module Wip
       code
     end
 
-    def container_exists?
+    def resource_exists?(find_command)
       out = StringIO.new
-      code = CommandRunner.new(stdout: out, stderr: StringIO.new).run(builder.find)
+      code = CommandRunner.new(stdout: out, stderr: StringIO.new).run(find_command)
       code.zero? && !JSON.parse(out.string).empty?
     rescue JSON::ParserError
       false
     end
+
+    def ensure_network
+      network = load_config.network
+      return unless network
+      return if network_exists?(network)
+
+      warn "wip: creating network '#{network}'"
+      execute(builder.network_create, exit_on_failure: false)
+    end
+
+    def network_exists?(network)
+      out = StringIO.new
+      code = CommandRunner.new(stdout: out, stderr: StringIO.new).run(builder.network_list)
+      return false unless code.zero?
+
+      JSON.parse(out.string).any? { |entry| entry['Name'] == network }
+    rescue JSON::ParserError
+      false
+    end
+
+    def ensure_dependency(name)
+      if resource_exists?(builder.dependency_find(name))
+        warn "wip: starting existing dependency '#{name}'"
+        execute(builder.dependency_start(name))
+      else
+        warn "wip: dependency '#{name}' not found, creating it"
+        execute(builder.dependency_up(name))
+      end
+    end
+
+    def ensure_container
+      container = load_config.defaults['container']
+      interactive = builder.tty?(!options[:detach])
+      if resource_exists?(builder.find)
+        warn "wip: starting existing container '#{container}'"
+        execute(builder.start(detach: options[:detach]), interactive: interactive)
+      else
+        warn "wip: container '#{container}' not found, creating it"
+        execute(builder.up(detach: options[:detach]), interactive: interactive)
+      end
+    end
   end
 end

data/lib/wip/command_builder.rb

@@ -29,6 +29,7 @@ module Wip
     def up(detach: false)
       values = @config.defaults
       command = [@wslc, 'run', '--name', required(values, 'container')]
+      command.push('--network', @config.network) if @config.network
       command << '-d' if detach
       command << '-it' if !detach && tty?(true)
       command.concat(options(values)).push(required(values, 'image'))
@@ -55,6 +56,40 @@ module Wip
       [@wslc, 'remove', '-f', required(@config.defaults, 'container')]
     end
 
+    def network_create
+      [@wslc, 'network', 'create', required_network]
+    end
+
+    def network_list
+      [@wslc, 'network', 'list', '--format', 'json']
+    end
+
+    def dependency_up(name, detach: true)
+      values = dependency_values(name)
+      command = [@wslc, 'run', '--name', name.to_s]
+      command.push('--network', @config.network) if @config.network
+      command << '-d' if detach
+      command.concat(options(values)).push(required(values, 'image'))
+      command.concat(Shellwords.split(values['command'].to_s)) unless values['command'].to_s.empty?
+      command
+    end
+
+    def dependency_start(name)
+      [@wslc, 'start', name.to_s]
+    end
+
+    def dependency_find(name)
+      [@wslc, 'list', '--all', '--filter', "name=#{name}", '--format', 'json']
+    end
+
+    def dependency_down(name)
+      [@wslc, 'stop', name.to_s]
+    end
+
+    def dependency_remove(name)
+      [@wslc, 'remove', '-f', name.to_s]
+    end
+
     def build(settings:, extra: [])
       values = @config.defaults.merge(settings)
       context = values['context'] || '.'
@@ -95,5 +130,16 @@ module Wip
 
       value
     end
+
+    def required_network
+      network = @config.network
+      raise ConfigError, 'Configured network must not be empty' if network.to_s.empty?
+
+      network
+    end
+
+    def dependency_values(name)
+      @config.dependency(name) || raise(ConfigError, "Unknown dependency: #{name}")
+    end
   end
 end

data/lib/wip/config.rb

@@ -18,6 +18,8 @@ module Wip
     def commands = @raw['commands'] || {}
     def defaults = DEFAULTS.merge(@raw['defaults'] || {})
     def up_command = @raw.dig('up', 'command')
+    def dependencies = @raw['dependencies'] || {}
+    def network = defaults['network']
 
     def command(name)
       entry = commands[name.to_s]
@@ -26,9 +28,16 @@ module Wip
       defaults.merge('type' => 'exec').merge(entry)
     end
 
+    def dependency(name)
+      entry = dependencies[name.to_s]
+      return unless entry
+
+      { 'workdir' => nil, 'env' => {}, 'ports' => [], 'volumes' => [] }.merge(entry)
+    end
+
     def to_h(redact: true)
       value = { 'version' => 1, 'wslc' => { 'command' => wslc_command }, 'defaults' => defaults,
-                'up' => { 'command' => up_command },
+                'up' => { 'command' => up_command }, 'dependencies' => dependencies,
                 'commands' => commands.transform_values { |entry| defaults.merge('type' => 'exec').merge(entry) } }
       redact ? redact_secrets(value) : value
     end
@@ -37,12 +46,24 @@ module Wip
 
     def validate!
       raise ConfigError, "Unsupported configuration version: #{@raw['version']}" unless (@raw['version'] || 1) == 1
-      raise ConfigError, 'commands must be a mapping' unless commands.is_a?(Hash)
       raise ConfigError, 'up must be a mapping' if @raw.key?('up') && !@raw['up'].is_a?(Hash)
 
+      validate_commands!
+      validate_dependencies!
+    end
+
+    def validate_commands!
+      raise ConfigError, 'commands must be a mapping' unless commands.is_a?(Hash)
+
       commands.each { |name, entry| validate_command!(name, entry) }
     end
 
+    def validate_dependencies!
+      raise ConfigError, 'dependencies must be a mapping' unless dependencies.is_a?(Hash)
+
+      dependencies.each { |name, entry| validate_dependency!(name, entry) }
+    end
+
     def validate_command!(name, entry)
       raise ConfigError, "commands.#{name} must be a mapping" unless entry.is_a?(Hash)
 
@@ -52,6 +73,13 @@ module Wip
       entry['env']&.transform_values!(&:to_s)
     end
 
+    def validate_dependency!(name, entry)
+      raise ConfigError, "dependencies.#{name} must be a mapping" unless entry.is_a?(Hash)
+      raise ConfigError, "dependencies.#{name} must set image" if entry['image'].to_s.empty?
+
+      entry['env']&.transform_values!(&:to_s)
+    end
+
     def stringify(object)
       case object
       when Hash then object.to_h { |key, value| [key.to_s, stringify(value)] }

data/lib/wip/doctor.rb

@@ -15,9 +15,8 @@ module Wip
 
     def call
       results = []
-      results << result(@environment.wsl2? ? :ok : :fail, 'Running on WSL2', 'Not running on WSL2')
-      results << result(@environment.windows_interop? ? :ok : :fail, 'Windows executable interoperability is enabled',
-                        'Windows executable interoperability is disabled')
+      results << result(@environment.wsl2? ? :ok : :fail, *wsl2_messages)
+      results << interop_result unless @environment.windows?
       results << Result.new(:ok, "Architecture: #{@environment.architecture}")
       config = load_config(results)
       command = resolve(config, results) if config
@@ -29,6 +28,17 @@ module Wip
 
     private
 
+    def wsl2_messages
+      return ['WSL2 is available', 'WSL2 is not available'] if @environment.windows?
+
+      ['Running on WSL2', 'Not running on WSL2']
+    end
+
+    def interop_result
+      result(@environment.windows_interop? ? :ok : :fail, 'Windows executable interoperability is enabled',
+             'Windows executable interoperability is disabled')
+    end
+
     def load_config(results)
       config = @loader.load
       invalid = %w[container image].select { |key| config.defaults[key].to_s.empty? }

data/lib/wip/environment.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 module Wip
   # Detects WSL2, Windows interop, and architecture facts about the host.
   class Environment
@@ -8,7 +10,11 @@ module Wip
       @stdout = stdout
     end
 
+    def windows? = Gem.win_platform?
+
     def wsl2?
+      return wsl2_backend_available? if windows?
+
       File.read('/proc/version').match?(/microsoft.*WSL2/i)
     rescue Errno::ENOENT
       false
@@ -18,9 +24,20 @@ module Wip
     def interactive? = @stdin.tty? && @stdout.tty?
 
     def architecture
-      machine = `uname -m`.strip
-      { 'x86_64' => 'linux/amd64', 'aarch64' => 'linux/arm64', 'arm64' => 'linux/arm64' }.fetch(machine,
-                                                                                                "linux/#{machine}")
+      machine = RbConfig::CONFIG['host_cpu']
+      { 'x86_64' => 'linux/amd64', 'x64' => 'linux/amd64', 'aarch64' => 'linux/arm64', 'arm64' => 'linux/arm64' }
+        .fetch(machine, "linux/#{machine}")
+    end
+
+    private
+
+    # On native Windows there is no /proc/version to read, so ask Windows
+    # itself whether the WSL2 backend that WSLC depends on is installed.
+    def wsl2_backend_available?
+      _output, status = Open3.capture2e('wsl.exe', '--status')
+      status.success?
+    rescue Errno::ENOENT
+      false
     end
   end
 end

data/lib/wip/version.rb

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

metadata

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