Reword error messages to make them more descriptive

Author: ambareesha

lib/instance_agent/plugins/codedeploy/application_specification/ace_info.rb

@@ -12,20 +12,20 @@ def initialize(ace, internal=false)
             @name = ""
             parts = ace.split(":", -1).reverse
             if (parts.length < 2) || (parts.length > 4)
-              raise AppSpecValidationException, "invalid acl entry #{ace}"
+              raise AppSpecValidationException, "The deployment failed because of a problem with the acls permission settings in the application specification file. Invalid acl entry (#{ace})."
             end
 
             if (parts.length == 4)
               if !(parts[3].eql?("d") || (parts[3].eql?("default")))
-                raise AppSpecValidationException, "invalid acl entry #{ace}"
+                raise AppSpecValidationException, "The deployment failed because of a problem with the acls permission settings in the application specification file. Invalid acl entry (#{ace})."
               end
               @default = true
             end
 
             if parts.length >= 3
               if parts[2].eql?("d") || (parts[2].eql?("default"))
                 if @default
-                  raise AppSpecValidationException, "invalid acl entry #{ace}"
+                  raise AppSpecValidationException, "The deployment failed because of a problem with the acls permission settings in the application specification file. Invalid acl entry (#{ace})."
                 end
                 @default = true
               elsif parts[2].eql?("m") || parts[2].eql?("mask")
@@ -37,7 +37,7 @@ def initialize(ace, internal=false)
               elsif parts[2].eql?("u") || parts[2].eql?("user")
                 @type = "user"
               else
-                raise AppSpecValidationException, "invalid acl entry #{ace}"
+                raise AppSpecValidationException, "The deployment failed because of a problem with the acls permission settings in the application specification file. Invalid acl entry (#{ace})."
               end
             end
 
@@ -61,10 +61,10 @@ def initialize(ace, internal=false)
             end
 
             if (@type.eql?("mask") || @type.eql?("other")) && !@name.empty?
-              raise AppSpecValidationException, "invalid acl entry #{ace}"
+              raise AppSpecValidationException, "The deployment failed because of a problem with the acls permission settings in the application specification file. Invalid acl entry (#{ace})."
             end
             if (!internal && !@default && !@type.eql?("mask") && @name.empty?)
-              raise AppSpecValidationException, "use mode to set the base acl entry #{ace}"
+              raise AppSpecValidationException, "The deployment failed because of a problem with the acls permission settings in the application specification file. Use mode to set the base acl entry (#{ace}). Update the permissions section of the AppSpec file, and then try again."
             end
 
             perm_chars = parts[0].chars.entries
@@ -87,7 +87,7 @@ def initialize(ace, internal=false)
                   @execute = true
                 when '-'
                 else
-                  raise AppSpecValidationException, "unrecognized permission character #{perm} in #{ace}"
+                  raise AppSpecValidationException, "The deployment failed because the access control list (ACL) named #{ace} in the application specification file contains an invalid character (#{perm}). Correct the ACL in the hooks section of the AppSpec file, and then try again."
                 end
               end
             end
@@ -130,4 +130,4 @@ def to_bits(num, min_size)
       end
     end
   end
-end
+end

lib/instance_agent/plugins/codedeploy/application_specification/application_specification.rb

@@ -26,7 +26,7 @@ def supported_versions()
 
           def parse_version(version)
             if !supported_versions.include?(version)
-              raise AppSpecValidationException, "unsupported version: #{version}"
+              raise AppSpecValidationException, "The deployment failed because an invalid version value (#{version}) was entered in the application specification file. Make sure your AppSpec file specifies \"0.0\" as the version, and then try again."
             end
             version
           end
@@ -37,7 +37,7 @@ def supported_oses()
 
           def parse_os(os)
             if !supported_oses.include?(os)
-              raise AppSpecValidationException, "unsupported os: #{os}"
+              raise AppSpecValidationException, "The deployment failed because the application specification file specifies an unsupported operating system (#{os}). Specify either \"linux\" or \"windows\" in the os section of the AppSpec file, and then try again."
             end
             os
           end
@@ -64,7 +64,7 @@ def parse_hooks(hooks_hash)
                     :timeout => script['timeout']
                   })
                 else
-                  raise AppSpecValidationException, 'script provided without a location value'
+                  raise AppSpecValidationException, 'The deployment failed because the application specification file specifies a script with no location value. Specify the location in the hooks section of the AppSpec file, and then try again.'
                 end
               end
               temp_hooks_hash[hook] = current_hook_scripts
@@ -77,7 +77,7 @@ def parse_permissions(permissions_list)
             #loop through list and create permissionsInfo representations
             permissions_list.each do |permission|
               if !permission.has_key?('object') || permission['object'].nil?
-                raise AppSpecValidationException, 'permission provided without a object value'
+                raise AppSpecValidationException, 'The deployment failed because a permission listed in the application specification file has no object value. Update the permissions section of the AppSpec file, and then try again.'
               end
               if @os.eql?('linux')
                 permissions << InstanceAgent::Plugins::CodeDeployPlugin::ApplicationSpecification::LinuxPermissionInfo.new(permission['object'].to_s.strip,
@@ -92,7 +92,7 @@ def parse_permissions(permissions_list)
                   :context => parse_context(permission['context'])
                 })
               else
-                raise AppSpecValidationException, 'permissions only supported with linux os currently'
+                raise AppSpecValidationException, 'The deployment failed because the application specification file specifiles file permissions, but the deployment is targeting one or more Windows Server instances. Permissions are supported only for Amazon Linux, Ubuntu Server, and Red Hat Enterprise Linux (RHEL) instances. Update the permissions section of the AppSpec file, and then try again.'
               end
             end
             permissions
@@ -119,7 +119,7 @@ def parse_type_list(type_list)
             type_list ||= supported_types
             type_list.each do |type|
               if !supported_types.include?(type)
-                raise AppSpecValidationException, "assigning permissions to objects of type #{type} not supported"
+                raise AppSpecValidationException, "The deployment failed because the application specification file specifies a permission for an object type not supported for permissions (#{type}). Update the permissions section of the AppSpec file, and then try again."
               end
             end
             type_list

lib/instance_agent/plugins/codedeploy/application_specification/context_info.rb

@@ -8,7 +8,7 @@ class ContextInfo
           attr_reader :user, :role, :type, :range
           def initialize(context)
             if context['type'].nil?
-              raise AppSpecValidationException, "invalid context type required #{context.inspect}"
+              raise AppSpecValidationException, "The deployment failed because the application specification file specifies an invalid context type (#{context.inspect}). Update the permissions section of the AppSpec file, and then try again."
             end
             @user = context['name']
             @role = nil
@@ -20,4 +20,4 @@ def initialize(context)
       end
     end
   end
-end
+end

lib/instance_agent/plugins/codedeploy/application_specification/file_info.rb

@@ -8,9 +8,9 @@ class FileInfo
           attr_reader :source, :destination
           def initialize(source, destination, opts = {})
             if(source.nil?)
-              raise AppSpecValidationException, 'File needs to have a source'
+              raise AppSpecValidationException, 'The deployment failed because the application specification file specifies a destination file, but no source file. Update the files section of the AppSpec file, and then try again.'
             elsif (destination.nil?)
-              raise AppSpecValidationException, "File #{source} needs to have a destination"
+              raise AppSpecValidationException, "The deployment failed because the application specification file specifies only a source file (#{source}). Add the name of the destination file to the files section of the AppSpec file, and then try again."
             end
             @source = source
             @destination = destination

lib/instance_agent/plugins/codedeploy/application_specification/linux_permission_info.rb

@@ -9,7 +9,7 @@ class LinuxPermissionInfo
           def initialize(object, opts = {})
             object = object.to_s
             if (object.empty?)
-              raise AppSpecValidationException, 'Permission needs a object value'
+              raise AppSpecValidationException, 'The deployment failed because a permission listed in the application specification file has no object value. Update the permissions section of the AppSpec file, and then try again.'
             end
             @object = object
             @pattern = opts[:pattern] || "**"
@@ -25,10 +25,10 @@ def initialize(object, opts = {})
           def validate_file_permission()
             if @type.include?("file")
               if !"**".eql?(@pattern)
-                raise AppSpecValidationException, "Attempt to use pattern #{@pattern} when assigning permissions to file #{@object}"
+                raise AppSpecValidationException, "The deployment failed because the application specification file includes an object (#{@object}) with an invalid pattern (#{@pattern}), such as a pattern for a file applied to a directory. Correct the permissions section of the AppSpec file, and then try again."
               end
               if !@except.empty?
-                raise AppSpecValidationException, "Attempt to use except #{@except} when assigning permissions to file #{@object}"
+                raise AppSpecValidationException, "The deployment failed because the except parameter for a pattern in the permissions section (#{@except}) for the object named #{@object} contains an invalid format. Update the AppSpec file, and then try again."
               end
             end
           end
@@ -37,7 +37,7 @@ def validate_file_acl(object)
             if !@acls.nil?
               default_acl = @acls.get_default_ace
               if !default_acl.nil?
-                raise "Attempt to set default acl #{default_acl} on file #{object}"
+                raise "The deployment failed because the -d parameter has been specified to apply an acl setting to a file. This parameter is supported for directories only. Update the AppSpec file, and then try again."
               end
             end
           end
@@ -118,4 +118,4 @@ def sanitize_dir_path(path)
       end
     end
   end
-end
+end

lib/instance_agent/plugins/codedeploy/application_specification/mode_info.rb

@@ -16,11 +16,11 @@ def initialize(mode)
               mode = "0" + mode;
             end
             if mode.length > 4
-              raise AppSpecValidationException, "permission mode length incorrect: #{mode}"
+              raise AppSpecValidationException, "The deployment failed because the length of a permissions mode (#{mode}) in the application specification file is invalid. Permissions modes must be between one and four characters long. Update the permissions section of the AppSpec file, and then try again."
             end
             mode.each_char do |char|
               if (char.ord < '0'.ord) || (char.ord > '7'.ord)
-                raise AppSpecValidationException, "invalid character #{char} in permission mode #{mode}"
+                raise AppSpecValidationException, "The deployment failed because the permissions mode (#{mode}) in the application specification file contains an invalid character (#{char}). Update the permissions section of the AppSpec file, and then try again."
               end
             end
             @mode = mode
@@ -63,4 +63,4 @@ def to_bits(num, min_size)
       end
     end
   end
-end
+end

lib/instance_agent/plugins/codedeploy/application_specification/range_info.rb

@@ -13,7 +13,7 @@ def initialize(range)
             if sensitivity_parts.length == 2
               @high_sensitivity = getSensitivityNumber(sensitivity_parts[1])
               if @high_sensitivity < @low_sensitivity
-                raise AppSpecValidationException, "invalid sensitivity range in #{range}"
+                raise AppSpecValidationException, "The deployment failed because of a problem with the SELinux range specified (#{range}) for the context parameter in the permissions section of the application specification file. Make corrections in the permissions section of the AppSpec file, and then try again."
               end
             else
               @high_sensitivity = @low_sensitivity
@@ -131,4 +131,4 @@ def get_range
       end
     end
   end
-end
+end

lib/instance_agent/plugins/codedeploy/application_specification/script_info.rb

@@ -9,15 +9,15 @@ class ScriptInfo
           def initialize(location, opts = {})
             location = location.to_s
             if(location.empty?)
-              raise AppSpecValidationException, 'Scripts need a location value'
+              raise AppSpecValidationException, 'The deployment failed because the application specification file specifies a script with no location value. Specify the location in the hooks section of the AppSpec file, and then try again.'
             end
             @location = location
             @runas = opts[:runas]
             @sudo = opts[:sudo]
             @timeout = opts[:timeout] || 3600
             @timeout = @timeout.to_i
             if(@timeout <= 0)
-              raise AppSpecValidationException, 'Timeout needs to be an integer greater than 0'
+              raise AppSpecValidationException, 'The deployment failed because an invalid timeout value was provided for a script in the application specification file. Make corrections in the hooks section of the AppSpec file, and then try again.'
             end
           end
         end