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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
#
# Author:: Daniel DeLeo (<dan@opscode.com>)
# Copyright:: Copyright (c) 2010 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 'pathname'
require 'chef/mixin/shell_out'
require 'chef/mixin/checksum'
class Chef
class Cookbook
# == Chef::Cookbook::SyntaxCheck
# Encapsulates the process of validating the ruby syntax of files in Chef
# cookbooks.
class SyntaxCheck
# == Chef::Cookbook::SyntaxCheck::PersistentSet
# Implements set behavior with disk-based persistence. Objects in the set
# are expected to be strings containing only characters that are valid in
# filenames.
#
# This class is used to track which files have been syntax checked so
# that known good files are not rechecked.
class PersistentSet
attr_reader :cache_path
# Create a new PersistentSet. Values in the set are persisted by
# creating a file in the +cache_path+ directory.
def initialize(cache_path=Chef::Config[:syntax_check_cache_path])
@cache_path = cache_path
@cache_path_created = false
end
# Adds +value+ to the set's collection.
def add(value)
ensure_cache_path_created
FileUtils.touch(File.join(cache_path, value))
end
# Returns true if the set includes +value+
def include?(value)
File.exist?(File.join(cache_path, value))
end
private
def ensure_cache_path_created
return true if @cache_path_created
FileUtils.mkdir_p(cache_path)
@cache_path_created = true
end
end
include Chef::Mixin::ShellOut
include Chef::Mixin::Checksum
attr_reader :cookbook_path
# A PersistentSet object that tracks which files have already been
# validated.
attr_reader :validated_files
# Creates a new SyntaxCheck given the +cookbook_name+ and a +cookbook_path+.
# If no +cookbook_path+ is given, +Chef::Config.cookbook_path+ is used.
def self.for_cookbook(cookbook_name, cookbook_path=nil)
cookbook_path ||= Chef::Config.cookbook_path
unless cookbook_path
raise ArgumentError, "Cannot find cookbook #{cookbook_name} unless Chef::Config.cookbook_path is set or an explicit cookbook path is given"
end
new(File.join(cookbook_path, cookbook_name.to_s))
end
# Create a new SyntaxCheck object
# === Arguments
# cookbook_path::: the (on disk) path to the cookbook
def initialize(cookbook_path)
@cookbook_path = cookbook_path
@validated_files = PersistentSet.new
end
def chefignore
@chefignore ||= Chefignore.new(File.dirname(cookbook_path))
end
def remove_ignored_files(file_list)
return file_list unless chefignore.ignores.length > 0
file_list.reject do |full_path|
cookbook_pn = Pathname.new cookbook_path
full_pn = Pathname.new full_path
relative_pn = full_pn.relative_path_from cookbook_pn
chefignore.ignored? relative_pn.to_s
end
end
def ruby_files
remove_ignored_files Dir[File.join(cookbook_path, '**', '*.rb')]
end
def untested_ruby_files
ruby_files.reject do |file|
if validated?(file)
Chef::Log.debug("Ruby file #{file} is unchanged, skipping syntax check")
true
else
false
end
end
end
def template_files
remove_ignored_files Dir[File.join(cookbook_path, '**', '*.erb')]
end
def untested_template_files
template_files.reject do |file|
if validated?(file)
Chef::Log.debug("Template #{file} is unchanged, skipping syntax check")
true
else
false
end
end
end
def validated?(file)
validated_files.include?(checksum(file))
end
def validated(file)
validated_files.add(checksum(file))
end
def validate_ruby_files
untested_ruby_files.each do |ruby_file|
return false unless validate_ruby_file(ruby_file)
validated(ruby_file)
end
end
def validate_templates
untested_template_files.each do |template|
return false unless validate_template(template)
validated(template)
end
end
def validate_template(erb_file)
Chef::Log.debug("Testing template #{erb_file} for syntax errors...")
result = shell_out("erubis -x #{erb_file} | ruby -c")
result.error!
true
rescue Mixlib::ShellOut::ShellCommandFailed
file_relative_path = erb_file[/^#{Regexp.escape(cookbook_path+File::Separator)}(.*)/, 1]
Chef::Log.fatal("Erb template #{file_relative_path} has a syntax error:")
result.stderr.each_line { |l| Chef::Log.fatal(l.chomp) }
false
end
def validate_ruby_file(ruby_file)
Chef::Log.debug("Testing #{ruby_file} for syntax errors...")
result = shell_out("ruby -c #{ruby_file}")
result.error!
true
rescue Mixlib::ShellOut::ShellCommandFailed
file_relative_path = ruby_file[/^#{Regexp.escape(cookbook_path+File::Separator)}(.*)/, 1]
Chef::Log.fatal("Cookbook file #{file_relative_path} has a ruby syntax error:")
result.stderr.each_line { |l| Chef::Log.fatal(l.chomp) }
false
end
end
end
end
|
