forked from hashicorp/vagrant
/
environment.rb
366 lines (313 loc) · 11 KB
/
environment.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
require 'pathname'
require 'fileutils'
module Vagrant
# Represents a single Vagrant environment. A "Vagrant environment" is
# defined as basically a folder with a "Vagrantfile." This class allows
# access to the VMs, CLI, etc. all in the scope of this environment.
class Environment
ROOTFILE_NAME = "Vagrantfile"
HOME_SUBDIRS = ["tmp", "boxes", "logs"]
DEFAULT_VM = :default
# Parent environment (in the case of multi-VMs)
attr_reader :parent
# The `cwd` that this environment represents
attr_reader :cwd
# The single VM that this environment represents, in the case of
# multi-VM.
attr_accessor :vm
# The {UI} object to communicate with the outside world.
attr_writer :ui
#---------------------------------------------------------------
# Class Methods
#---------------------------------------------------------------
class << self
# Verifies that VirtualBox is installed and that the version of
# VirtualBox installed is high enough.
def check_virtualbox!
version = VirtualBox.version
raise Errors::VirtualBoxNotDetected.new if version.nil?
raise Errors::VirtualBoxInvalidVersion.new(:version => version.to_s) if version.to_f < 3.2
raise Errors::VirtualBoxInvalidOSE.new(:version => version.to_s) if version.to_s.downcase.include?("ose")
end
end
# Initializes a new environment with the given options. The options
# is a hash where the main available key is `cwd`, which defines where
# the environment represents. There are other options available but
# they shouldn't be used in general. If `cwd` is nil, then it defaults
# to the `Dir.pwd` (which is the cwd of the executing process).
def initialize(opts=nil)
opts = {
:parent => nil,
:vm => nil,
:cwd => nil,
}.merge(opts || {})
opts[:cwd] ||= Dir.pwd
opts[:cwd] = Pathname.new(opts[:cwd])
opts.each do |key, value|
instance_variable_set("@#{key}".to_sym, opts[key])
end
@loaded = false
end
#---------------------------------------------------------------
# Helpers
#---------------------------------------------------------------
# The path to the `dotfile`, which contains the persisted UUID of
# the VM if it exists.
#
# @return [Pathname]
def dotfile_path
root_path.join(config.vagrant.dotfile_name) rescue nil
end
# The path to the home directory, expanded relative to the root path,
# and converted into a Pathname object.
#
# @return [Pathname]
def home_path
@_home_path ||= Pathname.new(File.expand_path(config.vagrant.home, root_path))
end
# The path to the Vagrant tmp directory
#
# @return [Pathname]
def tmp_path
home_path.join("tmp")
end
# The path to the Vagrant boxes directory
#
# @return [Pathname]
def boxes_path
home_path.join("boxes")
end
# Path to the Vagrant logs directory
#
# @return [Pathname]
def log_path
home_path.join("logs")
end
# Returns the name of the resource which this environment represents.
# The resource is the VM name if there is a VM it represents, otherwise
# it defaults to "vagrant"
#
# @return [String]
def resource
vm.name rescue "vagrant"
end
# Returns the collection of boxes for the environment.
#
# @return [BoxCollection]
def boxes
return parent.boxes if parent
@_boxes ||= BoxCollection.new(self)
end
# Returns the box that this environment represents.
#
# @return [Box]
def box
result = boxes.find(config.vm.box)
raise Errors::BoxNotFound, :name => config.vm.box if vm && !result
result
end
# Returns the VMs associated with this environment.
#
# @return [Array<VM>]
def vms
return parent.vms if parent
load! if !loaded?
@vms ||= load_vms!
end
# Returns the primary VM associated with this environment. This
# method is only applicable for multi-VM environments. This can
# potentially be nil if no primary VM is specified.
#
# @return [VM]
def primary_vm
return vms.values.first if !multivm?
return parent.primary_vm if parent
config.vm.defined_vms.each do |name, subvm|
return vms[name] if subvm.options[:primary]
end
nil
end
# Returns a boolean whether this environment represents a multi-VM
# environment or not. This will work even when called on child
# environments.
#
# @return [Bool]
def multivm?
if parent
parent.multivm?
else
vms.length > 1 || vms.keys.first != DEFAULT_VM
end
end
# Makes a call to the CLI with the given arguments as if they
# came from the real command line (sometimes they do!). An example:
#
# env.cli("package", "--vagrantfile", "Vagrantfile")
#
def cli(*args)
CLI.start(args.flatten, :env => self)
end
# Returns the {UI} for the environment, which is responsible
# for talking with the outside world.
#
# @return [UI]
def ui
@ui ||= if parent
result = parent.ui.clone
result.env = self
result
else
UI.new(self)
end
end
# Returns the host object associated with this environment.
#
# @return [Hosts::Base]
def host
@host ||= Hosts::Base.load(self, config.vagrant.host)
end
# Returns the {Action} class for this environment which allows actions
# to be executed (middleware chains) in the context of this environment.
#
# @return [Action]
def actions
@actions ||= Action.new(self)
end
# Loads on initial access and reads data from the global data store.
# The global data store is global to Vagrant everywhere (in every environment),
# so it can be used to store system-wide information. Note that "system-wide"
# typically means "for this user" since the location of the global data
# store is in the home directory.
#
# @return [DataStore]
def global_data
return parent.global_data if parent
@global_data ||= DataStore.new(File.expand_path("global_data.json", home_path))
end
# Loads (on initial access) and reads data from the local data
# store. This file is always at the root path as the file "~/.vagrant"
# and contains a JSON dump of a hash. See {DataStore} for more
# information.
#
# @return [DataStore]
def local_data
return parent.local_data if parent
@local_data ||= DataStore.new(dotfile_path)
end
# Accesses the logger for Vagrant. This logger is a _detailed_
# logger which should be used to log internals only. For outward
# facing information, use {#ui}.
#
# @return [Logger]
def logger
return parent.logger if parent
@logger ||= Util::ResourceLogger.new(resource, self)
end
# The root path is the path where the top-most (loaded last)
# Vagrantfile resides. It can be considered the project root for
# this environment.
#
# @return [String]
def root_path
return @root_path if defined?(@root_path)
root_finder = lambda do |path|
return path if File.exist?(File.join(path.to_s, ROOTFILE_NAME))
return nil if path.root? || !File.exist?(path)
root_finder.call(path.parent)
end
@root_path = root_finder.call(cwd)
end
#---------------------------------------------------------------
# Config Methods
#---------------------------------------------------------------
# The configuration object represented by this environment. This
# will trigger the environment to load if it hasn't loaded yet (see
# {#load!}).
#
# @return [Config::Top]
def config
load! if !loaded?
@config
end
#---------------------------------------------------------------
# Load Methods
#---------------------------------------------------------------
# Returns a boolean representing if the environment has been
# loaded or not.
#
# @return [Bool]
def loaded?
!!@loaded
end
# Loads this entire environment, setting up the instance variables
# such as `vm`, `config`, etc. on this environment. The order this
# method calls its other methods is very particular.
def load!
if !loaded?
@loaded = true
self.class.check_virtualbox!
load_config!
end
self
end
# Loads this environment's configuration and stores it in the {#config}
# variable. The configuration loaded by this method is specified to
# this environment, meaning that it will use the given root directory
# to load the Vagrantfile into that context.
def load_config!
first_run = @config.nil?
# First load the initial, non config-dependent Vagrantfiles
loader = Config.new(self)
loader.queue << File.expand_path("config/default.rb", Vagrant.source_root)
loader.queue << File.join(box.directory, ROOTFILE_NAME) if !first_run && box
loader.queue << File.join(home_path, ROOTFILE_NAME) if !first_run && home_path
loader.queue << File.join(root_path, ROOTFILE_NAME) if root_path
# If this environment is representing a sub-VM, then we push that
# proc on as the last configuration.
if vm
subvm = parent.config.vm.defined_vms[vm.name]
loader.queue << subvm.proc_stack if subvm
end
# Execute the configuration stack and store the result as the final
# value in the config ivar.
@config = loader.load!
# (re)load the logger
@logger = nil
if first_run
# After the first run we want to load the configuration again since
# it can change due to box Vagrantfiles and home directory Vagrantfiles
load_home_directory!
load_config!
end
end
# Loads the home directory path and creates the necessary subdirectories
# within the home directory if they're not already created.
def load_home_directory!
# Setup the array of necessary home directories
dirs = [home_path]
dirs += HOME_SUBDIRS.collect { |subdir| home_path.join(subdir) }
# Go through each required directory, creating it if it doesn't exist
dirs.each do |dir|
next if File.directory?(dir)
ui.info I18n.t("vagrant.general.creating_home_dir", :directory => dir)
FileUtils.mkdir_p(dir)
end
end
# Loads the persisted VM (if it exists) for this environment.
def load_vms!
result = {}
# Load the VM UUIDs from the local data store
(local_data[:active] || {}).each do |name, uuid|
result[name.to_sym] = Vagrant::VM.find(uuid, self, name.to_sym)
end
# For any VMs which aren't created, create a blank VM instance for
# them
all_keys = config.vm.defined_vms.keys
all_keys = [DEFAULT_VM] if all_keys.empty?
all_keys.each do |name|
result[name] = Vagrant::VM.new(:name => name, :env => self) if !result.has_key?(name)
end
result
end
end
end