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
|
#
# Copyright:: 2008-2020, Chef Software Inc.
#
# 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_relative "../resource"
require "plist"
class Chef
class Resource
class BuildEssential < Chef::Resource
unified_mode true
provides(:build_essential) { true }
description "Use the build_essential resource to install the packages required for compiling C software from source."
introduced "14.0"
examples <<~DOC
Install compilation packages
```ruby
build_essential
```
Install compilation packages during the compilation phase
```ruby
build_essential 'Install compilation tools' do
compile_time true
end
```
DOC
# this allows us to use build_essential without setting a name
property :name, String, default: ""
property :raise_if_unsupported, [TrueClass, FalseClass],
description: "Raise a hard error on platforms where this resource is unsupported.",
default: false, desired_state: false # FIXME: make this default to true
action :install do
description "Install build essential packages"
case
when debian?
package %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev }
when fedora_derived?
package %w{ autoconf bison flex gcc gcc-c++ gettext kernel-devel make m4 ncurses-devel patch }
when freebsd?
package "devel/gmake"
package "devel/autoconf"
package "devel/m4"
package "devel/gettext"
when macos?
install_xcode_cli_tools(xcode_cli_package_label) unless xcode_cli_installed?
when omnios?
package "developer/gcc48"
package "developer/object-file"
package "developer/linker"
package "developer/library/lint"
package "developer/build/gnu-make"
package "system/header"
package "system/library/math/header-math"
# Per OmniOS documentation, the gcc bin dir isn't in the default
# $PATH, so add it to the running process environment
# http://omnios.omniti.com/wiki.php/DevEnv
ENV["PATH"] = "#{ENV["PATH"]}:/opt/gcc-4.7.2/bin"
when solaris2?
package "autoconf"
package "automake"
package "bison"
package "gnu-coreutils"
package "flex"
package "gcc"
package "gnu-grep"
package "gnu-make"
package "gnu-patch"
package "gnu-tar"
package "make"
package "pkg-config"
package "ucb"
when smartos?
package "autoconf"
package "binutils"
package "build-essential"
package "gcc47"
package "gmake"
package "pkg-config"
when suse?
package %w{ autoconf bison flex gcc gcc-c++ kernel-default-devel make m4 }
package %w{ gcc48 gcc48-c++ } if node["platform_version"].to_i < 12
else
msg = <<-EOH
The build_essential resource does not currently support the '#{node["platform_family"]}'
platform family. Skipping...
EOH
if new_resource.raise_if_unsupported
raise msg
else
Chef::Log.warn msg
end
end
end
action :upgrade do
description "Upgrade build essential (Xcode Command Line) tools on macOS"
if macos?
pkg_label = xcode_cli_package_label
# With upgrade action we should install if it's not installed or if there's an available update.
# `xcode_cli_package_label` will be nil if there's no update.
install_xcode_cli_tools(pkg_label) if !xcode_cli_installed? || xcode_cli_package_label
else
Chef::Log.info "The build_essential resource :upgrade action is only supported on macOS systems. Skipping..."
end
end
action_class do
#
# Install Xcode Command Line tools via softwareupdate CLI
#
# @param [String] label The label (package name) to install
#
def install_xcode_cli_tools(label)
# This script was graciously borrowed and modified from Tim Sutton's
# osx-vm-templates at https://github.com/timsutton/osx-vm-templates/blob/b001475df54a9808d3d56d06e71b8fa3001fff42/scripts/xcode-cli-tools.sh
execute "install Xcode Command Line tools" do
command <<-EOH
# create the placeholder file that's checked by CLI updates' .dist code
# in Apple's SUS catalog
touch /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
# install it
softwareupdate -i "#{label}" --verbose
# Remove the placeholder to prevent perpetual appearance in the update utility
rm -f /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
EOH
end
end
#
# Determine if the XCode Command Line Tools are installed by parsing the install history plist.
# We parse the plist data install of running pkgutil because we found that pkgutils doesn't always contain all the packages
#
# @return [true, false]
def xcode_cli_installed?
packages = Plist.parse_xml(::File.open("/Library/Receipts/InstallHistory.plist", "r"))
packages.select! { |package| package["displayName"].match? "Command Line Tools" }
!packages.empty?
end
#
# Return to package label of the latest Xcode Command Line Tools update, if available
#
# @return [String, NilClass]
def xcode_cli_package_label
available_updates = shell_out("softwareupdate", "--list")
# raise if we fail to check
available_updates.error!
# https://rubular.com/r/UPEE5P7mZLvXNs
label_match = available_updates.stdout.match(/^\s*\* (?:Label: )?(Command Line Tools.*)/)
# this will return the match or nil
label_match[1] unless label_match.nil?
end
end
end
end
end
|
