fix authorized_keys comment bug

Author: tejaycar

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG for ssh
 
+## 0.10.20
+* allow full line comments on authorized_keys
+
 ## 0.10.18
 * Cleanup tests to get them running again
 * updates for rubocop errors

metadata.rb

@@ -4,7 +4,7 @@
 license          'Apache 2.0'
 description      'LWRPs for managing SSH known_hosts and config files'
 long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
-version          '0.10.18'
+version          '0.10.20'
 issues_url 'https://github.com/markolson/chef-ssh/issues'
 source_url 'https://github.com/markolson/chef-ssh'
 

providers/authorized_keys.rb

@@ -51,19 +51,21 @@ def update_file
 end
 
 def format_lines
-  @lines.collect do |line|
-    joined = if line[:options].nil?
-               ''
-             else
-               line[:options].collect do |key, value|
-                 value.nil? || value.empty? ? key.to_s : "#{key}=\"#{value}\""
-               end.join(',')
-             end
-    joined << ' ' unless joined.empty?
-    joined << line[:type] << ' ' << line[:key]
-    line[:comment] && (joined << ' ' << line[:comment])
-    joined
-  end.join("\n") + "\n"
+  @lines.collect { |line| line.is_a?(String) ? line : construct_line(line) }.join("\n") + "\n"
+end
+
+def construct_line(line)
+  joined = if line[:options].nil?
+             ''
+           else
+             line[:options].collect do |key, value|
+               value.nil? || value.empty? ? key.to_s : "#{key}=\"#{value}\""
+             end.join(',')
+           end
+  joined << ' ' unless joined.empty?
+  joined << line[:type] << ' ' << line[:key]
+  line[:comment] && (joined << ' ' << line[:comment])
+  joined
 end
 
 def initialize(new_resource, run_context)
@@ -77,7 +79,7 @@ def initialize(new_resource, run_context)
 def load_current_resource
   @lines = ::File.exist?(@path) ? parse(::IO.readlines(@path)) : []
 
-  current_line = @lines.find { |line| line[:key] == @new_resource.key }
+  current_line = @lines.find { |line| line.is_a?(Hash) && line[:key] == @new_resource.key }
   @current_resource = Chef::Resource::SshKnownHosts.new(@new_resource.name)
   @current_resource.exists = current_line
 end
@@ -86,15 +88,19 @@ def load_current_resource
 
 def parse(current)
   current.reduce([]) do |memo, row|
-    line = {}
-    # split on whitespace that is not inside of quotes
-    fields = row.split(/(?!\B"[^"]*)\s(?![^"]*"\B)/)
-    line[:options] = parse_options(fields.shift) unless types.include? fields[0]
-    validate_type(fields[0], @path)
-    line[:type] = fields[0]
-    line[:key] = fields[1]
-    line[:comment] = fields[2..-1].join(' ') if fields[2]
-    memo << line
+    if /^#/ =~ row || row.strip.empty?
+      memo << row
+    else
+      line = {}
+      # split on whitespace that is not inside of quotes
+      fields = row.split(/(?!\B"[^"]*)\s(?![^"]*"\B)/)
+      line[:options] = parse_options(fields.shift) unless types.include? fields[0]
+      validate_type(fields[0], @path)
+      line[:type] = fields[0]
+      line[:key] = fields[1]
+      line[:comment] = fields[2..-1].join(' ') if fields[2]
+      memo << line
+    end
   end
 end
 

test/cookbooks/ssh_test/recipes/authorized_keys.rb

@@ -5,6 +5,14 @@
   action [:create, :manage]
 end
 
+directory '/home/test-user/.ssh' do
+  mode 0o0700
+end
+
+file '/home/test-user/.ssh/authorized_keys' do
+  content "# this is a comment\n" + 'ssh-rsa iWasHereAAAAB2EAAAADAQABAAACAQCeCRfSzGWGNsisAZpuFIS0GmHJfgms3g8okwL9h9AvoQPwgyhyri/Wlcz3eyZMvuR4/vwh9FgWpRwLxot7QSGry58GYR9tHkDT9o3m0Hlx28E+K2gbNK5SyFROx5lSfOZkCSyPjBEBmTAadpVYZBJj789oeAT3dDvsxMAqokCIjV5Ey9xBIWKapbsDiTdOHmtDhlrFZfBc75I6tTnW9WGVG6gCQtzyC/tJ2DmWJhtEz9UjxhAOUzazHM2CJ2IlF3SHm+nz7xjTWmGVRzpiellmN+2Stmianea9ga8L//9v06gDKqp2lNSsi2SJujAsEiKAGtQu6Aa4hdxRFt87m6WSN9lusAazZvnX5s93lAmUAG+wWPnAsujkRSDwv2Ju+GdQFW3ncML7aXFOhIMViG6B98X2h9f3W6XdwQseh10QfvFZ3fAmcAvWvlEM0pGXdfKeFY0LfD7UFxTvzEfqPKnbV6SKlAIMAQ3CX+Q1sZ4nfqopZVJwHDHSL/KQeVKePdyFbZcFVE4L/zruS/fLDqiDMq9yZqMu3WkP5bp4crzguaVwHmrTG4k1XOH5jkMrUj7javMLQHWu56bj0heynhXw7gzXnC/DSgY58/1BPEy7ejsGr0RX2LBRulh84UkV0cjLs8MZyBrhS4dYwyBmtcYlh+OVVVwFimg4ayR7UlkVMw==' # rubocop:disable all'
+end
+
 ssh_authorized_keys 'first' do
   user 'test-user'
   type 'ssh-rsa'

test/cookbooks/ssh_test/recipes/known_hosts.rb

@@ -3,13 +3,13 @@
 include_recipe 'ssh'
 
 file '/etc/ssh/ssh_known_hosts' do
-  content "#{::TestData.dummy1_key}\n#{::TestData.dummy2_key}\n"\
+  content "# this is a comment\n#{::TestData.dummy1_key}\n#{::TestData.dummy2_key}\n"\
           "#{::TestData.dummy6_key}\n"
   action :create
 end
 
 file '/home/vagrant/.ssh/known_hosts' do
-  content "#{::TestData.dummy3_key}\n#{::TestData.dummy4_key}\n"
+  content "#{::TestData.dummy3_key}\n# this is a comment\n#{::TestData.dummy4_key}\n"
   action :create
 end
 

test/integration/known_hosts/serverspec/known_hosts_spec.rb

@@ -7,13 +7,15 @@
   its(:content) { should include(TestData.github_key) }
   its(:content) { should include(TestData.dummy1_key) }
   its(:content) { should_not match(/dummy2/) }
+  its(:content) { is_expected.to contain('# this is a comment') }
 end
 
 describe file('/home/vagrant/.ssh/known_hosts') do
   it { should be_file }
   it { should be_readable }
   its(:content) { should include(TestData.dummy3_key) }
   its(:content) { should_not match(/dummy4/) }
+  its(:content) { is_expected.to contain('# this is a comment') }
 end
 
 describe command('ssh-keygen -F github.com -f /home/vagrant/.ssh/known_hosts') do