ssc 0.1 → 0.2.0

data/lib/handlers/file.rb

@@ -0,0 +1,102 @@
+require 'tempfile'
+
+module SSC
+  module Handler
+    class OverlayFile < Base
+
+
+      no_tasks do
+        cattr_reader :local_source
+        @@local_source= 'files/'
+      end
+
+      # must be run in appliance directory
+      # takes the following argument:
+      # file_path => (relative positions("." and "..") allowed and ~ for home directory allowed)
+      # takes the following options:
+      # --path="/path/to/file_directory/"   => optional (by default it is the path of the file on the local system)
+      # --name="file_name"                  => optional (by default it is the name of the file on the local system)
+      # --permissions="0766"                => optional (default: 0755)
+      # --owner="user"                      => optional (default: root)
+      desc 'file create PATH', 'create a new overlay file'
+      require_appliance_id
+      allow_remote_option
+      method_option :path, :type => :string, :default => ''
+      method_option :name, :type => :string, :default => ''
+      method_option :permissions, :type => :string, :default => '0755'
+      method_option :owner, :type => :string, :default => 'root'
+      def create(path)
+        absolute_path= File.expand_path(path)
+        optional_file_params= {:permissions => options.permissions, 
+                               :owner => options.owner}
+        file_dir, file_name= File.split(absolute_path)
+        file_dir = options.path == '' ? file_dir : options.path
+        file_name = options.name == '' ? file_name : options.name
+        id= nil
+        if options.remote?
+          require_appliance do |appliance|
+            file_params= ({:path => file_dir, :filename => file_name})
+            file_params.merge!(optional_file_params)
+            File.open(absolute_path) do |file|
+              file= StudioApi::File.upload(file, appliance.id, file_params)
+              id= file.id.to_i
+            end
+            say "Overlay file saved. Id: #{id}"
+          end
+        end
+        local_copy= initiate_file(file_dir, file_name, id)
+        say "Created #{local_copy}"
+      end
+
+      desc 'file show FILE_NAME', 'show the contents of the file'
+      require_appliance_id
+      allow_remote_option
+      def show(file_name)
+        if options.remote?
+          id= find_file_id(file_name)
+          response= StudioApi::File.find(id)
+          say response.content
+        else
+          say show_file(file_name)
+        end
+      end
+
+      desc 'file diff FILE_NAME', 'show the diff of the remote file and the local one'
+      require_appliance_id
+      def diff(file_name)
+        begin
+          id= find_file_id(file_name)
+          file_content= StudioApi::File.find(id).content
+        rescue
+          say "unable to connect or not in appliance directory", :red
+        end
+
+        begin
+          tempfile=Tempfile.new('ssc_file') 
+          tempfile.write(file_content)
+          say find_diff(tempfile.path, full_local_file_path(file_name))
+          tempfile.close; tempfile.unlink
+        rescue Errno::ENOENT
+          say "diff not installed", :red
+        end
+      end
+
+      desc 'file list', 'show all overlay files'
+      require_appliance_id
+      allow_remote_option
+      def list
+        require_appliance do |appliance|
+          out= if options.remote? || file_list_empty?
+            response= StudioApi::File.find(:all, :params => {:appliance_id => appliance.id})
+            response.collect do |file|
+              {file.filename => {"id" => id, "path" => file.path}}
+            end
+          else
+            list_local_files
+          end
+          say out.to_yaml
+        end
+      end
+    end
+  end
+end

data/lib/handlers/helper.rb

@@ -0,0 +1,79 @@
+require 'yaml'
+
+module SSC
+  module Handler
+    module Helper
+
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+
+        end
+        base.send :include, InstanceMethods
+      end
+
+      module ClassMethods
+        def require_authorization
+          config= get_config
+          method_option :username, :type => :string, :required => true, 
+            :default => config["username"]
+          method_option :password, :type => :string, :required => true, 
+            :default => config["password"]
+          method_option :proxy, :type => :string
+          method_option :timeout, :type => :string
+        end
+
+        def require_appliance_id
+          require_authorization
+          config= get_config
+          method_option :appliance_id, :type => :numeric, :required => true,
+            :default => config["appliance_id"]
+        end
+
+        def allow_remote_option
+          method_option :remote, :type => :boolean, :default => false
+        end
+
+        def get_config
+          begin
+            YAML::load File.read(File.join('.', '.sscrc'))
+          rescue Errno::ENOENT
+            return {'username' => nil, 'password' => nil, 'appliance_id' => nil}
+          end
+        end
+      end
+
+      module InstanceMethods
+
+        # Establish connection to Suse Studio with username, password
+        def connect(user, pass, connection_options)
+          @connection= StudioApi::Connection.new(user, pass, self.class::API_URL, connection_options)
+          StudioApi::Util.configure_studio_connection @connection
+        end
+
+        def filter_options(options, keys)
+          keys.inject({}) do |out, key|
+            (options.respond_to?(key) && options.send(key)) ? out.merge({ key => options.send(key) }) : out
+          end
+        end
+
+        def say_array(array, color= nil)
+          # NOTE
+          # Included for those methods that still return arrays for printing
+          # Can be removed eventually
+          # Still seems to be a nice way to format the text output of methods
+          say array.join("\n"), color
+        end
+
+        def require_appliance
+          if options.appliance_id
+            yield(StudioApi::Appliance.find(options.appliance_id))
+          else
+            raise "Unable to find the appliance"
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/handlers/package.rb

@@ -0,0 +1,153 @@
+module SSC
+  module Handler
+    class Package < Base
+
+      # Structure of the 'software' file:
+      #
+      # ---
+      # list:
+      #   installed:
+      #     <name>:
+      #       version: <package.version>
+      #     .
+      #     .
+      #     .
+      #   selected:
+      #     <name>: 
+      #     .
+      #     .
+      #     .
+      # add:
+      #   <name>
+      #   .
+      #   .
+      #   .
+      # remove:
+      #   <name>
+      #   .
+      #   .
+      #   .
+      # ban:
+      #   <name>
+      #   .
+      #   .
+      #   .
+      # unban:
+      #   <name>
+      #   .
+      #   .
+      #   .
+
+      no_tasks do 
+        cattr_reader :local_source
+        @@local_source= 'software'
+      end
+
+      desc 'package search SEARCH_STRING', 'search available packages and patterns'
+      require_appliance_id
+      method_option :all_repos, :type => :boolean, :default => true
+      def search(search_string)
+        require_appliance_id(@options) do |appliance|
+          params= {:all_repos => options.all_repos} if options.all_repos
+          software= appliance.search_software(search_string, params)
+          say_array software.collect do |software|
+            "#{software.name} v#{software.version}. Repo Id: #{software.repository_id}"
+          end
+        end
+      end
+
+      desc 'package list [selected|installed]', 'list all selected or installed packages'
+      require_appliance_id
+      allow_remote_option
+      method_option :build_id, :type => :numeric
+      def list(type)
+        say("installed | selected package only", :red) unless ['installed', 'selected'].include?(type)
+        out= if options.remote? || no_local_list?
+          require_appliance do |appliance|
+            params= {:build_id => options.build_id} if options.build_id
+            software= appliance.send("#{type}_software")
+            formatted_list= software.collect do |package|
+              version= package.version ? { "version" => package.version } : nil
+              {package.name => version}
+            end
+            save(type, formatted_list)
+            formatted_list
+          end
+        else
+          read(type)
+        end
+        say out.to_yaml
+      end
+
+
+      desc 'package add NAME', 'add a package to the appliance'
+      require_appliance_id
+      allow_remote_option
+      def add(name)
+        if options.remote?
+          require_appliance do |appliance|
+            response= appliance.add_package(name)
+            say case response['state']
+            when "fixed"
+              "Package Added. State: #{response['state']}"
+            when "equal"
+              "Package Not Added."
+            when "broken"
+              "Package Added. State: #{response['state']}. Please resolve dependencies"
+            else
+              "unknown code"
+            end
+          end
+        else
+          save("add", [ name ])
+          say "#{name} marked for addition"
+        end
+      end
+
+      desc 'package remove NAME', 'remove a package from the appliance'
+      require_appliance_id
+      allow_remote_option
+      def remove(name)
+        if options.remote?
+          require_appliance do |appliance|
+            response= appliance.remove_package(name)
+            say "State: #{response['state']}"
+          end
+        else
+          save("remove", [ name ])
+          say "#{name} marked for removal"
+        end
+      end
+
+      desc 'package ban NAME', 'ban a package from the appliance'
+      require_appliance_id
+      allow_remote_option
+      def ban(name)
+        if options.remote?
+          require_appliance do |appliance|
+            response= appliance.ban_package(name)
+            response.collect{|key, val| "#{key}: #{val}"}
+          end
+        else
+          save("ban", [ name ])
+          say "#{name} marked to be banned"
+        end
+      end
+
+      desc 'package unban NAME', 'unban a package for the appliance'
+      require_appliance_id
+      allow_remote_option
+      def unban(name)
+        if options.remote?
+          require_appliance do |appliance|
+            response= appliance.unban_package(name)
+            response.collect{|key, val| "#{key}: #{val}"}
+          end
+        else
+          save("unban", [ name ])
+          say "#{name} marked to be unbanned"
+        end
+      end
+    end
+  end
+end

data/lib/handlers/repository.rb

@@ -0,0 +1,109 @@
+module SSC
+  module Handler
+    class Repository < Base
+
+      # Structure of the 'repositories' file:
+      #
+      # ---
+      # list:
+      #   <id>:
+      #     name: <repo.name>
+      #     type: <repo.type>
+      #     base_system: <repo.base_url>
+      #   .
+      #   .
+      #   .
+      # add:
+      #   <id>
+      #   .
+      #   .
+      #   .
+      # remove:
+      #   <id>
+      #   .
+      #   .
+      #   .
+      # import:
+      #   name: <name>
+      #   url: <url>
+      no_tasks do
+        cattr_reader :local_source
+        @@local_source= 'repositories'
+      end
+
+      desc "repository search SEARCH_STRING", "search all available repositories"
+      require_authorization
+      method_option :base_system, :type => :string
+      def search(search_string)
+        params= {:filter => search_string}
+        params= params.merge({:base_system => options.base_system}) if options.base_system
+        repos= StudioApi::Repository.find(:all, :params => params)
+        say_array(repos.collect do |repo|
+          "#{repo.id}.) #{repo.name}: #{repo.base_url}
+          #{[repo.matches.software_name].flatten.join(', ')}\n"
+        end)
+      end
+
+      desc "repository list", "list all repositories in a given appliance"
+      require_appliance_id
+      allow_remote_option
+      def list
+        list= if options.remote? || no_local_list?
+          require_appliance do |appliance|
+            appliance.repositories.collect do |repo|
+              { repo.id => { 'name'        => repo.name, 
+                             'type'        => repo.type, 
+                             'base_system' => repo.base_system}}
+            end
+          end
+        else
+          read('list')
+        end
+        save('list', list) unless options.remote?
+        say list.to_yaml
+      end
+
+      desc 'repository add REPO_IDS', 'add existing repositories to the appliance'
+      require_appliance_id
+      allow_remote_option
+      def add(*repo_ids)
+        if options.remote?
+          require_appliance do |appliance|
+            response= appliance.add_repository(repo_ids)
+            say "Added"+( response.collect{|repos| repos.name} ).join(", ")
+          end
+        else
+          save('add', repo_ids)
+          say "Marked the following for addition #{repo_ids.join(", ")}"
+        end
+      end
+
+      desc 'repository remove REPO_IDS', 'remove existing repositories from appliance'
+      require_appliance_id
+      allow_remote_option
+      def remove(*repo_ids)
+        if options.remote?
+          require_appliance do |appliance|
+            response= appliance.remove_repository(repo_ids)
+            say "Removed #{repo_ids.join(", ")}"
+          end
+        else
+          save('remove', repo_ids)
+          say "Marked the following for removal #{repo_ids.join(", ")}"
+        end
+      end
+
+      desc 'repository import URL NAME', 'import a 3rd party repository into appliance'
+      allow_remote_option
+      def import(url, name) 
+        if options.remote?
+          repository= StudioApi::Repository.import(url, name)
+          say "Added #{repository.name} at #{url}"
+        else
+          save("import", [{"name" => name, "url" => url}])
+          say "Marked #{name} for import"
+        end
+      end
+    end
+  end
+end

data/lib/handlers/template.rb

@@ -0,0 +1,25 @@
+module SSC
+  module Handler
+    class Template < Base
+
+      desc 'template list_sets', 'list all available template sets'
+      require_authorization
+      def list_sets
+        templates= StudioApi::TemplateSet.find(:all)
+        say_array templates.collect {|template| template.name}
+      end
+
+      desc 'template list SET_NAME', 'show details of a particular template set'
+      require_authorization
+      def list(name)
+        template_set= StudioApi::TemplateSet.find(name)
+        out = [template_set.name+' : '+template_set.description]
+        out += template_set.template.collect do |appliance| 
+          "#{appliance.appliance_id}: #{appliance.name}"
+        end
+        say_array out
+      end
+    end
+  end
+
+end

data/lib/ssc.rb

@@ -0,0 +1,18 @@
+module SSC
+end
+
+require 'thor'
+require 'thor/group'
+require 'directory_manager'
+require 'handlers/all'
+require 'yaml'
+
+module SSC
+  class Base < Thor
+    register Handler::Appliance, :appliance, "appliance", "manage appliances"
+    register Handler::Repository, :repository, "repository","manage repositories"
+    register Handler::Package, :package, "package", "manage packages"
+    register Handler::Template, :template, "template", "manage templates"
+    register Handler::OverlayFile, :file, "file", "manage files"
+  end
+end

data/test/handlers/test_appliance.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestHandlerAppliance < Test::Unit::TestCase
+  context "SSC::Handler::Template" do
+    context "#list" do
+      setup do
+        @handler= SSC::Handler::Appliance.new()
+        @handler.stubs(:connect)
+      end
+
+      should "call find(:all) on StudioApi::Appliance" do
+        mock_app_list= mock('appliance list')
+        mock_app_list.stubs(:collect)
+        mock_app_list.stubs(:empty?)
+        StudioApi::Appliance.expects(:find).with(:all).returns(mock_app_list)
+        @handler.list
+      end
+    end
+  end
+end

data/test/handlers/test_helper.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestHandlerHelper < Test::Unit::TestCase
+  context "SSC::Handler::Helper" do
+    setup do
+      class TestObject
+        include SSC::Handler::Helper
+      end
+
+      @objekt= TestObject.new
+    end
+
+    context "#connect" do
+      should "create connection and configure StudioApi to use it" do
+        mock_connection= mock('connection')
+        StudioApi::Connection.expects(:new)
+          .with('user', 'pass', 'https://susestudio.com/api/v1/user', 
+                {:proxy => 'proxy'})
+          .returns(mock_connection)
+        StudioApi::Util.expects(:configure_studio_connection).with(mock_connection)
+        @objekt.connect('user', 'pass', {:proxy => 'proxy', :another_option => 'value'})
+      end
+    end
+
+    context "#filter_options" do
+      should "return a hash of only the specified keys" do
+        out= @objekt.filter_options({:a => 'a', :b => 'b'}, [:a])
+        assert_equal({:a => 'a'}, out)
+      end
+    end
+
+    context "#require_appliance_id" do
+      should "raise and error if the appliance id option is not passed" do
+        assert_raise(RuntimeError) { @objekt.require_appliance_id({}) }
+      end
+
+      should "not raise error if appliance id is provided" do
+        StudioApi::Appliance.expects(:find).with(1).returns(nil)
+        assert_nothing_raised do 
+          @objekt.require_appliance_id(:appliance_id=>1) {|i| i}
+        end
+      end
+    end
+  end
+end

data/test/handlers/test_repository.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestHandlerRepository < Test::Unit::TestCase
+  context "SSC::Handler::Repository" do
+    setup do
+      @handler= SSC::Handler::Repository.new()
+      @handler.stubs(:connect)
+    end
+    context "#search" do
+
+      should "call .find(:all, params_hash) on StudioApi::Repository" do
+        mock_collection= mock('collection')
+        mock_collection.stubs(:collect)
+        StudioApi::Repository.expects(:find).with(:all, :params => {:filter => 'chess', :base_system => '11.1'}).returns(mock_collection)
+        @handler.instance_variable_set('@options', {:base_system => '11.1'})
+        @handler.search('chess')
+      end
+    end
+  end
+end

data/test/handlers/test_template.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class TestTemplateHandler < Test::Unit::TestCase
+  context "SSC::Handler::Template" do
+    context "#list" do
+      setup do
+        @handler= SSC::Handler::Template.new()
+        @handler.stubs(:connect)
+      end
+
+      should "call .find(:all) on StudioApi::TemplateSet" do
+        mock_template= mock('template_list')
+        mock_template.stubs(:collect)
+        StudioApi::TemplateSet.expects(:find).with(:all).returns(mock_template)
+        @handler.list
+      end
+
+      should "return a list of strings of type 'template.id: template.name'" do
+        mock_template= StudioApi::TemplateSet.new(:name => 'Template Name')
+        StudioApi::TemplateSet.stubs(:find).with(:all).returns([mock_template])
+        assert_equal ["Template Name"],
+          @handler.list
+      end
+
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+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 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ssc'
+
+class Test::Unit::TestCase
+end

data/test/test_argument_parser.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+class TestArgumentParser < Test::Unit::TestCase
+  context "SSC::ArgumentParser" do
+  
+    context "when arguments are good" do
+      setup do
+        @parser= SSC::ArgumentParser.new(['appliance', 'create', 'act_arg1', 'act_arg2', '--option', 'value', '-o', 'v', '--flag', '-f'])
+      end
+
+      should "set @klass to Appliance" do
+        assert_equal SSC::Handler::Appliance, @parser.klass
+      end
+
+      should "set @action to create" do
+        assert_equal 'create', @parser.action
+      end
+
+      should "set @options to option hash" do
+        assert_equal({:option => 'value',
+                      :o      => 'v',
+                      :flag   => true,
+                      :f      => true }, @parser.options)
+      end
+
+      should "set @action_arguments to argument array" do
+        #only one of the arguments must be taken since create take only one argument
+	assert_equal(['act_arg1'], @parser.action_arguments)
+      end
+
+      should "have the entire list if arity of the method is -1(splat)" do
+        parser= SSC::ArgumentParser.new(['repository', 'add', 'act_arg1', 'act_arg2'])
+        assert_equal(['act_arg1', 'act_arg2'], parser.action_arguments )
+      end
+
+    end
+  end
+
+  context "when handler is unknown" do
+    should "raise UnkownOptionError" do
+      assert_raise(SSC::UnkownOptionError) do
+        SSC::ArgumentParser.new(['apliance', 'create'])
+      end
+    end
+  end
+
+  context "when handler method is unknown" do
+    should "raise UnkownOptionError" do
+      assert_raise(SSC::UnkownOptionError) do
+        SSC::ArgumentParser.new(['appliance', 'unkown_method'])
+      end
+    end
+  end
+
+end