dister 0.1.0

data/lib/dister/db_adapter.rb

@@ -0,0 +1,57 @@
+require 'erb'
+
+module Dister
+  class DbAdapter
+
+    def initialize db_config_file, dump=nil
+      config = YAML.load_file(db_config_file)
+      if !config.has_key?("production")
+        STDERR.puts "There's no configuration for the production environment"
+      end
+      
+      @adapter  = config["production"]["adapter"]
+      @user     = config["production"]["username"]
+      @password = config["production"]["password"] 
+      @dbname   = config["production"]["adapter"] 
+      @dump     = dump
+      
+      filename = File.expand_path("../../adapters/#{@adapter}.yml", __FILE__)
+      raise "There's no adapter for #{@adapter}" if !File.exists?(filename)
+
+      @adapter_config = YAML.load_file(filename)
+    end
+
+    def has_dump?
+      return false if @dump.nil?
+      return File.exists? @dump
+    end
+    
+    def cmdline_tool
+      @adapter_config["cmdline_tool"]
+    end
+
+    def packages
+      @adapter_config["packages"]
+    end
+
+    def daemon_name
+      @adapter_config["daemon_name"]
+    end
+
+    def create_user_cmd
+      compile_cmd @adapter_config["create_user_cmd"]
+    end
+
+    def restore_dump_cmd
+      compile_cmd @adapter_config["restore_dump_cmd"]
+    end
+
+    private
+    def compile_cmd cmd
+      return "" if cmd.nil?
+
+      erb = ERB.new cmd
+      erb.result(binding)
+    end
+  end
+end

data/lib/dister/downloader.rb

@@ -0,0 +1,58 @@
+require 'ruby-debug'
+module Dister
+  class Downloader
+    attr_reader :filename
+
+
+    def initialize url, message
+      @filename = File.basename(url)
+      @message  = message
+      
+      # setup curl
+      @curl = Curl::Easy.new
+      @curl.url = url
+      @curl.follow_location = true
+
+      @curl.on_body { |data| self.on_body(data); data.size }
+      @curl.on_complete { |data| self.on_complete }
+      @curl.on_failure { |data| self.on_failure }
+      @curl.on_progress do |dl_total, dl_now, ul_total, ul_now|
+        self.on_progress(dl_now, dl_total, @curl.download_speed, @curl.total_time)
+        true
+      end
+    end
+
+    def start
+      @file = File.open(@filename, "wb")
+      @pbar = ProgressBar.new(@message, 100)
+      @curl.perform
+    end
+
+    def on_body(data)
+      @file.write(data)
+    end
+
+    def on_progress(downloaded_size, total_size, download_speed, downloading_time)
+      if total_size > 0
+        @pbar.set(downloaded_size / total_size * 100)
+      end
+    end
+
+    def on_complete
+      @pbar.finish
+      @file.close
+    end
+
+    def on_failure
+      begin
+        unless code == 'Curl::Err::CurlOKNo error'
+          @pbar.finish
+          STDOUT.flush
+          raise "Download failed with error code: #{code}"
+        end
+      ensure
+        @file.close
+      end
+    end
+  end
+end

data/lib/dister/options.rb

@@ -0,0 +1,113 @@
+require 'fileutils'
+
+module Dister
+  class Options
+
+    SUSE_STUDIO_DOT_COM_API_PATH = 'https://susestudio.com/api/v2/user'
+    GLOBAL_PATH = "#{File.expand_path('~')}/.dister"
+    LOCAL_PATH = "#{Dister::Core::APP_ROOT}/.dister/options.yml"
+
+    attr_reader :use_only_local
+
+    # Read options from file.
+    def initialize use_only_local=false
+      @use_only_local = use_only_local
+      reload
+    end
+
+    # Provides setter and getter for all options.
+    def method_missing(method, *args)
+      method_name = method.to_s
+      if (method_name =~ /=$/).nil?
+        # Getter
+        provide[method_name]
+      else
+        # Setter
+        store(method_name[0..-2], args.first)
+      end
+    end
+
+    # Read @global and @local option files.
+    def reload
+      if @use_only_local
+        @global = {}
+      else
+        # Global options hold the user's credentials to access SUSE Studio.
+        # They are stored inside the user's home directory.
+        @global = read_options_from_file(GLOBAL_PATH)
+
+        # make sure the default api path is available
+        unless @global.has_key? 'api_path'
+          @global['api_path'] = SUSE_STUDIO_DOT_COM_API_PATH
+        end
+      end
+      # Local options hold application specific data (e.g. appliance_id)
+      # They are stored inside the application's root directory.
+      @local = read_options_from_file(LOCAL_PATH)
+    end
+
+    private
+
+    # Reads from global or local options file and returns an options hash.
+    def read_options_from_file(file_path)
+      values_hash = YAML.load_file(file_path)
+      # In the unlikely case that the options file is empty, return an empty hash.
+      values_hash ? values_hash : {}
+    rescue Errno::ENOENT
+      # File does not exist.
+      options_dir = File.dirname(file_path)
+      FileUtils.mkdir_p(options_dir) unless File.directory?(options_dir)
+      File.new(file_path, 'w')
+      retry
+    end
+
+    # Writes an options_hash back to a specified options file.
+    def write_options_to_file(options_hash, file_path)
+      File.open(file_path, 'w') do |out|
+        YAML.dump(options_hash, out)
+      end
+    end
+
+    # Determines to which file an option gets written.
+    def determine_options_file(option_key)
+      return 'local' if @use_only_local
+
+      # Search in local options first, since they override global options.
+      case option_key
+        when @local.keys.include?(option_key) then 'local'
+        when @global.keys.include?(option_key) then 'global'
+        else
+          if %w(username api_key api_path).include?(option_key)
+            # Credentials are stored globally per default.
+            'global'
+          else
+            # New options get stored locally.
+            'local'
+          end
+      end
+    end
+
+    # Stores a specified option_key inside its originating options file.
+    def store(option_key, option_value)
+      if determine_options_file(option_key) == 'local'
+        @local[option_key] = option_value
+        options_hash = @local
+        file_path = LOCAL_PATH
+      else
+        @global[option_key] = option_value
+        options_hash = @global
+        file_path = GLOBAL_PATH
+      end
+      write_options_to_file(options_hash, file_path)
+    end
+
+    # Returns a hash consisting of both global and local options.
+    # All options can be read through this method.
+    # NOTE: Local options override global options.
+    def provide
+      @global.merge(@local)
+    end
+
+  end
+
+end

data/lib/dister/utils.rb

@@ -0,0 +1,46 @@
+module Dister
+  module Utils
+    module_function
+    # Shows message and prints a dot per second until the block code
+    # terminates its execution.
+    # Exceptions raised by the block are displayed and program exists with
+    # error status 1.
+    def execute_printing_progress message
+      t = Thread.new do
+        print "#{message}"
+        while(true) do
+          print "."
+          STDOUT.flush
+          sleep 1
+        end
+      end
+      shell = Thor::Shell::Color.new
+      begin
+        ret = yield
+        t.kill if t.alive?
+        shell.say_status "[DONE]", "", :GREEN
+        return ret
+      rescue
+        t.kill if t.alive?
+        shell.say_status "[ERROR]", $!, :RED
+        exit 1
+      end
+    end
+
+    GIGA_SIZE = 1073741824.0
+    MEGA_SIZE = 1048576.0
+    KILO_SIZE = 1024.0
+
+    # Return the file size with a readable style.
+    def readable_file_size(size, precision)
+      case
+        when size == 1 then "1 Byte"
+        when size < KILO_SIZE then "%d Bytes" % size
+        when size < MEGA_SIZE then "%.#{precision}f KB" % (size / KILO_SIZE)
+        when size < GIGA_SIZE then "%.#{precision}f MB" % (size / MEGA_SIZE)
+        else "%.#{precision}f GB" % (size / GIGA_SIZE)
+      end
+    end
+
+  end
+end

data/lib/dister/version.rb

@@ -0,0 +1,5 @@
+module Dister
+
+  VERSION = "0.1.0"
+
+end

data/lib/studio_api/build.rb

@@ -0,0 +1,7 @@
+module StudioApi
+  class Build
+    def to_s
+      "version #{self.version}, #{self.image_type} format"
+    end
+  end
+end

data/lib/templates/boot_script.erb

@@ -0,0 +1,37 @@
+#!/bin/bash
+#
+# This script is executed whenever your appliance boots.  Here you can add
+# commands to be executed before the system enters the first runlevel.  This
+# could include loading kernel modules, starting daemons that aren't managed
+# by init files, asking questions at the console, etc.
+#
+# The 'kiwi_type' variable will contain the format of the appliance (oem =
+# disk image, vmx = VMware, iso = CD/DVD, xen = Xen).
+#
+
+# read in some variables
+. /studio/profile
+
+if [ -f /etc/init.d/suse_studio_firstboot ]
+then
+  # Put commands to be run on the first boot of your appliance here
+  echo "Running SUSE Studio first boot script..."
+  cd <%= rails_root %>
+  bundle install --local
+<% unless @db_adapter.nil? %>  
+  # create db user
+  if [ -f /root/create_db_user.sql ]
+  then
+    /etc/init.d/<%= @db_adapter.daemon_name %> start
+    <%= @db_adapter.cmdline_tool %> < /root/create_db_user.sql
+  fi
+
+<% if !@db_adapter.has_dump? %>
+  echo "Loading database schema"
+  RAILS_ENV=production rake db:create
+  RAILS_ENV=production rake db:schema:load
+<% else %>
+  <%= @db_adapter.restore_dump_cmd %>
+<% end %>
+<% end %>
+fi

data/lib/templates/build_script.erb

@@ -0,0 +1,22 @@
+#!/bin/bash -e
+#
+# This script is executed at the end of appliance creation.  Here you can do
+# one-time actions to modify your appliance before it is ever used, like
+# removing files and directories to make it smaller, creating symlinks,
+# generating indexes, etc.
+#
+# The 'kiwi_type' variable will contain the format of the appliance (oem =
+# disk image, vmx = VMware, iso = CD/DVD, xen = Xen).
+#
+
+# read in some variables
+. /studio/profile
+
+# add passenger module to apache
+sed -i.bak 's/^\(APACHE_MODULES=.*\)"/\1 passenger"/' /etc/sysconfig/apache2
+
+# enable services 
+insserv /etc/init.d/apache2
+<% unless @db_adapter.nil? %>  
+insserv /etc/init.d/<%= @db_adapter.daemon_name %>
+<% end %>

data/lib/templates/passenger.erb

@@ -0,0 +1,13 @@
+<VirtualHost *:80>
+    PassengerEnabled on
+    RailsEnv production
+    ServerAdmin you@example.com
+    DocumentRoot /srv/www/<%= @options.app_name %>/public
+    <Directory /srv/www/<%= @options.app_name %>/public>
+        Options FollowSymlinks
+        Allow from all
+    </Directory>
+    ErrorLog /var/log/apache2/error.log
+    LogLevel warn
+    CustomLog /var/log/apache2/access.log combined
+</VirtualHost>

data/test/cli_test.rb

@@ -0,0 +1,141 @@
+require File.expand_path('../test_helper', __FILE__)
+
+if !defined? FakeTemplates
+  Struct.new("FakeTemplate", :name, :basesystem, :appliance_id, :description)
+
+  FakeTemplates = []
+  YAML.load_file(File.expand_path('../fixtures/templates.yml', __FILE__)).each do |item|
+    info = item.last
+    FakeTemplates  << Struct::FakeTemplate.new(info["name"],
+                                               info["basesystem"],
+                                               info["appliance_id"],
+                                               info["description"])
+  end
+  FakeTemplates.freeze
+end
+
+class CliTest < Test::Unit::TestCase
+
+  context "Run with FakeFS" do
+
+    setup do
+      FakeFS.activate!
+    end
+
+    teardown do
+      FakeFS.deactivate!
+    end
+
+    context "no parameter passed" do
+
+      setup do
+        @out = capture(:stdout) { Dister::Cli.start() }
+      end
+
+      should "show help message" do
+        assert @out.include?("Tasks:")
+      end
+
+    end
+
+    context "wrong param" do
+
+      setup do
+        @out = capture(:stdout) do
+          @err = capture(:stderr) { Dister::Cli.start(['foo']) }
+        end
+      end
+
+      should "show help message" do
+        assert_equal 'Could not find task "foo".', @err.chomp
+        assert @out.empty?
+      end
+
+    end
+
+    context "config handling" do
+      setup do
+        FakeFS.activate!
+      end
+
+      teardown do
+        FakeFS.deactivate!
+      end
+
+      should "write to local file" do
+        FileUtils.rm_rf Dister::Options::GLOBAL_PATH
+        FileUtils.rm_rf Dister::Options::LOCAL_PATH
+        @out = capture(:stdout) do
+          Dister::Cli.start(['config', 'foo', 'foo_value', '--local'])
+        end
+        assert !File.exists?(Dister::Options::GLOBAL_PATH)
+        assert File.exists?(Dister::Options::LOCAL_PATH)
+        options = Dister::Options.new(true)
+        assert_equal "foo_value", options.foo
+      end
+
+    end
+
+    context "creating a new appliance" do
+
+      setup do
+        Dister::Core.any_instance.stubs(:puts)
+        Dister::Core.any_instance.stubs(:templates).returns(FakeTemplates)
+        basesystems = ["11.1", "SLED10_SP2", "SLES10_SP2", "SLED11", "SLES11",
+                       "11.2", "SLES11_SP1", "SLED11_SP1", "11.3", "SLED10_SP3",
+                       "SLES10_SP3", "SLES11_SP1_VMware"]
+        Dister::Core.any_instance.stubs(:basesystems).returns(basesystems)
+      end
+
+      should "refuse invalid archs" do
+        STDERR.stubs(:puts)
+        assert_raise SystemExit do
+          Dister::Cli.start(['create', 'foo','--arch', 'ppc'])
+        end
+      end
+
+      should "accept valid archs" do
+        fake_app = mock()
+        fake_app.stubs(:edit_url).returns("http://susestudio.com")
+        Dister::Core.any_instance.expects(:create_appliance).returns(fake_app)
+        assert_nothing_raised do
+          Dister::Cli.start(['create', 'foo','--arch', 'x86_64'])
+        end
+      end
+
+      should "guess latest version of openSUSE if no base system is specified" do
+        fake_app = mock()
+        fake_app.stubs(:edit_url).returns("http://susestudio.com")
+        Dister::Core.any_instance.expects(:create_appliance).\
+                                 with("foo", "JeOS", "11.3", "i686").\
+                                 returns(fake_app)
+        assert_nothing_raised do
+          Dister::Cli.start(['create', 'foo'])
+        end
+      end
+
+      should "detect bad combination of template and basesystem" do
+        STDERR.stubs(:puts)
+        assert_raise(SystemExit) do
+          Dister::Cli.start(['create', 'foo', "--template", "jeos",
+                             "--basesystem", "SLES11_SP1_VMware"])
+        end
+      end
+
+    end
+
+    context "When executing 'dister bundle' it" do
+
+      should 'package all required gems' do
+        FileUtils.stubs(:rm).returns(:true)
+        Dister::Core.any_instance.expects(:package_gems).once
+        Dister::Core.any_instance.expects(:package_config_files).once
+        Dister::Core.any_instance.expects(:package_app).once
+        Dister::Cli.start ['bundle']
+      end
+
+    end
+
+  end
+
+end