dister 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+.idea
+.dister
+rdoc
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,9 @@
+source :gemcutter
+
+# Specify your gem's dependencies in dister.gemspec
+gemspec
+
+# Explicitly requiring test/unit here so that testing works on Ruby 1.9
+group :test do
+  gem 'test-unit', '1.2.3', :require => 'test/unit'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Flavio Castelli
+Copyright (c) 2011 Dominik Mayer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,86 @@
+= Dister: an Heroku like solution for SUSE Studio
+
+{SUSE Studio}[http://susestudio.com] is an online Linux image creation tool.
+Creating an appliance to run your rails appliacation can be quite annoying:
+there are extra repositories to add, gem dependencies to satisfy, a database to 
+setup, apache and passenger to configure, overlay files to add and so on.
+
+You can save some time cloning {this}[http://susegallery.com/a/CZ0T0D/rails-in-a-box]
+appliance shared on {SUSE Gallery}[http://susegallery.com/], but some efforts
+are still required.
+
+Currenlty the easiest solution to deploy a rails application in the cloud is 
+{Heroku}[http://heroku.com/].
+
+Dister is a command line tool similar to the one used by Heroku. Within a few 
+steps you can create a SUSE Studio appliance running your rails application, 
+download it and run into your private or public cloud.
+
+SUSE Studio currenlty supports the following appliance formats:
+- oem: it can be run inside KVM or it can be installed to a hard disk/usb pen.
+- iso and preload iso: you can create a live dvd or an installation dvd.:
+- vmx and ovf: use these formats if you want to run your appliance inside of
+  VMware, VirtualBox or KVM.
+- XEN guest: use this format if you want to run your appliance using Xen
+  hypervisor.
+- ec2: jumping into Amazon's cloud has never been so easy.
+
+More formats are coming. Checkout {SUSE Studio}[http://susestudio.com] for 
+more details.
+
+== Common workflow
+
+This section will show the common workflow required to create a SUSE Studio 
+appliance running a standard Rails application.
+
+All the following commands must be executed inside of the root directory of
+your rails application.
+
+=== Create
+You can create your SUSE Studio appliance using the following command:
+    dister create APPLIANCE_NAME
+The following code creates a 32bit appliance based on the latest version of
+openSUSE supported by SUSE Studio. The appliance will use the 
+{JeOS}[http://en.wikipedia.org/wiki/Just_enough_operating_system] template.
+
+You can change the default behaviour using the following command line options:
+- <tt>--basesystem</tt>: to use something different from openSUSE.
+- <tt>--template</tt>: to use something different from the JeOS template.
+- <tt>--arch</tt>: to build a 64bit appliance.
+
+By default all the appliances created by dister have the <em>devel:language:ruby:extensions</em>
+repository. This repository contains all the ruby-related packages.
+It's actively maintained by the openSUSE community and by some Novell employee.
+
+The following packages are automatically added to all appliances:
+- devel_C_C++ and devel_Ruby: these are needed in order to build native gems.
+- rubygem-bundler: this package provides latest version of bundler.
+- rubygem-passenger-apache2: this package is required in order to deploy your
+  rails application using Apache. All the Apache packages will be automatically
+  installed by SUSE Studio because they are dependencies of rubygem-passenger-apache2.
+
+The create task takes care of uploading some custom build and boot scripts.
+These scripts take care of initializing your appliance. You can inspect them
+using SUSE Studio web interface.
+
+=== Upload your code
+In order to add your rails application to your SUSE Studio appliance just execute:
+    dister push
+
+This will automatically create (or update) your local bundle and upload it to
+SUSE Studio.
+Your bundle contains:
+- all the gems needed by your rails appliance (this is done using bundler).
+- all your code
+- apache configuration
+
+=== Build
+Building can be triggered using the following command:
+    dister build
+A nice progress bar will be shown.
+
+TODO: write more documentation.
+
+== License
+
+Dister is released under the MIT license.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler'
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+task :default => "test"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'dister'
+  rdoc.options << '--line-numbers' << "--main" << "README.rdoc"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc]

data/bin/dister

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/dister',__FILE__)
+Dister::Cli.start(ARGV)

data/dister.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/dister/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "dister"
+  s.version     = Dister::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Flavio Castelli', 'Dominik Mayer']
+  s.email       = ['flavio@castelli.name','dmayer@novell.com']
+  s.homepage    = "https://features.opensuse.org/311133"
+  s.summary     = "Heroku like solution for SUSE Studio"
+  s.description = "Turn your rails app into a SUSE Studio appliance in a few steps."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "dister"
+
+  s.add_dependency "curb"
+  s.add_dependency "progressbar"
+  s.add_dependency "studio_api", "~>3.1.0"
+  s.add_dependency "thor", "~>0.14.0"
+
+  s.add_development_dependency "bundler", "~>1.0.0"
+  s.add_development_dependency "fakefs"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "test-unit", "1.2.3"
+  s.add_development_dependency "shoulda"
+  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'
+end

data/lib/adapters/mysql.yml

@@ -0,0 +1,13 @@
+packages:
+  - mysql-community-server
+  - ruby-mysql
+daemon_name:      mysql
+cmdline_tool:     mysql
+create_user_cmd:  |
+                  CREATE USER '<%= @user %>'@'localhost'
+                  IDENTIFIED BY '<%= @password %>'; 
+                  GRANT ALL PRIVILEGES ON *.* TO '<%= @user %>'@'localhost' 
+                  WITH GRANT OPTION;
+restore_dump_cmd: |
+                  mysql --user=<%= @user %> --password=<%= @password %>
+                  <%= @dbname %> < <%= @dump %>

data/lib/adapters/mysql2.yml

@@ -0,0 +1,13 @@
+packages:
+  - mysql-community-server
+  - rubygem-mysql2
+daemon_name:      mysql
+cmdline_tool:     mysql
+create_user_cmd:  |
+                  CREATE USER '<%= @user %>'@'localhost'
+                  IDENTIFIED BY '<%= @password %>'; 
+                  GRANT ALL PRIVILEGES ON *.* TO '<%= @user %>'@'localhost' 
+                  WITH GRANT OPTION;
+restore_dump_cmd: |
+                  mysql --user=<%= @user %> --password=<%= @password %>
+                  <%= @dbname %> < <%= @dump %>

data/lib/adapters/postgresql.yml

@@ -0,0 +1,12 @@
+packages:
+  - postgresql-server
+  - rubygem-pg
+daemon_name:      postgresql
+cmdline_tool:     psql
+create_user_cmd:  |
+                  CREATE USER '<%= @user %>'
+                  WITH PASSWORD '<%= @password %>'; 
+                  CREATEDB;
+restore_dump_cmd: |
+                  psql -U <%= @user %> -h localhost -p <%= @password %>
+                  <%= @dbname %> < <%= @dump %>

data/lib/adapters/sqlite3.yml

@@ -0,0 +1,7 @@
+packages:
+  - sqlite3
+  - rubygem-sqlite3
+cmdline_tool: sqlite3
+daemon_name:
+create_user_cmd:
+restore_dump_cmd: sqlite db/<%= dbname %>.sqlite3 < <%= dump %>

data/lib/dister.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'thor'
+require 'studio_api'
+require 'yaml'
+require 'progressbar'
+require 'bundler'
+require 'curb'
+
+require File.expand_path('../dister/cli', __FILE__)
+require File.expand_path('../dister/core', __FILE__)
+require File.expand_path('../dister/options', __FILE__)
+require File.expand_path('../dister/utils', __FILE__)
+require File.expand_path('../dister/downloader', __FILE__)
+require File.expand_path('../dister/db_adapter', __FILE__)
+require File.expand_path('../studio_api/build', __FILE__)
+
+module Dister
+
+  autoload :Version, File.expand_path('../dister/version', __FILE__)
+
+end

data/lib/dister/cli.rb

@@ -0,0 +1,198 @@
+module Dister
+
+  class Cli < Thor
+
+    VALID_TEMPLATES = %w(JeOS Server X Gnome KDE)
+    VALID_FOMATS = %w(oem vmx iso xen) #TODO: add other formats
+    VALID_ARCHS = %w(i686 x86_64)
+
+    include Thor::Actions
+
+    # Returns Dister's root directory.
+    # NOTE: Some of Thor's actions require this method to be defined.
+    def self.source_root
+      File.expand_path('../../',__FILE__)
+    end
+
+    desc "config OPTION VALUE", "set OPTION value to VALUE"
+    method_option :local,
+      :type => :boolean, :default => false, :required => false
+    def config option, value
+      dister_options = Dister::Options.new(!options[:local].nil?)
+      dister_options.send("#{option}=", value)
+    end
+
+    desc "create APPLIANCE_NAME", "create a new appliance named APPLIANCE_NAME."
+    method_option :basesystem, :type => :string, :default => nil, :required => false
+    method_option :template, :type => :string, :default => 'JeOS', :required => false
+    method_option :arch, :type => :string, :default => 'i686', :required => false
+    def create(appliance_name)
+      # Check parameters.
+      access_core
+      ensure_valid_option options[:arch], VALID_ARCHS, "arch"
+      ensure_valid_option options[:template], VALID_TEMPLATES, "template"
+      basesystems = @core.basesystems
+      basesystem = options[:basesystem] || basesystems.find_all{|a| a =~ /\d+\.\d+/}.sort.last
+      ensure_valid_option basesystem, basesystems, "base system"
+      # Create appliance and add patterns required to build native gems.
+      @core.create_appliance(appliance_name, options[:template], basesystem, options[:arch])
+    end
+
+    desc "build", "Build the appliance."
+    def build
+      access_core
+      ensure_appliance_exists
+      if @core.build
+        puts "Appliance successfully built."
+      else
+        puts "Build failed."
+      end
+    end
+
+    desc "download", "Download the appliance."
+    def download
+      access_core
+      ensure_appliance_exists
+      ensure_build_exists
+      @core.download(@builds)
+    end
+
+    desc "testdrive", "Testdrive the appliance."
+    def testdrive
+      access_core
+      ensure_appliance_exists
+      ensure_build_exists
+      @core.testdrive(@builds)
+    end
+
+    desc "format list|add|rm FORMAT", "Enables building of FORMAT"
+    method_option :all, :type => :boolean, :default => false, :required => false
+    def format(operation,format = nil)
+      access_core
+      ensure_valid_option operation, %w(add rm list), "operation"
+      if operation == 'list' and options[:all]
+        puts "Available formats:"
+        puts VALID_FOMATS
+      else
+        existing_types = @core.options.build_types || []
+        chosen_types = case operation
+          when "add"
+            ensure_valid_option format, VALID_FOMATS, "format"
+            @core.options.build_types = (existing_types + [format]).uniq
+          when "rm"
+            @core.options.build_types = (existing_types - [format])
+          else
+            existing_types
+          end
+        puts "Chosen formats:"
+        puts chosen_types
+      end
+    end
+
+    desc "templates", "List all the templates available on SUSE Studio."
+    def templates
+      puts VALID_TEMPLATES.sort
+    end
+
+    desc "basesystems", "List all the base systems available on SUSE Studio."
+    def basesystems
+      access_core
+      puts @core.basesystems.sort
+    end
+
+    desc "bundle", "Bundles the application and all required gems."
+    def bundle
+      access_core
+      @core.package_gems
+      @core.package_config_files
+      # Package app last, since it will tarball the application including all gems.
+      @core.package_app
+    end
+
+    desc 'push', 'Pushes all required gems and the application tarball to SUSE Studio.'
+    def push
+      access_core
+      # Always call 'bundle' to ensure we got the latest version bundled.
+      invoke :bundle
+      ensure_appliance_exists
+      @core.upload_bundled_files
+    end
+
+    desc "package add|rm PACKAGE [PACKAGE, ...]", "Add/remove PACKAGE to the appliance"
+    def package operation, *package
+      access_core
+      valid_operations = %w(add rm)
+      ensure_valid_option operation, valid_operations, "operation"
+      case operation
+      when "add"
+        package.each do |p|
+          @core.add_package p
+        end
+      when "rm"
+        package.each do |p|
+          @core.rm_package p
+        end
+      end
+      @core.verify_status
+      puts "Done."
+    end
+
+    desc "info", "Show some useful information about the appliance"
+    def info
+      access_core
+      app = Utils::execute_printing_progress "Contacting SUSE Studio" do
+        @core.appliance
+      end
+      puts "Name: #{app.name}"
+      puts "Based on: #{app.parent.name}"
+      if app.builds.empty?
+        puts "No builds yet."
+      else
+        puts "Builds:"
+        app.builds.each do |b|
+          puts "  - #{b.image_type}, version #{b.version}"
+        end
+      end
+      puts "Edit url: #{app.edit_url}"
+    end
+
+    private
+
+    # Convenience method to reduce duplicity and improve readability.
+    # Sets @core
+    def access_core
+      @core ||= Core.new
+    end
+
+    # Checks whether an appliance already exists (invokes :create if not).
+    def ensure_appliance_exists
+      if @core.appliance.nil?
+        appliance_id = @core.shell.ask('Please provide a name for your appliance:')
+        invoke :create, [appliance_id]
+        @core.options.reload
+      end
+    end
+
+    # Checks whether there is at least one existing build (invokes :build if not).
+    def ensure_build_exists
+      @builds = @core.builds
+      if @builds.empty?
+        invoke :build
+        @builds = @core.builds
+        @core.options.reload
+      end
+    end
+
+    # Ensures actual_value is allowed. If not prints an error message to
+    # stderr and exits
+    def ensure_valid_option actual_value, allowed_values, option_name
+      if allowed_values.find{|v| v.downcase == actual_value.downcase}.nil?
+        STDERR.puts "#{actual_value} is not a valid value for #{option_name}"
+        STDERR.puts "Valid values are: #{allowed_values.join(" ")}"
+        exit 1
+      end
+    end
+
+  end
+
+end