kanrisuru 0.13.0 → 0.14.0

data/lib/kanrisuru/core/stream/commands/read_file_chunk.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Stream
+      def read_file_chunk(path, start_line, end_line)
+        if !start_line.instance_of?(Integer) || !end_line.instance_of?(Integer) ||
+           start_line > end_line || start_line.negative? || end_line.negative?
+          raise ArgumentError, 'Invalid start or end'
+        end
+
+        end_line = end_line - start_line + 1
+        command = Kanrisuru::Command.new("tail -n +#{start_line} #{path} | head -n #{end_line}")
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command, &:to_a)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/stream/commands/sed.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Stream
+      def sed(path, expression, replacement, opts = {})
+        command = Kanrisuru::Command.new('sed')
+        command.append_flag('-i', opts[:in_place])
+        command.append_flag('-r', opts[:regexp_extended])
+
+        command << "'s/#{expression}/#{replacement}/g'"
+        command << "'#{path}'"
+
+        append_file(command, opts)
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Sed.parse(cmd, opts)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/stream/commands/tail.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Stream
+      def tail(path, opts = {})
+        command = Kanrisuru::Command.new('tail')
+        command.append_arg('-c', opts[:bytes])
+        command.append_arg('-n', opts[:lines])
+        command << path
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command, &:to_a)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/stream/commands.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'commands/cat'
+require_relative 'commands/echo'
+require_relative 'commands/head'
+require_relative 'commands/read_file_chunk'
+require_relative 'commands/sed'
+require_relative 'commands/tail'
+
+module Kanrisuru
+  module Core
+    module Stream
+      private
+
+      def append_file(command, opts)
+        return unless Kanrisuru::Util.present?(opts[:new_file])
+
+        case opts[:mode]
+        when 'append'
+          command << ">> #{opts[:new_file]}"
+        when 'write'
+          command << "> #{opts[:new_file]}"
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/stream/parser.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'parsers/echo'
+require_relative 'parsers/sed'

data/lib/kanrisuru/core/stream/parsers/echo.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Stream
+      module Parser
+        class Echo
+          def self.parse(command, opts)
+            return if Kanrisuru::Util.present?(opts[:new_file])
+
+            command.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/stream/parsers/sed.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Stream
+      module Parser
+        class Sed
+          def self.parse(command, opts)
+            return if Kanrisuru::Util.present?(opts[:new_file])
+
+            command.to_a.join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/stream.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative 'stream/parser'
+require_relative 'stream/commands'
+
 module Kanrisuru
   module Core
     module Stream
@@ -11,110 +14,6 @@ module Kanrisuru
       os_define :linux, :sed
       os_define :linux, :echo
       os_define :linux, :cat
-
-      def head(path, opts = {})
-        command = Kanrisuru::Command.new('head')
-        command.append_arg('-c', opts[:bytes])
-        command.append_arg('-n', opts[:lines])
-        command << path
-
-        execute_shell(command)
-
-        Kanrisuru::Result.new(command, &:to_a)
-      end
-
-      def tail(path, opts = {})
-        command = Kanrisuru::Command.new('tail')
-        command.append_arg('-c', opts[:bytes])
-        command.append_arg('-n', opts[:lines])
-        command << path
-
-        execute_shell(command)
-
-        Kanrisuru::Result.new(command, &:to_a)
-      end
-
-      def read_file_chunk(path, start_line, end_line)
-        if !start_line.instance_of?(Integer) || !end_line.instance_of?(Integer) ||
-           start_line > end_line || start_line.negative? || end_line.negative?
-          raise ArgumentError, 'Invalid start or end'
-        end
-
-        end_line = end_line - start_line + 1
-        command = Kanrisuru::Command.new("tail -n +#{start_line} #{path} | head -n #{end_line}")
-
-        execute_shell(command)
-
-        Kanrisuru::Result.new(command, &:to_a)
-      end
-
-      def sed(path, expression, replacement, opts = {})
-        command = Kanrisuru::Command.new('sed')
-        command.append_flag('-i', opts[:in_place])
-        command.append_flag('-r', opts[:regexp_extended])
-
-        command << "'s/#{expression}/#{replacement}/g'"
-        command << "'#{path}'"
-
-        append_file(command, opts)
-        execute_shell(command)
-
-        Kanrisuru::Result.new(command) do |cmd|
-          if Kanrisuru::Util.present?(opts[:new_file])
-            nil
-          else
-            cmd.to_a.join("\n")
-          end
-        end
-      end
-
-      def echo(text, opts = {})
-        command = Kanrisuru::Command.new('echo')
-        command.append_flag('-e', opts[:backslash])
-        command << "'#{text}'"
-
-        append_file(command, opts)
-        execute_shell(command)
-
-        Kanrisuru::Result.new(command) do |cmd|
-          if Kanrisuru::Util.present?(opts[:new_file])
-            nil
-          else
-            cmd.to_s
-          end
-        end
-      end
-
-      def cat(files, opts = {})
-        command = Kanrisuru::Command.new('cat')
-        command.append_flag('-T', opts[:show_tabs])
-        command.append_flag('-n', opts[:number])
-        command.append_flag('-s', opts[:squeeze_blank])
-        command.append_flag('-v', opts[:show_nonprinting])
-        command.append_flag('-E', opts[:show_ends])
-        command.append_flag('-b', opts[:number_nonblank])
-        command.append_flag('-A', opts[:show_all])
-
-        command.append_array(files)
-
-        append_file(command, opts)
-        execute_shell(command)
-
-        Kanrisuru::Result.new(command, &:to_a)
-      end
-
-      private
-
-      def append_file(command, opts)
-        return unless Kanrisuru::Util.present?(opts[:new_file])
-
-        case opts[:mode]
-        when 'append'
-          command << ">> #{opts[:new_file]}"
-        when 'write'
-          command << "> #{opts[:new_file]}"
-        end
-      end
     end
   end
 end

data/lib/kanrisuru/core/system/commands/cpu_info.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def cpu_info(spec)
+        Kanrisuru.logger.info do
+          'DEPRECATION WARNING: cpu_info will be removed in the upcoming major release. Use lscpu instead.'
+        end
+
+        name =
+          case spec
+          when 'sockets'
+            '^Socket'
+          when 'cores_per_socket'
+            '^Core'
+          when 'threads'
+            '^Thread'
+          when 'cores'
+            '^CPU('
+          else
+            return
+          end
+
+        command = Kanrisuru::Command.new("lscpu | grep -i '#{name}' | awk '{print $NF}'")
+        execute(command)
+
+        Kanrisuru::Result.new(command, &:to_i)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/free.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def free(type)
+        conversions = {
+          total: 'MemTotal',
+          free: 'MemFree',
+          swap: 'SwapTotal',
+          swap_free: 'SwapFree'
+        }
+
+        option = conversions[type.to_sym]
+        raise ArgumentError, 'Invalid mem type' unless option
+
+        command = Kanrisuru::Command.new("cat /proc/meminfo | grep -i '^#{option}' | awk '{print $2}'")
+        execute(command)
+
+        ## In kB
+        Kanrisuru::Result.new(command, &:to_i)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/kernel_statistics.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def kstat
+        kernel_statistics
+      end
+
+      def kernel_statistics
+        command = Kanrisuru::Command.new('cat /proc/stat')
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::KernelStatistics.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/kill.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def kill(signal, pids)
+        raise ArgumentError, 'Invalid signal' unless Kanrisuru::Util::Signal.valid?(signal)
+
+        ## Use named signals for readabilitiy
+        signal = Kanrisuru::Util::Signal[signal] if signal.instance_of?(Integer)
+
+        command = Kanrisuru::Command.new('kill')
+        command << "-#{signal}"
+        command << (pids.instance_of?(Array) ? pids.join(' ') : pids)
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command)
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/last.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def last(opts = {})
+        command =
+          if opts[:failed_attempts]
+            Kanrisuru::Command.new('lastb')
+          else
+            Kanrisuru::Command.new('last')
+          end
+
+        command.append_flag('-i')
+        command.append_flag('-F')
+        command.append_arg('-f', opts[:file])
+
+        ## Some systems only use 1 space between user and TTY field
+        ## Add an additional space in output formatting for simple parsing
+        ## logic.
+        command | "sed 's/ /  /'"
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Last.parse(cmd, opts)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/load_average.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def load_average
+        command = Kanrisuru::Command.new("cat /proc/loadavg | awk '{print $1,$2,$3}'")
+        execute(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::LoadAverage.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/load_env.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def load_env
+        command = Kanrisuru::Command.new('env')
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::LoadEnv.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/lscpu.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def lscpu
+        command = Kanrisuru::Command.new('lscpu')
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Lscpu.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/lsof.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def lsof(_opts = {})
+        command = Kanrisuru::Command.new('lsof -F pcuftDsin')
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Lsof.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/poweroff.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def poweroff(opts = {})
+        time = opts[:time]
+        cancel = opts[:cancel]
+        message = opts[:message]
+        no_wall = opts[:no_wall]
+
+        command = Kanrisuru::Command.new('shutdown')
+
+        if Kanrisuru::Util.present?(cancel)
+          command.append_flag('-c')
+          command << message if message
+        else
+          time = format_shutdown_time(time) if Kanrisuru::Util.present?(time)
+
+          if Kanrisuru::Util.present?(no_wall)
+            command.append_flag('--no-wall')
+          else
+            command << time if time
+            command << message if message
+          end
+        end
+
+        begin
+          execute_shell(command)
+
+          Kanrisuru::Result.new(command)
+        rescue IOError
+          ## When powering off 'now', ssh io stream closes
+          ## Set exit status to 0
+          command.handle_status(0)
+
+          Kanrisuru::Result.new(command)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/ps.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def ps(opts = {})
+        group = opts[:group]
+        user  = opts[:user]
+        pid   = opts[:pid]
+        ppid  = opts[:ppid]
+        # tree  = opts[:tree]
+
+        command = Kanrisuru::Command.new('ps ww')
+
+        if !user.nil? || !group.nil? || !pid.nil? || !ppid.nil?
+          command.append_arg('--user', user.instance_of?(Array) ? user.join(',') : user)
+          command.append_arg('--group', group.instance_of?(Array) ? group.join(',') : group)
+          command.append_arg('--pid', pid.instance_of?(Array) ? pid.join(',') : pid)
+          command.append_arg('--ppid', ppid.instance_of?(Array) ? ppid.join(',') : ppid)
+        else
+          command.append_flag('ax')
+        end
+
+        command.append_arg('-o', 'uid,user,gid,group,ppid,pid,pcpu,pmem,stat,pri,flags,policy,time,cmd')
+        command.append_flag('--no-headers')
+
+        execute(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Ps.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/reboot.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def reboot(opts = {})
+        time = opts[:time]
+        cancel = opts[:cancel]
+        message = opts[:message]
+        no_wall = opts[:no_wall]
+
+        command = Kanrisuru::Command.new('shutdown')
+
+        if Kanrisuru::Util.present?(cancel)
+          command.append_flag('-c')
+          command << message if message
+        else
+          command.append_flag('-r')
+
+          time = format_shutdown_time(time) if Kanrisuru::Util.present?(time)
+
+          if Kanrisuru::Util.present?(no_wall)
+            command.append_flag('--no-wall')
+          else
+            command << time if time
+            command << message if message
+          end
+        end
+
+        begin
+          execute_shell(command)
+          Kanrisuru::Result.new(command)
+        rescue IOError
+          ## When rebooting 'now', ssh io stream closes
+          ## Set exit status to 0
+          command.handle_status(0)
+          Kanrisuru::Result.new(command)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/uptime.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def uptime
+        ## Ported from https://github.com/djberg96/sys-uptime
+        command = Kanrisuru::Command.new('cat /proc/uptime')
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Uptime.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands/w.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def who(opts = {})
+        w(opts)
+      end
+
+      def w(opts = {})
+        users = opts[:users]
+        command = Kanrisuru::Command.new('w -hi')
+
+        command << users if Kanrisuru::Util.present?(users)
+
+        execute(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::W.parse(cmd)
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/commands.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'commands/cpu_info'
+require_relative 'commands/free'
+require_relative 'commands/kernel_statistics'
+require_relative 'commands/kill'
+require_relative 'commands/last'
+require_relative 'commands/load_average'
+require_relative 'commands/load_env'
+require_relative 'commands/lscpu'
+require_relative 'commands/lsof'
+require_relative 'commands/poweroff'
+require_relative 'commands/ps'
+require_relative 'commands/reboot'
+require_relative 'commands/uptime'
+require_relative 'commands/w'
+
+module Kanrisuru
+  module Core
+    module System
+      private
+
+      def format_shutdown_time(time)
+        if time.instance_of?(Integer) || !/^[0-9]+$/.match(time).nil?
+          "+#{time}"
+        elsif !/^[0-9]{0,2}:[0-9]{0,2}$/.match(time).nil? || time == 'now'
+          time
+        else
+          raise ArgumentError, 'Invalid time format'
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/core/system/parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'parsers/kernel_statistics'
+require_relative 'parsers/last'
+require_relative 'parsers/load_average'
+require_relative 'parsers/load_env'
+require_relative 'parsers/lscpu'
+require_relative 'parsers/lsof'
+require_relative 'parsers/ps'
+require_relative 'parsers/uptime'
+require_relative 'parsers/w'