[client] Add linting and formatting to circl-ci (#72)

rhaist · web-flow · commit d4b0d02024c7 · 2020-04-21T12:42:30.000+02:00
* Add linting and formatting to circl-ci
* Remove old black command
* Add vscode to gitignore
* Allow sub folder to be modules
* Rewrite main __init__.py
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,6 +1,30 @@
 version: 2.1
 
 jobs:
+  ensure_formatting:
+    docker:
+      - image: circleci/python:3.7.7
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run:
+          name: install dependencies
+          command: sudo pip3 install black
+      - run:
+          name: confirm black version
+          command: black --version
+      - run:
+          name: run black check
+          command: black --check .
+  linter:
+    docker:
+      - image: alpine/flake8
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run:
+          name: flake8
+          command: flake8 --ignore=E,W ~/repo
   build:
     working_directory: ~/opencti-client
     docker:
@@ -10,9 +34,6 @@ jobs:
       - run:
           name: install dependencies
           command: pip3 install -r requirements.txt --user
-      - run:
-          name: install dependencies
-          command: black --check .
       - run:
           name: build
           command: python3 setup.py sdist
@@ -30,7 +51,7 @@ jobs:
           at: ~/opencti-client
       - run:
           name: install dependencies
-          command: pip3 install -r requirements.txt --user    
+          command: pip3 install -r requirements.txt --user
       - run:
           name: verify git tag vs. version
           command: python3 setup.py verify
@@ -48,6 +69,11 @@ jobs:
           command: twine upload dist/*
 
 workflows:
+  version: 2
+  check-code:
+    jobs:
+      - ensure_formatting
+      - linter
   opencti_client_python:
     jobs:
       - build:
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@ pycti.egg-info
 logs
 test.py
 .idea
+.vscode
 *.iml
 examples/*.json
 examples/*.pdf
diff --git a/examples/add_organization_to_sector.py b/examples/add_organization_to_sector.py
@@ -1,7 +1,5 @@
 # coding: utf-8
 
-import datetime
-
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/examples/add_tag_to_malware.py b/examples/add_tag_to_malware.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-from dateutil.parser import parse
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/examples/add_tool_usage_to_intrusion-set.py b/examples/add_tool_usage_to_intrusion-set.py
@@ -1,8 +1,5 @@
 # coding: utf-8
 
-import datetime
-from dateutil.parser import parse
-
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/examples/create_incident_with_ttps_and_indicators.py b/examples/create_incident_with_ttps_and_indicators.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-import datetime
 from dateutil.parser import parse
 
 from pycti import OpenCTIApiClient
diff --git a/examples/create_indicator_of_campaign.py b/examples/create_indicator_of_campaign.py
@@ -1,7 +1,5 @@
 # coding: utf-8
 
-import datetime
-
 from dateutil.parser import parse
 from pycti import OpenCTIApiClient
 
diff --git a/examples/delete_intrusion_set.py b/examples/delete_intrusion_set.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-import json
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/examples/delete_relation.py b/examples/delete_relation.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-import json
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/examples/export_async_of_indicators.py b/examples/export_async_of_indicators.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-import json
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/examples/export_async_of_malware.py b/examples/export_async_of_malware.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-import json
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/examples/update_entity_attribute.py b/examples/update_entity_attribute.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-import json
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/examples/upload_file.py b/examples/upload_file.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-import datetime
 from pycti import OpenCTIApiClient
 
 # Variables
diff --git a/pycti/__init__.py b/pycti/__init__.py
@@ -1,36 +1,71 @@
-from pycti.api.opencti_api_client import OpenCTIApiClient
-from pycti.api.opencti_api_connector import OpenCTIApiConnector
-from pycti.api.opencti_api_job import OpenCTIApiJob
+# -*- coding: utf-8 -*-
+from .api.opencti_api_client import OpenCTIApiClient
+from .api.opencti_api_connector import OpenCTIApiConnector
+from .api.opencti_api_job import OpenCTIApiJob
 
-from pycti.connector.opencti_connector import ConnectorType
-from pycti.connector.opencti_connector import OpenCTIConnector
-from pycti.connector.opencti_connector_helper import (
+from .connector.opencti_connector import ConnectorType
+from .connector.opencti_connector import OpenCTIConnector
+from .connector.opencti_connector_helper import (
     OpenCTIConnectorHelper,
     get_config_variable,
 )
 
-from pycti.entities.opencti_tag import Tag
-from pycti.entities.opencti_marking_definition import MarkingDefinition
-from pycti.entities.opencti_external_reference import ExternalReference
-from pycti.entities.opencti_kill_chain_phase import KillChainPhase
-from pycti.entities.opencti_stix_entity import StixEntity
-from pycti.entities.opencti_stix_domain_entity import StixDomainEntity
-from pycti.entities.opencti_stix_observable import StixObservable
-from pycti.entities.opencti_stix_relation import StixRelation
-from pycti.entities.opencti_stix_observable_relation import StixObservableRelation
-from pycti.entities.opencti_identity import Identity
-from pycti.entities.opencti_threat_actor import ThreatActor
-from pycti.entities.opencti_intrusion_set import IntrusionSet
-from pycti.entities.opencti_campaign import Campaign
-from pycti.entities.opencti_incident import Incident
-from pycti.entities.opencti_malware import Malware
-from pycti.entities.opencti_tool import Tool
-from pycti.entities.opencti_vulnerability import Vulnerability
-from pycti.entities.opencti_attack_pattern import AttackPattern
-from pycti.entities.opencti_course_of_action import CourseOfAction
-from pycti.entities.opencti_report import Report
-from pycti.entities.opencti_indicator import Indicator
+from .entities.opencti_tag import Tag
+from .entities.opencti_marking_definition import MarkingDefinition
+from .entities.opencti_external_reference import ExternalReference
+from .entities.opencti_kill_chain_phase import KillChainPhase
+from .entities.opencti_stix_entity import StixEntity
+from .entities.opencti_stix_domain_entity import StixDomainEntity
+from .entities.opencti_stix_observable import StixObservable
+from .entities.opencti_stix_relation import StixRelation
+from .entities.opencti_stix_observable_relation import StixObservableRelation
+from .entities.opencti_identity import Identity
+from .entities.opencti_threat_actor import ThreatActor
+from .entities.opencti_intrusion_set import IntrusionSet
+from .entities.opencti_campaign import Campaign
+from .entities.opencti_incident import Incident
+from .entities.opencti_malware import Malware
+from .entities.opencti_tool import Tool
+from .entities.opencti_vulnerability import Vulnerability
+from .entities.opencti_attack_pattern import AttackPattern
+from .entities.opencti_course_of_action import CourseOfAction
+from .entities.opencti_report import Report
+from .entities.opencti_indicator import Indicator
 
-from pycti.utils.opencti_stix2 import OpenCTIStix2
-from pycti.utils.constants import ObservableTypes
-from pycti.utils.constants import CustomProperties
+from .utils.opencti_stix2 import OpenCTIStix2
+from .utils.constants import ObservableTypes
+from .utils.constants import CustomProperties
+
+__all__ = [
+    "OpenCTIApiClient",
+    "OpenCTIApiConnector",
+    "OpenCTIApiJob",
+    "ConnectorType",
+    "OpenCTIConnector",
+    "OpenCTIConnectorHelper",
+    "get_config_variable",
+    "Tag",
+    "MarkingDefinition",
+    "ExternalReference",
+    "KillChainPhase",
+    "StixEntity",
+    "StixDomainEntity",
+    "StixObservable",
+    "StixRelation",
+    "StixObservableRelation",
+    "Identity",
+    "ThreatActor",
+    "IntrusionSet",
+    "Campaign",
+    "Incident",
+    "Malware",
+    "Tool",
+    "Vulnerability",
+    "AttackPattern",
+    "CourseOfAction",
+    "Report",
+    "Indicator",
+    "OpenCTIStix2",
+    "ObservableTypes",
+    "CustomProperties",
+]
diff --git a/pycti/api/__init__.py b/pycti/api/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/pycti/api/opencti_api_connector.py b/pycti/api/opencti_api_connector.py
@@ -1,6 +1,5 @@
 import json
 import logging
-from typing import Dict
 
 from pycti.connector.opencti_connector import OpenCTIConnector
 
diff --git a/pycti/connector/__init__.py b/pycti/connector/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/pycti/entities/__init__.py b/pycti/entities/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/pycti/entities/opencti_stix_observable_relation.py b/pycti/entities/opencti_stix_observable_relation.py
@@ -1,9 +1,7 @@
 # coding: utf-8
 
-import json
 import dateutil.parser
 import datetime
-from pycti.utils.constants import CustomProperties
 
 
 class StixObservableRelation:
@@ -24,16 +22,16 @@ def __init__(self, opencti):
             created_at
             updated_at
             from {
-                id  
+                id
                 stix_id_key
                 entity_type
                 observable_value
             }
             to {
-                id  
+                id
                 stix_id_key
                 entity_type
-                observable_value              
+                observable_value
             }
             createdByRef {
                 node {
@@ -102,7 +100,7 @@ def __init__(self, opencti):
         :param lastSeenStop: the last_seen date stop filter
         :param inferred: includes inferred relations
         :param first: return the first n rows from the after ID (or the beginning if not set)
-        :param after: ID of the first row for pagination        
+        :param after: ID of the first row for pagination
         :return List of stix_observable_relation objects
     """
 
@@ -154,7 +152,7 @@ def list(self, **kwargs):
                         hasNextPage
                         hasPreviousPage
                         globalCount
-                    }                        
+                    }
                 }
             }
          """
@@ -184,7 +182,7 @@ def list(self, **kwargs):
 
     """
         Read a stix_observable_relation object
-        
+
         :param id: the id of the stix_observable_relation
         :param stix_id_key: the STIX id of the stix_observable_relation
         :param fromId: the id of the source entity of the relation
@@ -351,7 +349,7 @@ def create(self, **kwargs):
             id
             entity_type
             name
-            description 
+            description
             weight
             first_seen
             last_seen
diff --git a/pycti/entities/opencti_stix_relation.py b/pycti/entities/opencti_stix_relation.py
@@ -1,6 +1,5 @@
 # coding: utf-8
 
-import json
 import dateutil.parser
 import datetime
 from pycti.utils.constants import CustomProperties
@@ -41,7 +40,7 @@ def __init__(self, opencti):
                 ...on StixDomainEntity {
                     name
                     description
-                }       
+                }
             }
             createdByRef {
                 node {
@@ -130,7 +129,7 @@ def __init__(self, opencti):
         :param lastSeenStop: the last_seen date stop filter
         :param inferred: includes inferred relations
         :param first: return the first n rows from the after ID (or the beginning if not set)
-        :param after: ID of the first row for pagination        
+        :param after: ID of the first row for pagination
         :return List of stix_relation objects
     """
 
@@ -182,7 +181,7 @@ def list(self, **kwargs):
                         hasNextPage
                         hasPreviousPage
                         globalCount
-                    }                        
+                    }
                 }
             }
          """
@@ -212,7 +211,7 @@ def list(self, **kwargs):
 
     """
         Read a stix_relation object
-        
+
         :param id: the id of the stix_relation
         :param fromId: the id of the source entity of the relation
         :param toId: the id of the target entity of the relation
@@ -380,7 +379,7 @@ def create(self, **kwargs):
             id
             entity_type
             name
-            description 
+            description
             weight
             first_seen
             last_seen
@@ -533,7 +532,7 @@ def update_field(self, **kwargs):
                     mutation StixRelationEdit($id: ID!, $input: EditInput!) {
                         stixRelationEdit(id: $id) {
                             fieldPatch(input: $input) {
-                                id    
+                                id
                             }
                         }
                     }
diff --git a/pycti/utils/__init__.py b/pycti/utils/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
