From e1fdd1ac205916df7af285fcbb556b63aacd620c Mon Sep 17 00:00:00 2001
From: Oliver Smith <osmith@sysmocom.de>
Date: Tue, 13 Nov 2018 14:35:22 +0100
Subject: tests: add shared content pdf build tests

Build project independent "test-usermanual.pdf" (with all common
chapters automatically included) and "test-vty-reference.pdf" files.

This allows testing if changed common chapters and the build scripts
are still working, even when the project specific manuals will be moved
away from this repository.

(moving manuals to project repositories 2/19)

Related: OS#3386
Change-Id: Ia74e32678c95e22ba493e80d0a4a8f783c5a5ddf
---
 .gitignore                        |  1 +
 Makefile                          |  2 ++
 tests/Makefile                    | 30 ++++++++++++++++++++++++++++++
 tests/test-usermanual-docinfo.xml | 31 +++++++++++++++++++++++++++++++
 tests/test-vty-reference.xml      | 38 ++++++++++++++++++++++++++++++++++++++
 tests/vty/test_vty_additions.xml  |  2 ++
 tests/vty/test_vty_reference.xml  | 17 +++++++++++++++++
 7 files changed, 121 insertions(+)
 create mode 100644 tests/Makefile
 create mode 100644 tests/test-usermanual-docinfo.xml
 create mode 100644 tests/test-vty-reference.xml
 create mode 100644 tests/vty/test_vty_additions.xml
 create mode 100644 tests/vty/test_vty_reference.xml

diff --git a/.gitignore b/.gitignore
index 3c72c7f..1e0984f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,4 @@
 *__*.svg
 *.check
 generated/
+tests/test-usermanual.adoc
diff --git a/Makefile b/Makefile
index eb3be75..c94f0a8 100644
--- a/Makefile
+++ b/Makefile
@@ -17,6 +17,7 @@ all: check-deps
 	cd OsmoTRX; $(MAKE)
 
 clean:
+	cd tests; $(MAKE) clean
 	cd OsmoBTS; $(MAKE) clean
 	cd OsmoNITB; $(MAKE) clean
 	cd OsmoBSC; $(MAKE) clean
@@ -53,6 +54,7 @@ upload:
 	cd OsmoTRX; $(MAKE) upload
 
 check:
+	cd tests; $(MAKE)
 	cd OsmoBTS; $(MAKE) check
 	cd OsmoNITB; $(MAKE) check
 	cd OsmoBSC; $(MAKE) check
diff --git a/tests/Makefile b/tests/Makefile
new file mode 100644
index 0000000..0b914e9
--- /dev/null
+++ b/tests/Makefile
@@ -0,0 +1,30 @@
+TOPDIR = ..
+
+# Generate adoc file that includes all chapters
+ASCIIDOC = test-usermanual.adoc
+ASCIIDOC_DEPS =
+$(ASCIIDOC): $(TOPDIR)/common/chapters/*.adoc
+	echo ":gfdl-enabled:" > $@
+	echo ":program-name: Test" >> $@
+	echo "" >> $@
+	echo "Osmo GSM Manuals Shared Content Test" >> $@
+	echo "====================================" >> $@
+	echo "Oliver Smith <osmith@sysmocom.de>" >> $@
+	echo "" >> $@
+	for chapter in $(TOPDIR)/common/chapters/*.adoc; do \
+		echo "include::$${chapter}[]" >> $@; \
+	done;
+CLEAN_FILES = $(ASCIIDOC)
+
+include $(TOPDIR)/build/Makefile.asciidoc.inc
+
+VTY_REFERENCE = test-vty-reference.xml
+include $(TOPDIR)/build/Makefile.vty-reference.inc
+include $(TOPDIR)/build/Makefile.common.inc
+
+
+default: all check
+
+
+.DEFAULT_GOAL := default
+.PHONY: default
diff --git a/tests/test-usermanual-docinfo.xml b/tests/test-usermanual-docinfo.xml
new file mode 100644
index 0000000..4edc233
--- /dev/null
+++ b/tests/test-usermanual-docinfo.xml
@@ -0,0 +1,31 @@
+<revhistory>
+  <revision>
+    <revnumber>1</revnumber>
+    <date>6th November 2018</date>
+    <authorinitials>os</authorinitials>
+    <revremark>Initial</revremark>
+  </revision>
+</revhistory>
+
+<copyright>
+  <year>2018</year>
+  <holder>sysmocom - s.f.m.c. GmbH</holder>
+</copyright>
+
+<legalnotice>
+  <para>
+	Permission is granted to copy, distribute and/or modify this
+	document under the terms of the GNU Free Documentation License,
+	Version 1.3 or any later version published by the Free Software
+	Foundation; with the Invariant Sections being just 'Foreword',
+	'Acknowledgements' and 'Preface', with no Front-Cover Texts,
+	and no Back-Cover Texts.  A copy of the license is included in
+	the section entitled "GNU Free Documentation License".
+  </para>
+  <para>
+	The Asciidoc source code of this manual can be found at
+	<ulink url="http://git.osmocom.org/osmo-gsm-manuals/">
+		http://git.osmocom.org/osmo-gsm-manuals/
+	</ulink>
+  </para>
+</legalnotice>
diff --git a/tests/test-vty-reference.xml b/tests/test-vty-reference.xml
new file mode 100644
index 0000000..8bec1e6
--- /dev/null
+++ b/tests/test-vty-reference.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ex:ts=2:sw=42sts=2:et
+  -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
+-->
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN"
+"http://docbook.org/xml/5.0/dtd/docbook.dtd" [
+<!ENTITY chapter-vty      SYSTEM      "../common/chapters/vty.xml" >
+<!ENTITY sections-vty     SYSTEM      "generated/docbook_vty.xml"  >
+]>
+
+<book>
+  <info>
+    <revhistory>
+        <revision>
+            <revnumber>v1</revnumber>
+            <date>6th November 2018</date>
+            <authorinitials>os</authorinitials>
+            <revremark>Initial</revremark>
+        </revision>
+    </revhistory>
+
+    <title>Test VTY Reference</title>
+
+    <copyright>
+      <year>2018</year>
+    </copyright>
+
+    <legalnotice>
+      <para>This work is copyrighted by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved.
+      </para>
+    </legalnotice>
+  </info>
+
+  <!-- Main chapters-->
+  &chapter-vty;
+</book>
+
diff --git a/tests/vty/test_vty_additions.xml b/tests/vty/test_vty_additions.xml
new file mode 100644
index 0000000..a4c675e
--- /dev/null
+++ b/tests/vty/test_vty_additions.xml
@@ -0,0 +1,2 @@
+<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
+</vtydoc>
diff --git a/tests/vty/test_vty_reference.xml b/tests/vty/test_vty_reference.xml
new file mode 100644
index 0000000..e5674e7
--- /dev/null
+++ b/tests/vty/test_vty_reference.xml
@@ -0,0 +1,17 @@
+<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
+  <node id='_common_cmds_'>
+    <name>Common Commands</name>
+    <description>These commands are available on all VTY nodes. They are listed here only once, to unclutter the VTY reference.</description>
+    <command id='help'>
+      <params>
+        <param name='help' doc='Description of the interactive help system' />
+      </params>
+    </command>
+    <command id='list'>
+      <params>
+        <param name='list' doc='Print command list' />
+      </params>
+    </command>
+    <!-- (...) -->
+  </node>
+</vtydoc>
-- 
cgit v1.2.3