aboutsummaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@ericsson.com>2018-09-05 15:46:31 +0100
committerliamfallon <liam.fallon@ericsson.com>2018-09-06 13:26:24 +0100
commita41c877a6b1980e0e866699633e0289d9a3fdbb5 (patch)
tree4f8d15559549760c2e74880871ec08c3b8df2d0e /tools
parent825ae627d4378c5cc7ab4b7d5f4b4ffefcb7977e (diff)
Fix package of apex examples and documents
The examples are not packaged correctly in the apex build and the client wars are missing The links and location of the documents are corrected. Some POM duplicate dependencies removed. Javadoc warnings removed. Issue-ID: POLICY-867 Change-Id: I555c29191c61c0a9887365d95005dbc584eddf04 Signed-off-by: liamfallon <liam.fallon@ericsson.com>
Diffstat (limited to 'tools')
-rwxr-xr-xtools/scripts/clear-site.sh83
-rwxr-xr-xtools/scripts/copy-css.sh47
-rw-r--r--tools/simple-wsclient/pom.xml8
-rw-r--r--tools/tools-common/src/test/java/org/onap/policy/apex/tools/common/docs/ExampleCliParser.java14
4 files changed, 142 insertions, 10 deletions
diff --git a/tools/scripts/clear-site.sh b/tools/scripts/clear-site.sh
new file mode 100755
index 000000000..c72e9f16e
--- /dev/null
+++ b/tools/scripts/clear-site.sh
@@ -0,0 +1,83 @@
+#!/usr/bin/env bash
+
+#-------------------------------------------------------------------------------
+# ============LICENSE_START=======================================================
+# Copyright (C) 2016-2018 Ericsson. All rights reserved.
+# ================================================================================
+# 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=========================================================
+#-------------------------------------------------------------------------------
+
+##
+## Script to clear all created site artifacts, so all target/site for all modules plus target/ad-site on parrent.
+## Call -h for help
+##
+## @author Sven van der Meer <sven.van.der.meer@ericsson.com>
+## @version v2.0.0
+
+
+##
+## DO NOT CHANGE CODE BELOW, unless you know what you are doing
+##
+
+## script name for output
+MOD_SCRIPT_NAME=`basename $0`
+
+
+##
+## Help screen and exit condition (i.e. too few arguments)
+##
+Help()
+{
+ echo ""
+ echo "$MOD_SCRIPT_NAME - remove all generated site artifacts."
+ echo ""
+ echo " Usage: $MOD_SCRIPT_NAME [options]"
+ echo ""
+ echo " Options"
+ echo " -x - execute the delete actions"
+ echo " -h - this help screen"
+ echo ""
+ echo ""
+ exit 255;
+}
+if [ $# -eq 0 ]; then
+ Help
+fi
+
+while [ $# -gt 0 ]
+do
+ case $1 in
+ # -x do clear
+ -x)
+ echo
+ echo "$MOD_SCRIPT_NAME: removing generated sites in all modules"
+ for dir in `find -type d -name "site"|grep "/target/"`
+ do
+ echo "--> removing $dir"
+ rm -fr $dir
+ done
+ echo "--> removing target/ad-site"
+ rm -fr target/ad-site
+ exit
+ ;;
+
+ #-h prints help and exists
+ -h) Help;exit 0;;
+
+ *) echo "$MOD_SCRIPT_NAME: undefined CLI option - $1"; exit 255;;
+ esac
+done
+
diff --git a/tools/scripts/copy-css.sh b/tools/scripts/copy-css.sh
new file mode 100755
index 000000000..7603c0d41
--- /dev/null
+++ b/tools/scripts/copy-css.sh
@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+#-------------------------------------------------------------------------------
+# ============LICENSE_START=======================================================
+# Copyright (C) 2016-2018 Ericsson. All rights reserved.
+# ================================================================================
+# 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=========================================================
+#-------------------------------------------------------------------------------
+
+##
+## Script to copy css artifacts from parent to all child modules, recursively.
+##
+## @author Sven van der Meer <sven.van.der.meer@ericsson.com>
+## @version v2.0.0
+
+
+##
+## DO NOT CHANGE CODE BELOW, unless you know what you are doing
+##
+
+## script name for output
+MOD_SCRIPT_NAME=`basename $0`
+
+echo
+echo "$MOD_SCRIPT_NAME: copying standard css and images to modules"
+for dir in `find -type d -name "site"|grep "/src"|grep "./modules/"`
+do
+ echo "--> copying to $dir"
+ cp -dfrp src/site/css $dir
+ cp -dfrp src/site/images $dir
+done
+
+echo "-> done"
+echo
diff --git a/tools/simple-wsclient/pom.xml b/tools/simple-wsclient/pom.xml
index be18247d8..9437f6216 100644
--- a/tools/simple-wsclient/pom.xml
+++ b/tools/simple-wsclient/pom.xml
@@ -30,10 +30,6 @@
<name>${project.artifactId}</name>
<description>[${project.parent.artifactId}] Simple Websocket client (console and echo)</description>
- <properties>
- <apex-apps-wsclients-simple-dir>${project.basedir}/src</apex-apps-wsclients-simple-dir>
- </properties>
-
<dependencies>
<dependency>
<groupId>org.java-websocket</groupId>
@@ -64,7 +60,7 @@
</descriptorRefs>
<archive>
<manifest>
- <mainClass>org.onap.policy.apex.tools.simple.wsclients.Application</mainClass>
+ <mainClass>org.onap.policy.apex.tools.simple.wsclient.Application</mainClass>
</manifest>
</archive>
</configuration>
@@ -93,4 +89,4 @@
</distributionManagement>
</profile>
</profiles>
-</project> \ No newline at end of file
+</project>
diff --git a/tools/tools-common/src/test/java/org/onap/policy/apex/tools/common/docs/ExampleCliParser.java b/tools/tools-common/src/test/java/org/onap/policy/apex/tools/common/docs/ExampleCliParser.java
index 487bed297..b93038604 100644
--- a/tools/tools-common/src/test/java/org/onap/policy/apex/tools/common/docs/ExampleCliParser.java
+++ b/tools/tools-common/src/test/java/org/onap/policy/apex/tools/common/docs/ExampleCliParser.java
@@ -21,17 +21,23 @@
package org.onap.policy.apex.tools.common.docs;
////
-//// NOTE: This file contains tags for ASCIIDOC
-//// DO NOT REMOVE any of those tag lines, e.g.
-//// //tag::**
-//// //end::**
+////NOTE: This file contains tags for ASCIIDOC
+////DO NOT REMOVE any of those tag lines, e.g.
+//////tag::**
+//////end::**
+////
+////DO NOT auto-refresh imports or organise imports!
////
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.HelpFormatter;
import org.junit.Test;
+
+//tag::import[]
import org.onap.policy.apex.tools.common.CliOptions;
import org.onap.policy.apex.tools.common.CliParser;
+//end::import[]
+
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;