cleanup + update parts of README (#78)

Author: melodychn

README.md

@@ -1,9 +1,6 @@
 # GreySwan
 
-## Config frontend project
-Run `yarn` in `./frontend` to install dependencies.
-
-## Run locally
+## Run project locally
 ```
 // From frontend directory
 yarn local
@@ -12,6 +9,34 @@ mvn appengine:run
 // From python directory
 python3.7 main.py
 ```
+*See `key.json` section if you don't already have the key locally.
+
+## Project set up
+### Frontend
+1) Install Node v10.21.0.
+```
+nvm install v10.21.0
+nvm list // Make sure v10.21.0 is included.
+nvm use 10.21.0
+```
+2) Make sure you have `yarn` installed.
+3) Run `yarn` in `./frontend` to install dependencies.
+### Java Backend
+1) Follow [instructions](https://cloud.google.com/sdk/docs/downloads-apt-ge) to install gCloud SDK.
+2) Run `gcloud init` in root directory of our repository. Provide `greyswan` as gCloud project ID. 
+3) Install Maven locally.
+```
+sudo apt update
+sudo apt install maven
+mvn -version // Check if maven is installed.
+```
+4) Make sure you have Java 8 installed locally. If not, follow instructions [here](https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html).
+### Python Microservice
+1) Make sure you have Python 3.7 and pip3 installed.
+2) To install dependencies:
+```
+pip3 install -r requirements.txt
+```
 
 ## Testing
 ```
@@ -21,18 +46,8 @@ mvn test
 yarn test
 ```
 
-## Setting up and running Python code
-To install dependencies: (Only need to run once.)
-```
-pip3 install -r requirements.txt
-```
-To run server locally (make sure you're in `python` directory and `key.json` is present):
-```
-python3.7 main.py
-```
-
-## Deploy to gcloud
-Only need to do for first time. If you're using cloud shell, should not need following commands.
+## Deploy to gCloud
+Only need to do for first time in project root directory. If you're using cloud shell, should not need following commands.
 ```
 gcloud init
 gcloud config set project greyswan

backend/src/main/java/com/google/blackswan/mock/Constant.java

@@ -22,6 +22,10 @@
 
 /** Constants used throughout the blackswan mock classes. */
 public final class Constant {
+  // Only set to false, when you're pushing to Github or do 
+  // not have access to key.json. 
+  public static final boolean USE_CLOUD_STORAGE = false;
+  
   // Constants used to filenames. 
   private static final String FILE_DELIMITER = "-";
   private static final String FILE_END = "--data.csv";

backend/src/main/java/com/google/blackswan/mock/SimpleAnomalyGenerator.java

@@ -41,7 +41,8 @@ public class SimpleAnomalyGenerator implements AnomalyGenerator {
   private static final int THRESHOLD = 13;
   private static final int NUM_POINTS = 5;
   /** Ideally the FileSystem should be injected. */
-  private static final FileSystem FILE_SYSTEM = LocalFileSystem.createSystem();
+  private static final FileSystem FILE_SYSTEM = Constant.USE_CLOUD_STORAGE ? 
+      CloudFileSystem.createSystem() : LocalFileSystem.createSystem();
 
   private final ImmutableList<Anomaly> anomalies;
   private final DataInfo topic;
@@ -50,8 +51,6 @@ public class SimpleAnomalyGenerator implements AnomalyGenerator {
   public static SimpleAnomalyGenerator createGenerator(DataInfo topic) {
     return new SimpleAnomalyGenerator(
       topic,
-      // For [push] to git, always use LocalFileSystem, as CloudFileSystem will fail 
-      // unit test without access to key.json. 
       FILE_SYSTEM.getDataAsStream(topic),
       THRESHOLD,
       NUM_POINTS
@@ -101,10 +100,6 @@ private ImmutableList<Anomaly> generateAnomalies(int threshold, int numDataPoint
         .collect(ImmutableList.toImmutableList());
   }
 
-  /** 
-   * TODO: Depending on size of future data, alter algorithm of finding 
-   * associated data points. 
-   */
   private Anomaly createAnomalyFromDataPoint(Timestamp time, int numDataPoints) {
 
     // Convert keys into ArrayList.
@@ -133,7 +128,8 @@ private Anomaly createAnomalyFromDataPoint(Timestamp time, int numDataPoints) {
                         listKeys.get(firstDataPointIndex),
                         listKeys.get(lastDataPointIndex));
 
-    return new Anomaly(time, topic.getMetricName(), topic.getDimensionName(), dataPoints, relatedDataList);
+    return new Anomaly(time, topic.getMetricName(), topic.getDimensionName(), 
+        dataPoints, relatedDataList);
   }
 
 }

backend/src/main/java/com/google/blackswan/mock/SimpleRelatedDataGenerator.java

@@ -36,8 +36,10 @@
 public class SimpleRelatedDataGenerator implements RelatedDataGenerator {
   private static final String CONFIG_USERNAME = "catyu@";
   /** Ideally should be injected. Currently, putting as class variable. */
-  private static final FileSystem FILE_SYSTEM = LocalFileSystem.createSystem();
-  private static final SimpleRelatedDataGenerator INSTANCE = new SimpleRelatedDataGenerator();
+  private static final FileSystem FILE_SYSTEM = Constant.USE_CLOUD_STORAGE ? 
+      CloudFileSystem.createSystem() : LocalFileSystem.createSystem();
+  private static final SimpleRelatedDataGenerator INSTANCE 
+      = new SimpleRelatedDataGenerator();
 
   private Multimap<DataInfo, DataInfoUser> relatedDataMap;
   private Map<DataInfo, Map<Timestamp, Integer>> csvDataCache;

dispatch.yaml

@@ -1,10 +1,13 @@
 # Rules for dispatch file...
 dispatch:
-# Route the urls that point to the Java backend's API calls
+# Route the urls that point to the Java backend's API calls.
  - url: "*/api/v1/*"
    service: backend
  - url: "*/blackswan/*"
    service: backend
-# Route all other urls to the React.js frontend
+# Route the urls that point to Python backend's API calls.
+ - url: "*/python/*"
+   service: python
+# Route all other urls to the React.js frontend.
  - url: "*/*"
    service: default