Merge branch 'klpanagi_documentation' into devel (closes #343)

* klpanagi_documentation:
  Code documentation fixes for rapp_web_services
  Updates rapp_testing_tools README.md
  Updates rapp_testing_tools README.md [ci skip]
  Update web services package documentation [ci skip]

Author: athallas

rapp_testing_tools/README.md

@@ -6,109 +6,60 @@ RAPP Testing Tools
 
 Testing tools used for RAPP Platform integration tests.
 
-All tests use the RappCloud python module,[python-rapp-api](https://github.com/rapp-project/rapp-api/tree/master/python), to communicate with RAPP Platform AI modules.
+All tests use the Python implementation of the RAPP Platform API,[rapp-platform-api/python](https://github.com/rapp-project/rapp-api/tree/master/python), to request for .
 
+Test classes inherit from Python unit testing framework, [unittest](https://docs.python.org/2.7/library/unittest.html)
 
 ## Tests Directory
 
-By default, this package containes basic, out-of-the-box, integration tests. These tests are located
+By default, this package containes out-of-the-box, integration tests. These tests are located
 under:
 
-```shell
+```bash
 $ <rapp_testing_tools_package_path>/scripts/default_tests
 ```
 
 
 ## Executing Tests
 
 The rapp_run_test.py script is used in order to execute developed tests.
+The script accept the following arguments:
 
-##### Execution time arguments:
-- [ **-i** ] : Give as input, the test name, to execute.
+- [ **-i** ] : Test filepath, to execute. If empty, all tests under the **default_tests** directory will be executed.
 
-```shell
-$ ./rapp_run_test_.py -i face_detection_test_1.py
+```bash
+$ ./rapp_run_test_.py -i default_tests/face_detection_tests.py
 ```
 
-- [ **-n** ] : Give number of execution of test(s).
+- [ **-n** ] :  Number of times of test(s) execution.
 
-```shell
-$ ./rapp_run_test.py -i face_detection_test_1.py -n 10
+```bash
+$ ./rapp_run_test.py -i default_tests/face_detection_tests.py -n 10
 ```
 
-- [ **-t** ] : Run the test in threaded mode which means that multible invocations can be done, simultaneous. Each test execution is handled by a standalone thread.
+- [ **-t** ] : Run the test in threaded mode. Multible invocations can be done, simultaneous. Each test execution is handled by a single thread.
 
-```shell
-$ ./rapp_run_test.py -i face_detection_test_1.py -n 10 -t
+```bash
+$ ./rapp_run_test.py -i default_tests/face_detection_tests.py -n 10 -t
 ```
 
-
--  [ **-c** ] :  Test classes can be used to execute a spesific family of tests. Using test classes all tests, under this class, will be executed. In most cases a test class is named after the relevant RAPP Platform ROS-Package; [ **face-detection, qr-detection, speech-detection, speech-detection-sphinx4, speech-detection-google, ontology, cognitive, tts** ]
-
-```shell
-$ ./rapp_run_test.py -c face-detection
-```
- 
-
 **Note:**
-If no test_name is provided as argument, all tests located under tests paths
-are executed!!
-
-There are two ways of executing developed tests:
-- Execute directly.
-- Execute under the ROS framework.
-
-### Using the python executable, directly.
-
-The below example executes the qr_detection_test_1, five times in sequential
-mode.
-
-```shell
-$ ./rapp_run_test.py -i qr_detection_test_1.py -n 5
-```
-
-### Using ROS framework
-
-The below example executes all tests, once.
-
-```shell
-$ rosrun rapp_testing_tools rapp_run_test.py
-```
+If no test_name is provided as argument, all tests are executed!!
 
 
 ## Developing Tests
 
-A template.py is located under the [default_tests](https://github.com/rapp-project/rapp-platform/tree/master/rapp_testing_tools/scripts/default_tests) directory of the rapp_testing_tools package.
+A template_test.py is located under the [default_tests](https://github.com/rapp-project/rapp-platform/tree/master/rapp_testing_tools/scripts/default_tests) directory of the rapp_testing_tools package.
 
-```shell
-$ <path_to_rapp_testing_tools_package>/scripts/default_tests
+```bash
+$ <path_to_rapp_testing_tools_package>/scripts/default_tests/
 ```
 
-Also several tests have already been developed, located under the default_tests
-directory. Those can be used as a reference for developing new tests.
-
-
-### Where to store developed tests
+Also, several tests have already been developed, located under the default_tests
+directory. Those can be used as a reference/examples for developing new tests.
 
-By default, developed tests are stored under the scripts/default_tests directory. 
-
-To define external tests directories, developers have to append that path
-into the params.yaml configuration file. This file is located under the config/
-directory in this package.
-
-Lets say for example that you want to store tests under:
-
-```shell
-$ ${HOME}/rapp_integration_tests_external
-```
-
-You can extend the path directories used by the test-engine to search under for python test source files. Just write down custom directory paths into the [params.yaml]([params.yaml](https://github.com/rapp-project/rapp-platform/blob/master/rapp_testing_tools/config/params.yaml)) file.
-
-```yaml
-tests_path:
-  - '~/rapp_integration_tests_external'
-```
 
+A Section in the [Wiki](https://github.com/rapp-project/rapp-platform/wiki/How-to-implement-an-integration-test%3F) exists that guides through developing integration tests for the RAPP Platform.
 
 ## Contributors
 
@@ -117,4 +68,5 @@ tests_path:
 
 
 ## Contact
+
 - Konstantinos Panayiotou, [[email protected]]

rapp_web_services/.jshintrc

@@ -0,0 +1,3 @@
+{
+  "esversion": 6
+}

rapp_web_services/Gruntfile.js

@@ -7,23 +7,32 @@ module.exports = function(grunt) {
     // Task configuration.
     jsdoc: {
       services: {
-        src: ['services/*.js', 'services/README.md'],
+        src: [
+          'services/**/svc.js',
+          '!services/templates/*.js',
+          'services/README.md'
+        ],
         options: {
           destination: 'doc/services',
           template: "node_modules/ink-docstrap/template",
           configure: "config/jsdoc/jsdoc-services.conf.json"
         }
       },
       commons: {
-        src: ['modules/common/*.js', 'modules/common/README.md'],
+        src: [
+          'src/**/*.js'
+        ],
         options: {
           destination: 'doc/commons',
           template: "node_modules/ink-docstrap/template",
           configure: "config/jsdoc/jsdoc-commons.conf.json"
         }
       },
       templates: {
-        src: ['services/templates/*.js', 'services/templates/README.md'],
+        src: [
+          'services/templates/*.js',
+          'services/templates/README.md'
+        ],
         options: {
           destination: 'doc/templates',
           template: "node_modules/ink-docstrap/template",

rapp_web_services/README.md

@@ -29,23 +29,30 @@ Currently, HOP-Server is configured to act as an HTTP/HTTPS Web Server (**Does n
 
 On a fresh clone you will first need to install required dependencies:
 
-```shell
+```bash
 $ npm install
 ```
 
 For initiating HOP Web Server (and HOP Web Services), a grunt task exists:
 
-```shell
+```bash
 $ grunt init-hop
 ```
 
 Or execute the **run.sh** script directly:
 
-```shell
+```bash
 $ ./run.sh
 ```
 
 
+We also provide [pm2](https://github.com/Unitech/pm2) configuration file for the web server to launch. If you have pm2 installed on the machine hosting the RAPP Platform, simply execute:
+
+```bash
+pm2 start server.yaml
+```
+
+
 **Note**: Do not change HOP Server configuration parameters, unless you know what you are doing!!
 
 
@@ -69,32 +76,32 @@ This package's source-code is documented using the [JSDoc](https://github.com/js
 
 Generate documentation for HOP Web Services ONLY!:
 
-```shell
+```bash
 $ grunt jsdoc:services
 ```
 
 Generate documentation for service-creation-templates ONLY!:
 
-```shell
+```bash
 $ grunt jsdoc:templates
 ```
 
 Generate documentation for commons ONLY!:
 
-```shell
+```bash
 $ grunt jsdoc:commons
 ```
 
 Gererate documentation for ALL:
 
-```shell
+```bash
 $ grunt jsdoc
 ```
 
 
 Generated doc files are stored under the **doc/** directory, or under:
 
-```shell
+```bash
 $ ${HOME}/rapp_platform_files/
 ```
 

rapp_web_services/init.js

@@ -34,26 +34,26 @@ var path = require('path');
 
 const ENV = require( path.join(__dirname, 'env.js') );
 const PKG_DIR = ENV.PATHS.PKG_DIR;
-const INCLUDE_DIR = ENV.PATHS.INCLUDE_DIR;
+const INCLUDES = ENV.PATHS.INCLUDE_DIR;
 const SERVICES_CACHE_DIR = ENV.PATHS.SERVICES_CACHE_DIR;
 const SERVER_CACHE_DIR = ENV.PATHS.SERVER_CACHE_DIR;
 /* --------------------------------------------------------------- */
 
-var hostname = hop.hostname;
-var port = hop.port;
+const hostname = hop.hostname;
+const port = hop.port;
 var workers = require('./config/services/workers.json');
 
-var Fs = require( path.join(INCLUDE_DIR, 'common', 'fileUtils.js') );
-var logger = new (require( path.join(INCLUDE_DIR, 'common', 'logger.js') ))(
-  {console: true, file: false, ns: ''});
+var Fs = require( path.join(INCLUDES, 'common', 'fileUtils.js') );
+const logger = new (require( path.join(INCLUDES, 'common', 'logger.js') ))(
+  {debug: false, file: false, ns: ''});
 if( createCacheDir(SERVICES_CACHE_DIR) ){
   logger.info('...Services caching in ' + SERVICES_CACHE_DIR);
-}else{
+} else {
   logger.error('Failed to create cache directories: ' + SERVICES_CACHE_DIR);
 }
 
-var srvHandler = new ( require( path.join(INCLUDE_DIR, 'servicehandler',
-    'service_handler.js') ))({logger: logger});
+var core = require(path.join(INCLUDES, 'serverCore.js'));
+core.applyLogger(logger);
 
 
 launchWorkers(workers);
@@ -62,7 +62,7 @@ launchWorkers(workers);
 /** ---------------------- [Util functions] --------------------- */
 /** ------------------------------------------------------------- */
 
-function createCacheDir( dir ){
+function createCacheDir(dir){
   if( dir === undefined || dir === '' )
   {
     return false;
@@ -74,14 +74,14 @@ function createCacheDir( dir ){
 }
 
 
-function launchWorkers( workers ){
+function launchWorkers(workers) {
   for(var w in workers){
     if( (workers[w].launch === true) || ( workers[w].launch) === undefined ){
       var worker = {
         file: path.join(__dirname, workers[w].path),
         name: w,
       };
-      srvHandler.registerWorker( worker );
+      core.registerWorker(worker);
     }
   }
 }
@@ -95,7 +95,7 @@ process.stdin.resume();
 process.on('SIGTERM',
   function(){
     console.log('Exiting with code: ');
-    srvHandler.terminate();
+    core.terminate();
   }
 );
 

rapp_web_services/services/README.md

@@ -81,7 +81,7 @@ Otherwise, use *application/x-www-form-urlencoded*.
 All data, except files, have to be  be send under a field named **json**.
 In case of using *application/x-www-form-urlencoded* type this will look like:
 
-```
+```http
 POST /hop/ontology_subclasses_of HTTP/1.1
 Connection: keep-alive
 ...
@@ -92,7 +92,7 @@ json=%7B%22query%22%3A+%22Oven%22%7D
 
 and in case of multipart/form-data:
 
-```
+```http
 POST /hop/face_detection HTTP/1.1
 Connection: keep-alive
 ...
@@ -1174,7 +1174,7 @@ where *story* object is:
 
 Developed tests and testing tools are currently located under the [rapp_testing_tools](https://github.com/rapp-project/rapp-platform/tree/master/rapp_testing_tools) package:
 
-```shell
+```bash
 $ <path_to_rapp_platform_repo>/rapp_testing_tools/
 ```