donce 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87e27e95378a5ad34a9ba6a7ef7c8578efb3d24990998beada04097c1a46d5c1
-  data.tar.gz: 0ea31ae8977024be7abdbc164a3250a8eb907511ea24b5427b2eb3f8960b2912
+  metadata.gz: 77e8fc303600f62224be74352774a1d7d2a0e151cf4935316112874bf2b4c39f
+  data.tar.gz: 220d2d7b9fcdcd4702fb594daf2211a0268f54a7fc21231bbf8e4a670f75d796
 SHA512:
-  metadata.gz: df41062bb8aea186f7bafc2df0070d7abbf1238d2eea5270f49a62e1901a495b0d50afca4659b5314ea0ea0117a299241b8757369a07b5e384cd8595abf956f2
-  data.tar.gz: 2d6de2cde5d5df5dc3048bb7e9d68cc8b866ec76842f9ce7f9441a4b3b1f683a58e65428c558244c02ab2bcf1a6760606f1e63cea7a7c1a77f08778a18c59fd4
+  metadata.gz: 5e70dc715fb1b8166a6bf0805639b7f384e5f346438fdd8c030444d02a7fee8bcfb042ccd1bf71ef095ca201f1dbb4f586a30fe50a102686eb5b4dff6e6e2ee8
+  data.tar.gz: 2a4bf49df247f331a36dfaffb055a66f38e207dda78133c49d7db95e7178be4421253803d456e931cb40227802142c7f5d7363b11cb36345d85c662d79f00800

data/Gemfile

@@ -28,7 +28,7 @@ gem 'minitest', '5.25.4', require: false
 gem 'minitest-reporters', '1.7.1', require: false
 gem 'minitest-retry', '0.2.5', require: false
 gem 'rake', '13.2.1', require: false
-gem 'rspec-rails', '7.1.0', require: false
+gem 'rspec-rails', '7.1.1', require: false
 gem 'rubocop', '1.71.2', require: false
 gem 'rubocop-minitest', '0.36.0', require: false
 gem 'rubocop-performance', '1.23.1', require: false

data/Gemfile.lock

@@ -134,7 +134,7 @@ GEM
     reline (0.6.0)
       io-console (~> 0.5)
     rexml (3.4.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -142,7 +142,7 @@ GEM
     rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-rails (7.1.0)
+    rspec-rails (7.1.1)
       actionpack (>= 7.0)
       activesupport (>= 7.0)
       railties (>= 7.0)
@@ -213,7 +213,7 @@ DEPENDENCIES
   minitest-reporters (= 1.7.1)
   minitest-retry (= 0.2.5)
   rake (= 13.2.1)
-  rspec-rails (= 7.1.0)
+  rspec-rails (= 7.1.1)
   rubocop (= 1.71.2)
   rubocop-minitest (= 0.36.0)
   rubocop-performance (= 1.23.1)

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

data/lib/donce.rb

@@ -68,18 +68,21 @@ module Kernel
 
   # Build Docker image (or use existing one), run Docker container, and then clean up.
   #
-  # @param [String] dockerfile The content of the +Dockerfile+
+  # @param [String] dockerfile The content of the +Dockerfile+ (if array is provided, it will be concatenated)
   # @param [String] home The directory with Dockerfile and all other necessary files
   # @param [String] image The name of Docker image, e.g. "ubuntu:24.04"
   # @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 [Hash<String,String>] build_args Arguments for +docker build+ as +--build-arg+ may need
   # @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: {}, build_args: {})
     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
@@ -90,13 +93,20 @@ module Kernel
         image
       else
         i = "donce-#{SecureRandom.hex(6)}"
+        a = [
+          "--tag #{i}",
+          build_args.map { |k, v| "--build-arg #{Shellwords.escape("#{k}=#{v}")}" }.join(' ')
+        ].join(' ')
         if dockerfile
           Dir.mktmpdir do |tmp|
+            dockerfile = dockerfile.join("\n") if dockerfile.is_a?(Array)
             File.write(File.join(tmp, 'Dockerfile'), dockerfile)
-            qbash("#{docker} build #{Shellwords.escape(tmp)} -t #{i}", log:)
+            qbash("#{docker} build #{a} #{Shellwords.escape(tmp)}", log:)
           end
+        elsif home
+          qbash("#{docker} build #{a} #{Shellwords.escape(home)}", log:)
         else
-          qbash("#{docker} build #{Shellwords.escape(home)} -t #{i}", log:)
+          raise 'Either "dockerfile" or "home" must be provided'
         end
         i
       end
@@ -107,15 +117,17 @@ module Kernel
       begin
         cmd = [
           docker, 'run',
-          block_given? ? '-d' : '',
+          block_given? ? '--detach' : 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}")}",
+          env.map { |k, v| "--env #{Shellwords.escape("#{k}=#{v}")}" }.join(' '),
+          ports.map { |k, v| "--publish #{Shellwords.escape("#{k}:#{v}")}" }.join(' '),
+          volumes.map { |k, v| "--volume #{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(
@@ -140,7 +152,7 @@ module Kernel
           log:
         )
         stdout = logs if block_given?
-        qbash("#{docker} rm -f #{Shellwords.escape(container)}", log:)
+        qbash("#{docker} rm --force #{Shellwords.escape(container)}", log:)
       end
       stdout
     ensure

data/test/test_donce.rb

@@ -34,6 +34,20 @@ class TestDonce < Minitest::Test
     assert_equal("hello\n", stdout)
   end
 
+  def test_prints_build_args
+    stdout = donce(
+      dockerfile: [
+        'FROM ubuntu',
+        'ARG FOO=what?',
+        'RUN echo $FOO > /tmp/foo',
+        'CMD cat /tmp/foo'
+      ],
+      build_args: { 'FOO' => 'hello' },
+      log: Loog::NULL
+    )
+    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)
@@ -47,6 +61,24 @@ class TestDonce < Minitest::Test
     end
   end
 
+  def test_copies_resources
+    content = 'hello!'
+    Dir.mktmpdir do |home|
+      File.write(File.join(home, 'test.txt'), content)
+      File.write(
+        File.join(home, 'Dockerfile'),
+        [
+          'FROM ubuntu',
+          'WORKDIR /foo',
+          'COPY test.txt .',
+          'CMD cat test.txt'
+        ].join("\n")
+      )
+      stdout = donce(home:, log: Loog::NULL)
+      assert_equal(content, 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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: donce
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-06 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace