kanrisuru 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc638e7e85cf76460cffecc7bcd885a7cc3f30c098c1d2fa0250daeb455e87a2
-  data.tar.gz: 78d733e6299f3a49ce40a0be6bb73b50a8c6b9f184ceacf920bc55661653c393
+  metadata.gz: 8366ff4859b2cf024741e8be0ca834863fabc641c3089a9e73e070b49715209b
+  data.tar.gz: d74ba72f68efee3d6228fc23aa01b762aba3ab5a3bc36c40721705027a1d8157
 SHA512:
-  metadata.gz: 2706ac5496f456560795adedbe445ecfa1509e7d3d60dde5b5d4e85a59687b1477fdf035aeba0b31a5ade24cc25c962a8cbb559a75ba5899eaf90e4f02ada212
-  data.tar.gz: 606de07f8ddd04465df2bc0f4bd3ffbfb1e362986613a31f2184076337ba9542ea05ac1874d36c24442d1609f176dfa1bd2cf8104835fa1233d9e4c68cd7f7a4
+  metadata.gz: 48617976b38c0b0f230b08220fac0fa79eccc6e5a2b1669f51fcf8709a7f18fec3b6d137dc6add1c26b31979d419f5741d76252ad14a91b0a094e11f70053c00
+  data.tar.gz: ca0a3df92bb1dbee0b9c3d46c74ea9287adfded79a548afe41212c936e339135be96ff91cf801e958b29e576405e9ba7c02fa561f3abb7c3aa88602e1e0dbbd2

data/kanrisuru.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.author      = 'Ryan Mammina'
   gem.email       = 'ryan@avamia.com'
   gem.license     = 'MIT'
-  gem.summary     = 'Manage remote servers with ruby.'
+  gem.summary     = 'Manage remote servers over ssh with ruby.'
   gem.homepage    = 'https://github.com/avamia/kanrisuru'
 
   gem.required_ruby_version     = '>= 2.5.0'

data/lib/kanrisuru/core.rb

@@ -14,6 +14,7 @@ require_relative 'core/stream'
 require_relative 'core/transfer'
 require_relative 'core/ip'
 require_relative 'core/socket'
+require_relative 'core/apt'
 
 module Kanrisuru
   module Remote
@@ -32,6 +33,7 @@ module Kanrisuru
       os_include Kanrisuru::Core::Transfer
       os_include Kanrisuru::Core::IP
       os_include Kanrisuru::Core::Socket
+      os_include Kanrisuru::Core::Apt
     end
 
     class Cluster
@@ -48,6 +50,7 @@ module Kanrisuru
       os_collection Kanrisuru::Core::Transfer
       os_collection Kanrisuru::Core::IP
       os_collection Kanrisuru::Core::Socket
+      os_collection Kanrisuru::Core::Apt
     end
   end
 end

data/lib/kanrisuru/core/apt.rb

@@ -0,0 +1,337 @@
+# frozen_string_literal: true
+
+module Kanrisuru
+  module Core
+    module Apt
+      extend OsPackage::Define
+
+      os_define :debian, :apt
+
+      AptSource = Struct.new(:url, :dist, :architecture)
+      AptPackageOverview = Struct.new(:package, :version, :suites, :architecture, :installed, :upgradeable, :automatic)
+      AptPackageDetail = Struct.new(
+        :package,
+        :version,
+        :priority,
+        :section,
+        :origin,
+        :maintainer,
+        :original_maintainer,
+        :bugs,
+        :install_size,
+        :dependencies,
+        :recommends,
+        :provides,
+        :suggests,
+        :breaks,
+        :conflicts,
+        :replaces,
+        :homepage,
+        :task,
+        :supported,
+        :download_size,
+        :apt_manual_installed,
+        :apt_sources,
+        :description,
+        :summary
+      )
+
+      def apt(action, opts = {})
+        case action
+        when 'list'
+          apt_list(opts)
+        when 'update'
+          apt_update(opts)
+        when 'upgrade'
+          apt_upgrade(opts)
+        when 'full-upgrade', 'full_upgrade'
+          apt_full_upgrade(opts)
+        when 'install'
+          apt_install(opts)
+        when 'remove'
+          apt_remove(opts)
+        when 'purge'
+          apt_purge(opts)
+        when 'autoremove'
+          apt_autoremove(opts)
+        when 'search'
+          apt_search(opts)
+        when 'show'
+          apt_show(opts)
+        when 'clean'
+          apt_clean(opts)
+        when 'autoclean'
+          apt_autoclean(opts)
+        end
+      end
+
+      private
+
+      def apt_autoclean(_opts)
+        command = Kanrisuru::Command.new('apt-get autoclean')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_clean(_opts)
+        command = Kanrisuru::Command.new('apt-get clean')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_search(opts)
+        command = Kanrisuru::Command.new('apt search')
+        command << opts[:query]
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          lines = cmd.to_a
+          lines.shift
+          lines.shift
+
+          result = []
+
+          lines.each do |line|
+            next unless line.include?('/')
+
+            item = parse_apt_line(line)
+            next unless item
+
+            result << item
+          end
+
+          result
+        end
+      end
+
+      def apt_list(opts)
+        command = Kanrisuru::Command.new('apt list')
+        command.append_flag('--installed', opts[:installed])
+        command.append_flag('--upgradeable', opts[:upgradeable])
+        command.append_flag('--all-versions', opts[:all_versions])
+        command.append_arg('-a', opts[:package_name])
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          lines = cmd.to_a
+          lines.shift
+
+          result = []
+          lines.each.with_index do |line, _index|
+            item = parse_apt_line(line)
+            next unless item
+
+            result << item
+          end
+
+          result
+        end
+      end
+
+      def apt_autoremove(_opts)
+        command = Kanrisuru::Command.new('apt-get autoremove')
+        command.append_flag('-y')
+
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_purge(opts)
+        command = Kanrisuru::Command.new('apt-get purge')
+        command.append_flag('-y')
+
+        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        command << packages
+
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_remove(opts)
+        command = Kanrisuru::Command.new('apt-get remove')
+        command.append_flag('-y')
+
+        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        command << packages
+
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_install(opts)
+        command = Kanrisuru::Command.new('apt-get install')
+        command.append_flag('-y')
+
+        command.append_flag('--no-upgrade', opts[:no_upgrade])
+        command.append_flag('--only-upgrade', opts[:only_upgrade])
+        command.append_flag('--reinstall', opts[:reinstall])
+
+        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        command << packages
+
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_full_upgrade(_opts)
+        command = Kanrisuru::Command.new('apt full-upgrade')
+        command.append_flag('-y')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_upgrade(_opts)
+        command = Kanrisuru::Command.new('apt-get upgrade')
+        command.append_flag('-y')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_update(_opts)
+        command = Kanrisuru::Command.new('apt-get update')
+        command.append_flag('-y')
+        execute_shell(command)
+        Kanrisuru::Result.new(command)
+      end
+
+      def apt_show(opts)
+        command = Kanrisuru::Command.new('apt show')
+        command.append_flag('-a')
+
+        packages = Kanrisuru::Util.string_join_array(opts[:packages], ' ')
+        command << packages
+
+        execute_shell(command)
+
+        Kanrisuru::Result.new(command) do |cmd|
+          lines = cmd.to_a
+          rows = []
+
+          current_row = nil
+          summary = ''
+
+          lines.each do |line|
+            next if line == 'WARNING: apt does not have a stable CLI interface. Use with caution in scripts.'
+            next if [] ['', nil, '.'].include?(line)
+
+            case line
+            when /^Package:/
+              unless current_row.nil?
+                current_row.summary = summary.strip
+                summary = ''
+                rows << current_row
+              end
+
+              current_row = AptPackageDetail.new
+              current_row.package = extract_single_line(line)
+            when /^Version:/
+              current_row.version = extract_single_line(line)
+            when /^Priority:/
+              current_row.priority = extract_single_line(line)
+            when /^Section:/
+              current_row.section = extract_single_line(line)
+            when /^Origin:/
+              current_row.origin = extract_single_line(line)
+            when /^Maintainer:/
+              current_row.maintainer = extract_single_line(line)
+            when /^Original-Maintainer:/
+              current_row.original_maintainer = extract_single_line(line)
+            when /^Bugs:/
+              current_row.bugs = extract_single_line(line)
+            when /^Installed-Size:/
+              current_row.install_size = normalize_size(extract_single_line(line))
+            when /^Download-Size:/
+              current_row.download_size = normalize_size(extract_single_line(line))
+            when /^Depends:/
+              current_row.dependencies = parse_comma_values(extract_single_line(line))
+            when /^Provides:/
+              current_row.provides = parse_comma_values(extract_single_line(line))
+            when /^Recommends:/
+              current_row.recommends = parse_comma_values(extract_single_line(line))
+            when /^Suggests:/
+              current_row.suggests = parse_comma_values(extract_single_line(line))
+            when /^Breaks:/
+              current_row.breaks = parse_comma_values(extract_single_line(line))
+            when /^Conflicts:/
+              current_row.conflicts = parse_comma_values(extract_single_line(line))
+            when /^Replaces:/
+              current_row.replaces = parse_comma_values(extract_single_line(line))
+            when /^Homepage:/
+              current_row.homepage = extract_single_line(line)
+            when /^Task:/
+              current_row.task = parse_comma_values(extract_single_line(line))
+            when /^Supported:/
+              current_row.supported = extract_single_line(line)
+            when /^APT-Sources:/
+              current_row.apt_sources = parse_apt_sources(extract_single_line(line))
+            when /^APT-Manual-Installed:/
+              current_row.apt_manual_installed = extract_single_line(line) == 'yes'
+            when /^Description:/
+              current_row.description = extract_single_line(line)
+            else
+              summary += " #{line.strip}"
+            end
+          end
+
+          current_row.summary = summary.strip
+          rows << current_row
+          rows
+        end
+      end
+
+      def extract_single_line(line)
+        line.split(': ')[1]
+      end
+
+      def parse_comma_values(string)
+        string.split(', ')
+      end
+
+      def parse_apt_sources(string)
+        url, dist, architecture, = string.split
+        AptSource.new(url, dist, architecture)
+      end
+
+      def normalize_size(string)
+        size, unit = string.split
+        size = size.to_i
+        case unit.downcase
+        when 'b'
+          Kanrisuru::Util::Bits.convert_bytes(size, :byte, :kilobyte)
+        when 'kb'
+          size
+        when 'mb'
+          Kanrisuru::Util::Bits.convert_from_mb(size, :kilobyte).to_i
+        when 'gb'
+          Kanrisuru::Util::Bits.convert_from_gb(size, :kilobyte).to_i
+        end
+      end
+
+      def parse_apt_line(line)
+        values = line.split('/')
+        return if values.length < 2
+
+        package = values[0]
+
+        values = values[1].split
+        suites = values[0].split(',')
+        version = values[1]
+        architecture = values[2]
+
+        installed = false
+        upgradeable = false
+        automatic = false
+
+        if values.length > 3
+          installed = values[3].include?('installed')
+          upgradeable = values[3].include?('upgradeable')
+          automatic = values[3].include?('automatic')
+        end
+
+        AptPackageOverview.new(package, version, suites, architecture, installed, upgradeable, automatic)
+      end
+    end
+  end
+end

data/lib/kanrisuru/util.rb

@@ -15,13 +15,13 @@ module Kanrisuru
       !Kanrisuru::Util.blank?(value)
     end
 
-    def self.array_join_string(arg)
-      arg.instance_of?(Array) ? arg.join(',') : arg
+    def self.array_join_string(arg, field = ',')
+      arg.instance_of?(Array) ? arg.join(field) : arg
     end
 
-    def self.string_join_array(arg)
+    def self.string_join_array(arg, field = ',')
       array = arg.instance_of?(String) ? [arg] : arg
-      array.join(',')
+      array.join(field)
     end
 
     def self.numeric?(value)

data/lib/kanrisuru/version.rb

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

data/spec/functional/core/apt_spec.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kanrisuru::Core::Apt do
+  TestHosts.each_os do |os_name|
+    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
+
+      describe 'apt install' do
+        it 'installs package' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('install', packages: %w[ffmpeg curl])
+            expect(result).to be_success
+          end
+        end
+      end
+
+      describe 'apt remove' do
+        it 'removes installed packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('remove', packages: ['ffmpeg'])
+            expect(result).to be_success
+          end
+        end
+
+        it 'purges installed packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('purge', packages: ['ffmpeg'])
+            expect(result).to be_success
+          end
+        end
+      end
+
+      describe 'apt autoremove' do
+        it 'removes unused packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('autoremove')
+            expect(result).to be_success
+          end
+        end
+      end
+
+      describe 'apt clean' do
+        it 'cleans packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('clean')
+            expect(result).to be_success
+          end
+        end
+
+        it 'autocleans packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('autoclean')
+            expect(result).to be_success
+          end
+        end
+      end
+
+      describe 'apt upgrade' do
+        it 'upgrades packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('upgrade')
+            expect(result).to be_success
+          end
+        end
+
+        it 'fully upgrades packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('full-upgrade')
+            expect(result).to be_success
+          end
+        end
+      end
+
+      describe 'apt show' do
+        it 'shows details of listed packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            result = host.apt('show', packages: %w[wget curl git sudo])
+            expect(result).to be_success
+          end
+        end
+      end
+
+      describe 'apt list' do
+        it 'lists all packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('list')
+            expect(result).to be_success
+          end
+        end
+
+        it 'lists installed packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('list', installed: true)
+            expect(result).to be_success
+          end
+        end
+
+        it 'lists upgradable packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('list', upgradable: true)
+            expect(result).to be_success
+          end
+        end
+
+        it 'lists all versions for packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            host.su('root')
+            result = host.apt('list', all_versions: true)
+            expect(result).to be_success
+          end
+        end
+
+        it 'searches packages' do
+          case os_name
+          when 'debian', 'ubuntu'
+            result = host.apt('search', query: 'wget')
+            expect(result).to be_success
+          end
+        end
+      end
+    end
+  end
+end

data/spec/functional/core/stream_spec.rb

@@ -89,7 +89,7 @@ RSpec.describe Kanrisuru::Core::Stream do
         result = host.read_file_chunk("#{spec_dir}/test-file-chunk.txt", 2, 4)
         expect(result).to be_success
         expect(result.data.length).to eq(3)
-        expect(result.data).to eq(['is', 'is', 'a'])
+        expect(result.data).to eq(%w[is is a])
       end
 
       it 'cats a file' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -131,6 +131,7 @@ files:
 - lib/kanrisuru.rb
 - lib/kanrisuru/command.rb
 - lib/kanrisuru/core.rb
+- lib/kanrisuru/core/apt.rb
 - lib/kanrisuru/core/archive.rb
 - lib/kanrisuru/core/disk.rb
 - lib/kanrisuru/core/file.rb
@@ -165,6 +166,7 @@ files:
 - lib/kanrisuru/util/os_family.rb
 - lib/kanrisuru/util/signal.rb
 - lib/kanrisuru/version.rb
+- spec/functional/core/apt_spec.rb
 - spec/functional/core/archive_spec.rb
 - spec/functional/core/disk_spec.rb
 - spec/functional/core/file_spec.rb
@@ -219,5 +221,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Manage remote servers with ruby.
+summary: Manage remote servers over ssh with ruby.
 test_files: []