donce 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 458248c2903f4159ae8e840d9f79173fa5cfccaea2ef74de4ec8896fa2204be6
-  data.tar.gz: 54e651309713b136eac4f40c77db3840aadb95e626cfe861ccfc0d76e50e06b8
+  metadata.gz: 87e27e95378a5ad34a9ba6a7ef7c8578efb3d24990998beada04097c1a46d5c1
+  data.tar.gz: 0ea31ae8977024be7abdbc164a3250a8eb907511ea24b5427b2eb3f8960b2912
 SHA512:
-  metadata.gz: 407378f5c2d8285092e468c7472fdc778558a5b4525c37eba2226a49b2e10debbe4943338030fb351ac28f3b285b7adf480f26335d9ffd5b18458204d3053f01
-  data.tar.gz: 84a740834b4e6c4277c9680ea85c0c124c1fdbefc6c5af33146ba6a70360be0781be1dfbe466aa69414cd3af99e0c3b31abb0172ef531524871f2e160db60d4d
+  metadata.gz: df41062bb8aea186f7bafc2df0070d7abbf1238d2eea5270f49a62e1901a495b0d50afca4659b5314ea0ea0117a299241b8757369a07b5e384cd8595abf956f2
+  data.tar.gz: 2d6de2cde5d5df5dc3048bb7e9d68cc8b866ec76842f9ce7f9441a4b3b1f683a58e65428c558244c02ab2bcf1a6760606f1e63cea7a7c1a77f08778a18c59fd4

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.2'
+  s.version = '0.0.4'
   s.license = 'MIT'
   s.summary = 'Builds and starts temporary Docker containers'
   s.description =

data/lib/donce.rb

@@ -89,16 +89,18 @@ module Kernel
       if image
         image
       else
-        i = "donce-#{SecureRandom.hex(8)}"
+        i = "donce-#{SecureRandom.hex(6)}"
         if dockerfile
-          Dir.mktmpdir do |home|
-            File.write(File.join(home, 'Dockerfile'), dockerfile)
-            qbash("#{docker} build #{Shellwords.escape(home)} -t #{i}", log:)
+          Dir.mktmpdir do |tmp|
+            File.write(File.join(tmp, 'Dockerfile'), dockerfile)
+            qbash("#{docker} build #{Shellwords.escape(tmp)} -t #{i}", log:)
           end
+        else
+          qbash("#{docker} build #{Shellwords.escape(home)} -t #{i}", log:)
         end
         i
       end
-    container = "donce-#{SecureRandom.hex(8)}"
+    container = "donce-#{SecureRandom.hex(6)}"
     begin
       stdout = nil
       code = 0
@@ -130,16 +132,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

@@ -34,6 +34,19 @@ class TestDonce < Minitest::Test
     assert_equal("hello\n", stdout)
   end
 
+  def test_runs_existing_image
+    stdout = donce(image: 'ubuntu:24.04', command: 'echo hello', log: Loog::NULL)
+    assert_equal("hello\n", stdout)
+  end
+
+  def test_runs_from_home
+    Dir.mktmpdir do |home|
+      File.write(File.join(home, 'Dockerfile'), "FROM ubuntu\nCMD echo hello")
+      stdout = donce(home:, log: Loog::NULL)
+      assert_equal("hello\n", stdout)
+    end
+  end
+
   def test_runs_daemon
     seen = false
     donce(dockerfile: "FROM ubuntu\nCMD while true; do sleep 1; echo sleeping; done", log: Loog::NULL) do |id|
@@ -42,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.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Yegor Bugayenko