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
|
#
# 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 'chef/checksum_cache'
require 'chef/mixin/shell_out'
class Chef
class Cookbook
# == Chef::Cookbook::SyntaxCheck
# Encapsulates the process of validating the ruby syntax of files in Chef
# cookbooks.
class SyntaxCheck
include Chef::Mixin::ShellOut
attr_reader :cookbook_path
# 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
end
def cache
Chef::ChecksumCache.instance
end
def ruby_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
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)
!!cache.lookup_checksum(cache_key(file), File.stat(file))
end
def validated(file)
cache.generate_checksum(cache_key(file), file, File.stat(file))
end
def cache_key(file)
@cache_keys ||= {}
@cache_keys[file] ||= cache.generate_key(file, "chef-test")
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
|
