songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update testsuite script to last doxygen version

This commit is contained in:
Sébastien Loriot 2023-05-12 19:44:58 +02:00
parent cb11c8a673
commit d23fdd85bf
3 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
Documentation/doc/scripts/process_doc.sh
View File

@ -1,22 +1,22 @@
#!/bin/bash #!/bin/bash
if [ "$1" == '--help' ]; then if [ "$1" == '--help' ]; then
echo "Usage: $0 <doxygen 1.8.4> <doxygen 1.8.13> [publish_dir]" echo "Usage: $0 <doxygen 1.8.13> <doxygen 1.9.6> [publish_dir]"
echo "Compares the output of doxygen 1.8.13 and doxygen master to the one from doxygen 1.8.4, of this CGAL version, " echo "Compares the output of doxygen 1.9.6 and doxygen master to the one from doxygen 1.8.13, of this CGAL version, "
echo "publish_dir is the path to the dir where the testsuite results are kept" echo "publish_dir is the path to the dir where the testsuite results are kept"
echo "$0 must be called from doc/scripts" echo "$0 must be called from doc/scripts"
exit 0 exit 0
fi fi
mkdir -p doc_1_8_4
mkdir -p doc_1_8_13 mkdir -p doc_1_8_13
mkdir -p doc_1_9_6
mkdir -p doc_master mkdir -p doc_master
PATH_TO_1_8_4="$1" PATH_TO_1_8_13="$1"
PATH_TO_1_8_13="$2" PATH_TO_1_9_6="$2"
PUBLISH_DIR="$3" PUBLISH_DIR="$3"
DOXYGEN_1=$($PATH_TO_1_8_4 --version) DOXYGEN_1=$($PATH_TO_1_8_13 --version)
DOXYGEN_2=$($PATH_TO_1_8_13 --version) DOXYGEN_2=$($PATH_TO_1_9_6 --version)
DO_COMPARE=TRUE DO_COMPARE=TRUE
PATH_TO_SCRIPTS=${PWD} PATH_TO_SCRIPTS=${PWD}
@ -52,17 +52,17 @@ cd $PATH_TO_SCRIPTS #scripts
PATH_TO_MASTER="$PWD/doxygen_master/build/bin/doxygen" PATH_TO_MASTER="$PWD/doxygen_master/build/bin/doxygen"
echo "done." echo "done."
echo "comparing versions 1.8.4 and 1.8.13" echo "comparing versions 1.8.13 and 1.9.6"
bash -$- test_doxygen_versions.sh $PATH_TO_1_8_4 $PATH_TO_1_8_13 $PWD/doc_1_8_4 $PWD/doc_1_8_13 $PUBLISH_DIR bash -$- test_doxygen_versions.sh $PATH_TO_1_8_13 $PATH_TO_1_9_6 $PWD/doc_1_8_13 $PWD/doc_1_9_6 $PUBLISH_DIR
if [ ! -d $PWD/doc_1_8_13/doc_log ]; then if [ ! -d $PWD/doc_1_9_6/doc_log ]; then
echo "NO DOC LOGS." echo "NO DOC LOGS."
exit 1 exit 1
fi fi
mv diff.txt diff1.txt mv diff.txt diff1.txt
echo "comparing versions 1.8.4 and master" echo "comparing versions 1.8.13 and master"
if [ "$DO_COMPARE" = "TRUE" ]; then if [ "$DO_COMPARE" = "TRUE" ]; then
bash -$- test_doxygen_versions.sh $PATH_TO_1_8_4 $PATH_TO_MASTER $PWD/doc_1_8_4 $PWD/doc_master $PUBLISH_DIR bash -$- test_doxygen_versions.sh $PATH_TO_1_8_13 $PATH_TO_MASTER $PWD/doc_1_8_13 $PWD/doc_master $PUBLISH_DIR
fi fi
if [ $? -ne 0 ] || [ "$DO_COMPARE" = "FALSE" ]; then if [ $? -ne 0 ] || [ "$DO_COMPARE" = "FALSE" ]; then
DO_COMPARE=FALSE DO_COMPARE=FALSE
@ -74,19 +74,19 @@ fi
#update overview #update overview
CGAL_NAME=$(cat cgal_version) CGAL_NAME=$(cat cgal_version)
if [ "$DO_COMPARE" = "TRUE" ]; then if [ "$DO_COMPARE" = "TRUE" ]; then
python3 ${PWD}/testsuite.py --output-dir1 $PWD/doc_1_8_4/doc_output/ --output-dir2 $PWD/doc_1_8_13/doc_output/ --doc-log-dir1 $PWD/doc_1_8_4/doc_log/ \ python3 ${PWD}/testsuite.py --output-dir1 $PWD/doc_1_8_13/doc_output/ --output-dir2 $PWD/doc_1_9_6/doc_output/ --doc-log-dir1 $PWD/doc_1_8_13/doc_log/ \
--doc-log-dir2 $PWD/doc_1_8_13/doc_log/ --doc-log-dir-master $PWD/doc_master/doc_log/ \ --doc-log-dir2 $PWD/doc_1_9_6/doc_log/ --doc-log-dir-master $PWD/doc_master/doc_log/ \
--publish $PUBLISH_DIR --diff1 $PWD/diff1.txt --diff2 $PWD/diff2.txt --master-dir $PWD/doc_master/doc_output/ \ --publish $PUBLISH_DIR --diff1 $PWD/diff1.txt --diff2 $PWD/diff2.txt --master-dir $PWD/doc_master/doc_output/ \
--cgal-version "$CGAL_NAME" --do-copy-results --version-to-keep 10 --doxygen-version1 "$DOXYGEN_1" --doxygen-version2 "$DOXYGEN_2" --master-describe "$MASTER_DESCRIBE" --cgal-version "$CGAL_NAME" --do-copy-results --version-to-keep 10 --doxygen-version1 "$DOXYGEN_1" --doxygen-version2 "$DOXYGEN_2" --master-describe "$MASTER_DESCRIBE"
else else
echo "NO MASTER" echo "NO MASTER"
python3 ${PWD}/testsuite.py --output-dir1 $PWD/doc_1_8_4/doc_output/ --output-dir2 $PWD/doc_1_8_13/doc_output/ --doc-log-dir1 $PWD/doc_1_8_4/doc_log/ \ python3 ${PWD}/testsuite.py --output-dir1 $PWD/doc_1_8_13/doc_output/ --output-dir2 $PWD/doc_1_9_6/doc_output/ --doc-log-dir1 $PWD/doc_1_8_13/doc_log/ \
--doc-log-dir2 $PWD/doc_1_8_13/doc_log/ --doc-log-dir-master $PWD/doc_master/ \ --doc-log-dir2 $PWD/doc_1_9_6/doc_log/ --doc-log-dir-master $PWD/doc_master/ \
--publish $PUBLISH_DIR --diff1 $PWD/diff1.txt \ --publish $PUBLISH_DIR --diff1 $PWD/diff1.txt \
--cgal-version "$CGAL_NAME" --do-copy-results --version-to-keep 10 --doxygen-version1 "$DOXYGEN_1" --doxygen-version2 "$DOXYGEN_2" --cgal-version "$CGAL_NAME" --do-copy-results --version-to-keep 10 --doxygen-version1 "$DOXYGEN_1" --doxygen-version2 "$DOXYGEN_2"
fi fi
#clean-up #clean-up
rm -rf ./doc_1_8_4 ./doc_1_8_13 ./doc_master #./doxygen_master rm -rf ./doc_1_8_13 ./doc_1_9_6 ./doc_master #./doxygen_master
rm ./diff1.txt ./cgal_version rm ./diff1.txt ./cgal_version
if [ -f ./diff2.txt ]; then if [ -f ./diff2.txt ]; then
rm ./diff2.txt rm ./diff2.txt

20
Documentation/doc/scripts/testsuite.py
View File

@ -1,9 +1,9 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# Copyright (c) 2012 GeometryFactory (France). All rights reserved. # Copyright (c) 2012 GeometryFactory (France). All rights reserved.
# All rights reserved. # All rights reserved.
# #
# This file is part of CGAL (www.cgal.org). # This file is part of CGAL (www.cgal.org).
# #
# $URL$ # $URL$
# $Id$ # $Id$
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
@ -74,7 +74,7 @@ body {color: black; background-color: #C0C0D0; font-family: sans-serif;}
</head><body> </head><body>
<h1 id="maintitle">Doxygen Manual Results</h1>''' <h1 id="maintitle">Doxygen Manual Results</h1>'''
page_footer='''<table border="1" cellspacing="2" cellpadding="5" class="test-results"> page_footer='''<table border="1" cellspacing="2" cellpadding="5" class="test-results">
<tr><td/><th colspan="3">Doxygen 1.8.4</th><th colspan="3">Doxygen 1.8.13(official)</th><th colspan="3">Doxygen master</th></tr> <tr><td/><th colspan="3">Doxygen 1.8.13(patched)</th><th colspan="3">Doxygen 1.9.6(patched)</th><th colspan="3">Doxygen master</th></tr>
<tr> <tr>
<th>Package Name</th> <th>Package Name</th>
<th>Logs </th> <th>Logs </th>
@ -97,7 +97,7 @@ body {color: black; background-color: #C0C0D0; font-family: sans-serif;}
suffix = '' suffix = ''
if args.doxygen_version2: if args.doxygen_version2:
suffix = args.doxygen_version2 suffix = args.doxygen_version2
link2="\n<br><a href=\"output2/Manual/index.html\">Documentation built</a> with <a href=\"https://github.com/CGAL/doxygen\">our fork of Doxygen {_suffix} (used for the official CGAL documentation)</a>\n".format(_suffix=suffix) link2="\n<br><a href=\"output2/Manual/index.html\">Documentation built</a> with <a href=\"https://github.com/CGAL/doxygen\">our fork of Doxygen {_suffix} (used for the official CGAL documentation)</a>\n".format(_suffix=suffix)
suffix = '' suffix = ''
if args.master_describe: if args.master_describe:
suffix=args.master_describe suffix=args.master_describe
@ -205,9 +205,9 @@ def main():
parser.add_argument('--doxygen-version1', default ='', help='Specify this argument if you want to add a version number to the name of the link to the first documentation.') parser.add_argument('--doxygen-version1', default ='', help='Specify this argument if you want to add a version number to the name of the link to the first documentation.')
parser.add_argument('--doxygen-version2', default ='', help='Specify this argument if you want to add a version number to the name of the link to the second documentation.') parser.add_argument('--doxygen-version2', default ='', help='Specify this argument if you want to add a version number to the name of the link to the second documentation.')
parser.add_argument('--master-describe', default ='', help='Specify this argument if you want to add a suffix to the name of the link to the doxygen master documentation.') parser.add_argument('--master-describe', default ='', help='Specify this argument if you want to add a suffix to the name of the link to the doxygen master documentation.')
args = parser.parse_args() args = parser.parse_args()
if args.cgal_version: if args.cgal_version:
version_string="CGAL-"+args.cgal_version version_string="CGAL-"+args.cgal_version
version_date=datetime.datetime.now().strftime("%Y-%m-%d") version_date=datetime.datetime.now().strftime("%Y-%m-%d")
@ -255,7 +255,7 @@ def main():
try: try:
with open(publish_dir + 'index.html') as f: pass with open(publish_dir + 'index.html') as f: pass
except IOError as e: except IOError as e:
print('No index.html in the publish directory found. Writing a skeleton.') print('No index.html in the publish directory found. Writing a skeleton.')
with open(publish_dir + 'index.html', 'w') as f: with open(publish_dir + 'index.html', 'w') as f:
f.write('''<!DOCTYPE html> f.write('''<!DOCTYPE html>
<style type="text/css"> <style type="text/css">
@ -267,10 +267,10 @@ body {color: black; background-color: #C0C0D0; font-family: sans-serif;}
<html><head><title>Manual Testsuite Overview</title></head> <html><head><title>Manual Testsuite Overview</title></head>
<body><h1>Overviewpage of the Doxygen Manual Testsuite</h1> <body><h1>Overviewpage of the Doxygen Manual Testsuite</h1>
<table border="1" cellspacing="2" cellpadding="5" id="revisions" class="rev-table"> <table border="1" cellspacing="2" cellpadding="5" id="revisions" class="rev-table">
<tr><td/><td/><th colspan="2">Doxygen 1.8.4</th><th colspan="2">Doxygen 1.8.13</th><th colspan="2">Doxygen master</th><td/><td/></tr> <tr><td/><td/><th colspan="2">Doxygen 1.8.13</th><th colspan="2">Doxygen 1.9.6</th><th colspan="2">Doxygen master</th><td/><td/></tr>
<tr><th>Revision</th><th>Date</th><th>Warnings</th> <tr><th>Revision</th><th>Date</th><th>Warnings</th>
<th>Errors</th><th>Warnings </th><th>Errors</th><th>Warnings </th><th>Errors </th> <th>Errors</th><th>Warnings </th><th>Errors</th><th>Warnings </th><th>Errors </th>
<th>Diff with doxygen master</th><th>Diff with doxygen 1.8.13</th></tr></table></body>''') <th>Diff with doxygen master</th><th>Diff with doxygen 1.9.6</th></tr></table></body>''')
args_list='' args_list=''
for arg in sys.argv[0:]: for arg in sys.argv[0:]:
args_list+=arg+' ' args_list+=arg+' '
@ -361,6 +361,6 @@ body {color: black; background-color: #C0C0D0; font-family: sans-serif;}
except: except:
sys.stderr.write("Error while writing to "+log_target+". Does it already exists?\n") sys.stderr.write("Error while writing to "+log_target+". Does it already exists?\n")
raise raise
if __name__ == "__main__": if __name__ == "__main__":
main() main()

2
Scripts/developer_scripts/run_doxygen_testsuite
View File

@ -61,7 +61,7 @@ cd "${CGAL_RELEASE_ID}"
PATH=/home/cgal-testsuite/local/bin:$PATH PATH=/home/cgal-testsuite/local/bin:$PATH
export PATH export PATH
cd "$PWD/doc/scripts" cd "$PWD/doc/scripts"
bash -$- ./process_doc.sh /home/cgal-testsuite/local/bin/doxygen /home/mgimeno/bin/doxygen /srv/CGAL/www/Members/Manual_doxygen_test bash -$- ./process_doc.sh /home/cgal-testsuite/bin/doxygen_1_8_13 /home/cgal-testsuite/bin/doxygen_1_9_6 /srv/CGAL/www/Members/Manual_doxygen_test
if head -2 ../../.scm-branch | grep -q cgal/master; then if head -2 ../../.scm-branch | grep -q cgal/master; then
rsync -a --delete "/srv/CGAL/www/Members/Manual_doxygen_test/${CGAL_RELEASE_ID}/output2/" /srv/CGAL/www/doc/master/ rsync -a --delete "/srv/CGAL/www/Members/Manual_doxygen_test/${CGAL_RELEASE_ID}/output2/" /srv/CGAL/www/doc/master/
fi fi