lxdev 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b44f874a451b8fcbf87c6015993879e1d587f703
+  data.tar.gz: 31fbead89ddd558dc00126c21d3705ba759a720d
+SHA512:
+  metadata.gz: dee6338ab4a878bcd51552da860f80db522ca855160ae774c9d75a85a0f4888947d1ec1af002f8e65b19d94c76d79ded6f60e99789db07a1edaa1ef04279a511
+  data.tar.gz: abe2b8ff716ae61d65dc9db7f43fac06886fa48b8129c96f015616b8217091234a2bb92b2343dada06f4d018d63236975eb99d43da381f0658d6e264a2e9363d

data/bin/lxdev

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+require 'lxdev'
+require 'optparse'
+
+def option_parser
+  opt_parser = OptionParser.new do |opts|
+    opts.banner = "Usage: lxdev [options] command"
+
+    opts.on("-h", "--help", "Prints this help") do
+      puts opts
+      exit
+    end
+
+    opts.on("-v", "--version", "Prints the version") do
+      puts "Version #{LxDev::VERSION}"
+      exit
+    end
+
+  end
+  opt_parser.separator ""
+  opt_parser.separator <<-EOS
+Commands:
+up          Bring container up
+status      Show status of the container
+ssh         Log into the container 
+halt        Stop the container
+destroy     Destroy the container 
+provision   Run provisioning commands from YAML file
+exec        Run command as root in container
+sudoers     Create a sudoers file, allowing you to use lxdev without entering the sudo password
+EOS
+  opt_parser.parse!()
+
+end
+
+
+def execute_main_command(lxdev)
+  if ARGV.empty?
+    puts "No arguments.\nRun \"lxdev --help\" for info"
+    exit 1
+  end
+
+  case ARGV.first
+  when 'up'
+    lxdev.up()
+  when 'status'
+    lxdev.status()
+  when 'ssh'
+    lxdev.ssh(ARGV[1..-1])
+  when 'halt'
+    lxdev.halt()
+  when 'destroy'
+    lxdev.destroy()
+  when 'provision'
+    lxdev.provision()
+  when 'exec'
+    command = ARGV[1..-1].join(" ")
+    if LxDev::SHELLS.include?(command)
+      lxdev.execute(command, interactive: true)
+    else
+      lxdev.execute(command)
+    end
+  when 'sudoers'
+    LxDev.create_sudoers_file()
+  else
+    puts "Unknown command.\nRun \"lxdev --help\" for info"
+  end
+end
+
+
+
+option_parser
+lxdev = LxDev.setup()
+if lxdev
+  execute_main_command(lxdev)
+  lxdev.save_state
+end

data/lib/lxdev.rb

@@ -0,0 +1,290 @@
+require 'yaml'
+require 'json'
+require 'terminal-table'
+
+class LxDev
+  WHITELISTED_SUDO_COMMANDS = ["lxc", "redir", "kill"]
+  SHELLS = ["bash", "zsh", "sh", "csh", "tcsh", "ash"]
+  BOOT_TIMEOUT = 30
+  VERSION = '0.1.0'
+
+  def initialize
+    @uid=%x{id -u}.chomp
+    @gid=%x{id -g}.chomp
+    @config = YAML.load_file('lxdev.yml')
+    @name = @config['box']['name']
+    @image = @config['box']['image']
+    @user = @config['box']['user']    
+    @ports = @config['box']['ports'] || {}
+    Dir.mkdir('.lxdev') unless File.directory?('.lxdev')
+    begin
+      @state = YAML.load_file('.lxdev/state')
+    rescue
+      @state = Hash.new
+    end
+  rescue Errno::ENOENT
+    puts "lxdev.yml not found"
+    exit 1 
+  end
+
+  def self.setup
+    unless lxd_initialized?
+      puts "Please run 'lxd init' and configure LXD first"
+      return false
+    end
+    return LxDev.new
+  end
+
+  def save_state
+    File.open('.lxdev/state', 'w') {|f| f.write @state.to_yaml } unless @state.empty?
+  end
+
+  def status
+    ensure_container_created
+
+    container_status = get_container_status
+    folders = container_status.first['devices'].map{|name, folders| [name,"#{folders['source']} => #{folders['path']}"] if folders['source']}.compact
+    table = Terminal::Table.new do |t|
+      t.add_row ['Name', container_status.first['name']]
+      t.add_row ['Status', container_status.first['status']]
+      t.add_row ['IP', get_container_ip]
+      t.add_row ['Image', @image]
+      t.add_separator
+      folders.each do |folder|
+        t.add_row folder
+      end
+      t.add_separator
+      @ports.each do |guest,host|
+        t.add_row ['Forwarded port', "guest: #{guest} host: #{host}"]
+      end
+    end
+    puts table
+  end
+
+  def up
+    do_provision = false
+    unless @state.empty?
+      puts "Container state .lxdev/state exists, is it running? If not it might have stopped unexpectedly. Please remove the file before starting."
+      exit 1
+    end
+    if get_container_status.empty?
+      create_container
+      do_provision = true
+    else
+      if get_container_status.first['status'] == 'Running'
+        puts "#{@name} is already running!"
+        exit 1
+      else
+        start_container
+      end
+    end
+    puts "Waiting for boot..."
+    wait_for_boot
+    @state['status'] = 'running'
+    puts "Forwarding ports..."
+    forward_ports(@ports)
+    provision if do_provision
+  end
+
+  def halt
+    ensure_container_created
+    %x{sudo lxc stop #{@name}}
+    cleanup_forwarded_ports
+    remove_state
+  end
+
+  def destroy
+    ensure_container_created
+    %x{sudo lxc delete #{@name}}
+  end
+
+  def ssh(args)
+    ensure_container_created
+    host = get_container_ip
+    if host.nil?
+      puts "#{@name} doesn't seem to be running."
+      exit 1
+    end
+    ssh_command = "ssh -o StrictHostKeyChecking=no -t #{@user}@#{get_container_ip} #{args.empty? ? 'bash --noprofile' : "'#{args.join(' ')}'"}"
+    exec ssh_command
+  end
+
+  def execute(command, interactive: false)
+    if interactive
+      exec("sudo lxc exec #{@name} #{command}") # execution stops here and gives control to exec
+    end
+    IO.popen("sudo lxc exec #{@name} -- /bin/sh -c '#{command}'", err: [:child, :out]) do |cmd_output|
+      cmd_output.each do |line|
+        puts line
+      end
+    end
+  end
+
+  def provision
+    ensure_container_created
+    if get_container_status.first['status'] != 'Running'
+      puts "#{@name} is not running!"
+      exit 1
+    end
+    provisioning = @config['box']['provisioning']
+    if provisioning.nil?
+      puts "Nothing to do"
+      return
+    end
+    puts "Provisioning #{@name}..."
+    STDOUT.sync = true
+    provisioning.each do |cmd|
+      execute cmd
+    end
+    STDOUT.sync = false
+  end
+
+  private
+  def self.lxd_initialized?
+    %x{sudo lxc info | grep 'lxd init'}
+    $?.exitstatus != 0
+  end
+
+  def ensure_container_created
+    container_status = get_container_status
+    unless container_status.size > 0
+      puts "Container not created yet. Run lxdev up"
+      exit(0)
+    end
+  end
+
+  def remove_state
+    File.delete('.lxdev/state') if File.exists?('.lxdev/state')
+    @state = {}
+  end
+
+  def create_container
+    add_subuid_and_subgid
+    puts "Launching #{@name}..."
+    %x{sudo lxc init #{@image} #{@name}}
+    %x{printf "uid #{@uid} 1001\ngid #{@gid} 1001"| sudo lxc config set #{@name} raw.idmap -}
+    %x{sudo lxc start #{@name}}
+    puts "Creating user #{@user}..."
+    create_container_user(@user)
+    puts "Mapping folders.."
+    map_folders(@config['box']['folders'])
+  end
+
+  def start_container
+    puts "Starting #{@name}..."
+    %x{sudo lxc start #{@name}}
+  end
+
+  def get_container_status
+    return @status unless @status.nil?
+    container_status = %x{sudo lxc list #{@name} --format=json}
+    @status = JSON.parse(container_status)
+  end
+
+  def get_container_ip
+    get_container_status.first['state']['network']['eth0']['addresses'].select{|addr| addr['family'] == 'inet'}.first['address']
+  rescue
+    nil
+  end
+
+  def add_subuid_and_subgid
+    need_restart = false
+    %x{sudo grep -q 'root:#{@uid}:1' /etc/subuid}
+    if $?.exitstatus != 0
+      %x{echo 'root:#{@uid}:1' | sudo tee -a /etc/subuid}
+      need_restart = true
+    end
+    %x{sudo grep -q 'root:#{@gid}:1' /etc/subgid}
+    if $?.exitstatus != 0
+      %x{echo 'root:#{@gid}:1' | sudo tee -a /etc/subgid}
+      need_restart = true
+    end
+    if need_restart
+      %x{sudo systemctl restart lxd.service}
+    end
+  end
+
+  def create_container_user(user)
+    %x{sudo lxc exec #{@name} -- groupadd --gid 1001 #{user}}
+    %x{sudo lxc exec #{@name} -- useradd --uid 1001 --gid 1001 -s /bin/bash -m #{user}}
+    %x{sudo lxc exec #{@name} -- mkdir /home/#{user}/.ssh}
+    %x{sudo lxc exec #{@name} -- chmod 0700 /home/#{user}/.ssh}
+    %x{ssh-add -L | sudo lxc exec #{@name} tee /home/#{user}/.ssh/authorized_keys}
+    %x{sudo lxc exec #{@name} -- chown -R #{user} /home/#{user}/.ssh}
+    %x{printf "#{user} ALL=(ALL) NOPASSWD: ALL\n" | sudo lxc exec #{@name} -- tee -a /etc/sudoers}
+    %x{sudo lxc exec #{@name} -- chmod 0440 /etc/sudoers}
+  end
+
+  def wait_for_boot
+    BOOT_TIMEOUT.times do |t|
+      @status = nil # reset status for each iteration to refresh IP
+      break if get_container_ip
+      abort_boot if t == (BOOT_TIMEOUT-1)
+      sleep 1
+    end
+  end
+
+  def forward_ports(ports)
+    redir_pids = []
+    ports.each do |guest, host|
+      puts "Forwarding #{get_container_ip}:#{guest} to local port #{host}"
+      pid = spawn %{sudo redir --caddr=#{get_container_ip} --cport=#{guest} --lport=#{host}}
+      redir_pids << pid
+      Process.detach(pid)
+    end
+    @state['redir_pids'] = redir_pids    
+  end
+
+  def cleanup_forwarded_ports
+    if @state.empty?
+      return
+    end
+    @state['redir_pids'].each do |pid|
+      %x{sudo kill #{pid}}
+    end
+  end
+
+  def map_folders(folders)
+    counter = 0
+    folders.each do |host, guest|
+      counter = counter + 1
+      puts "Mounting #{host} in #{guest}"
+      absolute_path = %x{readlink -f #{host}}.chomp
+      %x{sudo lxc config device add #{@name} shared_folder_#{counter} disk source=#{absolute_path} path=#{guest}}
+    end
+  end
+
+  def abort_boot
+    puts "Timeout waiting for container to boot"
+    exit 1
+  end
+
+  def self.create_sudoers_file
+    user=%x{whoami}.chomp
+    puts <<-EOS
+!! WARNING !!
+This will create a file, /etc/sudoers.d/lxdev,
+which will give your user #{user} access to running
+the following commands :
+ #{WHITELISTED_SUDO_COMMANDS.join(" ")}
+with superuser privileges. If you do not know what you're
+doing, this can be dangerous and insecure.
+
+If you want to do this, type 'yesplease'
+    EOS
+    action = STDIN.gets.chomp
+    unless action == 'yesplease'
+      puts "Not creating sudoers file"
+      return
+    end
+    content = []
+    content << "# Created by lxdev #{Time.now}"
+    WHITELISTED_SUDO_COMMANDS.each do |cmd|
+      cmd_with_path=%x{which #{cmd}}.chomp
+      content << "#{user} ALL=(root) NOPASSWD: #{cmd_with_path}"
+    end
+    %x{printf '#{content.join("\n")}\n' | sudo tee /etc/sudoers.d/lxdev}
+    %x{sudo chmod 0440 /etc/sudoers.d/lxdev}
+    puts "Created sudoers file."
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: lxdev
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Lønaas
+- Eivind Mork
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Lightweight vagrant-like system using LXD
+email: christian.lonaas@gyldendal.no
+executables:
+- lxdev
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/lxdev
+- lib/lxdev.rb
+homepage: https://github.com/GyldendalDigital/lxdev
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Automagic development environment with LXD
+test_files: []