pups 1.1.1 → 1.2.1

data/lib/pups/merge_command.rb

@@ -9,10 +9,12 @@ module Pups
     end
 
     def self.parse_command(command)
-      split = command.split(' ')
-      raise ArgumentError, "Invalid merge command #{command}" unless split[-1][0] == '$'
+      split = command.split(" ")
+      unless split[-1][0] == "$"
+        raise ArgumentError, "Invalid merge command #{command}"
+      end
 
-      [split[0..-2].join(' '), split[-1][1..-1]]
+      [split[0..-2].join(" "), split[-1][1..-1]]
     end
 
     def initialize(command, params)
@@ -25,7 +27,7 @@ module Pups
 
     def run
       merged = self.class.deep_merge(YAML.load_file(@filename), @merge_hash)
-      File.open(@filename, 'w') { |f| f.write(merged.to_yaml) }
+      File.open(@filename, "w") { |f| f.write(merged.to_yaml) }
       Pups.log.info("Merge: #{@filename} with: \n#{@merge_hash.inspect}")
     end
 
@@ -33,17 +35,18 @@ module Pups
       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
+      merger =
+        proc do |_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
         end
-      }
       first.merge(second, &merger)
     end
   end

data/lib/pups/replace_command.rb

@@ -6,18 +6,18 @@ module Pups
 
     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.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 self.guess_replace_type(item)
       # evaling to get all the regex flags easily
-      item[0] == '/' ? eval(item) : item
+      item[0] == "/" ? eval(item) : item # rubocop:disable Security/Eval
     end
 
     def initialize(params)
@@ -39,7 +39,7 @@ module Pups
 
     def run
       Pups.log.info("Replacing #{from} with #{to} in #{filename}")
-      File.open(filename, 'w') { |f| f.write replaced_text }
+      File.open(filename, "w") { |f| f.write replaced_text }
     end
   end
 end

data/lib/pups/runit.rb

@@ -11,9 +11,7 @@ module Pups
     def setup
       `mkdir -p /etc/service/#{name}`
       run = "/etc/service/#{name}/run"
-      File.open(run, 'w') do |f|
-        f.write(run_script)
-      end
+      File.open(run, "w") { |f| f.write(run_script) }
       `chmod +x #{run}`
     end
 
@@ -31,9 +29,7 @@ exec 2>&1
     end
 
     def env_script
-      @env&.map do |k, v|
-        "export #{k}=#{v}"
-      end&.join("\n")
+      @env&.map { |k, v| "export #{k}=#{v}" }&.join("\n")
     end
   end
 end

data/lib/pups/version.rb

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

data/lib/pups.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require 'logger'
-require 'yaml'
+require "logger"
+require "yaml"
 
-require 'pups/version'
-require 'pups/config'
-require 'pups/command'
-require 'pups/exec_command'
-require 'pups/merge_command'
-require 'pups/replace_command'
-require 'pups/file_command'
-require 'pups/docker'
-require 'pups/runit'
+require "pups/version"
+require "pups/config"
+require "pups/command"
+require "pups/exec_command"
+require "pups/merge_command"
+require "pups/replace_command"
+require "pups/file_command"
+require "pups/docker"
+require "pups/runit"
 
 module Pups
   class ExecError < RuntimeError
@@ -28,9 +28,7 @@ module Pups
   end
 
   def self.silence
-    if @logger
-      @logger.close
-    end
+    @logger.close if @logger
 
     @logger = Logger.new(File.open(File::NULL, "w"))
   end

data/test/cli_test.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'test_helper'
-require 'tempfile'
-require 'stringio'
+require "test_helper"
+require "tempfile"
+require "stringio"
 
 module Pups
-  class CliTest < MiniTest::Test
+  class CliTest < ::Minitest::Test
     def test_cli_option_parsing_stdin
-      options = Cli.parse_args(['--stdin'])
+      options = Cli.parse_args(["--stdin"])
       assert_equal(true, options[:stdin])
     end
 
@@ -18,11 +18,11 @@ module Pups
 
     def test_cli_read_config_from_file
       # for testing output
-      f = Tempfile.new('test_output')
+      f = Tempfile.new("test_output")
       f.close
 
       # for testing input
-      cf = Tempfile.new('test_config')
+      cf = Tempfile.new("test_config")
       cf.puts <<~YAML
       params:
         run: #{f.path}
@@ -32,16 +32,16 @@ module Pups
       cf.close
 
       Cli.run([cf.path])
-      assert_equal('hello world', File.read(f.path).strip)
+      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 = Tempfile.new("test_output")
       f.close
 
       # for testing input
-      cf = Tempfile.new('test_config')
+      cf = Tempfile.new("test_config")
       cf.puts <<~YAML
         env:
           MY_IGNORED_VAR: a_word
@@ -53,7 +53,7 @@ module Pups
       cf.close
 
       Cli.run(["--ignore", "env,params", cf.path])
-      assert_equal('repeating and also', File.read(f.path).strip)
+      assert_equal("repeating and also", File.read(f.path).strip)
     end
 
     def test_cli_gen_docker_run_args_ignores_other_config
@@ -111,7 +111,58 @@ module Pups
       expected.sort!
 
       assert_equal("", File.read(f.path).strip)
-      assert_output(expected.join(" ")) { Cli.run(["--gen-docker-run-args", cf.path]) }
+      assert_output(expected.join(" ")) do
+        Cli.run(["--gen-docker-run-args", cf.path])
+      end
+    end
+
+    def test_cli_tags
+      # for testing output
+      f = Tempfile.new("test_output")
+      f.close
+
+      # for testing input
+      cf = Tempfile.new("test_config")
+      cf.puts <<~YAML
+        run:
+          - exec:
+              tag: '1'
+              cmd: echo 1 >> #{f.path}
+          - exec:
+              tag: '2'
+              cmd: echo 2 >> #{f.path}
+          - exec:
+              tag: '3'
+              cmd: echo 3 >> #{f.path}
+      YAML
+      cf.close
+
+      Cli.run(["--tags", "1,3", cf.path])
+      assert_equal("1\n3", File.read(f.path).strip)
+    end
+    def test_cli_skip_tags
+      # for testing output
+      f = Tempfile.new("test_output")
+      f.close
+
+      # for testing input
+      cf = Tempfile.new("test_config")
+      cf.puts <<~YAML
+        run:
+          - exec:
+              tag: '1'
+              cmd: echo 1 >> #{f.path}
+          - exec:
+              tag: '2'
+              cmd: echo 2 >> #{f.path}
+          - exec:
+              tag: '3'
+              cmd: echo 3 >> #{f.path}
+      YAML
+      cf.close
+
+      Cli.run(["--skip-tags", "1,3", cf.path])
+      assert_equal("2", File.read(f.path).strip)
     end
   end
 end

data/test/config_test.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'test_helper'
-require 'tempfile'
+require "test_helper"
+require "tempfile"
 
 module Pups
-  class ConfigTest < MiniTest::Test
+  class ConfigTest < ::Minitest::Test
     def test_config_from_env
-      ENV['HELLO'] = 'world'
+      ENV["HELLO"] = "world"
       config = Config.new({})
-      assert_equal('world', config.params['$ENV_HELLO'])
+      assert_equal("world", config.params["$ENV_HELLO"])
     end
 
     def test_env_param
-      ENV['FOO'] = 'BAR'
+      ENV["FOO"] = "BAR"
       config = <<~YAML
         env:
           BAR: baz
@@ -22,14 +22,14 @@ module Pups
 
       config = Config.new(YAML.safe_load(config))
       %w[BAR hello one].each { |e| ENV.delete(e) }
-      assert_equal('BAR', config.params['$ENV_FOO'])
-      assert_equal('baz', config.params['$ENV_BAR'])
-      assert_equal('WORLD', config.params['$ENV_hello'])
-      assert_equal('1', config.params['$ENV_one'])
+      assert_equal("BAR", config.params["$ENV_FOO"])
+      assert_equal("baz", config.params["$ENV_BAR"])
+      assert_equal("WORLD", config.params["$ENV_hello"])
+      assert_equal("1", config.params["$ENV_one"])
     end
 
     def test_env_with_template
-      ENV['FOO'] = 'BAR'
+      ENV["FOO"] = "BAR"
       config = <<~YAML
         env:
           greeting: "{{hello}}, {{planet}}!"
@@ -43,10 +43,10 @@ module Pups
 
       config = Config.new(config_hash)
       %w[greeting one other].each { |e| ENV.delete(e) }
-      assert_equal('hola, pluto!', config.params['$ENV_greeting'])
-      assert_equal('1', config.params['$ENV_one'])
-      assert_equal('BAR', config.params['$ENV_FOO'])
-      assert_equal('where are we on pluto?', config.params['$ENV_other'])
+      assert_equal("hola, pluto!", config.params["$ENV_greeting"])
+      assert_equal("1", config.params["$ENV_one"])
+      assert_equal("BAR", config.params["$ENV_FOO"])
+      assert_equal("where are we on pluto?", config.params["$ENV_other"])
     end
 
     def test_label_with_template
@@ -67,11 +67,11 @@ module Pups
 
       config = Config.new(config_hash)
       %w[greeting one other].each { |e| ENV.delete(e) }
-      assert_equal("various_discourse", config.config['labels']['app_name'])
+      assert_equal("various_discourse", config.config["labels"]["app_name"])
     end
 
     def test_env_with_ENV_templated_variable
-      ENV['env_template_config'] = 'my_application'
+      ENV["env_template_config"] = "my_application"
       config = <<~YAML
         env:
           greeting: "{{hello}}, {{planet}}!"
@@ -85,14 +85,14 @@ module Pups
 
       config = Config.new(config_hash)
       %w[greeting one other].each { |e| ENV.delete(e) }
-      assert_equal('hola, pluto!', config.params['$ENV_greeting'])
-      assert_equal('1', config.params['$ENV_one'])
-      assert_equal('building my_application', config.params['$ENV_other'])
+      assert_equal("hola, pluto!", config.params["$ENV_greeting"])
+      assert_equal("1", config.params["$ENV_one"])
+      assert_equal("building my_application", config.params["$ENV_other"])
       ENV["env_template_config"] = nil
     end
 
     def test_integration
-      f = Tempfile.new('test')
+      f = Tempfile.new("test")
       f.close
 
       config = <<~YAML
@@ -106,8 +106,8 @@ module Pups
       YAML
 
       Config.new(YAML.safe_load(config)).run
-      ENV.delete('PLANET')
-      assert_equal('hello world', File.read(f.path).strip)
+      ENV.delete("PLANET")
+      assert_equal("hello world", File.read(f.path).strip)
     ensure
       f.unlink
     end
@@ -128,12 +128,12 @@ module Pups
       YAML
 
       config = Config.load_config(yaml).config
-      assert_equal({ 'exec' => 1.9 }, config['run'][1])
-      assert_equal({ 'exec' => 2.1 }, config['run'][3])
+      assert_equal({ "exec" => 1.9 }, config["run"][1])
+      assert_equal({ "exec" => 2.1 }, config["run"][3])
     end
 
     def test_ignored_elements
-      f = Tempfile.new('test')
+      f = Tempfile.new("test")
       f.close
 
       yaml = <<~YAML
@@ -157,15 +157,21 @@ module Pups
 
       conf = Config.load_config(yaml, %w[hooks params])
       config = conf.config
-      assert_equal({ 'exec' => 1 }, config['run'][0])
-      assert_equal({ 'exec' => { 'hook' => 'middle', 'cmd' => 2 } }, config['run'][1])
-      assert_equal({ 'exec' => 3 }, config['run'][2])
-      assert_equal({ 'exec' => "echo $greeting $PLANET >> #{f.path}" }, config['run'][3])
+      assert_equal({ "exec" => 1 }, config["run"][0])
+      assert_equal(
+        { "exec" => { "hook" => "middle", "cmd" => 2 } },
+        config["run"][1]
+      )
+      assert_equal({ "exec" => 3 }, config["run"][2])
+      assert_equal(
+        { "exec" => "echo $greeting $PLANET >> #{f.path}" },
+        config["run"][3]
+      )
 
       # $greet from params will be an empty var as it was ignored
       conf.run
-      ENV.delete('PLANET')
-      assert_equal('world', File.read(f.path).strip)
+      ENV.delete("PLANET")
+      assert_equal("world", File.read(f.path).strip)
     end
 
     def test_generate_docker_run_arguments
@@ -213,5 +219,69 @@ module Pups
 
       assert_equal(expected.join(" "), args)
     end
+
+    def test_tag_filtering
+      f = Tempfile.new("test")
+      f.close
+
+      yaml = <<~YAML
+        run:
+          - exec: 1
+          - exec:
+              hook: middle
+              cmd: 2
+              tag: one_tag
+          - exec:
+              cmd: 3
+              tag: two_tag
+        hooks:
+          after_middle:
+            - exec: 2.1
+          before_middle:
+            - exec: 1.9
+      YAML
+
+      # No tagging loads everything
+      conf = Config.load_config(yaml)
+      config = conf.config
+      assert_equal({ "exec" => 1 }, config["run"][0])
+      assert_equal({ "exec" => 1.9 }, config["run"][1])
+      assert_equal(
+        { "exec" => { "hook" => "middle", "cmd" => 2, "tag" => "one_tag" } },
+        config["run"][2]
+      )
+      assert_equal({ "exec" => 2.1 }, config["run"][3])
+      assert_equal(
+        { "exec" => { "cmd" => 3, "tag" => "two_tag" } },
+        config["run"][4]
+      )
+
+      # hooks get applied if hook command is not filtered
+      conf = Config.load_config(yaml, tags: ["one_tag"])
+      config = conf.config
+      assert_equal({ "exec" => 1.9 }, config["run"][0])
+      assert_equal(
+        { "exec" => { "hook" => "middle", "cmd" => 2, "tag" => "one_tag" } },
+        config["run"][1]
+      )
+      assert_equal({ "exec" => 2.1 }, config["run"][2])
+
+      # hooks get filtered out if the main hook command is filtered
+      conf = Config.load_config(yaml, tags: ["two_tag"])
+      config = conf.config
+      assert_equal(
+        { "exec" => { "cmd" => 3, "tag" => "two_tag" } },
+        config["run"][0]
+      )
+
+      # skip tags filter out commands with tags
+      conf = Config.load_config(yaml, skip_tags: ["one_tag"])
+      config = conf.config
+      assert_equal({ "exec" => 1 }, config["run"][0])
+      assert_equal(
+        { "exec" => { "cmd" => 3, "tag" => "two_tag" } },
+        config["run"][1]
+      )
+    end
   end
 end

data/test/docker_test.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
-require 'test_helper'
-require 'tempfile'
-require 'shellwords'
+require "test_helper"
+require "tempfile"
+require "shellwords"
 
 module Pups
-  class DockerTest < MiniTest::Test
+  class DockerTest < ::Minitest::Test
     def test_gen_env_arguments
       yaml = <<~YAML
       env:
@@ -16,7 +16,10 @@ module Pups
       YAML
 
       config = Config.load_config(yaml)
-      Config.transform_config_with_templated_vars(config.config['env_template'], config.config["env"])
+      Config.transform_config_with_templated_vars(
+        config.config["env_template"],
+        config.config["env"]
+      )
       args = Docker.generate_env_arguments(config.config["env"])
       assert_equal("--env foo=1 --env bar=2 --env baz=hello_eggs", args)
     end
@@ -30,7 +33,10 @@ module Pups
       YAML
 
       config = Config.load_config(yaml)
-      Config.transform_config_with_templated_vars(config.config['env_template'], config.config["env"])
+      Config.transform_config_with_templated_vars(
+        config.config["env_template"],
+        config.config["env"]
+      )
       args = Docker.generate_env_arguments(config.config["env"])
       assert_equal("--env foo=1 --env bar=2", args)
     end
@@ -44,9 +50,15 @@ module Pups
       YAML
 
       config = Config.load_config(yaml)
-      Config.transform_config_with_templated_vars(config.config['env_template'], config.config["env"])
+      Config.transform_config_with_templated_vars(
+        config.config["env_template"],
+        config.config["env"]
+      )
       args = Docker.generate_env_arguments(config.config["env"])
-      assert_equal("--env password=#{Shellwords.escape('eggs*`echo`@e$t| = >>$()&list;#')}", args)
+      assert_equal(
+        "--env password=#{Shellwords.escape("eggs*`echo`@e$t| = >>$()&list;#")}",
+        args
+      )
     end
 
     def test_gen_env_arguments_quoted_with_a_space
@@ -56,7 +68,10 @@ module Pups
       YAML
 
       config = Config.load_config(yaml)
-      Config.transform_config_with_templated_vars(config.config['env_template'], config.config["env"])
+      Config.transform_config_with_templated_vars(
+        config.config["env_template"],
+        config.config["env"]
+      )
       args = Docker.generate_env_arguments(config.config["env"])
       assert_equal('--env a_variable=here\ is\ a\ sentence', args)
     end
@@ -75,7 +90,10 @@ this password is
       YAML
 
       config = Config.load_config(yaml)
-      Config.transform_config_with_templated_vars(config.config['env_template'], config.config["env"])
+      Config.transform_config_with_templated_vars(
+        config.config["env_template"],
+        config.config["env"]
+      )
       args = Docker.generate_env_arguments(config.config["env"])
       assert_equal('--env password=this\ password\ is\ a\ weird\ one\ ', args)
     end
@@ -90,7 +108,10 @@ this password is
 
       config = Config.load_config(yaml)
       args = Docker.generate_expose_arguments(config.config["expose"])
-      assert_equal("--publish 2222:22 --publish 127.0.0.1:20080:80 --expose 5555", args)
+      assert_equal(
+        "--publish 2222:22 --publish 127.0.0.1:20080:80 --expose 5555",
+        args
+      )
     end
 
     def test_gen_volume_arguments
@@ -106,7 +127,10 @@ this password is
 
       config = Config.load_config(yaml)
       args = Docker.generate_volume_arguments(config.config["volumes"])
-      assert_equal("--volume /var/discourse/shared:/shared --volume /bar:/baz", args)
+      assert_equal(
+        "--volume /var/discourse/shared:/shared --volume /bar:/baz",
+        args
+      )
     end
 
     def test_gen_link_arguments
@@ -135,9 +159,15 @@ this password is
       YAML
 
       config = Config.load_config(yaml)
-      Config.transform_config_with_templated_vars(config.config['env_template'], config.config["labels"])
+      Config.transform_config_with_templated_vars(
+        config.config["env_template"],
+        config.config["labels"]
+      )
       args = Docker.generate_label_arguments(config.config["labels"])
-      assert_equal("--label monitor=true --label app_name=my_app_discourse", args)
+      assert_equal(
+        "--label monitor=true --label app_name=my_app_discourse",
+        args
+      )
     end
 
     def test_gen_label_arguments_escaped
@@ -149,9 +179,15 @@ this password is
       YAML
 
       config = Config.load_config(yaml)
-      Config.transform_config_with_templated_vars(config.config['env_template'], config.config["labels"])
+      Config.transform_config_with_templated_vars(
+        config.config["env_template"],
+        config.config["labels"]
+      )
       args = Docker.generate_label_arguments(config.config["labels"])
-      assert_equal("--label app_name=#{Shellwords.escape("my_app's_di$course")}", args)
+      assert_equal(
+        "--label app_name=#{Shellwords.escape("my_app's_di$course")}",
+        args
+      )
     end
   end
 end