pennyworth-tool 0.0.1

data/man/.gitignore

@@ -0,0 +1,2 @@
+*.1
+*.html

data/man/pennyworth.1.md

@@ -0,0 +1,28 @@
+# Pennyworth -- Tool for controlling a network of machines for integration tests
+
+## SYNOPSIS
+
+`pennyworth` [options]
+
+`pennyworth` help [command]
+
+
+## DESCRIPTION
+
+**Pennyworth** is a tool for controlling a network of machines for
+integration testing. It helps to control virtual and real machines to provide a
+well-defined test environment for automated tests.
+
+Use the `help` command to get documentation about the individual commands.
+Find more documentation at https://github.com/SUSE/pennyworth.
+
+
+## BUGS
+
+If you find bugs please report them at
+https://github.com/SUSE/pennyworth/issues/new.
+
+
+## COPYRIGHT
+
+Pennyworth is Copyright (c) 2013-2015 SUSE LLC

data/pennyworth.gemspec

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+
+# 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 File.expand_path("../lib/pennyworth/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "pennyworth-tool"
+  s.version     = Pennyworth::VERSION
+  s.license     = 'GPL-3.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['SUSE']
+  s.email       = ['machinery@lists.suse.com']
+  s.homepage    = "https://github.com/SUSE/pennyworth"
+  s.summary     = "A tool for running integration tests inside a network of virtual machines"
+  s.description = <<-EOT.split("\n").map(&:strip).join(" ")
+    Pennyworth is a tool for running integration tests inside a network of
+    virtual machines. It allows to define virtual machines, build them as
+    Vagrant boxes and run them using libvirt and kvm in coordinated fashion in
+    order to run the tests. These tests can be written in any
+    language/framework, but the preferred combination is Ruby/RSpec, for which
+    helpers are provided.
+  EOT
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "pennyworth"
+
+  s.add_dependency "gli", "~> 2.11.0"
+  s.add_dependency "cheetah"
+  s.add_dependency "colorize"
+  s.add_dependency "nokogiri"
+  s.add_dependency "ruby-libvirt", "~> 0.4.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+
+  s.files += Dir['man/*.?']            # UNIX man pages
+  s.files += Dir['man/*.{html,css,js}']  # HTML man pages
+  s.add_development_dependency 'ronn', '>=0.7.3'
+  s.add_development_dependency 'rake'
+end

data/prophet/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "prophet"

data/prophet/prophet.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+# 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 'prophet'
+require 'logger'
+require 'yaml'
+
+Prophet.setup do |config|
+
+  # Setup custom logger.
+  config.logger = log = Logger.new(STDOUT)
+  log.level = Logger::INFO
+
+  CONFIG_FILE = "config/options-local.yml"
+  if File.exists?(CONFIG_FILE)
+    options = YAML.load_file(CONFIG_FILE)
+    # The GitHub (GH) username/password to use for commenting on a successful run.
+    config.username = options["default"]["git_username"]
+    config.password = options["default"]["git_password"]
+  end
+
+  config.status_context = "prophet/unit"
+  config.disable_comments = true
+
+  # Add Jenkins URL if available.
+  jenkins_url = `echo $BUILD_URL`.chomp
+  unless jenkins_url.empty?
+    config.status_target_url = "#{jenkins_url}console"
+  end
+
+  # Specify when to run your code.
+  # By default your code will run every time either the pull request or its
+  # target (i.e. master) changes.
+  config.rerun_on_source_change = true
+  config.rerun_on_target_change = true
+
+  # Add custom messages for comments and statuses.
+  config.status_pending = 'Tests are still running.'
+  config.status_success = 'Tests are passing.'
+  config.status_failure = 'Tests are failing.'
+
+  # If you need to make some system calls before looping through the pull requests,
+  # you specify them here. This block will only be executed once and defaults to an
+  # empty block.
+  #config.preparation do
+  #  # Example: Setup jenkins.
+  #  `rake -f /usr/lib/ruby/gems/1.9.1/gems/ci_reporter-1.7.0/stub.rake`
+  #  `rake ci:setup:testunit`
+  #end
+
+  # Finally, specify which code to run. (Defaults to `rake`.)
+  # NOTE: If you don't set config.success manually to a boolean value,Prophet
+  # will try to determine it by looking at whether the last system call returned
+  # 0 (= success).
+  config.execution do
+    log.info 'Running tests ...'
+
+    system("cd ..; rspec")
+    config.success = ($? == 0)
+
+    log.info "Tests are #{config.success ? 'passing' : 'failing'}."
+  end
+
+end
+
+Prophet.run

data/spec/base_command_spec.rb

@@ -0,0 +1,30 @@
+# 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 "spec_helper.rb"
+
+describe Pennyworth::BaseCommand do
+  it "processes the base image parameter" do
+    c = Pennyworth::BaseCommand.new("/foo")
+
+    all_base_images = ["aaa", "bbb", "ccc"]
+
+    expect(c.process_base_image_parameter(all_base_images, "bbb")).to eq ["bbb"]
+    expect { c.process_base_image_parameter(all_base_images, "xxx") }.to raise_error
+    expect(c.process_base_image_parameter(all_base_images, nil)).to eq ["aaa", "bbb", "ccc"]
+  end
+end

data/spec/build_base_command_spec.rb

@@ -0,0 +1,147 @@
+# 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 "spec_helper.rb"
+
+describe Pennyworth::BuildBaseCommand do
+
+  let(:tmp_dir) { "/tmp/kiwi-vagrant-build-environment" }
+  let(:expected_content) {
+    <<-EOT
+---
+base_opensuse13.1_kvm:
+  sources:
+    config.sh: 00cd92ac20df539d7d6f7930a339c622
+    config.xml: 43dd3b9cd11bc9d882f8f82ac108b74a
+    root/home/vagrant/.ssh/authorized_keys: b440b5086dd12c3fd8abb762476b9f40
+  target: 115469c104dcc69455f321eb086ffb11
+base_opensuse12.3_kvm:
+  sources:
+    config.sh: c6640ba00ab345b7491b836d517a637b
+    config.xml: a3d3de67d84f7792bf2755f7a3ae4e3f
+    root/home/vagrant/.ssh/authorized_keys: b440b5086dd12c3fd8abb762476b9f40
+  target: e4e743b5340686d8488dbce54b5644d8
+EOT
+  }
+
+  context "with non-existing box state file" do
+    before(:each) do
+      Pennyworth::Cli.settings = Pennyworth::Settings.new
+      @kiwi_dir = File.join(test_data_dir, "kiwi")
+      @cmd = Pennyworth::BuildBaseCommand.new(@kiwi_dir)
+    end
+
+    it "reads box sources state of one box" do
+      source_state = @cmd.read_box_sources_state("base_opensuse12.3_kvm")
+
+      expect(source_state.count).to eq 3
+      expect(source_state["config.sh"]).to eq "c6640ba00ab345b7491b836d517a637b"
+    end
+
+    it "reads box target state of one box" do
+      target_state = @cmd.read_box_target_state("base_opensuse13.1_kvm")
+
+      expect(target_state).to eq "115469c104dcc69455f321eb086ffb11"
+    end
+
+    it "writes box state file" do
+      box_state_file = File.join(@kiwi_dir, "box_state.yaml")
+
+      box_state = {}
+      [ "base_opensuse13.1_kvm", "base_opensuse12.3_kvm" ].each do |box|
+        box_state[box] = {}
+        box_state[box]["sources"] = @cmd.read_box_sources_state(box)
+        target_state = @cmd.read_box_target_state(box)
+        if target_state
+          box_state[box]["target"] = target_state
+        end
+      end
+
+      FileUtils.rm(box_state_file) if File.exist?(box_state_file)
+
+      @cmd.write_box_state_file(box_state)
+
+      expect(File.read(box_state_file)).to eq expected_content
+
+      FileUtils.rm(box_state_file) if File.exist?(box_state_file)
+    end
+
+    it "doesn't fail reading box state file" do
+      box_state = @cmd.read_local_box_state_file
+
+      expect(box_state).to eq({})
+    end
+
+    it "preserves the state data of other boxes on build-base" do
+      allow(Pennyworth::Libvirt).to receive(:ensure_libvirt_env_started)
+
+      # Don't actually build
+      allow(@cmd).to receive(:base_image_create)
+      allow(@cmd).to receive(:base_image_export)
+      allow(@cmd).to receive(:base_image_cleanup_build)
+
+      allow(@cmd).to receive(:log) # Don't print to stdout
+
+      @cmd.execute(tmp_dir, "base_opensuse13.1_kvm")
+      @cmd.execute(tmp_dir, "base_opensuse12.3_kvm")
+
+      box_state_file = File.join(@kiwi_dir, "box_state.yaml")
+
+      expect(File.read(box_state_file)).to eq expected_content
+
+      FileUtils.rm(box_state_file) if File.exist?(box_state_file)
+    end
+  end
+
+  context "with existing box state file" do
+    before(:each) do
+      Pennyworth::Cli.settings = Pennyworth::Settings.new
+      @kiwi_dir = File.join(test_data_dir, "kiwi2")
+      @cmd = Pennyworth::BuildBaseCommand.new(@kiwi_dir)
+    end
+
+    it "reads box state file" do
+      box_state = @cmd.read_local_box_state_file
+
+      expect(box_state["base_opensuse12.3_kvm"]["sources"]["config.sh"]).to eq(
+        "c6640ba00ab345b7491b836d517a637b")
+      expect(box_state["base_opensuse13.1_kvm"]["target"]).to eq(
+        "115469c104dcc69455f321eb086ffb11")
+    end
+
+    it "rebuilds box with changed sources" do
+      allow(Pennyworth::Libvirt).to receive(:ensure_libvirt_env_started)
+      allow(@cmd).to receive(:log) # Don't print to stdout
+      allow(@cmd).to receive(:write_box_state_file) # Don't actually write data
+
+      expect(@cmd).to receive(:base_image_create)
+      expect(@cmd).to receive(:base_image_export)
+      expect(@cmd).to receive(:base_image_cleanup_build)
+      @cmd.execute(tmp_dir, "base_opensuse13.1_kvm")
+    end
+
+    it "doesn't rebuild box with unchanged sources" do
+      allow(Pennyworth::Libvirt).to receive(:ensure_libvirt_env_started)
+      allow(@cmd).to receive(:log) # Don't print to stdout
+      allow(@cmd).to receive(:write_box_state_file) # Don't actually write data
+
+      expect(@cmd).to_not receive(:base_image_create)
+      @cmd.execute(tmp_dir, "base_opensuse12.3_kvm")
+    end
+  end
+
+end

data/spec/cli_host_controller_spec.rb

@@ -0,0 +1,113 @@
+# Copyright (c) 2013-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
+
+require "spec_helper"
+
+include GivenFilesystemSpecHelpers
+
+describe Pennyworth::CliHostController do
+  use_given_filesystem
+
+  context "no configuration" do
+    before(:each) do
+      @config_dir = given_directory
+      out = double
+      allow(out).to receive(:puts)
+      @controller = Pennyworth::CliHostController.new(@config_dir, out)
+    end
+
+    describe "#setup" do
+      it "raises error when no argument is given" do
+        expect {
+          @controller.setup(nil)
+        }.to raise_error(GLI::BadCommandLine)
+      end
+
+      it "fetches configuration file" do
+        stub_request(:get, "http://remote.example.com/pennyworth/hosts.yaml").
+          with(:headers => {
+            "Accept" => "*/*",
+            "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+            "User-Agent" => "Ruby"
+          }).
+          to_return(status: 200, body: "xx", headers: {})
+
+        config_file = File.join(@config_dir, "hosts.yaml")
+        expect(File.exist?(config_file)).to be(false)
+        @controller.setup("http://remote.example.com")
+        expect(File.exist?(config_file)).to be(true)
+      end
+    end
+  end
+
+  context "existing configuration" do
+    before(:each) do
+      @config_dir = given_directory do
+        given_file("hosts.yaml")
+      end
+      @out = double
+      @controller = Pennyworth::CliHostController.new(@config_dir, @out)
+    end
+
+    describe "#list" do
+      it "lists host" do
+        expect(@out).to receive(:puts).
+          with("test_host (address: host.example.com, base snapshot id: 5)")
+        expect(@out).to receive(:puts).
+          with("missing_address (base snapshot id: 5)")
+        expect(@out).to receive(:puts).
+          with("missing_snapshot_id (address: host.example.com)")
+
+        @controller.list
+      end
+    end
+
+    describe "#lock" do
+      it "raises error when no argument is given" do
+        expect {
+          @controller.lock(nil)
+        }.to raise_error(GLI::BadCommandLine)
+      end
+
+      it "raises error when host is not in configuration file" do
+        expect {
+          @controller.lock("invalid name")
+        }.to raise_error(Pennyworth::LockError)
+      end
+
+      it "acquires lock for host" do
+        expect_any_instance_of(Pennyworth::LockService).to receive(:request_lock).
+          with("test_host").and_return(true)
+        expect(@out).to receive(:puts).with(/test_host/)
+        expect_any_instance_of(Pennyworth::LockService).to receive(:keep_lock)
+
+        @controller.lock("test_host")
+      end
+
+      it "fails to acquire lock for host" do
+        expect_any_instance_of(Pennyworth::LockService).to receive(:request_lock).
+          with("test_host").and_return(false)
+        expect_any_instance_of(Pennyworth::LockService).to receive(:info).
+          with("test_host").and_return("'test_host' locked by 1.2.3.4")
+        expect(@out).to receive(:puts).with(/test_host/)
+        expect_any_instance_of(Pennyworth::LockService).to_not receive(:keep_lock)
+
+        @controller.lock("test_host")
+      end
+    end
+  end
+end