cifrado 0.1 → 0.1.1

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+# Cifrado 0.1.1 - Sun 03 Mar 2013
+
+* saio command improvements
+  * flavors: list flavors available
+  * images:  list images available
+  * regions: list regions available
+* Also added --disk-size bootstrap option to tweak the size
+  of the disk image created for Swift storage while bootstraping.
+* Bootstrap now prints copy&paste ready configuration for cifrado.
+
+
+```
+SLOC  Directory SLOC-by-Language (Sorted)
+2057    lib             ruby=1742,sh=315
+983     tests           ruby=983
+
+
+Totals grouped by language (dominant language first):
+ruby:          2725 (89.64%)
+sh:             315 (10.36%)
+
+
+
+
+Total Physical Source Lines of Code (SLOC)                = 3,040
+Development Effort Estimate, Person-Years (Person-Months) = 0.64 (7.71)
+ (Basic COCOMO model, Person-Months = 2.4 * (KSLOC**1.05))
+Schedule Estimate, Years (Months)                         = 0.45 (5.43)
+ (Basic COCOMO model, Months = 2.5 * (person-months**0.38))
+Estimated Average Number of Developers (Effort/Schedule)  = 1.42
+Total Estimated Cost to Develop                           = $ 86,828
+ (average salary = $56,286/year, overhead = 2.40).
+SLOCCount, Copyright (C) 2001-2004 David A. Wheeler
+SLOCCount is Open Source Software/Free Software, licensed under the GNU GPL.
+```
+
 # Cifrado 0.1 - Sun 03 Mar 2013
 
 * Uploading/downloading files and directories to OpenStack Swift.

data/README.md

@@ -28,6 +28,8 @@ OpenStack Swift CLI with built in (GPG) encryption.
 Cifrado has a built-in help command:
 
 ```
+$ cifrado help
+
 Tasks:
   cifrado cinema CONTAINER VIDEO              # Stream videos from the target container
   cifrado delete CONTAINER [OBJECT]           # Delete specific container or object
@@ -95,12 +97,12 @@ Install the gem:
 If you already have a Swift installation running,
 you can use 'cifrado setup' to configure Cifrado for the first time.
 
-Note that it's not strictly required to save the options or running the
-setup process. If you do so, you'll not be asked for the username,
+The setup process is optional but highly recommended.
+If you run setup, you won't be asked for the username,
 password, auth_url and other parameters required to run Cifrado.
 
-The setup command will ask you the OpenStack Swift authentication 
-information:
+The setup command will ask you for the OpenStack Swift authentication
+parameters:
 
     $ cifrado setup
     Running cifrado setup...
@@ -116,7 +118,7 @@ information:
     Auth URL: https://identity.example.net/v2.0/tokens
     Do you want to save these settings? (y/n)  
 
-There's an alternative way to setup cifrado and provision a Swift All-In-One
+There's an alternative way to setup Cifrado and provision a Swift All-In-One
 server for testing and/or personal use. Head over to the Wiki for more
 details.
 

data/lib/cifrado/cli/saio/base.rb

@@ -1,20 +1,23 @@
 module Cifrado
-  class Saio < Thor
-    include Cifrado::Utils
+  module Plugins
+    class Saio < Thor
+      include Cifrado::Utils
 
-    class_option :provider,     :type => :string
-    class_option :api_key,      :type => :string, :required => true
-    class_option :client_id,    :type => :string, :required => true
-    
-    private
-    def service
-      return @service if @service
-      client_id = options[:client_id]
-      api_key   = options[:api_key]
-      @service = Fog::Compute.new :provider => 'DigitalOcean',
-                                  :digitalocean_api_key   => api_key,
-                                  :digitalocean_client_id => client_id
-    end
+      class_option :provider,     :type => :string
+      class_option :api_key,      :type => :string, :required => true
+      class_option :client_id,    :type => :string, :required => true
+
+      no_tasks do
+        def service
+          return @service if @service
+          client_id = options[:client_id]
+          api_key   = options[:api_key]
+          @service = Fog::Compute.new :provider => 'DigitalOcean',
+                                      :digitalocean_api_key   => api_key,
+                                      :digitalocean_client_id => client_id
+        end
+      end
 
+    end
   end
 end

data/lib/cifrado/cli/saio/bootstrap.rb

@@ -1,118 +1,143 @@
 module Cifrado
-  class Saio < Thor
-    
-    desc 'bootstrap', 'Bootstrap a Swift All-In-One installation'
-    option :server_name,    :type => :string, :default => 'cifrado-saio'
-    option :ssh_key_name,   :type => :string, :required => true
-    option :save_settings,  :type => :boolean
-    option :bootstrap_debug, :type => :boolean
-    def bootstrap
-      require 'shexy'
-
-      Log.level = Logger::DEBUG if options[:bootstrap_debug]
-
-      begin
-        available_keys = service.list_ssh_keys.body['ssh_keys']
-        key = available_keys.find { |k| k['name'] == options[:ssh_key_name] }
-        unless key 
-          raise "SSH key #{options[:ssh_key_name]} not available."
-        end
+  module Plugins
+    class Saio < Thor
+      
+      desc 'bootstrap', 'Bootstrap a Swift All-In-One installation'
+      option :server_name,     :type => :string, :default => 'cifrado-saio'
+      option :ssh_key_name,    :type => :string, :required => true
+      option :save_settings,   :type => :boolean
+      option :bootstrap_debug, :type => :boolean
+      option :disk_size, 
+             :type => :numeric,
+             :default => 15,
+             :desc => 'Virtual disk size for Swift (in GB)'
+      option :flavor,          
+             :type => :string,
+             :desc => 'Flavor name to use when bootstraping',
+             :default => '512MB'
+      option :image,          
+             :type => :string,
+             :desc => 'Image name to use when bootstraping',
+             :default => 'Ubuntu 12.04 x64 Server'
+      option :region,          
+             :type => :string,
+             :desc => 'Region name to use when bootstraping',
+             :default => 'New York 1'
+      def bootstrap
+        require 'shexy'
 
-        server_name = options[:server_name]
-        server = service.servers.find { |s| s.name == server_name }
-        if server
-          raise "Server #{server_name} is currently running."
-        end
+        Log.level = Logger::DEBUG if options[:bootstrap_debug]
 
-        flavor = service.flavors.find { |f| f.name == '512MB' }
-        image = service.images.find { |i| i.name == 'Ubuntu 12.04 x64 Server' }
-        region = service.regions.first
-        Log.info "Creating server #{server_name}..."
-        server = service.servers.create :name        => options[:server_name],
-                                        :image_id    => image.id,
-                                        :flavor_id   => flavor.id,
-                                        :region_id   => region.id,
-                                        :ssh_key_ids => key['id']
-        Log.info "Server provisioned, waiting for IP..."
-        server.wait_for(120) { ip_address }
-        Log.info "Server IP: #{server.ip_address}"
-
-        #
-        # Copy the provisioning script to the server
-        #
-        Shexy.host = server.ip_address
-        Shexy.user = 'root'
-        Shexy.flags = { :paranoid => false }
-        Log.info 'Waiting for SSH...'
-        Shexy.wait_for_ssh(90)
-        Log.info 'Bootstraping Swift All-In-One (this may take a while)...'
-
-        if RUBY_VERSION >= '1.9'
-          secure_random = SecureRandom.hex.encode('UTF-8')
-          user_password = SecureRandom.hex.encode('UTF-8')
-        else
-          user_password = SecureRandom.hex
-          secure_random = SecureRandom.hex
-        end
-      
-        script = bootstrap_script(user_password)
-        Shexy.copy_to script, '/root/saio.sh'
+        begin
+          available_keys = service.list_ssh_keys.body['ssh_keys']
+          key = available_keys.find { |k| k['name'] == options[:ssh_key_name] }
+          unless key 
+            raise "SSH key #{options[:ssh_key_name]} not available."
+          end
 
-        # Provision Swift+Keystone
-        Shexy.exe '/bin/bash /root/saio.sh' do |out, err|
-          out.each_line { |l| Log.debug l } 
-        end
+          server_name = options[:server_name]
+          server = service.servers.find { |s| s.name == server_name }
+          if server
+            raise "Server #{server_name} is currently running."
+          end
+
+          flavor = service.flavors.find { |f| f.name == options[:flavor] }
+          image = service.images.find { |i| i.name == options[:image] }
+          region = service.regions.find { |r| r.name == options[:region] }
+
+          unless image and flavor and region
+            raise "The specified image, flavor or region was not found"
+          end
+
+          Log.info "Creating server #{server_name}..."
+          server = service.servers.create :name        => options[:server_name],
+                                          :image_id    => image.id,
+                                          :flavor_id   => flavor.id,
+                                          :region_id   => region.id,
+                                          :ssh_key_ids => key['id']
+          Log.info "Server provisioned, waiting for IP..."
+          server.wait_for(120) { ip_address }
+          Log.info "Server IP: #{server.ip_address}"
+
+          #
+          # Copy the provisioning script to the server
+          #
+          Shexy.host = server.ip_address
+          Shexy.user = 'root'
+          Shexy.flags = { :paranoid => false }
+          Log.info 'Waiting for SSH...'
+          Shexy.wait_for_ssh(90)
+          Log.info 'Bootstraping Swift All-In-One (this may take a while)...'
 
-        config = {
-          :auth_url => "https://#{server.ip_address}:5000/v2.0/tokens",
-          :username => 'admin',
-          :tenant   => 'admin',
-          :password => user_password,
-          :secure_random => secure_random
-        }
-
-        # Provisioning finished, print details
-        Log.info
-        Log.info 'Swift is ready. Login details:'
-        Log.info
-        Log.info "auth_url:      https://#{server.ip_address}:5000/v2.0/tokens"
-        Log.info "username:      admin"
-        Log.info "tenant:        admin"
-        Log.info "password:      #{user_password}"
-        Log.info "secure_random: #{secure_random}"
-        Log.info
-
-        save_settings(config) if options[:save_settings]
-      rescue Excon::Errors::Found => e
-        raise "Authentication failed"
+          if RUBY_VERSION >= '1.9'
+            secure_random = SecureRandom.hex.encode('UTF-8')
+            user_password = SecureRandom.hex.encode('UTF-8')
+          else
+            user_password = SecureRandom.hex
+            secure_random = SecureRandom.hex
+          end
+        
+          script = bootstrap_script(user_password, options[:disk_size])
+          Shexy.copy_to script, '/root/saio.sh'
+
+          # Provision Swift+Keystone
+          Shexy.exe '/bin/bash /root/saio.sh' do |out, err|
+            out.each_line { |l| Log.debug l } 
+          end
+
+          config = {
+            :auth_url => "https://#{server.ip_address}:5000/v2.0/tokens",
+            :username => 'admin',
+            :tenant   => 'admin',
+            :password => user_password,
+            :secure_random => secure_random
+          }
+
+          # Provisioning finished, print details
+          Log.info
+          Log.info 'Swift is ready. Login details:'
+          Log.info
+          Log.info "---"
+          Log.info ":auth_url:      https://#{server.ip_address}:5000/v2.0/tokens"
+          Log.info ":username:      admin"
+          Log.info ":tenant:        admin"
+          Log.info ":password:      #{user_password}"
+          Log.info ":secure_random: #{secure_random}"
+          Log.info
+
+          save_settings(config) if options[:save_settings]
+        rescue Excon::Errors::Found => e
+          raise "Authentication failed"
+        end
+        server
       end
-    end
 
-    private
-    def save_settings(config)
-      config_file = File.join(ENV['HOME'], '.config/cifrado/cifradorc')
-      FileUtils.mkdir_p File.join(ENV['HOME'], '.config/cifrado')
-      if File.exist?(config_file)
-        raise 'Cifrado config file exists. Refusing to overwrite.'
-      else
-        Log.info "Saving settings to #{config_file} as requested."
-        File.open config_file, 'w' do |f|
-          f.puts config.to_yaml
+      private
+      def save_settings(config)
+        config_file = File.join(ENV['HOME'], '.config/cifrado/cifradorc')
+        FileUtils.mkdir_p File.join(ENV['HOME'], '.config/cifrado')
+        if File.exist?(config_file)
+          raise 'Cifrado config file exists. Refusing to overwrite.'
+        else
+          Log.info "Saving settings to #{config_file} as requested."
+          File.open config_file, 'w' do |f|
+            f.puts config.to_yaml
+          end
         end
       end
-    end
 
-    def bootstrap_script(password)
-      require 'erb'
-      template = File.join(File.dirname(__FILE__), 'scripts/saio.sh.erb')
-      result = ERB.new(File.read(template)).result(binding)
-      tmpfile = "/tmp/#{SecureRandom.hex}"
-      File.open tmpfile, 'w' do |f|
-        f.puts result
+      def bootstrap_script(password, disk_size = 15)
+        require 'erb'
+        template = File.join(File.dirname(__FILE__), 'scripts/saio.sh.erb')
+        result = ERB.new(File.read(template)).result(binding)
+        tmpfile = "/tmp/#{SecureRandom.hex}"
+        File.open tmpfile, 'w' do |f|
+          f.puts result
+        end
+        tmpfile
       end
-      tmpfile
-    end
 
+    end
   end
 end
 

data/lib/cifrado/cli/saio/destroy.rb

@@ -1,16 +1,21 @@
 module Cifrado
-  class Saio < Thor
+  module Plugins
+    class Saio < Thor
 
-    desc 'destroy', 'Destroy bootstrapped server'
-    option :server_name,  :type => :string, :default => 'cifrado-saio'
-    def destroy
-      s = service.servers.find {|s| s.name == options[:server_name] }
-      if s
-        Log.info "Destroying server #{options[:server_name]}."
-        s.destroy 
+      desc 'destroy', 'Destroy bootstrapped server'
+      option :server_name,  :type => :string, :default => 'cifrado-saio'
+      def destroy
+        s = service.servers.find {|s| s.name == options[:server_name] }
+        if s
+          Log.info "Destroying server #{options[:server_name]}."
+          s.destroy 
+          true
+        else
+          false
+        end
       end
-    end
 
+    end
   end
 end
 

data/lib/cifrado/cli/saio/flavors.rb

@@ -0,0 +1,17 @@
+module Cifrado
+  module Plugins
+    class Saio
+      
+      desc 'flavors', 'List image flavors available'
+      def flavors
+        flavors = service.flavors.all
+        flavors.each do |f|
+          Log.info "[#{f.id}]".ljust(5) + "  #{f.name}"
+        end
+        flavors
+      end
+
+    end
+  end
+end
+

data/lib/cifrado/cli/saio/images.rb

@@ -0,0 +1,17 @@
+module Cifrado
+  module Plugins
+    class Saio
+      
+      desc 'images', 'List images available'
+      def images
+        images = service.images.all
+        images.each do |i|
+          Log.info "[#{i.id}]".ljust(10) + "  #{i.name}"
+        end
+        images
+      end
+
+    end
+  end
+end
+

data/lib/cifrado/cli/saio/regions.rb

@@ -0,0 +1,17 @@
+module Cifrado
+  module Plugins
+    class Saio
+      
+      desc 'regions', 'List regions available'
+      def regions
+        regions = service.regions.all
+        service.regions.each do |r|
+          Log.info "[#{r.id}]".ljust(10) + "  #{r.name}"
+        end
+        regions
+      end
+
+    end
+  end
+end
+

data/lib/cifrado/cli/saio/scripts/saio.sh.erb

@@ -5,7 +5,7 @@ set -e
 # SETUP VARIABLES
 # 
 # In GB
-SWIFT_DISK_SIZE=15
+SWIFT_DISK_SIZE=<%= disk_size %>
 # keystone variables
 PASSWORD=<%= password %>
 KROLE=admin

data/lib/cifrado/cli/saio.rb

@@ -3,9 +3,12 @@ require 'cifrado/cli/saio/base'
 module Cifrado
   class CLI
     desc "saio SUBCOMMAND ...ARGS", "Bootstrap a Swift installation"
-    subcommand "saio", Saio
+    subcommand "saio", Cifrado::Plugins::Saio
   end
 end
 
 require 'cifrado/cli/saio/bootstrap'
 require 'cifrado/cli/saio/destroy'
+require 'cifrado/cli/saio/flavors'
+require 'cifrado/cli/saio/images'
+require 'cifrado/cli/saio/regions'

data/lib/cifrado/version.rb

@@ -1,3 +1,3 @@
 module Cifrado
-  VERSION = "0.1"
+  VERSION = "0.1.1"
 end

data/tests/helper.rb

@@ -11,6 +11,10 @@ unless ENV['DEBUG']
   Cifrado::Log.level = Logger::ERROR
 end
 
+def fog_settings
+  YAML.load_file(File.expand_path('~/.fog'))[:default]
+end
+
 def client
   conf = YAML.load_file File.expand_path("~/.config/cifrado/cifradorc")
   client = SwiftClient.new  :username => conf[:username],

data/tests/saio/bootstrap_tests.rb

@@ -0,0 +1,35 @@
+Shindo.tests('Cifrado | CLI#saio', ['expensive']) do
+
+  tests '#bootstrap' do
+
+    Cifrado::Plugins::Saio.class_options[:api_key] = \
+      Thor::Option.parse :api_key, fog_settings[:digitalocean_api_key]
+    Cifrado::Plugins::Saio.class_options[:client_id] = \
+      Thor::Option.parse :client_id, fog_settings[:digitalocean_client_id]
+    cli = Cifrado::Plugins::Saio.new 
+
+    test '512MB image' do
+      #
+      # FIXME: find a way to test default options
+      #
+      cli.options = {
+        :client_id => fog_settings[:digitalocean_client_id],
+        :api_key => fog_settings[:digitalocean_api_key],
+        :ssh_key_name => 'personal',
+        :server_name => 'cifrado-saio-tests',
+        :flavor => '512MB',
+        :region => 'New York 1',
+        :image  => 'Ubuntu 12.04 x64 Server',
+        :disk_size => 15,
+      }.merge(cli.options)
+      @server = cli.bootstrap
+      !(cli.service.servers.find { |s| s.name == @server.name }).nil?
+    end
+
+    test 'destroy server' do
+      @server.destroy.status == 200
+    end
+
+  end
+
+end

data/tests/saio/flavors_tests.rb

@@ -0,0 +1,14 @@
+Shindo.tests('Cifrado | CLI#saio') do
+
+  tests '#flavors' do
+    test 'list' do
+      Cifrado::Plugins::Saio.class_options[:api_key] = \
+        Thor::Option.parse :api_key, fog_settings[:digitalocean_api_key]
+      Cifrado::Plugins::Saio.class_options[:client_id] = \
+        Thor::Option.parse :client_id, fog_settings[:digitalocean_client_id]
+      cli = Cifrado::Plugins::Saio.new 
+      cli.flavors.size > 0
+    end
+  end
+
+end

data/tests/saio/images_tests.rb

@@ -0,0 +1,14 @@
+Shindo.tests('Cifrado | CLI#saio') do
+
+  tests '#images' do
+    test 'list' do
+      Cifrado::Plugins::Saio.class_options[:api_key] = \
+        Thor::Option.parse :api_key, fog_settings[:digitalocean_api_key]
+      Cifrado::Plugins::Saio.class_options[:client_id] = \
+        Thor::Option.parse :client_id, fog_settings[:digitalocean_client_id]
+      cli = Cifrado::Plugins::Saio.new 
+      cli.images.size > 0
+    end
+  end
+
+end

data/tests/saio/regions_tests.rb

@@ -0,0 +1,14 @@
+Shindo.tests('Cifrado | CLI#saio') do
+
+  tests '#regions' do
+    test 'list' do
+      Cifrado::Plugins::Saio.class_options[:api_key] = \
+        Thor::Option.parse :api_key, fog_settings[:digitalocean_api_key]
+      Cifrado::Plugins::Saio.class_options[:client_id] = \
+        Thor::Option.parse :client_id, fog_settings[:digitalocean_client_id]
+      cli = Cifrado::Plugins::Saio.new 
+      cli.regions.size > 0
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cifrado
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -37,7 +37,7 @@ cert_chain:
   VmpCY252Rk9HWThmMzJoVnE2MTlRaUpWcFY5elJnWWE1TTA1bVdSbXdIQnly
   YjR5SzBBYgozR3B5dU1NTkJNaz0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0t
   LQo=
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -215,6 +215,9 @@ files:
 - lib/cifrado/cli/saio/base.rb
 - lib/cifrado/cli/saio/bootstrap.rb
 - lib/cifrado/cli/saio/destroy.rb
+- lib/cifrado/cli/saio/flavors.rb
+- lib/cifrado/cli/saio/images.rb
+- lib/cifrado/cli/saio/regions.rb
 - lib/cifrado/cli/saio/scripts/saio.sh.erb
 - lib/cifrado/cli/set_acl.rb
 - lib/cifrado/cli/setup.rb
@@ -237,6 +240,10 @@ files:
 - tests/crypto_services_tests.rb
 - tests/file_splitter_tests.rb
 - tests/helper.rb
+- tests/saio/bootstrap_tests.rb
+- tests/saio/flavors_tests.rb
+- tests/saio/images_tests.rb
+- tests/saio/regions_tests.rb
 - tests/swift_client/create_directory.rb
 - tests/swift_client/download_tests.rb
 - tests/swift_client/file_available.rb