cheyuanl/p2-1

RAFT

This repository contains the starter code for project 2 (15-440/15-640, Fall 2019). These instructions assume you have set your GOPATH to point to the repository's root P2/ directory.

Starter Code

The starter code for this project is organized roughly as follows:

src/github.com/cmu440/
  raft/                            Raft implementation, tests and test helpers

  rpc/                             RPC library that must be used for implementing Raft

Instructions

How to Write Go Code

If at any point you have any trouble with building, installing, or testing your code, the article titled How to Write Go Code is a great resource for understanding how Go workspaces are built and organized. You might also find the documentation for the go command to be helpful. As always, feel free to post your questions on Piazza.

Executing the official tests

1. Checkpoint

To run the checkpoint tests, run the following from the src/github.com/cmu440/raft/ folder

go test -run 2A

2. Full test

To execute all the tests, run the following from the src/github.com/cmu440/raft/ folder

go test

Miscellaneous

Reading the API Documentation

Before you begin the project, you should read and understand all of the starter code we provide. To make this experience a little less traumatic (we know, it's a lot :P), fire up a web server and read the documentation in a browser by executing the following command:

godoc -http=:6060 &

Then, navigate to localhost:6060/pkg/github.com/cmu440 in a browser. Note that you can execute this command from anywhere in your system (assuming your GOPATH is pointing to the project's root p1/ directory).

Using Go on AFS

For those students who wish to write their Go code on AFS (either in a cluster or remotely), you will need to set the GOROOT environment variable as follows (this is required because Go is installed in a custom location on AFS machines):

export GOROOT=/usr/local/depot/go