miniexec 0.0.9 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f159f73abf46bbc302ba16f34e5f3ec7eac0fe530e57e06e24e3504f198f2027
-  data.tar.gz: 41bd239c0271b589f448de12318397324f2e6ab67e6274caaa79405668119ef7
+  metadata.gz: 69219c3771eda716d56f9ee00bb7d8a7a9c214b38a35d17d2c14e297a0887420
+  data.tar.gz: 5ad61f25f0f1f757325e3e05be347ab3eae5d1861853c67ef938cc286fbdecd8
 SHA512:
-  metadata.gz: a86c5c2d96807c1572d2a78a6799e05694987f2bee706fb7b9822a6ee0b6d5481bcc43e4aa3a668957b476a30d6dfb5f054aa37956948cd3e9b8d2dac336af4d
-  data.tar.gz: 8722200cb309d02e28272ef2977464c1870980442deafacaa0dbd55842eb0fcfab77c0e33bf86bbd2ab18b7c39d48cf67fedbac3225b0ad84848436f36fbfffc
+  metadata.gz: d2413f6f8cf00ee930073576d7f82272bb46927ae74bbe0877ab49564ffe37ea2ca5b7183ae62fbc0fe58025d53877cd585b0ee30313116ab67f7aac553a71eb
+  data.tar.gz: 6b99388154b691babbd489e16e8ea54e711b9451776e99792cdcf9e3bea8798e7295abf6eabb018d7fb5a0f99d444f0d0b481969743e996d7cd2c18a287cf6e2

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,13 +42,23 @@ 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?
 
-MiniExec.config(project_path: options[:path])
-exec = MiniExec.new options[:job],
-                    docker_url: options[:docker],
-                    binds: options[:binds],
-                    env: options[:env]
+MiniExec::MiniExec.config(project_path: options[:path])
+exec = MiniExec::MiniExec.new options[:job],
+                              docker_url: options[:docker],
+                              binds: options[:binds],
+                              env: options[:env],
+                              mount_cwd: options[:cwd] || false,
+                              file: options[:file]
 exec.run_job

data/lib/miniexec.rb

@@ -1,124 +1,161 @@
 # frozen_string_literal: true
 
 # Main class
-class MiniExec
-  require 'logger'
-  require 'docker-api'
-  require 'json'
-  require 'tempfile'
-  require 'yaml'
-  require 'git'
-  # Class instance variables
-  @project_path = '.'
-  @workflow_file = '.gitlab-ci.yml'
+module MiniExec
+  class MiniExec
+    require 'logger'
+    require 'docker-api'
+    require 'json'
+    require 'tempfile'
+    require 'yaml'
+    require 'git'
+    require_relative './util'
+    # Class instance variables
+    @project_path = '.'
+    @workflow_file = '.gitlab-ci.yml'
 
-  class << self
-    attr_accessor :project_path, :workflow_file
-  end
+    class << self
+      attr_accessor :project_path, :workflow_file
+    end
 
-  def self.config(project_path: @project_path, workflow_file: @workflow_file)
-    @project_path = project_path
-    @workflow_file = workflow_file
-    self
-  end
+    def self.config(project_path: @project_path, workflow_file: @workflow_file)
+      @project_path = project_path
+      @workflow_file = workflow_file
+      self
+    end
 
-  attr_accessor :script
+    attr_accessor :script
+    attr_reader :runlog
 
-  def initialize(job,
-                 project_path: self.class.project_path,
-                 docker_url: nil,
-                 binds: [],
-                 env: {})
-    @job_name = job
-    @project_path = project_path
-    @workflow = YAML.load(File.read("#{@project_path}/#{MiniExec.workflow_file}"))
-    @job = @workflow[job]
-    @job['name'] = job
-    @default_image = @workflow['image'] || 'debian:buster-slim'
-    @image = set_job_image
-    @script = compile_script
-    @binds = binds
-    @env = {}
-    @env.merge! env
-    @env.merge! gitlab_env
-    @env.merge! variables
-    configure_logger
-    Docker.options[:read_timeout] = 6000
-    Docker.url = docker_url if docker_url
-  end
+    def initialize(job,
+                   project_path: self.class.project_path,
+                   docker_url: nil,
+                   binds: [],
+                   env: {},
+                   mount_cwd: true,
+                   file: nil)
+      @job_name = job
+      @project_path = project_path
+      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']
+      ].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
+    end
+
+    def run_job
+      script_path = "/tmp/#{@job['name']}.sh"
+      @logger.info "Fetching image #{@image}"
+      Docker::Image.create(fromImage: @image)
+      @logger.info 'Image fetched'
 
-  def run_job
-    script_path = "/tmp/#{@job['name']}.sh"
-    @logger.info "Fetching image #{@image}"
-    Docker::Image.create(fromImage: @image)
-    @logger.info 'Image fetched'
-    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),
-        Env: @env.map { |k, v| "#{k}=#{v}" }
-      )
-      container.store_file(script_path, @script)
-      container.start({ Binds: [@binds] })
-      container.tap(&:start).attach { |_, chunk| puts chunk }
+      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(
+          Image: @image,
+          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; @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
-  end
 
-  private
+    private
 
-  def set_job_image
-    return @job['image'] if @job['image']
+    def set_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
 
-    @default_image
-  end
+      image || @default_image
+    end
 
-  # Set gitlab's predefined env vars as per
-  # https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
-  def gitlab_env
-    g = Git.open(@project_path)
-    commit = g.gcommit 'HEAD'
-    tag = g.tags.find { |t| t.objectish == commit.sha }
-    commit_branch = g.branch.name
-    if tag.nil?
-      ref_name = g.branch.name
-      commit_tag = nil
-    else
-      ref_name = tag.name
-      commit_tag = ref_name
+    def set_job_entrypoint
+      @job['image']['entrypoint'] if @job['image'].instance_of?(Hash)
     end
-    {
-      'CI': true,
-      'CI_COMMIT_REF_SHA': commit.sha,
-      'CI_COMMIT_SHORT_SHA': commit.sha[0, 8],
-      'CI_COMMIT_REF_NAME': ref_name,
-      'CI_COMMIT_BRANCH': commit_branch,
-      'CI_COMMIT_TAG': commit_tag,
-      'CI_COMMIT_MESSAGE': commit.message,
-      'CI_COMMIT_REF_PROTECTED': false,
-      'CI_COMMIT_TIMESTAMP': commit.date.strftime('%FT%T')
-    }.transform_keys(&:to_s)
-  end
 
-  def variables
-    globals = @workflow['variables'] || {}
-    job_locals = @job['variables'] || {}
-    globals.merge job_locals
-  end
+    # Set gitlab's predefined env vars as per
+    # https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
+    def gitlab_env
+      g = Git.open(@project_path)
+      commit = g.gcommit 'HEAD'
+      tag = g.tags.find { |t| t.objectish == commit.sha }
+      commit_branch = g.branch.name
+      if tag.nil?
+        ref_name = g.branch.name
+        commit_tag = nil
+      else
+        ref_name = tag.name
+        commit_tag = ref_name
+      end
+      {
+        'CI': true,
+        'CI_COMMIT_REF_SHA': commit.sha,
+        'CI_COMMIT_SHORT_SHA': commit.sha[0, 8],
+        'CI_COMMIT_REF_NAME': ref_name,
+        'CI_COMMIT_BRANCH': commit_branch,
+        'CI_COMMIT_TAG': commit_tag,
+        'CI_COMMIT_MESSAGE': commit.message,
+        'CI_COMMIT_REF_PROTECTED': false,
+        'CI_COMMIT_TIMESTAMP': commit.date.strftime('%FT%T')
+      }.transform_keys(&:to_s)
+    end
 
-  def configure_logger
-    @logger = Logger.new($stdout)
-    @logger.formatter = proc do |severity, _, _, msg|
-      "[#{severity}]: #{msg}\n"
+    def variables
+      globals = @workflow['variables'] || {}
+      job_locals = @job['variables'] || {}
+      globals.merge job_locals
+    end
+
+    def configure_logger
+      @logger = Logger.new($stdout)
+      @logger.formatter = proc do |severity, _, _, msg|
+        "[#{severity}]: #{msg}\n"
+      end
+      @logger.level = ENV['LOGLEVEL'] || Logger::INFO
     end
-    @logger.level = ENV['LOGLEVEL'] || Logger::INFO
-  end
 
-  def compile_script
-    before_script = @job['before_script'] || ''
-    script = @job['script'] || ''
-    after_script = @job['after_script'] || ''
-    [before_script, script, after_script].flatten.join("\n").strip
+    def compile_script
+      before_script = @job['before_script'] || ''
+      script = @job['script'] || ''
+      after_script = @job['after_script'] || ''
+      [before_script, script, after_script].flatten.join("\n").strip
+    end
   end
 end

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.0.9
+  version: 0.2.2
 platform: ruby
 authors:
 - Martin Pugh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-27 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