From 920806ab272ba58a369072a5eeb89df5e9b470a6 Mon Sep 17 00:00:00 2001
From: Shivaram Venkataraman <shivaram@cs.berkeley.edu>
Date: Mon, 22 Aug 2016 17:09:32 -0700
Subject: [PATCH] [SPARK-16577][SPARKR] Add CRAN documentation checks to
run-tests.sh
## What changes were proposed in this pull request?
(Please fill in changes proposed in this fix)
## How was this patch tested?
This change adds CRAN documentation checks to be run as a part of `R/run-tests.sh` . As this script is also used by Jenkins this means that we will get documentation checks on every PR going forward.
(If this patch involves UI changes, please attach a screenshot; otherwise, remove this)
Author: Shivaram Venkataraman <shivaram@cs.berkeley.edu>
Closes #14759 from shivaram/sparkr-cran-jenkins.
---
R/check-cran.sh | 18 +++++++++++++++---
R/run-tests.sh | 27 ++++++++++++++++++++++++---
2 files changed, 39 insertions(+), 6 deletions(-)
diff --git a/R/check-cran.sh b/R/check-cran.sh
index 5c90fd07f2..bb331466ae 100755
--- a/R/check-cran.sh
+++ b/R/check-cran.sh
@@ -43,10 +43,22 @@ $FWDIR/create-docs.sh
"$R_SCRIPT_PATH/"R CMD build $FWDIR/pkg
# Run check as-cran.
-# TODO(shivaram): Remove the skip tests once we figure out the install mechanism
-
VERSION=`grep Version $FWDIR/pkg/DESCRIPTION | awk '{print $NF}'`
-"$R_SCRIPT_PATH/"R CMD check --as-cran SparkR_"$VERSION".tar.gz
+CRAN_CHECK_OPTIONS="--as-cran"
+
+if [ -n "$NO_TESTS" ]
+then
+ CRAN_CHECK_OPTIONS=$CRAN_CHECK_OPTIONS" --no-tests"
+fi
+
+if [ -n "$NO_MANUAL" ]
+then
+ CRAN_CHECK_OPTIONS=$CRAN_CHECK_OPTIONS" --no-manual"
+fi
+
+echo "Running CRAN check with $CRAN_CHECK_OPTIONS options"
+
+"$R_SCRIPT_PATH/"R CMD check $CRAN_CHECK_OPTIONS SparkR_"$VERSION".tar.gz
popd > /dev/null
diff --git a/R/run-tests.sh b/R/run-tests.sh
index 9dcf0ace7d..1a1e8ab9ff 100755
--- a/R/run-tests.sh
+++ b/R/run-tests.sh
@@ -26,6 +26,17 @@ rm -f $LOGFILE
SPARK_TESTING=1 $FWDIR/../bin/spark-submit --driver-java-options "-Dlog4j.configuration=file:$FWDIR/log4j.properties" --conf spark.hadoop.fs.default.name="file:///" $FWDIR/pkg/tests/run-all.R 2>&1 | tee -a $LOGFILE
FAILED=$((PIPESTATUS[0]||$FAILED))
+# Also run the documentation tests for CRAN
+CRAN_CHECK_LOG_FILE=$FWDIR/cran-check.out
+rm -f $CRAN_CHECK_LOG_FILE
+
+NO_TESTS=1 NO_MANUAL=1 $FWDIR/check-cran.sh 2>&1 | tee -a $CRAN_CHECK_LOG_FILE
+FAILED=$((PIPESTATUS[0]||$FAILED))
+
+NUM_CRAN_WARNING="$(grep -c WARNING$ $CRAN_CHECK_LOG_FILE)"
+NUM_CRAN_ERROR="$(grep -c ERROR$ $CRAN_CHECK_LOG_FILE)"
+NUM_CRAN_NOTES="$(grep -c NOTE$ $CRAN_CHECK_LOG_FILE)"
+
if [[ $FAILED != 0 ]]; then
cat $LOGFILE
echo -en "\033[31m" # Red
@@ -33,7 +44,17 @@ if [[ $FAILED != 0 ]]; then
echo -en "\033[0m" # No color
exit -1
else
- echo -en "\033[32m" # Green
- echo "Tests passed."
- echo -en "\033[0m" # No color
+ # We have 2 existing NOTEs for new maintainer, attach()
+ # We have one more NOTE in Jenkins due to "No repository set"
+ if [[ $NUM_CRAN_WARNING != 0 || $NUM_CRAN_ERROR != 0 || $NUM_CRAN_NOTES -gt 3 ]]; then
+ cat $CRAN_CHECK_LOG_FILE
+ echo -en "\033[31m" # Red
+ echo "Had CRAN check errors; see logs."
+ echo -en "\033[0m" # No color
+ exit -1
+ else
+ echo -en "\033[32m" # Green
+ echo "Tests passed."
+ echo -en "\033[0m" # No color
+ fi
fi
--
GitLab