Improve api

.dockerignore

@@ -0,0 +1,2 @@
+/node_modules
+

.travis.yml

@@ -0,0 +1,8 @@
+
+language: node_js
+node_js:
+  - 11
+
+script:
+  - npm run test
+  - npm run jshint

Dockerfile

@@ -0,0 +1,15 @@
+FROM node:8.16.2-alpine
+
+ENV NODE_ENV development
+ENV NODE_CONFIG '{"port":3100,"log_options":{"level":"error","log_api_access":false},"enable":{"admin_delete_db":false}}'
+
+ADD . /src
+WORKDIR /src
+
+RUN npm install --production && \
+    npm audit fix && \
+    npm dedupe
+
+EXPOSE 3100
+
+CMD npm start

README.md

@@ -86,6 +86,19 @@ properly until a few bugs are ironed out. Probably August 2019 for that update.
   * local: configure `/.vscode/runtime.env` to set `NODE_ENV`
   * lambda: edit `serverless.yml` to set `NODE_ENV` for the cloudformation deployed app
 
+### to build and run Docker image
+
+The project can be used as Docker container.
+
+First build the image:
+`docker build -t imf-mm-api .`
+
+First build the image:
+`docker run -d -p 3100:3100 --name imf-mm imf-mm-api`
+
+Then simply access to the API:
+[http://localhost:3100/demo/1/assets](http://localhost:3100/demo/1/assets)
+
 ## AWS requirements
 
 To use the simpledb cloud database as the backend, you will need to provide AWS keys that allow the
@@ -209,6 +222,11 @@ the changes along side your main server.
 
 ## API Change Log
 
+* 2019-11-20 Improve code and support file-type filter
+  * refactor some code
+  * be able to list `assets` and filter them by file type
+* 2019-10-14 Docker image
+  * provide the Docker image of the service
 * 2019-09-03 deployment updates
   * fixed mounting of the app under defferent routes by providing `config.mount_point`
   * updated cloud instance for testing with `staging`, `beta` and `1/` end points

__test__/test__api-properties.js

@@ -1,13 +1,13 @@
-/** @module test__api
- * 
+/**
+ * @module test__api
  */
 /* jshint node: true */
 /* globals afterAll, beforeAll, describe, expect, test */
 'use strict'
 require('dotenv').config({ path: '__test__/.env',})
-console.log(process.env.NODE_ENV)
-/** db-local storage tester
- *
+
+/**
+ * db-local storage tester
  */
 const fs = require('fs')
 const path = require('path')

__test__/test__api-assets.js → __test__/test__api.js

@@ -3,8 +3,8 @@
 'use strict'
 require('dotenv').config({ path: '__test__/.env', })
 
-/** api-assets jest test scripts
- * 
+/**
+ * api jest test scripts
  */
 const config = require('config')
 const log = require('pino')(config.get('log_options'))
@@ -14,24 +14,14 @@ const path = require('path')
 const __test = path.basename(__filename)
 
 const prefix = config.get('api_prefix')
-const api = `${config.get('api_prefix')}/assets`
+const assets_api = `${config.get('mount_point')}/${config.get('api_prefix')}/assets`
+const admin_info_api = `${config.get('mount_point')}/admin/info`
+const crawl_api = `${config.get('mount_point')}/crawl/`
 
-// Test the server using the test port (you can replace this with any URL)
+// Test the server using the test port
 let request = require('supertest');
-request = request(`http://localhost:${config.get('port')}`)
-let app
-
-beforeAll(async () => {
-    log.info(`${rJ('Jest starting: ')}server booting on http://localhost:${config.get('port')}.`);
-    log.info(`${rJ('Jest db: ')}${config.get('port')}.`);
-    /// prevent race conditions by waiting for the server to be listening on its port
-    try {
-        app = require('../src/start_local')
-        await request.get('/')
-    } catch (e) {
-        log.error(`${rJ('Server failed to start: ')}${e}.`);
-    }
-});
+let app = require('../src/start_local')
+let testServer = request(`http://localhost:${config.get('port')}`)
 
 // close koa's http after each test
 afterAll(() => {
@@ -41,22 +31,22 @@ afterAll(() => {
 
 // Local test database may be empty here so check basic functions
 
-describe(`${__test}: testing GET /${api}`, () => {
-    test(`GET /${api}`, async () => {
+describe(`${__test}: testing Assets`, () => {
+    test(`GET ${assets_api}`, async () => {
         //assert code 200, json content type and the body contains required 
-        return request
-            .get(`/${api}`)
+        return testServer
+            .get(`${assets_api}`)
             .expect(200)
             .expect('Content-Type', /json/)
             .expect(/"limit":/)
             .expect(/"results":/)
             .expect(/"skip":/)
             .expect(/"total":/)
     });
-    test(`GET /${api}/`, async () => {
+    test(`GET ${assets_api}/`, async () => {
         //assert code 200, json content type and the body contains required 
-        return request
-            .get(`/${api}/`)
+        return testServer
+            .get(`${assets_api}/`)
             .expect(200)
             .expect('Content-Type', /json/)
             .expect(/"limit":/)
@@ -66,4 +56,20 @@ describe(`${__test}: testing GET /${api}`, () => {
     });
 });
 
-// Scan the test folder and build a local database (asssum that bit's working)
+describe(`${__test}: testing Admin`, () => {
+    test(`GET ${admin_info_api}`, async () => {
+        //assert code 200, json content type and the body contains required 
+        return testServer
+            .get(`/${admin_info_api}`)
+            .expect(404)
+    });
+});
+
+describe(`${__test}: testing Crawl`, () => {
+    test(`GET ${crawl_api}`, async () => {
+        //assert code 200, json content type and the body contains required 
+        return testServer
+            .get(`/${crawl_api}`)
+            .expect(404)
+    });
+});

__test__/test__db-local.js

@@ -2,9 +2,8 @@
 /* globals afterAll, beforeAll, describe, expect, test */
 'use strict'
 require('dotenv').config({ path: '__test__/.env',})
-console.log(process.env.NODE_ENV)
-/** db-local storage tester
- *
+/**
+ * db-local storage tester
  */
 const fs = require('fs')
 const path = require('path')
@@ -20,6 +19,10 @@ const test_asset1= test_assets[0]
 const test_asset2= test_assets[1]
 
 const test_folder = path.join(__dirname, '__db-local__')
+if (!fs.existsSync(test_folder)) {
+    fs.mkdirSync(test_folder)
+}
+
 var params = {
     local_filename: path.join(test_folder, config.get('database').local_filename),
 }
@@ -93,25 +96,25 @@ describe(`${_module}`, () => {
         })
 
         test('db.get()', () => {
-            return local_db.get()
+            return local_db.get_assets()
                 .then(data => {
                     expect(data.length).toEqual(2)
                 })
         })
         test('db.get(0,1)', () => {
-            return local_db.get(0, 1)
+            return local_db.get_assets(0, 1)
                 .then(data => {
                     expect(data.length).toEqual(1)
                 })
         })
         test('db.get(1,1)', () => {
-            return local_db.get(1, 1)
+            return local_db.get_assets(1, 1)
                 .then(data => {
                     expect(data.length).toEqual(1)
                 })
         })
         test('db.get(2,100)', () => {
-            return local_db.get(2, 100)
+            return local_db.get_assets(2, 100)
                 .then(data => {
                     expect(data.length).toEqual(0)
                 })

__test__/test__lib-crawl-fs.js

@@ -21,6 +21,10 @@ var test_root = path.join(__dirname, 'assets-imf')
 var empty_root = path.join(__dirname, 'assets-imf/empty')
 
 const test_db_folder = path.join(__dirname, '__db-local__')
+if (!fs.existsSync(test_db_folder)) {
+    fs.mkdirSync(test_db_folder)
+}
+
 const test_db_path = path.join(test_db_folder, config.get('database').local_crawl_filename)
 
 describe(`${__test}: fs crawl core`, () => {

config/default.json

@@ -29,7 +29,7 @@
         "assets": true,
         "crawl": true,
         "www": true,
-        "load_home_page_on_boot": true,
+        "load_home_page_on_boot": false,
         "extended_status_messages": true,
         "synth_local_test_data": true
     },

config/development.json

@@ -16,6 +16,7 @@
         "__test__/assets-imf"
     ],
     "enable":{
-        "extended_config_messages":true
+        "extended_config_messages": true,
+        "load_home_page_on_boot": false
     }
 }

config/local-test.json

@@ -16,5 +16,8 @@
         "show_config_sources": true,
         "prettyPrint": true,
         "log_api_access": false
+    },
+    "enable": {
+        "load_home_page_on_boot": false
     }
 }