forj 0.0.43 → 0.0.44

data/lib/defaults.yaml

@@ -41,6 +41,8 @@
   :build_config: box
   :branch: master
   :box_name: maestro
+
+  :provider_name: hpcloud
 :description:
   # Description of build.sh environment variable defined by forj cli for build.sh. (~/.forj/infra/build/<Account>.build.env)
   :FORJ_HPC:             "HPCloud cli Account used to build your Maestro box"
@@ -57,64 +59,116 @@
   :FORJ_DNS_ZONE:        "HPCloud Domain name service to use for each boxes DNS entries. (Ex: region-a.geo-1)"
   :FORJ_DNS_DOMAIN:      "Domain used for DNS. Each server will be attached to a public IP. An 'A' record in the DNS service will need to be added to your HPCloud DOMAIN."
 
-# Use by Object ForjAccount, function get, to identify the section name in ~/.forj/accounts/YourAccount. We can set those variables with 'forj set key=value [-a account]'
-:account_section_mapping:
-  :security_group:
-    :section:     :maestro
-    :desc:        "Security group name to configure and attach to each forge boxes."
-
-  :image:
-    :section:    :maestro
-    :desc:       "Image used to create Maestro and all forge boxes. By default, it is 'Ubuntu Precise 12.04.4 LTS Server 64-bit 20140414 (Rescue Image)'"
-
-  :flavor:
-    :section:    :maestro
-    :desc:       "Maestro Flavor name. This flavor is for Maestro only. Your blueprint layout defines each node flavors on needs."
-
-  :bp_flavor:
-    :section:    :maestro
-    :desc:       "Blueprint nodes default flavor. Usually, blueprint node are smaller than Maestro."
-
-  :build_config:
-    :section:    :maestro
-    :desc:       "forj cli use 'build.sh' to create Maestro. See build_config option on build.sh to get more information. By default 'box'"
-
-  :box_name:
-    :section:    :maestro
-    :desc:       "forj cli use 'build.sh' to create Maestro. See box_name option on build.sh to get more information. By default 'maestro'"
-
-  :keypair_name:
-    :section:    :credentials
-    :desc:       "keypair name defined in your cloud to access your server. By default we named it 'forj'. If it doesn't exist, it will be created."
-
-  :keypair_path:
-    :section:    :credentials
-    :desc:       "public key file to send to the cloud under keypair name, and private key to keep on your local forj environment to access your boxes."
-
-  :tenant_name:
-    :section:    :compute
-    :desc:       "Tenant name required by fog/openstack on gardener"
-
-  :domain_name:
-    :section:    :dns
-    :desc:       "Domain name added to each hosts."
-
-  :tenant_id:
-    :section:    :dns
-    :desc:       "DNS Tenant ID Maestro will use"
-
-  :service:
-    :section:    :dns
-    :desc:       "DNS service region name Maestro will use."
-
-  :network:
-    :section:    :network
-    :desc:       "Network name to attach to each forge boxes. By default we use 'private'. If it doesn't exist, it will be created."
-    
-  :infra_repo:
-    :section:    :maestro
-    :desc:       "Defines your Infra directory to use while booting."
-  
-  :maestro_repo:
-    :section:    :maestro
-    :desc:       "To use a different Maestro repository already cloned."
+# Following declares generic FORJ data to handle Fog object (compute/network/dns/...)
+# It defines the account file structure. section/key=value
+# All data can be predefined by default value (config.yaml/defaults.yaml) except
+# those identified by :account_exclusive: true
+:sections:
+  # This section define updatable data available from config.yaml. But will never be added in an account file.
+  # Used by forj set/get functions
+  :default:
+    :account_name:
+      :desc:              "Default account name used by forj cli"
+    :provider_name:
+      :desc:              "Default provider name while running forj setup. By default, hpcloud is selected."
+  # Defines account credentials data
+  :account:
+    :name:
+      :desc:              "Name of the Forj cli account. use forj account rename <oldName> <NewName> to update it."
+      :readonly:          true
+      :account_exclusive: true
+    :provider:
+      :desc:              "Provider name attached to the forj cli account. To update it, use forj setup."
+      :readonly:          true
+      :account_exclusive: true
+      :default:           :provider_name
+
+  # Defines services
+  :services:
+    :compute:
+      :desc:              "Generic service identification for compute"
+      :account_exclusive: true
+      :account:           true
+    :network:
+      :desc:              "Generic service identification for network"
+      :account_exclusive: true
+      :account:           true
+
+  # Defines ssh keys credentials
+  :credentials:
+    :keypair_path:
+      :desc:              "public key file to send to the cloud under keypair name, and private key to keep on your local forj environment to access your boxes."
+    :keypair_name:
+      :desc:              "keypair name defined in your cloud to access your server. By default we named it 'forj'. If it doesn't exist, it will be created."
+    :auth_uri:
+      :desc:              "Generic service auth url"
+      :account_exclusive: true
+      :account:           true
+      :required:          true
+      :ask_sort:          0
+    :account_id:
+      :desc:              "Generic Cloud Account name."
+      :account_exclusive: true
+      :account:           true
+      :required:          true
+    :account_key:
+      :desc:              "Generic cloud account key"
+      :account_exclusive: true
+      :account:           true
+      :required:          true
+    :tenant:
+      :desc:             "Generic Tenant identification"
+      :account_exclusive: true
+      :account:           true
+      :required:          true
+    :os_user:
+      :desc:              "User name required by Maestro to access the cloud compute via openstack. Will be obsoleted soon."
+      :account_exclusive: true
+      :account:           true
+      :required:          true
+      :validate: !ruby/regexp /\w+/
+    :os_enckey:
+      :desc:              "Encrypted password required by Maestro to access the cloud compute via openstack. Will be obsoleted soon."
+      :account_exclusive: true
+      :encrypted:         true
+      :account:           true
+      :required:          true
+
+  # Defines DNS services for maestro
+  :dns:
+    :service:
+      :desc:       "DNS service region name Maestro will use."
+      :account_exclusive: true
+    :tenant_id:
+      :desc:       "DNS Tenant ID Maestro will use"
+      :account_exclusive: true
+    :domain_name:
+      :desc:       "Domain name added to each hosts."
+      :account_exclusive: true
+
+  :maestro:
+    :tenant_name:
+      :desc:       "Tenant name required by fog/openstack on gardener"
+    :network_name:
+      :desc:       "Network name to attach to each forge boxes. By default we use 'forj'. If it doesn't exist, it will be created."
+      :default:    network
+    :security_group:
+      :desc:        "Security group name to configure and attach to each forge boxes."
+    :maestro_repo:
+      :desc:       "To use a different Maestro repository already cloned."
+    :infra_repo:
+      :desc:       "Defines your Infra directory to use while booting."
+    :box_name:
+      :desc:       "forj cli use 'build.sh' to create Maestro. See box_name option on build.sh to get more information. By default 'maestro'"
+    :build_config:
+      :desc:       "forj cli use 'build.sh' to create Maestro. See build_config option on build.sh to get more information. By default 'box'"
+    :bp_flavor:
+      :desc:       "Blueprint nodes default flavor. Usually, blueprint node are smaller than Maestro."
+    :flavor:
+      :desc:       "Maestro Flavor name. This flavor is for Maestro only. Your blueprint layout defines each node flavors on needs."
+    :image:
+      :desc:       "Image used to create Maestro and all forge boxes. By default, it is 'Ubuntu Precise 12.04.4 LTS Server 64-bit 20140414 (Rescue Image)'"
+    :ports:
+      :desc:       "List of security group rules (1 port or range of ports) to open to the external network."
+    :branch:
+      :desc:       "Branch to use to build your forge"

data/lib/forj-account.rb

@@ -45,10 +45,38 @@ class ForjAccounts
    end
 end
 
+# ForjAccount manage a list of key/value grouped by section.
+# The intent of ForjAccount is to attach some keys/values to
+# an account to help end users to switch between each of them.
+#
+# ForjAccount based on ForjConfig (see forj-config.rb)
+# ensure ForjConfig and ForjAccount defines following common functions
+# - set (key, value)
+# - get (key)
+#
+# This means that key HAVE to be unique across sections
+# By default, keys maps with the same key name in ForjConfig.
+# But we can redefine the ForjConfig mapping of any key on need.
+#
+# ForjConfig, loads Account meta structure from defaults.yaml, sections
+#
+# defaults.yaml structure is:
+# sections:
+#   default: => defines key/values recognized by ForjAccount to be only managed by ForjConfig.
+#     <key> :
+#       :desc : <value> => defines the ForjConfig key description.
+#   <section>: Define a section name. For each keys on this section, the account file will kept those data under this section.
+#     <key>:
+#       :desc:              defines the key description.
+#       :readonly:          true if this key cannot be updated by ForjAccount.set
+#       :account_exclusive: true if this key cannot be predefined on ForjConfig keys list
+#       :default:           <ForjConfig real key name> Used to map the ForjAccount key to a different ForjConfig key name.
+
 class ForjAccount
 
    attr_reader :sAccountName
    attr_reader :hAccountData
+   attr_reader :oConfig
 
    # This object manage data located in oConfig[:hpc_accounts/AccountName]
 
@@ -67,53 +95,148 @@ class ForjAccount
       sProvider = @oConfig.get(:provider) if @oConfig.get(:provider)
 
       @hAccountData = {}
-      rhSet(@hAccountData, @sAccountName, [:account, :name]) if rhExist?(@hAccountData, [:account, :name]) != 2
-      rhSet(@hAccountData, sProvider, [:account, :provider]) if rhExist?(@hAccountData, [:account, :provider]) != 2
+      _set(:account, :name, @sAccountName) if exist?(:name) != 'hash'
+      _set(:account, :provider, sProvider)  if exist?(:provider) != 'hash'
+
    end
 
-   # oForjAccount data get are retrieved from the account file under section described in defaults.yaml (:account_section_mapping), as soon as this mapping exists.
-   # If not found, get the data from the local configuration file. Usually ~/.forj/config.yaml
-   # If not found, get the data from defaults.yaml
+   # oForjAccount data get at several levels:
+   # - get the data from runtime (runtimeSet/runtimeGet)
+   # - otherwise, get data from account file under section described in defaults.yaml (:account_section_mapping), as soon as this mapping exists.
+   # - otherwise, get the data from the local configuration file. Usually ~/.forj/config.yaml
+   # - otherwise, get the data from defaults.yaml
    # otherwise, use the get default parameter as value. Default is nil.
    def get(key, default = nil)
       return nil if not key
 
       key = key.to_sym if key.class == String
-      section = rhGet(@oConfig.getAppDefault(:account_section_mapping, key), :section)
-      yInterm = nil
-      if section
-         yInterm = rhGet(@hAccountData, section)
-      else
+
+      return @oConfig.runtimeGet(key) if @oConfig.runtimeExist?(key)
+
+      section = ForjDefault.get_meta_section(key)
+      default_key = key
+
+      if not section
          Logging.debug("ForjAccount.get: No section found for key '%s'." % [key])
+      else
+         return rhGet(@hAccountData, section, key) if rhExist?(@hAccountData, section, key) == 2
+
+         hMeta = @oConfig.getAppDefault(:sections)
+         if rhExist?(hMeta, section, key, :default) == 3
+            default_key = rhGet(hMeta, section, key, :default)
+            Logging.debug("ForjAccount.get: Reading default key '%s' instead of '%s'" % [default_key, key])
+         end
+         return default if rhExist?(hMeta, section, key, :account_exclusive) == 3
       end
-      @oConfig.get(key, yInterm , default )
+
+      @oConfig.get(default_key , default )
    end
 
    def exist?(key)
       return nil if not key
 
       key = key.to_sym if key.class == String
-      section = rhGet(@oConfig.getAppDefault(:account_section_mapping, key), :section)
-      yInterm = nil
-      yInterm = rhGet(@hAccountData, section) if section
-      @oConfig.exist?(key, yInterm)
+      section = ForjDefault.get_meta_section(key)
+      if not section
+         Logging.debug("ForjAccount.exist?: No section found for key '%s'." % [key])
+         return nil
+      end
+      return @sAccountName if rhExist?(@hAccountData, section, key) == 2
+
+      hMeta = @oConfig.getAppDefault(:sections)
+      if rhExist?(hMeta, section, key, :default) == 3
+         default_key = rhGet(hMeta, section, key, :default)
+         Logging.debug("ForjAccount.exist?: Reading default key '%s' instead of '%s'" % [default_key, key])
+      else
+         default_key = key
+      end
+      return nil if rhExist?(hMeta, section, key, :account_exclusive) == 3
+
+      @oConfig.exist?(default_key)
+
+   end
+
+   # Return true if readonly. set won't be able to update this value.
+   # Only _set (private function) is able.
+   def readonly?(key)
+      return nil if not key
+
+      key = key.to_sym if key.class == String
+      section = ForjDefault.get_meta_section(key)
+
+      rhGet(@oConfig.getAppDefault(:sections, section), key, :readonly)
+
+   end
+
+   def meta_set(key, hMeta)
+      key = key.to_sym if key.class == String
+      section = ForjDefault.get_meta_section(key)
+      hCurMeta = rhGet(@oConfig.getAppDefault(:sections, section), key)
+      hMeta.each { | mykey, myvalue |
+         rhSet(hCurMeta, myvalue, mykey)
+         }
+   end
+
+   def meta_exist?(key)
+      return nil if not key
+
+      key = key.to_sym if key.class == String
+      section = ForjDefault.get_meta_section(key)
+      rhExist?(@oConfig.getAppDefault(:sections, section), key) == 1
+   end
+
+   def get_meta_section(key)
+      key = key.to_sym if key.class == String
+      rhGet(@account_section_mapping, key)
+   end
+
+   def meta_type?(key)
+      return nil if not key
+
+      section = ForjDefault.get_meta_section(key)
+
+      return section if section == :default
+      @sAccountName
+   end
+
+   # Loop on account metadata
+   def metadata_each
+      rhGet(ForjDefault.dump(), :sections).each { | section, hValue |
+         next if section == :default
+         hValue.each { | key, value |
+            yield section, key, value
+            }
+         }
+   end
+
+   # Return true if exclusive
+   def exclusive?(key)
+      return nil if not key
+
+      key = key.to_sym if key.class == String
+      section = ForjDefault.get_meta_section(key)
 
+      rhGet(@oConfig.getAppDefault(:sections, section), key, :account_exclusive)
    end
 
+   # This function update a section/key=value if the account structure is defined.
+   # If no section is defined, set it in runtime config.
    def set(key, value)
       return nil if not key
 
       key = key.to_sym if key.class == String
-      section = rhGet(@oConfig.getAppDefault(:account_section_mapping, key), :section)
-      return nil if not section
-      rhSet(@hAccountData, value, section, key)
+      section = ForjDefault.get_meta_section(key)
+
+      return @oConfig.set(key, value) if not section
+      return nil if readonly?(key)
+      _set(section, key, value)
    end
 
    def del(key)
       return nil if not key
 
       key = key.to_sym if key.class == String
-      section = rhGet(@oConfig.getAppDefault(:account_section_mapping, key), :section)
+      section = ForjDefault.get_meta_section(key)
       return nil if not section
       rhSet(@hAccountData, nil, section, key)
    end
@@ -123,23 +246,30 @@ class ForjAccount
       default
    end
 
-   def ac_load(sAccountName = @sAccountName)
+   def ac_new(sAccountName)
+      return nil if sAccountName.nil?
+      @sAccountName = sAccountName
+      @sAccountFile = File.join($FORJ_ACCOUNTS_PATH, @sAccountName)
+
+      @hAccountData = {:account => {:name => sAccountName, :provider => @oConfig.get(:provider_name)}}
+   end
+
+   def ac_load(sAccountName = @sAccountName, bHPCloudLoad = true)
       # Load Account Information
 
       if sAccountName != @sAccountName
-         @sAccountName = sAccountName
-         @sAccountFile = File.join($FORJ_ACCOUNTS_PATH, @sAccountName)
+         ac_new(sAccountName)
       end
 
       if File.exists?(@sAccountFile)
          @hAccountData = @oConfig.ExtraLoad(@sAccountFile, :forj_accounts, @sAccountName)
          # Check if hAccountData are using symbol or needs to be updated.
-         sProvider = @oConfig.get(:provider, nil, 'hpcloud')
+         sProvider = @oConfig.get(:provider, 'hpcloud')
          rhSet(@hAccountData, @sAccountName, :account, :name) if rhExist?(@hAccountData, :account, :name) != 2
          rhSet(@hAccountData, sProvider, :account, :provider) if rhExist?(@hAccountData, :account, :provider) != 2
-         provider_load()
+         provider_load() if bHPCloudLoad
          if rhKeyToSymbol?(@hAccountData, 2)
-            @hAccountData = rhKeyToSymbol(@hAccountData, 2) 
+            @hAccountData = rhKeyToSymbol(@hAccountData, 2)
             self.ac_save()
          end
          return @hAccountData
@@ -178,7 +308,7 @@ class ForjAccount
 
       # Checking cloud connection
       Logging.message("Checking cloud connection")
-      ForjConnection.new(@oConfig)
+      ForjConnection.new(self)
 
       Logging.message("Setup '%s' done. Thank you." % @sAccountName)
    end
@@ -236,7 +366,7 @@ class ForjAccount
       if tenant_name
          Logging.debug("Tenant ID '%s': '%s' found." % [tenant_id, tenant_name])
          hCompute = { :tenant_name => tenant_name }
-         rhSet(@hAccountData, hCompute, :compute)
+         rhSet(@hAccountData, hCompute, :maestro)
       else
          Logging.error("Unable to find the tenant Name for '%s' ID." % tenant_id)
       end
@@ -334,12 +464,12 @@ class ForjAccount
             q.validate = /.*+/
          end
          keys_entered = keypair_detect(key_name, key_path)
-         if not keys_entered[:private_key_exist?] and not keys_entered[:public_key_exist?]
+         if not keys_entered[:private_key_exist? ] and not keys_entered[:public_key_exist? ]
             if agree("The key you entered was not found. Do you want to create this one?")
                base_dir = keys_entered[:keypair_path]
                if not File.directory?(base_dir)
                   if agree("'%s' doesn't exist. Do you want to create it?" % base_dir)
-                     Helpers.ensure_dir_exists(base_dir)
+                     AppInit.ensure_dir_exists(base_dir)
                   end
                end
             else
@@ -366,7 +496,7 @@ class ForjAccount
 
 
       # Creation sequences
-      if not keys[:private_key_exist?]
+      if not keys[:private_key_exist? ]
          # Need to create a key. ask if we need so.
          Logging.message("The private key file attached to keypair named '%s'  is not found. forj will propose to create one for you. Please review the proposed private key file name and path.\nYou can press Enter to accept the default value." % keys[:keypair_name])
          real_key_path = File.expand_path(ask("Private key file path:") do |q|
@@ -374,7 +504,7 @@ class ForjAccount
             q.default = private_key_file
          end)
          if not File.exists?(real_key_path)
-            Helpers.ensure_dir_exists(File.dirname(real_key_path))
+            AppInit.ensure_dir_exists(File.dirname(real_key_path))
             command = 'ssh-keygen -t rsa -f %s' % real_key_path
             Logging.debug("Executing '%s'" % command)
             system(command)
@@ -390,7 +520,7 @@ class ForjAccount
          end
       end
 
-      if not keys[:public_key_exist?]
+      if not keys[:public_key_exist? ]
          Logging.message("Your public key '%s' was not found. Getting it from the private one. It may require your passphrase." % [public_key_file])
          command = 'ssh-keygen -y -f %s > %s' % [private_key_file,public_key_file ]
          Logging.debug("Executing '%s'" % command)
@@ -522,24 +652,12 @@ class ForjAccount
       }
       Logging.info("'%s' written." % cloud_fog)
    end
-end
+   # private functions
+   private
+   def _set(section, key, value)
+      return nil if not key or not section
 
-def ensure_forj_dirs_exists()
-  # Function to create FORJ paths if missing.
-
-  # Defining Global variables
-  $FORJ_DATA_PATH = File.expand_path(File.join('~', '.forj'))
-  $FORJ_ACCOUNTS_PATH = File.join($FORJ_DATA_PATH, 'accounts')
-  $FORJ_KEYPAIRS_PATH = File.join($FORJ_DATA_PATH, 'keypairs')
-  $FORJ_CREDS_PATH = File.expand_path(File.join('~', '.cache', 'forj'))
-
-  # TODO: To move to an hpcloud object.
-  $HPC_KEYPAIRS = File.expand_path(File.join('~', '.hpcloud', 'keypairs'))
-  $HPC_ACCOUNTS = File.expand_path(File.join('~', '.hpcloud', 'accounts'))
+      rhSet(@hAccountData, value, section, key)
+   end
 
-  Helpers.ensure_dir_exists($FORJ_DATA_PATH)
-  Helpers.ensure_dir_exists($FORJ_ACCOUNTS_PATH)
-  Helpers.ensure_dir_exists($FORJ_KEYPAIRS_PATH)
-  FileUtils.chmod(0700, $FORJ_KEYPAIRS_PATH)
-  Helpers.ensure_dir_exists($FORJ_CREDS_PATH)
 end