miniexec 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8678ef2aa21bd66fbe29563f4621c2a1656b2c6fbcf0a1a3e231b750d65f9707
-  data.tar.gz: a946564ca4922eb7b0d55432e83e5827d310753ca4ebae0d150852db8eb269ec
+  metadata.gz: d1384a25b8dc2ad08cbc25bb427b2e6011a729a725bcbffd475491c06be91bcc
+  data.tar.gz: d34da5dcfdc51327a4462d0e3db39e2c001ea50570570ee1c125d19462face63
 SHA512:
-  metadata.gz: 534199cfb3d7ff71b05d2a6bc55591e9a259090375bc0e120c55a93de6ffcaf14aed7f147672543442a250ba165abaa0a41925530008491fae4e831c524953df
-  data.tar.gz: 7ce0d9cb62a9c7f0241376c79cbaa393846afd7a8995f22790fe7bb1ed932170eaa555ac8547c8babf3d71306f1e07f9218e89e6e30466870dfc5022f389628f
+  metadata.gz: 9066cbd4927f2e27e389eac2746398b0c280d6257c80915918c8ec90b596fa40cb477dc33dc94671deae3e03aebd6b3459327705ee59bd6377cd0ce6fdf535d7
+  data.tar.gz: 6c999684401609efd4bac19c66072e5859e31765df630c23b6adb5c950cd567f53a3f50315e65a17d5bf123509b2b49f330b4982de2e14bf22c35078a4d0ff34

data/bin/miniexec

@@ -10,7 +10,9 @@ options = {
   binds: [],
   env: {},
   path: '.',
-  docker: ENV['DOCKER_HOST'] || '/run/docker.sock'
+  docker: ENV['DOCKER_HOST'] || '/run/docker.sock',
+  cwd: true,
+  file: nil
 }
 
 OptionParser.new do |opts|
@@ -40,6 +42,14 @@ OptionParser.new do |opts|
           'Location of the docker socket') do |sock|
     options[:docker] = sock
   end
+  opts.on('-f', '--file FILE',
+          'Manually specify a custom .gitlab-ci.yml file.') do |file|
+    options[:file] = file
+  end
+  opts.on('-n', '--no-mount-cwd',
+          'Don\'t mount the CWD in the container\'s WORKDIR by default.') do
+    options[:cwd] = false
+  end
 end.parse!
 
 raise OptionParser::MissingArgument, 'Specify a job with -j' if options[:job].nil?
@@ -48,5 +58,7 @@ MiniExec::MiniExec.config(project_path: options[:path])
 exec = MiniExec::MiniExec.new options[:job],
                               docker_url: options[:docker],
                               binds: options[:binds],
-                              env: options[:env]
+                              env: options[:env],
+                              mount_cwd: options[:cwd] || false,
+                              file: options[:file]
 exec.run_job

data/lib/miniexec.rb

@@ -25,30 +25,37 @@ module MiniExec
     end
 
     attr_accessor :script
+    attr_reader :runlog
 
     def initialize(job,
                    project_path: self.class.project_path,
                    docker_url: nil,
                    binds: [],
-                   env: {})
+                   env: {},
+                   mount_cwd: true,
+                   file: nil)
       @job_name = job
       @project_path = project_path
-      @workflow = YAML.load(File.read("#{@project_path}/#{MiniExec.workflow_file}"))
+      file ||= "#{@project_path}/#{MiniExec.workflow_file}"
+      @workflow = YAML.load(File.read(file))
       @job = @workflow[job]
       @job['name'] = job
       @default_image = @workflow['image'] || 'debian:buster-slim'
       @image = set_job_image
+      @entrypoint = set_job_entrypoint
       @binds = binds
+      @mount_cwd = mount_cwd
       @env = {}
       [
-        env,
-        gitlab_env,
         @workflow['variables'],
-        @job['variables']
+        @job['variables'],
+        gitlab_env,
+        env
       ].each do |var_set|
         @env.merge!(var_set.transform_values { |v| Util.expand_var(v.to_s, @env) }) if var_set
       end
       @script = compile_script
+      @runlog = []
       configure_logger
       Docker.options[:read_timeout] = 6000
       Docker.url = docker_url if docker_url
@@ -59,26 +66,48 @@ module MiniExec
       @logger.info "Fetching image #{@image}"
       Docker::Image.create(fromImage: @image)
       @logger.info 'Image fetched'
+
+      config = Docker::Image.get(@image).info['Config']
+      working_dir = if config['WorkingDir'].empty?
+                      '/gitlab'
+                    else
+                      config['WorkingDir']
+                    end
+      binds = @binds
+      binds.push "#{ENV['PWD']}:#{working_dir}" if @mount_cwd
       Dir.chdir(@project_path) do
         @logger.info 'Creating container'
         container = Docker::Container.create(
-          Cmd: ['/bin/bash', script_path],
           Image: @image,
-          Volumes: @binds.map { |b| { b => { path_parent: 'rw' } } }.inject(:merge),
+          Cmd: ['/usr/bin/env', 'bash', script_path],
+          WorkingDir: working_dir,
+          Entrypoint: @entrypoint,
+          Volumes: binds.map { |b| { b => { path_parent: 'rw' } } }.inject(:merge),
           Env: @env.map { |k, v| "#{k}=#{v}" }
         )
         container.store_file(script_path, @script)
         container.start({ Binds: [@binds] })
-        container.tap(&:start).attach { |_, chunk| puts chunk }
+        container.tap(&:start).attach { |_, chunk| puts chunk; @runlog.push chunk}
+        @logger.info 'Job finished. Removing container.'
+        # After running, we want to remove the container.
+        container.remove
+        @logger.info 'Container removed.'
       end
     end
 
     private
 
     def set_job_image
-      return @job['image'] if @job['image']
+      if @job['image']
+        image = @job['image'] if @job['image'].instance_of?(String)
+        image = @job['image']['name'] if @job['image'].instance_of?(Hash)
+      end
+
+      image || @default_image
+    end
 
-      @default_image
+    def set_job_entrypoint
+      @job['image']['entrypoint'] if @job['image'].instance_of?(Hash)
     end
 
     # Set gitlab's predefined env vars as per

data/lib/util.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MiniExec
+  module Util
+    # Given a string and an env, replace any instance of shell-style variables
+    # with their value in the env. NOT POSIX COMPLIANT, just mostly hacky so
+    # I can get gitlab-ci.yml parsing to work properly. Required in MiniExec
+    # because of https://docs.gitlab.com/ee/ci/variables/where_variables_can_be_used.html#gitlab-internal-variable-expansion-mechanism
+    def self.expand_var(string, env)
+      # Match group 1 = the text to replace
+      # Match group 2 = the key from env we want to replace it with
+      regex = /(\${?(\w+)}?)/
+      string.scan(regex).uniq.each do |match|
+        string.gsub! match[0], env[match[1]].to_s
+      end
+      string
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miniexec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Martin Pugh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies: []
 description: A minimal interpretor/executor for .gitlab-ci.yml
 email: pugh@s3kr.it
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - bin/miniexec
 - lib/miniexec.rb
+- lib/util.rb
 homepage: https://github.com/s3krit/miniexec
 licenses:
 - AGPL-3.0-or-later