pennyworth-tool 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a540a31b068d26b1deebf691d65d60f94dcc343a
-  data.tar.gz: da36dd75b9c759acec70e477bafce396ebe5982a
+  metadata.gz: 381073546ae4950af4b0083f6a455038cf180ad9
+  data.tar.gz: 0ea747bfde18986eb72f3563bca2e8e738a3b546
 SHA512:
-  metadata.gz: 44914ae8d8bc9d39451349fa82df0f59e64bc59bef3ad3a3ff384707423362ff5923fdaed46c8720d25abd45baa33cce5396b2c7ab72794528a1cc81906b85c2
-  data.tar.gz: 95a678007e0dd64a1957faeb4a62aea969569ed31810255ae6d3120101d376007d02f0912b70476767b550db0663c9a44c8a88c6f515e1cce419621fa057d754
+  metadata.gz: eedf5019ded3f9c369e1529b42fd7bd972d602b6a7ed66ccda0543b1c12d8fe22c23b482424b1982a378e87896734309e2d071a99d1dbf604ccf4c39f7888342
+  data.tar.gz: cd0d7f4427b75622b4a7393bb3698be386e09d66f1ecd6cf869880556a6ecb672f2b6e3c148f94effa5b0a59a081b6651c9968ea7aeeb37c142a98c176a2881f

data/README.md

@@ -300,10 +300,38 @@ with the running machine (via SSH). It supports the following methods:
   * `run_command(command, *args, options = {})`
     `run_command(command_and_args, options = {})`
 
-    Executes a command on the running machine. The execution is implemented
-    using [Cheetah](https://github.com/opensuse/cheetah) and the `run_command`
-    method behaves mostly the same as
-    [`Cheetah.run`](http://rubydoc.info/github/openSUSE/cheetah/master/Cheetah.run).
+    Executes a command on the running machine. A VM::CommandResult instance is
+    returned which can be used with special RSpec matchers to define the
+    expected behavior. Examples:
+
+      # Expect exit code 0 and no stderr
+      expect(result).to succeed
+
+      # Expect exit code 0, ignoring any stderr
+      expect(@vm.run_command("ls -l")).to succeed.with_or_without_stderr
+
+      # Expect a certain stdout
+      expect(result).to succeed.and have_stdout(/foo.*bar/)
+      expect(result).to succeed.and have_stdout("foo bar")
+
+      # Expect exit code 0, but some stderr output
+      expect(result).to succeed.with_stderr
+
+      # Expect the stdout to include a certain string
+      expect(result).to include_stdout("foo bar")
+
+      # Expect exit code != 0
+      expect(result).to fail
+
+      # Expect a specific exit code
+      expect(result).to fail.with_exit_code(15)
+
+      # Expect specific stderr
+      expect(result).to have_stderr(/This.*error/)
+      expect(result).to have_stderr("This is an error")
+
+      # Expect stderr to include a certain string
+      expect(result).to include_stderr("Warning"
 
   * `inject_file(source, destination)`
 
@@ -333,6 +361,12 @@ VM
 : Virtual machine ran in KVM. Pennyworth supports running VMs described in a
 Vagrantfile as well as non vagrant managed ones.
 
+## Release Cycle
+
+As for now we don't have a time based release cycle. We update and publish the
+gem as needed. However don't hesitate to report bugs or better yet submit fixes
+as pull requests. We will make sure to update the gem with the latest code.
+
 ## Further information
 
 Further information like a [FAQ](https://github.com/SUSE/pennyworth/wiki/Debugging)

data/examples/README.md

@@ -6,7 +6,7 @@ It provides a very basic openSUSE 13.1 machine.
 
 ## Base Image
 
-The base image is defined in `examples/kiwi/definitions/base_opensuse13.1_kvm`.
+The base image is defined in `examples/boxes/definitions/base_opensuse13.1_kvm`.
 It can be build with:
 
 `$ bin/pennyworth -d examples/ build-base`

data/lib/pennyworth/cli.rb

@@ -26,8 +26,8 @@ module Pennyworth
       provide a well-defined test environment for automated tests.
 
       Use the global `--definitions-dir` option to specify the path to the
-      directory containing Kiwi and Vagrant definitions. The directory needs to
-      contain `kiwi/` and `vagrant/` subdirectories. Default is `~/.pennyworth`.
+      directory containing Kiwi, Veewee and Vagrant definitions. The directory needs to
+      contain `boxes/` and `vagrant/` subdirectories. Default is `~/.pennyworth`.
 
       Pennyworth writes a log file to `/tmp/pennyworth.log`.
 
@@ -141,13 +141,13 @@ module Pennyworth
     LONGDESC
     arg_name "IMAGE_NAME", :optional
     command "build-base" do |c|
-      c.flag [:kiwi_tmp_dir, :k], :type => String, :required => false,
-        :desc => "Temporary KIWI directory for building the Vagrant box.",
-        :arg_name => "KIWI-TMP-Dir"
+      c.flag [:temp_dir, :t], :type => String, :required => false,
+        :desc => "Temporary directory for building the Vagrant box.",
+        :arg_name => "TMP-Dir"
       c.action do |global_options,options,args|
         image_name = args.shift
-        tmp_dir = options[:kiwi_tmp_dir] || "/tmp/pennyworth-kiwi-builds"
-        BuildBaseCommand.new(Cli.settings.kiwi_dir).execute(tmp_dir, image_name)
+        tmp_dir = options[:temp_dir] || "/tmp/pennyworth-builds"
+        BuildBaseCommand.new(Cli.settings.boxes_dir).execute(tmp_dir, image_name)
       end
     end
 
@@ -165,7 +165,7 @@ module Pennyworth
         image_name = args.shift
         VagrantCommand.setup_environment(@@settings.vagrant_dir)
         if options[:url]
-          kiwi_dir = File.expand_path("~/.pennyworth/kiwi")
+          boxes_dir = File.expand_path("~/.pennyworth/boxes")
           remote_url = options[:url]
           opts = {
             local: false,
@@ -175,12 +175,12 @@ module Pennyworth
             STDERR.puts "You need to specify a definitions directory when not using --url."
             exit 1
           end
-          kiwi_dir = Cli.settings.kiwi_dir
+          boxes_dir = Cli.settings.boxes_dir
           opts = {
             local: true
           }
         end
-        ImportBaseCommand.new(kiwi_dir, remote_url).execute(image_name, opts)
+        ImportBaseCommand.new(boxes_dir, remote_url).execute(image_name, opts)
       end
     end
 
@@ -238,7 +238,7 @@ module Pennyworth
     command :list do |c|
       c.action do |global_options,options,args|
         VagrantCommand.setup_environment(@@settings.vagrant_dir)
-        ListCommand.new(Cli.settings.kiwi_dir).execute
+        ListCommand.new(Cli.settings.boxes_dir).execute
       end
     end
 

data/lib/pennyworth/commands/base_command.rb

@@ -18,11 +18,11 @@
 module Pennyworth
   class BaseCommand < Command
 
-    attr_reader :kiwi_dir
+    attr_reader :boxes_dir
 
-    def initialize(kiwi_dir, remote_url = nil)
+    def initialize(boxes_dir, remote_url = nil)
       super()
-      @kiwi_dir = kiwi_dir
+      @boxes_dir = boxes_dir
       @remote_url = remote_url
     end
 
@@ -41,7 +41,7 @@ module Pennyworth
     end
 
     def local_base_images
-      Dir.glob(File.join(@kiwi_dir, "definitions", "*")).
+      Dir.glob(File.join(@boxes_dir, "definitions", "*")).
         select { |f| File.directory?(f) }.
         map { |d| File.basename(d) }
     end
@@ -59,7 +59,7 @@ module Pennyworth
 
     def read_box_sources_state(box_name)
       sources = Hash.new
-      source_dir = File.join(@kiwi_dir, "definitions", box_name)
+      source_dir = File.join(@boxes_dir, "definitions", box_name)
       Find.find(source_dir) do |file|
         next if File.directory?(file)
         relative_path = file.gsub(/^#{File.join(source_dir, "/")}/, "")
@@ -69,7 +69,7 @@ module Pennyworth
     end
 
     def read_box_target_state(box_name)
-      box_file = File.join(@kiwi_dir, box_name) + ".box"
+      box_file = File.join(@boxes_dir, box_name) + ".box"
       if File.exist?(box_file)
         target_state = Digest::MD5.file(box_file).hexdigest
       end
@@ -77,13 +77,13 @@ module Pennyworth
     end
 
     def write_box_state_file(box_state)
-      File.open(File.join(@kiwi_dir, "box_state.yaml"), "w") do |f|
+      File.open(File.join(@boxes_dir, "box_state.yaml"), "w") do |f|
         f.write(box_state.to_yaml)
       end
     end
 
     def read_local_box_state_file
-      box_state_file = File.join(@kiwi_dir, "box_state.yaml")
+      box_state_file = File.join(@boxes_dir, "box_state.yaml")
       if File.exist? box_state_file
         box_state = YAML.load_file(box_state_file)
       else

data/lib/pennyworth/commands/build_base_command.rb

@@ -18,7 +18,7 @@
 module Pennyworth
   class BuildBaseCommand < BaseCommand
 
-    def initialize(kiwi_dir)
+    def initialize(boxes_dir)
       super
     end
 
@@ -29,7 +29,7 @@ module Pennyworth
       images = process_base_image_parameter(local_base_images, image_name)
       log "Creating base images..."
       images.each do |image|
-        Dir.chdir kiwi_dir do
+        Dir.chdir(boxes_dir) do
           log
           log "--- #{image} ---"
           source_state = read_box_sources_state(image)
@@ -38,10 +38,7 @@ module Pennyworth
             log "  Sources not changed, skipping build"
           else
             log "  Building base image..."
-            base_image_create(File.join(kiwi_dir, "definitions", image), tmp_dir)
-            log "  Exporting image as box for vagrant..."
-            base_image_export(File.join(kiwi_dir, image), tmp_dir)
-            base_image_cleanup_build(tmp_dir)
+            base_image_create(image, tmp_dir)
 
             box_state[image] = {
               "sources" => source_state,
@@ -55,9 +52,31 @@ module Pennyworth
 
     private
 
-    # Creates a KVM image from the according Kiwi description.
-    # See pennyworth/kiwi/definitions for the definitions we use.
-    def base_image_create(description_dir, tmp_dir)
+    # Creates a KVM image from the according Kiwi or Veewe description.
+    def base_image_create(image, tmp_dir)
+      description_dir = File.join(boxes_dir, "definitions", image)
+
+      if File.exists?(File.join(description_dir, "config.xml"))
+        build_kiwi(image, tmp_dir)
+      elsif File.exists?(File.join(description_dir, "definition.rb"))
+        build_veewee(image)
+      else
+        raise BuildFailed, "Unknown definition format in '#{description_dir}'. " \
+          "Supported are Kiwi and Veewee definitions"
+      end
+    end
+
+    def build_veewee(image)
+      Cheetah.run "veewee", "kvm", "build", image, "--force", "--auto"
+      Cheetah.run "veewee", "kvm", "halt", image
+      log "  Exporting image as box for vagrant..."
+      Cheetah.run "veewee", "kvm", "export", image, "--force"
+    rescue Cheetah::ExecutionFailed => e
+      raise ExecutionFailed.new(e)
+    end
+
+    def build_kiwi(image, tmp_dir)
+      description_dir = File.join(boxes_dir, "definitions", image)
       FileUtils.mkdir_p(tmp_dir)
       logfile = "#{tmp_dir}/kiwi-terminal-output.log"
       log "    The build log is available under #{logfile}"
@@ -65,17 +84,20 @@ module Pennyworth
         Cheetah.run "sudo", "/usr/sbin/kiwi", "--build", description_dir,
           "--destdir", tmp_dir, "--logfile", "#{logfile}",
           :stdout => :capture
-        rescue Cheetah::ExecutionFailed => e
-          raise ExecutionFailed.new(e)
-        end
+      rescue Cheetah::ExecutionFailed => e
+        raise ExecutionFailed.new(e)
+      end
+      log "  Exporting image as box for vagrant..."
+      base_image_export(image, tmp_dir)
+      base_image_cleanup_build(tmp_dir)
     end
 
-    def base_image_export(kiwi_dir, tmp_dir)
+    def base_image_export(name, tmp_dir)
       Dir.chdir(tmp_dir) do
         image = Dir.glob("*.box").first
         if image
           from_file = File.join(tmp_dir, image)
-          to_file = kiwi_dir.gsub(/\/$/, "") + ".box"
+          to_file = File.join(boxes_dir, name).gsub(/\/$/, "") + ".box"
           begin
             Cheetah.run "sudo", "mv", from_file, to_file, :stdout => :capture
           rescue Cheetah::ExecutionFailed => e

data/lib/pennyworth/commands/import_base_command.rb

@@ -58,7 +58,7 @@ module Pennyworth
     end
 
     def read_import_state_file
-      import_state_file = File.join(kiwi_dir, "import_state.yaml")
+      import_state_file = File.join(boxes_dir, "import_state.yaml")
       if File.exist? import_state_file
         import_state = YAML.load_file(import_state_file)
       else
@@ -68,9 +68,9 @@ module Pennyworth
     end
 
     def write_import_state_file(import_state)
-      FileUtils.mkdir_p(kiwi_dir) unless Dir.exists?(kiwi_dir)
+      FileUtils.mkdir_p(boxes_dir) unless Dir.exists?(boxes_dir)
 
-      File.open(File.join(kiwi_dir, "import_state.yaml"), "w") do |f|
+      File.open(File.join(boxes_dir, "import_state.yaml"), "w") do |f|
         f.write(import_state.to_yaml)
       end
     end
@@ -102,7 +102,7 @@ module Pennyworth
     # environments.
     def base_image_import(box, options)
       if options[:local]
-        box_path = File.join(kiwi_dir, box + ".box")
+        box_path = File.join(boxes_dir, box + ".box")
       else
         box_path = URLs.join(@remote_url, options[:subdir], box + ".box")
       end

data/lib/pennyworth/commands/list_command.rb

@@ -18,7 +18,7 @@
 module Pennyworth
   class ListCommand < BaseCommand
     def execute
-      if @kiwi_dir
+      if @boxes_dir
         puts "Vagrant box definitions managed by pennyworth:"
         local_base_images.each do |b|
           puts "  #{b}"

data/lib/pennyworth/commands/setup_command.rb

@@ -36,6 +36,9 @@ module Pennyworth
       allow_libvirt_access
       allow_qemu_kvm_access
       allow_arp_access
+
+      # Enable required services
+      enable_services
     end
 
     def show_warning_for_unsupported_platforms
@@ -45,7 +48,7 @@ module Pennyworth
 
       if os_release
         version = os_release[/^VERSION_ID="(.*)"/, 1]
-        distribution = os_release[/^NAME="(.*)"/, 1]
+        distribution = os_release[/^NAME=(.*)/, 1]
       end
 
       if !os_release || !supported_os.include?("#{distribution} #{version}")
@@ -59,6 +62,32 @@ module Pennyworth
       File.read(os_release_file) if File.exist?(os_release_file)
     end
 
+    def vagrant_installed?
+      begin
+        vagrant = Cheetah.run "rpm", "-q", "vagrant", stdout: :capture
+      rescue
+        return false
+      end
+
+      @vagrant_version = vagrant.lines.select { |plugin| plugin.start_with?("vagrant") }
+
+      !vagrant.match(/vagrant-[1-]\.[7-]\.[2-]/).nil?
+    end
+
+    def vagrant_libvirt_installed?
+      begin
+        vagrant_libvirt = Cheetah.run "vagrant", "plugin", "list", stdout: :capture
+      rescue
+        return false
+      end
+
+      @vagrant_libvirt_version = vagrant_libvirt.lines.select { |plugin|
+        plugin.start_with?("vagrant-libvirt")
+      }
+
+      !vagrant_libvirt.match(/vagrant-libvirt \(\d\.\d\.29|[3-9]\d\)/).nil?
+    end
+
     private
 
     def zypper_install(package)
@@ -75,22 +104,19 @@ module Pennyworth
 
     def install_packages
       log "Installing packages:"
-
       packages = config["packages"]["local"]
 
       if config["packages"][base_system]
         packages += config["packages"][base_system]
       end
 
+      config["packages"]["remote"].reject! { |url| url.match(/vagrant_/) && vagrant_installed? }
+      packages += config["packages"]["remote"]
+
       packages.each do |name|
         log "  * Installing #{name}..."
         zypper_install(name)
       end
-
-      config["packages"]["remote"].each do |url|
-        log "  * Downloading and installing #{url}..."
-        zypper_install(url)
-      end
     end
 
     # The kvm package does come with a udev rule file to adjust ownership of
@@ -104,9 +130,10 @@ module Pennyworth
     end
 
     def install_vagrant_plugin
-      log "Installing libvirt plugin for Vagrant..."
-
-      Cheetah.run "vagrant", "plugin", "install", "vagrant-libvirt"
+      if !vagrant_libvirt_installed?
+        log "Installing libvirt plugin for Vagrant..."
+        Cheetah.run "vagrant", "plugin", "install", "vagrant-libvirt"
+      end
     end
 
     def add_user_to_groups
@@ -202,6 +229,12 @@ module Pennyworth
       Cheetah.run "sudo", "chmod", permissions, file
     end
 
+    def enable_services
+      ["libvirtd", "dnsmasq"].each do |service|
+        Cheetah.run "sudo", "systemctl", "enable", service
+      end
+    end
+
     def base_system
       Cheetah.run(["lsb_release", "--release"], :stdout => :capture).split[1]
     end

data/lib/pennyworth/exceptions.rb

@@ -24,16 +24,4 @@ module Pennyworth
   class InvalidHostError < StandardError; end
   class HostFileError < StandardError; end
   class LockError < StandardError; end
-
-  class ExecutionFailed < StandardError
-    def initialize(e)
-      @message = e.message
-      @message += "\nStandard output:\n #{e.stdout}\n"
-      @message += "\nError output:\n #{e.stderr}\n"
-    end
-
-    def to_s
-      @message
-    end
-  end
 end