LandRegistry/development-environment-alpha

Name: development-environment-alpha

Owner: HM Land Registry

Description: This repository contains the tools & setup scripts to work on the Land Registry code base as a developer.

Created: 2014-07-07 14:34:58.0

Updated: 2015-03-13 11:19:11.0

Pushed: 2015-01-28 07:48:19.0

Homepage: null

Size: 1309

Language: Shell

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Land Registry Development Environment

This repository contains the setup scripts for developers to quickly get up and running with the Land Registry codebase. By bootstrapping their developer environment from these scripts developers will be able to get all of the code repositories, run the unit tests and start the various applications that make up the land registry systems.

Prerequisites

In order to run the development environment locally you will need

• VirtualBox 4.3.14 or above (https://www.virtualbox.org/wiki/Downloads)
• Vagrant (http://www.vagrantup.com/downloads.html)
• git must be installed locally

Configuring the hostfile

Before using the service ensure that the following line is in your hostfile on the host machine. (Normally in /etc/hosts)

16.42.43 landregistry.local

You will also want to add to the hosts file all the services listed when running `lr-nginx`, which is also displayed on the first start of your development VM. That entry should look like

em-of-record.landregistry.local mint.landregistry.local property-frontend.landregistry.local search-api.landregistry.local casework-frontend.landregistry.local the-feeder.landregistry.local service-frontend.landregistry.local decision.landregistry.local html-prototypes.landregistry.local style-guide.landregistry.local ownership.landregistry.local matching.landregistry.local fixtures.landregistry.local introductions.landregistry.local cases.landregistry.local historian.landregistry.local charges-html-prototype.landregistry.local

Configuring SSH agent forwarding

To allow github repos to be cloned down while inside the vagrant box, you need to give it access to your local ssh keys. Create your ssh config file if you don't have one already:

h ~/.ssh/config

and add the following lines:

 172.16.42.43
orwardAgent yes

If after 'vagrant up' you get the following error message -

 SSH command responded with a non-zero exit status...."

Then enter the following on the mac -

add ~/.ssh/id_rsa

Creating the environment

From the directory containing this repository run

ant up

This will create the virtual machine. Next, log into the virtual machine using the command:

ant ssh

This will log into the machine and check out all of the applications in the /vagrant/apps directory

Running all of the unit tests

To run all of the unit tests configured in the applications simply log into the VM and run

un-all-unit-tests

Starting up all of the applications

To start up all of the applications run

tart-all

Appplication files & log locations

Each application will be stored in /vagrant/apps/

Logs for each individual application can be found in /vagrant/logs

To update all of the apps

Simply run

pdate-all-apps

To upgrade all of the databases

Simply run

pgrade-all-databases

To create all of the databases

Run

reate-all-databases

Note: This will run automatically when the VM is provisioned.

If your environment becomes corrupted

To clean out the environment and python virtual environments for all applications you can run

lean

To clean out the whole environment and begin again from scratch you can run the following commands from the host machine, not inside the VM.

ant halt
ant destroy
ant up

To run the acceptance tests

Run

un-acceptance-tests

Advanced topics

For more detailed operations within the dev environment look here: https://github.com/LandRegistry/development-environment/blob/master/README_Advanced.md