ruby_yacht 0.1.1 → 0.2.0

data/spec/dsl/app_type_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+describe RubyYacht::AppType do
+  let(:full_config_block) do
+    Proc.new do
+      baseline_image 'ubuntu'
+      project_attribute name: :environment, default: 'staging'
+      project_attribute name: :foo
+
+      app_attribute name: :bar, required: false
+
+      environment_variable :app, 'SECRET_KEY' do
+        @app.secret_key
+      end
+    end
+  end
+
+  before do
+    RubyYacht.configuration.clear
+    RubyYacht.configure do
+      app_type(:generic) { baseline_image 'ubuntu' }
+    end
+  end
+  
+  describe "setting attributes on other DSL types" do
+    let(:project_configuration_block) do
+      Proc.new do
+        system_prefix 'test-project'
+        repository 'github.com'
+        domain 'test.com'
+        database do
+          host 'localhost'
+          name 'test'
+          username 'test'
+          password 'test'
+        end
+      end
+    end
+
+    before do
+      block = full_config_block
+      RubyYacht.configure do
+        app_type :app_type_test do
+          instance_eval(&block)
+        end
+      end
+    end
+
+    it "defines a method for adding an app with this type to the project" do
+      block = project_configuration_block
+      RubyYacht.configure do
+        project :test do
+          instance_eval &block
+          app_type_test_foo 'test value'
+
+          app_type_test_app :test do
+            repository_name 'brownleej/test'
+          end
+        end
+      end
+
+      app = RubyYacht.configuration.projects.last.apps.first
+      expect(app.name).to eq :test
+      expect(app.app_type).to eq :app_type_test
+    end
+
+    it "creates attributes for the project attributes on the Project DSL" do
+      block = project_configuration_block
+      RubyYacht.configure do
+        project :test do
+          instance_eval &block
+          app_type_test_foo 'test value'
+        end
+      end
+
+      project = RubyYacht.configuration.projects.last
+      expect(project.app_type_test_environment).to eq 'staging'
+      expect(project.app_type_test_foo).to eq 'test value'
+    end
+
+    it "creates attributes for the app attributes on apps of this type" do
+      block = project_configuration_block
+      RubyYacht.configure do
+        project :test do
+          instance_eval &block
+          app_type_test_foo 'test value'
+
+          app :test1, :app_type_test do
+            app_type_test_bar 'baz'
+            repository_name 'brownleej/test'
+          end
+        end
+      end
+
+      project = RubyYacht.configuration.projects.last
+      app = project.apps.last
+      expect(app.app_type_test_bar).to eq 'baz'
+    end
+
+    it "does not create attributes on apps of other types" do
+      raised_exception = false
+      block = project_configuration_block
+      RubyYacht.configure do
+        project :test do
+          instance_eval &block
+          app_type_test_foo 'test value'
+
+          app :test1, :generic do
+            begin
+              app_type_test_bar 'baz'
+            rescue
+              raised_exception = true
+            end
+            repository_name 'brownleej/test'
+          end
+        end
+      end
+
+      project = RubyYacht.configuration.projects.last
+      app = project.apps.last
+      expect(raised_exception).to be_truthy
+      expect(app.app_type_test_bar).to be_nil
+    end
+
+    context "with a missing required attribute" do
+      it "raises an exception" do
+        block = project_configuration_block
+        expect(lambda do
+          RubyYacht.configure do
+            project :test do
+              instance_eval &block
+            end
+          end
+        end).to raise_exception "Missing required attribute app_type_test_foo for RubyYacht::Project::DSL"
+      end
+    end
+  end
+
+  describe "dsl" do
+    let(:dsl) { RubyYacht::AppType::DSL.new(:app_type_test) }
+    let(:app_type) { dsl.run(@config_block).create_object }
+
+    before do
+      @config_block = full_config_block
+    end
+
+    it "sets the information on the app type" do
+      expect(app_type.name).to eq :app_type_test
+      expect(app_type.baseline_image).to eq 'ubuntu'
+      
+      expect(app_type.project_attributes.count).to eq 2
+      expect(app_type.project_attributes[0]).to eq(name: :environment, default: 'staging')
+      expect(app_type.project_attributes[1]).to eq(name: :foo)
+      
+      expect(app_type.app_attributes.count).to eq 1
+      expect(app_type.app_attributes[0]).to eq(name: :bar, required: false)
+
+      @app = Object.new
+      @app.define_singleton_method :secret_key do
+        'abc1234'
+      end
+
+      expect(app_type.environment_variables.count).to eq 1
+      expect(app_type.environment_variables[0][:name]).to eq 'SECRET_KEY'
+      expect(app_type.environment_variables[0][:image]).to eq :app
+      expect(instance_eval(&app_type.environment_variables[0][:block])).to eq 'abc1234'
+    end
+
+    context "with no baseline image" do
+      it "raises an exception" do
+        @config_block = Proc.new {}
+        expect { app_type }.to raise_exception "Missing required attribute baseline_image for RubyYacht::AppType::DSL"
+      end
+    end
+  end
+end

data/spec/dsl/configuration_spec.rb

@@ -6,13 +6,65 @@ describe RubyYacht::Configuration do
     RubyYacht.configuration.clear
   end
 
+  describe "reading configuration" do
+    describe "fetch_hooks" do
+      before do
+        RubyYacht.configure do
+          app_type :test do
+            baseline_image 'ubuntu'
+          end
+          app_type :php do
+            baseline_image 'ubuntu'
+          end
+        end
+
+        RubyYacht.configure do
+          add_hooks app_type: :test, folder: '.' do
+            before(:startup) { run_script 'a.rb' }
+            before(:install_libraries) { run_script 'a.rb' }
+            
+            before :startup do
+              app_type :php
+              run_script 'c.rb'
+            end
+
+            before :startup do
+              app_type :test
+              run_script 'd.rb'
+            end
+          end
+        end
+      end
+
+      it "returns hooks with the matching attributes" do
+        hooks = RubyYacht.configuration.fetch_hooks(app_type: :test, event_type: :startup)
+        expect(hooks.count).to eq 2
+        expect(hooks[0].script_path).to eq './a.rb'
+        expect(hooks[1].script_path).to eq './d.rb'
+      end
+    end
+
+    describe "find_app_type" do
+      before do
+        RubyYacht.configure do
+          app_type(:generic) { baseline_image 'ubuntu' }
+          app_type(:debian) { baseline_image 'debian' }
+        end
+      end
+
+      it "returns the app type with that name" do
+        type = RubyYacht.configuration.find_app_type(:debian)
+        expect(type.baseline_image).to eq 'debian'
+      end
+    end
+  end
+
   describe "dsl" do
     let(:project_creation_block) do
       Proc.new do
         project :project1 do
           system_prefix :a
           domain "a.test.com"
-          secret_key_base "a"
           repository "github.com"
 
           database do
@@ -26,7 +78,6 @@ describe RubyYacht::Configuration do
         project :project2 do
           system_prefix :b
           domain "b.test.com"
-          secret_key_base "b"
           repository "github.com"
 
           database do
@@ -39,6 +90,33 @@ describe RubyYacht::Configuration do
       end
     end
 
+    let(:hook_creation_block) do
+      Proc.new do
+        add_hooks app_type: :configuration_test, folder: './scripts' do
+          before :startup do
+            run_script 'update_config.rb'
+          end
+        end
+      end
+    end
+
+    let(:app_type_creation_block) do
+      Proc.new do
+        app_type :second_configuration_test do
+          baseline_image 'debian'
+          app_attribute :test_attribute
+        end
+      end
+    end
+
+    before do
+      RubyYacht.configure do
+        app_type :configuration_test do
+          baseline_image 'ubuntu'
+        end
+      end
+    end
+
     it "can add projects" do
       configuration = RubyYacht::Configuration::DSL.new.run(project_creation_block).create_object
       expect(configuration.projects.count).to eq 2
@@ -46,6 +124,50 @@ describe RubyYacht::Configuration do
       expect(configuration.projects[1].name).to eq :project2
     end
 
+    it "can add hooks" do
+      configuration = RubyYacht::Configuration::DSL.new.run(hook_creation_block).create_object
+      expect(configuration.hooks.count).to eq 1
+      expect(configuration.hooks[0].event_time).to eq :before
+      expect(configuration.hooks[0].event_type).to eq :startup
+      expect(configuration.hooks[0].script_path).to eq './scripts/update_config.rb'
+    end
+
+    it "can add types" do
+      configuration = RubyYacht::Configuration::DSL.new.run(app_type_creation_block).create_object
+      expect(configuration.app_types.count).to eq 1
+      expect(configuration.app_types[0].name).to eq :second_configuration_test
+      expect(configuration.app_types[0].project_attributes.count).to eq 0
+      expect(configuration.app_types[0].app_attributes.count).to eq 1
+    end
+
+    it "can add `during` hooks" do
+      configuration = RubyYacht::Configuration::DSL.new.run(Proc.new do
+        add_hooks app_type: :configuration_test, folder: './scripts' do
+          during :startup do
+            run_script 'start_app.rb'
+          end
+        end
+      end).create_object
+      expect(configuration.hooks.count).to eq 1
+      expect(configuration.hooks[0].event_time).to eq :during
+      expect(configuration.hooks[0].event_type).to eq :startup
+      expect(configuration.hooks[0].script_path).to eq './scripts/start_app.rb'
+    end
+
+    it "can add `after` hooks" do
+      configuration = RubyYacht::Configuration::DSL.new.run(Proc.new do
+        add_hooks app_type: :configuration_test, folder: './scripts' do
+          after :startup do
+            run_script 'start_app.rb'
+          end
+        end
+      end).create_object
+      expect(configuration.hooks.count).to eq 1
+      expect(configuration.hooks[0].event_time).to eq :after
+      expect(configuration.hooks[0].event_type).to eq :startup
+      expect(configuration.hooks[0].script_path).to eq './scripts/start_app.rb'
+    end
+
     describe "configure method" do
       it "adds to the list of projects" do
         project = RubyYacht::Project.new
@@ -59,6 +181,43 @@ describe RubyYacht::Configuration do
         expect(configuration.projects[1].name).to eq :project1
         expect(configuration.projects[2].name).to eq :project2
       end
+
+      it "adds to the list of hooks" do
+        hook = RubyYacht::Hook.new
+        hook.event_time = :after
+        hook.event_type = :restart_application
+        hook.script_path = './scripts/log_success.rb'
+        RubyYacht.configuration.hooks << hook
+        RubyYacht.configure(&hook_creation_block)
+
+        configuration = RubyYacht.configuration
+        expect(configuration.hooks.count).to eq 2
+        expect(configuration.hooks[0].script_path).to eq './scripts/log_success.rb'
+        expect(configuration.hooks[1].script_path).to eq './scripts/update_config.rb'
+      end
+
+      it "adds to the list of app types" do
+        RubyYacht.configure(&app_type_creation_block)
+
+        configuration = RubyYacht.configuration
+        expect(configuration.app_types.count).to eq 2
+        expect(configuration.app_types[0].name).to eq :configuration_test
+        expect(configuration.app_types[1].name).to eq :second_configuration_test
+      end
+
+      context "with an app type that is already registered" do
+        before do
+          type = RubyYacht::AppType.new
+          type.name = :second_configuration_test
+          RubyYacht.configuration.app_types << type
+        end
+
+        it "raises an exception" do
+          expect(lambda do
+            RubyYacht.configure(&app_type_creation_block)
+          end).to raise_exception "App type already registered: second_configuration_test"
+        end
+      end
     end
   end
 end

data/spec/dsl/dsl_spec.rb

@@ -161,7 +161,7 @@ describe RubyYacht::DSL::Base do
     before do
       DSLTestHelpers::SecondDSL.add_attribute :name
       DSLTestHelpers::SecondDSL.creates_object DSLTestHelpers::ThingOne
-      DSLTestHelpers::DSL.add_object :thing, 'DSLTestHelpers::SecondDSL'
+      DSLTestHelpers::DSL.add_object :thing, DSLTestHelpers::SecondDSL
     end
 
     it "defines a method for constructing an object of the real type" do
@@ -182,7 +182,7 @@ describe RubyYacht::DSL::Base do
 
     it "can accept optional attributes" do
       DSLTestHelpers::DSL.clear
-      DSLTestHelpers::DSL.add_object :thing, 'DSLTestHelpers::SecondDSL', required: false
+      DSLTestHelpers::DSL.add_object :thing, DSLTestHelpers::SecondDSL, required: false
       expect(DSLTestHelpers::DSL.required_attributes).to eq []
     end
   end
@@ -191,7 +191,7 @@ describe RubyYacht::DSL::Base do
     before do
       DSLTestHelpers::SecondDSL.add_attribute :name
       DSLTestHelpers::SecondDSL.creates_object DSLTestHelpers::ThingOne
-      DSLTestHelpers::DSL.add_object_list :thing, 'DSLTestHelpers::SecondDSL'
+      DSLTestHelpers::DSL.add_object_list :thing, DSLTestHelpers::SecondDSL
     end
 
     it "defines methods for building a list of objects" do

data/spec/dsl/hook_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe RubyYacht::Hook do
+  describe "script_name" do
+    context "with no script path" do
+      it "is an empty string" do
+        expect(subject.script_name).to eq ""
+      end
+    end
+
+    context "with a script path" do
+      before { subject.script_path = "./foo/bar.rb" }
+
+      it "gets the filename from the script path" do
+        expect(subject.script_name).to eq "bar.rb"
+      end
+    end
+  end
+
+  describe "dsl" do
+    let(:dsl) { RubyYacht::Hook::DSL.new(:before, :startup) }
+    let(:hook) { dsl.run(@config_block).create_object }
+
+    before do
+      RubyYacht.configuration.clear
+
+      RubyYacht.configure do
+        app_type :test do
+          baseline_image 'ubuntu'
+        end
+      end
+
+      @config_block = Proc.new do
+        app_type :test
+        command 'curl google.com'
+      end
+    end
+
+    it "can create a hook for running a command" do
+      expect(hook.event_time).to eq :before
+      expect(hook.event_type).to eq :startup
+      expect(hook.app_type).to eq :test
+      expect(hook.command).to eq 'curl google.com'
+    end
+
+    it "can create a hook for running a command" do
+      @config_block = Proc.new do
+        app_type :test
+        script_folder './foo'
+        run_script 'bar.rb'
+      end
+      expect(hook.event_time).to eq :before
+      expect(hook.event_type).to eq :startup
+      expect(hook.app_type).to eq :test
+      expect(hook.script_path).to eq './foo/bar.rb'
+      expect(hook.command).to eq '/var/docker/bar.rb'
+    end
+
+    context "with no command" do
+      before do
+        @config_block = Proc.new do
+          app_type :test
+        end
+      end
+      
+      it "raises an exception" do
+        expect { hook }.to raise_exception 'Missing required attribute command for RubyYacht::Hook::DSL'
+      end
+    end
+
+    context "with a script name and no script path" do
+      before do
+        @config_block = Proc.new do
+          app_type :test
+          run_script 'bar.rb'
+        end
+      end
+
+      it "creates a hook with with the script relative to the current folder" do
+        expect(hook.script_path).to eq './bar.rb'
+        expect(hook.command).to eq '/var/docker/bar.rb'
+      end
+    end
+
+    context "with no app type" do
+      before do
+        @config_block = Proc.new do
+          script_folder './foo'
+          run_script 'bar.rb'
+        end
+      end
+      
+      it "raises an exception" do
+        expect { hook }.to raise_exception 'Missing required attribute app_type for RubyYacht::Hook::DSL'
+      end
+    end
+
+    context "with an invalid app type" do
+      before do
+        @config_block = Proc.new do
+          app_type :invalid
+          command 'whoami'
+        end
+      end
+      
+      it "raises an exception" do
+        expect { hook }.to raise_exception 'Hook has invalid app type `invalid`'
+      end
+    end
+  end
+end