.test.sh

#!/bin/bash -e

# Copyright 2016 Google Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
# in compliance with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License
# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
# or implied. See the License for the specific language governing permissions and limitations under
# the License.

# This file tests (most of) the notebooks in this repository using nbconvert.
#
# A number of the notebooks have prerequisites for passing, so make sure that
# you have
#
#  1. Signed in via gcloud
#  2. Created a Google Cloud Platform project and set its ID in the 'PROJECT_ID'
#     environment variable.
#  3. Enabled billing in that project.
#  4. Enabled the Compute Engine API and Machine Learning Engine API in that project.
#  4. Created at least one Google Compute Engine VM in that project (this is
#     required by the monitoring 'Getting Started' notebook).
#  5. Created a Stackdriver account, and a Stackdriver group containing one or
#     more Google Compute Engine VMs (this is required by the monitoring 'Group
#     metrics' notebook).
#
# To ensure you have the necessary Datalab dependencies installed, you should
# run this inside of the latest Datalab image using the following command
# (assuming you have set the 'PROJECT_ID' variable to your test project):
#
#    docker run -it -v "$(pwd):/content/notebooks" \
#      -v "${HOME}:/content/datalab" \
#      -e "CLOUDSDK_CORE_PROJECT=${PROJECT_ID}" \
#      -e "GOOGLE_APPLICATION_CREDENTIALS=/content/datalab/.config/gcloud/application_default_credentials.json" \
#      --entrypoint /content/notebooks/.test.sh \
#      --workdir /content/notebooks \
#      gcr.io/cloud-datalab/datalab

EXCLUDE_NOTEBOOKS=(
"Group metrics.ipynb"
"Getting started.ipynb"
"Introduction to Python.ipynb"
"UDFs using Code in Cloud Storage.ipynb"
"LSTM Punctuation Model With TensorFlow.ipynb"  # This notebook takes 60 minutes to execute.
"Image-to-Captions Model with TensorFlow.ipynb" # This notebook takes 120 minutes to execute.
"Basic RNN TensorFlow Model Trained on Simulated Data.ipynb" # This notebook takes 10 minutes to execute.
"Text Classification with TensorFlow.ipynb" # This notebook takes 10 minutes to execute.
)

# samples/ML Toolbox/Classification/* is tested.
# Image Classification notebooks take too long to execute.
# contrib is experimental
EXCLUDE_FOLDERS=(
"samples/ML Toolbox/Regression/*"
"samples/ML Toolbox/Image Classification/*"
"samples/contrib/*"
)

function testNotebooks() {
    DIR="${1:-./}"
    IFS=$'\n'
    FAILED_NOTEBOOKS=""
    SEP=$'\n\t'
    COUNT="0"
    EXCLUDE_ARGS=""
    for EXCLUDED_NOTEBOOK in "${EXCLUDE_NOTEBOOKS[@]}"; do
        EXCLUDE_ARGS="${EXCLUDE_ARGS} -and -not -name '${EXCLUDED_NOTEBOOK}'"
    done
    for EXCLUDED_FOLDER in "${EXCLUDE_FOLDERS[@]}"; do
        EXCLUDE_ARGS="${EXCLUDE_ARGS} -and -not -path '${DIR}${EXCLUDED_FOLDER}'"
    done
    SEARCH_CMD="find ${DIR} -name '*.ipynb'${EXCLUDE_ARGS}"
    echo "Search command: ${SEARCH_CMD}"
    for NOTEBOOK in `eval "${SEARCH_CMD}"`; do
        echo "Testing ${NOTEBOOK}"
        jupyter nbconvert --ExecutePreprocessor.enabled=True --ExecutePreprocessor.timeout=300 "${NOTEBOOK}" || FAILED_NOTEBOOKS="${FAILED_NOTEBOOKS}${SEP}${NOTEBOOK}"
        COUNT=$(expr ${COUNT} + 1)
    done
    if [ -n "${FAILED_NOTEBOOKS}" ]; then
        echo "Validation failed for the following notebooks:${FAILED_NOTEBOOKS}"
        exit 1
    else
        echo "Validation passed for ${COUNT} notebooks"
    fi
}

# If a service account credentials file is specified, configure
# gcloud to use the specified service account credentials
if [ -n "${GOOGLE_APPLICATION_CREDENTIALS}" ]; then
  gcloud auth activate-service-account --key-file="${GOOGLE_APPLICATION_CREDENTIALS}"
fi

# Tell bash to exit the script completely rather than just killing the current command.
trap "exit" INT

DIR="${1:-./}"

first_account=`gcloud auth list --format="value(account)" --limit=1`
active_account=`gcloud auth list --filter="status=ACTIVE" --format="value(account)"`
if [ -z "${active_account}" ]; then
    gcloud config set account "${first_account}"
fi


# Check if this container has Conda, if so ensure we're in the correct Conda environment.
if [ -r "$(command -v activate)" ]; then
  source activate "py3env"
  testNotebooks ${DIR}
  source deactivate
else
  testNotebooks ${DIR}
fi