From f8e594c9e99608c36dda1a021cdad553a2b92ef1 Mon Sep 17 00:00:00 2001
From: Bo Zhou <2466956298@qq.com>
Date: Tue, 9 Jul 2019 13:25:37 +0800
Subject: [PATCH] add unittest for compling the docs (#87)

* add unittest for compling the docs

* record the time of change

* remove unused requirements

* reduce font size of the changelog
---
 .teamcity/CHANGELOG.md |  3 +++
 .teamcity/Dockerfile   |  2 +-
 .teamcity/build.sh     | 18 ++++++++++++++++++
 CMakeLists.txt         | 12 ++++++++++++
 docs/test.sh           |  7 +++++++
 5 files changed, 41 insertions(+), 1 deletion(-)
 create mode 100644 .teamcity/CHANGELOG.md
 create mode 100644 docs/test.sh

diff --git a/.teamcity/CHANGELOG.md b/.teamcity/CHANGELOG.md
new file mode 100644
index 0000000..081d59a
--- /dev/null
+++ b/.teamcity/CHANGELOG.md
@@ -0,0 +1,3 @@
+### [2019-07-09] 1.1-cuda9.0-cudnn7-docs:
+add unnit test for compling the docs
+  - add an envionment `docs` in anaconda 
diff --git a/.teamcity/Dockerfile b/.teamcity/Dockerfile
index ca88356..da98d19 100644
--- a/.teamcity/Dockerfile
+++ b/.teamcity/Dockerfile
@@ -15,7 +15,7 @@
 
 # A dev image based on paddle production image
 
-FROM parl/parl-test:1.1-cuda9.0-cudnn7-v2
+FROM parl/parl-test:1.1-cuda9.0-cudnn7-docs
 
 COPY ./requirements.txt /root/
 
diff --git a/.teamcity/build.sh b/.teamcity/build.sh
index 9e55dcb..1fcb11b 100755
--- a/.teamcity/build.sh
+++ b/.teamcity/build.sh
@@ -102,6 +102,23 @@ EOF
     rm -rf ${REPO_ROOT}/build
 }
 
+function run_docs_test {
+    #export CUDA_VISIBLE_DEVICES=""
+
+    mkdir -p ${REPO_ROOT}/build
+    cd ${REPO_ROOT}/build
+
+    cmake .. -DIS_TESTING_DOCS=ON 
+
+    cat <<EOF
+    ========================================
+    Running docs test...
+    ========================================
+EOF
+    ctest --output-on-failure
+    rm -rf ${REPO_ROOT}/build
+}
+
 function main() {
     set -e
     local CMD=$1
@@ -119,6 +136,7 @@ function main() {
           run_test_with_gpu
           run_test_with_cpu
           run_import_test
+          run_docs_test
           ;;
         *)
           print_usage
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 543b472..6a32de0 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -18,6 +18,7 @@ enable_testing()
 
 option(WITH_TESTING "Include unit testing" ON)
 option(IS_TESTING_IMPORT "Whether is testing import parl" OFF)
+option(IS_TESTING_DOCS "Whether is testing compling the docs" OFF)
 
 set(PADDLE_PYTHON_PATH "" CACHE STRING "Python path to PaddlePaddle Fluid")
 
@@ -41,20 +42,31 @@ function(import_test TARGET_NAME)
     set(oneValueArgs "")
     set(multiValueArgs SRCS DEPS ARGS ENVS)
     cmake_parse_arguments(py_test "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
     add_test(NAME ${TARGET_NAME}_with_empty_env
         COMMAND env PYTHONPATH=.:${py_test_ENVS}
         /root/miniconda3/envs/empty_env/bin/python -u ${py_test_SRCS} ${py_test_ARGS}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+
     add_test(NAME ${TARGET_NAME}_with_paddle1.4.0
         COMMAND env PYTHONPATH=.:${py_test_ENVS}
         /root/miniconda3/envs/paddle1.4.0/bin/python -u ${py_test_SRCS} ${py_test_ARGS}
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+
+endfunction()
+
+function(docs_test)
+    add_test(NAME compling_docs_test
+        COMMAND bash ./docs/test.sh
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
 endfunction()
 
 if (WITH_TESTING)
     if (IS_TESTING_IMPORT)
         set(src "parl/tests/import_test")
         import_test(${src} SRCS ${src}.py ENVS ${PADDLE_PYTHON_PATH})
+      elseif (IS_TESTING_DOCS)
+        docs_test()
     else ()
         file(GLOB_RECURSE TEST_OPS RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}" "*_test.py")
         string(REPLACE ".py" "" TEST_OPS "${TEST_OPS}")
diff --git a/docs/test.sh b/docs/test.sh
new file mode 100644
index 0000000..86235c1
--- /dev/null
+++ b/docs/test.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+cd "$(dirname "$0")"
+source ~/.bashrc
+export PATH="/root/miniconda3/bin:$PATH"
+source activate docs
+pip install -i https://pypi.tuna.tsinghua.edu.cn/simple /work/
+make html
-- 
GitLab