Adding --appspec-filename option description to bin/codedeploy-local, integration test cases covering custom appspec filename

Author: chrisdibble

bin/codedeploy-local

@@ -54,6 +54,7 @@ Synopsis
   [--application-name <value>]
   [--events <value>]
   [--agent-configuration-file <value>]
+  [--appspec-filename <value>]
 
 Options
 *******
@@ -83,6 +84,9 @@ Options
   -c, --agent-configuration-file <value>
   The location of a configuration file to use for the deployment, if you store it in a location other than the default. A configuration file specifies alternatives to other default values and behaviors for a deployment. By default, configuration files are stored as /etc/codedeploy-agent/conf/codedeployagent.yml (Amazon Linux, RHEL, or Ubuntu Server instances) or C:/ProgramData/Amazon/CodeDeploy/conf.yml (Windows Server).
 
+  -A, --appspec-filename <value>
+  The name of the appspec file to use for the deployment, if you set it to a name other than the default. By default, appspec files are named "appspec.yml" or "appspec.yaml".
+
   -h, --help
   Displays a summary of help content.
 

features/codedeploy-local/codedeploy_local.feature

@@ -93,3 +93,17 @@ Feature: Local Deploy using AWS CodeDeploy Local CLI
     When I create a local deployment with my bundle with file-exists-behavior RETAIN
     Then the local deployment command should succeed
     And the expected existing file should end up like file-exists-behavior RETAIN specifies
+
+  Scenario: Doing a sample local deployment using a directory bundle with a custom appspec filename
+    Given I have a sample local directory bundle
+    And I have a custom appspec filename appspec_override.yaml
+    When I create a local deployment with my bundle
+    Then the local deployment command should succeed
+    And the expected files should have have been locally deployed to my host
+    And the scripts should have been executed during local deployment
+
+  Scenario: Doing a sample local deployment using a directory bundle with a non-existent custom appspec filename
+    Given I have a sample local directory bundle
+    And I have a custom appspec filename appspec_nonexistent.yaml
+    When I create a local deployment with my bundle
+    Then the local deployment command should fail

features/resources/sample_app_bundle_linux/appspec_override.yaml

@@ -0,0 +1,21 @@
+version: 0.0
+os: linux
+hooks:
+    BeforeBlockTraffic:
+        - location: scripts/before_block_traffic.sh
+    AfterBlockTraffic:
+        - location: scripts/after_block_traffic.sh
+    ApplicationStop:
+        - location: scripts/application_stop.sh
+    BeforeInstall:
+        - location: scripts/before_install.sh
+    AfterInstall:
+        - location: scripts/after_install.sh
+    ApplicationStart:
+        - location: scripts/application_start.sh
+    ValidateService:
+        - location: scripts/validate_service.sh
+    BeforeAllowTraffic:
+        - location: scripts/before_allow_traffic.sh
+    AfterAllowTraffic:
+        - location: scripts/after_allow_traffic.sh

features/step_definitions/codedeploy_local_steps.rb

@@ -15,6 +15,7 @@
 Before("@codedeploy-local") do
   @test_directory = Dir.mktmpdir
   configure_local_agent(@test_directory)
+  @appspec_filename = 'appspec.yml'
 end
 
 After("@codedeploy-local") do
@@ -121,6 +122,10 @@ def tgz_app_bundle(temp_directory_to_create_bundle)
   tgz_file_name
 end
 
+Given(/^I have a custom appspec filename ([^"]*)$/) do |custom_appspec_filename|
+  @appspec_filename = custom_appspec_filename
+end
+
 When(/^I create a local deployment with my bundle with only events (.+)$/) do |custom_events|
   @local_deployment_succeeded = create_local_deployment(custom_events.split(' '))
 end
@@ -148,7 +153,7 @@ def create_local_deployment(custom_events = nil, file_exists_behavior = nil)
   # Windows doesn't respect shebang lines so ruby needs to be specified
   ruby_prefix_for_windows = StepConstants::IS_WINDOWS ? "ruby " : ""
 
-  system "#{ruby_prefix_for_windows}bin/codedeploy-local --bundle-location #{@bundle_location} --type #{@bundle_type} --deployment-group #{LOCAL_DEPLOYMENT_GROUP_ID} --agent-configuration-file #{InstanceAgent::Config.config[:config_file]}#{codeedeploy_command_suffix}"
+  system "#{ruby_prefix_for_windows}bin/codedeploy-local --bundle-location #{@bundle_location} --type #{@bundle_type} --deployment-group #{LOCAL_DEPLOYMENT_GROUP_ID} --agent-configuration-file #{InstanceAgent::Config.config[:config_file]}#{codeedeploy_command_suffix} --appspec-filename #{@appspec_filename}"
 end
 
 Then(/^the local deployment command should succeed$/) do

features/step_definitions/common_steps.rb

@@ -78,7 +78,8 @@ def write_zip_entries(entries, path, input_dir, zip_io)
   expect(files_and_directories_in_deployment_id_folder).to include(*%w(logs deployment-archive))
 
   files_and_directories_in_deployment_archive_folder = InstanceAgent::Plugins::CodeDeployPlugin::DeploymentCommandTracker.directories_and_files_inside("#{InstanceAgent::Config.config[:root_dir]}/#{deployment_group_id}/#{deployment_id}/deployment-archive")
-  expect(files_and_directories_in_deployment_archive_folder.size).to eq(2)
+  # most sample apps contain 2 files that should be present, except the linux sample app which contains an additional appspec file with a custom filename
+  expect(files_and_directories_in_deployment_archive_folder.size).to be_between(2, 3)
   expect(files_and_directories_in_deployment_archive_folder).to include(*%w(appspec.yml scripts))
 
   files_in_scripts_folder = InstanceAgent::Plugins::CodeDeployPlugin::DeploymentCommandTracker.directories_and_files_inside("#{InstanceAgent::Config.config[:root_dir]}/#{deployment_group_id}/#{deployment_id}/deployment-archive/scripts")

lib/aws/codedeploy/local/cli_validator.rb

@@ -44,7 +44,7 @@ def validate(args)
             if !appspec_filename.nil? && !File.exists?("#{location}/#{appspec_filename}")
               raise ValidationError.new("Expecting appspec file at location #{location}/#{appspec_filename} but it is not found there. Please either run the CLI from within a directory containing the #{appspec_filename} file or specify a bundle location containing an #{appspec_filename} file in its root directory")
             end
-            if !File.exists?("#{location}/appspec.yml") && !File.exists?("#{location}/appspec.yaml")
+            if appspec_filename.nil? && !File.exists?("#{location}/appspec.yml") && !File.exists?("#{location}/appspec.yaml")
               raise ValidationError.new("Expecting appspec file at location #{location}/appspec.yml or #{location}/appspec.yaml but it is not found there. Please either run the CLI from within a directory containing the appspec.yml or appspec.yaml file or specify a bundle location containing an appspec.yml or appspec.yaml file in its root directory")
             end
           end

lib/instance_agent/plugins/codedeploy/deployment_specification.rb

@@ -175,4 +175,4 @@ def getDeploymentIdFromArn(arn)
       end
     end
   end
-end
+end