ssc 0.1 → 0.2.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "studio_api", ">= 3.1.2"
+gem "thor", ">=0.14.6"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "mocha", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    builder (2.1.2)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.12)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    studio_api (3.1.2)
+      activeresource (>= 2.3.8)
+      xml-simple (>= 1.0.0)
+    thor (0.14.6)
+    xml-simple (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.0)
+  mocha
+  rcov
+  shoulda
+  studio_api (>= 3.1.2)
+  thor (>= 0.14.6)

data/README.rdoc

@@ -0,0 +1,22 @@
+= ssc
+
+This is the new version of the the Suse Studio command line client. Built as a part of GSOC 2011.
+
+== Installing ssc
+
+=== Straight from the code
+* Checkout the code
+* In the checked out directory do `rake install`
+
+=== Ocassionally released packaged gems
+* Download 
+
+== Contributing to ssc
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ssc"
+  gem.homepage = "http://github.com/rjsvaljean/ssc"
+  gem.license = "MIT"
+  gem.summary = %Q{Command-line client for Suse Studio}
+  gem.description = %Q{Command-line client for Suse Studio}
+  gem.email = "rjsvaljean@gmail.com"
+  gem.authors = ["Ratan Sebastian"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ssc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/ssc

@@ -1,233 +1,6 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
-require 'rubygems'
-require 'net/http'
-require 'net/netrc'
-require 'xml/smart'
-require 'cgi'
-require 'fileutils'
-require 'optparse'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-$LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
-require 'appliancehandler.rb'
-require 'buildhandler.rb'
-require 'checkouthandler.rb'
-
-
-$server_name="susestudio.com"
-$api_prefix="api/v1/user"
-$username=""
-$password=""
-force = false
-follow = false
-images = false
-version="0.1"
-
-def get_appliance_from_args_or_config args
-  if args
-    appliance = args[1]
-  end
-  unless appliance
-    if File.exists?(".ssc/appliance.config")
-      appliance_config = XML::Smart.open(".ssc/appliance.config")
-      appliance = appliance_config.find("/checkout/appliance_id").first.to_s if appliance_config.find("/checkout/appliance_id").length > 0
-    end
-  end
-  if appliance.nil? || appliance.empty?
-    STDERR.puts "You need to specify an appliance."
-    exit 1
-  end
-  appliance
-end
-
-def base_url
-  "http://#{$server_name}/#{$api_prefix}"
-end
-
-opt = OptionParser.new
-opt.separator("Options")
-opt.on( "-s", "--server", "=HOST",
-  "The Studio hostname" ) do |v|
-  $server_name = v
-end
-opt.on( "-u", "--username", "=USER_NAME", "User name") do |v|
-  $username = v
-end
-opt.on( "-p", "--password", "=PASSWORD", "Password") do |v|
-  $password = v
-end
-opt.on( "-h", "--help", "Print this message" ) do
-  puts opt
-  exit
-end
-opt.on( "-v", "--version",  "Print the version") do |v|
-  puts "ssc #{version} - A command line interface to SUSE Studio"
-  exit 0
-end
-
-# Try to get credentials from .netrc
-rc = Net::Netrc.locate($server_name)
-if $username.empty? and $password.empty? and rc
-  $username = rc.login
-  $password = rc.password
-end
-
-
-if ARGV.include?("ba") || ARGV.include?("buildappliance")
-  opt.banner = "Usage: ssc [options] buildappliance APPLIANCE [command-options]"
-  opt.separator("Trigger a build of an appliance.")
-  opt.separator("\n")
-  opt.separator("Command options:")
-  opt.on( "-f", "--force","Force building the appliance even if it overwrites a build") do |v|
-    force = v
-  end
-elsif ARGV.include?("la") || ARGV.include?("listappliances")
-  opt.banner = "Usage: ssc [options] listappliances"
-  opt.separator("Show a list of your appliances.")
-elsif ARGV.include?("ca") || ARGV.include?("cloneappliance")
-  opt.banner = "Usage: ssc [options] cloneappliance APPLIANCE"
-  opt.separator("Create a new appliance by cloning a template.")
-elsif ARGV.include?("da") || ARGV.include?("deleteappliance")
-  opt.banner = "Usage: ssc [options] deleteappliance APPLIANCE"
-  opt.separator("Delete an appliance.")
-elsif ARGV.include?("lt") || ARGV.include?("listtemplates")
-  opt.banner = "Usage: ssc [options] listtemplates"
-  opt.separator("Get a list of available templates.")
-elsif ARGV.include?("lrb") || ARGV.include?("listrunningbuilds")
-  opt.banner = "Usage: ssc [options] listrunningbuilds APPLIANCE"
-  opt.separator("List all running builds of an appliance.")
-elsif ARGV.include?("srb") || ARGV.include?("showrunningbuild")
-  opt.banner = "Usage: ssc [options] showrunningbuild ID"
-  opt.separator("Show the status of a running build.")
-  opt.on( "-f", "--follow","Follow the progress of the build") do |f|
-    follow = f
-  end
-elsif ARGV.include?("lb") || ARGV.include?("listbuilds")
-  opt.banner = "Usage: ssc [options] listbuilds APPLIANCE"
-  opt.separator("List builds of an appliance.")
-elsif ARGV.include?("sb") || ARGV.include?("showbuild")
-  opt.banner = "Usage: ssc [options] showbuild ID"
-  opt.separator("Show information on a build.")
-elsif ARGV.include?("cb") || ARGV.include?("cancelbuild")
-  opt.banner = "Usage: ssc [options] cancelbuild ID"
-  opt.separator("Cancel a running build.")
-elsif ARGV.include?("db") || ARGV.include?("deletebuild")
-  opt.banner = "Usage: ssc [options] deletebuild ID"
-  opt.separator("Delete a finished build.")
-elsif ARGV.include?("co") || ARGV.include?("checkout")
-  opt.banner = "Usage: ssc [options] checkout APPLIANCE"
-  opt.separator("Checkout an appliance.")
-  opt.on( "-i", "--download-images","Download images of the appliance") do |i|
-    images = i
-  end
-elsif ARGV.include?("st") || ARGV.include?("status")
-  opt.banner = "Usage: ssc [options] status"
-  opt.separator("Show the status of the checkout.")
-elsif ARGV.include?("ci") || ARGV.include?("commit")
-  opt.banner = "Usage: ssc [options] commit"
-  opt.separator("Commit changes to the appliance.")
-elsif ARGV.include?("add")
-  opt.banner = "Usage: ssc [options] add FILE"
-  opt.separator("Add a file to the checkout.")
-elsif ARGV.include?("rm") || ARGV.include?("remove")
-  opt.banner = "Usage: ssc [options] remove FILE"
-  opt.separator("Remove a file from the checkout.")
-else
-  opt.banner = "Usage: ssc [options] COMMAND [command-options]"
-  opt.separator("SUSE Studio command line client.")
-  opt.separator("Type 'ssc COMMAND --help' for help on a specific command.")
-
-  opt.separator("\n")
-  opt.separator("Commands:")
-  opt.separator("    Managing your appliances:")
-  opt.separator("      listappliances,la\t\t     Get a list of your appliances")
-  opt.separator("      cloneappliance,ca\t\t     Create a new appliance by cloning a template")
-  opt.separator("      deleteappliance,da\t     Delete an appliance")
-  opt.separator("      listtemplates,lt\t\t     Get a list of available templates")
-  opt.separator("\n")
-  opt.separator("    Managing builds:")
-  opt.separator("      buildappliance,ba\t\t     Trigger a build of an appliance")
-  opt.separator("      listrunningbuilds,lrb\t     List all running builds of an appliance")
-  opt.separator("      showrunningbuild,srb\t     Show the status of a running build")
-  opt.separator("      listbuilds,lb\t\t     List builds of an appliance")
-  opt.separator("      showbuild,sb\t\t     Show information on a build")
-  opt.separator("      cancelbuild,cb\t\t     Cancel a running build")
-  opt.separator("      deletebuild,db\t\t     Delete a finished build")
-  opt.separator("\n")
-  opt.separator("    Managing checkouts:")
-  opt.separator("      checkout,co\t\t     Checkout an appliance")
-  opt.separator("      status,st\t\t\t     Show the status of the checkout")
-  opt.separator("      commit,ci\t\t\t     Commit changes to the appliance")
-  opt.separator("      add\t\t\t     Add a file to the checkout")
-  opt.separator("      rm\t\t\t     Remove a file from the checkout")
-  opt.separator("\n")
-end
-
-begin
-  opt.parse!( ARGV )
-rescue OptionParser::InvalidOption
-  STDERR.puts $!
-  STDERR.puts opt
-  exit 1
-end
-
-if ARGV.size == 0
-  STDERR.puts opt
-  exit 1
-end
-
-cmd = ARGV[0]
-
-if cmd == "listappliances" or cmd =="la"
-  ApplianceHandler.list_appliances
-
-elsif cmd == "cloneappliance" or cmd =="ca"
-  ApplianceHandler.clone_appliance ARGV
-
-elsif cmd == "deleteappliance" or cmd == "da"
-  ApplianceHandler.delete_appliance ARGV
-
-elsif cmd == "listtemplates" or cmd =="lt"
-  ApplianceHandler.template_sets
-
-elsif cmd == "buildappliance" or cmd =="ba"
-  BuildHandler.build_appliance ARGV, force
-
-elsif cmd == "listrunningbuilds" or cmd =="lrb"
-  BuildHandler.list_running_builds ARGV
-
-elsif cmd == "showrunningbuild" or cmd =="srb"
-  BuildHandler.show_running_build ARGV, follow
-
-elsif cmd == "listbuilds" or cmd =="lb"
-  BuildHandler.list_builds ARGV
-
-elsif cmd == "showbuild" or cmd =="sb"
-  BuildHandler.show_build ARGV
-
-elsif cmd == "cancelbuild" or cmd =="cb"
-  BuildHandler.cancel_build ARGV
-
-elsif cmd == "deletebuild" or cmd =="db"
-  BuildHandler.delete_build ARGV
-
-elsif cmd == "checkout" or cmd =="co"
-  CheckoutHandler.checkout ARGV, images
-
-elsif cmd == "status" or cmd =="st"
-  CheckoutHandler.status
-
-elsif cmd == "commit" or cmd =="ci"
-  CheckoutHandler.commit
-
-elsif cmd == "add"
-  CheckoutHandler.add ARGV
-
-elsif cmd == "remove" or cmd == "rm"
-  CheckoutHandler.remove ARGV
-
-else
-  STDERR.puts "Unknown command: #{cmd}\n"
-  STDERR.puts opt
-  exit 1
-end
+require 'ssc'
+SSC::Base.start

data/lib/directory_manager.rb

@@ -0,0 +1,194 @@
+module SSC
+  module DirectoryManager
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      def create_appliance_directory(appliance_dir, username, password, appliance_id)
+        FileUtils.mkdir_p(appliance_dir)
+        FileUtils.mkdir_p(File.join(appliance_dir, 'files'))
+        FileUtils.touch(File.join(appliance_dir, 'repositories'))
+        FileUtils.touch(File.join(appliance_dir, 'software'))
+        FileUtils.touch(File.join(appliance_dir, 'files/.file_list'))
+        File.open(File.join(appliance_dir, '.sscrc'), 'w') do |file|
+          file.write("username: #{username}\n"+
+                     "password: #{password}\n"+
+                     "appliance_id: #{appliance_id}")
+        end
+        File.join(Dir.pwd, appliance_dir)
+      end
+
+      def manage(local_source)
+        self.class.class_variable_set('@@appliance_directory', Dir.pwd)
+        if appliance_directory_valid?(Dir.pwd)
+          file= File.join(Dir.pwd, local_source)
+          self.class.class_variable_set('@@local_source', file) if File.exist?(file)
+        end
+      end
+
+      private
+
+      def appliance_directory_valid?(dir)
+        config_file= File.join(dir, '.sscrc')
+        File.exist?(config_file) && File.read(config_file).match(/appliance_id:\ *\d+/)
+      end
+
+    end
+
+    module InstanceMethods
+      include Thor::Actions
+
+      # Save data to local storage file
+      # @param [String] section The section of the document that is to be saved
+      # @param [Array] list The data in Array format which will be merged with existing data
+      def save(section, list)
+        safe_get_source_file do |source|
+	  parsed_file= YAML::load(File.read(source))
+          # YAML::load returns false if file is empty
+          parsed_file= {} unless parsed_file
+          final_list= list
+          if parsed_file[section]
+            current_list= parsed_file[section]
+            final_list= current_list | final_list
+          end
+          parsed_file[section]= final_list
+          File.open(source, 'w') {|f| f.write parsed_file.to_yaml}
+        end
+      end
+
+      # Reads data from the local storage file
+      # @param [String] section (optional) This is the top-level section
+      #	  of the storage file that is to be read. It can be left blank to 
+      #	  return all sections of the file
+      #	@return [String] Either the whole file of the specified section
+      def read(section = nil)
+        safe_get_source_file do |source|
+	  if section
+	    parsed_file= YAML::load(File.read(source))
+	    parsed_file[section]
+	  else
+	    File.read(source)
+	  end
+        end
+      end
+
+      private
+
+
+      # Wrapper to check existence of source file and other sanity checks 
+      # It takes a block with one argument - the path of the source file
+      def safe_get_source_file
+        source= self.class.class_variable_get('@@local_source')
+        source= File.join(Dir.pwd, source)
+        if File.exist?(source)
+          yield source
+        else
+          raise "Couldn't find the local source file" unless options.remote?
+        end
+      end
+
+      def find_file_id(file_name) 
+        file_list= File.join(self.class.class_variable_get('@@local_source'), '.file_list')
+        parsed_file= YAML::load(File.read(file_list))
+        if parsed_file["list"]
+          files= parsed_file["list"].select{|i| i.keys[0] == file_name}
+          if files.length < 1
+            raise ArgumentError, "file not found"
+          else
+            files[0][file_name]["id"]
+          end
+        else
+          raise ArgumentError, "file not found"
+        end
+      end
+
+      def full_local_file_path(file)
+        full_path= File.join(self.class.class_variable_get('@@local_source'), file)
+      end
+
+      def show_file(file)
+        full_path= full_local_file_path(file)
+        if File.exist?(full_path)
+          File.read(full_path)
+        else
+          raise ArgumentError, "file not found"
+        end
+      end
+
+      def find_diff(remote, local)
+        `diff #{remote} #{local}`
+      end
+
+      def initiate_file(file_dir, file_name, id)
+        source_file= File.join(file_dir, file_name)
+        destination_file= full_local_file_path(file_name)
+        file_list= File.join(self.class.class_variable_get('@@local_source'), '.file_list')
+        if File.exist?(source_file)
+          FileUtils.cp(source_file, destination_file)
+          parsed_file= YAML::load(File.read(file_list)) || {}
+          File.open(file_list, 'w') do  |f|
+            if id # if the file has been uploaded 
+              parsed_file['list']= [] unless parsed_file['list']
+              parsed_file['list'] |= [{file_name => {
+                                         "id" => id,  
+                                         "path" => file_dir}}]
+            else
+              parsed_file['add']= [] unless parsed_file['add']
+
+              parsed_file['add'] |= [{file_name => { 
+                                        "path" => file_dir}}]
+            end
+            f.write(parsed_file.to_yaml)
+          end
+          destination_file
+        else
+          raise ArgumentError, "File does not exist"
+        end
+      end
+
+      def list_local_files
+        source= self.class.class_variable_get('@@local_source')
+        parsed_file= YAML::load File.read(File.join(source, '.file_list'))
+        parsed_file = {} unless parsed_file
+        parsed_file["list"]
+      end
+
+      def parse_file_list
+        source= self.class.class_variable_get('@@local_source')
+        file_list= File.read(File.join(source, '.file_list'))
+        YAML::load(file_list)
+      end
+
+      def write_to_file(file, data)
+        written= []
+        existing_lines= file.readlines.collect{|i| i.strip}
+        file.write("\n") if existing_lines.last != '' and existing_lines != []
+        data.each do |line|
+          unless existing_lines.include?( line )
+            file.write(line+"\n") 
+            written << line
+          end
+        end
+      end
+
+      def file_list_empty?
+        safe_get_source_file do |source|
+          !YAML::load File.read(File.join(source, '.file_list'))
+        end
+      end
+
+      # Checks if the local source file has a list 
+      # @return [Boolean] true if there is no list
+      def no_local_list?
+        safe_get_source_file do |source|
+          list= YAML::load(File.read source)
+          !list || list == nil || list == {} || list == []
+        end
+      end
+
+    end
+  end
+end

data/lib/handlers/all.rb

@@ -0,0 +1,33 @@
+require 'studio_api'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module SSC::Handler; end
+
+require 'helper'
+
+module SSC
+  module Handler
+    class Base < Thor
+
+      include Helper
+      include DirectoryManager
+
+      API_URL= 'https://susestudio.com/api/v1/user'
+
+      def initialize(*args)
+        super
+
+        optional_connection_options= filter_options(options, [:timeout, :proxy])
+        connect(options.username, options.password, optional_connection_options)
+        @not_local= true if options.remote?
+      end
+    end
+  end
+end
+
+require 'appliance'
+require 'repository'
+require 'package'
+require 'template'
+require 'file'

data/lib/handlers/appliance.rb

@@ -0,0 +1,74 @@
+module SSC
+  module Handler
+    class Appliance < Base
+
+      desc "appliance create APPLIANCE_NAME", "Create an appliance"
+      require_authorization
+      method_option :source_id, :type => :numeric, :required => true
+      method_option :arch, :type => :string
+      def create(appliance_name)
+        appliance_dir= File.join('.', appliance_name) 
+        params= {:name => appliance_name}
+        params.merge!(:arch => options.arch) if options.arch
+        appliance= StudioApi::Appliance.clone(options.source_id, params)
+        appliance_dir= self.class.create_appliance_directory(appliance_dir, options.username, options.password, appliance.id)
+         say_array ["Created: ", appliance_dir, 
+         File.join(appliance_dir, 'files'),
+         File.join(appliance_dir, 'repositories'),
+         File.join(appliance_dir, 'software') ]
+      end
+      
+      desc "appliance list", "list all appliances"
+      require_authorization
+      def list
+        appliances= StudioApi::Appliance.find(:all)
+        print_table appliances.collect{|i| [i.id, i.name]}
+      end
+
+      desc "appliance info", "show details of a specific appliance"
+      require_appliance_id
+      def info
+        appliance= StudioApi::Appliance.find(options.appliance_id)
+        say_array ["#{appliance.id}: #{appliance.name}",
+         "Parent: ( #{appliance.parent.id} ) #{appliance.parent.name}",
+         "Download Url: #{download_url(appliance)}"]
+      end
+
+      desc "appliance destroy", "destroy the current appliance (within appliance directory only)"
+      require_appliance_id
+      def destroy
+        if appliance.destroy.code_type == Net::HTTPOK
+          say 'Appliance Successfully Destroyed', :red
+        else
+          say_array ['There was a problem with destroying the appliance.',
+           'Make sure that you\'re in the appliance directory OR',
+           'Have provided the --appliance_id option']
+        end
+      end
+
+      desc "appliance status", "gives status of the appliance"
+      require_appliance_id
+      def status
+        require_appliance do |appliance|
+          response= appliance.status
+          case response.state
+          when 'error'
+            say "Error: #{response.issues.issue.text}"
+          when 'ok'
+            say "Appliance Ok"
+          end
+        end
+      end
+
+      private
+
+      def download_url(appliance)
+        if appliance.builds.empty?
+          "No Build Yet"
+        else
+          appliance.builds.last.download_url
+        end
+      end
+    end
+  end
+end