Add basic pytest framework (#89)

* Add basic test framework
* Fix formatting
* Bump dependencies and add test token
* Fix Tests
* Add documentation for Indicator class

Author: rhaist

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 jobs:
   ensure_formatting:
     docker:
-      - image: circleci/python:3.7.7
+      - image: circleci/python:3.9
     working_directory: ~/repo
     steps:
       - checkout
@@ -25,10 +25,24 @@ jobs:
       - run:
           name: flake8
           command: flake8 --ignore=E,W ~/repo
+  tests:
+    docker:
+      - image: circleci/python:3.9
+    steps:
+      - checkout
+      - run:
+          name: install dependencies
+          command: pip3 install -r requirements.txt --user
+      - run:
+          name: install pytest
+          command: pip3 install pytest pytest-cov --user
+      - run:
+          name: run pytest
+          command: python3 -m pytest --cov=pycti
   build:
     working_directory: ~/opencti-client
     docker:
-      - image: circleci/python:3.6
+      - image: circleci/python:3.9
     steps:
       - checkout
       - run:
@@ -44,7 +58,7 @@ jobs:
   deploy:
     working_directory: ~/opencti-client
     docker:
-      - image: circleci/python:3.6
+      - image: circleci/python:3.9
     steps:
       - checkout
       - attach_workspace:
@@ -74,6 +88,7 @@ workflows:
     jobs:
       - ensure_formatting
       - linter
+      - tests
   opencti_client_python:
     jobs:
       - build:

docs/conf.py

@@ -23,7 +23,7 @@
 author = "OpenCTI Project"
 
 # The full version, including alpha/beta/rc tags
-release = "3.3.3"
+release = "4.2.0"
 
 master_doc = "index"
 

docs/pycti/pycti.rst

@@ -29,7 +29,7 @@ Classes
 - :py:class:`OpenCTIApiConnector`:
   OpenCTIApiConnector
 
-- :py:class:`OpenCTIApiJob`:
+- :py:class:`OpenCTIApiWork`:
   OpenCTIApiJob
 
 - :py:class:`ConnectorType`:
@@ -128,9 +128,18 @@ Classes
 - :py:class:`OpenCTIStix2Splitter`:
   Undocumented.
 
+- :py:class:`OpenCTIStix2Update`:
+  Python API for Stix2 Update in OpenCTI
+
+- :py:class:`OpenCTIStix2Utils`:
+  Undocumented.
+
 - :py:class:`StixCyberObservableTypes`:
   An enumeration.
 
+- :py:class:`SimpleObservable`:
+  Base class for STIX object types
+
 
 .. autoclass:: OpenCTIApiClient
    :members:
@@ -146,11 +155,11 @@ Classes
    .. inheritance-diagram:: OpenCTIApiConnector
       :parts: 1
 
-.. autoclass:: OpenCTIApiJob
+.. autoclass:: OpenCTIApiWork
    :members:
 
    .. rubric:: Inheritance
-   .. inheritance-diagram:: OpenCTIApiJob
+   .. inheritance-diagram:: OpenCTIApiWork
       :parts: 1
 
 .. autoclass:: ConnectorType
@@ -377,9 +386,30 @@ Classes
    .. inheritance-diagram:: OpenCTIStix2Splitter
       :parts: 1
 
+.. autoclass:: OpenCTIStix2Update
+   :members:
+
+   .. rubric:: Inheritance
+   .. inheritance-diagram:: OpenCTIStix2Update
+      :parts: 1
+
+.. autoclass:: OpenCTIStix2Utils
+   :members:
+
+   .. rubric:: Inheritance
+   .. inheritance-diagram:: OpenCTIStix2Utils
+      :parts: 1
+
 .. autoclass:: StixCyberObservableTypes
    :members:
 
    .. rubric:: Inheritance
    .. inheritance-diagram:: StixCyberObservableTypes
       :parts: 1
+
+.. autoclass:: SimpleObservable
+   :members:
+
+   .. rubric:: Inheritance
+   .. inheritance-diagram:: SimpleObservable
+      :parts: 1

pycti/entities/opencti_indicator.py

@@ -41,7 +41,7 @@ def __init__(self, opencti):
                                 color
                             }
                         }
-                    }                    
+                    }
                 }
                 ... on Organization {
                     x_opencti_organization_type
@@ -112,7 +112,7 @@ def __init__(self, opencti):
                 edges {
                     node {
                         id
-                        standard_id                            
+                        standard_id
                         entity_type
                         kill_chain_name
                         phase_name
@@ -139,6 +139,9 @@ def list(self, **kwargs):
         :param list customAttributes: (optional) list of attributes keys to return
         :param bool getAll: (optional) switch to return all entries (be careful to use this without any other filters)
         :param bool withPagination: (optional) switch to use pagination
+
+        :return: List of Indicators
+        :rtype: list
         """
 
         filters = kwargs.get("filters", None)
@@ -228,6 +231,9 @@ def read(self, **kwargs):
 
         :param str id: the id of the Threat-Actor
         :param list filters: the filters to apply if no id provided
+
+        :return: Indicator object
+        :rtype: Indicator
         """
 
         id = kwargs.get("id", None)
@@ -264,14 +270,17 @@ def read(self, **kwargs):
             )
             return None
 
-    """
-        Create a Indicator object
+    def create(self, **kwargs):
+        """
+        Create an Indicator object
 
-        :param name: the name of the Indicator
-        :return Indicator object
-    """
+        :param str name: the name of the Indicator
+        :param str pattern: stix indicator pattern
+        :param str x_opencti_main_observable_type: type of the observable
 
-    def create(self, **kwargs):
+        :return: Indicator object
+        :rtype: Indicator
+        """
         stix_id = kwargs.get("stix_id", None)
         created_by = kwargs.get("createdBy", None)
         object_marking = kwargs.get("objectMarking", None)
@@ -364,15 +373,16 @@ def create(self, **kwargs):
                 "[opencti_indicator] Missing parameters: name or pattern or x_opencti_main_observable_type",
             )
 
-    """
+    def add_stix_observable(self, **kwargs):
+        """
         Add a Stix-Observable object to Indicator object (based-on)
 
         :param id: the id of the Indicator
-        :param entity_id: the id of the Stix-Observable
-        :return Boolean
-    """
+        :param indicator: Indicator object
+        :param stix_cyber_observable_id: the id of the Stix-Observable
 
-    def add_stix_observable(self, **kwargs):
+        :return: Boolean True if there has been no import error
+        """
         id = kwargs.get("id", None)
         indicator = kwargs.get("indicator", None)
         stix_cyber_observable_id = kwargs.get("stix_cyber_observable_id", None)
@@ -423,14 +433,17 @@ def add_stix_observable(self, **kwargs):
             )
             return False
 
-    """
+    def import_from_stix2(self, **kwargs):
+        """
         Import an Indicator object from a STIX2 object
 
         :param stixObject: the Stix-Object Indicator
-        :return Indicator object
-    """
+        :param extras: extra dict
+        :param bool update: set the update flag on import
 
-    def import_from_stix2(self, **kwargs):
+        :return: Indicator object
+        :rtype: Indicator
+        """
         stix_object = kwargs.get("stixObject", None)
         extras = kwargs.get("extras", {})
         update = kwargs.get("update", False)

tests/01-unit/test_stix_split.py

@@ -7,4 +7,4 @@ def test_split_bundle():
     with open("./tests/data/enterprise-attack.json") as file:
         content = file.read()
     bundles = stix_splitter.split_bundle(content)
-    assert len(bundles) == 7028
+    assert len(bundles) == 7029

tests/data/indicator_stix.json

@@ -0,0 +1,48 @@
+{
+    "type": "bundle",
+    "id": "bundle--3e0921e7-0d87-49c4-8121-ec28db0f535f",
+    "objects": [
+        {
+            "id": "indicator--39915430-6d24-4f9d-a871-76a264169674",
+            "type": "indicator",
+            "spec_version": "2.1",
+            "name": "103.83.192.6",
+            "labels": [
+                "indicator"
+            ],
+            "pattern": "[ipv4-addr:value = '103.83.192.6']",
+            "valid_from": "2020-04-17T09:50:27.000Z",
+            "valid_until": "2021-04-17T09:50:27.000Z",
+            "x_opencti_pattern_type": "stix",
+            "created": "2020-04-30T06:29:41.232Z",
+            "modified": "2020-04-30T06:29:41.232Z",
+            "x_opencti_score": 50,
+            "x_opencti_id": "40caf0b8-0632-4f62-9ba6-dc10c093a63e",
+            "created_by_ref": "identity--26926631-96e9-40e9-9ac0-ab93384f0ce7",
+            "object_marking_refs": [
+                "marking-definition--613f2e26-407d-48c7-9eca-b8e91df99dc9"
+            ]
+        },
+        {
+            "id": "indicator--41be0c61-43b3-4233-aea0-7077a8981c77",
+            "type": "indicator",
+            "spec_version": "2.1",
+            "name": "192.185.46.253",
+            "labels": [
+                "indicator"
+            ],
+            "pattern": "[ipv4-addr:value = '192.185.46.253']",
+            "valid_from": "2020-04-17T09:50:27.000Z",
+            "valid_until": "2021-04-17T09:50:27.000Z",
+            "x_opencti_pattern_type": "stix",
+            "created": "2020-04-30T06:29:41.303Z",
+            "modified": "2020-04-30T06:29:41.303Z",
+            "x_opencti_score": 50,
+            "x_opencti_id": "2962d903-76ad-4092-b4e0-2021a30db0cb",
+            "created_by_ref": "identity--26926631-96e9-40e9-9ac0-ab93384f0ce7",
+            "object_marking_refs": [
+                "marking-definition--613f2e26-407d-48c7-9eca-b8e91df99dc9"
+            ]
+        }
+    ]
+}