From 123321473628cbacd35963f4f30bf2ab621fd3b7 Mon Sep 17 00:00:00 2001
From: liamfallon <liam.fallon@est.tech>
Date: Thu, 15 Jul 2021 14:59:06 +0100
Subject: Add profile for generating Swagger documents

This commit adds a profile for generating Swagger documents and creating
a tarball containing the swagger.json, swagger.html, and swagger.pdf
files.

The profile is triggered in any module when tsts are enabled (In other
words when the skipTests flag is off), and when the following proerty is
set:
        <swagger.generation.phase>post-integration-test</swagger.generation.phase>

This profile assumes that a unit test exists that creates the following
file:
target/swagger/swagger.json

If this file does not exist, the build will fail if the profile is
invoked.

Therefore, to generate the Swagger documentation tarball, a module must
set the swagger.generation.phase propety AND have a unit test that
generates the swagger.json file.

Issue-ID: POLICY-3424
Change-Id: I8ff769e7a28bf0e00969d1bc677fee6908951d8a
Signed-off-by: liamfallon <liam.fallon@est.tech>
---
 resources/src/main/resources/asciidoc/swagger.adoc |  4 +++
 .../src/main/resources/assemblies/swagger-docs.xml | 40 ++++++++++++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 resources/src/main/resources/asciidoc/swagger.adoc
 create mode 100644 resources/src/main/resources/assemblies/swagger-docs.xml

(limited to 'resources/src/main')

diff --git a/resources/src/main/resources/asciidoc/swagger.adoc b/resources/src/main/resources/asciidoc/swagger.adoc
new file mode 100644
index 00000000..e2543364
--- /dev/null
+++ b/resources/src/main/resources/asciidoc/swagger.adoc
@@ -0,0 +1,4 @@
+include::{generated}/overview.adoc[]
+include::{generated}/paths.adoc[]
+include::{generated}/security.adoc[]
+include::{generated}/definitions.adoc[]
diff --git a/resources/src/main/resources/assemblies/swagger-docs.xml b/resources/src/main/resources/assemblies/swagger-docs.xml
new file mode 100644
index 00000000..1a1934f3
--- /dev/null
+++ b/resources/src/main/resources/assemblies/swagger-docs.xml
@@ -0,0 +1,40 @@
+<!--
+  ============LICENSE_START=======================================================
+   Copyright (C) 2021 Nordix Foundation.
+  ================================================================================
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  SPDX-License-Identifier: Apache-2.0
+  ============LICENSE_END=========================================================
+-->
+
+<assembly>
+    <id>swagger-docs</id>
+    <formats>
+        <format>tar.gz</format>
+    </formats>
+    <includeBaseDirectory>false</includeBaseDirectory>
+    <fileSets>
+        <fileSet>
+            <directory>${project.build.directory}/swagger
+            </directory>
+            <includes>
+                <include>*.json</include>
+                <include>*.html</include>
+                <include>*.pdf</include>
+            </includes>
+            <outputDirectory>${file.separator}swagger</outputDirectory>
+            <lineEnding>unix</lineEnding>
+        </fileSet>
+    </fileSets>
+</assembly>
-- 
cgit 1.2.3-korg