Cargo Upgrade Service Project

NC State CSC517: Object-Oriented Design and Development

Chris Brown (dcbrow10@ncsu.edu)
Bradford Ingersoll (bingers@ncsu.edu)
Qiufeng Yu (qyu4@ncsu.edu)

The Servo Dependency Tool is a set of python scripts that automatically upgrades Cargo dependencies for the Servo web browser engine (Github page: https://github.com/servo/servo).

Video:

Background Information

Servo is a prototype web browser engine written in the Rust language. It is currently developed on 64bit OS X, 64bit Linux, and Android. Servo depends on numerous other Rust libraries that are published on the package manager crates.io. There are no notifications for when packages are updated; it's up to developers to keep track of when they need to upgrade their dependencies. The goal of the Servo Dependency Tool is to automatically upgrade Servo's dependencies whenever new versions are released.

Tool Workflow Overview

This gives a high-level summary of the tool's workflow

1. Perform a pull to ensure servo is up-to-date
2. Create a new branch for the updates
3. Parse the Cargo.lock file for all packages and their current versions
4. Clone the crates.io index and check each package from the previous step for a more recent version
5. Locate all Cargo.toml files in the servo project and update their dependencies with the most recent version found in the previous step
6. Execute the cargo update command for each package (specifying version when ambiguity occurs)
7. Push these updates to the upstream branch
8. Create a pull request on the main servo repository with these updated dependencies

Installation

Prerequisites

• Servo web engine
• Python3

Installing GitPython and github3.py

The Servo Dependency Tool requires two external libraries (GitPython and github3.py) in order to interact with the Servo github, push lastest dependencies and open pull requests.

• Install GitPython

     python3 -m pip install gitpython

• Install github3.py

     python3 -m pip install github3.py

Running Locally

In order to run the tool, first make a local clone of the Servo repository

     git clone https://github.com/servo/servo.git

and then run the main driver file: servo_dependency_tool.py.

     python3 servo_dependency_tool.py

The tool will first do a git pull command to get the latest fork of the Servo repository, then it wil create a new branch on the local clone and update all the dependencies. Finaly, it will open a new pull request against Servo's github repository from our local fork.

For more detailed instructions on how to use this tool, please click on the video on the top.

Issue Tracker

Servo Wiki page

Running on Amazon AWS (Ubuntu 14.04)

Launch a virtual machine with EC2 (Ubuntu 14.04)

Once running, SSH to the server using the steps listed on the EC2 Instances "Connect" button

Once logged in, update the package listings in apt-get

     sudo apt-get update

Install all necessary packages for servo (from Servo README)

    sudo apt-get install git curl freeglut3-dev autoconf \
       libfreetype6-dev libgl1-mesa-dri libglib2.0-dev xorg-dev \
       gperf g++ build-essential cmake python-virtualenv python-pip \
       libssl-dev libbz2-dev libosmesa6-dev libxmu6 libxmu-dev \
       libglu1-mesa-dev libgles2-mesa-dev libegl1-mesa-dev libdbus-1-dev

Install python3 pip

     sudo apt-get install python3-pip

Install the necessary python3 modules

     sudo python3 -m pip install gitpython github3.py

Clone the servo-based repo (servo or the forked instance of servo)

     git clone https://github.com/servo/servo.git

Navigate to the new directory

     cd servo

Clone the servo-dependency-tool repo (must be inside the root servo folder)

     git clone https://github.com/chbrown13/servo-dependency-tool.git

Run the tool

     sudo python3 servo_dependency_tool.py