the-maestro 0.3.1 → 0.3.2

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License) 
 
-Copyright (c) 2010 Brian Ploetz <bploetz@gmail.com>
+Copyright (c) 2010 Brian Ploetz <bploetz (at) gmail.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.rdoc

@@ -22,7 +22,7 @@ Add the following gem dependency to your Rails project's <code>config/environmen
 
     Rails::Initializer.run do |config|
 
-      config.gem "the-maestro", :lib => "maestro", :version => "0.3.0", :source => "http://gemcutter.org"
+      config.gem "the-maestro", :lib => "maestro", :version => "0.3.2", :source => "http://gemcutter.org"
 
     end
 
@@ -132,7 +132,7 @@ A cloud name may only contain alphanumerics and dashes.
 
 ==== aws_cloud attributes
 
-The following attributes must be present after your aws_cloud declaration:
+The following attributes must be present within your aws_cloud declaration:
 
 - <b>keypair_name</b>: A keypair associated with your Amazon Web Services account
 - <b>keypair_file</b>: Fully qualified path to the keypair file on your computer matching the above keypair_name
@@ -175,7 +175,7 @@ Creates an Elastic Cloud Compute (EC2) node. An EC2 node name may only contain a
 
 The following attributes must be present:
 
-- <b>roles</b>: An array of Chef roles to apply to this node. The role names in the array must match the Chef roles that are defined in config/maestro/roles.
+- <b>roles</b>: An array of Chef roles to apply to this node. The role names in the array must match the Chef roles that are defined in <code>config/maestro/roles</code>.
 - <b>ami</b>: The AMI identifier to use.
 - <b>ssh_user</b>: The name of the user to use to ssh to the instance.
 - <b>instance_type</b>: The instance type to use for this EC2 node.
@@ -183,6 +183,8 @@ The following attributes must be present:
 
 The following attributes are optional:
 
+- <b>cookbook_attributes</b>: Chef cookbook attribute overrides, in JSON format (see {the Chef documentation}[http://wiki.opscode.com/display/chef/Attributes#Attributes-AttributesinJSON] for more information).
+  Since the attribute JSON format necessitates lots of " characters, the use of heredocs is recomended to avoid manual escaping of " characters and improve readability. See the example below.
 - <b>elastic_ip</b>: The Elastic IP address to associate with this node.
 - <b>ebs_volume_id</b>: The id of the EBS Volume to attach to this node.
 - <b>ebs_device</b>: The device to attach the EBS Volume to.
@@ -195,6 +197,20 @@ An example ec2_node:
       ssh_user "ubuntu"
       instance_type "m1.small"
       availability_zone "us-east-1b"
+      cookbook_attributes <<-COOKBOOK_ATTRIBUTES
+        "apache": {
+          "listen_ports": ["81", "8181"],
+          "worker" : {
+            "startservers" : "5"
+          }
+        },
+        "mysql": {
+          "server_root_password": "XXXXXXXX",
+          "tunable": {
+            "max_connections": "500"
+          }
+        }
+      COOKBOOK_ATTRIBUTES
       elastic_ip "123.45.678.90"
       ebs_volume_id "vol-xxxxxxxx"
       ebs_device "/dev/sdh"
@@ -284,9 +300,9 @@ At any time, you may run the following Rake task to validate your Maestro config
 
     rake maestro:validate_configs
 
-This will validate all of the files in your Maestro config directory
+This will validate all of the files in your Maestro config directory, and report any errors.
 
-=== Conduct
+=== Conduct!
 
 Maestro creates Rake tasks for all of your valid clouds. These tasks allow you to provision, configure, and deploy to your cloud.
 A very simplistic workflow:
@@ -322,9 +338,9 @@ For a more in depth explanation of Chef, please consult {the Chef documentation}
 Maestro will log cloud-wide workflow messages to STDOUT. In addition, log files will be created for your cloud, as well as each of the nodes in your cloud. These
 can be found at the following location:
 
-    YOUR_RAILS_APP/log/maestro/clouds/<i>cloud-name</i>/
-    YOUR_RAILS_APP/log/maestro/clouds/<i>cloud-name</i>/<i>cloud-name</i>.log
-    YOUR_RAILS_APP/log/maestro/clouds/<i>cloud-name</i>/<i>node-name</i>.log
+    YOUR_RAILS_APP/log/maestro/clouds/cloud-name/
+    YOUR_RAILS_APP/log/maestro/clouds/cloud-name/cloud-name.log
+    YOUR_RAILS_APP/log/maestro/clouds/cloud-name/node-name.log
 
 Node-specific messages are not logged to STDOUT, but only to the node's log file. For troubleshooting problems configuring your nodes, please
 consult the individual node log files for information.
@@ -337,6 +353,11 @@ consult the individual node log files for information.
 TODO...
 
 
+== Where To Get Help
+
+The {Maestro Users Google Group}[http://groups.google.com/group/maestro-users] is the recommended place to get help.
+
+
 == Contributing
 Please use the {Issues}[http://github.com/bploetz/maestro/issues] page on the Maestro GitHub site to report bugs or feature requests.
 
@@ -383,7 +404,7 @@ To generate RDoc locally:
 
 (The MIT License) 
 
-Copyright (c) 2010 Brian Ploetz <bploetz@gmail.com>
+Copyright (c) 2010 Brian Ploetz <bploetz (at) gmail.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/maestro/cloud.rb

@@ -22,6 +22,8 @@ module Maestro
       attr_reader :configurable_nodes
       # String containing the full path to this Cloud's log directory
       attr_reader :log_directory
+      # String containing the full path to this Cloud's log file
+      attr_reader :log_file
       dsl_property :keypair_name, :keypair_file
 
       # Creates a new Cloud object.
@@ -123,7 +125,7 @@ module Maestro
           else
             @logger.info "chef-solo already installed on Nodes #{@configurable_nodes.keys.inspect}"
           end
-          @logger.info "Running chef-solo on Nodes #{@configurable_nodes.keys.inspect}..."
+          @logger.info "Running chef-solo on Nodes #{@configurable_nodes.keys.inspect}. This may take a few minutes..."
           session = open_ssh_session
           run_chef_solo(session)
           session.close
@@ -315,6 +317,7 @@ module Maestro
             File.new(cloud_log_file, "a+")
             @logger.info "Created #{cloud_log_file}"
           end
+          @log_file = cloud_log_file
           outputter = Log4r::FileOutputter.new("#{@name}-file", :formatter => FileFormatter.new, :filename => cloud_log_file, :truncate => false)
           @logger.add(outputter)
         rescue RuntimeError => rerr

data/lib/maestro/node.rb

@@ -19,7 +19,9 @@ module Maestro
       # the IP address of this Node
       attr_accessor :ip_address
       # the logger of this Node
-      attr_accessor :logger
+      attr_reader :logger
+      # String containing the fully qualified path to the log file of this Node
+      attr_reader :log_file
 
       # Creates a new Node
       def initialize(name, cloud, &block)
@@ -65,6 +67,7 @@ module Maestro
             node_log_file = @cloud.log_directory + "/#{@name.to_s}.log"
             if !File.exists?(node_log_file)
               File.new(node_log_file, "a+")
+              @log_file = node_log_file
               @logger.info "Created #{node_log_file}"
             end
             outputter = Log4r::FileOutputter.new("#{@name.to_s}-file", :formatter => FileFormatter.new, :filename => node_log_file, :truncate => false)
@@ -91,7 +94,7 @@ module Maestro
 
       DEFAULT_SSH_USER = "root"
 
-      dsl_property :roles, :ssh_user
+      dsl_property :roles, :ssh_user, :cookbook_attributes
       # the file name of this Configurable Node's Chef Node JSON file
       attr_accessor :json_filename
       # the contents of this Configurable Node's Chef Node JSON file
@@ -107,7 +110,17 @@ module Maestro
           @json.chop! if @json =~ /\s$/
           @json.chop! if @json =~ /,$/
         end
-        @json = @json + "]}"
+        @json = @json + "]"
+        if !@cookbook_attributes.nil?
+          @cookbook_attributes.gsub!(/(\n|\n\r)\s{0,}/, ' ')
+          @cookbook_attributes.strip!
+          @cookbook_attributes.chop! if @cookbook_attributes =~ /,$/
+          @cookbook_attributes.slice!(0) if @cookbook_attributes =~ /^\{/
+          @json = @json + ", "
+          @json = @json + @cookbook_attributes
+          @json.chop! if @json =~ /\s$/
+        end
+        @json = @json + " }"
       end
 
       protected
@@ -116,8 +129,10 @@ module Maestro
       def validate_internal
         super
         invalidate "'#{@name}' Node missing roles map" if roles.nil?
+        if !cookbook_attributes.nil?
+          invalidate "'#{@name}' Node's cookbook_attributes must be a String" if !cookbook_attributes.is_a?(String)
+        end
       end
     end
-
   end
 end

data/test/unit/test_cloud.rb

@@ -14,6 +14,7 @@ class TestCloud < Test::Unit::TestCase
 
   context "A Cloud instance" do
     setup do
+      ENV[Maestro::MAESTRO_DIR_ENV_VAR] = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'standalone')
       @cloud = aws_cloud :test do
         keypair_name "XXXXXXX-keypair"
         keypair_file "/path/to/id_rsa-XXXXXXX-keypair"
@@ -32,6 +33,11 @@ class TestCloud < Test::Unit::TestCase
       end
     end
 
+    teardown do
+      FileUtils.rm_rf([Maestro.maestro_log_directory], :secure => true) if File.exists?(Maestro.maestro_log_directory)
+      ENV.delete Maestro::MAESTRO_DIR_ENV_VAR
+    end
+
 
     should "raise exception on space in name" do
       assert_raise StandardError do
@@ -138,5 +144,18 @@ class TestCloud < Test::Unit::TestCase
       assert !@cloud.valid?
       assert @cloud.validation_errors.any? {|message| !message.index("Missing nodes").nil? }
     end
+
+    should "create logs" do
+      assert_nothing_raised do
+        base_dir = ENV[Maestro::MAESTRO_DIR_ENV_VAR]
+        assert !File.exists?("#{base_dir}/log/maestro/clouds/foo")
+        assert !File.exists?("#{base_dir}/log/maestro/clouds/foo/foo.log")
+        cloud = aws_cloud :foo do end
+        assert cloud.log_file.eql? "#{base_dir}/log/maestro/clouds/foo/foo.log"
+        assert cloud.log_directory.eql? "#{base_dir}/log/maestro/clouds/foo"
+        assert File.exists?("#{base_dir}/log/maestro/clouds/foo/foo.log")
+        assert File.exists?("#{base_dir}/log/maestro/clouds/foo")
+      end
+    end
   end
 end

data/test/unit/test_configurable_node.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+# Unit tests for Maestro::Node::Configurable
+class TestConfigurableNode < Test::Unit::TestCase
+
+  context "Maestro::Node::Configurable" do
+    setup do
+      @cloud = aws_cloud :test do
+        nodes do
+          ec2_node "web-1" do
+            roles ["web", "mail"]
+            cookbook_attributes <<-COOKBOOK_ATTRIBUTES
+              "apache": {
+                "listen_ports": ["81", "8181"],
+                "worker" : {
+                  "startservers" : "5"
+                }
+              },
+              "mysql": {
+                "server_root_password": "XXXXXXXX",
+                "tunable": {
+                  "max_connections": "500"
+                }
+              }
+            COOKBOOK_ATTRIBUTES
+          end
+        end
+      end
+      @node = @cloud.nodes["web-1"]
+    end
+
+
+    should "be invalid due to missing role map" do
+      @node.roles nil
+      @node.validate
+      assert !@node.valid?
+      assert @node.validation_errors.any? {|message| !message.index("missing roles map").nil? }
+    end
+
+    should "be invalid due to cookbook_attributes not a string" do
+      @node.cookbook_attributes Hash.new
+      @node.validate
+      assert !@node.valid?
+      assert @node.validation_errors.any? {|message| !message.index("cookbook_attributes must be a String").nil? }
+    end
+
+    should "have valid JSON" do
+      assert @node.json.eql? "{ \"run_list\": [\"role[web]\", \"role[mail]\"], \"apache\": { \"listen_ports\": [\"81\", \"8181\"], \"worker\" : { \"startservers\" : \"5\" } }, \"mysql\": { \"server_root_password\": \"XXXXXXXX\", \"tunable\": { \"max_connections\": \"500\" } } }"
+    end
+  end
+end

data/test/unit/test_node.rb

@@ -1,36 +1,21 @@
 require 'helper'
 
-# Unit tests for Maestro::Node
+# Unit tests for Maestro::Node::Base
 class TestNode < Test::Unit::TestCase
 
-  context "Maestro::Node" do
+  context "Maestro::Node::Base" do
     setup do
-      @cloud = aws_cloud :test do
-        keypair_name "XXXXXXX-keypair"
-        keypair_file "/path/to/id_rsa-XXXXXXX-keypair"
-
-        roles do
-          role "web" do
-            public_ports [80, 443]
-          end
-        end
-        
-        nodes do
-          ec2_node "web-1" do
-            roles ["web"]
-          end
-        end
-      end
-      @node = @cloud.nodes["web-1"]
+      ENV[Maestro::MAESTRO_DIR_ENV_VAR] = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'standalone')
     end
-
-
+  
+    teardown do
+      FileUtils.rm_rf([Maestro.maestro_log_directory], :secure => true) if File.exists?(Maestro.maestro_log_directory)
+      ENV.delete Maestro::MAESTRO_DIR_ENV_VAR
+    end
+  
     should "raise exception on space in name" do
       assert_raise StandardError do
-        @cloud = aws_cloud :test do
-          keypair_name "XXXXXXX-keypair"
-          keypair_file "/path/to/id_rsa-XXXXXXX-keypair"
-          roles {}
+        cloud = aws_cloud :test do
           nodes do
             ec2_node "foo bar" do
               roles ["web"]
@@ -40,11 +25,20 @@ class TestNode < Test::Unit::TestCase
       end
     end
 
-    should "be invalid due to missing role map" do
-      @node.roles nil
-      @node.validate
-      assert !@node.valid?
-      assert @node.validation_errors.any? {|message| !message.index("missing roles map").nil? }
+    should "create log file" do
+      assert_nothing_raised do
+        base_dir = ENV[Maestro::MAESTRO_DIR_ENV_VAR]
+        assert !File.exists?("#{base_dir}/log/maestro/clouds/test/foo.log")
+        cloud = aws_cloud :test do
+          nodes do
+            ec2_node "foo" do
+              roles ["web"]
+            end
+          end
+        end
+        assert cloud.nodes["foo"].log_file.eql? "#{base_dir}/log/maestro/clouds/test/foo.log"
+        assert File.exists?("#{base_dir}/log/maestro/clouds/test/foo.log")
+      end
     end
   end
 end

data/the-maestro.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{the-maestro}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Ploetz"]
-  s.date = %q{2010-05-21}
+  s.date = %q{2010-05-23}
   s.description = %q{Maestro is a cloud provisioning, configuration, and deployment utility for your Ruby and Ruby On Rails applications.}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -64,6 +64,7 @@ Gem::Specification.new do |s|
      "test/unit/test_aws_rds_node.rb",
      "test/unit/test_cent_os.rb",
      "test/unit/test_cloud.rb",
+     "test/unit/test_configurable_node.rb",
      "test/unit/test_debian.rb",
      "test/unit/test_fedora.rb",
      "test/unit/test_invalid_mode.rb",
@@ -98,6 +99,7 @@ Gem::Specification.new do |s|
      "test/unit/test_aws_rds_node.rb",
      "test/unit/test_cent_os.rb",
      "test/unit/test_cloud.rb",
+     "test/unit/test_configurable_node.rb",
      "test/unit/test_debian.rb",
      "test/unit/test_fedora.rb",
      "test/unit/test_invalid_mode.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: the-maestro
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Brian Ploetz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-21 00:00:00 -04:00
+date: 2010-05-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -160,6 +160,7 @@ files:
 - test/unit/test_aws_rds_node.rb
 - test/unit/test_cent_os.rb
 - test/unit/test_cloud.rb
+- test/unit/test_configurable_node.rb
 - test/unit/test_debian.rb
 - test/unit/test_fedora.rb
 - test/unit/test_invalid_mode.rb
@@ -216,6 +217,7 @@ test_files:
 - test/unit/test_aws_rds_node.rb
 - test/unit/test_cent_os.rb
 - test/unit/test_cloud.rb
+- test/unit/test_configurable_node.rb
 - test/unit/test_debian.rb
 - test/unit/test_fedora.rb
 - test/unit/test_invalid_mode.rb