donce 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad7d3419ce887d6b42f6f92f6dc9ad8414b0c3c89c1fb0ef4600972ac54f754e
-  data.tar.gz: a8d95d419418e037968ae4f659a5b538a8c67c44fee323974befefa7d5651b5c
+  metadata.gz: 44c678f3ea8b379cf1d76ef37954ad59a3b4bb508001576972b799196859f547
+  data.tar.gz: a669642f9ddc4a45e04f8d00f9a2bda74fd2ae62f40717626b1ab2fd992f627a
 SHA512:
-  metadata.gz: 22738b8cdd2b2eef8188c1e69dfea55a7d3b7317f73623fd2230cd65695dd033994f58a62fca0e549a5e846245c61b1ec0d870760d79becda4e4a769f62ba9dc
-  data.tar.gz: 86ee931f8f8149192661d2541b19abbd58377dd8d6aa7fc5770fbe1fdc66819aeb8ff409224938b74acedf5a94b5d961c40439f4263d83cdf3eb1e84b9e24169
+  metadata.gz: 1e66afd723eaef2ce89b2ec88418f9be91ef25ddbe0054015d707cdaf178086f68e0e78337c5305fbd752fc92434782212f61fe8e0f2f5bc8220c1f586668522
+  data.tar.gz: 819b0e6086390e483cb54b0b42ac007c2f2bdc0f39fd7170325abcfc53bc1cdd98b7df821474c46078401f5bc0d0faedb90e5e929b8a95202a049cfbd280a550

data/README.md

@@ -12,7 +12,7 @@
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/donce/blob/master/LICENSE.txt)
 
 This small Ruby library helps building temporary [Docker]
-images, run Docker containers, and clean up afterwards --- may be
+images, runs Docker containers, and cleans up afterwards — it may be
 convenient for automated tests (for example, with [Minitest]):
 
 ```ruby
@@ -29,6 +29,15 @@ class MyTest < Minitest::Test
 end
 ```
 
+It's possible to run Docker image in a background mode too:
+
+```ruby
+stdout = donce(image: 'ubuntu', command: 'sleep 9999') do |id|
+  # The "id" is the container id
+  # The "donce_host()" is the hostname of it
+end
+```
+
 That's it.
 
 ## How to contribute

data/donce.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.0'
   s.name = 'donce'
-  s.version = '0.0.3'
+  s.version = '0.0.5'
   s.license = 'MIT'
   s.summary = 'Builds and starts temporary Docker containers'
   s.description =

data/lib/donce.rb

@@ -74,12 +74,14 @@ module Kernel
   # @param [Logger] log The logging destination, can be +$stdout+
   # @param [String|Array<String>] args List of extra arguments for the +docker+ command
   # @param [Hash<String,String>] env Environment variables going into the container
+  # @param [Hash<String,String>] volumes Local to container volumes mapping
+  # @param [Hash<String,String>] ports Local to container port mapping
   # @param [Boolean] root Let user inside the container be "root"?
   # @param [String|Array<String>] command The command for the script inside the container
   # @param [Integer] timeout Maximum seconds to spend on each +docker+ call
   # @return [String] The stdout of the container
   def donce(dockerfile: nil, image: nil, home: nil, log: $stdout, args: '', env: {}, root: false, command: '',
-            timeout: 10)
+            timeout: 10, volumes: {}, ports: {})
     raise 'Either use "dockerfile" or "home"' if dockerfile && home
     raise 'Either use "dockerfile" or "image"' if dockerfile && image
     raise 'Either use "image" or "home"' if home && image
@@ -89,7 +91,7 @@ module Kernel
       if image
         image
       else
-        i = "donce-#{SecureRandom.hex(8)}"
+        i = "donce-#{SecureRandom.hex(6)}"
         if dockerfile
           Dir.mktmpdir do |tmp|
             File.write(File.join(tmp, 'Dockerfile'), dockerfile)
@@ -100,22 +102,24 @@ module Kernel
         end
         i
       end
-    container = "donce-#{SecureRandom.hex(8)}"
+    container = "donce-#{SecureRandom.hex(6)}"
     begin
       stdout = nil
       code = 0
       begin
         cmd = [
           docker, 'run',
-          block_given? ? '-d' : '',
+          block_given? ? '-d' : nil,
           '--name', Shellwords.escape(container),
-          OS.linux? ? '' : "--add-host #{donce_host}:host-gateway",
+          OS.linux? ? nil : "--add-host #{donce_host}:host-gateway",
           args,
           env.map { |k, v| "-e #{Shellwords.escape("#{k}=#{v}")}" }.join(' '),
-          root ? '' : "--user=#{Shellwords.escape("#{Process.uid}:#{Process.gid}")}",
+          ports.map { |k, v| "-p #{Shellwords.escape("#{k}:#{v}")}" }.join(' '),
+          volumes.map { |k, v| "-v #{Shellwords.escape("#{k}:#{v}")}" }.join(' '),
+          root ? nil : "--user=#{Shellwords.escape("#{Process.uid}:#{Process.gid}")}",
           Shellwords.escape(img),
           command
-        ].join(' ')
+        ].compact.join(' ')
         stdout, code =
           Timeout.timeout(timeout) do
             qbash(
@@ -132,16 +136,14 @@ module Kernel
             "Failed to run #{cmd} " \
             "(exit code is ##{code}, stdout has #{stdout.split("\n").count} lines)"
         end
-        if block_given?
-          r = yield container
-          return r
-        end
+        yield container if block_given?
       ensure
-        qbash(
+        logs = qbash(
           "#{docker} logs #{Shellwords.escape(container)}",
           level: code.zero? ? Logger::DEBUG : Logger::ERROR,
           log:
         )
+        stdout = logs if block_given?
         qbash("#{docker} rm -f #{Shellwords.escape(container)}", log:)
       end
       stdout

data/test/test_donce.rb

@@ -55,4 +55,9 @@ class TestDonce < Minitest::Test
     end
     assert(seen)
   end
+
+  def test_returns_stdout_from_daemon
+    stdout = donce(dockerfile: "FROM ubuntu\nCMD echo hello", log: Loog::NULL) { |_| sleep 0.1 }
+    assert_equal("hello\n", stdout)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: donce
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Yegor Bugayenko