pups 1.0.0 → 1.1.1

data/lib/pups/file_command.rb

@@ -1,37 +1,37 @@
-class Pups::FileCommand < Pups::Command
-  attr_accessor :path, :contents, :params, :type, :chmod
+# frozen_string_literal: true
 
-  def self.from_hash(hash, params)
-    command = new
-    command.path = hash["path"]
-    command.contents = hash["contents"]
-    command.chmod = hash["chmod"]
-    command.params = params
+module Pups
+  class FileCommand < Pups::Command
+    attr_accessor :path, :contents, :params, :type, :chmod, :chown
 
-    command
-  end
+    def self.from_hash(hash, params)
+      command = new
+      command.path = hash['path']
+      command.contents = hash['contents']
+      command.chmod = hash['chmod']
+      command.chown = hash['chown']
+      command.params = params
 
-  def initialize
-    @params = {}
-    @type = :bash
-  end
+      command
+    end
 
-  def params=(p)
-    @params = p
-  end
+    def initialize
+      @params = {}
+      @type = :bash
+    end
 
-  def run
-    path = interpolate_params(@path)
+    attr_writer :params
 
-    `mkdir -p #{File.dirname(path)}`
-    File.open(path, "w") do |f|
-      f.write(interpolate_params(contents))
-    end
-    if @chmod
-      `chmod #{@chmod} #{path}`
+    def run
+      path = interpolate_params(@path)
+
+      `mkdir -p #{File.dirname(path)}`
+      File.open(path, 'w') do |f|
+        f.write(interpolate_params(contents))
+      end
+      `chmod #{@chmod} #{path}` if @chmod
+      `chown #{@chown} #{path}` if @chown
+      Pups.log.info("File > #{path}  chmod: #{@chmod}  chown: #{@chown}")
     end
-    Pups.log.info("File > #{path}  chmod: #{@chmod}")
   end
-
 end
-

data/lib/pups/merge_command.rb

@@ -1,48 +1,50 @@
-class Pups::MergeCommand < Pups::Command
-  attr_reader :filename
-  attr_reader :merge_hash
-
-  def self.from_str(command, params)
-    new(command,params)
-  end
-
-  def self.parse_command(command)
-    split = command.split(" ")
-    raise ArgumentError.new("Invalid merge command #{command}") unless split[-1][0] == "$"
-
-    [split[0..-2].join(" ") , split[-1][1..-1]]
-  end
-
-  def initialize(command, params)
-    @params = params
-
-    filename, target_param = Pups::MergeCommand.parse_command(command)
-    @filename = interpolate_params(filename)
-    @merge_hash = params[target_param]
-  end
-
-  def run
-    merged = self.class.deep_merge(YAML.load_file(@filename), @merge_hash)
-    File.open(@filename,"w"){|f| f.write(merged.to_yaml) }
-    Pups.log.info("Merge: #{@filename} with: \n#{@merge_hash.inspect}")
+# frozen_string_literal: true
+
+module Pups
+  class MergeCommand < Pups::Command
+    attr_reader :filename, :merge_hash
+
+    def self.from_str(command, params)
+      new(command, params)
+    end
+
+    def self.parse_command(command)
+      split = command.split(' ')
+      raise ArgumentError, "Invalid merge command #{command}" unless split[-1][0] == '$'
+
+      [split[0..-2].join(' '), split[-1][1..-1]]
+    end
+
+    def initialize(command, params)
+      @params = params
+
+      filename, target_param = Pups::MergeCommand.parse_command(command)
+      @filename = interpolate_params(filename)
+      @merge_hash = params[target_param]
+    end
+
+    def run
+      merged = self.class.deep_merge(YAML.load_file(@filename), @merge_hash)
+      File.open(@filename, 'w') { |f| f.write(merged.to_yaml) }
+      Pups.log.info("Merge: #{@filename} with: \n#{@merge_hash.inspect}")
+    end
+
+    def self.deep_merge(first, second, *args)
+      args ||= []
+      merge_arrays = args.include? :merge_arrays
+
+      merger = proc { |_key, v1, v2|
+        if v1.is_a?(Hash) && v2.is_a?(Hash)
+          v1.merge(v2, &merger)
+        elsif v1.is_a?(Array) && v2.is_a?(Array)
+          merge_arrays ? v1 + v2 : v2
+        elsif v2.is_a?(NilClass)
+          v1
+        else
+          v2
+        end
+      }
+      first.merge(second, &merger)
+    end
   end
-
-  def self.deep_merge(first,second, *args)
-    args ||= []
-    merge_arrays = args.include? :merge_arrays
-
-    merger = proc { |key, v1, v2|
-      if Hash === v1 && Hash === v2
-        v1.merge(v2, &merger)
-      elsif Array === v1 && Array === v2
-        merge_arrays ? v1 + v2 : v2
-      elsif NilClass === v2
-        v1
-      else
-        v2
-      end
-    }
-    first.merge(second, &merger)
-  end
-
 end

data/lib/pups/replace_command.rb

@@ -1,43 +1,45 @@
-class Pups::ReplaceCommand < Pups::Command
-  attr_accessor :text, :from, :to, :filename, :direction, :global
+# frozen_string_literal: true
 
-  def self.from_hash(hash, params)
-    replacer = new(params)
-    replacer.from = guess_replace_type(hash["from"])
-    replacer.to = guess_replace_type(hash["to"])
-    replacer.text = File.read(hash["filename"])
-    replacer.filename = hash["filename"]
-    replacer.direction = hash["direction"].to_sym if hash["direction"]
-    replacer.global = hash["global"].to_s == "true"
-    replacer
-  end
+module Pups
+  class ReplaceCommand < Pups::Command
+    attr_accessor :text, :from, :to, :filename, :direction, :global
 
-  def self.guess_replace_type(item)
-    # evaling to get all the regex flags easily
-    item[0] == "/" ? eval(item) : item
-  end
+    def self.from_hash(hash, params)
+      replacer = new(params)
+      replacer.from = guess_replace_type(hash['from'])
+      replacer.to = guess_replace_type(hash['to'])
+      replacer.text = File.read(hash['filename'])
+      replacer.filename = hash['filename']
+      replacer.direction = hash['direction'].to_sym if hash['direction']
+      replacer.global = hash['global'].to_s == 'true'
+      replacer
+    end
 
-  def initialize(params)
-    @params = params
-  end
+    def self.guess_replace_type(item)
+      # evaling to get all the regex flags easily
+      item[0] == '/' ? eval(item) : item
+    end
 
-  def replaced_text
-    new_to = to
-    if String === to
-      new_to = interpolate_params(to)
+    def initialize(params)
+      @params = params
     end
-    if global
-      text.gsub(from,new_to)
-    elsif direction == :reverse
-      index = text.rindex(from)
-      text[0..index-1] << text[index..-1].sub(from,new_to)
-    else
-      text.sub(from,new_to)
+
+    def replaced_text
+      new_to = to
+      new_to = interpolate_params(to) if to.is_a?(String)
+      if global
+        text.gsub(from, new_to)
+      elsif direction == :reverse
+        index = text.rindex(from)
+        text[0..index - 1] << text[index..-1].sub(from, new_to)
+      else
+        text.sub(from, new_to)
+      end
     end
-  end
 
-  def run
-    Pups.log.info("Replacing #{from.to_s} with #{to.to_s} in #{filename}")
-    File.open(filename, "w"){|f| f.write replaced_text }
+    def run
+      Pups.log.info("Replacing #{from} with #{to} in #{filename}")
+      File.open(filename, 'w') { |f| f.write replaced_text }
+    end
   end
 end

data/lib/pups/runit.rb

@@ -1,40 +1,39 @@
-class Pups::Runit
+# frozen_string_literal: true
 
-  attr_accessor :env, :exec, :cd, :name
+module Pups
+  class Runit
+    attr_accessor :env, :exec, :cd, :name
 
+    def initialize(name)
+      @name = name
+    end
 
-  def initialize(name)
-    @name = name
-  end
-
-  def setup
-    `mkdir -p /etc/service/#{name}`
-    run = "/etc/service/#{name}/run"
-    File.open(run, "w") do |f|
-      f.write(run_script)
+    def setup
+      `mkdir -p /etc/service/#{name}`
+      run = "/etc/service/#{name}/run"
+      File.open(run, 'w') do |f|
+        f.write(run_script)
+      end
+      `chmod +x #{run}`
     end
-    `chmod +x #{run}`
-  end
 
-  def run_script
-"#!/bin/bash
+    def run_script
+      "#!/bin/bash
 exec 2>&1
 #{env_script}
 #{cd_script}
 #{exec}
 "
-  end
+    end
 
-  def cd_script
-    "cd #{@cd}" if @cd
-  end
+    def cd_script
+      "cd #{@cd}" if @cd
+    end
 
-  def env_script
-    if @env
-      @env.map do |k,v|
+    def env_script
+      @env&.map do |k, v|
         "export #{k}=#{v}"
-      end.join("\n")
+      end&.join("\n")
     end
   end
-
 end

data/lib/pups/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pups
-  VERSION = "1.0.0"
+  VERSION = '1.1.1'
 end

data/pups.gemspec

@@ -1,26 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pups/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "pups"
+  spec.name          = 'pups'
   spec.version       = Pups::VERSION
-  spec.authors       = ["Sam Saffron"]
-  spec.email         = ["sam.saffron@gmail.com"]
-  spec.description   = %q{Process orchestrator}
-  spec.summary       = %q{Process orchestrator}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Sam Saffron']
+  spec.email         = ['sam.saffron@gmail.com']
+  spec.description   = 'Simple docker image creator'
+  spec.summary       = 'Toolkit for orchestrating a composed docker image'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-discourse'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-rake'
 end

data/test/cli_test.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'tempfile'
+require 'stringio'
+
+module Pups
+  class CliTest < MiniTest::Test
+    def test_cli_option_parsing_stdin
+      options = Cli.parse_args(['--stdin'])
+      assert_equal(true, options[:stdin])
+    end
+
+    def test_cli_option_parsing_none
+      options = Cli.parse_args([])
+      assert_nil(options[:stdin])
+    end
+
+    def test_cli_read_config_from_file
+      # for testing output
+      f = Tempfile.new('test_output')
+      f.close
+
+      # for testing input
+      cf = Tempfile.new('test_config')
+      cf.puts <<~YAML
+      params:
+        run: #{f.path}
+      run:
+        - exec: echo hello world >> #{f.path}
+      YAML
+      cf.close
+
+      Cli.run([cf.path])
+      assert_equal('hello world', File.read(f.path).strip)
+    end
+
+    def test_cli_ignore_config_element
+      # for testing output
+      f = Tempfile.new('test_output')
+      f.close
+
+      # for testing input
+      cf = Tempfile.new('test_config')
+      cf.puts <<~YAML
+        env:
+          MY_IGNORED_VAR: a_word
+        params:
+          a_param_var: another_word
+        run:
+          - exec: echo repeating $MY_IGNORED_VAR and also $a_param_var >> #{f.path}
+      YAML
+      cf.close
+
+      Cli.run(["--ignore", "env,params", cf.path])
+      assert_equal('repeating and also', File.read(f.path).strip)
+    end
+
+    def test_cli_gen_docker_run_args_ignores_other_config
+      # When generating the docker run arguments it should ignore other template configuration
+      # like 'run' directives.
+
+      # for testing output
+      f = Tempfile.new("test_output")
+      f.close
+
+      # for testing input
+      cf = Tempfile.new("test_config")
+      cf.puts <<~YAML
+      env:
+        foo: 1
+        bar: 5
+        baz: 'hello_{{spam}}'
+      env_template:
+        spam: 'eggs'
+        config: my_app
+      params:
+        run: #{f.path}
+      run:
+        - exec: echo hello world >> #{f.path}
+      expose:
+        - "2222:22"
+        - "127.0.0.1:20080:80"
+        - 5555
+      volumes:
+        - volume:
+            host: /var/discourse/shared
+            guest: /shared
+        - volume:
+            host: /bar
+            guest: /baz
+      links:
+        - link:
+            name: postgres
+            alias: postgres
+        - link:
+            name: foo
+            alias: bar
+      labels:
+        monitor: "true"
+        app_name: "{{config}}_discourse"
+      YAML
+      cf.close
+
+      expected = []
+      expected << "--env foo=1 --env bar=5 --env baz=hello_eggs"
+      expected << "--publish 2222:22 --publish 127.0.0.1:20080:80 --expose 5555"
+      expected << "--volume /var/discourse/shared:/shared --volume /bar:/baz"
+      expected << "--link postgres:postgres --link foo:bar"
+      expected << "--label monitor=true --label app_name=my_app_discourse"
+      expected.sort!
+
+      assert_equal("", File.read(f.path).strip)
+      assert_output(expected.join(" ")) { Cli.run(["--gen-docker-run-args", cf.path]) }
+    end
+  end
+end