fabfile.py

from fabric.api import run, sudo, env, require, settings, local, put
from fabric.contrib.files import exists
import subprocess
import os

### VARIABLES ###

# Origin of our repository, and the repository
GIT_ORIGIN = 'git@github.com'
GIT_REPO = 'nsh87/shiny'

# Packages to install in Vagrant
INSTALL_PACKAGES = ['r-base',
                    'gdebi-core',
                    'haskell-platform',
                    'libghc-pandoc-dev',
                    'pandoc']

### ENVIRONMENTS ###

def vagrant():
    """Defines the Vagrant virtual machine's environment variables.
    Local development and server will use this environment.
    """
    # Configure SSH things
    raw_ssh_config = subprocess.Popen(['vagrant', 'ssh-config'], stdout=subprocess.PIPE).communicate()[0]
    ssh_config = dict([l.strip().split() for l in raw_ssh_config.decode('utf-8').split("\n") if l])
    env.hosts = ['127.0.0.1:%s' % (ssh_config['Port'])]
    env.user = ssh_config['User']
    env.key_filename = ssh_config['IdentityFile'].replace("'", "").replace('"', '')

    # Development will happen on the master branch
    env.repo = ('origin', 'master')

def remote():
    """Defines a remote server on AWS running Ubuntu 14.x, ideally with >1.5GB
    RAM.
    """
    # Insert values for:
    env.hosts = 'ec2-52-13.us-west-2.compute.amazonaws.com'  # Your public DNS
    env.key_filename = os.path.join('/', 'my.pem')  # Path to your AWS .pem key

    # Don't change unless you know what you are doing:
    env.base = '/www-shiny'  # Default location for Shiny Server apps
    env.user = 'ubuntu'  # Default username for AWS SSH login

### ROUTINES ###

def setup_vagrant():
    """Sets up the Vagrant environment"""
    require('hosts', provided_by=[vagrant])  # Sets the environment for Fabric
    sub_add_repos()
    sub_install_packages()
    sub_install_shiny()
    reload_server()

def bootstrap():
    """Sets up the remote environment"""
    require('hosts', provided_by=[remote])
    sub_add_repos()
    sub_install_packages()
    sub_install_shiny()
    reload_server()

def reload_server():
    require('hosts', provided_by=[vagrant, remote])
    sudo('restart shiny-server')

def push():
    """Pushes the current folder to the remote machine's Shiny apps folder"""
    require('hosts', provided_by=[remote])
    sudo('mkdir -p /www-shiny')
    sudo('chown -R ubuntu:ubuntu /www-shiny')
    sudo('rm -rf /www-shiny/*')
    put('./', '/www-shiny/')

### SUB-ROUTINES ###

def sub_add_repos():
    """Adds any repositories needed to install packages"""
    if not exists('/etc/apt/sources.list.d/cran.list', use_sudo=True):
        # Add the repository for R
        sudo('sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 '
             '--recv-keys E084DAB9')
        run('sudo sh -c "echo \'deb http://cran.rstudio.com/bin/linux/ubuntu '
            'trusty/\' >> /etc/apt/sources.list.d/cran.list"')

def sub_install_packages():
    """Installs the necessary packages to get Shiny running"""
    sudo('apt-get update')
    sudo('apt-get -y upgrade')
    package_str = ' '.join(INSTALL_PACKAGES)
    sudo('apt-get -y --force-yes install ' + package_str)

def sub_install_shiny():
    """Installs Shiny package and Shiny Server"""
    # Install Shiny package for R
    sudo('R -e "install.packages(\'shiny\', '
         'repos=\'http://cran.rstudio.com/\')"')

    # Install Shiny Server using gdebi. According to documentation, will be
    # installed into /opt/shiny-server/ with main executable in
    # /opt/shiny-server/bin/shiny-server. Also new user 'shiny' will be
    # created.
    sudo('mkdir -p /usr/src/shiny')
    sudo('''cd /usr/src/shiny; if [ ! -e shiny-server-1.4.2.786-amd64.deb ];
    then a='http://download3.rstudio.org/ubuntu-12.04/x86_64/shiny-server-' ; \
    b='1.4.2.786-amd64.deb' ; \
    wget $a$b ; \
    echo y | gdebi shiny-server-1.4.2.786-amd64.deb ; \
    fi''')

    # Move server directory at /srv/shiny-server to shared Vagrant folder if
    # the shared folder is empty. This will copy sample Shiny app in the
    # process.
    sudo('''if [ 'find /www-shiny -maxdepth 0 -empty | read v' ]; then \
    cp -LR /srv/shiny-server/* /www-shiny/ ; \
    rm -rf /srv/shiny-server ; \
    ln -s /www-shiny/ /srv/shiny-server;
    fi''')

    sub_install_rmarkdown()
    sub_install_additional_packages()
    sub_make_writeable_project()

def sub_make_writeable_project():
    """Creates a symlink from Shiny's web server folder to a shiny:shiny
    writeable folder for app development.

    Shiny server runs in /www-shiny (/project on the host machine), whose
    owner is vagrant:vagrant. Shiny server runs as user shiny:shiny; so if
    you have an app that needs to write anything, you can't do it in
    /www-shiny. You have to do it in another owned by shiny:shiny.
    """
    sudo('''cd /www-shiny; if [ ! -L proj ]; then \
    ln -s ../writeable-project/ proj ;
    fi''')

def sub_install_rmarkdown():
    """Installs the packages required for Shiny to serve markdown documents.
    Haskell is a prerequisite that should have been installed earlier. Pandoc is
    also required."""
    run('cabal update')
    sudo('R -e "install.packages(\'rmarkdown\', '
         'repos=\'http://cran.rstudio.com/\')"')

def sub_install_additional_packages():
    """This is an example function demonstrating how to add the installation of
    an R package to the setup process.

    Simply uncomment the lines below and replace the name of the package and the
    URL to its repo if necessary. Then delete the line that says 'pass'.
    """
    # sudo('R -e "install.packages(\'rmarkdown\', '
    #     'repos=\'http://cran.rstudio.com/\')"')
    pass