getch 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab4a85424380fa152f9d5e764799ab85f44c2bcc09a74f0e8d8ba80278f7b880
-  data.tar.gz: 586e590f3a66d81382193c4e1d0c8735165c39b6d4ef6eed8846aa620fd03a8b
+  metadata.gz: 87ae271211f6081929b72327651ff6e4f18adeca452cf10294d75a114f26db38
+  data.tar.gz: eb0ea1a935578351133e4c13dd0ee7e13d1696d6fbcc58bbd441e59d1cacf7de
 SHA512:
-  metadata.gz: 2262f40341744f5d9128ae1372c48c3f1d762054cc600ca202f406e8b6d4c4d2912be157d0af08f61bc039b894e7c3825ff87a7a8ef2070e2411eb21f747aba0
-  data.tar.gz: 854f785d9cee4e03b1e724881483ae3f9f69388ee0079dcf1c2ed057eb0b98d81236948b170fe6cc1b985f991f8ac13316c48417a943f68f67c3a20a9c9dbbaf
+  metadata.gz: b32454448824fef83fab42ac34534125b0dc6d0655235f271c97b644105dba75eebf0ca56b1c32e6a8cab019fa638d4e9fc44f20744cafd7ca584a94e05a0f4d
+  data.tar.gz: 809fc8dd380821f9bc479b4efee45f7f83cafc3a0a14a441881a3abd1daaeb0da84b20a2f2ff0af9bdee31cc1f247a21a873ef2729144ec2483aec8f165b6adf

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.swp

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## 0.0.6, release 2020-09-19
+* Add support for QEMU guest #2
+* Kernel compilation, initialize a config file with `make localyesconfig`.
+* More modular codes to start with encryption and other filesystems.
+* Add the new option --verbose to display output of compilation, etc... #2
+
+## 0.0.5, release 2020-09-17
+* Generate a hostname
+* Configure systemd-boot for UEFI system
+
+## 0.0.4, release 2020-09-16
+* Boot on a BIOS system with VirtualBox
+* Install Grub
+* Create user
+* Create passwd for root and user
+* Check lsmod to install deps (like wpa_supplicant) and patch the kernel
+
+## 0.0.3, release 2020-09-14
+* Add dhcpcd, gentoo-sources, linux-firmware
+* Kernel build by using https://github.com/szorfein/garden
+* Populate /etc/portage (/etc/portage/package.{use,unmask,accept_keywords}/zzz_via_autounmask)
+* Download all the lastest ebuild via emerge-webrsync
+* Update gentoo via emerge -uDN @world
+
+## 0.0.2, release 2020-09-12
+* Getch genere a file /tmp/install_gentoo to avoid to remake same task over and over
+* Support for ext4
+* Mount partition on /mnt/gentoo during the install
+* Download, verify the checksum and decompress the last stage3-amd64-systemd
+
+## 0.0.1, release 2020-09-10
+* Partition disk (at least 15G required) with sgdisk (create /boot, /, /home, and swap)
+* Support for one disk with -d|--disk
+* Add few options for the CLI
+* Add bin/setup.sh to install ruby when boot on a ISO file
+* Init project

data/README.md

@@ -1,6 +1,43 @@
 # Getch
-A script to install Gentoo.
+A CLI tool to install Gentoo.
 
-# Install
+## 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.
+
+I would also add disk encryption soon.
+
+The ISO images i was able to test and that works:
++ [Archlinux](https://www.archlinux.org/download/)
+
+## Install
+Getch is cryptographically signed, so add my public key (if you haven’t already) as a trusted certificate.  
+With `gem` installed:
+
+    $ gem cert --add <(curl -Ls https://raw.githubusercontent.com/szorfein/getch/master/certs/szorfein.pem)
+
+    $ gem install getch -P HighSecurity
+
+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
+    # source ~/.zshrc # or ~/.bashrc
+
+## Usage
+
+    $ getch -h
+
+## Examples
+For a french user:
+
+    # getch --username ninja --zoneinfo "Europe/Paris" --language fr_FR --keyboard fr
+
+After an install by Getch, take a look on the [wiki](https://github.com/szorfein/getch/wiki).
+
+## 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:
++ lspci
++ lsmod

data/Rakefile

@@ -0,0 +1,21 @@
+# https://github.com/seattlerb/minitest#running-your-tests-
+require "rake/testtask"
+require File.dirname(__FILE__) + "/lib/getch/version"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+end
+
+# Usage: rake gem:build
+namespace :gem do
+  desc "build the gem"
+  task :build do
+    Dir["getch*.gem"].each {|f| File.unlink(f) }
+    system("gem build getch.gemspec")
+    system("gem install getch-#{Getch::VERSION}.gem -P HighSecurity")
+  end
+end
+
+task :default => :test

data/bin/getch

@@ -2,4 +2,8 @@
 
 require 'getch'
 
-Getch::main(ARGV)
+def main(argv)
+  Getch::main(argv)
+end
+
+main(ARGV)

data/bin/setup.sh

@@ -26,8 +26,7 @@ search_ruby() {
   else
     echo "Install ruby"
     if hash pacman 2>/dev/null ; then
-      pacman -Syy
-      pacman -S --needed ruby
+      pacman -Syy 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
@@ -39,19 +38,37 @@ search_ruby() {
 }
 
 get_getch() {
-  cd /tmp
-  [ -f ./getch.tar.gz ] && rm ./getch.tar.gz
-  [ -d ./getch-master ] && rm -rf ./getch-master
+  if hash gem 2>/dev/null ; then
+    gem install getch
+    getch -h
+  else
+    cd /tmp
+    [ -f ./getch.tar.gz ] && rm ./getch.tar.gz
+    [ -d ./getch-master ] && rm -rf ./getch-master
+
+    curl -s -L -o getch.tar.gz https://github.com/szorfein/getch/archive/master.tar.gz
+    tar xzf getch.tar.gz \
+      && cd $DIR \
+      && ruby -I lib bin/getch -h
+  fi
+}
 
-  curl -s -L -o getch.tar.gz https://github.com/szorfein/getch/archive/master.tar.gz
-  tar xzf getch.tar.gz
+set_shell() {
+  your_shell=~/.bashrc
+  [ -f ~/.zshrc ] && your_shell=~/.zshrc
+
+  [ -f "$your_shell" ] && {
+    if ! grep -q ".gem/ruby/[0-9.]*/bin" "$your_shell" ; then
+      echo "export PATH=\$PATH:$(ruby -e 'puts Gem.user_dir')/bin" >> "$your_shell"
+    fi
+    . "$your_shell"
+  }
 }
 
 main() {
-  get_getch
   search_ruby
-  cd $DIR \
-    && ruby -I lib bin/getch
+  set_shell
+  get_getch
 }
 
 main "$@"

data/getch.gemspec

@@ -3,10 +3,15 @@ require File.dirname(__FILE__) + "/lib/getch/version"
 Gem::Specification.new do |s|
   s.name = "getch"
   s.version = Getch::VERSION
-  s.summary = "A script to install Gentoo"
+  s.summary = "A CLI tool to install Gentoo"
   s.authors = ["szorfein"]
   s.email = ["szorfein@protonmail.com"]
   s.homepage = 'https://github.com/szorfein/getch'
+  s.metadata = {
+    "changelog_uri" => "https://github.com/szorfein/getch/blob/master/CHANGELOG.md",
+    "bug_tracker_uri" => "https://github.com/szorfein/getch/issues",
+    "wiki_uri" => "https://github.com/szorfein/getch"
+  }
   s.license = "MIT"
   s.required_ruby_version = '>=2.5'
 
@@ -15,7 +20,6 @@ Gem::Specification.new do |s|
 
   s.executables = [ 'getch' ]
 
-
   s.cert_chain  = ['certs/szorfein.pem']
   s.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
 end

data/lib/getch.rb

@@ -1,5 +1,87 @@
+require_relative 'getch/options'
+require_relative 'getch/states'
+require_relative 'getch/mount'
+require_relative 'getch/gentoo'
+require_relative 'getch/filesystem'
+require_relative 'getch/command'
+require_relative 'getch/helpers'
+
 module Getch
+
+  DEFAULT_OPTIONS = {
+    language: 'en_US',
+    zoneinfo: 'US/Eastern',
+    keyboard: 'us',
+    disk: 'sda',
+    fs: 'ext4',
+    username: nil,
+    verbose: false
+  }
+
+  STATES = {
+    :partition => false,
+    :format => false,
+    :mount => false,
+    :gentoo_base => false,
+    :gentoo_config => false,
+    :gentoo_update => false,
+    :gentoo_kernel => false
+  }
+
+  MOUNTPOINT = "/mnt/gentoo".freeze
+  OPTIONS_FS = {
+    'ext4' => Getch::FileSystem::Ext4
+  }.freeze
+
+  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
+    print "Continue? (n,y) "
+    case gets.chomp
+    when /^y|^Y/
+      return
+    else
+      exit 1
+    end
+  end
+
+  def self.format(disk, fs, user)
+    return if STATES[:format] and STATES[:partition]
+    puts
+    print "Partition and format disk #{disk}, this will erase all data, continue? (n,y) "
+    case gets.chomp
+    when /^y|^Y/
+      filesystem = OPTIONS_FS[fs].new(disk)
+      filesystem.cleaning
+      filesystem.partition
+      filesystem.format
+      OPTIONS_FS[fs]::Mount.new(disk, user).run
+    else
+      exit 1
+    end
+  end
+
+  def self.init_gentoo(options)
+    gentoo = Getch::Gentoo
+    gentoo.stage3
+    gentoo.config(options)
+    gentoo.chroot
+    gentoo.kernel
+    gentoo.boot(options)
+  end
+
   def self.main(argv)
-    puts "Starting..."
+    options = Options.new(argv)
+    DEFAULT_OPTIONS.freeze
+    resume_options(options)
+    Getch::States.new() # Update States
+    format(options.disk, options.fs, options.username)
+    init_gentoo(options)
   end
 end

data/lib/getch/command.rb

@@ -0,0 +1,55 @@
+require 'open3'
+
+module Getch
+  class Command
+    def initialize(cmd)
+      @cmd = cmd
+      @block_size = 512
+    end
+
+    def run!
+      puts "Running command: " + @cmd.gsub(/\"/, '')
+
+      Open3.popen3(@cmd) do |stdin, stdout, stderr|
+        stdin.close_write
+
+        begin
+          files = [stdout, stderr]
+
+          until all_eof(files) do
+            ready = IO.select(files)
+
+            if ready
+              readable = ready[0]
+              # 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
+            end
+          end
+        rescue IOError => e
+          puts "IOError: #{e}"
+        end
+      end
+      puts "Done"
+    end
+
+    private
+
+    # Returns true if all files are EOF
+    def all_eof(files)
+      files.find { |f| !f.eof }.nil?
+    end
+  end
+end

data/lib/getch/filesystem.rb

@@ -0,0 +1,7 @@
+module Getch
+  module FileSystem
+  end
+end
+
+require_relative 'filesystem/root'
+require_relative 'filesystem/ext4'

data/lib/getch/filesystem/ext4.rb

@@ -0,0 +1,75 @@
+module Getch
+  module FileSystem
+    class Ext4 < Getch::FileSystem::Root
+      def initialize(disk)
+        @disk = disk
+        @fs = 'ext4'
+        super
+      end
+
+      class Mount < Getch::Mount
+        def initialize(disk, user)
+          @disk = disk
+          @user = user
+          super
+        end
+
+        private
+
+        def gen_vars
+          @dev_boot_efi = Helpers::efi? ? "/dev/#{@disk}1" : nil
+          @dev_swap = "/dev/#{@disk}2"
+          @dev_root = "/dev/#{@disk}3"
+          @dev_home = @user ? "/dev/#{@disk}4" : nil
+        end
+
+        def data_fstab
+          boot_efi = @dev_boot_efi ? "UUID=#{@uuid_boot_efi} /boot/efi vfat noauto,defaults  0 2" : ''
+          swap = @dev_swap ? "UUID=#{@uuid_swap} none swap discard 0 0" : ''
+          root = @dev_root ? "UUID=#{@uuid_root} / ext4 defaults 0 1" : ''
+          home = @dev_home ? "UUID=#{@uuid_home} /home/#{@user} ext4 defaults 0 2" : ''
+
+          return [ boot_efi, swap, root, home ]
+        end
+      end
+
+      private
+
+      # Follow https://wiki.archlinux.org/index.php/Partitioning
+      def partition_efi
+        # /boot/efi - EFI system partition - 260MB
+        # swap      - Linux Swap - size of the ram
+        # /         - Root
+        # /home     - Home
+        system("sgdisk -n1:1M:+260M -t1:EF00 /dev/#{@disk}") # boot EFI
+        system("sgdisk -n2:0:+2G -t2:8200 /dev/#{@disk}") # swap
+        system("sgdisk -n3:0:+15G -t3:8304 /dev/#{@disk}") # root
+        system("sgdisk -n4:0:0 -t3:8302 /dev/#{@disk}") # home
+      end
+
+      def format_efi
+        system("mkfs.fat -F32 /dev/#{@disk}1")
+        system("mkswap /dev/#{@disk}2")
+        system("mkfs.#{@fs} /dev/#{@disk}3")
+        system("mkfs.#{@fs} /dev/#{@disk}4")
+      end
+
+      def partition_bios
+        # None      - Bios Boot Partition - 1MiB
+        # swap      - Linux Swap - size of the ram
+        # /         - Root
+        # /home     - Home
+        system("sgdisk -n1:1MiB:+1MiB -t1:EF02 /dev/#{@disk}")
+        system("sgdisk -n2:0:+2G -t2:8200 /dev/#{@disk}")
+        system("sgdisk -n3:0:+15G -t3:8304 /dev/#{@disk}")
+        system("sgdisk -n4:0:0 -t3:8302 /dev/#{@disk}")
+      end
+
+      def format_bios
+        system("mkswap /dev/#{@disk}2")
+        system("mkfs.#{@fs} /dev/#{@disk}3")
+        system("mkfs.#{@fs} /dev/#{@disk}4")
+      end
+    end
+  end
+end