all_images 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1e9a30544cd8da8ff78b08273145dc8c43f30ee61aee97e035444c7eca98b1d
-  data.tar.gz: faba9ac223de4a106c77fd1dc943ab4933cde3b4a052c7411390e1b7335780d1
+  metadata.gz: cbf39eaf44bd3eef5cba7b22e942621717fd838cde984764c684ba2a7f8842f7
+  data.tar.gz: f8c257c224e80f2ae251ec8e05b8869d3348ae0408d4a0dadd789ef74ce182c3
 SHA512:
-  metadata.gz: 3a95b63a886db349cf62083638f4686a4adefa2e013da197b5ae016cac16fc3f967a35b679a47ba2a86bbecceb85181c7fd85c1411b442891945f2d91ecbe8d8
-  data.tar.gz: cfb5b0bf0a330623bfb37579f5606da2b2099511f31c7d28263dd249388856418d984d86f00889e1db2825b752ff30a74bf9de1dc90110b886220181ec92d458
+  metadata.gz: 39b423c850d91d8a7261c2b4677ba9935486797e0dd08ab2cca2ed6e9af78c162296cd89daa7e7ce71dd23999fed098f4158edc57d34222d99ef38db495bca10
+  data.tar.gz: 4a2d1611e0452b452963c099aed19163af335290015b25b72757db37803827a304d77282c3cc0919cfc0b24855703d8fb727cd74dd4c11664edcee7b3bbbac08

data/CHANGES.md

@@ -0,0 +1,96 @@
+# Changes
+
+## 2024-10-14 v0.6.0
+
+### Significant Changes
+* **Add support for environment variables to all_images**
+  + Require `'tins/xt/full'` and add new method `env` to set environment variables.
+  + Modified the `sh` method to use environment variables from the `env` method.
+  + Modified the `run_image` method to include environment variables in the Docker command.
+* Update rake task to use spec instead of test
+* Added `[IMAGE]` as an optional argument in the Usage message.
+
+### Other Changes
+* Reformat CHANGES.md
+* Add error reporting to `sh`
+  + Added require `'shellwords'`
+
+#### Environment Variables
+* Added `env` section to `.all_images.yml`
+* Defined `FOO=bar` and `USER` environment variables
+
+## 2024-09-01 v0.5.0
+
+* **Update image processing for parallel execution**:
+  + Added random suffix to image names to prevent conflicts between concurrent processes.
+* Added `CHANGES.md` file
+
+## 2024-08-08 v0.4.1
+
+* **License File Added**: A license file was added in written form.
+
+## 2024-02-07 v0.4.0
+
+* Added support for outputting colors in addition to existing functionality.
+
+## 2023-08-17 v0.3.0
+
+* **New Feature**: Allow running scripts within a Docker container, enabling
+  more flexible and isolated testing environments.
+
+## 2023-08-17 v0.2.5
+
+* Corrected actual checking logic.
+
+## 2023-08-17 v0.2.4
+
+* **Improved Error Handling**: 
+  * Added checks to prevent premature failure in critical sections of the code.
+
+## 2023-06-01 v0.2.3
+
+* **New Features**
+  + Added support for Ruby 3.2
+* **Changes**
+  + Bumped build version
+  + Removed support for Ruby 2.5
+* **Bug Fixes**
+  + Repaired `fail_fast` mode
+
+## 2023-04-19 v0.2.2
+
+* **New Version Features**
+  + Progress into the future of ruby development
+  + Progress into the future
+* **Significant Changes**
+  + Removed development dependency (again)
+
+## 2022-11-17 v0.2.1
+
+* Added a new `help` command.
+
+## 2022-11-17 v0.2.0
+
+* **New Features**
+  + Added commands to run and debug single images
+  + Added a debug debugger feature
+
+## 2022-11-17 v0.1.0
+
+* Added `fail_fast` configuration option.
+
+## 2022-07-11 v0.0.2
+
+* **Security Fix**: Local config files are now properly sanitized to prevent potential security vulnerabilities.
+
+## 2022-05-16 v0.0.1
+
+* **Bug Fix**: Fixed bug in `required_ruby_version` functionality, which was causing issues with certain RubyGems releases.
+ 
+### Significant Changes
+* Removed buggy implementation of `required_ruby_version`
+* Improved stability and compatibility with RubyGems releases
+
+## 2022-05-15 v0.0.0
+
+  * Start

data/all_images.gemspec

@@ -1,29 +1,29 @@
 # -*- encoding: utf-8 -*-
-# stub: all_images 0.4.1 ruby lib
+# stub: all_images 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "all_images".freeze
-  s.version = "0.4.1".freeze
+  s.version = "0.6.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-08-08"
+  s.date = "2024-10-14"
   s.description = "A script that runs a script in all of the configured docker images".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["all_images".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/all_images.rb".freeze, "lib/all_images/app.rb".freeze, "lib/all_images/config.rb".freeze, "lib/all_images/version.rb".freeze]
-  s.files = [".utilsrc".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "all_images.gemspec".freeze, "bin/all_images".freeze, "lib/all_images.rb".freeze, "lib/all_images/app.rb".freeze, "lib/all_images/config.rb".freeze, "lib/all_images/version.rb".freeze, "spec/app_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.files = [".utilsrc".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "all_images.gemspec".freeze, "bin/all_images".freeze, "lib/all_images.rb".freeze, "lib/all_images/app.rb".freeze, "lib/all_images/config.rb".freeze, "lib/all_images/version.rb".freeze, "spec/app_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "https://github.com/flori/all_images".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "AllImages -- Runs a script in all of the docker images".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.5.16".freeze
+  s.rubygems_version = "3.5.18".freeze
   s.summary = "Runs a script in all of the docker images".freeze
   s.test_files = ["spec/app_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.16.1".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.19".freeze])
   s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])

data/lib/all_images/app.rb

@@ -1,28 +1,29 @@
 require 'term/ansicolor'
 require 'tmpdir'
 require 'fileutils'
+require 'tins'
+require 'tins/xt/full'
+require 'shellwords'
 
 class AllImages::App
   include Term::ANSIColor
   include FileUtils
 
-  alias sh system
-
   def initialize(args)
     @args     = args.dup
     @command  = pick_command
     @commands = %w[ ls help run debug run_all ].sort
+    @suffix   = Tins::Token.new(alphabet: Tins::Token::BASE32_ALPHABET, bits: 32)
   end
 
   def run
     @config   = load_config or return 23
-
     result = 0
     case @command
     when 'ls'
       puts Array(@config['images']).map(&:first)
     when 'help'
-      puts "Usage: #{File.basename($0)} #{@commands * ?|} IMAGE"
+      puts "Usage: #{File.basename($0)} #{@commands * ?|} [IMAGE]"
     else
       Array(@config['images']).each do |image, script|
         case @command
@@ -43,16 +44,45 @@ class AllImages::App
 
   private
 
+  def env
+    vars = @config.fetch('env', [])
+    vars << 'TERM' if ENV.key?('TERM')
+    vars.each_with_object({}) { |v, h|
+      name, value = v.split(?=, 2)
+      if value
+        h[name] = value
+      else
+        h[name] = ENV[name]
+      end
+    }
+  end
+
+  def sh(*a)
+    if $DEBUG
+      STDERR.puts "Executing #{a.inspect}."
+    end
+    system(*a)
+    if $?.success?
+      true
+    else
+      raise "Command #{Shellwords.join(a).inspect} failed with: #{$?.exitstatus}"
+    end
+  end
+
+  def name
+    [ 'all_images', @suffix ] * ?-
+  end
+
   def run_image(image, script, interactive: false)
     dockerfile = @config.fetch('dockerfile').to_s
-    tag = provide_image image, dockerfile, script
-    term = ENV.key?('TERM') ? %{ -e TERM=#{ENV['TERM'].inspect} } : ' '
+    tag  = provide_image image, dockerfile, script
+    envs = env.full? { |e| +' ' << e.map { |n, v| '-e %s=%s' % [ n, v.inspect ] } * ' ' }
     if interactive
       puts "You can run /script interactively now."
-      sh "docker run --name all_images -it #{term}-v `pwd`:/work '#{tag}' sh"
+      sh "docker run --name #{name} -it#{envs} -v `pwd`:/work '#{tag}' sh"
       return 0
     else
-      if sh "docker run --name all_images -it #{term}-v `pwd`:/work '#{tag}' sh -c /script"
+      if sh "docker run --name #{name} -it#{envs} -v `pwd`:/work '#{tag}' sh -c /script"
         puts green('SUCCESS')
         return 0
       else
@@ -61,7 +91,7 @@ class AllImages::App
       end
     end
   ensure
-    sh 'docker rm -f all_images >/dev/null'
+    sh "docker rm -f #{name} >/dev/null"
   end
 
   def pick_command

data/lib/all_images/version.rb

@@ -1,6 +1,6 @@
 module AllImages
   # AllImages version
-  VERSION         = '0.4.1'
+  VERSION         = '0.6.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: all_images
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.1
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.1
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +121,7 @@ extra_rdoc_files:
 - lib/all_images/version.rb
 files:
 - ".utilsrc"
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Runs a script in all of the docker images