Allow overriding appspec path + fallback to appspec.yml and appspec.yaml

nyo · nyo · commit f294c2edeac0 · 2020-09-01T19:59:55.000+02:00
Removed leftover debug typos

Renamed variable to not have default in the name
diff --git a/lib/instance_agent/plugins/codedeploy/command_executor.rb b/lib/instance_agent/plugins/codedeploy/command_executor.rb
@@ -154,7 +154,7 @@ def map
                 :deployment_root_dir => deployment_root_dir(deployment_spec),
                 :last_successful_deployment_dir => last_successful_deployment_dir(deployment_spec.deployment_group_id),
                 :most_recent_deployment_dir => most_recent_deployment_dir(deployment_spec.deployment_group_id),
-                :app_spec_path => app_spec_path)
+                :app_spec_path => deployment_spec.app_spec_path)
                 script_log.concat_log(hook_command.execute)
               end
               script_log.log
@@ -183,7 +183,7 @@ def last_successful_deployment_dir(deployment_group)
           return unless File.exist? last_successful_install_file_location
           File.open last_successful_install_file_location do |f|
             return f.read.chomp
-          end 
+          end
         end
 
         private
@@ -192,18 +192,18 @@ def most_recent_deployment_dir(deployment_group)
           return unless File.exist? most_recent_install_file_location
           File.open most_recent_install_file_location do |f|
             return f.read.chomp
-          end 
+          end
         end
 
         private
         def default_app_spec(deployment_spec)
-          default_app_spec_location = File.join(archive_root_dir(deployment_spec), app_spec_path)
-          log(:debug, "Checking for app spec in #{default_app_spec_location}")
-          validate_app_spec_hooks(ApplicationSpecification::ApplicationSpecification.parse(File.read(default_app_spec_location)), deployment_spec.all_possible_lifecycle_events)
+          app_spec_location = app_spec_real_path(deployment_spec)
+          validate_app_spec_hooks(app_spec_location, deployment_spec.all_possible_lifecycle_events)
         end
 
         private
-        def validate_app_spec_hooks(app_spec, all_possible_lifecycle_events)
+        def validate_app_spec_hooks(app_spec_location, all_possible_lifecycle_events)
+          app_spec = ApplicationSpecification::ApplicationSpecification.parse(File.read(app_spec_location))
           unless all_possible_lifecycle_events.nil?
             app_spec_hooks_plus_hooks_from_mapping = app_spec.hooks.keys.to_set.merge(@hook_mapping.keys).to_a
             unless app_spec_hooks_plus_hooks_from_mapping.to_set.subset?(all_possible_lifecycle_events.to_set)
@@ -238,7 +238,7 @@ def most_recent_install_file_path(deployment_group)
         private
         def download_from_s3(deployment_spec, bucket, key, version, etag)
           log(:debug, "Downloading artifact bundle from bucket '#{bucket}' and key '#{key}', version '#{version}', etag '#{etag}'")
-                    
+
           s3 = Aws::S3::Client.new(s3_options)
 
           File.open(artifact_bundle(deployment_spec), 'wb') do |file|
@@ -269,14 +269,14 @@ def s3_options
           if !InstanceAgent::Config.config[:s3_endpoint_override].to_s.empty?
             options[:endpoint] = URI(InstanceAgent::Config.config[:s3_endpoint_override])
           elsif InstanceAgent::Config.config[:use_fips_mode]
-            #S3 Fips pseudo-regions are not supported by the SDK yet 
+            #S3 Fips pseudo-regions are not supported by the SDK yet
             #source for the URL: https://aws.amazon.com/compliance/fips/
             options[:endpoint] = "https://s3-fips.#{region}.amazonaws.com"
-          end 
+          end
           proxy_uri = nil
           if InstanceAgent::Config.config[:proxy_uri]
             proxy_uri = URI(InstanceAgent::Config.config[:proxy_uri])
-          end          
+          end
           options[:http_proxy] = proxy_uri
 
           if InstanceAgent::Config.config[:log_aws_wire]
@@ -288,10 +288,10 @@ def s3_options
                 64 * 1024 * 1024)
             options[:http_wire_trace] = true
           end
-          
-          options          
-        end  
-        
+
+          options
+        end
+
         private
         def download_from_github(deployment_spec, account, repo, commit, anonymous, token)
 
@@ -402,7 +402,7 @@ def unpack_bundle(cmd, bundle_file, deployment_spec)
 
           # If the top level of the archive is a directory that contains an appspec,
           # strip that before giving up
-          if ((archive_root_files.size == 1) && 
+          if ((archive_root_files.size == 1) &&
               File.directory?(File.join(dst, archive_root_files[0])) &&
               Dir.entries(File.join(dst, archive_root_files[0])).grep(/appspec/i).any?)
             log(:info, "Stripping leading directory from archive bundle contents.")
@@ -417,7 +417,7 @@ def unpack_bundle(cmd, bundle_file, deployment_spec)
             FileUtils.mv(nested_archive_root, dst)
             FileUtils.rmdir(tmp_dst)
 
-            log(:debug, Dir.entries(dst).join("; "))            
+            log(:debug, Dir.entries(dst).join("; "))
           end
         end
 
@@ -433,7 +433,7 @@ def update_most_recent_install(deployment_spec)
           File.open(most_recent_install_file_path(deployment_spec.deployment_group_id), 'w+') do |f|
             f.write deployment_root_dir(deployment_spec)
           end
-        end  
+        end
 
         private
         def cleanup_old_archives(deployment_spec)
@@ -445,7 +445,7 @@ def cleanup_old_archives(deployment_spec)
 
           full_path_deployment_archives = deployment_archives.map{ |f| File.join(ProcessManager::Config.config[:root_dir], deployment_group, f)}
           full_path_deployment_archives.delete(deployment_root_dir(deployment_spec))
-          
+
           extra = full_path_deployment_archives.size - @archives_to_retain + 1
           return unless extra > 0
 
@@ -458,7 +458,7 @@ def cleanup_old_archives(deployment_spec)
 
           # Absolute path takes care of relative root directories
           directories = oldest_extra.map{ |f| File.absolute_path(f) }
-          log(:debug,"Delete Files #{directories}" )
+          log(:debug, "Delete Files #{directories}")
           InstanceAgent::Platform.util.delete_dirs_command(directories)
 
         end
@@ -473,6 +473,24 @@ def app_spec_path
           'appspec.yml'
         end
 
+        # Checks for existence the possible extensions of the app_spec_path (.yml and .yaml)
+        private
+        def app_spec_real_path(deployment_spec)
+          app_spec_param_location = File.join(archive_root_dir(deployment_spec), deployment_spec.app_spec_path)
+          app_spec_yaml_location = File.join(archive_root_dir(deployment_spec), "appspec.yaml")
+          app_spec_yml_location = File.join(archive_root_dir(deployment_spec), "appspec.yml")
+          if File.exist? app_spec_param_location
+            log(:debug, "Using appspec file #{app_spec_param_location}")
+            app_spec_param_location
+          elsif File.exist? app_spec_yaml_location
+            log(:debug, "Using appspec file #{app_spec_yaml_location}")
+            app_spec_yaml_location
+          else
+            log(:debug, "Using appspec file #{app_spec_yml_location}")
+            app_spec_yml_location
+          end
+        end
+
         private
         def description
           self.class.to_s
diff --git a/lib/instance_agent/plugins/codedeploy/deployment_specification.rb b/lib/instance_agent/plugins/codedeploy/deployment_specification.rb
@@ -13,6 +13,7 @@ class DeploymentSpecification
         attr_accessor :external_account, :repository, :commit_id, :anonymous, :external_auth_token
         attr_accessor :file_exists_behavior
         attr_accessor :local_location, :all_possible_lifecycle_events
+        attr_accessor :app_spec_path
         class << self
           attr_accessor :cert_store
         end
@@ -47,6 +48,12 @@ def initialize(data)
           @deployment_creator = data["DeploymentCreator"] || "user"
           @deployment_type = data["DeploymentType"] || "IN_PLACE"
 
+          if property_set?(data, "AppSpecPath")
+            @app_spec_path = data["AppSpecPath"]
+          else
+            @app_spec_path = "appspec.yml"
+          end
+
           raise 'Must specify a revison' unless data["Revision"]
           @revision_source = data["Revision"]["RevisionType"]
           raise 'Must specify a revision source' unless @revision_source
diff --git a/test/instance_agent/plugins/codedeploy/command_executor_test.rb b/test/instance_agent/plugins/codedeploy/command_executor_test.rb
@@ -148,10 +148,8 @@ def generate_signed_message_for(map)
           File.stubs(:open).with(@last_successful_install_file_location)
 
           @app_spec = mock("parsed application specification")
-          File.
-          stubs(:read).
-          with("#@archive_root_dir/appspec.yml").
-          returns("APP SPEC")
+          File.stubs(:exist?).with("#@archive_root_dir/appspec.yml").returns(true)
+          File.stubs(:read).with("#@archive_root_dir/appspec.yml").returns("APP SPEC")
           ApplicationSpecification::ApplicationSpecification.stubs(:parse).with("APP SPEC").returns(@app_spec)
         end
 
@@ -234,6 +232,91 @@ def generate_signed_message_for(map)
             @command_executor.execute_command(@command, deployment_spec)
           end
         end
+
+        should 'honor the AppSpecPath command variable' do
+          deployment_spec = generate_signed_message_for({
+            "DeploymentId" => @deployment_id.to_s,
+            "DeploymentGroupId" => @deployment_group_id,
+            "ApplicationName" => @application_name,
+            "DeploymentGroupName" => @deployment_group_name,
+            "DeploymentCreator" => @deployment_creator,
+            "DeploymentType" => @deployment_type,
+            "AgentActionOverrides" => @agent_actions_overrides,
+            "AppSpecPath" => "appspec-override.yaml",
+            "Revision" => {
+               "RevisionType" => "S3",
+               "S3Revision" => @s3Revision
+              }
+            })
+
+            File.expects(:exist?).with("#@archive_root_dir/appspec-override.yaml").returns(true)
+            File.expects(:read).with("#@archive_root_dir/appspec-override.yaml").returns("APP SPEC")
+            @command_executor.execute_command(@command, deployment_spec)
+        end
+
+        should 'fallback to appspec.yaml if provided AppSpecPath variable points to a file which does\'t exist' do
+          deployment_spec = generate_signed_message_for({
+            "DeploymentId" => @deployment_id.to_s,
+            "DeploymentGroupId" => @deployment_group_id,
+            "ApplicationName" => @application_name,
+            "DeploymentGroupName" => @deployment_group_name,
+            "DeploymentCreator" => @deployment_creator,
+            "DeploymentType" => @deployment_type,
+            "AgentActionOverrides" => @agent_actions_overrides,
+            "AppSpecPath" => "appspec-override.yaml",
+            "Revision" => {
+              "RevisionType" => "S3",
+              "S3Revision" => @s3Revision
+            }
+          })
+
+          File.expects(:exist?).with("#@archive_root_dir/appspec-override.yaml").returns(false)
+          File.expects(:exist?).with("#@archive_root_dir/appspec.yaml").returns(true)
+          File.expects(:read).with("#@archive_root_dir/appspec.yaml").returns("APP SPEC")
+          @command_executor.execute_command(@command, deployment_spec)
+        end
+        should 'fallback to appspec.yaml if both AppSpecPath variable and appspec.yaml don\'t exist' do
+          deployment_spec = generate_signed_message_for({
+            "DeploymentId" => @deployment_id.to_s,
+            "DeploymentGroupId" => @deployment_group_id,
+            "ApplicationName" => @application_name,
+            "DeploymentGroupName" => @deployment_group_name,
+            "DeploymentCreator" => @deployment_creator,
+            "DeploymentType" => @deployment_type,
+            "AgentActionOverrides" => @agent_actions_overrides,
+            "AppSpecPath" => "appspec-override.yaml",
+            "Revision" => {
+              "RevisionType" => "S3",
+              "S3Revision" => @s3Revision
+            }
+          })
+
+          File.expects(:exist?).with("#@archive_root_dir/appspec-override.yaml").returns(false)
+          File.expects(:exist?).with("#@archive_root_dir/appspec.yaml").returns(false)
+          File.expects(:read).with("#@archive_root_dir/appspec.yml").returns("APP SPEC")
+          @command_executor.execute_command(@command, deployment_spec)
+        end
+
+        should 'fallback to appspec.yaml if appspec.yml is not there and no AppSpecPath arg is specified' do
+          deployment_spec = generate_signed_message_for({
+            "DeploymentId" => @deployment_id.to_s,
+            "DeploymentGroupId" => @deployment_group_id,
+            "ApplicationName" => @application_name,
+            "DeploymentGroupName" => @deployment_group_name,
+            "DeploymentCreator" => @deployment_creator,
+            "DeploymentType" => @deployment_type,
+            "AgentActionOverrides" => @agent_actions_overrides,
+            "Revision" => {
+              "RevisionType" => "S3",
+              "S3Revision" => @s3Revision
+            }
+          })
+
+          File.expects(:exist?).with("#@archive_root_dir/appspec.yml").returns(false)
+          File.expects(:exist?).with("#@archive_root_dir/appspec.yaml").returns(true)
+          File.expects(:read).with("#@archive_root_dir/appspec.yaml").returns("APP SPEC")
+          @command_executor.execute_command(@command, deployment_spec)
+        end
       end
 
       context "when executing the DownloadBundle command" do
@@ -317,36 +400,36 @@ def generate_signed_message_for(map)
         end
 
         context "when creating S3 options" do
-          
+
           should "use right region" do
             assert_equal 'us-east-1', @command_executor.s3_options[:region]
           end
-          
-          should "use right signature version" do 
+
+          should "use right signature version" do
             assert_equal 'v4', @command_executor.s3_options[:signature_version]
           end
-          
+
           should "use right endpoint when using Fips" do
             InstanceAgent::Config.config[:use_fips_mode] = true
             assert_equal 'https://s3-fips.us-east-1.amazonaws.com', @command_executor.s3_options[:endpoint]
             InstanceAgent::Config.config[:use_fips_mode] = false
           end
-          
+
           should "use right endpoint when using endpoint override" do
             s3_endpoint_override_url = 'htpp://testendpointoverride'
             InstanceAgent::Config.config[:s3_endpoint_override] = s3_endpoint_override_url
             assert_equal s3_endpoint_override_url, @command_executor.s3_options[:endpoint].to_s
             InstanceAgent::Config.config[:s3_endpoint_override] = nil
           end
-          
+
           should "use no endpoint when neither using Fips nor Endpoint override" do
             InstanceAgent::Config.config[:s3_endpoint_override] = nil
             InstanceAgent::Config.config[:use_fips_mode] = false
             assert_false @command_executor.s3_options.include? :endpoint
           end
-          
+
         end
-        
+
         context "downloading bundle from S3" do
           setup do
             File.expects(:open).with(File.join(@deployment_root_dir, 'bundle.tar'), 'wb').yields(@mock_file)
@@ -598,7 +681,7 @@ def generate_signed_message_for(map)
             :deployment_group_id => @deployment_group_id,
             :deployment_creator => @deployment_creator,
             :deployment_type => @deployment_type,
-            :deployment_root_dir => @deployment_root_dir, 
+            :deployment_root_dir => @deployment_root_dir,
             :last_successful_deployment_dir => nil,
             :most_recent_deployment_dir => nil,
             :app_spec_path => 'appspec.yml'}
diff --git a/test/instance_agent/plugins/codedeploy/deployment_specification_test.rb b/test/instance_agent/plugins/codedeploy/deployment_specification_test.rb
@@ -25,7 +25,7 @@ def generate_signed_message_for(map)
       @agent_actions_overrides = {"AgentOverrides" => @agent_actions_overrides_map}
       @bundle_type = 'tar'
       InstanceAgent::Config.init
-    end 
+    end
 
     context 'With Github Revision' do
       setup do
@@ -601,6 +601,22 @@ def generate_signed_message_for(map)
         end
       end
 
+      context "with app_spec_path" do
+        should "use the variable set by the AppSpecPath variable" do
+          @deployment_spec["AppSpecPath"] = "foo.yaml"
+          @packed_message = generate_signed_message_for(@deployment_spec)
+          parsed_deployment_spec = InstanceAgent::Plugins::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+          assert_equal "foo.yaml", parsed_deployment_spec.app_spec_path
+        end
+
+        should "fallback to appspec.yml if AppSpecPath is not set" do
+          @deployment_spec.delete("AppSPecPath")
+          @packed_message = generate_signed_message_for(@deployment_spec)
+          parsed_deployment_spec = InstanceAgent::Plugins::CodeDeployPlugin::DeploymentSpecification.parse(@packed_message)
+          assert_equal "appspec.yml", parsed_deployment_spec.app_spec_path
+        end
+      end
+
       context "with file_exists_behavior" do
         should "set file_exists_behavior to DISALLOW when AgentActionOverrides is not set" do
           @deployment_spec.delete("AgentActionOverrides")
