chef 18.4.2 → 18.5.0

data/lib/chef/target_io/train/dir.rb

@@ -0,0 +1,69 @@
+require_relative "file"
+require_relative "fileutils"
+
+module TargetIO
+  module TrainCompat
+    class Dir
+      class << self
+        # TODO: chdir, mktmpdir, pwd, home (Used in Resources)
+
+        def [](*patterns, base: ".", sort: true)
+          Dir.glob(patterns, 0, base, sort)
+        end
+
+        def delete(dir_name)
+          ::TargetIO::FileUtils.rm_rf(dir_name)
+        end
+
+        def directory?(dir_name)
+          ::TargetIO::File.directory? dir_name
+        end
+
+        def entries(dirname)
+          cmd = "ls -1a #{dirname}"
+          output = __run_command(cmd).stdout
+          output.split("\n")
+        end
+
+        def glob(pattern, flags = 0, base: ".", sort: true)
+          raise "Dir.glob flags not supported except FNM_DOTMATCH" unless [0, ::File::FNM_DOTMATCH].include? flags
+
+          pattern  = Array(pattern)
+          matchdot = flags || ::File::FNM_DOTMATCH ? "dotglob" : ""
+
+          # TODO: Check for bash remotely
+          cmd += <<-BASH4
+            shopt -s globstar #{matchdot}
+            cd #{base}
+            for f in #{pattern.join(" ")}; do
+              printf '%s\n' "$f";
+            done
+          BASH4
+
+          output = __run_command(cmd).stdout
+          files  = output.split("\n")
+          files.sort! if sort
+
+          files
+        end
+
+        def mkdir(dir_name, mode = nil)
+          ::TargetIO::FileUtils.mkdir(dir_name)
+          ::TargetIO::FileUtils.chmod(dir_name, mode) if mode
+        end
+
+        def unlink(dir_name)
+          ::TargetIO::FileUtils.rmdir(dir_name)
+        end
+
+        def __run_command(cmd)
+          __transport_connection.run_command(cmd)
+        end
+
+        def __transport_connection
+          Chef.run_context&.transport_connection
+        end
+      end
+    end
+  end
+end

data/lib/chef/target_io/train/etc.rb

@@ -0,0 +1,112 @@
+require_relative "file"
+
+module TargetIO
+  module TrainCompat
+    class Etc
+      @@cache = {}
+
+      class << self
+        def getpwnam(name)
+          __getpw { |entry| entry["user"] == name }
+        end
+
+        def getpwuid(uid)
+          __getpw { |entry| entry["uid"] == uid.to_i }
+        end
+
+        def getgrnam(name)
+          __getgr { |entry| entry["name"] == name }
+        end
+
+        def getgrgid(gid)
+          __getgr { |entry| entry["gid"] == gid.to_i }
+        end
+
+        def __getpw(&block)
+          content = ::TargetIO::File.read("/etc/passwd")
+          entries = __parse_passwd(content)
+          data    = entries.detect(&block)
+          raise ArgumentError unless data
+
+          ::Etc::Passwd.new(
+            data["user"],
+            data["password"],
+            data["uid"].to_i,
+            data["gid"].to_i,
+            data["desc"],
+            data["home"],
+            data["shell"]
+          )
+        end
+
+        # Parse /etc/passwd files.
+        # Courtesy of InSpec
+        #
+        # @param [String] content the raw content of /etc/passwd
+        # @return [Array] Collection of passwd entries
+        def __parse_passwd(content)
+          content.to_s.split("\n").map do |line|
+            next if line[0] == "#"
+
+            __parse_passwd_line(line)
+          end.compact
+        end
+
+        # Parse a line of /etc/passwd
+        #
+        # @param [String] line a line of /etc/passwd
+        # @return [Hash] Map of entries in this line
+        def __parse_passwd_line(line)
+          x = line.split(":")
+          {
+            # rubocop:disable Layout/AlignHash
+            "user"     => x.at(0),
+            "password" => x.at(1),
+            "uid"      => x.at(2),
+            "gid"      => x.at(3),
+            "desc"     => x.at(4),
+            "home"     => x.at(5),
+            "shell"    => x.at(6),
+          }
+        end
+
+        def __getgr(&block)
+          content = ::TargetIO::File.read("/etc/group")
+          entries = __parse_group(content)
+          data    = entries.detect(&block)
+          raise ArgumentError unless data
+
+          ::Etc::Group.new(
+            data["name"],
+            data["password"],
+            data["gid"].to_i,
+            String(data["mem"]).split(",")
+          )
+        end
+
+        def __parse_group(content)
+          content.to_s.split("\n").map do |line|
+            next if line[0] == "#"
+
+            __parse_group_line(line)
+          end.compact
+        end
+
+        def __parse_group_line(line)
+          x = line.split(":")
+          {
+            # rubocop:disable Layout/AlignHash
+            "name"     => x.at(0),
+            "password" => x.at(1),
+            "gid"      => x.at(2),
+            "mem"      => x.at(3),
+          }
+        end
+
+        def __transport_connection
+          Chef.run_context&.transport_connection
+        end
+      end
+    end
+  end
+end

data/lib/chef/target_io/train/file.rb

@@ -0,0 +1,219 @@
+module TargetIO
+  module TrainCompat
+    class File
+      class << self
+        def foreach(name)
+          raise "TargetIO does not implement block-less File.foreach yet" unless block_given?
+
+          contents = readlines(name)
+          contents.each { |line| yield(line) }
+        end
+
+        def binread(name, length = nil, offset = 0)
+          content = read(file_name)
+          length = content.size - offset if length.nil?
+
+          content[offset, length]
+        end
+
+        def expand_path(file_name, dir_string = "")
+          require "pathname" unless defined?(Pathname)
+
+          # Will just collapse relative paths inside
+          pn = Pathname.new File.join(dir_string, file_name)
+          pn.cleanpath
+        end
+
+        def new(filename, mode = "r")
+          # Would need to hook into io.close (Closure?)
+          raise NotImplementedError, "TargetIO does not implement File.new yet"
+        end
+
+        def read(file_name)
+          readlines(file_name)&.join("\n") || ""
+        end
+
+        def open(file_name, mode = "r")
+          # Would need to hook into io.close (Closure?)
+          raise "TargetIO does not implement block-less File.open with modes other than read yet" if mode != "r" && !block_given?
+
+          content = read(file_name)
+          new_content = content.dup
+
+          io = StringIO.new(new_content)
+
+          if mode.start_with? "w"
+            io.truncate(0)
+          elsif mode.start_with? "a"
+            io.seek(0, IO::SEEK_END)
+          end
+
+          if block_given?
+            yield(io)
+
+            if (content != new_content) && !mode.start_with?("r")
+              __transport_connection.file(file_name).content = new_content # Need Train 2.5+
+            end
+          end
+
+          io
+        end
+
+        def readlines(file_name)
+          content = __transport_connection.file(file_name).content
+          raise Errno::ENOENT if content.nil? # Not found
+
+          content.split("\n")
+        end
+
+        ### START Could be in Train::File::...
+
+        def executable?(file_name)
+          mode(file_name) & 0111 != 0
+        end
+
+        def readable?(file_name)
+          cmd = format("test -r %s", file_name)
+          __transport_connection.run_command(cmd).exit_status == 0
+        end
+
+        def writable?(file_name)
+          cmd = format("test -w %s", file_name)
+          __transport_connection.run_command(cmd).exit_status == 0
+        end
+
+        # def ftype(file_name)
+        #   case type(file_name)
+        #   when :block_device
+        #     "blockSpecial"
+        #   when :character_device
+        #     "characterSpecial"
+        #   when :symlink
+        #     "link"
+        #   else
+        #     type(file_name).to_s
+        #   end
+        # end
+
+        def realpath(file_name)
+          cmd = "realpath #{file_name}" # coreutils, not MacOSX
+          Chef::Log.debug cmd
+
+          __transport_connection.run_command(cmd).stdout.chop
+        end
+
+        def readlink(file_name)
+          raise Errno::EINVAL unless symlink?(file_name)
+
+          cmd = "readlink #{file_name}"
+          Chef::Log.debug cmd
+
+          __transport_connection.run_command(cmd).stdout.chop
+        end
+
+        # def setgid?(file_name)
+        #   mode(file_name) & 04000 != 0
+        # end
+
+        # def setuid?(file_name)
+        #   mode(file_name) & 02000 != 0
+        # end
+
+        # def sticky?(file_name)
+        #   mode(file_name) & 01000 != 0
+        # end
+
+        # def size?(file_name)
+        #   exist?(file_name) && size(file_name) > 0
+        # end
+
+        # def world_readable?(file_name)
+        #   mode(file_name) & 0001 != 0
+        # end
+
+        # def world_writable?(file_name)
+        #   mode(file_name) & 0002 != 0
+        # end
+
+        # def zero?(file_name)
+        #   exists?(file_name) && size(file_name) == 0
+        # end
+
+        ### END: Could be in Train
+
+        # passthrough or map calls to third parties
+        def method_missing(m, *args, **kwargs, &block)
+          nonio    = %i{extname join dirname path split}
+
+          # TODO: writable?
+          passthru = %i{basename directory? exist? exists? file? path pipe? socket? symlink?}
+          redirect_train = {
+            blockdev?: :block_device?,
+            chardev?: :character_device?,
+          }
+          redirect_utils = {
+            chown: :chown,
+            chmod: :chmod,
+            symlink: :ln_s,
+            delete: :rm,
+          }
+          filestat = %i{gid group mode owner selinux_label size uid}
+
+          if %i{stat lstat}.include? m
+            Chef::Log.debug "File::#{m} passed to Train.file.stat"
+
+            follow_symlink = m == :stat
+            tfile = __transport_connection.file(args[0], follow_symlink).stat
+
+            require "ostruct" unless defined?(OpenStruct)
+            OpenStruct.new(tfile)
+
+          # Non-IO methods can be issued locally
+          elsif nonio.include? m
+            ::File.send(m, *args, **kwargs) # TODO: pass block
+
+          elsif passthru.include? m
+            Chef::Log.debug "File::#{m} passed to Train.file.#{m}"
+
+            file_name, other_args = args[0], args[1..]
+
+            file = __transport_connection.file(file_name)
+            file.send(m, *other_args, **kwargs) # block?
+
+          elsif m == :mtime
+            # Solve a data type disparity between Train.file and File
+            timestamp = __transport_connection.file(args[0]).mtime
+            Time.at(timestamp)
+
+          elsif filestat.include? m
+            Chef::Log.debug "File::#{m} passed to Train.file.stat.#{m}"
+
+            __transport_connection.file(args[0]).stat[m]
+
+          elsif redirect_utils.key?(m)
+            new_method = redirect_utils[m]
+            Chef::Log.debug "File::#{m} redirected to TargetIO::FileUtils.#{new_method}"
+
+            ::TargetIO::FileUtils.send(new_method, *args, **kwargs) # TODO: pass block
+
+          elsif redirect_train.key?(m)
+            new_method = redirect_train[m]
+            Chef::Log.debug "File::#{m} redirected to Train.file.#{new_method}"
+
+            file_name, other_args = args[0], args[1..]
+
+            file = __transport_connection.file(file_name)
+            file.send(redirect[m], *other_args, **kwargs) # TODO: pass block
+
+          else
+            raise "Unsupported File method #{m}"
+          end
+        end
+
+        def __transport_connection
+          Chef.run_context&.transport_connection
+        end
+      end
+    end
+  end
+end

data/lib/chef/target_io/train/fileutils.rb

@@ -0,0 +1,220 @@
+module TargetIO
+  module TrainCompat
+    class FileUtils
+      class << self
+        def chmod(mode, list, noop: nil, verbose: nil)
+          cmd = sprintf("chmod %s %s", __mode_to_s(mode), Array(list).join(" "))
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def chmod_R(mode, list, noop: nil, verbose: nil, force: nil)
+          cmd = sprintf("chmod -R%s %s %s", (force ? "f" : ""), mode_to_s(mode), Array(list).join(" "))
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def chown(user, group, list, noop: nil, verbose: nil)
+          cmd = sprintf("chown %s %s", (group ? "#{user}:#{group}" : user || ":"), Array(list).join(" "))
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def chown_R(user, group, list, noop: nil, verbose: nil, force: nil)
+          cmd = sprintf("chown -R%s %s %s", (force ? "f" : ""), (group ? "#{user}:#{group}" : user || ":"), Array(list).join(" "))
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        # cmp
+        # collect_method
+        # commands
+        # compare_file
+        # compare_stream
+
+        def cp(src, dest, preserve: nil, noop: nil, verbose: nil)
+          cmd = "cp#{preserve ? " -p" : ""} #{[src, dest].flatten.join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+        alias_method :copy, :cp
+
+        def cp_lr(src, dest, noop: nil, verbose: nil, dereference_root: true, remove_destination: false)
+          cmd = "cp -lr#{remove_destination ? " --remove-destination" : ""} #{[src, dest].flatten.join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def cp_r(src, dest, preserve: nil, noop: nil, verbose: nil, dereference_root: true, remove_destination: nil)
+          cmd = "cp -r#{preserve ? "p" : ""}#{remove_destination ? " --remove-destination" : ""} #{[src, dest].flatten.join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        # getwd (alias pwd)
+        # have_option?
+        # identical? (alias compare_file)
+
+        def install(src, dest, mode: nil, owner: nil, group: nil, preserve: nil, noop: nil, verbose: nil)
+          cmd = "install -c"
+          cmd << " -p" if preserve
+          cmd << " -m " << mode_to_s(mode) if mode
+          cmd << " -o #{owner}" if owner
+          cmd << " -g #{group}" if group
+          cmd << " " << [src, dest].flatten.join(" ")
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def ln(src, dest, force: nil, noop: nil, verbose: nil)
+          cmd = "ln#{force ? " -f" : ""} #{[src, dest].flatten.join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+        alias_method :link, :ln
+
+        def ln_s(src, dest, force: nil, noop: nil, verbose: nil)
+          cmd = "ln -s#{force ? "f" : ""} #{[src, dest].flatten.join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+        alias_method :symlink, :ln_s
+
+        def ln_sf(src, dest, noop: nil, verbose: nil)
+          ln_s(src, dest, force: true, noop: noop, verbose: verbose)
+        end
+
+        def mkdir(list, mode: nil, noop: nil, verbose: nil)
+          cmd = "mkdir #{mode ? ("-m %03o " % mode) : ""}#{Array(list).join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def mkdir_p(list, mode: nil, noop: nil, verbose: nil)
+          cmd = "mkdir -p #{mode ? ("-m %03o " % mode) : ""}#{Array(list).join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+        alias_method :makedirs, :mkdir_p
+        alias_method :mkpath, :mkdir_p
+
+        def mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil)
+          cmd = "mv#{force ? " -f" : ""} #{[src, dest].flatten.join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        # options
+        # options_of
+        # pwd
+        # remove
+        # remove_entry_secure
+        # remove_file
+
+        def rm(list, force: nil, noop: nil, verbose: nil)
+          cmd = "rm#{force ? " -f" : ""} #{Array(list).join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def rm_f(list, force: nil, noop: nil, verbose: nil, secure: nil)
+          rm(list, force: true, noop: noop, verbose: verbose)
+        end
+
+        def rm_r(list, force: nil, noop: nil, verbose: nil, secure: nil)
+          cmd = "rm -r#{force ? "f" : ""} #{Array(list).join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def rm_rf(list, noop: nil, verbose: nil, secure: nil)
+          rm_r(list, force: true, noop: noop, verbose: verbose, secure: secure)
+        end
+        alias_method :remove_entry, :rm_rf
+        alias_method :rmtree, :rm_rf
+        alias_method :safe_unlink, :rm_rf
+
+        def rmdir(list, parents: nil, noop: nil, verbose: nil)
+          cmd = "rmdir #{parents ? "-p " : ""}#{Array(list).join(" ")}"
+
+          Chef::Log.debug cmd if verbose
+          return if noop
+
+          __run_command(cmd)
+        end
+
+        def touch(list, noop: nil, verbose: nil, mtime: nil, nocreate: nil)
+          return if noop
+
+          __run_command "touch #{nocreate ? "-c " : ""}#{mtime ? mtime.strftime("-t %Y%m%d%H%M.%S ") : ""}#{Array(list).join(" ")}"
+        end
+
+        # uptodate?
+
+        def method_missing(m, *_args, **_kwargs, &_block)
+          raise "Unsupported #{self.class} method #{m}"
+        end
+
+        private
+
+        # TODO: Symbolic modes
+        def __mode_to_s(mode)
+          mode.to_s(8)
+        end
+
+        def __run_command(cmd)
+          __transport_connection.run_command(cmd)
+        end
+
+        def __transport_connection
+          Chef.run_context&.transport_connection
+        end
+      end
+    end
+  end
+end