kanrisuru 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bde6a8003df4dbe874a1b2471eb042b294fabc7e84d4146458fd3a1dbf4882ca
-  data.tar.gz: 4b2e3f0f35c62ee2286ad9aea4ae32cd7044418cc141c1abc176c5b017821c8d
+  metadata.gz: 80ead7b757f8228b63f2908df9163f726e99ec27dcd2b88f7a5ff197e98f8008
+  data.tar.gz: 8393af4b3e03f583981b06eaa384b47527882870289df125d4887f98abb293b2
 SHA512:
-  metadata.gz: b32475bde12456c03a3028f8ebbc6f792d59ad69b8014737d266d65ea4d4ba3208f864aa1eb8de58929abc8460e41971371fc6d4c3bc6c2d6e28db54c73fc9b5
-  data.tar.gz: a22f5af50adce7dc76504ba78fdddd000d08766e2115e4d092b12e8d44b5b76aa3e0f68cf6286c3344cde9d82520238ecd96b2e6b0b11384cc4ec859bbcebd2a
+  metadata.gz: 2268c08d84aa9cf09232900c7d2ccd489cb9de12aa77c3fdc9666eb8859d41b072a932d0afb0d6ed2818978e641dee1569ddeda30f417466f7bd1a8150206cb9
+  data.tar.gz: e4ef880302b200deafb4c69e703cfb79fc4162d20d6b6269a635e0277f790c4c872299513cab53edeb395f20e15660fda09ba7d0c135b8ebf97d67b7464e1859

data/CHANGELOG.md

@@ -1,8 +1,11 @@
+## 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.
+*  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/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

@@ -14,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

@@ -8,5 +8,6 @@ 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/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/version.rb

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

data/spec/functional/core/system_spec.rb

@@ -93,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

@@ -100,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

@@ -33,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.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-23 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel_tests
@@ -319,6 +319,7 @@ 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
@@ -330,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