Merge branch 'master' of https://github.com/IBM/qpylib into story250001

Author: smokeykappa

.gitignore

@@ -14,3 +14,5 @@ qpylib.egg-info
 RemoteSystemsTempFiles
 qpylib/version.py
 .idea/
+coverage.xml
+.coverage

README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.com/IBM/qpylib.svg?branch=master)](https://travis-ci.com/IBM/qpylib)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=qpylib&metric=alert_status)](https://sonarcloud.io/dashboard?id=qpylib)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=qpylib&metric=coverage)](https://sonarcloud.io/component_measures?id=qpylib&metric=new_coverage&view=list)
 
 
 # QRadar App Python Library (qpylib)
@@ -22,4 +23,3 @@ any code contained herein is unsupported and subject to change.
 * [CONTRIBUTING](CONTRIBUTING.md)
 * [MAINTAINERS](MAINTAINERS.md)
 * [CHANGELOG](CHANGELOG.md)
-

clean.sh

@@ -8,3 +8,5 @@ rm -f qpylib/version.py
 rm -rf dist qpylib.egg-info
 rm -rf qpylib/__pycache__
 rm -rf test/__pycache__
+rm -f .coverage
+rm -f coverage.xml

qpylib/asset_qpylib.py

@@ -6,7 +6,7 @@
 from . import json_qpylib
 
 # Context location yet to be finalised.
-JSON_LD_CONTEXT = 'http://qradar/context/location'
+JSON_LD_CONTEXT = 'https://qradar/context/location'
 
 # The api method to GET an individual asset is not yet supported.
 def get_asset_url(asset_id):

qpylib/json_qpylib.py

@@ -8,6 +8,10 @@
 # A dictionary of jsonld context types mapped to the type name
 JSONLD_TYPES = {}
 
+KEY_CONTEXT = '@context'
+KEY_TYPE = '@type'
+KEY_ID = '@id'
+
 def register_jsonld_endpoints():
     manifest = app_qpylib.get_manifest_json()
 
@@ -35,9 +39,10 @@ def register_jsonld_endpoints():
                 register_jsonld_type_from_context(jsonld_context)
 
 def _extract_jsonld_context(argument, mime_id, context_id):
-    if mime_id in argument.keys() and context_id in argument.keys():
-        if argument[mime_id] == 'application/json+ld':
-            return argument[context_id]
+    if (mime_id in argument.keys() and
+            context_id in argument.keys() and
+            argument[mime_id] == 'application/json+ld'):
+        return argument[context_id]
     return None
 
 def register_jsonld_type_from_context(context):
@@ -57,12 +62,12 @@ def get_jsonld_type(jsonld_type):
 
 def _extract_type(argument):
     type_id = None
-    if '@context' in argument.keys():
-        context = argument['@context']
-        if '@type' in context.keys():
-            type_id = context['@type']
-        if type_id == '@id' and '@id' in context.keys():
-            type_id = context['@id']
+    if KEY_CONTEXT in argument.keys():
+        context = argument[KEY_CONTEXT]
+        if KEY_TYPE in context.keys():
+            type_id = context[KEY_TYPE]
+        if type_id == KEY_ID and KEY_ID in context.keys():
+            type_id = context[KEY_ID]
     return type_id
 
 def render_json_ld_type(jld_type, data, jld_id=None):
@@ -71,16 +76,16 @@ def render_json_ld_type(jld_type, data, jld_id=None):
     for json_key in data:
         json_dict[json_key] = data[json_key]
 
-    json_dict['@context'] = jld_context['@context']
-    json_dict['@type'] = jld_type
+    json_dict[KEY_CONTEXT] = jld_context[KEY_CONTEXT]
+    json_dict[KEY_TYPE] = jld_type
     if jld_id is not None:
-        json_dict['@type'] = jld_type
+        json_dict[KEY_TYPE] = jld_type
 
     return json.dumps(json_dict, sort_keys=True)
 
 # pylint: disable=too-many-arguments
 def json_ld(jld_context, jld_id, jld_type, name, description, data):
-    return json.dumps({'@context': jld_context, '@id': jld_id, '@type': jld_type, 'name': name,
+    return json.dumps({KEY_CONTEXT: jld_context, KEY_ID: jld_id, KEY_TYPE: jld_type, 'name': name,
                        'description': description, 'data': data}, sort_keys=True)
 
 def json_html(html):

qpylib/offense_qpylib.py

@@ -8,10 +8,11 @@
 from . import qpylib
 
 # Context location yet to be finalised
-JSON_LD_CONTEXT = 'http://qradar/context/location'
+JSON_LD_CONTEXT = 'https://qradar/context/location'
 OFFENSE_HEADER_TEMPLATE = ('<div class="gridHeader" id="{0}gridheaderdiv" style="clear:both;">'
                            '<div class="heading" id="{0}headingdiv">{1}</div>'
                            '</div>')
+OFFENSE_ROW_TEMPLATE = '<tr><td>{0}</td><td>{1}</td></tr>'
 
 def get_offense_url(offense_id):
     return 'api/siem/offenses/{0}'.format(offense_id)
@@ -27,9 +28,9 @@ def get_offense_json(offense_id):
 
 def get_offense_html_example(offense_json):
     return ('<table><tbody>' +
-            '<tr><td>Offense ID</td><td>' + str(offense_json['id']) + '</td></tr>' +
-            '<tr><td>Source IP</td><td>' + offense_json['offense_source'] + '</td></tr>' +
-            '<tr><td>Severity</td><td>' + str(offense_json['severity']) + '</td></tr>' +
+            OFFENSE_ROW_TEMPLATE.format('Offense ID', str(offense_json['id'])) +
+            OFFENSE_ROW_TEMPLATE.format('Source IP', offense_json['offense_source']) +
+            OFFENSE_ROW_TEMPLATE.format('Severity', str(offense_json['severity'])) +
             '</tbody></table>')
 
 def get_offense_html_header(offense_id):

requirements.txt

@@ -2,6 +2,7 @@ flask
 requests
 pycryptodome
 cryptography
-pylint
-pytest
 responses
+pylint==2.5.3
+pytest==5.4.3
+pytest-cov==2.10.0

sonar-project.properties

@@ -4,3 +4,4 @@ sonar.organization=qradar-app-framework
 sonar.projectKey=qpylib
 sonar.tests=test
 sonar.host.url=https://sonarcloud.io
+sonar.python.coverage.reportPaths=coverage.xml

test.sh

@@ -3,4 +3,4 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-python -m pytest -v test
+python -m pytest -v --cov-report xml:coverage.xml --cov-report term --cov=qpylib test