Skip to content

Latest commit

 

History

History
68 lines (64 loc) · 3.63 KB

README.md

File metadata and controls

68 lines (64 loc) · 3.63 KB
Raw

Chirp Phase 3

Forked from jillianKhoo/499-jkhoo.

Contents

  1. Installation
  2. Compiling and Running the Code
  3. Compiling and Running the Tests
  4. Notes on Implementation

1. Installation

Initial Setup:

Download vagrant here:

https://www.vagrantup.com/downloads.html

Follow these instructions for Project Setup for your vagrant vm:

https://www.vagrantup.com/intro/getting-started/project_setup.html

Install the box:

Use this box: https://app.vagrantup.com/generic/boxes/ubuntu1804 vagrant box add generic/ubuntu1804
Open the Vagrantfile and change its contents to this:
Vagrant.configure("2") do |config|
      config.vm.box = "hashicorp/precise64"
      config.vm.synced_folder ".", "/vagrant"
      config.vm.provision :shell, path: "bootstrap.sh"
end

Create the Shell Script bootstrap.sh

Create the following shell script and save it as bootstrap.sh in the same directory as your Vagrantfile
apt-get update
apt-get install -y apache2
if ! [ -L /var/www ]; then
      rm -rf /var/www
      ln -fs /vagrant /var/www
fi

Run vagrant up then vagrant ssh

Install grpc and protobuf

Use these instructions to install grpc and protobuf: https://github.com/grpc/grpc/blob/master/BUILDING.md
Go to grpc/third_party/protobuf in the grpc repository and run ./autogen.sh, ./configure, make && sudo make install
Go to the root directory of the grpc repository and run sudo make install

Install gtest

sudo apt-get install libgtest-dev
sudo apt-get install cmake cd /usr/src/gtest sudo cmake CMakeLists.txt sudo make sudo cp *.a /usr/lib

2. Compiling and running the code

Go to 499-jkhoo/cpp and run ./compile_clean to compile everything except tests
Start the Key Value store with ./backend_store
Start the Service Layer with ./service_layer
Run the client layer with ./client_layer and any appropriate flags

Example runs for the client layer:

./client_layer --register <username>registers the given user
./client_layer --user <username> logs in the given user and the --user flag must be before any command other than register
./client_layer --user <username> --chirp <text> creates a new chirp by the user with the given text
./client_layer --user <username> --chirp <text> --reply <parent_id> creates a new chirp by the user with the given text as a reply to the chirp with the given parent_id
./client_layer --user <username> --follow <to_follow> username starts following to_follow
./client_layer --user <username> --read <chirp_id> reads the chirp thread starting at the given id
./client_layer --user <username> --monitor monitors new chirps from those currently followed
./client_layer --user <username> --stream <hashtag> streams new hashtags from any other user (note: hashtag passed to the command line does NOT contain '#' symbol)

3. Compiling and running the tests

Go to 499-jkhoo/tests and run ./test_compile_clean
Run the key value store tests with ./key_value_store_service_impl_tests
Run the service layer tests with ./service_layer_service_impl_tests

4. Notes on implementation

  • --stream is takes string without '#' symbol
  • --stream does not take any hashtag containing a blank space ' ' character, even if it is at the beginning or end of the string