aws-codedeploy-agent 0.0.1

data/test/instance_agent/codedeploy_plugin/deployment_specification_test.rb

@@ -0,0 +1,335 @@
+require 'test_helper'
+require 'ostruct'
+require 'certificate_helper'
+
+class DeploymentSpecificationTest < InstanceAgentTestCase
+  context 'The Deployment Specification' do
+    def generate_signed_message_for(map)
+      message = @cert_helper.sign_message(map.to_json)
+      spec = OpenStruct.new({ :payload => message })
+      spec.format = "PKCS7/JSON"
+
+      return spec
+    end
+
+    setup do
+      @cert_helper = CertificateHelper.new
+      @deployment_id = SecureRandom.uuid.to_s
+      @deployment_group_id = SecureRandom.uuid.to_s
+      @s3Revision = {
+        "Bucket" => "mybucket",
+        "Key" => "mykey",
+        "BundleType" => "tar"
+      }
+      @revision = {
+        "RevisionType" => "S3",
+        "S3Revision" => @s3Revision
+      }
+      @deployment_spec = {
+        "DeploymentId" => @deployment_id,
+        "DeploymentGroupId" => @deployment_group_id,
+        "Revision" => @revision
+      }
+      @packed_message = generate_signed_message_for(@deployment_spec)
+      InstanceAgent::Config.init
+    end
+
+    context "with JSON format" do
+      should "populate the deployment id" do
+        parsed_deployment_spec = InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        assert_equal @deployment_id, parsed_deployment_spec.deployment_id
+        assert_equal @s3Revision, parsed_deployment_spec.revision
+      end
+    end
+
+    context "with arn deployment id" do
+      setup do
+        @deployment_spec = {
+          "DeploymentId" => "arn:aws:codedeploy:region:account:deployment/#{@deployment_id}",
+          "DeploymentGroupId" => @deployment_group_id,
+          "Revision" => @revision
+        }
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "populate the Bundle" do
+        parsed_deployment_spec = InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        assert_equal @deployment_id, parsed_deployment_spec.deployment_id
+        assert_equal @deployment_group_id, parsed_deployment_spec.deployment_group_id
+        assert_equal @s3Revision, parsed_deployment_spec.revision
+      end
+    end
+
+    context "with an unsupported format" do
+      setup do
+        @packed_message.format = "XML"
+      end
+
+      should "raise an exception" do
+        assert_raised_with_message("Unsupported DeploymentSpecification format: XML") do
+          parsed_deployment_spec = InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with additional data" do
+      setup do
+        @deployment_spec["AdditionalData"] = "test"
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "populate the Bundle" do
+        parsed_deployment_spec = InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        assert_equal @deployment_id, parsed_deployment_spec.deployment_id
+        assert_equal @deployment_group_id, parsed_deployment_spec.deployment_group_id
+        assert_equal @s3Revision, parsed_deployment_spec.revision
+      end
+    end
+
+    context "with a nil format" do
+      setup do
+        @packed_message.format = nil
+      end
+
+      should "raise an exception" do
+        assert_raised_with_message("Unsupported DeploymentSpecification format: ") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "is nil" do
+      setup do
+        @packed_message = nil
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message("Provided deployment spec was nil") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with no deployment id" do
+      setup do
+        @deployment_spec.delete("DeploymentId")
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message("Deployment Spec has no DeploymentId") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with null deployment id" do
+      setup do
+        @deployment_spec["DeploymentId"] = nil
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message("Deployment Spec has no DeploymentId") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with empty deployment id" do
+      setup do
+        @deployment_spec["DeploymentId"] = ""
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message("Deployment Spec has no DeploymentId") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with no instance group id" do
+      setup do
+        @deployment_spec.delete("DeploymentGroupId")
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message("Deployment Spec has no DeploymentGroupId") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with null instance group id" do
+      setup do
+        @deployment_spec["DeploymentGroupId"] = nil
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message("Deployment Spec has no DeploymentGroupId") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with empty instance group id" do
+      setup do
+        @deployment_spec["DeploymentGroupId"] = ""
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message("Deployment Spec has no DeploymentGroupId") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with no target revision" do
+      setup do
+        @deployment_spec.delete("Revision")
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message('Must specify a revison') do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with null target revision" do
+      setup do
+        @deployment_spec["Revision"] = nil
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message('Must specify a revison') do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with empty target revision" do
+      setup do
+        @deployment_spec["Revision"] = ""
+        @packed_message = generate_signed_message_for(@deployment_spec)
+      end
+
+      should "raise a runtime exception" do
+        assert_raised_with_message("Must specify a revision source") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+    end
+
+    context "with S3 Revision" do
+      should "parse correctly" do
+        parsed_deployment_spec = InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        assert_equal @s3Revision, parsed_deployment_spec.revision
+      end
+
+      should "raise when Bucket is missing" do
+        @s3Revision = {
+          "Key" => "mykey",
+          "BundleType" => "tar"
+        }
+        @revision = {
+          "RevisionType" => "S3",
+          "S3Revision" => @s3Revision
+        }
+        @deployment_spec = {
+          "DeploymentId" => @deployment_id,
+          "DeploymentGroupId" => @deployment_group_id,
+          "Revision" => @revision
+        }
+        @packed_message = generate_signed_message_for(@deployment_spec)
+
+        assert_raised_with_message("S3Revision in Deployment Spec must specify Bucket, Key and BundleType") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+
+      should "raise when Key is missing" do
+        @s3Revision = {
+          "Bucket" => "mybucket",
+          "BundleType" => "tar"
+        }
+        @revision = {
+          "RevisionType" => "S3",
+          "S3Revision" => @s3Revision
+        }
+        @deployment_spec = {
+          "DeploymentId" => @deployment_id,
+          "DeploymentGroupId" => @deployment_group_id,
+          "Revision" => @revision
+        }
+        @packed_message = generate_signed_message_for(@deployment_spec)
+
+        assert_raised_with_message("S3Revision in Deployment Spec must specify Bucket, Key and BundleType") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+
+      should "raise when BundleType is missing" do
+        @s3Revision = {
+          "Bucket" => "mybucket",
+          "Key" => "mykey"
+        }
+        @revision = {
+          "RevisionType" => "S3",
+          "S3Revision" => @s3Revision
+        }
+        @deployment_spec = {
+          "DeploymentId" => @deployment_id,
+          "DeploymentGroupId" => @deployment_group_id,
+          "Revision" => @revision
+        }
+        @packed_message = generate_signed_message_for(@deployment_spec)
+
+        assert_raised_with_message("S3Revision in Deployment Spec must specify Bucket, Key and BundleType") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+
+      should "raise when bundle type is not a supported format" do
+        @s3Revision = {
+          "Bucket" => "mybucket",
+          "Key" => "mykey",
+          "BundleType" => "bar"
+        }
+        @revision = {
+          "RevisionType" => "S3",
+          "S3Revision" => @s3Revision
+        }
+        @deployment_spec = {
+          "DeploymentId" => @deployment_id,
+          "DeploymentGroupId" => @deployment_group_id,
+          "Revision" => @revision
+        }
+        @packed_message = generate_signed_message_for(@deployment_spec)
+
+        assert_raised_with_message("BundleType in S3Revision must be tar, tgz or zip") do
+          InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+        end
+      end
+
+      should "raise when JSON submitted as PKCS7/JSON" do
+        @packed_message.payload = @deployment_spec.to_json
+
+        assert_raised_with_message("Could not parse the PKCS7: nested asn1 error") do
+          begin
+            InstanceAgent::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+          rescue ArgumentError => e
+            raise e.message
+          end
+        end
+      end
+    end
+  end
+end
+

data/test/instance_agent/codedeploy_plugin/hook_executor_test.rb

@@ -0,0 +1,250 @@
+require 'test_helper'
+require 'stringio'
+require 'fileutils'
+require 'instance_agent/codedeploy_plugin/installer'
+require 'com/amazon/codedeploy/command/v20141006/host_command_instance'
+
+class HookExecutorTest < InstanceAgentTestCase
+
+  include InstanceAgent::CodeDeployPlugin
+
+  def create_full_hook_executor
+    HookExecutor.new ({:lifecycle_event => @lifecycle_event,
+                        :deployment_root_dir => @deployment_root_dir,
+                        :last_successful_deployment_dir => @last_successful_deployment_dir,
+                        :app_spec_path => @app_spec_path})
+  end
+
+  context "testing hook executor" do
+    setup do
+      @deployment_root_dir = "deployment/root/dir"
+      @last_successful_deployment_dir = "last/deployment/root/dir"
+      @app_spec_path = "app_spec"
+      @app_spec =  { "version" => 0.0, "os" => "linux" }
+      YAML.stubs(:load).returns(@app_spec)
+    end
+
+    context "when creating a hook command" do
+      context "first deployment pre-download scripts" do
+        setup do
+          File.stubs(:exist?).returns(false)
+          @lifecycle_event = "ApplicationStop"
+        end
+
+        should "do nothing" do
+          @hook_executor = HookExecutor.new ({:lifecycle_event => @lifecycle_event,
+                                              :deployment_root_dir => @deployment_root_dir,
+                                              :app_spec_path => @app_spec_path})
+        end
+      end
+
+      context "first deployment post-download scripts" do
+        setup do
+          File.stubs(:exist?).returns(false)
+          @lifecycle_event = "ValidateService"
+        end
+
+        should "raise an error" do
+          assert_raise do
+            @hook_executor = HookExecutor.new ({:lifecycle_event => @lifecycle_event,
+                                               :deployment_root_dir => @deployment_root_dir})
+          end
+        end
+      end
+
+      context "all information provided" do
+        setup do
+          @lifecycle_event = "ValidateService"
+          ApplicationSpecification.stubs(:parse)
+        end
+
+        should "parse an app spec from the current deployments directory" do
+          File.expects(:read).with(File.join(@deployment_root_dir, 'deployment-archive', @app_spec_path))
+          @hook_executor =  create_full_hook_executor
+        end
+
+        context "hook is before download bundle" do
+          setup do
+            @lifecycle_event = "ApplicationStop"
+          end
+
+          should "parse an app spec from the previous deployment's directory" do
+            File.expects(:read).with(File.join(@last_successful_deployment_dir, 'deployment-archive', @app_spec_path))
+            @hook_executor = create_full_hook_executor
+          end
+        end
+      end
+    end
+
+    context "when executing a hook command" do
+      setup do
+        @lifecycle_event = "ValidateService"
+        File.stubs(:read).with(File.join(@deployment_root_dir, 'deployment-archive', @app_spec_path))
+      end
+
+      context "no scripts to run for a given hook" do
+        setup do
+          @app_spec = {"version" => 0.0, "os" => "linux", "hooks" => {}}
+          YAML.stubs(:load).returns(@app_spec)
+          @hook_executor = create_full_hook_executor
+        end
+
+        should "do nothing" do
+          @hook_executor.execute
+        end
+      end
+
+      context "running with a single basic script" do
+        setup do
+          @app_spec = {"version" => 0.0, "os" => "linux", "hooks" => {'ValidateService'=>[{'location'=>'test'}]}}
+          YAML.stubs(:load).returns(@app_spec)
+          @script_location = File.join(@deployment_root_dir, 'deployment-archive', 'test')
+          @hook_executor = create_full_hook_executor
+        end
+
+        context "when hook script doesn't exist" do
+          setup do
+            File.stubs(:exist?).with(@script_location).returns(false)
+          end
+
+          should "raise and exception" do
+            assert_raised_with_message('Script does not exist at specified location: test', ScriptError)do
+              @hook_executor.execute
+            end
+          end
+        end
+
+        context "when the file exists" do
+          setup do
+            File.stubs(:exist?).with(@script_location).returns(true)
+          end
+
+          context "and isn't executable" do
+            setup do
+              File.stubs(:executable?).with(@script_location).returns(false)
+              InstanceAgent::Log.expects(:send).with(:warn, 'InstanceAgent::CodeDeployPlugin::HookExecutor: Script at specified location: test is not executable.  Trying to make it executable.')
+            end
+
+            should "log and make the hook script executable" do
+              FileUtils.expects(:chmod)#.with("+x", @script_location)
+              assert_raised_with_message('No such file or directory - deployment/root/dir/deployment-archive/test', Errno::ENOENT) do
+                 @hook_executor.execute
+              end
+            end
+
+            context "and setting executable fails" do
+              setup do
+                FileUtils.stubs(:chmod).raises("An exception")
+              end
+
+              should "raise an exception" do
+                assert_raised_with_message('Unable to set script at specified location: test as executable', ScriptError) do
+                  @hook_executor.execute
+                end
+              end
+            end
+          end
+
+          context "files are executable (both intial checks pass)" do
+            setup do
+              File.stubs(:executable?).with(@script_location).returns(true)
+              @mock_pipe = mock
+              dummy_array = mock
+              @mock_pipe.stubs(:each_line).returns(dummy_array)
+              @mock_pipe.stubs(:close)
+              dummy_array.stubs(:each).returns(nil)
+              @wait_thr = mock
+              @value = mock
+              @wait_thr.stubs(:value).returns(@value)
+              @wait_thr.stubs(:join).returns(1000)
+            end
+
+            context "scripts timeout" do
+              setup do
+                @app_spec =  { "version" => 0.0, "os" => "linux", "hooks" => {'ValidateService'=> [{"location"=>"test", "timeout"=>"30"}]}}
+                YAML.stubs(:load).returns(@app_spec)
+                @hook_executor = create_full_hook_executor
+                @wait_thr.stubs(:join).with(30).returns(nil)
+                @wait_thr.stubs(:pid)
+                mock_pipe = mock
+                Open3.stubs(:popen3).with(@script_location, :pgroup=>true).yields([@mock_pipe,@mock_pipe,@mock_pipe,@wait_thr])
+                Process.stubs(:kill)
+              end
+
+              should "raise and exception" do
+                assert_raised_with_message('Script at specified location: test failed to complete in 30 seconds', ScriptError) do
+                  @hook_executor.execute
+                end
+              end
+            end
+
+            context "Scripts run with a runas" do
+              setup do
+                @app_spec =  { "version" => 0.0, "os" => "linux", "hooks" => {'ValidateService'=> [{"location"=>"test", "runas"=>"user"}]}}
+                YAML.stubs(:load).returns(@app_spec)
+                @hook_executor = create_full_hook_executor
+                mock_pipe = mock
+                Open3.stubs(:popen3).with('su user -c ' + @script_location, :pgroup=>true).yields([@mock_pipe,@mock_pipe,@mock_pipe,@wait_thr])
+              end
+
+              context "scripts fail" do
+                setup do
+                  @value.stubs(:exitstatus).returns(1)
+                end
+
+                should "raise an exception" do
+                  assert_raised_with_message('Script at specified location: test run as user user failed with exit code 1', ScriptError) do
+                    @hook_executor.execute
+                  end
+                end
+              end
+
+              context "scripts pass" do
+                setup do
+                  @value.stubs(:exitstatus).returns(0)
+                end
+
+                should "execute script with runas" do
+                  Open3.expects(:popen3).with('su user -c ' + @script_location, :pgroup=>true).yields([@mock_pipe,@mock_pipe,@mock_pipe,@wait_thr])
+                  @hook_executor.execute
+                end
+              end
+            end
+
+            context "Scripts run without a runas" do
+              setup do
+                @app_spec =  { "version" => 0.0, "os" => "linux", "hooks" => {'ValidateService'=> [{"location"=>"test"}]}}
+                YAML.stubs(:load).returns(@app_spec)
+                @hook_executor = create_full_hook_executor
+                Open3.stubs(:popen3).with(@script_location, :pgroup=>true).yields([@mock_pipe,@mock_pipe,@mock_pipe,@wait_thr])
+              end
+
+              context "Scripts fail" do
+                setup do
+                  @value.stubs(:exitstatus).returns(1)
+                end
+
+                should "raise an exception" do
+                  assert_raised_with_message('Script at specified location: test failed with exit code 1', ScriptError) do
+                    @hook_executor.execute
+                  end
+                end
+              end
+
+              context "Scripts pass" do
+                setup do
+                  @value.stubs(:exitstatus).returns(0)
+                end
+
+                should "execute script" do
+                  Open3.expects(:popen3).with(@script_location, :pgroup=>true).yields([@mock_pipe,@mock_pipe,@mock_pipe,@wait_thr])
+                  @hook_executor.execute
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end