Vagrantfile

   1 # -*- mode: ruby -*-
   2 # vi: set ft=ruby :
   3
   4 # This assumes that the host machine has r2 and all the reddit plugins checked
   5 # out and in the correct directories--pay attention to both name and position
   6 # relative to the r2 code:
   7 #
   8 # r2:         {ROOTDIR}/reddit
   9 #
  10 # plugins:
  11 # about:      {ROOTDIR}/about
  12 # gold:       {ROOTDIR}/gold
  13 #
  14 # All plugins are optional. A plugin will only be installed if it is listed
  15 # in `plugins` AND it is located in a directory that both follows the plugin
  16 # naming convention and is correctly located on the host machine. The general
  17 # rule for naming each plugin directory is that "reddit-plugin-NAME" should be
  18 # in the directory {ROOTDIR}/NAME.
  19 #
  20 # This VagrantFile allows for the creation of two VMs:
  21 #   * default: the primary VM, with all services necessary to run reddit
  22 #              locally against the local codebase.
  23 #   * travis:  Testing-only VM suitable for running `nosetests` and debugging
  24 #              issues encountered without having to wait for travis-ci to pick
  25 #              up the build.  This will *not* be the same environment as
  26 #              travis, but it should be useful for repairing broken tests.
  27 #
  28 # To start your vagrant box simply enter `vagrant up` from {ROOTDIR}/reddit.
  29 # You can then ssh into it with `vagrant ssh`.
  30 #
  31 # avahi-daemon is installed on the guest VM so you can access your local install
  32 # at https://reddit.local. If that fails you'll need to update your host
  33 # machine's hosts file (/etc/hosts) to include the line:
  34 # 192.168.56.111 reddit.local
  35 #
  36 # If you want to create additional vagrant boxes you can copy this file
  37 # elsewhere, but be sure to update `code_share_host_path` to be the absolute
  38 # path to {ROOTDIR}.
  39
  40 vagrant_user = "vagrant"
  41
  42 # code directories
  43 this_path = File.absolute_path(__FILE__)
  44 reddit_dir = File.expand_path("..", this_path)
  45 code_share_host_path = File.expand_path("..", reddit_dir)
  46 code_share_guest_path = "/media/reddit_code"
  47 plugins = [
  48   "about",
  49   "gold",
  50 ]
  51
  52 # overlayfs directories
  53 overlay_mount = "/home/#{vagrant_user}/src"
  54 overlay_lower = code_share_guest_path
  55 overlay_upper = "/home/#{vagrant_user}/.overlay"
  56
  57 # "default" vm config
  58 guest_ip = "192.168.56.111"
  59 guest_mem = "4096"
  60 guest_swap = "4096"
  61 hostname = "reddit.local"
  62
  63
  64 Vagrant.configure(2) do |config|
  65   config.vm.box = "trusty-cloud-image"
  66   config.vm.box_url = "https://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box"
  67
  68   # mount the host shared folder
  69   config.vm.synced_folder code_share_host_path, code_share_guest_path, mount_options: ["ro"]
  70
  71   config.vm.provider "virtualbox" do |vb|
  72     vb.memory = guest_mem
  73   end
  74
  75   # ubuntu cloud image has no swapfile by default, set one up
  76   config.vm.provision "shell", inline: <<-SCRIPT
  77     if ! grep -q swapfile /etc/fstab; then
  78       echo 'swapfile not found. Adding swapfile.'
  79       fallocate -l #{guest_swap}M /swapfile
  80       chmod 600 /swapfile
  81       mkswap /swapfile
  82       swapon /swapfile
  83       echo '/swapfile none swap defaults 0 0' >> /etc/fstab
  84     else
  85       echo 'swapfile found. No changes made.'
  86     fi
  87   SCRIPT
  88
  89   # set up the overlay filesystem
  90   config.vm.provision "shell", inline: <<-SCRIPT
  91     if [ ! -d #{overlay_mount} ]; then
  92       echo "creating overlay mount directory #{overlay_mount}"
  93       sudo -u #{vagrant_user} mkdir #{overlay_mount}
  94     fi
  95
  96     if [ ! -d #{overlay_upper} ]; then
  97       echo "creating overlay upper directory #{overlay_upper}"
  98       sudo -u #{vagrant_user} mkdir #{overlay_upper}
  99     fi
 100
 101     echo "mounting overlayfs (lower: #{overlay_lower}, upper: #{overlay_upper}, mount: #{overlay_mount})"
 102     mount -t overlayfs overlayfs -o lowerdir=#{overlay_lower},upperdir=#{overlay_upper} #{overlay_mount}
 103   SCRIPT
 104
 105   # NOTE: This VM exists solely to assist in writing tests.  It does not actually
 106   # install travis but rather builds a minimal vm with only the services
 107   # available under a travis build to aid in test debugging (via `nosetests`)
 108   # To use:
 109   #     $ vagrant up travis
 110   #     $ vagrant ssh travis
 111   #     vagrant@travis$ cd src/reddit/r2 && nosetests
 112   config.vm.define "travis", autostart: false do |travis|
 113       travis.vm.hostname = "travis"
 114       # run install script
 115       travis.vm.provision "shell", inline: <<-SCRIPT
 116         if [ ! -f /var/local/reddit_installed ]; then
 117           echo "running install script"
 118           cd /home/#{vagrant_user}/src/reddit
 119           ./install/travis.sh vagrant
 120           touch /var/local/reddit_installed
 121         else
 122           echo "install script already run"
 123         fi
 124       SCRIPT
 125   end
 126
 127   # NB: this is the primary VM. To build run
 128   #    $ vagrant up
 129   # [though 'vagrant up default' will also work, the 'default' is redudnant]
 130   # Once built, avahi-daemon should guarantee the instance will be accessible
 131   # from https://reddit.local/
 132   config.vm.define "default", primary: true do |redditlocal|
 133       redditlocal.vm.hostname = hostname
 134       # host-only network interface
 135       redditlocal.vm.network "private_network", ip: guest_ip
 136
 137       # rabbitmq web interface
 138       config.vm.network "forwarded_port", guest: 15672, host: 15672
 139
 140       # run install script
 141       plugin_string = plugins.join(" ")
 142       redditlocal.vm.provision "shell", inline: <<-SCRIPT
 143         if [ ! -f /var/local/reddit_installed ]; then
 144           echo "running install script"
 145           cd /home/#{vagrant_user}/src/reddit
 146           REDDIT_PLUGINS="#{plugin_string}" REDDIT_DOMAIN="#{hostname}" ./install/reddit.sh
 147           touch /var/local/reddit_installed
 148         else
 149           echo "install script already run"
 150         fi
 151       SCRIPT
 152
 153       # inject test data
 154       redditlocal.vm.provision "shell", inline: <<-SCRIPT
 155         if [ ! -f /var/local/test_data_injected ]; then
 156           cd /home/#{vagrant_user}/src/reddit
 157           sudo -u #{vagrant_user} reddit-run scripts/inject_test_data.py -c 'inject_test_data()'
 158           touch /var/local/test_data_injected
 159         else
 160           echo "inject test data already run"
 161         fi
 162
 163         # HACK: stop and start everything (otherwise sometimes there's an issue with
 164         # ports being in use?)
 165         reddit-stop
 166         reddit-start
 167       SCRIPT
 168
 169       # additional setup
 170       redditlocal.vm.provision "shell", inline: <<-SCRIPT
 171         if [ ! -f /var/local/additional_setup ]; then
 172           apt-get install -y ipython avahi-daemon
 173           touch /var/local/additional_setup
 174         else
 175           echo "additional setup already run"
 176         fi
 177       SCRIPT
 178
 179       # DONE: let this run whenever provision is run so that the user can see
 180       # how to proceed.
 181       redditlocal.vm.provision "shell", inline: <<-SCRIPT
 182         cd /home/#{vagrant_user}/src/reddit
 183         REDDIT_DOMAIN="#{hostname}" ./install/done.sh
 184       SCRIPT
 185   end
 186 end