pennyworth-tool 0.0.1

data/lib/pennyworth/local_runner.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2013-2014 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+
+module Pennyworth
+  class LocalRunner < Runner
+    def initialize(opts = {})
+      @command_runner = LocalCommandRunner.new(opts)
+    end
+
+    def start
+      # Nothing to do here
+
+      "127.0.0.1"
+    end
+
+    def stop
+      # Nothing to do here either
+    end
+  end
+end

data/lib/pennyworth/lock_service.rb

@@ -0,0 +1,87 @@
+# Copyright (c) 2015 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+
+module Pennyworth
+  class LockService
+    attr_reader :lock_server_host
+    attr_reader :lock_server_port
+
+    def initialize(lock_server_address)
+      fields = lock_server_address.split(":")
+      @lock_server_host = fields[0]
+      @lock_server_port = fields[1]
+      @sockets = {}
+    end
+
+    def socket(lock_name)
+      if !@sockets.has_key?(lock_name)
+        @sockets[lock_name] = TCPSocket.new(@lock_server_host, @lock_server_port)
+      end
+      @sockets[lock_name]
+    end
+
+    def request_lock(lock_name)
+      socket(lock_name).puts("g #{lock_name}")
+      response = socket(lock_name).gets
+      if response =~ /^1/
+        return true
+      elsif response =~ /^0/
+        return false
+      else
+        raise LockError.new("Error, received: #{response}")
+      end
+    end
+
+    def keep_lock
+      # Sleep forever to keep process running to keep TCP connection to lock
+      # server open. When the process is ended the connection is closed and the
+      # lock is released. Users can end the process and release the lock with
+      # Ctrl-C.
+      sleep
+    end
+
+    def release_lock(lock_name)
+      if !@sockets[lock_name]
+        raise LockError.new("Lock '#{lock_name}' doesn't exist")
+      end
+      @sockets[lock_name].close
+      @sockets.delete(lock_name)
+    end
+
+    def locked?(lock_name)
+      socket(lock_name).puts("i #{lock_name}")
+      response = socket(lock_name).gets
+      if response =~ /^1/
+        return true
+      else
+        return false
+      end
+    end
+
+    def info(lock_name)
+      if locked?(lock_name)
+        socket(lock_name).puts("d #{lock_name}")
+        response = socket(lock_name).gets
+        response =~ /^#{lock_name}: (.*):/
+        client = $1
+        return "'#{lock_name}' is locked by #{client}"
+      else
+        return "'#{lock_name}' is not locked"
+      end
+    end
+  end
+end

data/lib/pennyworth/remote_command_runner.rb

@@ -0,0 +1,144 @@
+# Copyright (c) 2013-2014 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+
+# The purpose of this class is to execute commands on a remote machine via SSH.
+module Pennyworth
+  class RemoteCommandRunner
+    def initialize(ip, username)
+      @ip = ip
+      @username = username
+    end
+
+    def run(*args)
+      # When ssh executes commands, it passes them through shell expansion.
+      # For example, compare
+      #
+      #   $ echo '$HOME'
+      #   $HOME
+      #
+      # with
+      #
+      #   $ ssh localhost echo '$HOME'
+      #   /home/dmajda
+      #
+      # To mitigate that and maintain usual Cheetah semantics, we need to
+      # protect the command and its arguments using another layer of escaping.
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      args.map! { |a| Shellwords.escape(a) } if !options[:skip_escape]
+
+      if user = options.delete(:as)
+        args = ["su", "-l", user, "-c"] + args
+      end
+
+      Cheetah.run(
+        "ssh",
+        "-o",
+        "UserKnownHostsFile=/dev/null",
+        "-o",
+        "StrictHostKeyChecking=no",
+        "#{@username}@#{@ip}",
+        "LC_ALL=C",
+        *args,
+        options
+      )
+    rescue Cheetah::ExecutionFailed => e
+      raise ExecutionFailed.new(e)
+    end
+
+    # Copy a local file to the remote system.
+    #
+    # +source+:: Path to the local file
+    # +destination+:: Path to the remote file or directory. If +destination+ is a
+    #                 path, the same filename as +source+ will be used.
+    # +opts+:: Options to modify the attributes of the remote file.
+    #
+    #          Available options:
+    #          [owner]:: Owner of the file, e.g. "tux"
+    #          [group]:: Group of the file, e.g. "users"
+    #          [mode]:: Mode of the file, e.g. "600"
+    def inject_file(source, destination, opts = {})
+      # Append filename (taken from +source+) to destination if it is a path, so
+      # that +destination+ is always the full target path including the filename.
+      destination += File.basename(source) if destination.end_with?("/")
+
+      Cheetah.run(
+        "scp",
+        "-o",
+        "UserKnownHostsFile=/dev/null",
+        "-o",
+        "StrictHostKeyChecking=no",
+        source,
+        "#{@username}@#{@ip}:#{destination}"
+      )
+
+      if opts[:owner] || opts[:group]
+        owner_group = opts[:owner] || ""
+        owner_group += ":#{opts[:group]}" if opts[:group]
+        run "chown", "-R", owner_group, destination
+      end
+
+      if opts[:mode]
+        run "chmod", opts[:mode], destination
+      end
+    rescue Cheetah::ExecutionFailed => e
+      raise ExecutionFailed.new(e)
+    end
+
+    def extract_file(source, destination)
+      Cheetah.run(
+        "scp",
+        "-o",
+        "UserKnownHostsFile=/dev/null",
+        "-o",
+        "StrictHostKeyChecking=no",
+        "#{@username}@#{@ip}:#{source}",
+        destination
+      )
+    rescue Cheetah::ExecutionFailed => e
+      raise ExecutionFailed.new(e)
+    end
+
+    def inject_directory(source, destination, opts = {})
+      if opts[:owner] || opts[:group]
+        owner_group = opts[:owner] || ""
+        owner_group += ":#{opts[:group]}" if opts[:group]
+      end
+
+      chown_cmd = " && chown #{owner_group} '#{destination}'" if owner_group
+      mkdir_cmd = "test -d '#{destination}' || (mkdir -p '#{destination}' #{chown_cmd} )"
+
+      run mkdir_cmd, skip_escape: true
+
+      Cheetah.run(
+        "scp",
+        "-r",
+        "-o",
+        "UserKnownHostsFile=/dev/null",
+        "-o",
+        "StrictHostKeyChecking=no",
+        source,
+        "#{@username}@#{@ip}:#{destination}"
+      )
+
+      if owner_group
+        run "chown", "-R", owner_group, File.join(destination, File.basename(source))
+      end
+    rescue Cheetah::ExecutionFailed => e
+      raise ExecutionFailed.new(e)
+    end
+  end
+end

data/lib/pennyworth/runner.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2013-2014 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+
+module Pennyworth
+  # Base class for the runner classes
+  class Runner
+    attr_reader :command_runner
+
+    def cleanup_directory(dir)
+      command_runner.run("test -d #{dir} && rm -r #{dir}")
+    end
+  end
+end

data/lib/pennyworth/settings.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2013-2014 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+
+module Pennyworth
+  class Settings
+
+    attr_accessor :verbose, :silent, :definitions_dir
+
+    def initialize
+      @verbose = false
+      @silent = false
+      @definitions_dir = File.expand_path("~/.pennyworth")
+    end
+
+    def kiwi_dir
+      File.join(@definitions_dir, "/kiwi")
+    end
+
+    def vagrant_dir
+      File.join(@definitions_dir, "/vagrant")
+    end
+
+    def version
+      Pennyworth::VERSION
+    end
+
+  end
+end

data/lib/pennyworth/spec.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2013-2014 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+
+require "cheetah"
+require "libvirt"
+require "socket"
+require "open-uri"
+require "yaml"
+
+require_relative "exceptions"
+require_relative "helper"
+require_relative "libvirt"
+require_relative "runner"
+require_relative "vagrant"
+require_relative "vagrant_runner"
+require_relative "image_runner"
+require_relative "host_config"
+require_relative "host_runner"
+require_relative "lock_service"
+require_relative "ssh_keys_importer"
+require_relative "vm"
+require_relative "spec_profiler"
+require_relative "remote_command_runner"
+require_relative "settings"
+require_relative "local_runner"
+require_relative "local_command_runner"
+
+module Pennyworth
+  module SpecHelper
+    def start_system(opts)
+      opts = {
+        skip_ssh_setup: false
+      }.merge(opts)
+      username = opts[:username] || "root"
+      if opts[:box]
+        runner = VagrantRunner.new(opts[:box], RSpec.configuration.vagrant_dir, username)
+        password = opts[:password] || "vagrant"
+      elsif opts[:image]
+        runner = ImageRunner.new(opts[:image], username)
+        password = opts[:password] || "linux"
+      elsif opts[:host]
+        config = HostConfig.new(RSpec.configuration.hosts_file)
+        config.read
+        runner = HostRunner.new(opts[:host], config, username)
+      elsif opts[:local]
+        runner = LocalRunner.new(env: opts[:env])
+      end
+
+      raise "No image specified." unless runner
+
+      system = VM.new(runner)
+
+      # Make sure to stop the machine again when the example group is done
+      self.class.after(:all) do
+        system.stop
+      end
+
+      measure("Boot machine '#{opts[:box] || opts[:image] || opts[:host]}'") do
+        system.start
+      end
+      if !opts[:skip_ssh_setup] && !opts[:host] && !opts[:local]
+        SshKeysImporter.import(system.ip, username, password)
+      end
+
+      system
+    end
+  end
+end
+
+RSpec.configure do |config|
+  defaults = Pennyworth::Settings.new
+  config.include(Pennyworth::SpecHelper)
+  config.add_setting :pennyworth_mode, default: false
+  config.add_setting :vagrant_dir, default: defaults.vagrant_dir
+  config.add_setting :hosts_file, default: File.join(defaults.definitions_dir, "/hosts.yaml")
+
+  config.before(:all) do
+    unless RSpec.configuration.pennyworth_mode
+      Pennyworth::Libvirt.ensure_libvirt_env_started
+    end
+  end
+end

data/lib/pennyworth/spec_profiler.rb

@@ -0,0 +1,85 @@
+# Copyright (c) 2013-2014 SUSE LLC
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 3 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE about this file by physical or electronic mail,
+# you may find current contact information at www.suse.com
+
+require "benchmark"
+
+def measure(label, &block)
+  own_parent = @parent_measurement
+  measurement = {
+      label: label,
+      child_measurements: []
+  }
+
+  @parent_measurement = measurement
+  time = Benchmark.measure do
+    block.call
+  end
+  @parent_measurement = own_parent
+  measurement.merge!(time: time.real)
+
+  # Calculate time that was not spent in the measured child blocks but somewhere
+  # else
+  if !measurement[:child_measurements].empty?
+    other_time = measurement[:time]
+    measurement[:child_measurements].each do |child|
+      other_time -= child[:time]
+    end
+    measurement[:child_measurements] << { label: "Other", time: other_time }
+  end
+
+  if own_parent
+    own_parent[:child_measurements] << measurement
+  else
+    @measurements << measurement
+  end
+end
+
+def print_measurement(measurement, indent = 0)
+  name = measurement[:label][0..65-indent].ljust(70-indent)
+  STDERR.puts (" " * indent) + "#{name}: #{measurement[:time]}"
+
+  if measurement[:child_measurements]
+    measurement[:child_measurements].each do |child|
+      print_measurement(child, indent + 2)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:all) do
+    @measurements = []
+  end
+
+  config.around(:each) do |example|
+    if RSpec.configuration.pennyworth_mode
+      example.run
+    else
+      measure(example.metadata[:full_description]) do
+        example.run
+      end
+    end
+  end
+
+  config.after(:all) do
+    if !RSpec.configuration.pennyworth_mode
+      @measurements.each do |measurement|
+        print_measurement(measurement)
+      end
+    end
+  end
+end
+