Class: VagrantPlugins::Ebcommon::Action::SetupProvision

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant-ebcommon/actions/setup_provision.rb

Instance Method Summary collapse

Constructor Details

#initialize(app, env) ⇒ SetupProvision

Returns a new instance of SetupProvision.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/vagrant-ebcommon/actions/setup_provision.rb', line 10

def initialize(app, env)
  @app = app
  @env = env
  @ebcommon = env[:machine].config.ebcommon
  @puppet_fact_generator = @env[:machine].config.puppet_fact_generator

  provisioner = nil
  @env[:machine].config.vm.provisioners.each do |p|
    if p.name == :puppet
      provisioner = p
      break
    end
  end
  @puppet_config = provisioner ? provisioner.config: nil
  @vagrant_git_commiter_details = @env[:machine].env.local_data_path.join(
    'git_commit_details'
  )
end

Instance Method Details

#call(env) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/vagrant-ebcommon/actions/setup_provision.rb', line 175

def call(env)
  provision_enabled = env.has_key?(:provision_enabled) ? env[:provision_enabled] : true
  if provision_enabled
    ensure_vpn()
    setup_ssh_keys()
    setup_git_hooks()
    generate_git_commiter_facts()
  end
  @app.call(env)
end

#ensure_vpn ⇒ Object

In order to provision vagrant, we require you to be in the office or connected to VPN. There are several packages that are hosted internally and everything will fail miserably if you’re not on our network.



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/vagrant-ebcommon/actions/setup_provision.rb', line 82

def ensure_vpn
  if !ENV['FORCE_PROVISION'] && @ebcommon.vpn_urls
    vpn_valid = false
    @ebcommon.vpn_urls.each { |url|
      vpn_valid = test_url_timeout url, @ebcommon.vpn_timeout
      break if vpn_valid
    }
    if !vpn_valid
      raise Ebcommon::Errors::VPNRequired.new
    end
    @env[:ui].success 'VPN connection verified, continuing provision.'
  end
end

#fetch_git_commiter_details_from_file ⇒ Object

We store the git commiter details in a file within the vagrant directory. We do this so we’re not always prompting a user for their full name and email. If they don’t provide them the first time around, we’ll opt them out and never ask them again.

:Returns:

- dict of github creds



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/vagrant-ebcommon/actions/setup_provision.rb', line 103

def fetch_git_commiter_details_from_file
  creds = {}
  contents = ""
  if File.exists?(@vagrant_git_commiter_details)
    File.open(@vagrant_git_commiter_details, 'r') do |f|
      while line = f.gets
        contents += line
      end
    end
  end
  if !contents.empty?
    creds = JSON.parse contents
  end
  return creds
end

#generate_git_commiter_facts ⇒ Object

When a user is setting up a new vagrant, prompt them for their full name and email. We’ll set these within vagrant so we avoid people accidently commiting as the “vagrant” user.



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
 
# File 'lib/vagrant-ebcommon/actions/setup_provision.rb', line 135

def generate_git_commiter_facts()
  existing_details = fetch_git_commiter_details_from_file()
  # don't set the git configs if the user opted out
  if existing_details.has_key? 'optout'
    return
  end

  if existing_details.any?
    full_name = existing_details.fetch 'full_name', nil
    email = existing_details.fetch 'email', nil
  elsif existing_details.has_key? 'optout'
    full_name = nil
    email = nil
  else
    @env[:ui].warn \
      "You'll be prompted to enter your full name and eventbrite email.\n"\
      "We'll set these for you within your vagrant's .gitconfig.\n"\
      "This will avoid accidentally committing code as 'vagrant'.\n"\
      "If you ever want to reset these, remove\n"\
      "#{@vagrant_git_commiter_details} from your vagrant directory.\n"
    full_name = @env[:ui].ask 'Enter your full name: '
    email = @env[:ui].ask 'Enter your eventbrite email: '
    write_git_commiter_details(full_name, email)
  end
  if !full_name.empty? || !email.empty?
    @env[:ui].success "Will setup global github details in vagrant."\
      " Full Name: #{full_name}, Email: #{email}"
  end
  # NB: We have to escape single quotes for the bash command line.
  # These facts will get run with puppet_apply like:
  # FACTER_github_username='Brian O'Niell'. We use this special
  # escaping to concat an escaped single quote with the rest of the
  # string, outputting: FACTER_github_username='Brian O'\''Niell'
  @puppet_fact_generator.add_fact(
    'github_full_name',
    full_name.gsub("'", "'\\\\''")
  )
  @puppet_fact_generator.add_fact('github_email', email)
end

#setup_git_hooks ⇒ Object

Copy over our git commit hooks



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
 
# File 'lib/vagrant-ebcommon/actions/setup_provision.rb', line 48

def setup_git_hooks
  # repos to be hook'ed
  return unless @ebcommon.git_hook_repos

  # source
  plugin_hooks_dir = File.expand_path File.join(File.dirname(__FILE__), '..', 'files', 'git_hooks')
  git_hooks = Dir.entries(plugin_hooks_dir).select {|f| !File.directory? f}

  @env[:ui].info 'Copying over git commit hooks...'
  @ebcommon.git_hook_repos.each do |repo_path|
    # repo
    repo_dir = File.join @ebcommon.git_hook_root_dir, repo_path, '.git'
    next unless File.directory? repo_dir

    # create repo hooks dir if needed
    target_hooks_dir = File.join repo_dir, 'hooks'
    unless File.directory? target_hooks_dir
      @env[:ui].info "Creating #{target_hooks_dir} directory..."
      FileUtils.mkdir target_hooks_dir
    end

    # copy source hooks to repo
    git_hooks.each do |hook|
      @env[:ui].success "Copying over git hook: #{hook} to #{target_hooks_dir}"
      source = File.join plugin_hooks_dir, hook
      FileUtils.cp source, target_hooks_dir
    end
  end
end

#setup_ssh_keys ⇒ Object

Some of our requirements contain references to private eventbrite github repos. We’ll fail to clone these unless we’ve added our ssh-keys so their available to vagrant.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/vagrant-ebcommon/actions/setup_provision.rb', line 32

def setup_ssh_keys
  @env[:ui].info 'Ensuring ssh-keys have been added via `ssh-add`...'
  current_keys = `ssh-add -l`
  if current_keys.include? 'no identities'
    success = system('ssh-add')
    if success
      @env[:ui].success '...ssh-keys successfully added'
    else
      @env[:ui].warn 'failed to call `ssh-add`, some requirements may fail to install'
    end
  else
    @env[:ui].info '...ssh-keys detected, skipping `ssh-add`'
  end
end

#write_git_commiter_details(full_name, email) ⇒ Object

Write the git commiter details to a file so we can load them next time the user starts up vagrant.



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/vagrant-ebcommon/actions/setup_provision.rb', line 121

def write_git_commiter_details(full_name, email)
  if full_name.empty? and email.empty?
    creds = {'optout' => true}
  else
    creds = {'full_name' => full_name, 'email' => email}
  end
  File.open(@vagrant_git_commiter_details, 'w') do |f|
    f.write(JSON.dump(creds))
  end
end