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 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
|
#! /usr/bin/env ruby
require 'spec_helper'
require 'puppet_spec/files'
require 'puppet_spec/modules'
require 'puppet/module_tool/checksums'
describe Puppet::Module do
include PuppetSpec::Files
let(:env) { mock("environment") }
let(:path) { "/path" }
let(:name) { "mymod" }
let(:mod) { Puppet::Module.new(name, path, env) }
before do
# This is necessary because of the extra checks we have for the deprecated
# 'plugins' directory
Puppet::FileSystem.stubs(:exist?).returns false
end
it "should have a class method that returns a named module from a given environment" do
env = Puppet::Node::Environment.create(:myenv, [])
env.expects(:module).with(name).returns "yep"
Puppet.override(:environments => Puppet::Environments::Static.new(env)) do
expect(Puppet::Module.find(name, "myenv")).to eq("yep")
end
end
it "should return nil if asked for a named module that doesn't exist" do
env = Puppet::Node::Environment.create(:myenv, [])
env.expects(:module).with(name).returns nil
Puppet.override(:environments => Puppet::Environments::Static.new(env)) do
expect(Puppet::Module.find(name, "myenv")).to be_nil
end
end
describe "is_module_directory?" do
let(:first_modulepath) { tmpdir('firstmodules') }
let(:not_a_module) { tmpfile('thereisnomodule', first_modulepath) }
it "should return false for a non-directory" do
expect(Puppet::Module.is_module_directory?('thereisnomodule', first_modulepath)).to be_falsey
end
it "should return true for a well named directories" do
PuppetSpec::Modules.generate_files('foo', first_modulepath)
PuppetSpec::Modules.generate_files('foo2', first_modulepath)
PuppetSpec::Modules.generate_files('foo_bar', first_modulepath)
expect(Puppet::Module.is_module_directory?('foo', first_modulepath)).to be_truthy
expect(Puppet::Module.is_module_directory?('foo2', first_modulepath)).to be_truthy
expect(Puppet::Module.is_module_directory?('foo_bar', first_modulepath)).to be_truthy
end
it "should return false for badly named directories" do
PuppetSpec::Modules.generate_files('foo=bar', first_modulepath)
PuppetSpec::Modules.generate_files('.foo', first_modulepath)
expect(Puppet::Module.is_module_directory?('foo=bar', first_modulepath)).to be_falsey
expect(Puppet::Module.is_module_directory?('.foo', first_modulepath)).to be_falsey
end
end
describe "is_module_directory_name?" do
it "should return true for a valid directory module name" do
expect(Puppet::Module.is_module_directory_name?('foo')).to be_truthy
expect(Puppet::Module.is_module_directory_name?('foo2')).to be_truthy
expect(Puppet::Module.is_module_directory_name?('foo_bar')).to be_truthy
end
it "should return false for badly formed directory module names" do
expect(Puppet::Module.is_module_directory_name?('foo-bar')).to be_falsey
expect(Puppet::Module.is_module_directory_name?('foo=bar')).to be_falsey
expect(Puppet::Module.is_module_directory_name?('foo bar')).to be_falsey
expect(Puppet::Module.is_module_directory_name?('foo.bar')).to be_falsey
expect(Puppet::Module.is_module_directory_name?('-foo')).to be_falsey
expect(Puppet::Module.is_module_directory_name?('foo-')).to be_falsey
expect(Puppet::Module.is_module_directory_name?('foo--bar')).to be_falsey
expect(Puppet::Module.is_module_directory_name?('.foo')).to be_falsey
end
end
describe "is_module_namespaced_name?" do
it "should return true for a valid namespaced module name" do
expect(Puppet::Module.is_module_namespaced_name?('foo-bar')).to be_truthy
end
it "should return false for badly formed namespaced module names" do
expect(Puppet::Module.is_module_namespaced_name?('foo')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('.foo-bar')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('foo2')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('foo_bar')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('foo=bar')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('foo bar')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('foo.bar')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('-foo')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('foo-')).to be_falsey
expect(Puppet::Module.is_module_namespaced_name?('foo--bar')).to be_falsey
end
end
describe "attributes" do
it "should support a 'version' attribute" do
mod.version = 1.09
expect(mod.version).to eq(1.09)
end
it "should support a 'source' attribute" do
mod.source = "http://foo/bar"
expect(mod.source).to eq("http://foo/bar")
end
it "should support a 'project_page' attribute" do
mod.project_page = "http://foo/bar"
expect(mod.project_page).to eq("http://foo/bar")
end
it "should support an 'author' attribute" do
mod.author = "Luke Kanies <luke@madstop.com>"
expect(mod.author).to eq("Luke Kanies <luke@madstop.com>")
end
it "should support a 'license' attribute" do
mod.license = "GPL2"
expect(mod.license).to eq("GPL2")
end
it "should support a 'summary' attribute" do
mod.summary = "GPL2"
expect(mod.summary).to eq("GPL2")
end
it "should support a 'description' attribute" do
mod.description = "GPL2"
expect(mod.description).to eq("GPL2")
end
end
describe "when finding unmet dependencies" do
before do
Puppet::FileSystem.unstub(:exist?)
@modpath = tmpdir('modpath')
Puppet.settings[:modulepath] = @modpath
end
it "should resolve module dependencies using forge names" do
parent = PuppetSpec::Modules.create(
'parent',
@modpath,
:metadata => {
:author => 'foo',
:dependencies => [{
"name" => "foo/child"
}]
},
:environment => env
)
child = PuppetSpec::Modules.create(
'child',
@modpath,
:metadata => {
:author => 'foo',
:dependencies => []
},
:environment => env
)
env.expects(:module_by_forge_name).with('foo/child').returns(child)
expect(parent.unmet_dependencies).to eq([])
end
it "should list modules that are missing" do
metadata_file = "#{@modpath}/needy/metadata.json"
Puppet::FileSystem.expects(:exist?).with(metadata_file).returns true
mod = PuppetSpec::Modules.create(
'needy',
@modpath,
:metadata => {
:dependencies => [{
"version_requirement" => ">= 2.2.0",
"name" => "baz/foobar"
}]
},
:environment => env
)
env.expects(:module_by_forge_name).with('baz/foobar').returns(nil)
expect(mod.unmet_dependencies).to eq([{
:reason => :missing,
:name => "baz/foobar",
:version_constraint => ">= 2.2.0",
:parent => { :name => 'puppetlabs/needy', :version => 'v9.9.9' },
:mod_details => { :installed_version => nil }
}])
end
it "should list modules that are missing and have invalid names" do
metadata_file = "#{@modpath}/needy/metadata.json"
Puppet::FileSystem.expects(:exist?).with(metadata_file).returns true
mod = PuppetSpec::Modules.create(
'needy',
@modpath,
:metadata => {
:dependencies => [{
"version_requirement" => ">= 2.2.0",
"name" => "baz/foobar=bar"
}]
},
:environment => env
)
env.expects(:module_by_forge_name).with('baz/foobar=bar').returns(nil)
expect(mod.unmet_dependencies).to eq([{
:reason => :missing,
:name => "baz/foobar=bar",
:version_constraint => ">= 2.2.0",
:parent => { :name => 'puppetlabs/needy', :version => 'v9.9.9' },
:mod_details => { :installed_version => nil }
}])
end
it "should list modules with unmet version requirement" do
env = Puppet::Node::Environment.create(:testing, [@modpath])
['test_gte_req', 'test_specific_req', 'foobar'].each do |mod_name|
metadata_file = "#{@modpath}/#{mod_name}/metadata.json"
Puppet::FileSystem.stubs(:exist?).with(metadata_file).returns true
end
mod = PuppetSpec::Modules.create(
'test_gte_req',
@modpath,
:metadata => {
:dependencies => [{
"version_requirement" => ">= 2.2.0",
"name" => "baz/foobar"
}]
},
:environment => env
)
mod2 = PuppetSpec::Modules.create(
'test_specific_req',
@modpath,
:metadata => {
:dependencies => [{
"version_requirement" => "1.0.0",
"name" => "baz/foobar"
}]
},
:environment => env
)
PuppetSpec::Modules.create(
'foobar',
@modpath,
:metadata => { :version => '2.0.0', :author => 'baz' },
:environment => env
)
expect(mod.unmet_dependencies).to eq([{
:reason => :version_mismatch,
:name => "baz/foobar",
:version_constraint => ">= 2.2.0",
:parent => { :version => "v9.9.9", :name => "puppetlabs/test_gte_req" },
:mod_details => { :installed_version => "2.0.0" }
}])
expect(mod2.unmet_dependencies).to eq([{
:reason => :version_mismatch,
:name => "baz/foobar",
:version_constraint => "v1.0.0",
:parent => { :version => "v9.9.9", :name => "puppetlabs/test_specific_req" },
:mod_details => { :installed_version => "2.0.0" }
}])
end
it "should consider a dependency without a version requirement to be satisfied" do
env = Puppet::Node::Environment.create(:testing, [@modpath])
mod = PuppetSpec::Modules.create(
'foobar',
@modpath,
:metadata => {
:dependencies => [{
"name" => "baz/foobar"
}]
},
:environment => env
)
PuppetSpec::Modules.create(
'foobar',
@modpath,
:metadata => {
:version => '2.0.0',
:author => 'baz'
},
:environment => env
)
expect(mod.unmet_dependencies).to be_empty
end
it "should consider a dependency without a semantic version to be unmet" do
env = Puppet::Node::Environment.create(:testing, [@modpath])
metadata_file = "#{@modpath}/foobar/metadata.json"
Puppet::FileSystem.expects(:exist?).with(metadata_file).times(3).returns true
mod = PuppetSpec::Modules.create(
'foobar',
@modpath,
:metadata => {
:dependencies => [{
"name" => "baz/foobar"
}]
},
:environment => env
)
PuppetSpec::Modules.create(
'foobar',
@modpath,
:metadata => {
:version => '5.1',
:author => 'baz'
},
:environment => env
)
expect(mod.unmet_dependencies).to eq([{
:reason => :non_semantic_version,
:parent => { :version => "v9.9.9", :name => "puppetlabs/foobar" },
:mod_details => { :installed_version => "5.1" },
:name => "baz/foobar",
:version_constraint => ">= 0.0.0"
}])
end
it "should have valid dependencies when no dependencies have been specified" do
mod = PuppetSpec::Modules.create(
'foobar',
@modpath,
:metadata => {
:dependencies => []
}
)
expect(mod.unmet_dependencies).to eq([])
end
it "should throw an error if invalid dependencies are specified" do
expect {
PuppetSpec::Modules.create(
'foobar',
@modpath,
:metadata => {
:dependencies => ""
}
)
}.to raise_error(
Puppet::Module::MissingMetadata,
/dependencies in the file metadata.json of the module foobar must be an array, not: ''/)
end
it "should only list unmet dependencies" do
env = Puppet::Node::Environment.create(:testing, [@modpath])
[name, 'satisfied'].each do |mod_name|
metadata_file = "#{@modpath}/#{mod_name}/metadata.json"
Puppet::FileSystem.expects(:exist?).with(metadata_file).twice.returns true
end
mod = PuppetSpec::Modules.create(
name,
@modpath,
:metadata => {
:dependencies => [
{
"version_requirement" => ">= 2.2.0",
"name" => "baz/satisfied"
},
{
"version_requirement" => ">= 2.2.0",
"name" => "baz/notsatisfied"
}
]
},
:environment => env
)
PuppetSpec::Modules.create(
'satisfied',
@modpath,
:metadata => {
:version => '3.3.0',
:author => 'baz'
},
:environment => env
)
expect(mod.unmet_dependencies).to eq([{
:reason => :missing,
:mod_details => { :installed_version => nil },
:parent => { :version => "v9.9.9", :name => "puppetlabs/#{name}" },
:name => "baz/notsatisfied",
:version_constraint => ">= 2.2.0"
}])
end
it "should be empty when all dependencies are met" do
env = Puppet::Node::Environment.create(:testing, [@modpath])
mod = PuppetSpec::Modules.create(
'mymod2',
@modpath,
:metadata => {
:dependencies => [
{
"version_requirement" => ">= 2.2.0",
"name" => "baz/satisfied"
},
{
"version_requirement" => "< 2.2.0",
"name" => "baz/alsosatisfied"
}
]
},
:environment => env
)
PuppetSpec::Modules.create(
'satisfied',
@modpath,
:metadata => {
:version => '3.3.0',
:author => 'baz'
},
:environment => env
)
PuppetSpec::Modules.create(
'alsosatisfied',
@modpath,
:metadata => {
:version => '2.1.0',
:author => 'baz'
},
:environment => env
)
expect(mod.unmet_dependencies).to be_empty
end
end
describe "when managing supported platforms" do
it "should support specifying a supported platform" do
mod.supports "solaris"
end
it "should support specifying a supported platform and version" do
mod.supports "solaris", 1.0
end
end
it "should return nil if asked for a module whose name is 'nil'" do
expect(Puppet::Module.find(nil, "myenv")).to be_nil
end
it "should provide support for logging" do
expect(Puppet::Module.ancestors).to be_include(Puppet::Util::Logging)
end
it "should be able to be converted to a string" do
expect(mod.to_s).to eq("Module #{name}(#{path})")
end
it "should fail if its name is not alphanumeric" do
expect { Puppet::Module.new(".something", "/path", env) }.to raise_error(Puppet::Module::InvalidName)
end
it "should require a name at initialization" do
expect { Puppet::Module.new }.to raise_error(ArgumentError)
end
it "should accept an environment at initialization" do
expect(Puppet::Module.new("foo", "/path", env).environment).to eq(env)
end
describe '#modulepath' do
it "should return the directory the module is installed in, if a path exists" do
mod = Puppet::Module.new("foo", "/a/foo", env)
expect(mod.modulepath).to eq('/a')
end
end
[:plugins, :pluginfacts, :templates, :files, :manifests].each do |filetype|
case filetype
when :plugins
dirname = "lib"
when :pluginfacts
dirname = "facts.d"
else
dirname = filetype.to_s
end
it "should be able to return individual #{filetype}" do
module_file = File.join(path, dirname, "my/file")
Puppet::FileSystem.expects(:exist?).with(module_file).returns true
expect(mod.send(filetype.to_s.sub(/s$/, ''), "my/file")).to eq(module_file)
end
it "should consider #{filetype} to be present if their base directory exists" do
module_file = File.join(path, dirname)
Puppet::FileSystem.expects(:exist?).with(module_file).returns true
expect(mod.send(filetype.to_s + "?")).to be_truthy
end
it "should consider #{filetype} to be absent if their base directory does not exist" do
module_file = File.join(path, dirname)
Puppet::FileSystem.expects(:exist?).with(module_file).returns false
expect(mod.send(filetype.to_s + "?")).to be_falsey
end
it "should return nil if asked to return individual #{filetype} that don't exist" do
module_file = File.join(path, dirname, "my/file")
Puppet::FileSystem.expects(:exist?).with(module_file).returns false
expect(mod.send(filetype.to_s.sub(/s$/, ''), "my/file")).to be_nil
end
it "should return the base directory if asked for a nil path" do
base = File.join(path, dirname)
Puppet::FileSystem.expects(:exist?).with(base).returns true
expect(mod.send(filetype.to_s.sub(/s$/, ''), nil)).to eq(base)
end
end
it "should return the path to the plugin directory" do
expect(mod.plugin_directory).to eq(File.join(path, "lib"))
end
end
describe Puppet::Module, "when finding matching manifests" do
before do
@mod = Puppet::Module.new("mymod", "/a", mock("environment"))
@pq_glob_with_extension = "yay/*.xx"
@fq_glob_with_extension = "/a/manifests/#{@pq_glob_with_extension}"
end
it "should return all manifests matching the glob pattern" do
Dir.expects(:glob).with(@fq_glob_with_extension).returns(%w{foo bar})
FileTest.stubs(:directory?).returns false
expect(@mod.match_manifests(@pq_glob_with_extension)).to eq(%w{foo bar})
end
it "should not return directories" do
Dir.expects(:glob).with(@fq_glob_with_extension).returns(%w{foo bar})
FileTest.expects(:directory?).with("foo").returns false
FileTest.expects(:directory?).with("bar").returns true
expect(@mod.match_manifests(@pq_glob_with_extension)).to eq(%w{foo})
end
it "should default to the 'init' file if no glob pattern is specified" do
Puppet::FileSystem.expects(:exist?).with("/a/manifests/init.pp").returns(true)
expect(@mod.match_manifests(nil)).to eq(%w{/a/manifests/init.pp})
end
it "should return all manifests matching the glob pattern in all existing paths" do
Dir.expects(:glob).with(@fq_glob_with_extension).returns(%w{a b})
expect(@mod.match_manifests(@pq_glob_with_extension)).to eq(%w{a b})
end
it "should match the glob pattern plus '.pp' if no extension is specified" do
Dir.expects(:glob).with("/a/manifests/yay/foo.pp").returns(%w{yay})
expect(@mod.match_manifests("yay/foo")).to eq(%w{yay})
end
it "should return an empty array if no manifests matched" do
Dir.expects(:glob).with(@fq_glob_with_extension).returns([])
expect(@mod.match_manifests(@pq_glob_with_extension)).to eq([])
end
it "should raise an error if the pattern tries to leave the manifest directory" do
expect do
@mod.match_manifests("something/../../*")
end.to raise_error(Puppet::Module::InvalidFilePattern, 'The pattern "something/../../*" to find manifests in the module "mymod" is invalid and potentially unsafe.')
end
end
describe Puppet::Module do
include PuppetSpec::Files
before do
@modpath = tmpdir('modpath')
@module = PuppetSpec::Modules.create('mymod', @modpath)
end
it "should use 'License' in its current path as its metadata file" do
expect(@module.license_file).to eq("#{@modpath}/mymod/License")
end
it "should cache the license file" do
@module.expects(:path).once.returns nil
@module.license_file
@module.license_file
end
it "should use 'metadata.json' in its current path as its metadata file" do
expect(@module.metadata_file).to eq("#{@modpath}/mymod/metadata.json")
end
it "should have metadata if it has a metadata file and its data is not empty" do
Puppet::FileSystem.expects(:exist?).with(@module.metadata_file).returns true
File.stubs(:read).with(@module.metadata_file, {:encoding => 'utf-8'}).returns "{\"foo\" : \"bar\"}"
expect(@module).to be_has_metadata
end
it "should not have metadata if has a metadata file and its data is empty" do
Puppet::FileSystem.expects(:exist?).with(@module.metadata_file).returns true
File.stubs(:read).with(@module.metadata_file, {:encoding => 'utf-8'}).returns "This is some invalid json.\n"
expect(@module).not_to be_has_metadata
end
it "should know if it is missing a metadata file" do
Puppet::FileSystem.expects(:exist?).with(@module.metadata_file).returns false
expect(@module).not_to be_has_metadata
end
it "should be able to parse its metadata file" do
expect(@module).to respond_to(:load_metadata)
end
it "should parse its metadata file on initialization if it is present" do
Puppet::Module.any_instance.expects(:has_metadata?).returns true
Puppet::Module.any_instance.expects(:load_metadata)
Puppet::Module.new("yay", "/path", mock("env"))
end
it "should tolerate failure to parse" do
Puppet::FileSystem.expects(:exist?).with(@module.metadata_file).returns true
File.stubs(:read).with(@module.metadata_file, {:encoding => 'utf-8'}).returns(my_fixture('trailing-comma.json'))
expect(@module.has_metadata?).to be_falsey
end
describe 'when --strict is warning' do
before :each do
Puppet[:strict] = :warning
end
it "should warn about a failure to parse" do
Puppet::FileSystem.expects(:exist?).with(@module.metadata_file).returns true
File.stubs(:read).with(@module.metadata_file, {:encoding => 'utf-8'}).returns(my_fixture('trailing-comma.json'))
expect(@module.has_metadata?).to be_falsey
expect(@logs).to have_matching_log(/mymod has an invalid and unparsable metadata\.json file/)
end
end
describe 'when --strict is off' do
before :each do
Puppet[:strict] = :off
end
it "should warn about a failure to parse" do
Puppet::FileSystem.expects(:exist?).with(@module.metadata_file).returns true
File.stubs(:read).with(@module.metadata_file, {:encoding => 'utf-8'}).returns(my_fixture('trailing-comma.json'))
expect(@module.has_metadata?).to be_falsey
expect(@logs).to have_matching_log(/mymod has an invalid and unparsable metadata\.json file.*/)
end
end
describe 'when --strict is error' do
before :each do
Puppet[:strict] = :error
end
it "should fail on a failure to parse" do
Puppet::FileSystem.expects(:exist?).with(@module.metadata_file).returns true
File.stubs(:read).with(@module.metadata_file, {:encoding => 'utf-8'}).returns(my_fixture('trailing-comma.json'))
expect do
expect(@module.has_metadata?).to be_falsey
end.to raise_error(/mymod has an invalid and unparsable metadata\.json file/)
end
end
def a_module_with_metadata(data)
text = data.to_pson
mod = Puppet::Module.new("foo", "/path", mock("env"))
mod.stubs(:metadata_file).returns "/my/file"
File.stubs(:read).with("/my/file", {:encoding => 'utf-8'}).returns text
mod
end
describe "when loading the metadata file" do
before do
@data = {
:license => "GPL2",
:author => "luke",
:version => "1.0",
:source => "http://foo/",
:dependencies => []
}
@module = a_module_with_metadata(@data)
end
%w{source author version license}.each do |attr|
it "should set #{attr} if present in the metadata file" do
@module.load_metadata
expect(@module.send(attr)).to eq(@data[attr.to_sym])
end
it "should fail if #{attr} is not present in the metadata file" do
@data.delete(attr.to_sym)
@text = @data.to_pson
File.stubs(:read).with("/my/file", {:encoding => 'utf-8'}).returns @text
expect { @module.load_metadata }.to raise_error(
Puppet::Module::MissingMetadata,
"No #{attr} module metadata provided for foo"
)
end
end
end
describe "when loading the metadata file from disk" do
it "should properly parse utf-8 contents" do
rune_utf8 = "\u16A0\u16C7\u16BB" # ᚠᛇᚻ
metadata_json = tmpfile('metadata.json')
File.open(metadata_json, 'w') do |file|
file.puts <<-EOF
{
"license" : "GPL2",
"author" : "#{rune_utf8}",
"version" : "1.0",
"source" : "http://foo/",
"dependencies" : []
}
EOF
end
mod = Puppet::Module.new('foo', '/path', mock('env'))
mod.stubs(:metadata_file).returns metadata_json
mod.load_metadata
expect(mod.author).to eq(rune_utf8)
end
end
it "should be able to tell if there are local changes" do
modpath = tmpdir('modpath')
foo_checksum = 'acbd18db4cc2f85cedef654fccc4a4d8'
checksummed_module = PuppetSpec::Modules.create(
'changed',
modpath,
:metadata => {
:checksums => {
"foo" => foo_checksum,
}
}
)
foo_path = Pathname.new(File.join(checksummed_module.path, 'foo'))
IO.binwrite(foo_path, 'notfoo')
expect(Puppet::ModuleTool::Checksums.new(foo_path).checksum(foo_path)).not_to eq(foo_checksum)
IO.binwrite(foo_path, 'foo')
expect(Puppet::ModuleTool::Checksums.new(foo_path).checksum(foo_path)).to eq(foo_checksum)
end
it "should know what other modules require it" do
env = Puppet::Node::Environment.create(:testing, [@modpath])
dependable = PuppetSpec::Modules.create(
'dependable',
@modpath,
:metadata => {:author => 'puppetlabs'},
:environment => env
)
PuppetSpec::Modules.create(
'needy',
@modpath,
:metadata => {
:author => 'beggar',
:dependencies => [{
"version_requirement" => ">= 2.2.0",
"name" => "puppetlabs/dependable"
}]
},
:environment => env
)
PuppetSpec::Modules.create(
'wantit',
@modpath,
:metadata => {
:author => 'spoiled',
:dependencies => [{
"version_requirement" => "< 5.0.0",
"name" => "puppetlabs/dependable"
}]
},
:environment => env
)
expect(dependable.required_by).to match_array([
{
"name" => "beggar/needy",
"version" => "9.9.9",
"version_requirement" => ">= 2.2.0"
},
{
"name" => "spoiled/wantit",
"version" => "9.9.9",
"version_requirement" => "< 5.0.0"
}
])
end
end
|