forj 0.0.33 → 0.0.34

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d116642b62ded0c9f2aa26a8f3d67acf73a45d3
+  data.tar.gz: 81d3018544a5e3a211dbaf72110815cddbd0c503
+SHA512:
+  metadata.gz: e80b51b75742c2288a3351aca10d79438f94e8ce02713f14d956cadd135bfc29e9b4d8e9e90a5104ea90bb6f438c3afc4f5684989726a7cafa4cb0d47bd3d129
+  data.tar.gz: b2e2fddb8b5dbe3410f22606eb248f43f0152b83b89c0a7a7f9643f0f385e0bdcd544e7aa8cd1f02b4fcf79617322914eb75ef1716d583ae59c799ac66c7c6e5

data/README.md

@@ -1,82 +1,109 @@
 Forj cli
-=====================
+========
 
 
 Installation
-=====================
-For ruby 2.0
+------------
+### For ruby 2.0
 
-Fedora/CentOS/Redhat/rpm like system
+**Fedora/CentOS/Redhat rpm like package system**
 
-    sudo yum install ruby-dev build-essential libopenssl-ruby libssl-dev zlib1g-dev -y
-    sudo gem install forj
+    $ sudo yum install ruby-devel libxml2-devel libxslt-devel python-yaml -y
+    $ sudo gem install forj
 
-Ubuntu/Debian/debian like system (not tested)
+**Ubuntu/Debian deb like package system (not tested)**
 
-    sudo apt-get install ruby-dev build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev -y
-    sudo gem install forj
+    $ sudo apt-get install ruby-dev build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev -y
+    $ sudo gem install forj
 
-For ruby 1.9
+### For ruby 1.9
 
-    sudo apt-get install ruby-dev build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev -y
-    sudo gem install forj
+    $ sudo apt-get install ruby-dev build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev -y
+    $ sudo gem install forj
 
-For ruby 1.8
+### For ruby 1.8
 
-    sudo apt-get install ruby1.8-dev ruby1.8 ri1.8 rdoc1.8 irb1.8 -y
-    sudo apt-get install libreadline-ruby1.8 libruby1.8 libopenssl-ruby -y
-    sudo apt-get install libxslt-dev libxml2-dev -y
-    sudo gem install nokogiri
-    sudo apt-get install ruby-bundler -y
-    sudo gem install mime-types -v 1.25.1
-    sudo gem install hpcloud
-    sudo gem install forj
+    $ sudo apt-get install ruby1.8-dev ruby1.8 ri1.8 rdoc1.8 irb1.8 -y
+    $ sudo apt-get install libreadline-ruby1.8 libruby1.8 libopenssl-ruby -y
+    $ sudo apt-get install libxslt-dev libxml2-dev -y
+    $ sudo gem install nokogiri
+    $ sudo apt-get install ruby-bundler -y
+    $ sudo gem install mime-types -v 1.25.1
+    $ sudo gem install hpcloud
+    $ sudo gem install forj
 
 
-How to use forj cli
-=====================
-Setup forj
+Quick steps: How to create a forj?
+----------------------------------
 
     forj setup # follow the instructions
 
-Boot a forge
-
-    forj boot <blueprint> on <cloud_provider> as <name>
-    e.g. forj boot redstone on hpcloud as maestro_01
-
-Optional arguments
-
-    -u --build #Replace the default build.sh.
-    -d --build_config_dir # Defines the build configuration directory to load the build configuration file.
-    -c --build_config # The build config file to load <confdir>/<BoxName>.<Config>.env.
-    -b --branch # The build will extract from git branch name.
-    -t --test_box # Create test-box meta from the repository path provided.
-    -r --git_repo # The box built will use a different git repository sent out to <user_data>.
-    -h --boothook # By default, boothook file used is build/bin/build-tools/boothook.sh.
-    -x --box_name # Defines the name of the box or box image to build.
-    -k --key_name # Key pair name to import.
-    -p --key_path # Public key pair data.
-    -y --catalog # A path for the yaml file data about the blueprint
-
-Catalog.yaml example
-
-    redstone:
-      image: proto2b
-      flavor: standard.xsmall
-      ports: [22, 80, 443, 3131, 3000, 3132, 3133, 3134, 3135, 4505, 4506, 5000, 5666, 8000, 8080, 8081, 8083, 8125, 8139, 8140, 8773, 8774, 8776, 9292, 29418, 35357]
-      keypair_path: ~/.hpcloud/keypairs/nova
-      keypair_name: nova
-      router: private-ext
-      security_group: default
-      network: private
-      # at this point you have to clone the infra project manually
-      build_config_dir: ~/forj/infra/build/boxes/maestro
-      build_config: box-13.5
-      branch: master
-      box_name: maestro
-      infra: ~/.forj/infra
-    default:
-      maestro: https://github.com/forj-oss/maestro.git
+1.  Setup your first forj account.
+
+    `$ forj setup [Provider]`
+
+    Ex: `forj setup hpcloud`. In this example, your account will be named 'hpcloud'.
+    **WARNING!!!** [Provider] is currently not supported. By default, it is using hpcloud as default provider.
+
+2.  Create your forge on your default account
+
+    `$ forj boot <blueprint> on hpcloud as <InstanceName>`
+
+    Ex: `forj boot redstone on hpcloud as MyForge`
+
+
+###Forj options:
+
+To get forj cli help, just type:
+
+    $ forj
+
+To get help on specific action, just type:
+
+    $ forj help boot
+
+ Examples of possible actions:
+
+Commands:
+  forj boot <Blueprint> on <Provider> as <InstanceName> [options]  # boot a Maestro box and instruct it to provision the blueprint
+  forj down                                                        # delete the Maestro box and all systems installed by the blueprint
+  forj help [action]                                               # Describe available FORJ actions or one specific action
+  forj setup                                                       # set the credentials for forj cli
+  forj show defaults                                               # Show list of predefined value you can update in your ~/.forj/config.yaml
+  forj ssh 
+
+
+#### config.yaml description
+
+While building your forge, forj needs to load some data by default. Those are listed in forj-<version>/lib/defaults.yaml
+
+If you need to change one of this default value, update a ~/.forj/config.yaml file, with any kind of data that need to be changed.
+
+Here are the variables list you can set:
+
+     default:
+       account_name: name       # Default forj account used to connect to your cloud. This setting is automatically set to the first account created with forj setup <CloudProvider>
+       maestro_url: url         # Maestro GIT repository for clone.
+       infra_repo: path         # Path to the default Infra repository used to store your specific bootstrap/build environment. By default: ~/.forj/infra
+       image: imageName         # NOT CURRENTLY USED. Still under development.
+                                # 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)'
+                                # If you have created the generic proto2b image, you can set it here.
+       flavor: flavorName       # NOT CURRENTLY USED. Still under development.
+                                # Maestro Flavor name. This flavor is for Maestro only. Your blueprint layout defines each node flavors on needs.
+                                # By default: standard.xsmall
+       ports: [Port1,Port2,...] # list of additional ports to add in your cloud security group.
+                                # This list is added to the default one in defaults.yaml
+       keypair_path: path       # Define the file path to your OpenSSH private key. Useful to access your box with ssh command line.
+                                # By default. ~/.forj/keypairs/nova
+       keypair_name: name       # keypair name defined in your cloud to access your server. By default we named it 'nova'. If it doesn't exist, it will be created.
+       router: name             # Router name used by your forge boxes will use to access internet.
+       security_group: name     # Security group name to configure and attach to each forge boxes.
+       network: name            # Network name to attach to each forge boxes. By default we use 'private'. If it doesn't exist, it will be created.
+       # Internal use.
+       build_config: name       # forj cli use 'build.sh' to create Maestro. See build_config option on build.sh to get more information. By default 'box'
+       branch: name             # forj cli use 'build.sh' to create Maestro. See gitbranch option on build.sh to get more information. By default 'master'
+       box_name: maestro        # forj cli use 'build.sh' to create Maestro. See box_name option on build.sh to get more information. By default 'maestro'
+
 To ssh into a server
 
     forj ssh <name> <node>
@@ -89,6 +116,49 @@ We welcome all types of contributions.  Checkout our website (http://docs.forj.i
 to start hacking on Forj.  Also join us in our community (https://www.forj.io/community/) to help grow and foster Forj for
 your development today!
 
-License
-=====================
+
+Developping on FORJ:
+===================
+
+Development installation:
+-------------------------
+
+**WARNING!!!** forj cli is still under intensive development.
+
+### For ruby 2.0
+
+**Fedora/CentOS/Redhat rpm like package system**
+
+    $ sudo yum install git gcc ruby-devel libxml2-devel rubygem-rspec libxslt-devel python-yaml rubygem-nokogiri -y
+    $ gem install rspec-rake rspec-mocks rspec-expectations 
+
+**Ubuntu/Debian deb like package system (not tested)**
+
+    $ sudo apt-get install git ruby-dev build-essential libopenssl-ruby1.9.1 libssl-dev zlib1g-dev -y
+    $ gem install rspec rspec-rake rspec-mocks rspec-expectations 
+
+Then execute the following:
+
+    $ gem install forj # To install all gem required for running it.
+    $ mkdir -p ~/src/forj-oss
+    $ cd ~/src/forj-oss
+    $ git clone https://github.com/forj-oss/cli
+
+To update `forj` from the repository:
+
+    $ cd ~/src/forj-oss/cli
+    $ git pull
+
+To test `forj` cli, do the following:
+
+    $ cd ~/src/forj-oss/cli
+    $ bin/forj
+
+To run unit-test, do the following:
+
+    $ cd ~/src/forj-oss/cli
+    $ rspec -c
+
+License:
+========
 Forj Cli is licensed under the Apache License, Version 2.0.  See LICENSE for full license text.

data/bin/forj

@@ -28,63 +28,75 @@ include Setup
 require_relative '../lib/ssh.rb'
 include Ssh
 
+$APP_PATH = File.dirname(__FILE__)
+$LIB_PATH = File.expand_path(File.join(File.dirname($APP_PATH),'lib'))
+
+$FORJ_DATA_PATH= File.expand_path('~/.forj')
+$LOAD_PATH << './lib'
+
+require 'forj-config.rb' # Load class ForjConfig
 
 class Forj < Thor
-  desc 'help', 'Display forj cli help'
-  def help
-    puts 'Forj cli help'
-    puts ''
-    puts '  forj setup   # Set the credentials for forj. Currently supports only hpcloud provider.'
-    puts '    Several data will be requested like:'
-    puts '      access_key: access key from hpcloud'
-    puts '      secret_key: secret key from hpcloud'
-    puts '      auth_uri: identity endpoint'
-    puts '      tenant_id: id for the tenant you want to use'
-    puts '      availability_zone: which availability zone will be deployed'
-    puts ''
-    puts '  forj boot <Blueprint> on <Provider> as <InstanceName> [options]  # Boot a new forge with the following options'
-    puts '    where:'
-    puts '      blueprint    : Is the name of the blueprint (currently cli only supports redstone)'
-    puts '      Provider     : in which cloud provider to deploy the forge'
-    puts '      InstanceName : name of the forge'
-    puts ''
-    puts '    Ex: forj boot redstone on hpcloud as maestro_test'
-    puts ''
-    puts '    [Options] are:'
-    puts '      -b build: replace the default build.sh'
-    puts '      -bcd build_config_dir: defines the build configuration directory to load the build configuration file'
-    puts '      -bc build_config: the build config file to load <confdir>/<BoxName>.<Config>.env.'
-    puts '      -gb branch: the build will extract from git branch name'
-    puts '      -tb test_box (not yet implemented): create test-box meta from the repository path provided.'
-    puts '      -gr git_repo: the box built will use a different git repository sent out to <user_data>'
-    puts '      -bh boothook: by default, boothook file used is build/bin/build-tools/boothook.sh. Use this option to set another one.'
-    puts '      -bn box_name: defines the name of the box or box image to build.'
-    puts ''
-    puts '  forj ssh <Name> <Node>    # Connect through ssh to an existing instance'
-    puts '    where'
-    puts '      InstanceName: is the name of the forge (maestro_test)'
-    puts '      Node        : is the name of the node (maestro, ci, etc...)'
-    puts ''
-    puts '  forj down  <InstanceName>  # Delete a forge and create a backup of your data'
-    puts '    not yet implemented'
-    puts ''
-    puts '  forj help    # Display this help'
-  end
 
-  desc 'boot', 'boot a Maestro box and instruct it to provision the blueprint'
 
-  method_option :build,            :aliases => '-u',   :desc => 'Replace the default build.sh'
-  method_option :infra,            :aliases => '-I',   :desc => 'Defines the Infra directory to load the build configuration file. You can set FORJ_INFRA_DIR. By default, it will look in your current directory.'
-  method_option :build_config,     :aliases => '-c',   :desc => 'The build config file to load <confdir>/<BoxName>.<Config>.env. By default, uses "master" as Config.'
-  method_option :branch,           :aliases => '-b',   :desc => 'The build will extract from git branch name. It sets the configuration build <config> to the branch name <branch>.'
-  method_option :test_box,         :aliases => '-t',   :desc => 'Create test.rb-box meta from the repository path provided.'
-  method_option :git_repo,         :aliases => '-r',   :desc => 'The box built will use a different git repository sent out to <user_data>. This repository needs to be read only. No keys are sent.'
-  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 :box_name,         :aliases => '-x',   :desc => 'Defines the name of the box or box image to build.'
+  desc "help [action]", "Describe available FORJ actions or one specific action"
+  def help(task = nil, subcommand = false)
+    if task
+       self.class.task_help(shell, task)
+    else   
+       puts <<-LONGDESC
+Quick steps: How to create a forj?
+----------------------------------
+
+1.  Setup your first forj account.
+    `$ forj setup [Provider]`
+
+    Ex: `forj setup hpcloud`. In this example, your account will be named 'hpcloud'.
+    
+IMPORTANT NOTE: Without any provider, forj setup will choose 'hpcloud' as provider. 
+                Currently, forj supports only hpcloud. Openstack will be available soon.
+
+2.  Create your forge on your default account
+    `$ forj boot <blueprint> on <Provider> as <InstanceName> `
+
+    Ex: `forj boot redstone on hpcloud as MyForge` 
+       
+forj command line details:
+--------------------------
+       LONGDESC
+       self.class.help(shell, subcommand)
+    end
+  end 
+
+  # BOOT 
+  desc 'boot <Blueprint> on <Provider> as <InstanceName> [options]', 'boot a Maestro box and instruct it to provision the blueprint'
+  
+  long_desc <<-LONGDESC
+This task boot a new forge with the following options
+\x5- blueprint : Is the name of the blueprint (currently cli only supports redstone)
+\x5- Provider : in which cloud provider to deploy the forge
+\x5- InstanceName : name of the forge
+
+    Ex: forj boot redstone on hpcloud as maestro_test
+
+`forj boot` load predefine valued from `lib/defaults.yaml`. If you need to change one of them, add this value in your ~/.forj/config.yaml.
+The list of predefined values can be retrieved with forj show defaults
+
+  LONGDESC
+
+  method_option :config,           :aliases => '-c',   :desc => 'Path to a different forj config file. By default, use ~/.forj/config.yaml'
+  method_option :infra,            :aliases => '-i',   :desc => 'Defines your Infra directory to use while booting. You can also set FORJ_INFRA_DIR.'
   method_option :key_name,         :aliases => '-k',   :desc => 'Import a key pair.'
   method_option :key_path,         :aliases => '-p',   :desc => 'Public key data'
-  method_option :catalog,          :aliases => '-y',   :desc => 'A path for the yaml file data about the blueprint'
 
+  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 :build_config,     :aliases => '-C',   :desc => 'The build config file to load <confdir>/<BoxName>.<Config>.env. By default, uses "master" as Config.'
+  method_option :git_repo,         :aliases => '-R',   :desc => 'The box built will use a different git repository sent out to <user_data>. This repository needs to be read only. No keys are sent.'
+  method_option :branch,           :aliases => '-B',   :desc => 'The build will extract from git branch name. It sets the configuration build <config> to the branch name <branch>.'
+  method_option :box_name,         :aliases => '-N',   :desc => 'Defines the name of the box or box image to build.'
+  method_option :test_box,         :aliases => '-T',   :desc => 'Create test.rb-box meta from the repository path provided.'
+ 
   def boot(blueprint, on, cloud_provider, as, name, test = false)
       Boot.boot(blueprint, cloud_provider, name,
                 options[:build], options[:build_config_dir],
@@ -92,20 +104,54 @@ class Forj < Thor
                 options[:git_repo], options[:boothook],
                 options[:box_name], options[:key_name],
                 options[:key_path],options[:region],
-                options[:catalog], test)
+                options[:config], test)
   end
 
+  desc 'show defaults', 'Show list of predefined value you can update in your ~/.forj/config.yaml'
+
+  def show(name)
+     oConfig=ForjConfig.new()
+     
+     puts 'List of predefined values:
+--------------------------'
+     puts oConfig.yDefaults['default'].to_yaml()
+     puts '--------------------------'
+     puts "You can set any of those variable in your ~/.forj/config.yaml, under section 'default:'"
+  end
+  # DOWN
   desc 'down', 'delete the Maestro box and all systems installed by the blueprint'
+  long_desc <<-LONGDESC
+  Not yet implemented
+  LONGDESC
+  
   def down(name)
     Down.down(name)
   end
 
+  # SSH
   desc 'ssh', 'connect to your forge thru ssh'
+  long_desc <<-LONGDESC
+Connect through ssh to an existing instance
+    
+        not yet implemented
+  LONGDESC
+  
   def ssh(name, server)
     Ssh.connect(name, server)
   end
 
+  # SETUP
   desc 'setup', 'set the credentials for forj cli'
+  long_desc <<-LONGDESC
+Set the cloud credentials and services for forj. Currently supports only hpcloud provider.
+
+Several data will be requested like:
+\x5- access_key: access key from hpcloud
+\x5- secret_key: secret key from hpcloud
+\x5- auth_uri: identity endpoint
+\x5- tenant_id: id for the tenant you want to use
+\x5- availability_zone: which availability zone will be deployed
+  LONGDESC
   def setup
     Setup.setup
   end

data/lib/boot.rb

@@ -16,8 +16,6 @@
 #    limitations under the License.
 
 
-
-
 require_relative 'network.rb'
 include Network
 require_relative 'yaml_parse.rb'
@@ -31,6 +29,7 @@ include Logging
 require_relative 'helpers.rb'
 include Helpers
 
+
 #
 # Boot module
 #
@@ -38,28 +37,24 @@ module Boot
   def boot(blueprint, cloud_provider, name,
       build, infra_dir, build_config,
       branch, git_repo, boothook, box_name,
-      key_name, key_path, region, catalog,
+      key_name, key_path, region, config,
       test = false)
     begin
       initial_msg = 'booting %s on %s (~/.forj/forj.log)' % [blueprint , cloud_provider]
 
       Logging.info(initial_msg)
-      puts ('INFO: Reading default configuration...')
 
       forj_dir = File.expand_path(File.dirname(__FILE__))
       Dir.chdir(forj_dir)
 
-      #TODO: Consider defaults.yaml as default variables, and load more from ~/.forj/forj-config.yaml, to change defaults on user need.
-      if catalog
-        definitions = YamlParse.get_values(catalog)
-      else
-        definitions = YamlParse.get_values('defaults.yaml')
-      end
-      
+      puts ('INFO: Reading default configuration...')
+      oConfig=ForjConfig.new(config)
+      hConfig=oConfig.yConfig['default']
+
       # Initialize defaults
-      maestro_url =  definitions['default']['maestro_url']
+      maestro_url =  hConfig['maestro_url']
 
-      infra_dir = definitions['default']['infra_repo'] unless infra_dir
+      infra_dir = hConfig['infra_repo'] unless infra_dir
 
       # Ask information if needed.
       bBuildInfra=false
@@ -77,31 +72,31 @@ module Boot
       # Step Maestro Clone
       puts('INFO: cloning maestro repo from \'%s\'...' % maestro_url)
       Repositories.clone_repo(maestro_url)
-      
+
       if bBuildInfra
          puts('INFO: Building your infra... in \'%s\'' % [infra_dir])
          Repositories.create_infra
       end
 
-      puts('INFO: Configuring network \'%s\'' % [definitions['default']['network']])
-      network = Network.get_or_create_network(definitions['default']['network'])
+      puts('INFO: Configuring network \'%s\'' % [hConfig['network']])
+      network = Network.get_or_create_network(hConfig['network'])
       begin
         subnet = Network.get_or_create_subnet(network.id, name)
-        router = Network.get_router(definitions['default']['router'])
+        router = Network.get_router(hConfig['router'])
         Network.create_router_interface(subnet.id, router)
       rescue => e
         puts e.message
       end
 
 
-      puts('INFO: Configuring keypair \'%s\'' % [definitions['default']['keypair_name']])
-      key_name = definitions['default']['keypair_name'] unless key_name
-      key_path = definitions['default']['keypair_path'] unless key_path
+      puts('INFO: Configuring keypair \'%s\'' % [hConfig['keypair_name']])
+      key_name = hConfig['keypair_name'] unless key_name
+      key_path = hConfig['keypair_path'] unless key_path
       SecurityGroup.upload_existing_key(key_name, key_path)
 
-      puts('INFO: Configuring Security Group \'%s\'' % [definitions['default']['security_group']])
-      security_group = SecurityGroup.get_or_create_security_group(definitions['default']['security_group'])
-      ports = definitions['default']['ports']
+      puts('INFO: Configuring Security Group \'%s\'' % [hConfig['security_group']])
+      security_group = SecurityGroup.get_or_create_security_group(hConfig['security_group'])
+      ports = hConfig['ports']
 
       ports.each do|port|
         Network.get_or_create_rule(security_group.id, 'tcp', port, port)
@@ -124,19 +119,19 @@ module Boot
 
       build = 'bin/build.sh' unless build
 
-      build_config = definitions['default']['build_config'] unless build_config
+      build_config = hConfig['build_config'] unless build_config
 
-      branch = definitions['default']['branch'] unless branch
+      branch = hConfig['branch'] unless branch
 
-      box_name = definitions['default']['box_name'] unless box_name
+      box_name = hConfig['box_name'] unless box_name
 
-      meta = '--meta blueprint=%s  --meta HPCLOUD_PRIV=~/.cache/forj/master.forj-13.5.g64' % [blueprint]
+      meta = '--meta blueprint=%s ' % [blueprint]
 
       command = '%s --build_ID %s --box-name %s --build-conf-dir %s --build-config %s --gitBranch %s --debug-box %s' % [build, name, box_name, infra_dir, build_config, branch, meta]
 
       Logging.info('Calling build.sh')
       Logging.info(command)
-      
+
       Kernel.system(command)
       Dir.chdir(current_dir)
 

data/lib/defaults.yaml

@@ -24,7 +24,6 @@ default:
   security_group: default
   network: private
   # at this point you have to clone the infra project manually
-  build_config_dir: ~/forj/infra/build/boxes/maestro
   build_config: box
   branch: master
   box_name: maestro

data/lib/forj-config.rb

@@ -0,0 +1,163 @@
+#!/usr/bin/env ruby
+# 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.
+
+
+# puts "test_library included"
+
+require 'rubygems'
+require 'yaml'
+
+require_relative 'log.rb'
+include Logging
+
+class ForjDefault
+
+   # @sDefaultsName='defaults.yaml'
+   # @yDefaults = defaults.yaml file data hash
+
+   attr_reader   :yDefaults
+   
+   def initialize()
+      # Load yaml documents (defaults)
+      # If config doesn't exist, it will be created, empty with 'defaults:' only
+
+      if not $LIB_PATH
+         raise 'Internal $LIB_PATH was not set.'
+      end
+
+      @sDefaultsName=File.join($LIB_PATH,'defaults.yaml')
+
+      @yDefaults=YAML.load_file(@sDefaultsName)
+   end
+
+end
+
+class ForjConfig 
+
+   # Internal variables:
+   # @sConfigName='config.yaml'
+   # @yLocal = config.yaml file data hash.
+   # @yConfig = defaults.yaml + local_config data hash
+   
+
+   attr_reader   :yLocal
+   attr_reader   :yConfig
+   attr_reader   :sConfigName
+
+   def initialize(sConfigName=nil)
+      # Load yaml documents (defaults + config)
+      # If config doesn't exist, it will be created, empty with 'defaults:' only
+
+
+      if not $FORJ_DATA_PATH
+         raise 'Internal $FORJ_DATA_PATH was not set.'
+      end
+
+      sConfigDefaultName='config.yaml'
+
+      # binding.pry
+      if sConfigName
+         if File.dirname(sConfigName) == '.'
+            sConfigName= File.join($FORJ_DATA_PATH,sConfigName)
+         end  
+         sConfigName = File.expand_path(sConfigName)
+         if not File.exists?(sConfigName)
+            Logging.error('Config file %s doesn\'t exists. Using default one.')
+            @sConfigName=File.join($FORJ_DATA_PATH,sConfigDefaultName)
+         else   
+            @sConfigName=sConfigName
+         end
+      else
+         @sConfigName=File.join($FORJ_DATA_PATH,sConfigDefaultName)
+      end
+
+
+      @Default=ForjDefault.new
+      
+    
+      if File.exists?(@sConfigName)
+         @yLocal=YAML.load_file(@sConfigName)
+      else
+         @yLocal={ 'default' => nil }
+         if not File.exists?(@sConfigName)
+            # Write the empty file
+            if not File.exists?($FORJ_DATA_PATH)
+               Dir.mkdir($FORJ_DATA_PATH)
+            end
+            puts ('INFO: Creating your default configuration file ...')
+            self.SaveConfig()
+         end
+      end
+     
+      BuildConfig()
+   end
+
+
+   def SaveConfig()
+     begin
+       File.open(@sConfigName, 'w') do |out|
+         YAML.dump(@yLocal, out)
+       end
+     rescue => e
+       Logging.error(e.message)
+       return false
+     end
+     # puts ('INFO: Configuration file "%s" updated.' % @sConfigName)
+     return true
+   end
+   
+   def ConfigSet(key, value, section = 'default')
+     if not key or not value
+        return false
+     end
+     if @yLocal[section] == nil
+        @yLocal[section]={}
+     end
+     if @yLocal.has_key?(section)
+        @yLocal[section].merge!({key => value})
+     else
+        @yLocal.merge!(section => {key => value})
+     end   
+     BuildConfig()
+     return true
+   end
+   
+   def ConfigDel(key,section = 'default')
+     if not key
+        return false
+     end
+     if not @yLocal.has_key?(section)
+        return false
+     end   
+     @yLocal[section].delete(key)
+     BuildConfig()
+     return true
+   end
+   
+  
+   def BuildConfig()
+      # This function implements the logic to get defaults, superseed by local config. 
+      # Take care of ports array, which is simply merged.
+      
+      @yConfig={ 'default' => @Default.yDefaults['default'].clone }
+      if @yLocal['default']
+         @yConfig['default'].merge!(@yLocal['default']) { |key, oldval, newval| key == 'ports'? newval.clone.push(oldval.clone).flatten: newval }
+      end   
+      @yConfig.merge!(@yLocal) { |key, oldval, newval| key == 'default'? oldval: newval }
+   end
+
+end

data/lib/setup.rb

@@ -21,6 +21,8 @@ require 'highline/import'
 
 require_relative 'yaml_parse.rb'
 include YamlParse
+require_relative 'helpers.rb'
+include Helpers
 
 #
 # Setup module call the hpcloud functions
@@ -40,6 +42,7 @@ def setup_credentials
   hpcloud_os_key = ask('Enter hpcloud password: ') { |q| q.echo = '*'}
 
   home = File.expand_path('~')
+  Helpers.create_directory('%s/.cache/forj/' % [home])
   creds = '%s/.cache/forj/creds' % [home]
 
   values = {:credentials => {:hpcloud_os_user=> hpcloud_os_user, :hpcloud_os_key=> hpcloud_os_key}}
@@ -67,12 +70,9 @@ def save_cloud_fog
   os_key = local_template[:credentials][:hpcloud_os_key]
 
   File.open(cloud_fog, 'w') {|file|
-    file.write('HPCLOUD_OS_USER=%s' % [os_user])
-    file.write("\n")
-    file.write('HPCLOUD_OS_KEY=%s' % [os_key])
-    file.write("\n")
-    file.write('DNS_KEY=%s' % [access_key])
-    file.write("\n")
+    file.write('HPCLOUD_OS_USER=%s' % [os_user] + "\n")
+    file.write('HPCLOUD_OS_KEY=%s' % [os_key] + "\n")
+    file.write('DNS_KEY=%s' % [access_key] + "\n")
     file.write('DNS_SECRET=%s' % [secret_key])
   }
 

data/spec/forj-config_spec.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+# 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.
+
+class TestClass
+end
+
+require_relative '../lib/forj-config.rb'
+$APP_PATH = File.dirname(__FILE__)
+$LIB_PATH = File.expand_path(File.join(File.dirname($APP_PATH),'lib'))
+$FORJ_DATA_PATH= File.expand_path('~/.forj')
+
+describe 'forj cli' do
+  describe ".forj-config" do
+    context "new instance" do
+
+      it 'should be loaded' do
+         @test_config=ForjConfig.new()
+         expect(@test_config).to be
+      end
+
+    end
+
+    context "Config in memory" do
+      before(:all) do
+         @config=ForjConfig.new()
+      end
+      
+      it 'should be able to create a key/value in local config' do
+         @config.ConfigSet('test1','value')
+         @config.yConfig['default']['test1'].should == 'value'
+      end
+
+      it 'should be able to remove the previously created key/value from local config' do
+         @config.ConfigDel('test1')
+         @config.yConfig['default'].key?('test1').should == false
+      end
+    end   
+
+    
+    context "Updating local config file" do
+      before(:all) do
+         @config=ForjConfig.new() 
+      end
+      
+      after(:all)  do
+        @config.ConfigDel('test1')
+        @config.SaveConfig()
+      end  
+
+      it 'should save a key/value in local config' do
+         @config.ConfigSet('test1','value')
+         @config.SaveConfig().should == true
+      end
+      
+      it 'should get the saved value from local config' do
+         oConfig=ForjConfig.new()
+         @config.yConfig['default']['test1'].should == 'value'
+      end
+  
+    end
+
+    context "Updating another config file from .forj" do
+
+      before(:all) do
+        if File.exists?('~/.forj/test.yaml')
+           File.delete(File.expand_path('~/.forj/test.yaml'))
+        end
+        File.open(File.expand_path('~/.forj/test1.yaml'), 'w+') { |file| file.write("default:\n") }
+        @config=ForjConfig.new('test.yaml')
+        @config2=ForjConfig.new('test1.yaml')
+      end
+      
+      after(:all)  do
+        File.delete(File.expand_path('~/.forj/test1.yaml'))
+      end  
+
+      it 'If file do not exist, warning! and file is not created.' do
+         File.exists?(File.expand_path('~/.forj/test.yaml')).should == false
+      end
+      
+      it 'Then, default config is loaded.' do
+         File.basename(@config.sConfigName).should == 'config.yaml'
+      end
+
+      it 'test1.yaml config is loaded.' do
+         File.basename(@config2.sConfigName).should == 'test1.yaml'
+      end
+
+      it 'should save a key/value in test2 config' do
+         @config2.ConfigSet('test2','value')
+         @config2.SaveConfig().should == true
+      end
+
+  
+    end
+  end
+
+end

data/spec/repositories_spec.rb

@@ -27,11 +27,11 @@ class TestClass
 end
 
 describe 'repositories' do
-  it 'its clonning the repo' do
+  it 'should clone the repo' do
     @test_class = TestClass.new
     @test_class.extend(Repositories)
 
-    repo = @test_class.clone_repo
+    repo = @test_class.clone_repo('https://github.com/forj-oss/maestro')
     expect(repo).to be
   end
-end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forj
 version: !ruby/object:Gem::Version
-  version: 0.0.33
-  prerelease: 
+  version: 0.0.34
 platform: ruby
 authors:
 - forj team
@@ -13,81 +12,102 @@ date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &16777300 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.16.0
   type: :runtime
   prerelease: false
-  version_requirements: *16777300
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &16776760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.11
   type: :runtime
   prerelease: false
-  version_requirements: *16776760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.11
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &16776080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.19.0
   type: :runtime
   prerelease: false
-  version_requirements: *16776080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: hpcloud
-  requirement: &16775160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.8
   type: :runtime
   prerelease: false
-  version_requirements: *16775160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.8
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &16773180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.7
   type: :runtime
   prerelease: false
-  version_requirements: *16773180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.7
 - !ruby/object:Gem::Dependency
   name: rbx-require-relative
-  requirement: &16771380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *16771380
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &16786340 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.21
   type: :runtime
   prerelease: false
-  version_requirements: *16786340
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.21
 description: forj command line
 email:
 - forj@forj.io
@@ -112,6 +132,7 @@ files:
 - lib/log.rb
 - lib/helpers.rb
 - lib/build_tmpl/build-env.py
+- lib/forj-config.rb
 - spec/boot_spec.rb
 - spec/connection_spec.rb
 - spec/down_spec.rb
@@ -121,32 +142,32 @@ files:
 - spec/spec_helper.rb
 - spec/ssh_spec.rb
 - spec/yaml_parse_spec.rb
+- spec/forj-config_spec.rb
 - Rakefile
 - Gemfile
 - README.md
 homepage: https://forj.io
 licenses:
 - Apache License, Version 2.0.
+metadata: {}
 post_install_message: Go to docs.forj.io for more information on how to use forj cli
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.5
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: forj command line
 test_files: []