forj 1.0.10 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 104016c81c311f9a0f4454a0f50aadeb9e2810a2
-  data.tar.gz: 07452ff472445eed9d882d1d8e153c75b7b27182
+  metadata.gz: 5c59dea68c4b93b5a88af774d515d0d5c6aece5a
+  data.tar.gz: ba80c68baec1fada231973d365f7bc3d46cb6306
 SHA512:
-  metadata.gz: dc95fd28f3de676003c62a1804725ca4225199391c78096a200a048c92d02207324d19ffd6a127b9a446baafe6b16a28ca3a49c90d676e2a6db33fbf35dd75a0
-  data.tar.gz: f1f431e9d6ebb546d1f524b921db1098ce537ec5a263ea310a87f2b6ff36fc35261d37552f8b4e0fe8568d551ee5beb9daf115b8042f689a4ca26ea0c508688f
+  metadata.gz: d8f0791f66cb366aef89a6845e0a8ac13869e08e3e27e659824513b0056b27950503f2c354ddf4d5b00798ea60c34e3a0d94d2e56a6da992dc6bb290319f5e12
+  data.tar.gz: de46007515850844f71c4dbc2d7375991c58c2be4c9118b39b432694ecb7939a9c552945fc3a5cb19d830f953c77158f7f5096228e534828647418b65e45e9cb

data/.rubocop.yml

@@ -33,27 +33,24 @@ Style/HashSyntax:
 
 # lets start with 40, but 10 is way to small..
 Metrics/MethodLength:
-  Max: 40
+  Max: 50
+# If Method length is increased, class length need to be extended as well.
+Metrics/ClassLength:
+  Max: 150
+
 # allow arguments to be longer than 15
 Metrics/AbcSize:
-  Max: 40
-# allow nested methods and classes definition
-ClassAndModuleChildren:
-  # EnforcedStyle: compact
-  Enabled: false
+  Max: 50
+# Perceived Complexity
+Metrics/PerceivedComplexity:
+  Max: 9
+Metrics/CyclomaticComplexity:
+  Max: 8
 
-# some files names gets an exception
+# forj-docker binary name gets an exception
 Style/FileName:
   Exclude: ['Gemfile',
             'lib/forj/process/ForjProcess.rb',
             'lib/forj/ForjCore.rb',
             'lib/forj/ForjCli.rb',
             'lib/forj-settings.rb' ]
-
-# this project defines these globals
-Style/GlobalVars:
-  AllowedVariables: ['$RT_GEM_BIN',
-                     '$RT_VERSION_SPEC',
-                     '$FORJ_TEMP',
-                     '$RT_VERSION',
-                     '$RT_GEM_HOME']

data/bin/forj

@@ -21,6 +21,7 @@ require 'rubygems'
 require 'bundler/setup'
 require 'thor'
 require 'ansi'
+require 'forj'
 
 APP_PATH = File.dirname(File.dirname(__FILE__))
 LIB_PATH = File.expand_path(File.join(APP_PATH, 'lib'))
@@ -148,21 +149,27 @@ If you want to check/updated them, use `forj get [-a account]`
     ' flavor        : Maestro flavor to use.'
   method_option :bp_flavor,        :aliases => '-b',   :desc => 'config:' \
     ' bp_flavor     : Blueprint nodes default flavor to use.'\
-    "\n\n Build system options:"
+    "\n\nBuild system options:"
   method_option :boothook,         :aliases => '-H',   :desc => 'By default, ' \
     ' boothook file used is build/bin/build-tools/boothook.sh. '         \
     ' Use this option to set another one.'
   method_option :build,            :aliases => '-B',   :desc => 'Replace' \
     ' the default build.sh'
   method_option :branch,           :aliases => '-R',   :desc => 'Branch' \
-    "name to clone for maestro.\n\nMaestro/infra bootstrap debugging:"
-  method_option :test_box,         :aliases => '-T',   :desc => 'Identify a' \
-    ' path to become your test-box repository.' \
-    "\n                                            " \
-    'Ex: if your maestro is in ~/src/forj-oss, --test_box' \
-    ' ~/src/forj-oss/maestro build.sh and' \
-    "\n                                            " \
-    'test-box will send your local maestro repo to your box, for boot.'
+    "name to clone for maestro.\n\n"\
+    "Remote box bootstrap debugging (test-box):\n"\
+    'test-box is a shell script used to connect one or more local repository'\
+    " to be connected to the new remote box. \n"\
+    'If your box support test-box feature, at boot time, the remote box may '\
+    'wait for your local repository to be sent out to the new box. '\
+    'For more details on test-box, call it to get help.'
+  method_option :tb_path,  :aliases => '-t',
+                           :desc => 'Define the path to the test-box script. '\
+                                    'This option superseeds the TEST_BOX '\
+                                   'environment variable.'
+  method_option :test_box, :aliases => '-T', :type => :array,
+                           :desc => "Use a local repository for test-box\n\n"\
+                                    'Other options:'
   method_option :extra_metadata,   :aliases => '-e',   :desc => 'Custom' \
     ' server metadata format key1=value1,key2=value2...,keyN=valueN'
 

data/forj.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   s.name        = 'forj'
   s.homepage = 'https://www.forj.io'
 
-  s.version     = '1.0.10'
-  s.date        = '2015-04-17'
+  s.version     = '1.0.11'
+  s.date        = '2015-05-22'
   s.summary     = 'forj command line'
   s.description = 'forj cli - See https://www.forj.io for documentation/information'
 
@@ -51,7 +51,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '1.7.5'
   s.add_runtime_dependency 'bundler'
   s.add_runtime_dependency 'nokogiri','1.5.11'
-  s.add_runtime_dependency 'lorj_cloud', '~> 0.1.0'
+  s.add_runtime_dependency 'lorj_cloud', '~> 0.1.1'
 
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 3.1.0"

data/forj/defaults.yaml

@@ -13,285 +13,4 @@
 #    limitations under the License.
 
 :default:
-  :maestro_url: https://github.com/forj-oss/maestro.git
-
-  # Default Infra repository to use. If missing, it will be proposed to be created.
-  :infra_repo: ~/.forj/infra
-
-  # You can set proto2b in your ~/.forj/config.yaml if you built it from maestro/build. Read the maestro/README.md to create it.
-  :image_name: Ubuntu Precise 12.04.4 LTS Server 64-bit 20140414 (Rescue Image)
-
-  # Flavor to use for Maestro
-  :flavor: medium
-  # Default flavor to use for all Blueprint nodes.
-  :bp_flavor: small
-
-  # Ports to open for Maestro, added to the security group
-  :security_group: forj
-  :ports: [22, 80, 443, 3000, 3131-3135, 4505-4506, 5000, 5666, 8000, 8080-8081, 8083, 8125, 8139-8140, 8773-8776, 9292, 29418, 35357]
-
-  # Network: If network doesn't exist, forj cli will try to create it, and attach it a router.
-  :network: forj
-
-  # Users: Default user for ssh connection, if user doesn't exits, forj cli will try to get the user from the server image on it's name attribute
-  :users: ['ubuntu', 'fedora', 'cloud-user', 'cirros', 'centos', 'cloud', 'root']
-
-  # build.sh internal variables.
-  :build_config: box
-  :branch: master
-  :box_name: maestro
-
   :provider_name: hpcloud
-
-  :maestro_bootstrap_dir:  build/maestro/bootstrap
-: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"
-  :FORJ_HPC_COMPUTE:     "HPCloud Compute service (like region-b.geo-1) used to run your Maestro Box"
-  :FORJ_TENANT_NAME:     "HPCloud Tenant name used build your <Blueprint> nodes"
-  :FORJ_HPC_NET:         "HPCloud Network name to use, while booting all boxes."
-  :FORJ_KEYPAIR:         "Keypair used to access boxes."
-  :FORJ_SECURITY_GROUP:  "Security group associated to each box"
-  :FORJ_HPC_NOVA_KEYPUB: "Public key used by build.sh to ensure his existence on HPCloud"
-  :FORJ_BASE_IMG:        "Base image used to build all boxes"
-  :FORJ_FLAVOR:          "Flavor used to build Maestro"
-  # DNS specific data
-  :FORJ_DNS_TENANTID:    "HPCloud Project ID to use to create DNS entries for each boxes."
-  :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."
-
-# 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
-:setup:
-   :ask_step:
-      -  :desc:    "Provider configuration:"
-      -  :desc:    "Maestro Cloud compute configuration:"
-         :explanation:        |-
-            Maestro (gardener) is currently configured to access your cloud Compute service with fog openstack.
-            Fog openstack is compatible with hpcloud services
-
-            It requires the openstack project name, user and password.
-
-      -  :desc:    "Maestro and blueprint configuration:"
-         :add:
-            - :keypair_files
-            - :ssh_user
-      -  :desc:    "DNS Configuration for Maestro:"
-: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
-      :ask_step:           0
-    :network:
-      :desc:              "Generic service identification for network"
-      :account_exclusive: true
-      :account:           true
-      :ask_step:           0
-
-  # Defines ssh keys credentials
-  :credentials:
-    :keypair_files:
-      :explanation:        |-
-         A keypair is a combination of SSH public and private key files. Usually, generated in your '$HOME/.ssh/' directory.
-         The private key is used to identify yourself to access your box via ssh.
-         The public key is used to configure your server to authorize you to access the box with your private key.
-         This keypair files will be copied to '$HOME/.forj/keypairs/ under <keypair_name> files for 'forj' needs.
-
-         If the keypair doesn't exist locally, it will be created for you.
-      :desc:               "Base keypair file name"
-      :default_value:      "~/.ssh/<%= config[:keypair_name] %>-id_rsa"
-      :validate_function:  :forj_check_keypairs_files
-      :account:            true
-      :ask_step:           2
-      :after:              :keypair_name
-      :pre_step_function:  :forj_cloud_keypair_coherent?
-      :post_step_function: :forj_setup_keypairs_files
-    :keypair_path:
-      :desc:               "Contains the full path to the :keypair_base."
-      :default_value:      "<%= Forj.keypairs_path %>"
-    :keypair_base:
-      :desc:               "Contains the key file base name without .pem/.pub."
-      :default_value:      "<%= config[:keypair_name] %>"
-    :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."
-      :required:           true
-      :default_value:      "forj"
-      :account:            true
-      :ask_step:           2
-      :pre_step_function:  :update_keypair_config
-      :post_step_function: :forj_check_cloud_keypair
-    :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
-      :encrypted:          true
-    :tenant:
-      :desc:               "Openstack Tenant Name (Project name)"
-      :account_exclusive:  true
-      :account:            true
-      :required:           true
-      :ask_step:           0
-    :os_user:
-      :desc:               "Openstack compute cloud User name"
-      :account_exclusive:  true
-      :account:            true
-      :required:           true
-      :validate:           !ruby/regexp /\w+/
-      :ask_step:           1
-      :default_value:      "<%= (config[:provider_name] == 'openstack')?config[:account_id]:nil %>"
-    :os_enckey:
-      :desc:               "Openstack compute cloud password"
-      :account_exclusive:  true
-      :encrypted:          true
-      :account:            true
-      :required:           true
-      :ask_step:           1
-      :default_value:      "<%= (config[:provider_name] == 'openstack')?config[:account_key]:nil %>"
-
-  # Defines DNS services for maestro
-  :dns:
-      :domain_name:
-         :desc:               "Domain name added to each hosts."
-         :account_exclusive:  true
-         :account:            true
-         :post_step_function: :forj_dns_settings
-         :ask_step:           3
-      :dns_service:
-         :desc:               "DNS service region name Maestro will use."
-         :account_exclusive:  true
-         :account:            true
-         :pre_step_function:  :forj_dns_settings?
-         :ask_step:           3
-      :dns_tenant_id:
-         :desc:               "DNS Tenant ID Maestro will use"
-         :account_exclusive:  true
-         :account:            true
-         :pre_step_function:  :forj_dns_settings?
-         :ask_step:           3
-
-  :maestro:
-    :tenant_name:
-      :desc:            "Tenant name required by fog/openstack on gardener"
-      :account:         true
-      :validate:        !ruby/regexp /^\w?[\w_:-]*$/
-      :ask_step:        1
-      :ask_sort:        0
-      :default_value:   "<%= (config[:provider_name] == 'openstack')?config[:tenant]:nil %>"
-    :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
-      :account:         true
-      :required:        true
-      :default_value:   "forj"
-      :ask_step:        2
-    :security_group:
-      :desc:            "Security group name to configure and attach to each forge boxes."
-      :account:         true
-      :validate:        !ruby/regexp /^\w?\w*$/
-      :default_value:   "forj"
-      :ask_step:        2
-    :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"
-      :explanation: |-
-        Blueprint usually defines the required flavor for their nodes. If not, it will use this flavor as default.
-        Usually, blueprint nodes are smaller than Maestro.
-      :account:    true
-      :list_values:
-         :query_type:   :query_call # Will execute a query on flavor, query_params is empty for all.
-         :object:       :flavor
-         :value:        :name
-         :validate:     :list_strict
-      :ask_step:        2
-    :flavor_name:
-      :explanation: 'This flavor is for Maestro only.'
-      :desc:       "Maestro Flavor name"
-      :default:    :flavor
-      :account:    true
-      :list_values:
-         :query_type:   :query_call # Will execute a query on flavor, query_params is empty for all.
-         :object:       :flavor
-         :value:        :name
-         :validate:     :list_strict
-      :ask_step:        2
-    :image_name:
-      :desc:       "Image name"
-      :explanation: |-
-        Ubuntu image used to create Maestro and all forge boxes. Originally, Maestro uses 'Ubuntu Precise 12.04.4 LTS Server 64-bit'.
-        You need to choose the appropriate image to make Maestro & boxes to boot normally.
-      :account:    true
-      :ask_step:        2
-      :list_values:
-         :query_type:   :query_call # Will execute a query on flavor, query_params is empty for all. No filter currently working.
-         :object:       :image
-         :value:        :name
-         :validate:     :list_strict
-      :ask_step:        2
-    :ssh_user:
-      :desc:        "User name for ssh connection of your selected image."
-      :explanation: |-
-        The image name you have selected has a unique SSH Account access.
-
-        Thanks to the name of the image, setup assume the account name to use.
-        If this name is incoherent with the image you choosed, please update it.
-
-        Checking image '<%= config[:image_name] %>'...
-      :account:     true
-      :ask_step:    2
-      :after:              :image_name
-      :list_values:
-        :query_type:  :process_call # Will execute a process to query on image
-        :query_call:  :setup_ssh_user # and return the list of images and a default value.
-        :query_params: # Transmitted as hParams
-          :image_name: '<%= config[:image_name] %>'
-    :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"
-    :bootstrap_dirs:
-      :desc:            "Additional bootstrap directories (separated by space) to add in the bootstrap loop."
-    :bootstrap_extra_dir:
-      :desc:            "Additional bootstrap directory to add in the bootstrap loop, before :bootstrap_dirs and after maestro default bootstrap directory."

data/lib/boot.rb

@@ -53,9 +53,9 @@ module Forj
 
     def self.load_options(options, options_map)
       options_map.each do |opt_key, ac_key|
-        unless options[opt_key].nil?
-          value = yield(opt_key, options[opt_key])
-          @account.set(ac_key, options[opt_key]) unless value.nil?
+        if options.key?(opt_key.to_s)
+          value = yield(opt_key, options[opt_key.to_s])
+          @account.set(ac_key, value) unless value.nil?
         end
       end
     end
@@ -99,10 +99,12 @@ module Forj
                     @account[:instance_name], @account[:blueprint])
       end
     end
+  end
+  # rubocop: disable Metrics/CyclomaticComplexity
+  # rubocop: disable Metrics/MethodLength
 
-    # rubocop: disable Metrics/CyclomaticComplexity
-    # rubocop: disable Metrics/MethodLength
-
+  #
+  module Boot
     # Boot process
     def self.boot(blueprint, on_or_name, deprecated_name, options)
       @account = Lorj::Account.new(options[:config])
@@ -125,6 +127,9 @@ module Forj
                      @account[:account_name], @account[:account_name])
       end
 
+      options = options.to_h
+      options['tb_path'] = nil if options.key?('test_box') &&
+                                  !options.key?('tb_path')
       options_map = { :infra          => :infra_repo,
                       :key_name       => :keypair_name,
                       :key_path       => :keypair_path,
@@ -135,22 +140,10 @@ module Forj
                       :maestro_repo   => :maestro_repo,
                       :branch         => :branch,
                       :test_box       => :test_box,
+                      :tb_path        => :test_box_path,
                       :extra_metadata => :extra_metadata }
 
-      load_options(options, options_map) do |key, value|
-        case key
-        when :test_box
-          path = File.expand_path(value)
-          return path if File.directory?(path)
-          return nil
-        end
-        value
-      end
-
-      PrcLib.warning(
-        'test_box is currently disabled in this version.' \
-        'It will be re-activated in newer version.'
-      ) if options[:test_box]
+      load_options(options, options_map) { |k, v| complete_boot_options(k, v) }
 
       validate_keypath(options)
 
@@ -166,4 +159,91 @@ module Forj
       o_cloud.create(:forge)
     end
   end
+  # rubocop: enable Metrics/CyclomaticComplexity
+  # rubocop: enable Metrics/MethodLength
+
+  #
+  module Boot
+    # Take care of special options cases for boot.
+    def self.complete_boot_options(key, value)
+      case key
+      when :test_box
+        value = tb_repo_detect(value)
+      when :tb_path
+        value = tb_bin_detect(value)
+      end
+      value
+    end
+
+    # Function to check the repository path passed.
+    def self.tb_repo_detect(paths)
+      res = {}
+      paths.each do |path|
+        cmd = <<-CMD
+cd "#{path}"
+git rev-parse --show-toplevel 2>/dev/null 1>&2
+if [ $? -ne 0 ]
+then
+   exit 1
+fi
+REPO_TO_ADD="$(LANG= git remote show origin -n |
+                     awk '$1 ~ /Fetch/ { print $3 }')"
+if [ "$REPO_TO_ADD" = "" ]
+then
+   exit 1
+fi
+echo $REPO_TO_ADD
+pwd
+        CMD
+        cmd_res = `#{cmd}`.split
+        # For any reason, $CHILD_STATUS is empty, while $? is not.
+        # Ruby bug. tested with:
+        # ruby 2.0.0p353 (2013-11-22 revision 43784) [x86_64-linux]
+        # rubocop: disable Style/SpecialGlobalVars
+        next unless $?.exitstatus == 0
+        # rubocop: enable Style/SpecialGlobalVars
+        repo_found = cmd_res[0].match(%r{.*/(.*)(.git)?})
+        next unless repo_found
+        res[repo_found[1]] = cmd_res[1]
+      end
+      res
+    end
+
+    # function to detect if test-box.sh is runnable
+    #
+    # It returns the script to execute.
+    def self.tb_bin_detect(tb_path)
+      tb_path = ENV['TEST_BOX'] if tb_path.nil?
+      tb_path = File.expand_path(tb_path) unless tb_path.nil?
+
+      script = 'test-box.sh'
+      if tb_path && File.directory?(tb_path)
+        script_found = tb_check_bin(tb_path)
+        script = File.expand_path(File.join(tb_path, script))
+        if script_found.nil?
+          PrcLib.error("Test-box: '%s' is not a valid runnable script. "\
+                       'test-box is disabled.', script)
+          return nil
+        end
+        return script_found
+      end
+
+      script_found = nil
+
+      ENV['PATH'].split(':').each do |path|
+        script_found = tb_check_bin(path)
+        break unless script_found.nil?
+      end
+
+      script_found
+    end
+
+    # Script to check the bin and path
+    def self.tb_check_bin(tb_path)
+      script = 'test-box.sh'
+      script = File.expand_path(File.join(tb_path, script))
+      return script if File.executable?(script)
+      nil
+    end
+  end
 end