wsv 0.8.0

data/test/server_test.rb

@@ -0,0 +1,310 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "socket"
+require_relative "test_helper"
+
+class ServerTest < Minitest::Test
+  def setup
+    @dir = Dir.mktmpdir
+    @server = nil
+    @thread = nil
+  end
+
+  def teardown
+    @server&.stop
+    @thread&.join(2)
+    FileUtils.remove_entry(@dir)
+  end
+
+  def test_serves_index
+    File.write(File.join(@dir, "index.html"), "<h1>Hello</h1>")
+    start_server
+
+    response = get("/")
+
+    assert_equal "200", response.code
+    assert_equal "<h1>Hello</h1>", response.body
+    assert_equal "text/html; charset=utf-8", response["content-type"]
+    assert_equal "14", response["content-length"]
+    assert_equal "no-cache", response["cache-control"]
+  end
+
+  def test_serves_file_with_mime_type
+    File.write(File.join(@dir, "app.js"), "console.log('ok');")
+    start_server
+
+    response = get("/app.js")
+
+    assert_equal "200", response.code
+    assert_equal "console.log('ok');", response.body
+    assert_equal "text/javascript; charset=utf-8", response["content-type"]
+    assert_equal "18", response["content-length"]
+  end
+
+  def test_head_has_headers_without_body
+    File.write(File.join(@dir, "style.css"), "body{}")
+    start_server
+
+    response = head("/style.css")
+
+    assert_equal "200", response.code
+    assert_nil response.body
+    assert_equal "6", response["content-length"]
+  end
+
+  def test_directory_without_index_is_not_listed
+    FileUtils.mkdir_p(File.join(@dir, "assets"))
+    start_server
+
+    response = get("/assets/")
+
+    assert_equal "404", response.code
+    assert_includes response.body, "404 Not Found"
+  end
+
+  def test_redirects_directory_without_trailing_slash
+    FileUtils.mkdir_p(File.join(@dir, "docs"))
+    File.write(File.join(@dir, "docs", "index.html"), "docs")
+    start_server
+
+    response = get("/docs")
+
+    assert_equal "301", response.code
+    assert_equal "/docs/", response["location"]
+  end
+
+  def test_rejects_path_traversal
+    secret = File.join(File.dirname(@dir), "wsv-secret-#{$$}.txt")
+    File.write(secret, "secret")
+    start_server
+
+    response = get("/../#{File.basename(secret)}")
+
+    assert_equal "403", response.code
+  ensure
+    FileUtils.rm_f(secret) if secret
+  end
+
+  def test_rejects_dotfile_at_root
+    File.write(File.join(@dir, ".env"), "API_KEY=secret")
+    start_server
+
+    response = get("/.env")
+
+    assert_equal "403", response.code
+  end
+
+  def test_rejects_dotfile_in_subdir
+    FileUtils.mkdir_p(File.join(@dir, "sub"))
+    File.write(File.join(@dir, "sub", ".secret"), "secret")
+    start_server
+
+    response = get("/sub/.secret")
+
+    assert_equal "403", response.code
+  end
+
+  def test_rejects_dot_directory
+    FileUtils.mkdir_p(File.join(@dir, ".git"))
+    File.write(File.join(@dir, ".git", "config"), "[remote]")
+    start_server
+
+    response = get("/.git/config")
+
+    assert_equal "403", response.code
+  end
+
+  def test_rejects_url_encoded_traversal
+    secret = File.join(File.dirname(@dir), "wsv-secret-#{$$}.txt")
+    File.write(secret, "secret")
+    start_server
+
+    response = get("/%2e%2e/#{File.basename(secret)}")
+
+    assert_equal "403", response.code
+  ensure
+    FileUtils.rm_f(secret) if secret
+  end
+
+  def test_returns_414_for_too_long_request_line
+    start_server
+
+    long_path = "/" + ("a" * 9000)
+    socket = TCPSocket.open("127.0.0.1", @server.port)
+    socket.write("GET #{long_path} HTTP/1.1\r\nHost: localhost\r\n\r\n")
+    response = socket.read
+
+    assert_includes response, "HTTP/1.1 414"
+  ensure
+    socket&.close
+  end
+
+  def test_returns_431_for_too_large_headers
+    start_server
+
+    socket = TCPSocket.open("127.0.0.1", @server.port)
+    big = "X-Long: " + ("z" * 9000) + "\r\n"
+    socket.write("GET / HTTP/1.1\r\n#{big}\r\n")
+    response = socket.read
+
+    assert_includes response, "HTTP/1.1 431"
+  ensure
+    socket&.close
+  end
+
+  def test_returns_408_for_idle_client
+    start_server(read_timeout: 0.1)
+
+    socket = TCPSocket.open("127.0.0.1", @server.port)
+    response = socket.read
+
+    assert_includes response, "HTTP/1.1 408"
+  ensure
+    socket&.close
+  end
+
+  def test_slow_client_does_not_block_other_clients
+    File.write(File.join(@dir, "x.txt"), "ok")
+    start_server(read_timeout: 5)
+
+    slow_socket = TCPSocket.open("127.0.0.1", @server.port)
+
+    started = Time.now
+    response = get("/x.txt")
+    elapsed = Time.now - started
+
+    assert_equal "200", response.code
+    assert_equal "ok", response.body
+    assert_operator elapsed, :<, 1.0, "request should not be serialized behind slow client"
+  ensure
+    slow_socket&.close
+  end
+
+  def test_warns_when_binding_to_non_loopback
+    err = StringIO.new
+    server = Wsv::Server.new(host: "0.0.0.0", port: 0, root: @dir, out: StringIO.new, err: err)
+    server.send(:log_startup)
+
+    assert_includes err.string, "WARNING"
+    assert_includes err.string, "0.0.0.0"
+  end
+
+  def test_no_warning_for_loopback_bind
+    err = StringIO.new
+    server = Wsv::Server.new(host: "127.0.0.1", port: 0, root: @dir, out: StringIO.new, err: err)
+    server.send(:log_startup)
+
+    refute_includes err.string, "WARNING"
+  end
+
+  def test_accept_loop_survives_transient_accept_error
+    File.write(File.join(@dir, "x.txt"), "ok")
+    err = StringIO.new
+    @server = Wsv::Server.new(host: "127.0.0.1", port: free_port, root: @dir, out: StringIO.new, err: err)
+    inject_one_accept_error(@server, Errno::ECONNABORTED)
+    @thread = Thread.new { @server.start }
+    wait_until_ready
+
+    response = get("/x.txt")
+
+    assert_equal "200", response.code
+    assert_includes err.string, "accept error"
+    assert_includes err.string, "ECONNABORTED"
+  end
+
+  def test_drains_request_body_for_unsupported_method
+    start_server
+
+    body = "X" * 10_000
+    socket = TCPSocket.open("127.0.0.1", @server.port)
+    socket.write("POST /upload HTTP/1.1\r\nHost: localhost\r\nContent-Length: #{body.bytesize}\r\n\r\n#{body}")
+    response = socket.read
+
+    assert_includes response, "HTTP/1.1 405"
+  ensure
+    socket&.close
+  end
+
+  def test_unsupported_method
+    start_server
+
+    response = raw_request("POST / HTTP/1.1\r\nHost: 127.0.0.1\r\nContent-Length: 0\r\n\r\n")
+
+    assert_includes response, "HTTP/1.1 405 Method Not Allowed"
+    assert_includes response, "Allow: GET, HEAD"
+  end
+
+  private
+
+  def start_server(read_timeout: Wsv::Server::DEFAULT_READ_TIMEOUT)
+    @server = Wsv::Server.new(
+      host: "127.0.0.1",
+      port: free_port,
+      root: @dir,
+      out: StringIO.new,
+      err: StringIO.new,
+      read_timeout: read_timeout
+    )
+    @thread = Thread.new { @server.start }
+    wait_until_ready
+  end
+
+  def inject_one_accept_error(server, error_class)
+    fired = false
+    server.define_singleton_method(:start) do
+      @server = TCPServer.new(host, port)
+      original = @server.method(:accept)
+      @server.define_singleton_method(:accept) do
+        unless fired
+          fired = true
+          raise error_class, "injected"
+        end
+        original.call
+      end
+      @running = true
+      log_startup
+      trap_signals
+      accept_loop
+    ensure
+      close
+    end
+  end
+
+  def free_port
+    server = TCPServer.new("127.0.0.1", 0)
+    server.addr[1]
+  ensure
+    server&.close
+  end
+
+  def wait_until_ready
+    deadline = Time.now + 2
+    loop do
+      TCPSocket.open("127.0.0.1", @server.port).close
+      break
+    rescue Errno::ECONNREFUSED
+      raise if Time.now >= deadline
+
+      sleep 0.01
+    end
+  end
+
+  def get(path)
+    Net::HTTP.get_response(URI("http://127.0.0.1:#{@server.port}#{path}"))
+  end
+
+  def head(path)
+    Net::HTTP.start("127.0.0.1", @server.port) do |http|
+      http.head(path)
+    end
+  end
+
+  def raw_request(request)
+    socket = TCPSocket.open("127.0.0.1", @server.port)
+    socket.write(request)
+    socket.read
+  ensure
+    socket&.close
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "minitest/autorun"
+require "fileutils"
+require "stringio"
+require "tmpdir"
+require "wsv"

data/wsv.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/wsv/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "wsv"
+  spec.version = Wsv::VERSION
+  spec.authors = ["takahashim"]
+  spec.email = ["takahashimm@gmail.com"]
+
+  spec.summary = "A tiny static web server for local previews."
+  spec.description = "wsv serves a local directory over HTTP from a zero-config CLI."
+  spec.homepage = "https://rubygems.org/gems/wsv"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/takahashim/wsv",
+    "changelog_uri" => "https://github.com/takahashim/wsv/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.files = Dir[
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md",
+    "bin/wsv",
+    "lib/**/*.rb",
+    "test/**/*.rb",
+    "wsv.gemspec"
+  ]
+  spec.bindir = "bin"
+  spec.executables = ["wsv"]
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: wsv
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- takahashim
+bindir: bin
+cert_chain: []
+date: 2026-05-06 00:00:00.000000000 Z
+dependencies: []
+description: wsv serves a local directory over HTTP from a zero-config CLI.
+email:
+- takahashimm@gmail.com
+executables:
+- wsv
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/wsv
+- lib/wsv.rb
+- lib/wsv/app.rb
+- lib/wsv/cli.rb
+- lib/wsv/mime_types.rb
+- lib/wsv/path_resolver.rb
+- lib/wsv/request.rb
+- lib/wsv/response.rb
+- lib/wsv/server.rb
+- lib/wsv/status.rb
+- lib/wsv/version.rb
+- test/app_test.rb
+- test/cli_test.rb
+- test/path_resolver_test.rb
+- test/request_test.rb
+- test/response_test.rb
+- test/server_test.rb
+- test/test_helper.rb
+- wsv.gemspec
+homepage: https://rubygems.org/gems/wsv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/wsv
+  source_code_uri: https://github.com/takahashim/wsv
+  changelog_uri: https://github.com/takahashim/wsv/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A tiny static web server for local previews.
+test_files: []