update test and qa tools

maestro-server · Jan 3, 2019 · 460dddd · 460dddd
1 parent 276b599
commit 460dddd
Show file tree

Hide file tree

Showing 9 changed files with 96 additions and 3 deletions.
diff --git a/docs/_static/screen/analytics_internal.png b/docs/_static/screen/analytics_internal.png
diff --git a/docs/_static/screen/component_discovery.png b/docs/_static/screen/component_discovery.png
diff --git a/docs/_static/screen/discovery_arch.png b/docs/_static/screen/discovery_arch.png
diff --git a/docs/_static/screen/discovery_components.png b/docs/_static/screen/discovery_components.png
diff --git a/docs/_static/screen/tokens.png b/docs/_static/screen/tokens.png
diff --git a/docs/developer/architecture/discovery_app.rst b/docs/developer/architecture/discovery_app.rst
@@ -35,6 +35,8 @@ If you use windows, celery havent support for windows, the last version is 3.1.2
 
 **Important topics**
 
+.. image:: ../../_static/screen/discovery_arch.png
+
 - Controller used factory dc abstract to create easy way to make CRUD in mongodb
 
 - The crawler is divided in:
@@ -49,6 +51,12 @@ If you use windows, celery havent support for windows, the last version is 3.1.2
 
 	- **insert:** insert/update data in mongodb
 
+    - **audit:** prepare and transform data to be send record to external audit task
+
+    - **external_audit:** Send http request to Audit app
+
+    - **ws:** Send http notification to webscoket api
+
 	Each step have unique task.
 
 - Config is managed by env variables, need to be, because in production env like k8s is easier to manager the pods.

diff --git a/docs/developer/qa.rst b/docs/developer/qa.rst
@@ -176,3 +176,24 @@ CodeClimate       .. image:: https://api.codeclimate.com/v1/badges/645a6be641cb8
                         :target: https://codeclimate.com/github/maestro-server/analytics-front/test_coverage
                         :alt: Test Coverage
 ================  ================================================================================================================================================================================== 
+
+------------
+
+Audit App
+---------
+
+================  ================================================================================================================================================================================== 
+
+Codacy            .. image:: https://api.codacy.com/project/badge/Grade/4716ea50f4224175a6d6e5ebd5100974
+                        :target: https://www.codacy.com/app/maestro/audit-app?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=maestro-server/audit-app&amp;utm_campaign=Badge_Grade
+
+Travis            .. image:: https://travis-ci.org/maestro-server/audit-app.svg?branch=master
+                        :target: https://travis-ci.org/maestro-server/audit-app
+
+CodeClimate       .. image:: https://api.codeclimate.com/v1/badges/24f6cbc44944bdaf281b/maintainability
+                        :target: https://codeclimate.com/github/maestro-server/audit
+
+                  .. image:: https://api.codeclimate.com/v1/badges/24f6cbc44944bdaf281b/test_coverage
+                        :target: https://codeclimate.com/github/maestro-server/audit-app/test_coverage
+                        :alt: Test Coverage
+================  ================================================================================================================================================================================== 
diff --git a/docs/developer/tests.rst b/docs/developer/tests.rst
@@ -50,6 +50,12 @@ Testing use pytest
 
     python -m unittest discover
 
+================  ================================================================================================================================================================================== 
+Coveralls         .. image:: https://coveralls.io/repos/github/maestro-server/discovery-api/badge.svg?branch=master
+                        :target: https://coveralls.io/github/maestro-server/discovery-api?branch=master
+================  ================================================================================================================================================================================== 
+
+
 
 Reports APP
 -------------
@@ -62,6 +68,12 @@ Testing use pytest
 
     python -m unittest discover
 
+================  ================================================================================================================================================================================== 
+Coveralls         .. image:: https://coveralls.io/repos/github/maestro-server/report-app/badge.svg?branch=master
+                        :target: https://coveralls.io/github/maestro-server/report-app?branch=master
+================  ================================================================================================================================================================================== 
+
+
 Data Layer APP
 --------------
 
@@ -73,6 +85,12 @@ Testing use pytest
 
     python -m unittest discover
 
+================  ================================================================================================================================================================================== 
+Coveralls         .. image:: https://coveralls.io/repos/github/maestro-server/data-app/badge.svg?branch=master
+                        :target: https://coveralls.io/github/maestro-server/data-app?branch=master
+================  ================================================================================================================================================================================== 
+
+
 Analytics Apps
 --------------
 
@@ -84,13 +102,39 @@ Testing use pytest
 
     python -m unittest discover
 
+================  ================================================================================================================================================================================== 
+Coveralls         .. image:: https://coveralls.io/repos/github/maestro-server/analytics-maestro/badge.svg?branch=master
+                        :target: https://coveralls.io/github/maestro-server/analytics-maestro?branch=master
+================  ================================================================================================================================================================================== 
+
+
 Analytics Front
 ---------------
 
 Testing use pytest
 
 .. code-block:: bash
 
-    npm run test
+    npm run e2e
+
+================  ================================================================================================================================================================================== 
+Coveralls         .. image:: https://coveralls.io/repos/github/maestro-server/analytics-front/badge.svg?branch=master
+                        :target: https://coveralls.io/github/maestro-server/analytics-front?branch=master
+================  ================================================================================================================================================================================== 
+
+
+
+Audit App
+---------------
+
+Testing use pytest
+
+.. code-block:: bash
+
+    npm run e2e
+
+================  ================================================================================================================================================================================== 
+Coveralls         .. image:: https://coveralls.io/repos/github/maestro-server/audit-app/badge.svg?branch=master
+                        :target: https://coveralls.io/github/maestro-server/audit-app?branch=master
+================  ================================================================================================================================================================================== 
 
-    python -m unittest discover
diff --git a/docs/developer/tokens.rst b/docs/developer/tokens.rst
@@ -22,7 +22,7 @@ Follow an architecture of switch tokens
 +----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
 |                            |                                            |                        | WebSocket       | Hashtable message bus received                           |
 +----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
-| SecretJwt Public Analytics | Auth shared links (public access)          | Server App             | Analytics Front | Used to create token to allowed public access on graphs  |
+| SecretJwt Public           | Auth shared links (public access)          | Server App             | Analytics Front | Used to create token to allowed public access on graphs  |
 +----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
 | SecretJwt Analytics        | Auth along analytics apps                  | Analytics App (Worker) | Analytics Front | Security key to allowed to post on analytics front       |
 +----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
@@ -34,8 +34,28 @@ Follow an architecture of switch tokens
 +----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
 |                            |                                            |                        | Discovery App   |                                                          |
 +----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+| JWT Name                   | Context                                    | Owned by               | Used by         |                                                          |
++============================+============================================+========================+=================+==========================================================+
+| SecretJwt Private          | Private Authenticate                       | Server                 | Analytics App   | Security key beetween services                           |
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+|                            |                                            |                        | Discovery App   |                                                          |
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
 |                            |                                            |                        | Report App      |                                                          |
 +----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+|                            |                                            | Discovery App          | Data   App      |                                                          |
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+|                            |                                            |                        | Audit  App      |                                                          |
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+|                            |                                            | Reports App            | Data   App      |                                                          |
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+|                            |                                            |                        | Audit  App      |                                                          |
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+|                            |                                            |                        | Report  App     | Report Worker -> Report Api                              |
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
+|                            |                                            | Analytics App          | Data   App      |                                                          |
++----------------------------+--------------------------------------------+------------------------+-----------------+----------------------------------------------------------+
 
 - **Owned** - Responsible to create and maintain that token
 - **Context** - High-level description