-
Notifications
You must be signed in to change notification settings - Fork 66
/
foss_utils.rb
1629 lines (1454 loc) · 77.5 KB
/
foss_utils.rb
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
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
require "beaker-puppet/install_utils/windows_utils"
[ 'aio', 'foss' ].each do |lib|
require "beaker-puppet/install_utils/#{lib}_defaults"
end
require "beaker-puppet/install_utils/puppet_utils"
module Beaker
module DSL
module InstallUtils
#
# This module contains methods to install FOSS puppet from various sources
#
# To mix this is into a class you need the following:
# * a method *hosts* that yields any hosts implementing
# {Beaker::Host}'s interface to act upon.
# * a method *options* that provides an options hash, see {Beaker::Options::OptionsHash}
# * the module {Beaker::DSL::Roles} that provides access to the various hosts implementing
# {Beaker::Host}'s interface to act upon
# * the module {Beaker::DSL::Wrappers} the provides convenience methods for {Beaker::DSL::Command} creation
module FOSSUtils
include AIODefaults
include FOSSDefaults
include PuppetUtils
include WindowsUtils
# The default install path
SourcePath = "/opt/puppet-git-repos"
# A regex to know if the uri passed is pointing to a git repo
GitURI = %r{^(git|https?|file)://|^git@|^gitmirror@}
# Github's ssh signature for cloning via ssh
GitHubSig = 'github.com,207.97.227.239 ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=='
# Merge given options with our default options in a consistent way
# This will remove any nil values so that we always have a set default.
#
# @param [Hash] the original options to be merged with the default options
#
# @return [Hash] The finalized set of options
def sanitize_opts(opts)
# If any of the nightly urls are not set, but the main `:nightly_builds_url`
# is set, we should overwrite anything not set.
opts[:nightly_apt_repo_url] ||= opts[:nightly_builds_url]
opts[:nightly_yum_repo_url] ||= opts[:nightly_builds_url]
opts[:nightly_win_download_url] ||= opts[:nightly_builds_url]
opts[:nightly_mac_download_url] ||= opts[:nightly_builds_url]
FOSS_DEFAULT_DOWNLOAD_URLS.merge(opts.reject{|k,v| v.nil?})
end
# lookup project-specific git environment variables
# PROJECT_VAR or VAR otherwise return the default
#
# @!visibility private
def lookup_in_env(env_variable_name, project_name=nil, default=nil)
env_variable_name = "#{env_variable_name.upcase.gsub('-','_')}"
project_specific_name = "#{project_name.upcase.gsub('-','_')}_#{env_variable_name}" if project_name
project_name && ENV[project_specific_name] || ENV[env_variable_name] || default
end
# @return [Boolean] Whether Puppet's internal builds are accessible from all the SUTs
def dev_builds_accessible?(url = FOSS_DEFAULT_DOWNLOAD_URLS[:dev_builds_url])
block_on hosts do |host|
return false unless dev_builds_accessible_on?(host, url)
end
true
end
# @param [Host] A beaker host
# @return [Boolean] Whether Puppet's internal builds are accessible from the host /
# true for puppet amazon platfroms
def dev_builds_accessible_on?(host, url = FOSS_DEFAULT_DOWNLOAD_URLS[:dev_builds_url])
return true if host.host_hash[:template] =~ /^amazon-*/ && host.hostname =~ /.puppet.net$/
# redhat-8-arm64 is provided from amazon
return true if host.host_hash[:template] == 'redhat-8-arm64' && host.hostname =~ /.puppet.net$/
result = on(host, %(curl -fI "#{url}"), accept_all_exit_codes: true)
return result.exit_code.zero?
end
# @param [String] project_name
# @param [String] git_fork When not provided will use PROJECT_FORK environment variable
# @param [String] git_server When not provided will use PROJECT_SERVER environment variable
# @param [String] git_protocol 'git','ssh','https'
#
# @return [String] Returns a git-usable url
#
# TODO: enable other protocols, clarify, http://git-scm.com/book/ch4-1.html
def build_git_url(project_name, git_fork = nil, git_server = nil, git_protocol='https')
git_fork ||= lookup_in_env('FORK', project_name, 'puppetlabs')
git_server ||= lookup_in_env('SERVER', project_name, 'github.com')
case git_protocol
when /(ssh|git)/
git_protocol = 'git@'
when /https/
git_protocol = 'https://'
end
repo = (git_server == 'github.com') ? "#{git_fork}/#{project_name}.git" : "#{git_fork}-#{project_name}.git"
return git_protocol == 'git@' ? "#{git_protocol}#{git_server}:#{repo}" : "#{git_protocol}#{git_server}/#{repo}"
end
alias_method :build_giturl, :build_git_url
# @param [String] uri A uri in the format of <git uri>#<revision>
# the `git://`, `http://`, `https://`, and ssh
# (if cloning as the remote git user) protocols
# are valid for <git uri>
#
# @example Usage
# project = extract_repo_info_from 'git@github.com:puppetlabs/SuperSecretSauce#what_is_justin_doing'
#
# puts project[:name]
# #=> 'SuperSecretSauce'
#
# puts project[:rev]
# #=> 'what_is_justin_doing'
#
# @return [Hash{Symbol=>String}] Returns a hash containing the project
# name, repository path, and revision
# (defaults to HEAD)
#
def extract_repo_info_from uri
require 'pathname'
project = {}
repo, rev = uri.split('#', 2)
project[:name] = Pathname.new(repo).basename('.git').to_s
project[:path] = repo
project[:rev] = rev || 'HEAD'
return project
end
# Takes an array of package info hashes (like that returned from
# {#extract_repo_info_from}) and sorts the `puppet`, `facter`, `hiera`
# packages so that puppet's dependencies will be installed first.
#
# @!visibility private
def order_packages packages_array
puppet = packages_array.select {|e| e[:name] == 'puppet' }
puppet_depends_on = packages_array.select do |e|
e[:name] == 'hiera' or e[:name] == 'facter'
end
depends_on_puppet = (packages_array - puppet) - puppet_depends_on
[puppet_depends_on, puppet, depends_on_puppet].flatten
end
# @param [Host] host An object implementing {Beaker::Hosts}'s
# interface.
# @param [String] path The path on the remote [host] to the repository
# @param [Hash{Symbol=>String}] repository A hash representing repo
# info like that emitted by
# {#extract_repo_info_from}
#
# @example Getting multiple project versions
# versions = [puppet_repo, facter_repo, hiera_repo].inject({}) do |vers, repo_info|
# vers.merge(find_git_repo_versions(host, '/opt/git-puppet-repos', repo_info) )
# end
# @return [Hash] Executes git describe on [host] and returns a Hash
# with the key of [repository[:name]] and value of
# the output from git describe.
#
# @note This requires the helper methods:
# * {Beaker::DSL::Helpers#on}
#
def find_git_repo_versions host, path, repository
logger.notify("\n * Grab version for #{repository[:name]}")
version = {}
on host, "cd #{path}/#{repository[:name]} && " +
"git describe || true" do
version[repository[:name]] = stdout.chomp
end
version
end
# @param [Host] host An object implementing {Beaker::Hosts}'s
# interface.
# @param [String] path The path on the remote [host] to the repository
# @param [Hash{Symbol=>String}] repository A hash representing repo
# info like that emitted by
# {#extract_repo_info_from}
#
# @note This requires the helper methods:
# * {Beaker::DSL::Helpers#on}
#
def clone_git_repo_on host, path, repository, opts = {}
opts = {:accept_all_exit_codes => true}.merge(opts)
name = repository[:name]
repo = repository[:path]
rev = repository[:rev]
depth = repository[:depth]
depth_branch = repository[:depth_branch]
target = "#{path}/#{name}"
if (depth_branch.nil?)
depth_branch = rev
end
clone_cmd = "git clone #{repo} #{target}"
if (depth)
clone_cmd = "git clone --branch #{depth_branch} --depth #{depth} #{repo} #{target}"
end
logger.notify("\n * Clone #{repo} if needed")
on host, "test -d #{path} || mkdir -p #{path}", opts
on host, "test -d #{target} || #{clone_cmd}", opts
logger.notify("\n * Update #{name} and check out revision #{rev}")
commands = ["cd #{target}",
"remote rm origin",
"remote add origin #{repo}",
"fetch origin +refs/pull/*:refs/remotes/origin/pr/* +refs/heads/*:refs/remotes/origin/*",
"clean -fdx",
"checkout -f #{rev}"]
on host, commands.join(" && git "), opts
end
# @see #find_git_repo_versions
# @note This assumes the target repository application
# can be installed via an install.rb ruby script.
def install_from_git_on host, path, repository, opts = {}
opts = {:accept_all_exit_codes => true}.merge(opts)
clone_git_repo_on host, path, repository, opts
name = repository[:name]
logger.notify("\n * Install #{name} on the system")
# The solaris ruby IPS package has bindir set to /usr/ruby/1.8/bin.
# However, this is not the path to which we want to deliver our
# binaries. So if we are using solaris, we have to pass the bin and
# sbin directories to the install.rb
target = "#{path}/#{name}"
install_opts = ''
install_opts = '--bindir=/usr/bin --sbindir=/usr/sbin' if host['platform'].include? 'solaris'
on host, "cd #{target} && " +
"if [ -f install.rb ]; then " +
"ruby ./install.rb #{install_opts}; " +
"else true; fi", opts
end
alias_method :install_from_git, :install_from_git_on
# @deprecated Use {#install_puppet_on} instead.
def install_puppet(opts = {})
#send in the global hosts!
install_puppet_on(hosts, opts)
end
#Install FOSS based on specified hosts using provided options
# @example will install puppet 3.6.1 from native puppetlabs provided packages wherever possible and will fail over to gem installation when impossible
# install_puppet_on(hosts, {
# :version => '3.6.1',
# :facter_version => '2.0.1',
# :hiera_version => '1.3.3',
# :default_action => 'gem_install',
# })
#
# @example will install puppet 4 from native puppetlabs provided puppet-agent 1.x package wherever possible and will fail over to gem installation when impossible
# install_puppet({
# :version => '4',
# :default_action => 'gem_install'
# })
#
# @example will install puppet 4.1.0 from native puppetlabs provided puppet-agent 1.1.0 package wherever possible and will fail over to gem installation when impossible
# install_puppet({
# :version => '4.1.0',
# :puppet_agent_version => '1.1.0',
# :default_action => 'gem_install'
# })
#
#
#
# @example Will install latest packages on Enterprise Linux and Debian based distros and fail hard on all othere platforms.
# install_puppet_on(hosts)
#
# @note This will attempt to add a repository for apt.puppetlabs.com on
# Debian, Ubuntu, or Cumulus machines, or yum.puppetlabs.com on EL or Fedora
# machines, then install the package 'puppet' or 'puppet-agent'.
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts
# @option opts [String] :version Version of puppet to download
# @option opts [String] :puppet_agent_version Version of puppet agent to download
# @option opts [String] :mac_download_url Url to download msi pattern of %url%/puppet-%version%.msi
# @option opts [String] :win_download_url Url to download dmg pattern of %url%/(puppet|hiera|facter)-%version%.msi
# @option opts [Boolean] :run_in_parallel Whether to install on all hosts in parallel. Defaults to false.
#
# @return nil
# @raise [StandardError] When encountering an unsupported platform by default, or if gem cannot be found when default_action => 'gem_install'
# @raise [FailTest] When error occurs during the actual installation process
def install_puppet_on(hosts, opts = options)
opts = sanitize_opts(opts)
# If version isn't specified assume the latest in the 3.x series
if opts[:version] and not version_is_less(opts[:version], '4.0.0')
# backwards compatability
opts[:puppet_agent_version] ||= opts[:version]
install_puppet_agent_on(hosts, opts)
else
# Use option specified in the method call, otherwise check whether the global
# run_in_parallel option includes install
run_in_parallel = run_in_parallel? opts, @options, 'install'
block_on hosts, { :run_in_parallel => run_in_parallel } do |host|
if host['platform'] =~ /el-(5|6|7)/
relver = $1
install_puppet_from_rpm_on(host, opts.merge(:release => relver, :family => 'el'))
elsif host['platform'] =~ /fedora-(\d+)/
relver = $1
install_puppet_from_rpm_on(host, opts.merge(:release => relver, :family => 'fedora'))
elsif host['platform'] =~ /(ubuntu|debian|cumulus|huaweios)/
install_puppet_from_deb_on(host, opts)
elsif host['platform'] =~ /windows/
relver = opts[:version]
install_puppet_from_msi_on(host, opts)
elsif host['platform'] =~ /osx/
install_puppet_from_dmg_on(host, opts)
elsif host['platform'] =~ /openbsd/
install_puppet_from_openbsd_packages_on(host, opts)
elsif host['platform'] =~ /freebsd/
install_puppet_from_freebsd_ports_on(host, opts)
elsif host['platform'] =~ /archlinux/
install_puppet_from_pacman_on(host, opts)
else
if opts[:default_action] == 'gem_install'
opts[:version] ||= '~> 3.x'
install_puppet_from_gem_on(host, opts)
else
raise "install_puppet() called for unsupported platform '#{host['platform']}' on '#{host.name}'"
end
end
host[:version] = opts[:version]
# Certain install paths may not create the config dirs/files needed
host.mkdir_p host['puppetpath'] unless host[:type] =~ /aio/
if ((host['platform'] =~ /windows/) and not host.is_cygwin?)
# Do nothing
else
on host, "echo '' >> #{host.puppet['hiera_config']}"
end
end
end
nil
end
# Install Puppet Agent or Puppet as a gem based on specified hosts using provided options
# @example will install puppet-agent 1.1.0 from native puppetlabs provided packages wherever possible and will fail over to gem installing latest puppet
# install_puppet_agent_on(hosts, {
# :puppet_agent_version => '1.1.0',
# :default_action => 'gem_install',
# })
#
#
# @example Will install latest packages on Enterprise Linux, Debian based distros, Windows, OSX and fail hard on all othere platforms.
# install_puppet_agent_on(hosts)
#
# @note This will attempt to add a repository for apt.puppetlabs.com on
# Debian, Ubuntu, or Cumulus machines, or yum.puppetlabs.com on EL or Fedora
# machines, then install the package 'puppet-agent'.
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts
# @option opts [String] :puppet_agent_version Version of puppet to download
# @option opts [String] :puppet_gem_version Version of puppet to install via gem if no puppet-agent package is available
# @option opts [String] :mac_download_url Url to download msi pattern of %url%/puppet-agent-%version%.msi
# @option opts [String] :win_download_url Url to download dmg pattern of %url%/puppet-agent-%version%.msi
# @option opts [String] :puppet_collection Collection to install from. Defaults to 'pc1' (contains the latest
# puppet 4). Other valid options are 'puppet' (for the latest release), 'puppet5' (for the latest puppet 5),
# or 'puppet6' (for the latest puppet 6). Only works for platforms that rely on repos.
# @option opts [Boolean] :run_in_parallel Whether to run on each host in parallel.
#
# @return nil
# @raise [StandardError] When encountering an unsupported platform by default, or if gem cannot be found when default_action => 'gem_install'
# @raise [FailTest] When error occurs during the actual installation process
def install_puppet_agent_on(hosts, opts = {})
opts = sanitize_opts(opts)
opts[:puppet_agent_version] ||= opts[:version] #backwards compatability with old parameter name
opts[:puppet_collection] ||= puppet_collection_for(:puppet_agent, opts[:puppet_agent_version]) || 'pc1'
# the collection names are case sensitive
opts[:puppet_collection] = opts[:puppet_collection].downcase
run_in_parallel = run_in_parallel? opts, @options, 'install'
block_on hosts, { :run_in_parallel => run_in_parallel } do |host|
# AIO refers to FOSS agents that contain puppet 4+, that is, puppet-agent packages
# in the 1.x series, or the 5.x series, or later. Previous versions are not supported,
# so 'aio' is the only role that makes sense here.
add_role(host, 'aio')
package_name = nil
# If inside the Puppet VPN, install from development builds.
if opts[:puppet_agent_version] && opts[:puppet_agent_version] != 'latest' && dev_builds_accessible_on?(host, opts[:dev_builds_url])
install_puppet_agent_from_dev_builds_on(host, opts[:puppet_agent_version])
else
if opts[:puppet_agent_version] == 'latest'
opts[:puppet_collection] += '-nightly' unless opts[:puppet_collection].end_with? '-nightly'
# Since we have modified the collection, we don't want to pass `latest`
# in to `install_package` as the version. That'll fail. Instead, if
# we pass `nil`, `install_package` will just install the latest available
# package version from the enabled repo.
opts.delete(:puppet_agent_version)
opts.delete(:version)
end
case host['platform']
when /el-|redhat|fedora|sles|centos|cisco_/
package_name = 'puppet-agent'
package_name << "-#{opts[:puppet_agent_version]}" if opts[:puppet_agent_version]
when /debian|ubuntu|cumulus|huaweios/
package_name = 'puppet-agent'
package_name << "=#{opts[:puppet_agent_version]}-1#{host['platform'].codename}" if opts[:puppet_agent_version]
when /windows/
install_puppet_agent_from_msi_on(host, opts)
when /osx/
install_puppet_agent_from_dmg_on(host, opts)
when /archlinux/
install_puppet_from_pacman_on(host, opts)
else
if opts[:default_action] == 'gem_install'
opts[:version] = opts[:puppet_gem_version]
install_puppet_from_gem_on(host, opts)
on host, "echo '' >> #{host.puppet['hiera_config']}"
else
raise "install_puppet_agent_on() called for unsupported " +
"platform '#{host['platform']}' on '#{host.name}'"
end
end
if package_name
install_puppetlabs_release_repo( host, opts[:puppet_collection] , opts)
host.install_package( package_name )
end
end
end
end
# @deprecated Use {#configure_puppet_on} instead.
def configure_puppet(opts={})
hosts.each do |host|
configure_puppet_on(host,opts)
end
end
# Configure puppet.conf on the given host(s) based upon a provided hash
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts
# @option opts [Hash{String=>String}] :main configure the main section of puppet.conf
# @option opts [Hash{String=>String}] :agent configure the agent section of puppet.conf
# @option opts [Boolean] :run_in_parallel Whether to run on each host in parallel.
#
# @example will configure /etc/puppet.conf on the puppet master.
# config = {
# 'main' => {
# 'server' => 'testbox.test.local',
# 'certname' => 'testbox.test.local',
# 'logdir' => '/var/log/puppet',
# 'vardir' => '/var/lib/puppet',
# 'ssldir' => '/var/lib/puppet/ssl',
# 'rundir' => '/var/run/puppet'
# },
# 'agent' => {
# 'environment' => 'dev'
# }
# }
# configure_puppet_on(master, config)
#
# @return nil
def configure_puppet_on(hosts, opts = {})
puppet_conf_text = ''
opts.each do |section,options|
puppet_conf_text << "[#{section}]\n"
options.each do |option,value|
puppet_conf_text << "#{option}=#{value}\n"
end
puppet_conf_text << "\n"
end
logger.debug( "setting config '#{puppet_conf_text}' on hosts #{hosts}" )
block_on hosts, opts do |host|
puppet_conf_path = host.puppet['config']
create_remote_file(host, puppet_conf_path, puppet_conf_text)
end
end
# Installs Puppet and dependencies using rpm on provided host(s).
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :version The version of Puppet to install, if nil installs latest version
# @option opts [String] :facter_version The version of Facter to install, if nil installs latest version
# @option opts [String] :hiera_version The version of Hiera to install, if nil installs latest version
# @option opts [String] :release The major release of the OS
# @option opts [String] :family The OS family (one of 'el' or 'fedora')
#
# @return nil
# @api private
def install_puppet_from_rpm_on( hosts, opts )
block_on hosts do |host|
if opts[:puppet_collection] && opts[:puppet_collection].match(/puppet\d*/)
install_puppetlabs_release_repo(host,opts[:puppet_collection],opts)
elsif host[:type] == 'aio'
install_puppetlabs_release_repo(host,'pc1',opts)
else
install_puppetlabs_release_repo(host,nil,opts)
end
if opts[:facter_version]
host.install_package("facter-#{opts[:facter_version]}")
end
if opts[:hiera_version]
host.install_package("hiera-#{opts[:hiera_version]}")
end
puppet_pkg = opts[:version] ? "puppet-#{opts[:version]}" : 'puppet'
host.install_package("#{puppet_pkg}")
configure_type_defaults_on( host )
end
end
alias_method :install_puppet_from_rpm, :install_puppet_from_rpm_on
# Installs Puppet and dependencies from deb on provided host(s).
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :version The version of Puppet to install, if nil installs latest version
# @option opts [String] :facter_version The version of Facter to install, if nil installs latest version
# @option opts [String] :hiera_version The version of Hiera to install, if nil installs latest version
#
# @return nil
# @api private
def install_puppet_from_deb_on( hosts, opts )
block_on hosts do |host|
install_puppetlabs_release_repo(host)
if opts[:facter_version]
host.install_package("facter=#{opts[:facter_version]}-1puppetlabs1")
end
if opts[:hiera_version]
host.install_package("hiera=#{opts[:hiera_version]}-1puppetlabs1")
end
if opts[:version]
host.install_package("puppet-common=#{opts[:version]}-1puppetlabs1")
host.install_package("puppet=#{opts[:version]}-1puppetlabs1")
else
host.install_package('puppet')
end
configure_type_defaults_on( host )
end
end
alias_method :install_puppet_from_deb, :install_puppet_from_deb_on
# Installs Puppet and dependencies from msi on provided host(s).
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :version The version of Puppet to install
# @option opts [String] :puppet_agent_version The version of the
# puppet-agent package to install, required if version is 4.0.0 or greater
# @option opts [String] :win_download_url The url to download puppet from
#
# @note on windows, the +:ruby_arch+ host parameter can determine in addition
# to other settings whether the 32 or 64bit install is used
def install_puppet_from_msi_on( hosts, opts )
block_on hosts do |host|
version = opts[:version]
if version && !version_is_less(version, '4.0.0')
if opts[:puppet_agent_version].nil?
raise "You must specify the version of puppet agent you " +
"want to install if you want to install Puppet 4.0 " +
"or greater on Windows"
end
opts[:version] = opts[:puppet_agent_version]
install_puppet_agent_from_msi_on(host, opts)
else
compute_puppet_msi_name(host, opts)
install_a_puppet_msi_on(host, opts)
end
configure_type_defaults_on( host )
end
end
alias_method :install_puppet_from_msi, :install_puppet_from_msi_on
# @api private
def compute_puppet_msi_name(host, opts)
version = opts[:version]
install_32 = host['install_32'] || opts['install_32']
less_than_3_dot_7 = version && version_is_less(version, '3.7')
# If there's no version declared, install the latest in the 3.x series
if not version
if !host.is_x86_64? || install_32
host['dist'] = 'puppet-latest'
else
host['dist'] = 'puppet-x64-latest'
end
# Install Puppet 3.x with the x86 installer if:
# - we are on puppet < 3.7, or
# - we are less than puppet 4.0 and on an x86 host, or
# - we have install_32 set on host or globally
# Install Puppet 3.x with the x64 installer if:
# - we are otherwise trying to install Puppet 3.x on a x64 host
elsif less_than_3_dot_7 or not host.is_x86_64? or install_32
host['dist'] = "puppet-#{version}"
elsif host.is_x86_64?
host['dist'] = "puppet-#{version}-x64"
else
raise "I don't understand how to install Puppet version: #{version}"
end
end
# Installs Puppet Agent and dependencies from msi on provided host(s).
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :puppet_agent_version The version of Puppet Agent to install
# @option opts [String] :win_download_url The url to download puppet from
#
# @note on windows, the +:ruby_arch+ host parameter can determine in addition
# to other settings whether the 32 or 64bit install is used
def install_puppet_agent_from_msi_on(hosts, opts)
block_on hosts do |host|
add_role(host, 'aio') #we are installing agent, so we want aio role
is_config_32 = true == (host['ruby_arch'] == 'x86') || host['install_32'] || opts['install_32']
should_install_64bit = host.is_x86_64? && !is_config_32
arch = should_install_64bit ? 'x64' : 'x86'
# If we don't specify a version install the latest MSI for puppet-agent
if opts[:puppet_agent_version]
host['dist'] = "puppet-agent-#{opts[:puppet_agent_version]}-#{arch}"
else
host['dist'] = "puppet-agent-#{arch}-latest"
end
install_a_puppet_msi_on(host, opts)
end
end
# @api private
def msi_link_path(host, opts)
if opts[:puppet_collection] && opts[:puppet_collection].match(/puppet\d*/)
url = if opts[:puppet_collection].match(/-nightly$/)
opts[:nightly_win_download_url]
else
opts[:win_download_url]
end
link = "#{url}/#{opts[:puppet_collection]}/#{host['dist']}.msi"
else
link = "#{opts[:win_download_url]}/#{host['dist']}.msi"
end
if not link_exists?( link )
raise "Puppet MSI at #{link} does not exist!"
end
link
end
# @api private
def install_a_puppet_msi_on(hosts, opts)
block_on hosts do |host|
link = msi_link_path(host, opts)
msi_download_path = "#{host.system_temp_path}\\#{host['dist']}.msi"
if host.is_cygwin?
# NOTE: it is critical that -o be before -O on Windows
proxy = opts[:package_proxy] ? "-x #{opts[:package_proxy]} " : ''
on host, "curl #{proxy}-o \"#{msi_download_path}\" -O #{link}"
#Because the msi installer doesn't add Puppet to the environment path
#Add both potential paths for simplicity
#NOTE - this is unnecessary if the host has been correctly identified as 'foss' during set up
puppetbin_path = "\"/cygdrive/c/Program Files (x86)/Puppet Labs/Puppet/bin\":\"/cygdrive/c/Program Files/Puppet Labs/Puppet/bin\""
on host, %Q{ echo 'export PATH=$PATH:#{puppetbin_path}' > /etc/bash.bashrc }
else
webclient_proxy = opts[:package_proxy] ? "$webclient.Proxy = New-Object System.Net.WebProxy('#{opts[:package_proxy]}',$true); " : ''
on host, powershell("$webclient = New-Object System.Net.WebClient; #{webclient_proxy}$webclient.DownloadFile('#{link}','#{msi_download_path}')")
end
opts = { :debug => host[:pe_debug] || opts[:pe_debug] }
install_msi_on(host, msi_download_path, {}, opts)
configure_type_defaults_on( host )
host.mkdir_p host['distmoduledir'] unless host.is_cygwin?
end
end
# Installs Puppet and dependencies from FreeBSD ports
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :version The version of Puppet to install (shows warning)
#
# @return nil
# @api private
def install_puppet_from_freebsd_ports_on( hosts, opts )
if (opts[:version])
logger.warn "If you wish to choose a specific Puppet version, use `install_puppet_from_gem_on('~> 3.*')`"
end
block_on hosts do |host|
if host['platform'] =~ /freebsd-9/
host.install_package("puppet")
else
host.install_package("sysutils/puppet")
end
end
end
alias_method :install_puppet_from_freebsd_ports, :install_puppet_from_freebsd_ports_on
# Installs Puppet and dependencies from dmg on provided host(s).
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :version The version of Puppet to install
# @option opts [String] :puppet_version The version of puppet-agent to install
# @option opts [String] :facter_version The version of Facter to install
# @option opts [String] :hiera_version The version of Hiera to install
# @option opts [String] :mac_download_url Url to download msi pattern of %url%/puppet-%version%.msi
#
# @return nil
# @api private
def install_puppet_from_dmg_on( hosts, opts )
block_on hosts do |host|
# install puppet-agent if puppet version > 4.0 OR not puppet version is provided
if (opts[:version] && !version_is_less(opts[:version], '4.0.0')) || !opts[:version]
if opts[:puppet_agent_version].nil?
raise "You must specify the version of puppet-agent you " +
"want to install if you want to install Puppet 4.0 " +
"or greater on OSX"
end
install_puppet_agent_from_dmg_on(host, opts)
else
puppet_ver = opts[:version] || 'latest'
facter_ver = opts[:facter_version] || 'latest'
hiera_ver = opts[:hiera_version] || 'latest'
if [puppet_ver, facter_ver, hiera_ver].include?(nil)
raise "You need to specify versions for OSX host\n eg. install_puppet({:version => '3.6.2',:facter_version => '2.1.0',:hiera_version => '1.3.4',})"
end
on host, "curl -O #{opts[:mac_download_url]}/puppet-#{puppet_ver}.dmg"
on host, "curl -O #{opts[:mac_download_url]}/facter-#{facter_ver}.dmg"
on host, "curl -O #{opts[:mac_download_url]}/hiera-#{hiera_ver}.dmg"
host.install_package("puppet-#{puppet_ver}")
host.install_package("facter-#{facter_ver}")
host.install_package("hiera-#{hiera_ver}")
configure_type_defaults_on( host )
end
end
end
alias_method :install_puppet_from_dmg, :install_puppet_from_dmg_on
# Installs puppet-agent and dependencies from dmg on provided host(s).
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :puppet_agent_version The version of Puppet Agent to install, defaults to latest
# @option opts [String] :mac_download_url Url to download msi pattern of %url%/puppet-%version%.dmg
# @option opts [String] :puppet_collection Defaults to 'PC1'
#
# @return nil
# @api private
def install_puppet_agent_from_dmg_on(hosts, opts)
opts[:puppet_collection] ||= 'PC1'
opts[:puppet_collection] = opts[:puppet_collection].upcase if opts[:puppet_collection].match(/pc1/i)
block_on hosts do |host|
add_role(host, 'aio') #we are installing agent, so we want aio role
variant, version, arch, codename = host['platform'].to_array
if opts[:puppet_collection].match(/puppet\d*/)
url = if opts[:puppet_collection].match(/-nightly$/)
opts[:nightly_mac_download_url]
else
opts[:mac_download_url]
end
download_url = "#{url}/#{opts[:puppet_collection]}/#{version}/#{arch}"
else
download_url = "#{opts[:mac_download_url]}/#{version}/#{opts[:puppet_collection]}/#{arch}"
end
latest = get_latest_puppet_agent_build_from_url(download_url)
agent_version = opts[:puppet_agent_version] || latest
unless agent_version.length > 0
raise "no puppet-agent version specified or found on at #{download_url}"
end
pkg_name = "puppet-agent-#{agent_version}*"
dmg_name = "puppet-agent-#{agent_version}-1.osx#{version}.dmg"
on host, "curl -O #{download_url}/#{dmg_name}"
host.install_package(pkg_name)
configure_type_defaults_on( host )
end
end
# Returns the latest puppet-agent version number from a given url.
#
# @param [String] url URL containing list of puppet-agent packages.
# Example: https://downloads.puppetlabs.com/mac/10.11/PC1/x86_64
#
# @return [String] version puppet-agent version number (e.g. 1.4.1)
# Empty string if none found.
# @api private
def get_latest_puppet_agent_build_from_url(url)
require 'oga'
require 'net/http'
body = Net::HTTP.get(URI.parse("#{url}/index_by_lastModified_reverse.html"))
document = Oga.parse_html(body)
agents = document.xpath('//a[contains(@href, "puppet-agent")]')
latest_match = agents.shift.attributes[0].value
while (latest_match =~ /puppet-agent-\d(.*)/).nil?
latest_match = agents.shift.attributes[0].value
end
re = /puppet-agent-(.*)-/
latest_match = latest_match.match re
if latest_match
latest = latest_match[1]
else
latest = ''
end
return latest
end
# Installs Puppet and dependencies from OpenBSD packages
#
# @param [Host, Array<Host>, String, Symbol] hosts The host to install packages on
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :version The version of Puppet to install (shows warning)
#
# @return nil
# @api private
def install_puppet_from_openbsd_packages_on(hosts, opts)
if (opts[:version])
logger.warn "If you wish to choose a specific Puppet version, use `install_puppet_from_gem_on('~> 3.*')`"
end
block_on hosts do |host|
host.install_package('puppet')
configure_type_defaults_on(host)
end
end
# Installs Puppet and dependencies from Arch Linux Pacman
#
# @param [Host, Array<Host>, String, Symbol] hosts The host to install packages on
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :version The version of Puppet to install (shows warning)
#
# @return nil
# @api private
def install_puppet_from_pacman_on(hosts, opts)
if (opts[:version])
# Arch is rolling release, only the latest package versions are supported
logger.warn "If you wish to choose a specific Puppet version, use `install_puppet_from_gem_on('~> 3.*')`"
end
block_on hosts do |host|
host.install_package('puppet')
configure_type_defaults_on(host)
end
end
# Installs Puppet and dependencies from gem on provided host(s)
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
# @param [Hash{Symbol=>String}] opts An options hash
# @option opts [String] :version The version of Puppet to install, if nil installs latest
# @option opts [String] :facter_version The version of Facter to install, if nil installs latest
# @option opts [String] :hiera_version The version of Hiera to install, if nil installs latest
#
# @return nil
# @raise [StandardError] if gem does not exist on target host
# @api private
def install_puppet_from_gem_on( hosts, opts )
block_on hosts do |host|
# There are a lot of special things to do for Solaris and Solaris 10.
# This is easier than checking host['platform'] every time.
is_solaris10 = host['platform'] =~ /solaris-10/
is_solaris = host['platform'] =~ /solaris/
# Hosts may be provisioned with csw but pkgutil won't be in the
# PATH by default to avoid changing the behavior for Puppet's tests
if is_solaris10
on host, 'ln -s /opt/csw/bin/pkgutil /usr/bin/pkgutil'
end
# Solaris doesn't necessarily have this, but gem needs it
if is_solaris
on host, 'mkdir -p /var/lib'
end
unless host.check_for_command( 'gem' )
gempkg = case host['platform']
when /solaris-11/ then 'ruby-18'
when /ubuntu-14/ then 'ruby'
when /solaris-10|ubuntu|debian|el-|cumulus|huaweios/ then 'rubygems'
when /openbsd/ then 'ruby'
else
raise "install_puppet() called with default_action " +
"'gem_install' but program `gem' is " +
"not installed on #{host.name}"
end
host.install_package gempkg
end
# Link 'gem' to /usr/bin instead of adding /opt/csw/bin to PATH.
if is_solaris10
on host, 'ln -s /opt/csw/bin/gem /usr/bin/gem'
end
if host['platform'] =~ /debian|ubuntu|solaris|cumulus|huaweios/
gem_env = YAML.load( on( host, 'gem environment' ).stdout )
gem_paths_array = gem_env['RubyGems Environment'].find {|h| h['GEM PATHS'] != nil }['GEM PATHS']
path_with_gem = 'export PATH=' + gem_paths_array.join(':') + ':${PATH}'
on host, "echo '#{path_with_gem}' >> ~/.bashrc"
end
gemflags = '--no-document --no-format-executable'
if opts[:facter_version]
on host, "gem install facter -v'#{opts[:facter_version]}' #{gemflags}"
end
if opts[:hiera_version]
on host, "gem install hiera -v'#{opts[:hiera_version]}' #{gemflags}"
end
ver_cmd = opts[:version] ? "-v '#{opts[:version]}'" : ''
on host, "gem install puppet #{ver_cmd} #{gemflags}"
# Similar to the treatment of 'gem' above.
# This avoids adding /opt/csw/bin to PATH.
if is_solaris
gem_env = YAML.load( on( host, 'gem environment' ).stdout )
# This is the section we want - this has the dir where gem executables go.
env_sect = 'EXECUTABLE DIRECTORY'
# Get the directory where 'gem' installs executables.
# On Solaris 10 this is usually /opt/csw/bin
gem_exec_dir = gem_env['RubyGems Environment'].find {|h| h[env_sect] != nil }[env_sect]
on host, "ln -s #{gem_exec_dir}/hiera /usr/bin/hiera"
on host, "ln -s #{gem_exec_dir}/facter /usr/bin/facter"
on host, "ln -s #{gem_exec_dir}/puppet /usr/bin/puppet"
end
# A gem install might not necessarily create these
['confdir', 'logdir', 'codedir'].each do |key|
host.mkdir_p host.puppet[key] if host.puppet.has_key?(key)
end
configure_type_defaults_on( host )
end
end
alias_method :install_puppet_from_gem, :install_puppet_from_gem_on
alias_method :install_puppet_agent_from_gem_on, :install_puppet_from_gem_on
# Install official puppetlabs release repository configuration on host(s).
#
# @param [Host, Array<Host>, String, Symbol] hosts One or more hosts to act upon,
# or a role (String or Symbol) that identifies one or more hosts.
#