getch 0.0.7 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb6075f7c63fb0a9b3d9cae63e24aae84cb3c90947985aa54ba48bc0dd284dcc
-  data.tar.gz: 26ad192fed5685f42e62d400706d6127c3d28a0fc5ce67296da6ef758955de25
+  metadata.gz: 476822c82abc15e37ab19b3e111b4b4109beb127fb775a9075757948c9e202a4
+  data.tar.gz: 1a2290c23d28c9fb0fa45ac47882698ad4f61dfe10f699804ab53162ea337e00
 SHA512:
-  metadata.gz: fe321ca0175f95f07c68026269830932609ba2fe5a1757efb7228bc26a069c4f5c322b21c534d05077c98a4dddfb0ed33bb2aa2fb30b1bc2df234e25b47acb56
-  data.tar.gz: 5b3540c9a1f07162bfbb3e4772f78c0b74b9525ec74fed7ce71c507da5f58befc85e6f8198abc595b49fa767abc77349f56b0ab9790d56730c45771365268fb0
+  metadata.gz: 6b299fd1b7b9daa4be76a482ed768e85c2372c847a7f18e4ffaebf173d8d80fddbfe9b4fccc42f3037e51d53751acaf7d12f26e87b7e68fad385d280223c8471
+  data.tar.gz: 2e97a961aaa0e8a5380fa61f1dafaa958d8941287d2c16e6d493038e6bb52f94153aeb35d5762f1b8347eef8f85f0be496ca372fac6ff070caaf03b94c237b0e

data/CHANGELOG.md

@@ -1,7 +1,46 @@
-* Repair GRUB/fstab for BIOS system, add config and all
-* New option --encrypt (LVM/EXT4/LUKS for now)
-* Adding LVM
-* Create a swap volume equal to the memory installed
+## 0.1.2, release 2021-05-12
+* DOCS update.
+* Keep Nano for those who need :)
+* ZFS use the last version >=2.0 with kernel stable =5.10
+* ZFS create a Log device and Cache device if getch is used with `--separate-cache`.
+* GRUB or Systemd-boot can now be installed on separate disk with `--separate-boot`.
+* Adding flag for ZFS `-o autotrim=on` (used with `zpool create`).
+* Encrypted swap use: `cipher=aes-xts-plain64:sha256,size=512` by default.
+* In the make.conf: add `-fomit-frame-pointer`, designed to reduce generated code size.
+
+## 0.1.1, release 2020-11-01
+* Change mountpoint for the esp at /efi rather than /boot/efi
+* Replace Garden by Bask https://github.com/szorfein/bask
+* Correct option --username USERNAME, do not create a new partition.
+* New set of options --separate-{boot,cache,home} to install them on another disk
+* Refactor codes
+* Add cpu name to COMMON_FLAGS
+* Add cpuflags with app-portage/cpuid2cpuflags
++ Use the whole disk space available for / when option --username is unset
+
+## 0.1.0, release 2020-10-15
+* Add the (Zeta) filesystem ZFS
+* `emerge --depclean` to save space.
+* Add a message when getch have finish, keep /mnt/gentoo if you need to add something.
+* Use systemd-detect-virt to detect a Virtual Guest.
+
+## 0.0.9, release 2020-10-03
+* Add encryption on ext4 and lvm (BIOS,UEFI)
+* Correct KEYMAP="yes" with genkernel
+* Renaming option keyboard with keymap
+* GPG verification for ebuild
+
+## 0.0.8, release 2020-09-30
+* Adding LVM via the option fs, `--fs lvm`.
+* Systemd-boot use the value of PARTUUID without initramfs.
+* Include lib logger.
+* Enhance functions to call program system Emerge, Make, ...
+
+## 0.0.7, release 2020-09-22
+* Correct fstab.
+* Repair GRUB/fstab for BIOS system, add secure cmdline.
+* Create a swap volume equal to the memory installed.
+* Add vim and sudo
 
 ## 0.0.6, release 2020-09-19
 * Add support for QEMU guest with KVM and Virtio driver

data/README.md

@@ -3,15 +3,17 @@ A CLI tool to install Gentoo.
 
 ## Description
 Actually, Getch support only the [AMD64 handbook](https://wiki.gentoo.org/wiki/Handbook:AMD64) and only with the last `stage3-amd64-systemd`.  
-It also require a disk (only one for now) with a minimum of 20G.  
 
-Filesystem supported by Getch are: (the list will evolve...)
-+ ext4 with GRUB2 for BIOS based system and systemd-boot for UEFI systems.
+BIOS system will use `Grub2` and `systemd-boot` for UEFI. Filesystem supported by Getch are for now:
++ Ext4
++ LVM
++ ZFS
 
-I would also add disk encryption soon.
+Encryption is also supported.
 
 The ISO images i was able to test and that works:
 + [Archlinux](https://www.archlinux.org/download/)
++ [Archaeidae](https://github.com/szorfein/archaeidae): Custom Archiso that includes ZFS support.
 
 ## Install
 Getch is cryptographically signed, so add my public key (if you haven’t already) as a trusted certificate.  
@@ -23,19 +25,70 @@ With `gem` installed:
 
 When you boot from an `iso`, you can install `ruby`, `getch` and correct your `PATH=` directly with the `bin/setup.sh`:
 
-    # curl https://raw.githubusercontent.com/szorfein/getch/master/bin/setup.sh | sh
+    # sh <(curl -L https://raw.githubusercontent.com/szorfein/getch/master/bin/setup.sh)
     # source ~/.zshrc # or ~/.bashrc
 
+If you want to try the master branch:
+
+    # git clone https://github.com/szorfein/getch
+    # cd getch
+    # ruby -I lib bin/getch -h
+
 ## Usage
+Just ensure than the script is run with a root account.
+
+    # getch -h
 
-    $ getch -h
+After an install by Getch, take a look on the [wiki](https://github.com/szorfein/getch/wiki).
 
 ## Examples
 For a french user:
 
-    # getch --username ninja --zoneinfo "Europe/Paris" --language fr_FR --keyboard fr
+    # getch --zoneinfo "Europe/Paris" --language fr_FR --keymap fr
 
-After an install by Getch, take a look on the [wiki](https://github.com/szorfein/getch/wiki).
+Install Gentoo on LVM:
+
+    # getch --format lvm --disk sda
+
+Encrypt your disk with LVM with a french keymap
+
+    # getch --format lvm --encrypt --keymap fr
+
+Encrypt with ext4 and create a home directory /home/ninja
+
+    # getch --format ext4 --encrypt --username ninja
+
+With ZFS:
+
+    # getch --format zfs
+
+## Troubleshooting
+
+#### LVM
+Unless your old LVM volume group is also named `vg0`, `getch` may fail to partition your disk. You have to clean up your device before proceed with `vgremove` and `pvremove`. An short example how doing this with a volume group named `vg0`:
+
+    # vgdisplay | grep vg0
+    # vgremove -f vg0
+    # pvremove -f /dev/sdb
+
+#### Encryption enable on BIOS with ext4
+To decrypt your disk on BIOS system, you have to enter your password two times. One time for Grub and another time for the initramfs (Genkernel). [post](https://wiki.archlinux.org/index.php/GRUB#Encrypted_/boot).  
+Also with GRUB, only a `us` keymap is working.
+
+#### With ZFS
+When Gentoo boot, the pool may fail to start, it's happen when the pool has not been `export` to the ISO. So just reboot on your ISO:
+
+You need the partuuid, pool are create with the first 5 characters, just replace `sdX` by your real device:
+
+    # ls -l /dev/disk/by-partuuid/ | grep sdX4
+    -> 150ed969...
+    # zpool import -N -R /mnt rpool-150ed
+
+And export them correctly:
+
+    # zpool export -a
+
+It's all.
 
 ## Issues
 If need more support for your hardware (network, sound card, ...), you can submit a [new issue](https://github.com/szorfein/getch/issues/new) and post the output of the following command:

data/bin/setup.sh

@@ -26,7 +26,7 @@ search_ruby() {
   else
     echo "Install ruby"
     if hash pacman 2>/dev/null ; then
-      pacman -Syy libyaml ruby ruby-irb ruby-reline rubygems
+      pacman -Syy --noconfirm libyaml ruby ruby-irb ruby-reline rubygems
     elif hash emerge 2>/dev/null ; then
       emerge -av dev-lang/ruby
     elif hash apt-get 2>/dev/null ; then
@@ -72,10 +72,12 @@ set_shell() {
   [ -f ~/.zshrc ] && your_shell=~/.zshrc
 
   [ -f "$your_shell" ] && {
-    if ! grep -q ".gem/ruby/[0-9.]*/bin" "$your_shell" ; then
+    if ! grep -q "ruby" "$your_shell" ; then
       echo "export PATH=\$PATH:$(ruby -e 'puts Gem.user_dir')/bin" >> "$your_shell"
     fi
-    . "$your_shell"
+    if $(. "$your_shell") ; then
+      echo "Shell loaded"
+    fi
   }
 }
 

data/lib/getch.rb

@@ -4,16 +4,20 @@ require_relative 'getch/gentoo'
 require_relative 'getch/filesystem'
 require_relative 'getch/command'
 require_relative 'getch/helpers'
+require_relative 'getch/log'
 
 module Getch
 
   DEFAULT_OPTIONS = {
     language: 'en_US',
     zoneinfo: 'US/Eastern',
-    keyboard: 'us',
+    keymap: 'us',
     disk: 'sda',
     fs: 'ext4',
     username: nil,
+    boot_disk: nil,
+    cache_disk: nil,
+    home_disk: nil,
     encrypt: false,
     verbose: false
   }
@@ -29,19 +33,38 @@ module Getch
   }
 
   MOUNTPOINT = "/mnt/gentoo".freeze
-  OPTIONS_FS = {
-    'ext4' => DEFAULT_OPTIONS[:encrypt] ? Getch::FileSystem::Ext4::Encrypt : Getch::FileSystem::Ext4
+  DEFAULT_FS = {
+    true => {
+      ext4: Getch::FileSystem::Ext4::Encrypt,
+      lvm: Getch::FileSystem::Lvm::Encrypt,
+      zfs: Getch::FileSystem::Zfs::Encrypt
+    },
+    false => {
+      ext4: Getch::FileSystem::Ext4,
+      lvm: Getch::FileSystem::Lvm,
+      zfs: Getch::FileSystem::Zfs,
+    }
   }.freeze
 
+  def self.class_fs
+    encrypt = DEFAULT_OPTIONS[:encrypt]
+    fs = DEFAULT_OPTIONS[:fs].to_sym
+    DEFAULT_FS[encrypt][fs]
+  end
+
   def self.resume_options(opts)
     puts "\nBuild Gentoo with the following args:\n"
-    puts "lang: #{DEFAULT_OPTIONS[:language]}"
-    puts "zoneinfo: #{DEFAULT_OPTIONS[:zoneinfo]}"
-    puts "keyboard: #{DEFAULT_OPTIONS[:keyboard]}"
-    puts "disk: #{DEFAULT_OPTIONS[:disk]}"
-    puts "fs: #{DEFAULT_OPTIONS[:fs]}"
-    puts "username: #{DEFAULT_OPTIONS[:username]}"
-    puts "encrypt: #{DEFAULT_OPTIONS[:encrypt]}"
+    puts "Lang: #{DEFAULT_OPTIONS[:language]}"
+    puts "Zoneinfo: #{DEFAULT_OPTIONS[:zoneinfo]}"
+    puts "Keymap: #{DEFAULT_OPTIONS[:keymap]}"
+    puts "Disk: #{DEFAULT_OPTIONS[:disk]}"
+    puts "Filesystem: #{DEFAULT_OPTIONS[:fs]}"
+    puts "Username: #{DEFAULT_OPTIONS[:username]}"
+    puts "Encrypt: #{DEFAULT_OPTIONS[:encrypt]}"
+    puts
+    puts "separate-boot disk: #{DEFAULT_OPTIONS[:boot_disk]}"
+    puts "separate-cache disk: #{DEFAULT_OPTIONS[:cache_disk]}"
+    puts "separate-home disk: #{DEFAULT_OPTIONS[:home_disk]}"
     puts
     print "Continue? (n,y) "
     case gets.chomp
@@ -54,12 +77,14 @@ module Getch
 
   def self.format(disk, fs, user)
     return if STATES[:format] and STATES[:partition]
+    log = Log.new
     puts
     print "Partition and format disk #{disk}, this will erase all data, continue? (n,y) "
     case gets.chomp
     when /^y|^Y/
-      OPTIONS_FS[fs]::Partition.new
-      OPTIONS_FS[fs]::Format.new
+      log.info("Partition start")
+      class_fs::Partition.new
+      class_fs::Format.new
     else
       exit 1
     end
@@ -80,7 +105,7 @@ module Getch
     resume_options(options)
     Getch::States.new # Update States
     format(options.disk, options.fs, options.username)
-    OPTIONS_FS[DEFAULT_OPTIONS[:fs]]::Mount.new.run
+    class_fs::Mount.new.run
     init_gentoo(options)
   end
 end

data/lib/getch/command.rb

@@ -4,14 +4,22 @@ module Getch
   class Command
     def initialize(cmd)
       @cmd = cmd
-      @block_size = 512
+      @block_size = 1024
+      @log = Getch::Log.new
     end
 
     def run!
-      puts "Running command: " + @cmd.gsub(/\"/, '')
+      @log.info "Running command: " + @cmd.gsub(/\"/, '')
 
-      Open3.popen3(@cmd) do |stdin, stdout, stderr|
+      Open3.popen3(@cmd) do |stdin, stdout, stderr, wait_thr|
         stdin.close_write
+        code = wait_thr.value
+
+        # only stderr
+        begin
+          @log.debug stderr.readline until stderr.eof.nil?
+        rescue EOFError
+        end
 
         begin
           files = [stdout, stderr]
@@ -24,25 +32,20 @@ module Getch
               # writable = ready[1]
               # exceptions = ready[2]
 
-              readable.each do |f|
-                fileno = f.fileno
-
-                begin
-                  data = f.read_nonblock(@block_size)
-
-                  # Do something with the data...
-                  puts "#{data}" if DEFAULT_OPTIONS[:verbose]
-                rescue EOFError
-                  puts "fileno: #{fileno} EOF"
-                end
-              end
+              display_lines(readable)
             end
           end
         rescue IOError => e
           puts "IOError: #{e}"
         end
+
+        unless code.success?
+          @log.fatal "Running #{@cmd}"
+          exit 1
+        end
+
+        @log.debug "Done - #{@cmd} - #{code}"
       end
-      puts "Done"
     end
 
     private
@@ -51,5 +54,124 @@ module Getch
     def all_eof(files)
       files.find { |f| !f.eof }.nil?
     end
+
+    def display_lines(block)
+      block.each do |f|
+        begin
+          data = f.read_nonblock(@block_size)
+          puts data if DEFAULT_OPTIONS[:verbose]
+        rescue EOFError
+          puts ""
+        rescue => e
+          puts "Fatal - #{e}"
+        end
+      end
+    end
+  end
+
+  # Use system, the only ruby method to display stdout with colors !
+  class Emerge
+    def initialize(cmd)
+      @gentoo = MOUNTPOINT
+      @cmd = cmd
+      @log = Getch::Log.new
+    end
+
+    def run!
+      @log.info "Running emerge: #{@cmd}"
+      system("chroot", @gentoo, "/bin/bash", "-c", "source /etc/profile && #{@cmd}")
+      read_exit
+    end
+
+    def pkg!
+      @log.info "Running emerge pkg: #{@cmd}"
+      system("chroot", @gentoo, "/bin/bash", "-c", "source /etc/profile && emerge --changed-use #{@cmd}")
+      read_exit
+    end
+
+    private
+
+    def read_exit
+      if $?.exitstatus > 0
+        @log.fatal "Running #{@cmd}"
+      else
+        @log.info "Done #{@cmd}"
+      end
+    end
+  end
+
+  class Make
+    def initialize(cmd)
+      @gentoo = MOUNTPOINT
+      @cmd = cmd
+      @log = Getch::Log.new
+    end
+
+    def run!
+      @log.info "Running Make: #{@cmd}"
+      cmd = "chroot #{@gentoo} /bin/bash -c \"source /etc/profile \
+        && env-update \
+        && cd /usr/src/linux \
+        && #{@cmd}\""
+      Open3.popen2e(cmd) do |stdin, stdout_err, wait_thr|
+        while line = stdout_err.gets
+          puts line
+        end
+
+        exit_status = wait_thr.value
+        unless exit_status.success?
+          @log.fatal "Running #{cmd}"
+          exit 1
+        end
+      end
+    end
+  end
+
+  class Bask
+    def initialize(cmd)
+      @gentoo = MOUNTPOINT
+      @cmd = cmd
+      @log = Getch::Log.new
+      @version = "0.4"
+    end
+
+    def run!
+      download_bask if ! Dir.exist? "#{MOUNTPOINT}/root/bask-#{@version}"
+      @log.info "Running Bask: #{@cmd}"
+      cmd = "chroot #{@gentoo} /bin/bash -c \"source /etc/profile \
+        && env-update \
+        && cd /root/bask-#{@version} \
+        && ./bask.sh #{@cmd} -k /usr/src/linux\""
+      Open3.popen2e(cmd) do |stdin, stdout_err, wait_thr|
+        while line = stdout_err.gets
+          puts line
+        end
+
+        exit_status = wait_thr.value
+        unless exit_status.success?
+          @log.fatal "Running #{cmd}"
+          exit 1
+        end
+      end
+    end
+
+    private 
+
+    def download_bask
+      @log.info "Installing Bask..."
+      url = "https://github.com/szorfein/bask/archive/v#{@version}.tar.gz"
+      file = "bask-#{@version}.tar.gz"
+
+      Dir.chdir("#{MOUNTPOINT}/root")
+      Helpers::get_file_online(url, file)
+      Getch::Command.new("tar xzf #{file}").run!
+    end
+  end
+
+  class Chroot < Command
+    def initialize(cmd)
+      super
+      @cmd = "chroot #{MOUNTPOINT} /bin/bash -c \"source /etc/profile; #{cmd}\""
+    end
   end
 end