1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
# Author:: Lamont Granquist (<lamont@opscode.com>)
# Copyright:: Copyright (c) 2013 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require 'chef/mixin/shell_out'
class Chef
class Util
class Diff
include Chef::Mixin::ShellOut
# @todo: to_a, to_s, to_json, inspect defs, accessors for @diff and @error
# @todo: move coercion to UTF-8 into to_json
# @todo: replace shellout to diff -u with diff-lcs gem
def for_output
# formatted output to a terminal uses arrays of strings and returns error strings
@diff.nil? ? [ @error ] : @diff
end
def for_reporting
# caller needs to ensure that new files aren't posted to resource reporting
return nil if @diff.nil?
@diff.join("\\n")
end
def use_tempfile_if_missing(file)
tempfile = nil
unless File.exists?(file)
Chef::Log.debug("file #{file} does not exist to diff against, using empty tempfile")
tempfile = Tempfile.new("chef-diff")
file = tempfile.path
end
yield file
unless tempfile.nil?
tempfile.close
tempfile.unlink
end
end
def diff(old_file, new_file)
use_tempfile_if_missing(old_file) do |old_file|
use_tempfile_if_missing(new_file) do |new_file|
@error = do_diff(old_file, new_file)
end
end
end
private
def do_diff(old_file, new_file)
if Chef::Config[:diff_disabled]
return "(diff output suppressed by config)"
end
diff_filesize_threshold = Chef::Config[:diff_filesize_threshold]
diff_output_threshold = Chef::Config[:diff_output_threshold]
if ::File.size(old_file) > diff_filesize_threshold || ::File.size(new_file) > diff_filesize_threshold
return "(file sizes exceed #{diff_filesize_threshold} bytes, diff output suppressed)"
end
# MacOSX(BSD?) diff will *sometimes* happily spit out nasty binary diffs
return "(current file is binary, diff output suppressed)" if is_binary?(old_file)
return "(new content is binary, diff output suppressed)" if is_binary?(new_file)
begin
# -u: Unified diff format
# LC_ALL: in ruby 1.9 we want to set nil which is a magic option to mixlib-shellout to
# pass through the LC_ALL locale. in ruby 1.8 we force to 7-bit 'C' locale
# (which is the mixlib-shellout default for all rubies all the time).
Chef::Log.debug("running: diff -u #{old_file} #{new_file}")
env = ( Object.const_defined? :Encoding ) ? nil : 'C'
result = shell_out("diff -u #{old_file} #{new_file}", :env => {'LC_ALL' => env})
rescue Exception => e
# Should *not* receive this, but in some circumstances it seems that
# an exception can be thrown even using shell_out instead of shell_out!
return "Could not determine diff. Error: #{e.message}"
end
# diff will set a non-zero return code even when there's
# valid stdout results, if it encounters something unexpected
# So as long as we have output, we'll show it.
#
# Also on some platforms (Solaris) diff outputs a single line
# when there are no differences found. Look for this line
# before analyzing diff output.
if !result.stdout.empty? && result.stdout != "No differences encountered\n"
if result.stdout.length > diff_output_threshold
return "(long diff of over #{diff_output_threshold} characters, diff output suppressed)"
else
diff_str = result.stdout
if diff_str.respond_to?(:encoding)
# in ruby 1.9 diff_str will be ASCII-8BIT, in 2.0 it will be default_external (e.g. UTF-8)
# we will post this as JSON which needs UTF-8, so we force to UTF-8 here as part of the API
diff_str.encode!('UTF-8', :invalid => :replace, :undef => :replace, :replace => '?')
end
@diff = diff_str.split("\n")
return "(diff available)"
end
elsif !result.stderr.empty?
return "Could not determine diff. Error: #{result.stderr}"
else
return "(no diff)"
end
end
def is_binary?(path)
File.open(path) do |file|
# NB: IO.read() returns ASCII-8BIT, we use File.readlines to get Encoding.default_external
# XXX: this slurps into RAM, but we should have already checked our diff has a reasonable size
buff = file.readlines.join
buff = "" if buff.nil?
begin
return buff !~ /\A[\s[:print:]]*\z/m
rescue ArgumentError => e
return true if e.message =~ /invalid byte sequence/
raise
end
end
end
end
end
end
|
