kanrisuru 0.17.0 → 0.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3f695ef2a1f50c24f7e2c8a06a107202c72e36a19b4952a4af9fbe3bdda93d3
-  data.tar.gz: e4ec5a94e1b24ff564fc46d909ddfd93bcb0d3e2baa916137c07740a896d8a6e
+  metadata.gz: 750858fb5bf17a34ad853a052cf6f0c13f3226acb7d92a0c26537740b6cf44e2
+  data.tar.gz: f15b5d63e3687b3d605ccc24c3b929d3e16cdaa0ed5e871964716e6f6529b1d1
 SHA512:
-  metadata.gz: a02f65e7d962e2e02594bee48b8a8662bf29a936a02e9e938332340d695618bd92a2a3b6fc26c7324ecb0af236d6d6dc11475fd8205ee6cc77d97ff57f39cbdf
-  data.tar.gz: 047b7235f156d77085a413d2af37ce09367d1eb68b33ae0b96b1e2a0ed8f79ba9b8111f3933e02dd37245393fd4c6333455407187fb62ba6ad524dfc42ec1f54
+  metadata.gz: f8cf821cfe1260da1f87e7001093cbbca2571087076b8bdb478f58b128399dddd05448648a9c4b15c07346c010cc01bf58a63b94d030179a141d6afbe97f8598
+  data.tar.gz: da6b7c1337dc893dd131329670594277f3e4da5fbb5b4502a9a7b5c7434cf8e32666397fadbfb3fb570b6196e10d6775d12c9cd3e8cedab9c8e58020f50f11bc

data/CHANGELOG.md

@@ -1,5 +1,17 @@
+## Kanrisuru 0.19.2 (February 02, 2022) ##
+*  Add `to_h` to result class.
+
+## Kanrisuru 0.19.1 (February 02, 2022) ##
+*  Fix `load_env` command with parsing output, use `to_a` for cleaner newline parsing.
+
+## Kanrisuru 0.19.0 (January 25, 2022) ##
+*  Add readonly version of `sysctl` command with test cases.
+
+## Kanrisuru 0.18.0 (January 23, 2022) ##
+*  Add `history` command with test cases.
+
 ## Kanrisuru 0.17.0 (January 20, 2022) ##
-* Add `nproc` command with test cases.
+*  Add `nproc` command with test cases.
 
 ## Kanrisuru 0.16.17 (January 10, 2022) ##
 *  Add additional options to `wget` command.

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def history(opts = {})
+        histfile = opts[:histfile] || '~/.bash_history'
+
+        command = Kanrisuru::Command.new("HISTFILE=#{histfile}; history -r; history")
+
+        if Kanrisuru::Util.present?(opts[:delete])
+          command.append_arg('-d', Kanrisuru::Util.array_join_string(opts[:delete], ' '))
+        elsif Kanrisuru::Util.present?(opts[:clear])
+          command.append_flag('-c')
+        elsif Kanrisuru::Util.present?(opts[:n])
+          command << opts[:n]
+        end
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          return if Kanrisuru::Util.present?(opts[:delete]) || Kanrisuru::Util.present?(opts[:clear])
+
+          Parser::History.parse(cmd)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      def sysctl(variable = nil)
+        command = Kanrisuru::Command.new('sysctl')
+
+        ## Some older versions have a bug with 255 exit code being returned
+        command.append_valid_exit_code(255)
+
+        if Kanrisuru::Util.present?(variable)
+          command << variable
+        else
+          command.append_flag('--all')
+        end
+        
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          Parser::Sysctl.parse(cmd)
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@
 
 require_relative 'commands/cpu_info'
 require_relative 'commands/free'
+require_relative 'commands/history'
 require_relative 'commands/kernel_statistics'
 require_relative 'commands/kill'
 require_relative 'commands/last'
@@ -13,6 +14,7 @@ require_relative 'commands/nproc'
 require_relative 'commands/poweroff'
 require_relative 'commands/ps'
 require_relative 'commands/reboot'
+require_relative 'commands/sysctl'
 require_relative 'commands/uptime'
 require_relative 'commands/w'
 

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

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'parsers/kernel_statistics'
+require_relative 'parsers/history'
 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/sysctl'
 require_relative 'parsers/uptime'
 require_relative 'parsers/w'

data/lib/kanrisuru/core/system/parsers/history.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module System
+      module Parser
+        class History
+          def self.parse(command)
+            lines = command.to_a
+            lines.map do |line|
+              line.split(/^\d+\s+/)[1]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,12 +6,11 @@ module Kanrisuru
       module Parser
         class LoadEnv
           def self.parse(command)
-            string = command.to_s
+            rows = command.to_a
             hash = {}
 
-            rows = string.split("\n")
             rows.each do |row|
-              key, value = row.split('=', 2)
+              key, value = row.split('=')
               hash[key] = value
             end
 

data/lib/kanrisuru/core/system/parsers/sysctl.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'ostruct'
+
+module Kanrisuru
+  module Core
+    module System
+      module Parser
+        class Sysctl 
+          class << self
+            def parse(command)
+              result = {}
+
+              lines = command.to_a
+              lines.each do |line|
+                next if line.include?("permission denied on key")
+
+                keys, value = parse_line(line)
+                next if Kanrisuru::Util.blank?(value)
+
+                hash = build_nested_hash(keys, value)
+                result = merge_recursively(result, hash)
+              end
+
+              build_struct(result)
+            end
+
+            def build_struct(hash)
+              struct = Struct.new(*hash.keys).new
+
+              hash.keys.each do |key|
+                struct[key] = hash[key].is_a?(Hash) ? build_struct(hash[key]) : hash[key]
+              end
+
+              struct
+            end
+
+            def merge_recursively(h1, h2)
+              h1.merge(h2) do |k, v1, v2|
+                if v1.is_a?(Hash) && v2.is_a?(Hash)
+                  merge_recursively(v1, v2)
+                else
+                  [v1, v2].flatten
+                end
+              end
+            end
+
+            def build_nested_hash(array, value)
+              array.reverse.inject(value) { |assigned_value, key| { key => assigned_value } }
+            end
+
+            def parse_line(line)
+              string, value = line.split(' =')
+              return if Kanrisuru::Util.blank?(value)
+
+              string = string.strip
+              value = value.strip
+
+              if Kanrisuru::Util.numeric?(value)
+                value = value.to_i
+              elsif /\t+/.match(value)
+                ## Split tab delimited strings
+                value = value.split(/\t/)
+              end
+
+              [string.split('.').map(&:to_sym), value]
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanrisuru/result.rb

@@ -35,6 +35,10 @@ module Kanrisuru
       @data.to_s
     end
 
+    def to_h
+      @data.to_h
+    end
+
     def to_a
       @data.instance_of?(Array) ? @data : [@data]
     end

data/lib/kanrisuru/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kanrisuru
-  VERSION = '0.17.0'
+  VERSION = '0.19.2'
 end

data/spec/functional/core/system_spec.rb

@@ -43,6 +43,20 @@ RSpec.describe Kanrisuru::Core::System do
     end.to raise_error(ArgumentError)
   end
 
+  it 'prepares history command' do
+    expect_command(host.history, 'HISTFILE=~/.bash_history; history -r; history')
+    expect_command(host.history(histfile: '~/.history', n: 100),
+                   'HISTFILE=~/.history; history -r; history 100')
+    expect_command(host.history(clear: true),
+                   'HISTFILE=~/.bash_history; history -r; history -c')
+    expect_command(host.history(delete: 5),
+                   'HISTFILE=~/.bash_history; history -r; history -d 5')
+    expect_command(host.history(delete: [23, 30]),
+                   'HISTFILE=~/.bash_history; history -r; history -d 23 30')
+    expect_command(host.history(delete: '-7'),
+                   'HISTFILE=~/.bash_history; history -r; history -d -7')
+  end
+
   it 'prepares kernel_statistics command' do
     expect_command(host.kernel_statistics, 'cat /proc/stat')
   end
@@ -79,6 +93,11 @@ RSpec.describe Kanrisuru::Core::System do
     expect_command(host.lsof, 'lsof -F pcuftDsin')
   end
 
+  it 'prepares sysctl command' do
+    expect_command(host.sysctl, 'sysctl --all')
+    expect_command(host.sysctl('net.ipv4.conf.all'), 'sysctl net.ipv4.conf.all')
+  end
+
   it 'prepares poweroff command' do
     expect_command(host.poweroff, 'shutdown')
     expect_command(host.poweroff(cancel: true), 'shutdown -c')

data/spec/support/shared_examples/integration/core/system.rb

@@ -50,6 +50,12 @@ RSpec.shared_examples 'system' do |os_name, host_json, _spec_dir|
       expect(result.days).to be >= 0
     end
 
+    it 'gets history' do
+      result = host.history
+      expect(result).to be_success
+      expect(result.data).to be_instance_of(Array)
+    end
+
     it 'kills pids' do
       command = 'sleep 100000 > /dev/null 2>&1 &'
 
@@ -94,6 +100,20 @@ RSpec.shared_examples 'system' do |os_name, host_json, _spec_dir|
       expect(result.cpus.length).to eq(host.cpu.cores)
     end
 
+    it 'gets kernel sysctl info' do
+      result = host.sysctl
+      expect(result).to be_success
+      expect(result).to respond_to :net 
+      expect(result).to respond_to :kernel
+      expect(result).to respond_to :dev
+
+      result = host.sysctl('net.ipv4.conf')
+      expect(result).to be_success
+      expect(result).to respond_to :net
+      expect(result.net).to respond_to :ipv4
+      expect(result.net.ipv4).to respond_to :conf
+    end
+
     it 'gets login details' do
       host.su('root')
 

data/spec/unit/core/system_spec.rb

@@ -25,6 +25,7 @@ RSpec.describe Kanrisuru::Core::System do
     expect(host).to respond_to(:lscpu)
     expect(host).to respond_to(:load_average)
     expect(host).to respond_to(:free)
+    expect(host).to respond_to(:history)
     expect(host).to respond_to(:ps)
     expect(host).to respond_to(:kill)
     expect(host).to respond_to(:kernel_statistics)
@@ -32,6 +33,7 @@ RSpec.describe Kanrisuru::Core::System do
     expect(host).to respond_to(:lsof)
     expect(host).to respond_to(:nproc)
     expect(host).to respond_to(:last)
+    expect(host).to respond_to(:sysctl)
     expect(host).to respond_to(:uptime)
     expect(host).to respond_to(:w)
     expect(host).to respond_to(:who)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.2
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel_tests
@@ -307,6 +307,7 @@ files:
 - lib/kanrisuru/core/system/commands.rb
 - lib/kanrisuru/core/system/commands/cpu_info.rb
 - lib/kanrisuru/core/system/commands/free.rb
+- lib/kanrisuru/core/system/commands/history.rb
 - lib/kanrisuru/core/system/commands/kernel_statistics.rb
 - lib/kanrisuru/core/system/commands/kill.rb
 - lib/kanrisuru/core/system/commands/last.rb
@@ -318,9 +319,11 @@ files:
 - lib/kanrisuru/core/system/commands/poweroff.rb
 - lib/kanrisuru/core/system/commands/ps.rb
 - lib/kanrisuru/core/system/commands/reboot.rb
+- lib/kanrisuru/core/system/commands/sysctl.rb
 - lib/kanrisuru/core/system/commands/uptime.rb
 - lib/kanrisuru/core/system/commands/w.rb
 - lib/kanrisuru/core/system/parser.rb
+- lib/kanrisuru/core/system/parsers/history.rb
 - lib/kanrisuru/core/system/parsers/kernel_statistics.rb
 - lib/kanrisuru/core/system/parsers/last.rb
 - lib/kanrisuru/core/system/parsers/load_average.rb
@@ -328,6 +331,7 @@ files:
 - lib/kanrisuru/core/system/parsers/lscpu.rb
 - lib/kanrisuru/core/system/parsers/lsof.rb
 - lib/kanrisuru/core/system/parsers/ps.rb
+- lib/kanrisuru/core/system/parsers/sysctl.rb
 - lib/kanrisuru/core/system/parsers/uptime.rb
 - lib/kanrisuru/core/system/parsers/w.rb
 - lib/kanrisuru/core/system/types.rb