ssc 0.2.0 → 0.3.0

data/Gemfile.lock

@@ -24,7 +24,7 @@ GEM
       activeresource (>= 2.3.8)
       xml-simple (>= 1.0.0)
     thor (0.14.6)
-    xml-simple (1.1.0)
+    xml-simple (1.0.15)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -4,15 +4,95 @@ This is the new version of the the Suse Studio command line client. Built as a p
 
 == Installing ssc
 
+=== The easy way
+    gem install ssc
+
 === Straight from the code
 * Checkout the code
 * In the checked out directory do `rake install`
 
-=== Ocassionally released packaged gems
-* Download 
+== Using ssc
+
+=== Command Listing
+
+ssc checkout --appliance-id=N --password=PASSWORD --username=USERNAME  # checkout the latest changes to an appliance
+ssc commit --appliance-id=N --password=PASSWORD --username=USERNAME    # commit changes to studio
+ssc status --appliance-id=N --password=PASSWORD --username=USERNAME    # show status of the appliance
+
+ssc appliance   # manage appliances
+
+    ssc appliance create APPLIANCE_NAME --password=PASSWORD --source-id=N --username=USERNAME  # Create an appliance
+    ssc appliance destroy --appliance-id=N --password=PASSWORD --username=USERNAME             # destroy the current appliance 
+    ssc appliance info --appliance-id=N --password=PASSWORD --username=USERNAME                # show details of a specific appliance
+    ssc appliance list --password=PASSWORD --username=USERNAME                                 # list all appliances
+    ssc appliance status --appliance-id=N --password=PASSWORD --username=USERNAME              # gives status of the appliance
+
+ssc package     # manage packages
+
+    ssc package add NAME --appliance-id=N --password=PASSWORD --username=USERNAME
+        # add a package to the appliance
+    ssc package ban NAME --appliance-id=N --password=PASSWORD --username=USERNAME
+        # ban a package from the appliance
+    ssc package list [selected|installed] --appliance-id=N --password=PASSWORD --username=USERNAME
+        # list all selected or installed packages
+    ssc package remove NAME --appliance-id=N --password=PASSWORD --username=USERNAME
+        # remove a package from the appliance
+    ssc package search SEARCH_STRING --appliance-id=N --password=PASSWORD --username=USERNAME
+        # search available packages and patterns
+    ssc package unban NAME --appliance-id=N --password=PASSWORD --username=USERNAME
+        # unban a package for the appliance
+
+ssc repository  # manage repositories
+    ssc repository add REPO_IDS --appliance-id=N --password=PASSWORD --username=USERNAME    
+        # add existing repositories to the appliance
+    ssc repository import URL NAME --password=PASSWORD --username=USERNAME
+        # import a 3rd party repository into appliance
+    ssc repository list --appliance-id=N --password=PASSWORD --username=USERNAME
+        # list all repositories in a given appliance
+    ssc repository remove REPO_IDS --appliance-id=N --password=PASSWORD --username=USERNAME 
+        # remove existing repositories from appliance
+    ssc repository search SEARCH_STRING --password=PASSWORD --username=USERNAME
+        # search all available repositories
+    
+
+ssc file        # manage files
+    ssc file add PATH --appliance-id=N --password=PASSWORD --username=USERNAME          # create a new overlay file
+    ssc file diff FILE_NAME --appliance-id=N --password=PASSWORD --username=USERNAME    
+        # show the diff of the remote file and the local one
+    ssc file list --appliance-id=N --password=PASSWORD --username=USERNAME              # show all overlay files
+    ssc file remove FILE_NAME --appliance-id=N --password=PASSWORD --username=USERNAME  # removes existing overlay file
+    ssc file show FILE_NAME --appliance-id=N --password=PASSWORD --username=USERNAME    # show the contents of the file
+
+
+ssc build       # manage builds 
+    ssc build --appliance-id=N --password=PASSWORD --username=USERNAME  # build an appliance
+    ssc list --appliance-id=N --password=PASSWORD --username=USERNAME   # list builds (running or completed)
+    ssc status --build-id=N --password=PASSWORD --username=USERNAME     # find the build status of an appliance
+
+ssc template    # manage templates
+  ssc template list SET_NAME --password=PASSWORD --username=USERNAME  # show details of a particular template set
+  ssc template list_sets --password=PASSWORD --username=USERNAME      # list all available template sets
+
+ssc help [TASK] # Describe available tasks or one specific task
+
+=== Examples
+
+* Creating and modifying a new appliance:
+    $ ssc appliance create web_server --source-id=SOURCE_APPLIANCE_ID --username=USERNAME --password=PASSWORD
+    $ cd web_server
+    $ ssc package list
+    $ ssc package add apache
+    $ ssc file add /etc/apache2/apache2.conf
+    $ ssc commit
+
+* Checking out an existing appliance and starting a build
+    $ ssc checkout --appliance-id 59836 --username=USERNAME --password=PASSWORD
+    $ cd APPLIANCE_NAME
+    $ ssc build
+    $ ssc build status
 
 == 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

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/ssc

@@ -3,4 +3,4 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'ssc'
-SSC::Base.start
+SSC::Client.start

data/lib/directory_manager.rb

@@ -1,194 +1,146 @@
 module SSC
   module DirectoryManager
+    class LocalStorageFile
 
-    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)
+      def initialize(file_name, path= nil)
+        path = path ? path : Dir.pwd
+        @location= File.join(path, file_name)
       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+/)
+      def valid?
+        File.exist?(@location)
       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
+      def read
+        # default error is informative enough if the file is not found
+        @parsed_file = @parsed_file || YAML::load(File.read(@location)) || {}
       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
+      def [](section)
+        read
+        if @parsed_file[section]
+          @parsed_file[section]
+        else
+          []
         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
+      def pop(section)
+        read
+        if @parsed_file[section].is_a?(Array)
+          @parsed_file[section].pop
         else
-          raise "Couldn't find the local source file" unless options.remote?
+          nil
         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
+      
+      def push(section, item)
+        read
+        if @parsed_file[section].is_a?(Array)
+          @parsed_file[section] |= [ item ]
         else
-          raise ArgumentError, "file not found"
+          @parsed_file[section] = [ item ]
         end
+        item
       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
+      def save
+        contents= @parsed_file.to_yaml
+        @parsed_file= nil
+        File.open(@location, 'w') {|f| f.write contents}
+        contents
       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
+      def empty_list?
+        read
+        (!@parsed_file['list']) || (@parsed_file['list'] == []) || (@parsed_file['list'] == {})
       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"]
+    class PackageFile < LocalStorageFile
+      def initialize(path= nil)
+        super("software", path)
       end
+    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)
+    class RepositoryFile < LocalStorageFile
+      def initialize(path= nil)
+        super("repositories", path)
       end
+    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
+    class FileListFile < LocalStorageFile
+      def initialize(path= nil)
+        super("files/.file_list", path)
+      end
+
+      def pop(section)
+        file_hash= super(section)
+        file_name= file_hash.keys[0]
+        file_hash= file_hash[file_name]
+        { :name      => file_name,
+          :full_path => File.join(file_hash["path"]),
+          :params    => file_hash.slice("owner", "group", "permissions")}
+      end
+
+      def initiate_file(path, options)
+        raise "Unknown file #{path}" unless File.exists?(path)
+        file_path, file_name= File.split(path)
+        file_path ||= options[:path]
+        destination_path= File.join(File.split(@location)[0], file_name)
+        FileUtils.cp(path, destination_path)
+        if options[:id]
+          push("list", {file_name => {
+            "id" => options[:id],
+            "path" => file_path }})
+        else
+          file_params= options.slice(:permissions, :group, :owner).merge(:path => file_path)
+          push("add", {file_name => file_params})
         end
+        destination_file
       end
 
-      def file_list_empty?
-        safe_get_source_file do |source|
-          !YAML::load File.read(File.join(source, '.file_list'))
-        end
+      def is_uploaded?(file_name)
+        read
+        list= @parsed_file["list"].select{|i| i.keys[0] == file_name}
+        list.length > 0 ? list[0]["id"].to_i : nil
       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
+
+    class ApplianceDirectory
+      attr_reader :path
+      attr_reader :files
+
+      def initialize(name= '', options = {})
+        @name= name
+	@path= File.join(Dir.pwd, name)
+        @files = if Dir.exist?(@path)
+                   {:package   => PackageFile.new(@path),
+                   :repository => RepositoryFile.new(@path),
+                   :file_list  => FileListFile.new(@path)}
+                 else
+                   {}
+                 end
+        @options= options
+      end
+
+      def create
+        FileUtils.mkdir_p(@name)
+        FileUtils.mkdir_p(File.join(@name, 'files'))
+        @files[:repository] = FileUtils.touch(File.join(@name, 'repositories'))[0]
+        @files[:package]    = FileUtils.touch(File.join(@name, 'software'))[0]
+        @files[:file_list]  = FileUtils.touch(File.join(@name, 'files/.file_list'))[0]
+        File.open(File.join(@name, '.sscrc'), 'w') do |file|
+          file.write(@options.stringify_keys.to_yaml)
         end
+        File.join(Dir.pwd, @name)
       end
 
+      def valid?
+	Dir.exists?(@path) && File.exists?(File.join(@path, '.sscrc'))
+      end
     end
   end
 end

data/lib/handlers/all.rb

@@ -11,7 +11,6 @@ module SSC
     class Base < Thor
 
       include Helper
-      include DirectoryManager
 
       API_URL= 'https://susestudio.com/api/v1/user'
 
@@ -22,10 +21,18 @@ module SSC
         connect(options.username, options.password, optional_connection_options)
         @not_local= true if options.remote?
       end
+
+      no_tasks do 
+        def say(*args)
+          super(*args)
+          args[0]
+        end
+      end
     end
   end
 end
 
+require 'build'
 require 'appliance'
 require 'repository'
 require 'package'

data/lib/handlers/appliance.rb

@@ -11,18 +11,20 @@ module SSC
         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') ]
+        appliance_params= {
+          :username => options.username,
+          :password => options.password,
+          :appliance_id => appliance.id }
+        appliance_dir= ApplianceDirectory.new(appliance_name, appliance_params)
+        appliance_dir.create
+        say_array(["Created: ", appliance_dir.path] + appliance_dir.files.values)
       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]}
+        print_table([["id", "name"]]+appliances.collect{|i| [i.id, i.name]})
       end
 
       desc "appliance info", "show details of a specific appliance"
@@ -37,12 +39,14 @@ module SSC
       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']
+        require_appliance do |appliance|
+          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
       end