Organize tools and documentation

Organize tools/deps, examples/android and split compile.sh into build and test

Author: Ofer Bartal

.circleci/config.yml

@@ -61,13 +61,13 @@ jobs:
 
       - run: sudo cp .circleci/bazel.rc /etc/bazel.bazelrc
       - run: bazel info release
-      - run: './tools/get-android-sdk.sh'
+      - run: './tools/get_android_sdk.sh'
       - run:
-          command: ./compile.sh build
+          command: ./build.sh
           environment:
             ANDROID_HOME: /home/circleci/android_sdk/
       - run:
-          command: ./compile.sh test
+          command: ./test.sh
           environment:
             ANDROID_HOME: /home/circleci/android_sdk/
 

README.md

@@ -21,20 +21,11 @@ You can:
 * Use it as a reference and copy-paste parts of it to your own repo.
 * Use parts of it from your own repo. For an example of that, see https://github.com/hasadna/hasadna (look for `@startup_os` in BUILD files)
 
-### Installation
-Install [Bazel](https://docs.bazel.build/versions/master/install.html).
-If you already have Android SDK (i.e. you installed Android Studio, you
-might need to tweak `api_level` and `build_tools_version` in `WORKSPACE`),
-set environment variable `export ANDROID_HOME=<…>` (
-for macOS: `$HOME/Library/Android/sdk/`, for Linux: `$HOME/Android/Sdk`). Otherwise, start from executing
-`./tools/get-android-sdk.sh`
+### Setup
+* Install [Bazel](https://docs.bazel.build/versions/master/install.html)
+* Build all targets: `./build.sh`
+* Run all tests: `./test.sh`
 
-Now you can build any target you want.
-To build all targets:
-  `./compile.sh build`
-
-To run all tests:
-`./compile.sh test`
 
 ### Milestones
 #### ✓ Milestone I

WORKSPACE

@@ -16,7 +16,7 @@ git_repository(
     remote = "https://github.com/oferb/startupos-binaries",
 )
 
-load("//third_party/maven:workspace.bzl", "maven_dependencies")
+load("//third_party/maven:package-lock.bzl", "maven_dependencies")
 
 maven_dependencies()
 

build.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# Build all targets
+tools/build_or_test.sh build

compile.sh

@@ -1,7 +1,20 @@
-This sample project is intended to be used as a template for Android app which uses Firestore and is
-built via Bazel build system.
+# Android sample project
+
+This sample project is intended to be used as a template for an Android app that uses Firestore.
 
 To get it running:
-* Create a new project [here](https://console.firebase.google.com/)
+* Configure Android SDK (see below).
+* Create a new project [here](https://console.firebase.google.com/).
 * Download `google-services.json` config file and put it in `src/main/assets/` folder.
-* Configure `android_sdk_repository` in WORKSPACE as described there (set `ANDROID_HOME` env variable)
+
+## Configuring Android SDK
+There are 2 options for configuring the Android SDK.
+### Downloading an Android SDK
+Set `ANDROID_HOME` to your desired SDK location, then run:
+`./tools/get_android_sdk.sh`
+
+### Working with an existing Android SDK
+If you already have Android SDK on your machine (i.e. you've installed Android Studio), and you want to use it, then
+set `ANDROID_HOME` to it (e.g `export ANDROID_HOME=/your/sdk/location`). Typical locations for the SDK are `$HOME/Library/Android/sdk/` for macOS, and `$HOME/Android/Sdk` for Linux.
+
+You might need to set `api_level` and `build_tools_version` in the `android_sdk_repository` rule in `WORKSPACE`, to match those you have in the SDK folder. For more details on `android_sdk_repository`, see [Bazel's documentation](https://docs.bazel.build/versions/master/be/android.html#android_sdk_repository).

examples/android/README.md

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# Test all targets
+tools/build_or_test.sh test

test.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+# Build or test all targets.
+# Note that 'testing all targets' also builds all buildable targets.
+# If ANDROID_HOME is not set, skips Android targets.
+
+# Usage: tools/build_or_test.sh (build|test)
+
+RED=$(tput setaf 1)
+RESET=$(tput sgr0)
+
+# Warn if ANDROID_HOME is not set.
+if [[ -z "$ANDROID_HOME" ]]; then
+  echo "$RED""ANDROID_HOME not set, skipping Android targets. See examples/android for more details.$RESET"
+fi
+
+# Check we have (build|test) param
+if [[ $1 != "build" && $1 != "test" ]]; then
+  echo "$RED""Run script with 'build' or 'test' as param$RESET"
+  exit 1
+fi
+
+if [[ -z "$ANDROID_HOME" ]]; then
+  # Ignore third_party, node_modules and android targets
+  bazel query '//... except //third_party/... except filter(node_modules, //...) except kind("android_.* rule", //...)' | xargs bazel $1
+else
+  # Ignore just third_party and node_modules 
+  bazel query '//... except //third_party/... except filter(node_modules, //...)' | xargs bazel $1
+fi
+
+exit $?