forj 1.0.10 → 1.0.11

data/lib/process/forj_core/defaults.yaml

@@ -0,0 +1,61 @@
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    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."

data/lib/{forj/ForjCore.rb → process/forj_core/process/declare.rb}

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 
 # (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
@@ -15,16 +14,12 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-FORJCORE_PATH = File.expand_path(File.dirname(__FILE__))
-
-require File.join(FORJCORE_PATH, 'process', 'ForjProcess.rb')
-
 # Defines how to manage Maestro and forges
 # create a maestro box. Identify a forge instance, delete it,...
 
 # Define framework object on BaseDefinition
 # See lib/core/definition.rb for function details usage.
-class Lorj::BaseDefinition
+class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
   process_default :use_controller => false
 
   # ******************* Maestro Repository object
@@ -52,26 +47,28 @@ class Lorj::BaseDefinition
              :create_e => :build_metadata
 
   obj_needs :data,   :instance_name
-  obj_needs :data,   :network_name
-  obj_needs :data,   :security_group
-  obj_needs :data,   :keypair_name
-  obj_needs :data,   :image_name
-  obj_needs :data,   :bp_flavor
-  obj_needs :data,   :compute
-  obj_needs :data,   :branch
-  obj_needs :data,   :domain_name
-  obj_needs :data,   :tenant_name
+  obj_needs :data,   'maestro#network_name'
+  obj_needs :data,   'maestro#security_group'
+  obj_needs :data,   'credentials#keypair_name'
+  obj_needs :data,   'maestro#image_name'
+  obj_needs :data,   'maestro#bp_flavor'
+  obj_needs :data,   'services#compute'
+  obj_needs :data,   'maestro#branch'
+  obj_needs :data,   'dns#domain_name'
+  obj_needs :data,   'maestro#tenant_name'
   # sent in base64
-  obj_needs :data,   :os_user
-  obj_needs :data,   :os_enckey
-  obj_needs :data,   :account_id
-  obj_needs :data,   :account_key
-  obj_needs :data,   :auth_uri
+  obj_needs :data,   'credentials#os_user'
+  obj_needs :data,   'credentials#os_enckey'
+  obj_needs :data,   'credentials#account_id'
+  obj_needs :data,   'credentials#account_key'
+  obj_needs :data,   'credentials#auth_uri'
   obj_needs_optional
 
   # If requested by user, ask Maestro to manage the DNS.
-  obj_needs :data,   :dns_service
-  obj_needs :data,   :dns_tenant_id
+  obj_needs :data,   'dns#dns_service'
+  obj_needs :data,   'dns#dns_tenant_id'
+  obj_needs :data,   :test_box
+  obj_needs :data,   :test_box_path
 
   # If requested by user, ask Maestro to instantiate a blueprint.
   obj_needs :data,   :blueprint
@@ -93,20 +90,46 @@ class Lorj::BaseDefinition
 
   # ******************* forge object
   define_obj :forge,
-
              :create_e => :build_forge,
              :delete_e => :delete_forge,
              :get_e => :get_forge
 
-  obj_needs :CloudObject,  :compute_connection
-  obj_needs :CloudObject,  :metadata,         :for => [:create_e]
-  obj_needs :CloudObject,  :userdata,         :for => [:create_e]
-  obj_needs :data,         :instance_name,    :for => [:create_e]
+  obj_needs :CloudObject, :compute_connection
+  obj_needs :CloudObject, :metadata,                :for => [:create_e]
+  obj_needs :CloudObject, :userdata,                :for => [:create_e]
+  obj_needs :data,        :instance_name,           :for => [:create_e]
+  obj_needs :data,        'maestro#image_name',     :for => [:create_e]
+  obj_needs :data,        'maestro#flavor_name',    :for => [:create_e]
+  obj_needs :data,        'maestro#network_name',   :for => [:create_e]
+  obj_needs :data,        'maestro#security_group', :for => [:create_e]
 
   obj_needs_optional
   obj_needs :CloudObject,  :server
+  obj_needs :CloudObject,  :image,            :for => [:create_e]
   obj_needs :CloudObject,  :public_ip,        :for => [:create_e]
   obj_needs :CloudObject,  :keypairs,         :for => [:create_e]
   obj_needs :data,         :blueprint
   obj_needs :data,         :forge_server,     :for => [:delete_e]
+
+  # Adding support of test-box script
+  obj_needs :data,        :test_box,          :for => [:create_e]
+  obj_needs :data,        :test_box_path,     :for => [:create_e]
+  # Defines how cli will control FORJ features
+  # boot/down/ssh/...
+
+  # Define framework object on BaseDefinition
+  # See lib/core/definition.rb for function details usage.
+  # ************************************ SSH Object
+  define_obj(:ssh,
+
+             :create_e => :ssh_connection
+            )
+  obj_needs :CloudObject,  :forge
+  obj_needs :data,         :instance_name
+  obj_needs :data,         'credentials#keypair_name'
+  obj_needs :data,         :keypair_path
+
+  obj_needs_optional
+  obj_needs :data,         :forge_server
+  obj_needs :data,         :ssh_user
 end

data/lib/{forj/process/ForjProcess.rb → process/forj_core/process/forj_process.rb}

@@ -69,7 +69,11 @@ class ForjCoreProcess
     o_forge = process_get(sObjectType, config[:instance_name])
     if o_forge.empty? || o_forge[:servers].length == 0
       PrcLib.high_level_msg("\nBuilding your forge...\n")
-      process_create(:internet_server)
+      process_create(:internet_server,
+                     :image_name => hParams['maestro#image_name'],
+                     :flavor_name => hParams['maestro#flavor_name'],
+                     :network_name => hParams['maestro#network_name'],
+                     :security_group => hParams['maestro#security_group'])
       o_forge[:servers, 'maestro'] = hParams.refresh[:server]
     else
       o_forge = load_existing_forge(o_forge, hParams)
@@ -291,6 +295,9 @@ class ForjCoreProcess
         m_cloud_init_error = output_options[:error]
         o_old_log = output_options[:old_log]
         i_cur_act = output_options[:cur_act]
+
+        tb_detect(hParams, o_old_log)
+
         if pending_count == 60
           image = server_get_image o_server
           highlight = ANSI.yellow('-' * 40)
@@ -560,10 +567,10 @@ class ForjCoreProcess
   def load_hpcloud(hParams, os_key)
     hpcloud_priv = nil
     IO.popen('gzip -c', 'r+') do|pipe|
-      pipe.puts(format('HPCLOUD_OS_USER=%s', hParams[:os_user]))
+      pipe.puts(format('HPCLOUD_OS_USER=%s', hParams['credentials#os_user']))
       pipe.puts(format('HPCLOUD_OS_KEY=%s', os_key))
-      pipe.puts(format('DNS_KEY=%s', hParams[:account_id]))
-      pipe.puts(format('DNS_SECRET=%s', hParams[:account_key]))
+      pipe.puts(format('DNS_KEY=%s', hParams[:'credentials#account_id']))
+      pipe.puts(format('DNS_SECRET=%s', hParams['credentials#account_key']))
       pipe.close_write
       hpcloud_priv = pipe.read
     end
@@ -572,29 +579,29 @@ class ForjCoreProcess
 
   def load_h_meta(hParams, hpcloud_priv)
     h_meta = {
-      'flavor_name' => hParams[:bp_flavor],
+      'flavor_name' => hParams['maestro#bp_flavor'],
       'cdksite' => config.get(:server_name),
-      'cdkdomain' => hParams[:domain_name],
+      'cdkdomain' => hParams['dns#domain_name'],
       'eroip' => '127.0.0.1',
       'erosite' => config.get(:server_name),
-      'erodomain' => hParams[:domain_name],
-      'gitbranch' => hParams[:branch],
-      'security_groups' => hParams[:security_group],
-      'tenant_name' => hParams[:tenant_name],
-      'network_name' => hParams[:network_name],
-      'hpcloud_os_region' => hParams[:compute],
+      'erodomain' => hParams['dns#domain_name'],
+      'gitbranch' => hParams['maestro#branch'],
+      'security_groups' => hParams['maestro#security_group'],
+      'tenant_name' => hParams['maestro#tenant_name'],
+      'network_name' => hParams['maestro#network_name'],
+      'hpcloud_os_region' => hParams['services#compute'],
       'PUPPET_DEBUG' => 'True',
-      'image_name' => hParams[:image_name],
-      'key_name' => hParams[:keypair_name],
+      'image_name' => hParams['maestro#image_name'],
+      'key_name' => hParams['credentials#keypair_name'],
       # Remove pad
       'hpcloud_priv' => Base64.strict_encode64(hpcloud_priv).gsub('=', ''),
-      'compute_os_auth_url' => hParams[:auth_uri]
+      'compute_os_auth_url' => hParams['credentials#auth_uri']
     }
 
-    if hParams[:dns_service]
-      h_meta['dns_zone'] = hParams[:dns_service]
-      h_meta['dns_tenantid'] = hParams[:dns_tenant_id]
-      h_meta['dns_auth_url'] = hParams[:auth_uri]
+    if hParams['dns#dns_service']
+      h_meta['dns_zone'] = hParams[:'dns#dns_service']
+      h_meta['dns_tenantid'] = hParams['dns#dns_tenant_id']
+      h_meta['dns_auth_url'] = hParams['credentials#auth_uri']
     end
     # If requested by user, ask Maestro to instantiate a blueprint.
     h_meta['blueprint'] = hParams[:blueprint] if hParams[:blueprint]
@@ -611,13 +618,15 @@ class ForjCoreProcess
       end
     end
 
+    tb_metadata hParams, h_meta
+
     h_meta
   end
 
   def build_metadata(sObjectType, hParams)
     entr = load_encoded_key
 
-    os_enckey = hParams[:os_enckey]
+    os_enckey = hParams['credentials#os_enckey']
 
     os_key = decrypt_key(os_enckey, entr)
 
@@ -1280,11 +1289,11 @@ class ForjCoreProcess
     true
   end
 
-  def forj_dns_settings?(sKey)
+  def forj_dns_settings?(key)
     # Return true to ask the question. false otherwise
     unless config[:dns_settings]
-      section = Lorj.data.first_section(sKey)
-      config.del(sKey, :name => 'account', :section => section)
+      section, key = Lorj.data.first_section(key)
+      config.del(key, :name => 'account', :section => section)
       return false # Do not ask
     end
     true
@@ -1379,7 +1388,6 @@ class ForjCoreProcess
 
     Lorj.data.set(:sections, :credentials, :keypair_files,
                   { :desc => desc }, 'setup')
-
     true
   end
 end

data/lib/process/forj_core/process/test_box.rb

@@ -0,0 +1,120 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# Functions for test-box
+class ForjCoreProcess
+  # Function which detects the repository to send out to
+  # the box
+  #
+  # * *Args*:
+  #   - +params+   : ObjParams. Take care of following data
+  #     - :test_box : Hash. Key is the repo, and
+  #       value a full path to the local repo.
+  #     - :test_box_path : full path to the test-box.sh script
+  #     - :public_ip: Used for ssh connections
+  #     - :keypairs: Used for ssh connections
+  #   - +log_output+ : log string to parse.
+  #
+  # * *returns* :
+  #   - nothing.
+  #
+  def tb_detect(hParams, log_output)
+    return unless hParams[:test_box_path]
+    tb_repos = hParams[:test_box]
+    script = hParams[:test_box_path]
+
+    # the server must wait with 4 last lines in server log:
+    # [...] - forj-cli: tb-repo=maestro tb-dir=/opt/co[...] tb-root-repo=ma[...]
+    # [...] - build.sh: test-box-repo=maestro
+    # [...] - Test-box: Waiting for ~ubuntu/git/maestro.[...]
+    # [...] - On your workstation, you can start test-b [...]
+
+    re = /forj-cli: tb-repo=(.*) tb-dir=(.*) tb-root-repo=(.*)/
+    res = log_output.split("\n")[-4].match(re)
+
+    if res
+      repo_dir = "--repo-dir #{res[2]} --root-repo #{res[3]}"
+    else
+      res = log_output.split("\n")[-3].match(/build.sh: test-box-repo=(.*)/)
+      repo_dir = ''
+    end
+    return unless res && res[1] && tb_repos[res[1]]
+
+    repo = res[1]
+
+    test_box_dir = tb_repos[repo]
+
+    PrcLib.info('test-box: your box is waiting for a test-box repository. '\
+                'One moment.')
+
+    # TODO : Add tb_ensure_ssh_config task to set this server in ~/.ssh/config.
+    # unless tb_ensure_ssh_config(hParams)
+    #  PrcLib.info('test-box: Unable to configure ssh config with this server.'\
+    #               ' You needs to do it yourself manually. Remote box boot '\
+    #               "process is waiting for #{test_box_dir}")
+    #   return
+    # end
+    PrcLib.warning('test-box: ssh config is currently not managed. You may '\
+                   'need to configure it yourself, otherwise test-box may fail')
+
+    pubip = hParams[:public_ip, :public_ip]
+    user = hParams[:image, :ssh_user]
+    # TODO: Implement testing branch warning. See build.sh lines 618 -> 632
+    cmd = <<-CMD
+cd #{test_box_dir}
+if [ "$(git branch | grep 'testing-larsonsh-#{user}@#{pubip}')" != "" ]
+then
+   #{script} --remove-from #{user}@#{pubip} --repo #{repo} #{repo_dir}
+fi
+#{script} --push-to #{user}@#{pubip} --repo #{repo} #{repo_dir}
+    CMD
+    PrcLib.info "Running following shell instructions:\n#{cmd}"
+
+    return if system(cmd)
+
+    PrcLib.error('Unable to run test-box.sh successfully. You need to run it'\
+                 ' yourself manually, now.')
+    loop do
+      break if ask("When you are done, type 'DONE'") == 'DONE'
+    end
+  end
+
+  # def tb_ensure_ssh_config(hParams)
+  #   pubip = hParams[:public_ip, :name]
+  #   user = hParams[:image, :ssh_user]
+  #
+  #   ssh_config = Net::SSH::Config.new
+  # end
+
+  # function to add extra meta data to support test-box
+  #
+  # * *Args*:
+  #   - metadata : Hash. Hash structure to update.
+  #
+  # * * returns*:
+  #   - nothing
+  def tb_metadata(hParams, metadata)
+    #   META['test-box']="test-box=$REPO_TO_ADD;testing-$(id -un)"
+    # else
+    #   META['test-box']="${META['test-box']}|$REPO_TO_ADD;testing-$(id -un)"
+    return unless hParams.exist?(:test_box_path)
+
+    meta_str = `echo "testing-$(id -un)"`.split[0]
+    res = []
+    hParams[:test_box].each_key { |k| res << format('%s;%s', k, meta_str) }
+    metadata['test-box'] = res.join('|')
+  end
+end

data/lib/{forj/ForjCli.rb → process/forj_core_process.rb}

@@ -15,23 +15,12 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-# Defines how cli will control FORJ features
-# boot/down/ssh/...
+FORJCORE_PATH = File.expand_path(File.dirname(__FILE__))
 
-# Define framework object on BaseDefinition
-# See lib/core/definition.rb for function details usage.
-class Lorj::BaseDefinition
-  # ************************************ SSH Object
-  define_obj(:ssh,
+# Define model
 
-             :create_e => :ssh_connection
-            )
-  obj_needs :CloudObject,  :forge
-  obj_needs :data,         :instance_name
-  obj_needs :data,         :keypair_name
-  obj_needs :data,         :keypair_path
+lorj_objects = %w(forj_process test_box declare)
 
-  obj_needs_optional
-  obj_needs :data,         :forge_server
-  obj_needs :data,         :ssh_user
+lorj_objects.each do |name|
+  load File.join(FORJCORE_PATH, 'forj_core', 'process', name + '.rb')
 end