bebox 0.0.1

data/bin/bebox

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'bebox/cli'
+require 'bebox/version'
+
+Bebox::Cli.new(ARGV)

data/lib/bebox/cli.rb

@@ -0,0 +1,42 @@
+require 'gli'
+require 'highline/import'
+require 'bebox/logger'
+
+module Bebox
+  class Cli
+    include Bebox::Logger
+
+    attr_accessor :project_root
+
+    def initialize(*args)
+      # add the GLI magic on to the Bebox::Cli instance
+      self.extend GLI::App
+
+      program_desc 'Create basic provisioning of remote servers.'
+      version Bebox::VERSION
+
+      if inside_project?
+        require 'bebox/commands/project_commands'
+        self.extend Bebox::ProjectCommands
+      else
+        require 'bebox/commands/general_commands'
+        self.extend Bebox::GeneralCommands
+      end
+      exit run(*args)
+    end
+
+    # Search recursively for .bebox file to see
+    # if current directory is a bebox project or not
+    def inside_project?
+      project_found = false
+      cwd = Pathname(Dir.pwd)
+      home_directory = File.expand_path('~')
+      cwd.ascend do |current_path|
+        project_found = File.file?("#{current_path.to_s}/.bebox")
+        self.project_root = current_path.to_s if project_found
+        break if project_found || (current_path.to_s == home_directory)
+      end
+      project_found
+    end
+  end
+end

data/lib/bebox/commands/commands_helper.rb

@@ -0,0 +1,33 @@
+module Bebox
+  module CommandsHelper
+    # Obtain the environment from command parameters or menu
+    def get_environment(options)
+      environment = options[:environment]
+      # Ask for environment of node if flag environment not set
+      environment ||= Bebox::EnvironmentWizard.new.choose_environment(Environment.list(project_root))
+      # Check environment existence
+      Bebox::Environment.environment_exists?(project_root, environment) ? (return environment) : exit_now!(error("The '#{environment}' environment does not exist."))
+    end
+
+    # Obtain the default environment for a project
+    def default_environment
+      environments = Bebox::Environment.list(project_root)
+      if environments.count > 0
+        return environments.include?('vagrant') ? 'vagrant' : environments.first
+      else
+        return ''
+      end
+    end
+
+    # Check if vagrant is installed on the machine
+    def vagrant_installed?
+      (`which vagrant`) == 'vagrant not found' ? false : true
+    end
+
+    # Check if the step argument is valid
+    def valid_step?(step)
+      steps = %w{step-0 step-1 step-2 step-3}
+      steps.include?(step)
+    end
+  end
+end

data/lib/bebox/commands/environment_commands.rb

@@ -0,0 +1,46 @@
+module Bebox
+  module EnvironmentCommands
+
+    def self.extended(base)
+      base.load_commands
+    end
+
+    def load_commands
+      # Environment management phase commands
+      desc 'Manage environments for the project. The \'vagrant\', \'production\' and \'staging\' environments are present by default.'
+      command :environment do |environment_command|
+        # Environment list command
+        environment_command.desc 'list the remote environments in the project'
+        environment_command.command :list do |environment_list_command|
+          environment_list_command.action do |global_options,options,args|
+            require 'bebox/environment'
+            environments = Bebox::Environment.list(project_root)
+            title 'Current environments:'
+            environments.map{|environment| msg(environment)}
+            warn('There are not environments yet. You can create a new one with: \'bebox environment new\' command.') if environments.empty?
+          end
+        end
+        # Environment new command
+        environment_command.desc 'add a remote environment to the project'
+        environment_command.arg_name "[environment]"
+        environment_command.command :new do |environment_new_command|
+          environment_new_command.action do |global_options,options,args|
+            help_now!(error('You did not supply an environment')) if args.count == 0
+            require 'bebox/wizards/environment_wizard'
+            Bebox::EnvironmentWizard.new.create_new_environment(project_root, args.first)
+          end
+        end
+        # Environment remove command
+        environment_command.desc "remove a remote environment in the project"
+        environment_command.arg_name "[environment]"
+        environment_command.command :remove do |environment_remove_command|
+          environment_remove_command.action do |global_options,options,args|
+            help_now!(error('You did not supply an environment')) if args.count == 0
+            require 'bebox/wizards/environment_wizard'
+            Bebox::EnvironmentWizard.new.remove_environment(project_root, args.first)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bebox/commands/general_commands.rb

@@ -0,0 +1,24 @@
+module Bebox
+  module GeneralCommands
+
+    def self.extended(base)
+      base.load_commands
+    end
+
+    def load_commands
+      # Project creation phase command
+      desc 'Create a new bebox project through a simple wizard'
+      arg_name '[project_name]'
+      command :new do |project_command|
+        project_command.action do |global_options,options,args|
+          if args.count > 0
+            require 'bebox/wizards/project_wizard'
+            Bebox::ProjectWizard.new.create_new_project("bebox-#{args.first}")
+          else
+            help_now!(error('You did not supply a project name'))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bebox/commands/node_commands.rb

@@ -0,0 +1,68 @@
+require 'bebox/role'
+require 'bebox/node'
+
+module Bebox
+  module NodeCommands
+
+    def self.extended(base)
+      base.load_commands
+    end
+
+    def load_commands
+      # Nodes management phase commands
+      desc 'Manage nodes for a environment in the project.'
+      command :node do |node_command|
+        # Node list command
+        node_command.flag :environment, :desc => 'Set the environment for nodes', default_value: default_environment
+        node_command.desc 'list the nodes in a environment'
+        node_command.command :list do |node_list_command|
+          node_list_command.switch :all
+          node_list_command.action do |global_options,options,args|
+            # Call to list nodes
+            environments = options[:all] ? Bebox::Environment.list(project_root) : [get_environment(options)]
+            environments.each do |environment|
+              nodes = Node.list(project_root, environment, 'nodes')
+              title "Nodes for '#{environment}' environment:"
+              nodes.map{|node| msg("#{node}     (#{Bebox::Node.node_provision_state(project_root, environment, node)})")}
+              warn('There are not nodes yet in the environment. You can create a new one with: \'bebox node new\' command.') if nodes.empty?
+            end
+            linebreak
+          end
+        end
+        # Node new command
+        node_command.desc 'add a node to a environment'
+        node_command.command :new do |node_new_command|
+          node_new_command.action do |global_options,options,args|
+            environment = get_environment(options)
+            info "Environment: #{environment}"
+            require 'bebox/wizards/node_wizard'
+            Bebox::NodeWizard.new.create_new_node(project_root, environment)
+          end
+        end
+        # Node remove command
+        node_command.desc "remove a node in a environment"
+        node_command.command :remove do |node_remove_command|
+          node_remove_command.action do |global_options,options,args|
+            environment = get_environment(options)
+            info "Environment: #{environment}"
+            require 'bebox/wizards/node_wizard'
+            Bebox::NodeWizard.new.remove_node(project_root, environment, args.first)
+          end
+        end
+        # These commands are available if there is at least one role and one node
+        if Bebox::Role.roles_count(project_root) > 0 && Bebox::Node.count_all_nodes_by_type(project_root, 'nodes') > 0
+          # Associate node to role command
+          node_command.desc "Associate a node with a role in a environment"
+          node_command.command :set_role do |node_role_command|
+            node_role_command.action do |global_options,options,args|
+              environment = get_environment(options)
+              info "Environment: #{environment}"
+              require 'bebox/wizards/node_wizard'
+              Bebox::NodeWizard.new.set_role(project_root, environment)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bebox/commands/prepare_commands.rb

@@ -0,0 +1,59 @@
+module Bebox
+  module PrepareCommands
+
+    def self.extended(base)
+      base.load_commands
+    end
+
+    def load_commands
+      # Prepare nodes phase commands
+      desc 'Prepare the nodes for the environment.'
+      command :prepare do |prepare_command|
+        prepare_command.flag :environment, :desc => 'Set the environment of node', default_value: default_environment
+        prepare_command.action do |global_options,options,args|
+          environment = get_environment(options)
+          # Check if vagrant is installed
+          return error('Vagrant is not installed in the system. No changes were made.') unless vagrant_installed?
+          title "Environment: #{environment}"
+          require 'bebox/wizards/node_wizard'
+          Bebox::NodeWizard.new.prepare(project_root, environment)
+        end
+      end
+      # These commands are available if there are at least one node in the vagrant environment
+      if Bebox::Node.list(project_root, 'vagrant', 'prepared_nodes').count > 0
+        desc 'Halt the nodes for vagrant environment.'
+        command :vagrant_halt do |vagrant_halt_command|
+          vagrant_halt_command.action do |global_options,options,args|
+            # Check if vagrant is installed
+            return error('Vagrant is not installed in the system. No changes were made.') unless vagrant_installed?
+            # List nodes in environment and notice message
+            nodes = Bebox::Node.nodes_in_environment(project_root, 'vagrant', 'nodes')
+            environment = 'vagrant'
+            title "Environment: #{environment}"
+            title 'Halting nodes:'
+            nodes.each{|node| msg(node.hostname)}
+            linebreak
+            # Halt vagrant nodes
+            Bebox::Node.halt_vagrant_nodes(project_root)
+          end
+        end
+        desc 'Up the nodes for vagrant environment.'
+        command :vagrant_up do |vagrant_up_command|
+          vagrant_up_command.action do |global_options,options,args|
+            # Check if vagrant is installed
+            return error('Vagrant is not installed in the system. No changes were made.') unless vagrant_installed?
+            # List nodes in environment and notice message
+            nodes = Bebox::Node.nodes_in_environment(project_root, 'vagrant', 'nodes')
+            environment = 'vagrant'
+            title "Environment: #{environment}"
+            title 'Running up nodes:'
+            nodes.each{|node| msg(node.hostname)}
+            linebreak
+            # Up vagrant nodes
+            Bebox::Node.up_vagrant_nodes(project_root)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bebox/commands/project_commands.rb

@@ -0,0 +1,44 @@
+require 'bebox/commands/commands_helper'
+
+module Bebox
+  module ProjectCommands
+
+    include Bebox::CommandsHelper
+
+    def self.extended(base)
+      base.load_commands
+    end
+
+    def load_commands
+      require 'bebox/commands/environment_commands'
+      require 'bebox/environment'
+      self.extend Bebox::EnvironmentCommands
+      # This commands only run if there are environments configured
+      if Bebox::Environment.list(project_root).count > 0
+        require 'bebox/commands/node_commands'
+        self.extend Bebox::NodeCommands
+        # These commands are available if there are at least one node configured in the project
+        if Bebox::Node.count_all_nodes_by_type(project_root, 'nodes') > 0
+          require 'bebox/commands/prepare_commands'
+          self.extend Bebox::PrepareCommands
+          # These commands are available if there are at least one prepared_node
+          if Bebox::Node.count_all_nodes_by_type(project_root, 'prepared_nodes') > 0
+            # load_provision_commands
+            require 'bebox/commands/provision_commands'
+            self.extend Bebox::ProvisionCommands
+          end
+        end
+      end
+      pre do |global_options,command,options,args|
+        true
+      end
+
+      post do |global_options,command,options,args|
+      end
+
+      on_error do |exception|
+        true
+      end
+    end
+  end
+end

data/lib/bebox/commands/provision_commands.rb

@@ -0,0 +1,145 @@
+require 'bebox/profile'
+
+module Bebox
+  module ProvisionCommands
+
+    def self.extended(base)
+      base.load_commands
+    end
+
+    def load_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|
+        apply_command.switch :all, :desc => 'Apply all steps in sequence.', :negatable => false
+        apply_command.flag :environment, :desc => 'Set the environment of nodes', default_value: default_environment
+        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
+        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
+      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
+    end
+  end
+end

data/lib/bebox/environment.rb

@@ -0,0 +1,114 @@
+require 'tilt'
+require 'bebox/project'
+
+module Bebox
+  class Environment
+
+    attr_accessor :name, :project_root
+
+    def initialize(name, project_root)
+      self.name = name
+      self.project_root = project_root
+    end
+
+    # Create all files and directories related to an environment
+    def create
+      create_checkpoints
+      create_capistrano_base
+      generate_deploy_file
+      generate_hiera_template
+    end
+
+    # Delete all files and directories related to an environment
+    def remove
+      remove_checkpoints
+      remove_capistrano_base
+      remove_deploy_file
+      remove_hiera_template
+    end
+
+    # Lists existing environments
+    def self.list(project_root)
+      Dir["#{project_root}/.checkpoints/*/*"].map { |f| File.basename(f) }
+    end
+
+    # Create checkpoints base directories
+    def create_checkpoints
+      `cd #{self.project_root} && mkdir -p .checkpoints/environments/#{self.name}/{nodes,prepared_nodes,steps}`
+      (0..3).each{|i| `cd #{self.project_root} && mkdir -p .checkpoints/environments/#{self.name}/steps/step-#{i}`}
+    end
+
+    # Remove checkpoints base directories
+    def remove_checkpoints
+      `cd #{self.project_root} && rm -rf .checkpoints/environments/#{self.name}`
+    end
+
+    # Create capistrano base
+    def create_capistrano_base
+      # Create keys directory for environment
+      `cd #{self.project_root} && mkdir -p config/keys/environments/#{self.name}`
+      # Create ssh key for puppet user if environment is vagrant
+      generate_puppet_user_keys('vagrant') if self.name == 'vagrant'
+    end
+
+    # Remove capistrano base
+    def remove_capistrano_base
+      `cd #{self.project_root} && rm -rf config/keys/environments/#{self.name}`
+    end
+
+    # 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
+    end
+
+    # Generate the hiera data template for the environment
+    def generate_hiera_template
+      ssh_key = Bebox::Project.public_ssh_key_from_file(self.project_root, self.name)
+      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
+      end
+    end
+
+    # Remove the deploy file for the environment
+    def remove_deploy_file
+      `cd #{self.project_root} && rm -rf config/deploy/#{self.name}.rb`
+    end
+
+    # Remove the hiera data template file for the environment
+    def remove_hiera_template
+      Bebox::PROVISION_STEP_NAMES.each {|step| `cd #{self.project_root} && rm -rf puppet/steps/#{step}/hiera/data/#{self.name}.yaml` }
+    end
+
+    # Path to the templates directory in the gem
+    def templates_path
+      # File.expand_path(File.join(File.dirname(__FILE__), "..", "gems/bundler/lib/templates"))
+      File.join((File.expand_path '..', File.dirname(__FILE__)), 'templates')
+    end
+
+    # Generate ssh keys for connection with puppet user in environment
+    def generate_puppet_user_keys(environment)
+      `rm -f #{self.project_root}/config/keys/environments/#{environment}/{id_rsa,id_rsa.pub}`
+      `cd #{self.project_root}/config/keys/environments/#{environment} && ssh-keygen -q -f id_rsa -t rsa -N ''`
+    end
+
+    # Check if the environment has ssh keys configured
+    def self.check_environment_access(project_root, environment)
+      key_exist = File.exist?("#{project_root}/config/keys/environments/#{environment}/id_rsa")
+      key_exist &&= File.exist?("#{project_root}/config/keys/environments/#{environment}/id_rsa.pub")
+    end
+
+    # Check if there's an existing environment in the project
+    def self.environment_exists?(project_root, environment_name)
+      Dir.exists?("#{project_root}/.checkpoints/environments/#{environment_name}")
+    end
+  end
+end

data/lib/bebox/logger.rb

@@ -0,0 +1,51 @@
+require 'colorize'
+
+# A simple logger with colored output (logs to STDOUT)
+module Bebox
+  module Logger
+
+    def self.included(base)
+      base.extend(self)
+    end
+
+    def msg(message)
+      puts message.white
+    end
+
+    def linebreak
+      puts "\n"
+    end
+
+    def info(message)
+      puts "\n#{message.yellow}\n\n"
+    end
+
+    def title(message)
+      puts "\n#{message.cyan}\n\n"
+    end
+
+    def warn(message)
+      puts "\n#{message.yellow}\n\n"
+    end
+
+    def error(message)
+      puts "\n#{message.red}\n\n"
+    end
+
+    def quest(message)
+      puts "\n#{message.magenta}"
+    end
+
+    def ok(message)
+      puts "\n#{message.green}\n\n"
+    end
+
+    def highline_warn(message)
+      "<%= color('#{message}', :yellow) %>"
+    end
+
+    def highline_quest(message)
+      "<%= color('#{message}', :magenta) %>"
+    end
+  end
+end