bebox 0.0.1 → 0.1.0

data/lib/bebox/commands/provision_commands.rb

@@ -1,4 +1,3 @@
-require 'bebox/profile'
 
 module Bebox
   module ProvisionCommands
@@ -8,6 +7,12 @@ module Bebox
     end
 
     def load_commands
+      load_provision_commands
+      self.extend Bebox::RoleCommands
+      self.extend Bebox::ProfileCommands
+    end
+
+    def load_provision_commands
       desc 'Apply the Puppet step for the nodes in a environment. (step-0: Fundamental, step-1: User layer, step-2: Service layer, step-3: Security layer)'
       arg_name "[step]"
       command :apply do |apply_command|
@@ -16,130 +21,23 @@ module Bebox
         apply_command.action do |global_options,options,args|
           environment = get_environment(options)
           title "Environment: #{environment}"
-          require 'bebox/wizards/provision_wizard'
-          if options[:all]
-            title "Provisioning all steps..."
-            Bebox::PROVISION_STEPS.each do |step|
-              title "Provisioning #{step}:"
-              Bebox::ProvisionWizard.new.apply_step(project_root, environment, step)
-            end
-          else
-            step = args.first
-            help_now!(error('You did not specify an step')) if args.count == 0
-            help_now!(error('You did not specify a valid step')) unless valid_step?(step)
-            # Apply the step for the environment
-            title "Provisioning #{step}:"
-            Bebox::ProvisionWizard.new.apply_step(project_root, environment, step)
-          end
+          options[:all] ? apply_all(environment) : apply(environment, args)
         end
       end
+    end
 
-      # Profile commands
-      desc 'Manage profiles for the node provisioning phase.'
-      command :profile do |profile_command|
-        # Profile list command
-        profile_command.desc 'list the profiles in the project'
-        profile_command.command :list do |profile_list_command|
-          profile_list_command.action do |global_options,options,args|
-            require 'bebox/wizards/profile_wizard'
-            profiles = Bebox::ProfileWizard.new.list_profiles(project_root)
-            title 'Current profiles:'
-            profiles.map{|profile| msg(profile)}
-            warn('There are not profiles yet. You can create a new one with: \'bebox profile new\' command.') if profiles.empty?
-            linebreak
-          end
-        end
-        # Profile new command
-        profile_command.desc 'add a profile to the project'
-        profile_command.arg_name "[name]"
-        profile_command.command :new do |profile_new_command|
-          profile_new_command.flag :p, :arg_name => 'path', :desc => 'A relative path of the category folders tree to store the profile. Ex. basic/security/iptables'
-          profile_new_command.action do |global_options,options,args|
-            path = options[:p] || ''
-            help_now!(error('You did not supply a name')) if args.count == 0
-            require 'bebox/wizards/profile_wizard'
-            Bebox::ProfileWizard.new.create_new_profile(project_root, args.first, path)
-          end
-        end
-        # Profile remove command
-        profile_command.desc "remove a profile from the project"
-        profile_command.command :remove do |profile_remove_command|
-          profile_remove_command.action do |global_options,options,args|
-            require 'bebox/wizards/profile_wizard'
-            Bebox::ProfileWizard.new.remove_profile(project_root)
-          end
-        end
+    def apply_all(environment)
+      title "Provisioning all steps..."
+      Bebox::PROVISION_STEPS.each do |step|
+        Bebox::ProvisionWizard.new.apply_step(project_root, environment, step)
       end
+    end
 
-      # Roles commands
-      desc 'Manage roles for the node provisioning phase.'
-      command :role do |role_command|
-        # Role list command
-        role_command.desc 'list the roles in the project'
-        role_command.command :list do |role_list_command|
-          role_list_command.action do |global_options,options,args|
-            roles = Bebox::Role.list(project_root)
-            title 'Current roles:'
-            roles.map{|role| msg(role)}
-            warn('There are not roles yet. You can create a new one with: \'bebox role new\' command.') if roles.empty?
-            linebreak
-          end
-        end
-        # Role new command
-        role_command.desc 'add a role to the project'
-        role_command.arg_name "[name]"
-        role_command.command :new do |role_new_command|
-          role_new_command.action do |global_options,options,args|
-            help_now!(error('You did not supply a name')) if args.count == 0
-            require 'bebox/wizards/role_wizard'
-            Bebox::RoleWizard.new.create_new_role(project_root, args.first)
-          end
-        end
-        # Role remove command
-        role_command.desc "remove a role from the project"
-        role_command.command :remove do |role_remove_command|
-          role_remove_command.action do |global_options,options,args|
-            require 'bebox/wizards/role_wizard'
-            Bebox::RoleWizard.new.remove_role(project_root)
-          end
-        end
-
-        # These commands are available if there are at least one role and one profile
-        if Bebox::Role.roles_count(project_root) > 0 && Bebox::Profile.profiles_count(project_root) > 0
-          # Role list profiles command
-          role_command.desc 'list the profiles in a role'
-          role_command.arg_name "[role_name]"
-          role_command.command :list_profiles do |list_profiles_command|
-            list_profiles_command.action do |global_options,options,args|
-              help_now!(error('You did not supply a role name.')) if args.count == 0
-              role = args.first
-              require 'bebox/wizards/role_wizard'
-              exit_now!(error("The '#{role}' role does not exist.")) unless Bebox::RoleWizard.new.role_exists?(project_root, role)
-              profiles = Bebox::Role.list_profiles(project_root, role)
-              title "Current profiles in '#{role}' role:"
-              profiles.map{|profile| msg(profile)}
-              warn("There are not profiles in role '#{role}'. You can add a new one with: 'bebox role add_profile' command.") if profiles.empty?
-              linebreak
-            end
-          end
-          # Role add profile command
-          role_command.desc 'add a profile to a role'
-          role_command.command :add_profile do |add_profile_command|
-            add_profile_command.action do |global_options,options,args|
-              require 'bebox/wizards/role_wizard'
-              Bebox::RoleWizard.new.add_profile(project_root)
-            end
-          end
-          # Role remove profile command
-          role_command.desc "remove a profile from a role"
-          role_command.command :remove_profile do |remove_profile_command|
-            remove_profile_command.action do |global_options,options,args|
-              require 'bebox/wizards/role_wizard'
-              Bebox::RoleWizard.new.remove_profile(project_root)
-            end
-          end
-        end
-      end
+    def apply(environment, args)
+      step = args.first
+      help_now!(error('You did not specify an step')) if args.count == 0
+      help_now!(error('You did not specify a valid step')) unless valid_step?(step)
+      Bebox::ProvisionWizard.new.apply_step(project_root, environment, step)
     end
   end
 end

data/lib/bebox/commands/role_commands.rb

@@ -0,0 +1,83 @@
+
+module Bebox
+  module RoleCommands
+
+    def self.extended(base)
+      base.load_commands
+    end
+
+    def load_commands
+      desc 'Manage roles for the node provisioning phase.'
+      command :role do |role_command|
+        role_new_command(role_command)
+        generate_role_command(role_command, :remove, :remove_role, 'Remove a role from the project')
+        role_list_command(role_command)
+        # These commands are available if there are at least one role and one profile
+        (Bebox::Role.roles_count(project_root) > 0 && Bebox::Profile.profiles_count(project_root) > 0) ? load_role_profile_commands(role_command) : return
+      end
+    end
+
+    # Role list command
+    def role_list_command(role_command)
+      role_command.desc 'List the roles in the project'
+      role_command.command :list do |role_list_command|
+        role_list_command.action do |global_options,options,args|
+          roles = Bebox::Role.list(project_root)
+          title 'Current roles:'
+          roles.map{|role| msg(role)}
+          warn('There are not roles yet. You can create a new one with: \'bebox role new\' command.') if roles.empty?
+          linebreak
+        end
+      end
+    end
+
+    # Role new command
+    def role_new_command(role_command)
+      role_command.desc 'Add a role to the project'
+      role_command.arg_name "[name]"
+      role_command.command :new do |role_new_command|
+        role_new_command.action do |global_options,options,args|
+          help_now!(error('You did not supply a name')) if args.count == 0
+          Bebox::RoleWizard.new.create_new_role(project_root, args.first)
+        end
+      end
+    end
+
+    def load_role_profile_commands(role_command)
+      generate_role_command(role_command, :add_profile, :add_profile, 'Add a profile to a role')
+      generate_role_command(role_command, :remove_profile, :remove_profile, 'Remove a profile from a role')
+      role_list_profiles_command(role_command)
+    end
+
+    # For add_profile remove_profile and remove_role commands
+    def generate_role_command(role_command, command, send_command, description)
+      role_command.desc description
+      role_command.command command do |generated_command|
+        generated_command.action do |global_options,options,args|
+          Bebox::RoleWizard.new.send(send_command, project_root)
+        end
+      end
+    end
+
+    # Role list profiles command
+    def role_list_profiles_command(role_command)
+      role_command.desc 'List the profiles in a role'
+      role_command.arg_name "[role_name]"
+      role_command.command :list_profiles do |list_profiles_command|
+        list_profiles_command.action do |global_options,options,args|
+          help_now!(error('You did not supply a role name.')) if args.count == 0
+          role = args.first
+          exit_now!(error("The '#{role}' role does not exist.")) unless Bebox::RoleWizard.new.role_exists?(project_root, role)
+          print_profiles(role, Bebox::Role.list_profiles(project_root, role))
+        end
+      end
+    end
+
+    def print_profiles(role, profiles)
+      title "Current profiles in '#{role}' role:"
+      profiles.map{|profile| msg(profile)}
+      warn("There are not profiles in role '#{role}'. You can add a new one with: 'bebox role add_profile' command.") if profiles.empty?
+      linebreak
+    end
+  end
+end

data/lib/bebox/environment.rb

@@ -1,9 +1,9 @@
-require 'tilt'
-require 'bebox/project'
 
 module Bebox
   class Environment
 
+    include Bebox::FilesHelper
+
     attr_accessor :name, :project_root
 
     def initialize(name, project_root)
@@ -59,10 +59,7 @@ module Bebox
     # Generate the deploy file for the environment
     def generate_deploy_file
       template_name = (self.name == 'vagrant') ? 'vagrant' : "environment"
-      config_deploy_template = Tilt::ERBTemplate.new("#{templates_path}/project/config/deploy/#{template_name}.erb")
-      File.open("#{self.project_root}/config/deploy/#{self.name}.rb", 'w') do |f|
-        f.write config_deploy_template.render(nil, :nodes => nil, :environment => self.name)
-      end
+      generate_file_from_template("#{templates_path}/project/config/deploy/#{template_name}.erb", "#{self.project_root}/config/deploy/#{self.name}.rb", {nodes: nil, environment: self.name})
     end
 
     # Generate the hiera data template for the environment
@@ -71,10 +68,7 @@ module Bebox
       project_name = Bebox::Project.shortname_from_file(self.project_root)
       Bebox::PROVISION_STEPS.each do |step|
         step_dir = Bebox::Provision.step_name(step)
-        hiera_template = Tilt::ERBTemplate.new("#{templates_path}/puppet/#{step}/hiera/data/environment.yaml.erb")
-        File.open("#{self.project_root}/puppet/steps/#{step_dir}/hiera/data/#{self.name}.yaml", 'w') do |f|
-          f.write hiera_template.render(nil, :step_dir => step_dir, :ssh_key => ssh_key, :project_name => project_name)
-        end
+        generate_file_from_template("#{templates_path}/puppet/#{step}/hiera/data/environment.yaml.erb", "#{self.project_root}/puppet/steps/#{step_dir}/hiera/data/#{self.name}.yaml", {step_dir: step_dir, ssh_key: ssh_key, project_name: project_name})
       end
     end
 

data/lib/bebox/files_helper.rb

@@ -0,0 +1,37 @@
+
+module Bebox
+  module FilesHelper
+
+    def self.included(base)
+      base.extend(self)
+    end
+
+    # Generate a file from a template
+    def generate_file_from_template(template_path, file_path, options)
+      write_content_to_file(file_path, render_erb_template(template_path, options))
+    end
+
+    # Render a template for file content
+    def render_erb_template(template_path, options)
+      require 'tilt'
+      Tilt::ERBTemplate.new(template_path).render(nil, options)
+    end
+
+    # Write content to a file
+    def write_content_to_file(file_path, content)
+      File.open(file_path, 'w') do |f|
+        f.write content
+      end
+    end
+
+    # Get the content of a file with trimmed spaces
+    def file_content_trimmed(path)
+      File.read(path).gsub(/\s+/, ' ').strip
+    end
+
+    # Get the templates path inside the gem
+    def self.templates_path
+      File.join((File.expand_path '..', File.dirname(__FILE__)), 'templates')
+    end
+  end
+end

data/lib/bebox/logger.rb

@@ -1,4 +1,3 @@
-require 'colorize'
 
 # A simple logger with colored output (logs to STDOUT)
 module Bebox

data/lib/bebox/node.rb

@@ -1,10 +1,10 @@
-require 'tilt'
-require 'bebox/logger'
 
 module Bebox
   class Node
 
     include Bebox::Logger
+    include Bebox::FilesHelper
+    include Bebox::VagrantHelper
 
     attr_accessor :environment, :project_root, :hostname, :ip, :created_at, :started_at, :finished_at
 
@@ -24,7 +24,7 @@ module Bebox
 
     # Delete all files and directories related to an node
     def remove
-      remove_vagrant_box if self.environment == 'vagrant' && prepared_nodes_count > 0
+      remove_vagrant_box(self)
       remove_checkpoints
       remove_hiera_template
       remove_manifests_node
@@ -75,17 +75,12 @@ module Bebox
     def create_prepare_checkpoint(started_at)
       self.started_at = started_at
       self.finished_at = DateTime.now.to_s
-      node_template = Tilt::ERBTemplate.new("#{Bebox::Node::templates_path}/node/prepared_node.yml.erb")
-      File.open("#{self.project_root}/.checkpoints/environments/#{self.environment}/prepared_nodes/#{self.hostname}.yml", 'w') do |f|
-        f.write node_template.render(nil, :node => self)
-      end
+      generate_file_from_template("#{Bebox::FilesHelper::templates_path}/node/prepared_node.yml.erb", "#{self.project_root}/.checkpoints/environments/#{self.environment}/prepared_nodes/#{self.hostname}.yml", {node: self})
     end
 
     # Create the puppet hiera template file
     def create_hiera_template
-      options = {}
-      options[:ssh_key] = Bebox::Project.public_ssh_key_from_file(self.project_root, self.environment)
-      options[:project_name] = Bebox::Project.shortname_from_file(self.project_root)
+      options = {ssh_key: Bebox::Project.public_ssh_key_from_file(project_root, environment), project_name: Bebox::Project.shortname_from_file(project_root)}
       Bebox::Provision.generate_hiera_for_steps(self.project_root, "node.yaml.erb", self.hostname, options)
     end
 
@@ -94,38 +89,6 @@ module Bebox
       Bebox::Provision.add_node_to_step_manifests(self.project_root, self)
     end
 
-    # Prepare the vagrant nodes
-    def prepare_vagrant
-      project_name = Bebox::Project.name_from_file(self.project_root)
-      vagrant_box_base = Bebox::Project.vagrant_box_base_from_file(self.project_root)
-      configure_local_hosts(project_name)
-      add_vagrant_node(project_name, vagrant_box_base)
-    end
-
-    # Add the boxes to vagrant for each node
-    def add_vagrant_node(project_name, vagrant_box_base)
-      already_installed_boxes = installed_vagrant_box_names
-      box_name = "#{project_name}-#{self.hostname}"
-      info "Adding server to vagrant: #{self.hostname}..."
-      `cd #{self.project_root} && vagrant box add #{box_name} #{vagrant_box_base}` unless already_installed_boxes.include? box_name
-    end
-
-    # Up the vagrant boxes in Vagrantfile
-    def self.up_vagrant_nodes(project_root)
-      `cd #{project_root} && vagrant up --provision`
-    end
-
-    # Halt the vagrant boxes running
-    def self.halt_vagrant_nodes(project_root)
-      `cd #{project_root} && vagrant halt`
-    end
-
-    # return an Array with the names of the currently installed vagrant boxes
-    # @returns Array
-    def installed_vagrant_box_names
-      (`cd #{self.project_root} && vagrant box list`).split("\n").map{|vagrant_box| vagrant_box.split(' ').first}
-    end
-
     # returns an Array of the Node objects for an environment
     # @returns Array
     def self.nodes_in_environment(project_root, environment, node_type)
@@ -138,56 +101,12 @@ module Bebox
       node_objects
     end
 
-    # Generate the Vagrantfile
-    def self.generate_vagrantfile(project_root, nodes)
-      template = Tilt::ERBTemplate.new("#{templates_path}/node/Vagrantfile.erb")
-      network_interface = RUBY_PLATFORM =~ /darwin/ ? 'en0' : 'eth0'
-      project_name = Bebox::Project.name_from_file(project_root)
-      vagrant_box_provider = Bebox::Project.vagrant_box_provider_from_file(project_root)
-      File.open("#{project_root}/Vagrantfile", 'w') do |f|
-        f.write template.render(nil, :nodes => nodes, :project_name => project_name,
-          :vagrant_box_provider => vagrant_box_provider, :network_interface => network_interface)
-      end
-    end
-
-    # Backup and add the vagrant hosts to local hosts file
-    def configure_local_hosts(project_name)
-      info "\nPlease provide your account password, if ask you, to configure the local hosts file."
-      backup_local_hosts(project_name)
-      add_to_local_hosts
-    end
-
-    # Add the vagrant hosts to the local hosts file
-    def add_to_local_hosts
-      # Get the content of the hosts file
-      hosts_content = File.read("#{local_hosts_path}/hosts").gsub(/\s+/, ' ').strip
-      # Put the node lines in hosts file if not exist
-      line = "#{self.ip} #{self.hostname}"
-      node_present = (hosts_content =~ /#{self.ip}\s+#{self.hostname}/) ? true : false
-      `echo '#{line}     # Added by bebox' >> #{local_hosts_path}/hosts` unless node_present
-    end
-
-    # Backup the local hosts file
-    def backup_local_hosts(project_name)
-      # Make a backup of hosts file
-      hosts_backup_file = "#{local_hosts_path}/hosts_before_#{project_name}"
-      `sudo cp #{local_hosts_path}/hosts #{hosts_backup_file}` unless File.exist?(hosts_backup_file)
-    end
-
-    # Obtain the local hosts file for the OS
-    def local_hosts_path
-      RUBY_PLATFORM =~ /darwin/ ? '/private/etc' : '/etc'
-    end
-
     # Create checkpoint for node
     def create_node_checkpoint
       # Set the creation time for the node
       self.created_at = DateTime.now.to_s
       # Create the checkpoint file from template
-      node_template = Tilt::ERBTemplate.new("#{Bebox::Node::templates_path}/node/node.yml.erb")
-      File.open("#{self.project_root}/.checkpoints/environments/#{self.environment}/nodes/#{self.hostname}.yml", 'w') do |f|
-        f.write node_template.render(nil, :node => self)
-      end
+      generate_file_from_template("#{Bebox::FilesHelper::templates_path}/node/node.yml.erb", "#{project_root}/.checkpoints/environments/#{environment}/nodes/#{hostname}.yml", {node: self})
     end
 
     # Remove checkpoints for node
@@ -205,19 +124,6 @@ module Bebox
       Bebox::Provision.remove_node_for_steps(self.project_root, self.hostname)
     end
 
-    # Remove the specified boxes from vagrant
-    def remove_vagrant_box
-      project_name = Bebox::Project.name_from_file(self.project_root)
-      vagrant_box_provider = Bebox::Project.vagrant_box_provider_from_file(self.project_root)
-      `cd #{self.project_root} && vagrant destroy -f #{self.hostname}`
-      `cd #{self.project_root} && vagrant box remove #{project_name}-#{self.hostname} --provider #{vagrant_box_provider}`
-    end
-
-    # Get the templates path inside the gem
-    def self.templates_path
-      File.join((File.expand_path '..', File.dirname(__FILE__)), 'templates')
-    end
-
     # Get the environments path for project
     def self.environments_path(project_root)
       "#{project_root}/.checkpoints/environments"
@@ -226,24 +132,7 @@ module Bebox
     # Regenerate the deploy file for the environment
     def self.regenerate_deploy_file(project_root, environment, nodes)
       template_name = (environment == 'vagrant') ? 'vagrant' : "environment"
-      config_deploy_template = Tilt::ERBTemplate.new("#{templates_path}/project/config/deploy/#{template_name}.erb")
-      File.open("#{project_root}/config/deploy/#{environment}.rb", 'w') do |f|
-        f.write config_deploy_template.render(nil, :nodes => nodes, :environment => environment)
-      end
-    end
-
-    # Return the running status of vagrant node
-    def vagrant_box_running?
-      status = `cd #{self.project_root} && vagrant status`
-      (status =~ /#{self.hostname}\s+running/) ? true : false
-    end
-
-    # Return the existence status of vagrant node
-    def vagrant_box_exist?
-      vagrant_boxes = `cd #{project_root} && vagrant box list`
-      project_name = Bebox::Project.name_from_file(self.project_root)
-      vagrant_box_provider = Bebox::Project.vagrant_box_provider_from_file(self.project_root)
-      (vagrant_boxes =~ /#{project_name}-#{self.hostname}\s+\(#{vagrant_box_provider}/) ? true : false
+      generate_file_from_template("#{Bebox::FilesHelper::templates_path}/project/config/deploy/#{template_name}.erb", "#{project_root}/config/deploy/#{environment}.rb", {nodes: nodes, environment: environment})
     end
 
     # Count the number of prepared nodes
@@ -257,10 +146,8 @@ module Bebox
       checkpoint_directories = %w{nodes prepared_nodes steps/step-0 steps/step-1 steps/step-2 steps/step-3}
       checkpoint_directories.each do |checkpoint_directory|
         checkpoint_directory_path = "#{project_root}/.checkpoints/environments/#{environment}/#{checkpoint_directory}/#{node}.yml"
-        if File.exist?(checkpoint_directory_path)
-          creation_date = Bebox::Node.node_creation_date(project_root, environment, checkpoint_directory, node)
-          provision_state = "#{state_from_checkpoint(checkpoint_directory)} at #{creation_date}"
-        end
+        next unless File.exist?(checkpoint_directory_path)
+        provision_state = "#{state_from_checkpoint(checkpoint_directory)} at #{Bebox::Node.node_creation_date(project_root, environment, checkpoint_directory, node)}"
       end
       provision_state
     end

data/lib/bebox/profile.rb

@@ -1,8 +1,9 @@
-require 'tilt'
 
 module Bebox
   class Profile
 
+    include Bebox::FilesHelper
+
     attr_accessor :project_root, :name, :path
 
     def initialize(name, project_root, path)
@@ -36,18 +37,12 @@ module Bebox
 
     # Generate the manifests init.pp file
     def generate_manifests_file
-      manifests_template = Tilt::ERBTemplate.new("#{templates_path}/puppet/profiles/manifests/init.pp.erb")
-      File.open("#{absolute_path}/manifests/init.pp", 'w') do |f|
-        f.write manifests_template.render(nil, :profile => self)
-      end
+      generate_file_from_template("#{templates_path}/puppet/profiles/manifests/init.pp.erb", "#{absolute_path}/manifests/init.pp", {profile: self})
     end
 
     # Generate the Puppetfile
     def generate_puppetfile
-      puppetfile_template = Tilt::ERBTemplate.new("#{templates_path}/puppet/profiles/Puppetfile.erb")
-      File.open("#{absolute_path}/Puppetfile", 'w') do |f|
-        f.write puppetfile_template.render(nil)
-      end
+      generate_file_from_template("#{templates_path}/puppet/profiles/Puppetfile.erb", "#{absolute_path}/Puppetfile", {})
     end
 
     # Path to the templates directory in the gem
@@ -65,12 +60,6 @@ module Bebox
       Bebox::Profile.list(project_root).count
     end
 
-    # Check if the profile has a valid name
-    def self.valid_name?(name)
-      valid_name = (name =~ /\A[a-z][a-z0-9_]*\Z/).nil? ? false : true
-      valid_name && !Bebox::RESERVED_WORDS.include?(name)
-    end
-
     # Check if the profile has a valid path name
     def self.valid_pathname?(pathname)
       #Split the name and validate each path part
@@ -91,7 +80,7 @@ module Bebox
 
     # Create the profile path relative to the project
     def relative_path
-      File.join("#{self.path}", "#{self.name}")
+      path.empty? ? self.name : File.join("#{self.path}", "#{self.name}")
     end
 
     # Generate the namespace name from the profile relative path