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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
require 'spec_helper'
require 'puppet_spec/files'
require 'puppet/face'
describe Puppet::Face[:generate, :current] do
include PuppetSpec::Files
let(:genface) { Puppet::Face[:generate, :current] }
# * Format is 'pcore' by default
# * Format is accepted as 'pcore'
# * Any format expect 'pcore' is an error
# * Produces output to '<envroot>/.resource_types'
# * Produces all types found on the module path (that are not in puppet core)
# * Output files match input
# * Removes files for which there is no input
# * Updates a pcore file if it is out of date
# * The --force flag overwrite the output even if it is up to date
# * Environment is set with --environment (setting) (not tested explicitly)
# Writes output for:
# - isomorphic
# - parameters
# - properties
# - title patterns
# - type information is written when the type is X, Y, or Z
#
# Additional features
# - blacklist? whitelist? types to exclude/include
# - generate one resource type (somewhere on modulepath)
# - output to directory of choice
# - clean, clean the output directory (similar to force)
#
[:types].each do |action|
it { is_expected.to be_action(action) }
it { is_expected.to respond_to(action) }
end
context "when used from an interactive terminal" do
before :each do
from_an_interactive_terminal
end
context "in an environment with two modules containing resource types" do
let(:dir) do
dir_containing('environments', { 'testing_generate' => {
'environment.conf' => "modulepath = modules",
'manifests' => { 'site.pp' => "" },
'modules' => {
'm1' => {
'lib' => { 'puppet' => { 'type' => {
'test1.rb' => <<-EOF
module Puppet
Type.newtype(:test1) do
@doc = "Docs for resource"
newproperty(:message) do
desc "Docs for 'message' property"
end
newparam(:name) do
desc "Docs for 'name' parameter"
isnamevar
end
end; end
EOF
} }
},
},
'm2' => {
'lib' => { 'puppet' => { 'type' => {
'test2.rb' => <<-EOF
module Puppet
Type.newtype(:test2) do
@doc = "Docs for resource"
newproperty(:message) do
desc "Docs for 'message' property"
end
newparam(:name) do
desc "Docs for 'name' parameter"
isnamevar
end
end;end
EOF
} } },
}
}}})
end
let(:modulepath) do
File.join(dir, 'testing_generate', 'modules')
end
let(:m1) do
File.join(modulepath, 'm1')
end
let(:m2) do
File.join(modulepath, 'm2')
end
let(:outputdir) do
File.join(dir, 'testing_generate', '.resource_types')
end
around(:each) do |example|
Puppet.settings.initialize_global_settings
Puppet[:manifest] = ''
loader = Puppet::Environments::Directories.new(dir, [])
Puppet.override(:environments => loader) do
Puppet.override(:current_environment => loader.get('testing_generate')) do
example.run
end
end
end
it 'error if format is given as something other than pcore' do
expect {
genface.types(:format => 'json')
}.to raise_exception(ArgumentError, /'json' is not a supported format for type generation/)
end
it 'accepts --format pcore as a format' do
expect {
genface.types(:format => 'pcore')
}.not_to raise_error
end
it 'sets pcore as the default format' do
expect(Puppet::Generate::Type).to receive(:find_inputs).with(:pcore).and_return([])
genface.types()
end
it 'finds all files to generate types for' do
# using expects and returning what the side effect should have been
# (There is no way to call the original when mocking expected parameters).
input1 = Puppet::Generate::Type::Input.new(m1, File.join(m1, 'lib', 'puppet', 'type', 'test1.rb'), :pcore)
input2 = Puppet::Generate::Type::Input.new(m1, File.join(m2, 'lib', 'puppet', 'type', 'test2.rb'), :pcore)
expect(Puppet::Generate::Type::Input).to receive(:new).with(m1, File.join(m1, 'lib', 'puppet', 'type', 'test1.rb'), :pcore).and_return(input1)
expect(Puppet::Generate::Type::Input).to receive(:new).with(m2, File.join(m2, 'lib', 'puppet', 'type', 'test2.rb'), :pcore).and_return(input2)
genface.types
end
it 'creates output directory <env>/.resource_types/ if it does not exist' do
expect(Puppet::FileSystem.exist?(outputdir)).to be(false)
genface.types
expect(Puppet::FileSystem.dir_exist?(outputdir)).to be(true)
end
it 'creates output with matching names for each input' do
expect(Puppet::FileSystem.exist?(outputdir)).to be(false)
genface.types
children = Puppet::FileSystem.children(outputdir).map {|p| Puppet::FileSystem.basename_string(p) }
expect(children.sort).to eql(['test1.pp', 'test2.pp'])
end
it 'tolerates that <env>/.resource_types/ directory exists' do
Puppet::FileSystem.mkpath(outputdir)
expect(Puppet::FileSystem.exist?(outputdir)).to be(true)
genface.types
expect(Puppet::FileSystem.dir_exist?(outputdir)).to be(true)
end
it 'errors if <env>/.resource_types exists and is not a directory' do
expect(Puppet::FileSystem.exist?(outputdir)).to be(false) # assert it is not already there
Puppet::FileSystem.touch(outputdir)
expect(Puppet::FileSystem.exist?(outputdir)).to be(true)
expect(Puppet::FileSystem.directory?(outputdir)).to be(false)
expect {
genface.types
}.to raise_error(ArgumentError, /The output directory '#{outputdir}' exists and is not a directory/)
end
it 'does not overwrite if files exists and are up to date' do
# create them (first run)
genface.types
stats_before = [Puppet::FileSystem.stat(File.join(outputdir, 'test1.pp')), Puppet::FileSystem.stat(File.join(outputdir, 'test2.pp'))]
# generate again
genface.types
stats_after = [Puppet::FileSystem.stat(File.join(outputdir, 'test1.pp')), Puppet::FileSystem.stat(File.join(outputdir, 'test2.pp'))]
expect(stats_before <=> stats_after).to be(0)
end
it 'overwrites if files exists that are not up to date while keeping up to date files' do
# create them (first run)
genface.types
stats_before = [Puppet::FileSystem.stat(File.join(outputdir, 'test1.pp')), Puppet::FileSystem.stat(File.join(outputdir, 'test2.pp'))]
# fake change in input test1 - sorry about the sleep (which there was a better way to change the modtime
sleep(1)
Puppet::FileSystem.touch(File.join(m1, 'lib', 'puppet', 'type', 'test1.rb'))
# generate again
genface.types
# assert that test1 was overwritten (later) but not test2 (same time)
stats_after = [Puppet::FileSystem.stat(File.join(outputdir, 'test1.pp')), Puppet::FileSystem.stat(File.join(outputdir, 'test2.pp'))]
expect(stats_before[1] <=> stats_after[1]).to be(0)
expect(stats_before[0] <=> stats_after[0]).to be(-1)
end
it 'overwrites all files when called with --force' do
# create them (first run)
genface.types
stats_before = [Puppet::FileSystem.stat(File.join(outputdir, 'test1.pp')), Puppet::FileSystem.stat(File.join(outputdir, 'test2.pp'))]
# generate again
sleep(1) # sorry, if there is no delay the stats will be the same
genface.types(:force => true)
stats_after = [Puppet::FileSystem.stat(File.join(outputdir, 'test1.pp')), Puppet::FileSystem.stat(File.join(outputdir, 'test2.pp'))]
expect(stats_before <=> stats_after).to be(-1)
end
it 'removes previously generated files from output when there is no input for it' do
# create them (first run)
genface.types
stat_before = Puppet::FileSystem.stat(File.join(outputdir, 'test2.pp'))
# remove input
Puppet::FileSystem.unlink(File.join(m1, 'lib', 'puppet', 'type', 'test1.rb'))
# generate again
genface.types
# assert that test1 was deleted but not test2 (same time)
expect(Puppet::FileSystem.exist?(File.join(outputdir, 'test1.pp'))).to be(false)
stats_after = Puppet::FileSystem.stat(File.join(outputdir, 'test2.pp'))
expect(stat_before <=> stats_after).to be(0)
end
end
context "in an environment with a faulty type" do
let(:dir) do
dir_containing('environments', { 'testing_generate2' => {
'environment.conf' => "modulepath = modules",
'manifests' => { 'site.pp' => "" },
'modules' => {
'm3' => {
'lib' => { 'puppet' => { 'type' => {
'test3.rb' => <<-EOF
module Puppet
Type.newtype(:test3) do
@doc = "Docs for resource"
def self.title_patterns
identity = lambda {|x| x}
[
[
/^(.*)_(.*)$/,
[
[:name, identity ]
]
]
]
end
newproperty(:message) do
desc "Docs for 'message' property"
end
newparam(:name) do
desc "Docs for 'name' parameter"
isnamevar
end
end; end
EOF
} }
}
}
}}})
end
let(:modulepath) do
File.join(dir, 'testing_generate2', 'modules')
end
let(:m3) do
File.join(modulepath, 'm3')
end
around(:each) do |example|
Puppet.settings.initialize_global_settings
Puppet[:manifest] = ''
loader = Puppet::Environments::Directories.new(dir, [])
Puppet.override(:environments => loader) do
Puppet.override(:current_environment => loader.get('testing_generate2')) do
example.run
end
end
end
it 'fails when using procs for title patterns' do
expect {
genface.types(:format => 'pcore')
}.to exit_with(1)
end
end
end
def from_an_interactive_terminal
allow(STDIN).to receive(:tty?).and_return(true)
end
end
|