wslc-wip 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc4331f98464658b13ec0ac51737183931ce6ed5320d15cf64b2313b50aa7999
-  data.tar.gz: 3d9cac0a97bd2abb2a0c30f5c5bc5a8c626320d900f4ac7cd46aca682368b56c
+  metadata.gz: d9b186a9b511381675ce6b5c7073292bc3ba8401287807c2f088d722f7cc1d7c
+  data.tar.gz: 84a5b9b0ed0c9a3ada3ffe06eb793c12192d36d76b22197c9310776ddbe28c18
 SHA512:
-  metadata.gz: 8568791708d1e6b87b85c209568d47580daf0008253dc41b824c9a4377d35f08c2b1005a6082b7ab3eefeaf2cc7ead6ce8357a31047bc17dda0b9f6afcc70266
-  data.tar.gz: 827d83e3244bc9269b12139f5e4554f7b0e2137b1a2a54ac3258799a2c531d355e9a3405ec4bbffff1b134b7b39cbcde0a13a1ba06df35f93cc995b45e4637b7
+  metadata.gz: b46b8daa014806f40f361a5a8fb696cfbfa66f7e0652be23de5d328aaa13401248d640126767c39f1d87ca0329e2428e4a3abe7e19fb5d94e139209e43421646
+  data.tar.gz: ed2eb9f43b08a29f8ac48d16e2820f7aa088bd8d8eb2e8db5f27c22b145f4e26e082f6b0efda81db9e04d395dc7a90a96a9b211b5d723ebd859fd0605899f28d

data/README.md

@@ -1,37 +1,49 @@
 # wip
 
-`wip` は、Docker 開発環境 CLI の dip に近い操作感を Microsoft WSLC に提供する Ruby 製 OSS CLI ラッパーです。プロジェクト固有のコンテナ、イメージ、環境変数やコマンドを `wip.yml` にまとめ、安全な引数配列として `wslc.exe` / `wslc` に渡します。
+[![Tests](https://github.com/slidict/wip/actions/workflows/test.yml/badge.svg)](https://github.com/slidict/wip/actions/workflows/test.yml)
+[![Gem Version](https://img.shields.io/gem/v/wslc-wip.svg)](https://rubygems.org/gems/wslc-wip)
+[![License: MIT](https://img.shields.io/github/license/slidict/wip.svg)](LICENSE)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.2-red.svg)](wslc-wip.gemspec)
 
-> **Status:** 初期リリース 0.1.0。WSLC 自体の仕様変更に追随が必要になる可能性があります。
+`wip` is a Ruby-built OSS CLI wrapper that brings a [`dip`](https://github.com/bibendi/dip)-like
+workflow to Microsoft WSLC. It collects a project's container, image, environment variables, and
+commands into a single `wip.yml`, and forwards them to `wslc.exe` / `wslc` as safe argument arrays
+(no shell interpolation).
 
-## 対応環境とインストール
+![wip demo](https://raw.githubusercontent.com/slidict/wip/main/docs/demo.gif)
 
-Ruby 3.2 以上、WSL2、および Microsoft WSLC が必要です。RubyGems 公開後は次で導入できます。
+> **Status:** early release. Expect to track WSLC's own interface as it evolves.
+
+## Requirements & installation
+
+Ruby 3.2+, WSL2, and Microsoft WSLC.
 
 ```bash
-gem install wip
+gem install wslc-wip
 ```
 
-ソースからは `bundle install && bundle exec exe/wip version` を使用します。
+From source: `bundle install && bundle exec exe/wip version`.
 
-## クイックスタート
+## Quick start
 
 ```bash
-gem install wip
+gem install wslc-wip
 cd my-project
 wip doctor
 wip build
+wip up -d
 wip rails console
 ```
 
-## 完全な設定例
+## Full configuration example
 
-プロジェクトルートに `wip.yml` を置きます。子ディレクトリから実行しても親方向へ探索され、`--config PATH` で明示指定もできます。
+Put a `wip.yml` in your project root. Running from a subdirectory walks up to find it, or pass
+`--config PATH` to point at one explicitly.
 
 ```yaml
 version: 1
 wslc:
-  command: auto # wslc.exe、wslc、System32 の順。絶対パスも指定可能
+  command: auto # tries wslc.exe, wslc, then System32; an absolute path also works
 defaults:
   container: app
   image: slidict/slidict:development
@@ -45,6 +57,9 @@ defaults:
     - "3000:3000"
   volumes:
     - ".:/app"
+up:
+  command: server # command `wip up` passes to the image when it creates the container
+                   # (omit to use the image's default CMD)
 commands:
   rails:
     type: exec
@@ -72,46 +87,53 @@ commands:
     tag: slidict/slidict:development
 ```
 
-`env` の値は文字列化されます。`config` の表示では token、password、secret、credential、auth を含むキーを伏せます。秘密値は可能なら設定ファイルではなく実行環境側で管理してください。
+`env` values are stringified. `wip config` masks any key matching token, password, secret,
+credential, or auth. Keep real secrets out of the config file and in your runtime environment
+instead.
 
-## コマンド
+## Commands
 
-| コマンド | 説明 |
+| Command | Description |
 |---|---|
-| `wip version` | wip と、検出できた WSLC のバージョン |
-| `wip doctor` | WSL2、相互運用、WSLC、設定、アーキテクチャ、Git を診断 |
-| `wip config` | デフォルト適用済み設定（秘密値をマスク） |
-| `wip build -- --no-cache` | build 定義でイメージをビルド |
-| `wip up [-d]` | `defaults.container` を起動（無ければ作成）。`-d` でバックグラウンド実行 |
-| `wip down` | `defaults.container` を停止・削除 |
-| `wip exec [--no-interactive] COMMAND...` | 既存コンテナ内で実行 |
-| `wip run [--no-interactive] COMMAND...` | `--rm` の新規コンテナで実行 |
-| `wip shell` | 定義済み shell、または `bash`、`sh` の順に起動 |
-| `wip NAME ARGS...` | `commands.NAME` を実行し、引数を末尾に追加 |
-
-TTY はコマンド設定、CLI オプション、標準入出力が双方 TTY かを合わせて判定します。`WIP_DEBUG=1` では `Shellwords.join` した実行コマンドを表示します。
+| `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` | 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 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` |
+| `wip NAME ARGS...` | Run `commands.NAME`, appending any extra arguments |
+
+TTY allocation is decided by combining the command's config, the CLI option, and whether both
+stdin and stdout are real TTYs. Set `WIP_DEBUG=1` to print the `Shellwords`-joined command before
+running it.
 
 ## doctor
 
-`[OK]`、`[WARN]`、`[FAIL]` で各診断を表示します。警告だけなら終了コード 0、WSL2/相互運用/WSLC/設定など実行を妨げる問題があれば 1 です。実際のビルド環境から Git が見えない場合は警告になります。
+Each check prints as `[OK]`, `[WARN]`, or `[FAIL]`. Warnings alone exit 0; a WSL2, interop, WSLC,
+or config problem that blocks execution exits 1. Git being unreachable from the real build
+environment is only a warning.
 
-## よくあるエラー
+## Common errors
 
-### WSLC がない
+### WSLC not found
 
-WSLC/WSL コンテナツールをインストールまたは更新し、`wip doctor` を実行してください。`auto` は `wslc.exe`、`wslc`、`/mnt/c/Windows/System32/wslc.exe` の順で探します。
+Install or update the WSL container tooling, then run `wip doctor`. `auto` looks for `wslc.exe`,
+`wslc`, then `/mnt/c/Windows/System32/wslc.exe`, in that order.
 
-### Docker Hub の認証
+### Docker Hub authentication
 
-`pull access denied` 等を検出するとログイン方法を補足します。
+When `pull access denied` (or similar) is detected, wip suggests how to log in:
 
 ```bash
 wslc registry login -u <username> docker.io
 ```
 
-### CPU アーキテクチャ不一致
+### CPU architecture mismatch
 
-イメージを確認し、amd64/arm64 のマルチアーキテクチャイメージを公開します。
+Check the image and publish a multi-arch (amd64/arm64) image:
 
 ```bash
 docker buildx imagetools inspect <image>
@@ -121,10 +143,10 @@ docker buildx build \
   --push .
 ```
 
-## 開発
+## Development
 
 ```bash
-git clone <repository-url>
+git clone https://github.com/slidict/wip.git
 cd wip
 bundle install
 bundle exec rspec
@@ -132,11 +154,21 @@ bundle exec rubocop
 bundle exec rake
 ```
 
-テストは WSLC を必要とせず、解決・構築・実行層を差し替え可能にしています。GitHub Actions は Ruby 3.2、3.3、3.4 で RSpec と RuboCop を実行します。
+The test suite doesn't need WSLC — the resolution, build, and execution layers are all
+swappable. GitHub Actions runs RSpec and RuboCop on Ruby 3.2, 3.3, 3.4, and 4.0.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/slidict/wip). See
+[CONTRIBUTING.md](CONTRIBUTING.md) for commit conventions, versioning policy, and the PR
+checklist.
 
-## 初期リリースに含まれないもの
+## Not in the initial release
 
-Compose 互換、常駐プロセス、GUI、PowerShell 最適化、レジストリ API/manifest の直接解析、自動更新、プラグインは未実装です。将来は設定スキーマ、ライフサイクルフック、複数コンテナ、プラットフォーム選択、より詳細な診断の追加が有用です。
+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.
 
 ## License
 

data/lib/wip/cli.rb

@@ -2,6 +2,8 @@
 
 require 'thor'
 require 'yaml'
+require 'json'
+require 'stringio'
 
 module Wip
   # Thor-based command-line interface for wip.
@@ -54,8 +56,15 @@ module Wip
     desc 'up', 'Start the configured container, creating it if necessary'
     option :detach, type: :boolean, default: false, aliases: '-d'
     def up
-      code = execute(builder.start(detach: options[:detach]), exit_on_failure: false)
-      execute(builder.up(detach: options[:detach])) if code != 0
+      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
     end
 
     desc 'down', 'Stop and remove the configured container'
@@ -67,24 +76,32 @@ module Wip
     desc 'exec COMMAND...', 'Execute a command in the running container'
     option :interactive, type: :boolean, default: true
     def exec(*command)
-      execute(builder.exec(command, interactive: options[:interactive]))
+      tty = builder.tty?(options[:interactive])
+      execute(builder.exec(command, interactive: options[:interactive]), interactive: tty)
     end
 
     desc 'run COMMAND...', 'Run a command in a new container'
     option :interactive, type: :boolean, default: true
     def run_command(*command)
-      execute(builder.run(command, interactive: options[:interactive]))
+      tty = builder.tty?(options[:interactive])
+      execute(builder.run(command, interactive: options[:interactive]), interactive: tty)
     end
     map 'run' => :run_command
 
     desc 'shell', 'Open a shell in the configured container'
     def shell_command
       configured = load_config.command('shell')
-      return execute(builder.custom('shell', [])) if configured
+      if configured
+        tty = builder.tty?(configured.fetch('interactive', false))
+        return execute(builder.custom('shell', []), interactive: tty)
+      end
 
+      tty = builder.tty?(true)
       code = execute(builder.exec(['bash'], settings: { 'interactive' => true }, interactive: true),
-                     exit_on_failure: false)
-      execute(builder.exec(['sh'], settings: { 'interactive' => true }, interactive: true)) if code != 0
+                     interactive: tty, exit_on_failure: false)
+      return if code.zero?
+
+      execute(builder.exec(['sh'], settings: { 'interactive' => true }, interactive: true), interactive: tty)
     end
     map 'shell' => :shell_command
 
@@ -92,7 +109,8 @@ module Wip
     def dispatch(name = nil, *arguments)
       raise ConfigError, 'A command is required' unless name
 
-      execute(builder.custom(name, arguments))
+      values = load_config.command(name) || raise(ConfigError, "Unknown command: #{name}")
+      execute(builder.custom(name, arguments), interactive: builder.tty?(values.fetch('interactive', false)))
     end
 
     private
@@ -102,10 +120,18 @@ module Wip
     def resolver = CommandResolver.new
     def builder = CommandBuilder.new(wslc: resolver.resolve(load_config.wslc_command), config: load_config)
 
-    def execute(command, exit_on_failure: true)
-      code = CommandRunner.new.run(command)
+    def execute(command, interactive: false, exit_on_failure: true)
+      code = CommandRunner.new.run(command, interactive: interactive)
       exit(code) if exit_on_failure && !code.zero?
       code
     end
+
+    def container_exists?
+      out = StringIO.new
+      code = CommandRunner.new(stdout: out, stderr: StringIO.new).run(builder.find)
+      code.zero? && !JSON.parse(out.string).empty?
+    rescue JSON::ParserError
+      false
+    end
   end
 end

data/lib/wip/command_builder.rb

@@ -32,6 +32,8 @@ module Wip
       command << '-d' if detach
       command << '-it' if !detach && tty?(true)
       command.concat(options(values)).push(required(values, 'image'))
+      command.concat(Shellwords.split(@config.up_command.to_s)) if @config.up_command
+      command
     end
 
     def start(detach: false)
@@ -40,6 +42,11 @@ module Wip
       command
     end
 
+    def find
+      container = required(@config.defaults, 'container')
+      [@wslc, 'list', '--all', '--filter', "name=#{container}", '--format', 'json']
+    end
+
     def down
       [@wslc, 'stop', required(@config.defaults, 'container')]
     end
@@ -66,6 +73,8 @@ module Wip
       public_send(type, base + arguments, settings: values, interactive: values.fetch('interactive', false))
     end
 
+    def tty?(requested) = requested && @environment.interactive?
+
     private
 
     def options(values, include_container: false, include_publish: true)
@@ -86,7 +95,5 @@ module Wip
 
       value
     end
-
-    def tty?(requested) = requested && @environment.interactive?
   end
 end

data/lib/wip/command_runner.rb

@@ -13,8 +13,10 @@ module Wip
       @interpreter = interpreter
     end
 
-    def run(command, env: {})
+    def run(command, env: {}, interactive: false)
       @stderr.puts "+ #{Shellwords.join(command)}" if ENV['WIP_DEBUG']
+      return run_attached(command, env) if interactive
+
       captured = +''
       status = nil
       Open3.popen3(env, *command) do |input, output, error, wait|
@@ -33,6 +35,19 @@ module Wip
 
     private
 
+    # Piping stdin/stdout/stderr (as `run` does above) closes the child's
+    # stdin immediately, which breaks anything that reads from the terminal
+    # (a shell, `rails console`, ...). Inherit the real file descriptors
+    # instead so the child gets a genuine TTY.
+    def run_attached(command, env)
+      pid = Process.spawn(env, *command)
+      _, status = Process.wait2(pid)
+      status.exitstatus
+    rescue Errno::ENOENT => e
+      @stderr.puts e.message
+      127
+    end
+
     def pump(source, destination, captured)
       Thread.new do
         source.each(4096) do |chunk|

data/lib/wip/config.rb

@@ -17,6 +17,7 @@ module Wip
     def wslc_command = @raw.dig('wslc', 'command') || 'auto'
     def commands = @raw['commands'] || {}
     def defaults = DEFAULTS.merge(@raw['defaults'] || {})
+    def up_command = @raw.dig('up', 'command')
 
     def command(name)
       entry = commands[name.to_s]
@@ -27,6 +28,7 @@ module Wip
 
     def to_h(redact: true)
       value = { 'version' => 1, 'wslc' => { 'command' => wslc_command }, 'defaults' => defaults,
+                'up' => { 'command' => up_command },
                 'commands' => commands.transform_values { |entry| defaults.merge('type' => 'exec').merge(entry) } }
       redact ? redact_secrets(value) : value
     end
@@ -36,6 +38,7 @@ 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)
 
       commands.each { |name, entry| validate_command!(name, entry) }
     end

data/lib/wip/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wslc-wip
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Wip contributors
@@ -44,11 +44,14 @@ files:
 - lib/wip/error_interpreter.rb
 - lib/wip/errors.rb
 - lib/wip/version.rb
-homepage: https://github.com/example/wip
+homepage: https://github.com/slidict/wip
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/slidict/wip
+  changelog_uri: https://github.com/slidict/wip/releases
+  bug_tracker_uri: https://github.com/slidict/wip/issues
 rdoc_options: []
 require_paths:
 - lib