From 39766fcb7b41a2065599889b3e912ca402eeb3ac Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Tue, 25 Feb 2020 14:14:36 +0100
Subject: Add tests for QDoc's prepare and generate phases

The prepare test includes validating the generated .index file.

Fixes: QTBUG-82716
Change-Id: I673cf39965c81cf02b8c68e0319b45c909664917
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
---
 .../generatedoutput/expected_output/testcpp.index  | 39 ++++++++++++++++++++++
 .../testdata/configs/testcpp.qdocconf              |  1 +
 .../qdoc/generatedoutput/tst_generatedoutput.cpp   | 18 ++++++++++
 3 files changed, 58 insertions(+)
 create mode 100644 tests/auto/qdoc/generatedoutput/expected_output/testcpp.index

(limited to 'tests')

diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index b/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index
new file mode 100644
index 000000000..36f8e72af
--- /dev/null
+++ b/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE QDOCINDEX>
+<INDEX url="" title="TestCPP Reference Documentation" version="" project="TestCPP">
+    <namespace name="" status="active" access="public" module="testcpp">
+        <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="true" meta="macrowithoutparams" virtual="non" const="false" static="false" final="false" override="false" type="" signature="QDOCTEST_MACRO"/>
+        <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="true" since="Test 1.1" meta="macrowithparams" virtual="non" const="false" static="false" final="false" override="false" type="" brief="A macro with argument x" signature="QDOCTEST_MACRO2( x)">
+            <parameter type="" name="x" default=""/>
+        </function>
+        <namespace name="TestQDoc" href="testqdoc.html" status="active" access="public" location="testcpp.h" documented="true" module="TestCPP" brief="A namespace">
+            <contents name="usage" title="Usage" level="1"/>
+            <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="true" meta="macrowithoutparams" virtual="non" const="false" static="false" final="false" override="false" type="" signature="QDOCTEST_MACRO"/>
+            <class name="Test" fullname="TestQDoc::Test" href="testqdoc-test.html" status="active" access="public" location="testcpp.h" documented="true" module="TestCPP" brief="A class in a namespace">
+                <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="true" since="Test 1.1" meta="macrowithparams" virtual="non" const="false" static="false" final="false" override="false" type="" brief="A macro with argument x" signature="QDOCTEST_MACRO2( x)">
+                    <parameter type="" name="x" default=""/>
+                </function>
+                <function name="anotherObsoleteMember" fullname="TestQDoc::Test::anotherObsoleteMember" href="testqdoc-test-obsolete.html#anotherObsoleteMember" status="obsolete" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void anotherObsoleteMember()"/>
+                <function name="deprecatedMember" fullname="TestQDoc::Test::deprecatedMember" href="testqdoc-test-obsolete.html#deprecatedMember" status="obsolete" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void deprecatedMember()"/>
+                <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"/>
+                <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="obsolete" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void obsoleteMember()"/>
+                <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void overload()"/>
+                <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" meta="plain" virtual="non" const="false" static="false" final="false" override="false" overload="true" overload-number="1" type="void" signature="void overload(bool b)">
+                    <parameter type="bool" name="b" default=""/>
+                </function>
+                <function name="someFunction" fullname="TestQDoc::Test::someFunction" href="testqdoc-test.html#someFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="int" signature="int someFunction(int v)">
+                    <parameter type="int" name="v" default=""/>
+                </function>
+                <function name="someFunctionDefaultArg" fullname="TestQDoc::Test::someFunctionDefaultArg" href="testqdoc-test.html#someFunctionDefaultArg" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="non" const="false" static="false" final="false" override="false" type="void" signature="void someFunctionDefaultArg(int i, bool b)">
+                    <parameter type="int" name="i" default=""/>
+                    <parameter type="bool" name="b" default="false"/>
+                </function>
+                <function name="virtualFun" fullname="TestQDoc::Test::virtualFun" href="testqdoc-test.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" const="false" static="false" final="false" override="false" type="void" signature="void virtualFun()"/>
+            </class>
+            <class name="TestDerived" fullname="TestQDoc::TestDerived" href="testqdoc-testderived.html" status="active" access="public" location="testcpp.h" documented="true" bases="TestQDoc::Test" module="TestCPP" brief="A derived class in a namespace">
+                <function name="virtualFun" fullname="TestQDoc::TestDerived::virtualFun" href="testqdoc-testderived.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" const="false" static="false" final="false" override="true" type="void" signature="void virtualFun() override"/>
+            </class>
+        </namespace>
+        <module name="TestCPP" href="testcpp-module.html" status="active" documented="true" seen="true" title="QDoc Test C++ Classes" module="TestCPP" members="TestCPP,TestQDoc,Test,TestDerived,QDOCTEST_MACRO,QDOCTEST_MACRO2,deprecatedMember,obsoleteMember,anotherObsoleteMember,someFunctionDefaultArg,someFunction,inlineFunction,virtualFun,virtualFun," brief="A test module page"/>
+    </namespace>
+</INDEX>
diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/testcpp.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/testcpp.qdocconf
index 80ac58475..ff10ae4be 100644
--- a/tests/auto/qdoc/generatedoutput/testdata/configs/testcpp.qdocconf
+++ b/tests/auto/qdoc/generatedoutput/testdata/configs/testcpp.qdocconf
@@ -5,3 +5,4 @@ headers = ../testcpp/testcpp.h
 sources = ../testcpp/testcpp.cpp
 
 macro.CMDFN = \\\\fn
+locationinfo = false
diff --git a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp
index 20becc713..5449a50e2 100644
--- a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp
+++ b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp
@@ -65,6 +65,8 @@ private slots:
     void crossModuleLinking();
     void includeFromExampleDirs();
     void singleExec();
+    void preparePhase();
+    void generatePhase();
 
 private:
     QScopedPointer<QTemporaryDir> m_outputDir;
@@ -359,6 +361,22 @@ void tst_generatedOutput::singleExec()
                    "-single-exec");
 }
 
+void tst_generatedOutput::preparePhase()
+{
+    testAndCompare("testdata/configs/testcpp.qdocconf",
+                   "testcpp.index",
+                   "-prepare");
+}
+
+void tst_generatedOutput::generatePhase()
+{
+    testAndCompare("testdata/configs/testcpp.qdocconf",
+                   "testcpp-module.html "
+                   "testqdoc-test.html "
+                   "testqdoc-test-members.html "
+                   "testqdoc.html",
+                   "-generate");
+}
 
 QTEST_APPLESS_MAIN(tst_generatedOutput)
 
-- 
cgit v1.2.3