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>
---
 docs/development/devtools/devtools.rst | 49 ++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

(limited to 'docs/development/devtools')

diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index 1e2fd49f..7eb5e064 100644
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -283,3 +283,52 @@ familiar with the Policy Framework components and test any local changes.
    xacml-s3p.rst
    distribution-s3p.rst
 
+Generating Swagger Documentation
+********************************
+The `Policy Parent Integration POM <https://github.com/onap/policy-parent/blob/master/integration/pom.xml>`_ contains a *generateSwaggerDocs* profile. This
+profile can be activated on any module that has a Swagger endopint. When active, this profile creates a tarball in Nexus with the name
+*<project-artifactId>-swagger-docs.tar.gz*. The tarball contains the fillowing files:
+
+.. code-block:: bash
+
+    swagger/swagger.html
+    swagger/swagger.json
+    swagger/swagger.pdf
+
+The profile is activated when:
+
+1. The following property is defined at the top of the *pom.xml* file for a module
+
+    .. code-block:: bash
+
+        <!--  This property triggers generation of the Swagger documents -->
+        <swagger.generation.phase>post-integration-test</swagger.generation.phase>
+
+    See the `CLAMP runtime POM <https://github.com/onap/policy-clamp/blob/master/runtime/pom.xml>`_ for an example of the usage of this property.
+
+2. Unit tests are being executed in the build, in other wirds when the *skipTests* flag is *false*.
+
+You **must** create a unit test in your module that generates the following file:
+
+.. code-block:: bash
+
+    src/test/resources/swagger/swagger.json
+
+Typically, you do this by starting your REST endpoint in a unit test, issuing a REST call to get the Swagger API documentation. The test case below is an example
+of such a test case.
+
+.. code-block:: java
+
+   @Test
+   public void testSwaggerJson() throws Exception {
+       ResponseEntity<String> httpsEntity = getRestTemplate()
+               .getForEntity("https://localhost:" + this.httpsPort + "/restservices/clds/api-doc", String.class);
+       assertThat(httpsEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
+       assertThat(httpsEntity.getBody()).contains("swagger");
+       FileUtils.writeStringToFile(new File("target/swagger/swagger.json"), httpsEntity.getBody(),
+               Charset.defaultCharset());
+   }
+
+See `this unit test case <https://github.com/onap/policy-clamp/blob/master/runtime/src/test/java/org/onap/policy/clamp/clds/it/HttpsItCase.java>`_
+for the full example.
+
-- 
cgit 1.2.3-korg