kanrisuru 0.12.0 → 0.15.0

data/spec/support/shared_examples/integration/remote/host.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.shared_examples 'host' do |os_name, host_json, _spec_dir|
+  context "with #{os_name}" do
+    let(:host) do
+      described_class.new(
+        host: host_json['hostname'],
+        username: host_json['username'],
+        keys: [host_json['ssh_key']]
+      )
+    end
+
+    after do
+      host.disconnect
+    end
+
+    it 'can ping localhost' do
+      expect(host.ping?).to eq(true)
+    end
+
+    it 'gets hostname' do
+      expect(host.hostname).to eq(host_json['hostname'])
+    end
+
+    it 'changes directories' do
+      expect(host.pwd.path).to eq(host_json['home'])
+
+      host.cd('../')
+      expect(host.pwd.path).to eq('/home')
+
+      host.cd('../')
+      expect(host.pwd.path).to eq('/')
+
+      host.cd('~')
+
+      expect(host.pwd.path).to eq(host_json['home'])
+
+      host.su('root')
+      host.cd('/root/../etc')
+
+      result = host.ls
+      paths = result.map(&:path)
+
+      expect(paths).to include('hosts')
+      expect(paths).to include('shadow')
+      expect(paths).to include('ssh')
+
+      host.cd('default')
+      expect(host.pwd.path).to eq('/etc/default')
+
+      host.su(host_json['username'])
+
+      host.cd('.')
+      expect(host.pwd.path).to eq('/etc/default')
+
+      result = host.ls(path: '/home')
+      expect(result[0].path).to eq(host_json['username'])
+
+      host.cd('/bin')
+      expect(host.pwd.path).to eq('/bin')
+    end
+  end
+end

data/spec/support/shared_examples/integration/remote/memory.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.shared_examples 'memory' do |os_name, host_json, _spec_dir|
+  context "with #{os_name}" do
+    let(:host_json) { TestHosts.host(os_name) }
+    let(:host) do
+      Kanrisuru::Remote::Host.new(
+        host: host_json['hostname'],
+        username: host_json['username'],
+        keys: [host_json['ssh_key']]
+      )
+    end
+
+    after do
+      host.disconnect
+    end
+
+    it 'gets memory details' do
+      expect(host.memory.total(:gb)).to be >= 0.5
+      expect(host.memory.free(:mb)).to be >= 10.0
+      expect(host.memory.swap).to be_instance_of(Integer)
+      expect(host.memory.swap_free).to be_instance_of(Integer)
+    end
+  end
+end

data/spec/support/shared_examples/integration/remote/os.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.shared_examples 'os' do |os_name, host_json, _spec_dir|
+  context "with #{os_name}" do
+    let(:host) do
+      Kanrisuru::Remote::Host.new(
+        host: host_json['hostname'],
+        username: host_json['username'],
+        keys: [host_json['ssh_key']]
+      )
+    end
+
+    after do
+      host.disconnect
+    end
+
+    it 'detects os specs' do
+      expect(host.os.kernel).to eq(host_json['kernel'])
+      expect(host.os.processor).to eq('x86_64')
+
+      case os_name
+      when 'opensuse'
+        expect(host.os.release).to eq('opensuse_leap')
+      else
+        expect(host.os.release).to eq(os_name)
+      end
+
+      expect(host.os.version).to be > 0.00
+
+      case os_name
+      when 'debian'
+        expect(host.os.version).to eq(10)
+      when 'ubuntu'
+        expect(host.os.version).to eq(18.04)
+      when 'fedora'
+        expect(host.os.version).to eq(32)
+      when 'centos'
+        expect(host.os.version).to eq(7)
+      when 'opensuse'
+        expect(host.os.version).to eq(15.2)
+      when 'rhel'
+        expect(host.os.version).to eq(7.9)
+      end
+    end
+
+    it 'gets uname' do
+      expect(host.os.uname).to eq(host_json['kernel'])
+    end
+
+    it 'gets uname details' do
+      host.os.uname(
+        kernel_name: true,
+        hardware_platform: true,
+        operating_system: true
+      )
+    end
+  end
+end

data/spec/support/shared_examples/integration/remote/remote_file.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Remote
+    Class.new(File) do
+      READ_FILE_SIZE = 25_000
+    end
+  end
+end
+
+RSpec.shared_examples 'remote_file' do |os_name, host_json, spec_dir|
+  context "with #{os_name}" do
+    before(:all) do
+      host = Kanrisuru::Remote::Host.new(
+        host: host_json['hostname'],
+        username: host_json['username'],
+        keys: [host_json['ssh_key']]
+      )
+
+      host.mkdir(spec_dir, silent: true)
+      host.disconnect
+    end
+
+    let(:host) do
+      Kanrisuru::Remote::Host.new(
+        host: host_json['hostname'],
+        username: host_json['username'],
+        keys: [host_json['ssh_key']]
+      )
+    end
+
+    after do
+      host.disconnect
+    end
+
+    after(:all) do
+      host = Kanrisuru::Remote::Host.new(
+        host: host_json['hostname'],
+        username: host_json['username'],
+        keys: [host_json['ssh_key']]
+      )
+
+      host.rmdir(spec_dir)
+      host.disconnect
+    end
+
+    it 'loads a remote file to edit' do
+      file = host.file("#{spec_dir}/remote-file.txt")
+
+      expect(file).to be_instance_of(described_class)
+      expect(file.exists?).to eq(false)
+      expect(file.expand_path).to eq('')
+
+      file.touch
+
+      expect(file.exists?).to eq(true)
+      expect(file.zero?).to eq(true)
+      expect(file.user).to eq(host_json['username'])
+
+      case os_name
+      when 'opensuse', 'sles'
+        expect(file.group).to eq('users')
+      else
+        expect(file.group).to eq(host_json['username'])
+      end
+
+      expect(file.expand_path).to eq("#{spec_dir}/remote-file.txt")
+
+      file.append do |f|
+        f << 'Hello world'
+        f << 'this is a test!'
+      end
+
+      lines = file.map { |line| line }
+      expect(lines).to eq(['Hello world', 'this is a test!'])
+      expect(file.zero?).to eq(false)
+
+      file.prepend do |f|
+        f << 'Lines exist'
+        f << 'at the beginning...'
+      end
+
+      expect(file[0]).to eq('Lines exist')
+      expect(file[3]).to eq('this is a test!')
+
+      lines = file.map { |line| line }
+      expect(lines).to eq(['Lines exist', 'at the beginning...', 'Hello world', 'this is a test!'])
+
+      expect(file.delete).to eq(true)
+      expect(file.exists?).to eq(false)
+    end
+
+    it 'finds and updates file' do
+      file = host.file("#{spec_dir}/hosts.conf.test")
+
+      file.touch
+
+      file.write do |f|
+        f << '127.0.0.1 localhost'
+        f << '127.0.1.1 ubuntu'
+        f << ''
+        f << '# The following lines are desirable for IPv6 capable hosts'
+        f << '::1 ip6-localhost ip6-loopback'
+        f << 'fe00::0 ip6-localnet'
+        f << 'ff00::0 ip6-mcastprefix'
+        f << 'ff02::1 ip6-allnodes'
+        f << 'ff02::2 ip6-allrouters'
+        f << 'ff02::3 ip6-allhosts'
+      end
+
+      expect(file[2]).to eq('')
+      file.find_and_append(/^127.0.1.1 ubuntu/, '8.8.8.8 rickroll.com')
+      expect(file[2]).to eq('8.8.8.8 rickroll.com')
+
+      expect(file[1]).to eq('127.0.1.1 ubuntu')
+      file.find_and_prepend(/^127.0.1.1 ubuntu/, '1.1.1.1 nevergoingtoletyoudown.io')
+      expect(file[1]).to eq('1.1.1.1 nevergoingtoletyoudown.io')
+
+      file.prepend do |f|
+        f << '# Generated by Kanrisuru'
+      end
+
+      file.find_and_replace_line(/#/, '# Rick Astley was here')
+      expect(file[0]).to eq('# Rick Astley was here')
+      expect(file[6]).to eq('# Rick Astley was here')
+
+      file.find_and_replace_value(/\slocalhost/, ' nevergoingtogiveyouup.biz')
+      expect(file[1]).to eq('127.0.0.1 nevergoingtogiveyouup.biz')
+
+      file.find_and_remove(/^::/)
+      file.find_and_remove(/^ff/)
+      file.find_and_remove(/^fe/)
+
+      expect(file.lines).to eq(7)
+    end
+
+    it 'iterates with chunking' do
+      file = host.file("#{spec_dir}/remote-file-large.txt")
+
+      expect(file.exists?).to eq(false)
+
+      file.touch
+
+      file.write do |f|
+        (0...50_000).each do |i|
+          f << "Line: #{i}"
+        end
+      end
+
+      line = file.find do |f|
+        f == 'Line: 1111'
+      end
+
+      expect(line).to eq('Line: 1111')
+
+      expect(file[0]).to eq('Line: 0')
+      expect(file[5]).to eq('Line: 5')
+      expect(file[28_445]).to eq('Line: 28445')
+      expect(file[49_999]).to eq('Line: 49999')
+      expect { file[50_000] }.to raise_error(ArgumentError)
+
+      file.prepend do |f|
+        f << 'Hello large file'
+      end
+
+      expect(file[0]).to eq('Hello large file')
+      expect(file[1]).to eq('Line: 0')
+      expect(file[28_446]).to eq('Line: 28445')
+      expect(file[50_000]).to eq('Line: 49999')
+    end
+  end
+end

data/spec/unit/util_spec.rb

@@ -15,6 +15,22 @@ RSpec.describe Kanrisuru::Util do
     expect(described_class.present?(nil)).to eq(false)
   end
 
+  it 'joins strings into array' do
+    expect(described_class.array_join_string(%w[opt1 opt2 opt3])).to eq('opt1,opt2,opt3')
+    expect(described_class.array_join_string(%w[opt1 opt2 opt3], ' | ')).to eq('opt1 | opt2 | opt3')
+    expect(described_class.array_join_string('opt1, opt2, opt3')).to eq('opt1, opt2, opt3')
+  end
+
+  it 'still joins string with depecrated method' do
+    allow(Kanrisuru.logger).to receive(:info)
+    expect(Kanrisuru.logger).to receive(:info) do |&block|
+      expect(block.call).to eq('DEPRECATION WARNING: string_join_array will be removed in the upcoming major release. Use array_join_string instead.')
+    end
+
+    expect(described_class.string_join_array('a')).to eq('a')
+    expect(described_class.string_join_array(%w[a b c])).to eq('a,b,c')
+  end
+
   it 'camelizes strings' do
     expect(described_class.camelize('hello_world')).to eq('HelloWorld')
     expect(described_class.camelize('helloworld')).to eq('Helloworld')