getch 0.1.9 → 0.3.0

data/lib/mkfs/zfs.rb

@@ -0,0 +1,167 @@
+require 'getch/log'
+
+module Mkfs
+  class Zfs < Root
+    def initialize(devs, options)
+      @mountpoint = options[:mountpoint]
+      @zfs = options[:zfs_name] ||= 'pool'
+      @os = options[:os]
+      @encrypt = options[:encrypt]
+      @zlog = devs[:zlog] ||= nil
+      @zcache = devs[:zcache] ||= nil
+      @rpool = "r#{@zfs}"
+      @bpool = "b#{@zfs}"
+      @hpool = "h#{@zfs}"
+      @log = Getch::Log.new
+      super
+    end
+
+    # reorder process, root should be formatted first
+    def x
+      format_efi
+      format_root
+      format_boot
+      format_swap
+      format_home
+      add_dataset
+    end
+
+    # https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2020.04%20Root%20on%20ZFS.html#id13
+    def format_boot
+      @boot || return
+
+      id = Getch::Helpers.get_id(@boot)
+      ashift = get_ashift @boot
+      args = "-f -o ashift=#{ashift} -o autotrim=on"
+      args << ' -o feature@async_destroy=enabled'
+      args << ' -o feature@bookmarks=enabled'
+      args << ' -o feature@embedded_data=enabled'
+      args << ' -o feature@empty_bpobj=enabled'
+      args << ' -o feature@enabled_txg=enabled'
+      args << ' -o feature@extensible_dataset=enabled'
+      args << ' -o feature@filesystem_limits=enabled'
+      args << ' -o feature@hole_birth=enabled'
+      args << ' -o feature@large_blocks=enabled'
+      args << ' -o feature@lz4_compress=enabled'
+      args << ' -o feature@spacemap_histogram=enabled'
+      args << ' -O acltype=posixacl -O canmount=off -O compression=lz4'
+      args << ' -O devices=off -O normalization=formD -O atime=off -O xattr=sa'
+      args << ' -O mountpoint=/boot'
+      args << " -R #{@mountpoint} #{@bpool} #{id}"
+      sh 'zpool', 'create', args
+    end
+
+    def format_swap
+      mk_swap "/dev/#{@swap}"
+      add_zlog
+      add_zcache
+    end
+
+    def add_zlog
+      @zlog || return
+
+      id = Getch::Helpers.get_id(@zlog)
+      sh 'zpool', 'add', @rpool, 'log', id
+    end
+
+    def add_zcache
+      @zcache || return
+
+      id = Getch::Helpers.get_id(@zcache)
+      sh 'zpool', 'add', @rpool, 'cache', id
+    end
+
+    def format_root
+      id = Getch::Helpers.get_id(@root)
+      ashift = get_ashift @root
+      args = "-f -o ashift=#{ashift} -o autotrim=on"
+      @encrypt && args << ' -O encryption=aes-256-gcm'
+      @encrypt && args << ' -O keylocation=prompt -O keyformat=passphrase'
+      args << ' -O acltype=posixacl -O canmount=off -O compression=lz4'
+      args << ' -O xattr=sa -O mountpoint=/'
+      args << " -R #{@mountpoint} #{@rpool} #{id}"
+      sh 'zpool', 'create', args
+    end
+
+    def format_home
+      @home || return
+
+      id = Getch::Helpers.get_id(@home)
+      ashift = get_ashift @home
+      args = "-f -o ashift=#{ashift} -o autotrim=on"
+      @encrypt && args << ' -O encryption=aes-256-gcm'
+      @encrypt && args << ' -O keylocation=prompt -O keyformat=passphrase'
+      args << ' -O acltype=posixacl -O canmount=off -O compression=lz4'
+      args << ' -O xattr=sa -O mountpoint=/home'
+      args << " -R #{@mountpoint} #{@hpool} #{id}"
+      sh 'zpool', 'create', args
+    end
+
+    def add_dataset
+      zfs_create "-o canmount=off -o mountpoint=none #{@rpool}/ROOT"
+      zfs_create "-o canmount=noauto -o mountpoint=/ #{@rpool}/ROOT/#{@os}"
+      Getch::Command.new("zfs mount #{@rpool}/ROOT/#{@os}")
+
+      zfs_create "-o canmount=off #{@rpool}/ROOT/#{@os}/usr"
+      zfs_create "#{@rpool}/ROOT/#{@os}/usr/src"
+
+      zfs_create "-o canmount=off #{@rpool}/ROOT/#{@os}/var"
+      zfs_create "#{@rpool}/ROOT/#{@os}/var/log"
+      zfs_create "#{@rpool}/ROOT/#{@os}/var/db"
+      zfs_create "#{@rpool}/ROOT/#{@os}/var/tmp"
+      zfs_create "#{@rpool}/ROOT/#{@os}/var/lib"
+      zfs_create "#{@rpool}/ROOT/#{@os}/var/lib/docker"
+
+      boot_dataset
+      user_dataset
+    end
+
+    def boot_dataset
+      @boot || return
+
+      zfs_create "-o canmount=off -o mountpoint=none #{@bpool}/BOOT"
+      zfs_create "-o canmount=noauto -o mountpoint=/boot #{@bpool}/BOOT/#{@os}"
+    end
+
+    def user_dataset
+      if @home
+        zfs_create "-o canmount=off -o mountpoint=/ #{@hpool}/USERDATA"
+        zfs_create "-o canmount=on -o mountpoint=/root #{@hpool}/USERDATA/root"
+        zfs_create "-o canmount=on -o mountpoint=/home #{@hpool}/USERDATA/home"
+      else
+        zfs_create "-o canmount=off -o mountpoint=/ #{@rpool}/USERDATA"
+        zfs_create "-o canmount=on -o mountpoint=/root #{@rpool}/USERDATA/root"
+        zfs_create "-o canmount=on -o mountpoint=/home #{@rpool}/USERDATA/home"
+      end
+    end
+
+    private
+
+    def get_ashift(dev)
+      bs = Getch::Helpers.get_bs("/dev/#{dev}")
+      case bs
+      when /8096/ then 13
+      when /4096/ then 12
+      else 9
+      end
+    end
+
+    def zfs_create(*args)
+      Getch::Command.new('zfs', 'create', args)
+    end
+
+    def sh(*args)
+      @encrypt ?
+        cmd_crypt(args) :
+        Getch::Command.new(args)
+    end
+
+    def cmd_crypt(*args)
+      system args.join(' ')
+      return if $?.exitstatus == 0
+
+      @log.dbg $?
+      @log.fatal 'die'
+    end
+  end
+end

data/lib/mkfs.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'getch/command'
+require 'getch/helpers'
+
+module Mkfs
+  class Root
+    def initialize(devs, options)
+      @efi = devs[:efi] ||= nil
+      @boot = devs[:boot] ||= nil
+      @swap = devs[:swap] ||= nil
+      @root = devs[:root] ||= nil
+      @home = devs[:home] ||= nil
+      @fs = options[:fs]
+      x
+    end
+
+    protected
+
+    def x
+      format_efi
+      format_boot
+      format_swap
+      format_root
+      format_home
+    end
+
+    def format_efi
+      @efi || return
+
+      mkfs_vfat "/dev/#{@efi}"
+    end
+
+    def format_boot
+      @boot || return
+
+      mkfs "/dev/#{@boot}"
+    end
+
+    def format_swap
+      @swap || return
+
+      mk_swap "/dev/#{@swap}"
+    end
+
+    def format_root
+      @root || return
+
+      mkfs "/dev/#{@root}"
+    end
+
+    def format_home
+      @home || return
+
+      mkfs "/dev/#{@home}"
+    end
+
+    private
+
+    def mkfs(path)
+      case @fs
+      when 'ext4' then mkfs_ext4 path
+      when 'xfs' then mkfs_xfs path
+      end
+    end
+
+    def mkfs_vfat(path)
+      Getch::Command.new('mkfs.fat', '-F32', path)
+    end
+
+    def mk_swap(path)
+      Getch::Command.new('mkswap', '-f', path)
+    end
+
+    def mkfs_ext4(path)
+      bs = Getch::Helpers.get_bs(path)
+      Getch::Command.new('mkfs.ext4', '-F', '-b', bs, path)
+    end
+
+    def mkfs_xfs(path)
+      bs = Getch::Helpers.get_bs(path)
+      Getch::Command.new('mkfs.xfs', '-f', '-s', "size=#{bs}", path)
+    end
+  end
+
+  class Lvm < Root
+    def initialize(devs, options)
+      @vg = options[:vg_name]
+      super
+    end
+
+    def format_swap
+      mk_swap "/dev/#{@vg}/swap"
+    end
+
+    def format_root
+      mkfs "/dev/#{@vg}/root"
+    end
+
+    def format_home
+      mkfs "/dev/#{@vg}/home"
+    end
+  end
+
+  class Encrypt < Root
+    def initialize(devs, options)
+      @luks = options[:luks_name]
+      super
+    end
+
+    # Boot is alrealy formatted
+    def format_boot
+    end
+
+    # Swap will be encrypted after the reboot
+    def format_swap
+    end
+
+    def format_root
+      File.exist? "/dev/mapper/root-#{@luks}" || abort("No root-#{@luks} found")
+
+      mkfs "/dev/mapper/root-#{@luks}"
+    end
+
+    def format_home
+      @home || return
+
+      mkfs "/dev/mapper/home-#{@luks}"
+    end
+  end
+
+  class Hybrid < Lvm
+
+    # Boot is alrealy formatted
+    def format_boot
+    end
+  end
+end
+
+require_relative 'mkfs/zfs'

data/lib/mountfs.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'nito'
+
+module MountFs
+  class Minimal
+    include NiTo
+
+    def initialize(devs, options)
+      @efi = devs[:efi] ||= nil
+      @boot = devs[:boot] ||= nil
+      @swap = devs[:swap] ||= nil
+      @root = devs[:root] ||= nil
+      @home = devs[:home] ||= nil
+      @mountpoint = options[:mountpoint]
+      x
+    end
+
+    protected
+
+    def x
+      mount_root
+      mount_efi
+      mount_boot
+      mount_swap
+      mount_home
+    end
+
+    def mount_root
+      mount "/dev/#{@root}", @mountpoint
+    end
+
+    def mount_efi
+      @efi || return
+
+      mount "/dev/#{@efi}", "#{@mountpoint}/efi"
+    end
+
+    def mount_boot
+      @boot || return
+
+      mount "/dev/#{@root}", "#{@mountpoint}/boot"
+    end
+
+    def mount_swap
+      @swap || return
+
+      grep?('/proc/swaps', "/dev/#{@swap}") && return
+
+      swapon "/dev/#{@swap}"
+    end
+
+    def mount_home
+      @home || return
+
+      mount "/dev/#{@home}", "#{@mountpoint}/home"
+    end
+
+    private
+
+    def swapon(path)
+      Getch::Command.new('swapon', path)
+    end
+  end
+
+  class Lvm < Minimal
+    def initialize(devs, options)
+      @vg = options[:vg_name]
+      super
+    end
+
+    def mount_root
+      mount "/dev/#{@vg}/root", @mountpoint
+    end
+
+    def mount_swap
+      dm = Getch::Helpers.get_dm "#{@vg0}-swap"
+
+      grep?('/proc/swaps', "/dev/#{dm}") && return
+
+      swapon "/dev/#{@vg}/swap"
+    end
+
+    def mount_home
+      mount "/dev/#{@vg}/home", "#{@mountpoint}/home"
+    end
+  end
+
+  class Encrypt < Minimal
+    def initialize(devs, options)
+      @luks = options[:luks_name]
+      super
+    end
+
+    def mount_root
+      umount "/dev/mapper/boot-#{@luks}"
+      mount "/dev/mapper/root-#{@luks}", @mountpoint
+    end
+
+    def mount_boot
+      mount "/dev/mapper/boot-#{@luks}", "#{@mountpoint}/boot"
+    end
+
+    def mount_swap
+    end
+
+    def mount_home
+      @home || return
+
+      mount "/dev/mapper/home-#{@luks}", "#{@mountpoint}/home"
+    end
+  end
+
+  class Hybrid < Encrypt
+    def initialize(devs, options)
+      @vg = options[:vg_name]
+      super
+    end
+
+    def mount_root
+      umount "/dev/mapper/boot-#{@luks}"
+      mount "/dev/#{@vg}/root", @mountpoint
+    end
+
+    def mount_boot
+      mount "/dev/mapper/boot-#{@luks}", "#{@mountpoint}/boot"
+    end
+
+    def mount_home
+      mount "/dev/#{@vg}/home", "#{@mountpoint}/home"
+    end
+  end
+
+  class Zfs < Minimal
+    def initialize(devs, options)
+      @zfs = options[:zfs_name]
+      @os = options[:os]
+      super
+    end
+
+    # Root should be alrealy mounted
+    def mount_root
+    end
+
+    def mount_boot
+      @boot || return
+
+      Getch::Command.new("zfs mount b#{@zfs}/BOOT/#{@os}")
+    end
+
+    def mount_home
+    end
+  end
+end

data/lib/nito.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'open3'
+require 'tempfile'
+require_relative 'getch/log'
+require_relative 'getch/command'
+
+# uNix Tools like mkdir, mount in Ruby code
+module NiTo
+  module_function
+
+  def mkdir(path, perm = 0755)
+    return if Dir.exist? path
+
+    FileUtils.mkdir_p path, mode: perm
+  end
+
+  def grep?(file, search)
+    is_found = false
+    return is_found unless File.exist? file
+
+    File.open(file).each do |l|
+      is_found = true if l =~ /#{search}/
+    end
+    is_found
+  end
+
+  def rm(file)
+    File.exist?(file) && File.delete(file)
+  end
+
+  def umount(dir)
+    return unless mount? dir
+
+    Getch::Command.new('umount', dir)
+  end
+
+  # Mount, accept *args, the last argument should be the destination
+  # e.g: mount '--types proc', '/proc', '/mnt/getch/proc'
+  def mount(*args)
+    return if mount? args.last
+
+    mkdir args.last
+    Getch::Command.new('mount', args.join(' '))
+  end
+
+  def mount?(dir)
+    res = false
+    File.open('/proc/mounts').each do |l|
+      res = true if l =~ /#{dir}/
+    end
+    res
+  end
+
+  # Like echo 'content' > to_file
+  def echo(file, content)
+    File.write file, "#{content}\n", mode: 'w'
+  end
+
+  # Like echo 'content' >> to_file
+  def echo_a(file, content)
+    File.write file, "#{content}\n", mode: 'a' unless grep? file, content
+  end
+
+  def cp(src, dest)
+    FileUtils.cp src, dest
+  end
+
+  # create a void file
+  def touch(file)
+    File.write file, '' unless File.exist? file
+  end
+
+  # Like sed -i /old:new/ file
+  def sed(file, regex, change)
+    tmp_file = Tempfile.new
+    File.open(file).each do |l|
+      if l.match(regex)
+        echo_a tmp_file, change
+      else
+        File.write tmp_file, l, mode: 'a'
+      end
+    end
+    cp tmp_file, file
+  end
+
+  def search_proc_swaps(path)
+    found = nil
+    File.open('/proc/swaps').each do |l|
+      if l =~ /#{path}/
+        found = l.split(' ')
+      end
+    end
+    found
+  end
+
+  def swapoff(dev)
+    return unless grep? '/proc/swaps', dev
+
+    found = search_proc_swaps(dev)
+    found ?
+      Getch::Command.new('swapoff', found[0]) :
+      return
+  end
+
+  def swapoff_dm(name)
+    dm = Getch::Helpers.get_dm name
+    dm || return
+
+    found = search_proc_swaps(dm)
+    found ?
+      Getch::Command.new('swapoff', found[0]) :
+      return
+  end
+
+  def sh(*args)
+    log = Log.new
+    Open3.popen3 args.join(' ') do |_, stdout, stderr, wait_thr|
+      if wait_thr.value.success?
+        log.info_res 'Ok'
+        return stdout.read.chomp
+      end
+      puts
+      log.dbg args.join(' ') + "\nEXIT:#{wait_thr.value}"
+      log.dbg "STDERR:#{stderr.read}"
+      log.dbg "STDOUT:#{stdout.read}"
+      log.fatal 'Die'
+    end
+  end
+end