fixup! feat(glimps): add view token to analysis result

Glimps/CHANGELOG.md

@@ -11,13 +11,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Waitfor action : submit a file to Glimps detect and wit for analysis to finish
-- Get status action : get Glimps detect profile status
-- export submission : export analysis result in a given format and layout
+- Waitfor action: submit a file to GLIMPS detect and wait for analysis to finish
+- Get status action: get GLIMPS detect profile status
+- Export submission: export analysis result in a given format and layout
 
 ### Changed
 
-- use Glimps py-gdetect client to perform actions
+- Upgrade sekoia-automation-sdk
+- Use GLIMPS py-gdetect client to perform actions
 
 ## 2024-05-28 - 1.13.0
 

Glimps/glimps/base.py

@@ -1,11 +1,11 @@
 from sekoia_automation.action import Action
 from gdetect import Client, GDetectError
 from functools import cached_property
-from glimps.models import GlimpsModule
+from glimps.models import GLIMPSModule
 
 
 class GLIMPSAction(Action):
-    module: GlimpsModule
+    module: GLIMPSModule
 
     @cached_property
     def gdetect_client(self):

Glimps/glimps/models.py

@@ -7,13 +7,13 @@
 from typing_extensions import TypedDict, NotRequired
 
 
-class GlimpsConfiguration(BaseModel):
+class GLIMPSConfiguration(BaseModel):
     api_key: str = Field(..., secret=True, description="Glimps detect token")
     base_url: str = Field(..., description="Glimps detect url")
 
 
-class GlimpsModule(Module):
-    configuration: GlimpsConfiguration
+class GLIMPSModule(Module):
+    configuration: GLIMPSConfiguration
 
 
 class SubmitArgument(BaseModel):
@@ -100,7 +100,7 @@ class AnalysisDetails(BaseModel):
     special_status_code: int = Field(
         description="special error code, 0 means no special case"
     )
-    uuid: str = Field(description="Unique analysis identifier")
+    uuid: str = Field(description="unique analysis identifier")
     sha256: str = Field(description="string hex encoded input file SHA256")
     sha1: str = Field(description="string hex encoded input file SHA1")
     md5: str = Field(description="string hex encoded input file MD5")

Glimps/main.py

@@ -1,4 +1,4 @@
-from glimps.models import GlimpsModule
+from glimps.models import GLIMPSModule
 
 from glimps.get_status_action import GetStatus
 from glimps.submit_file_to_be_analysed_action import WaitForFile
@@ -9,7 +9,7 @@
 
 
 if __name__ == "__main__":
-    module = GlimpsModule()
+    module = GLIMPSModule()
     module.register(GetStatus, "GetStatus")
     module.register(WaitForFile, "WaitForFile")
     module.register(ExportSubmission, "ExportSubmission")

Glimps/manifest.json

@@ -5,7 +5,7 @@
   "description": "[Glimps](https://www.glimps.fr/) offers a DeepLearning solution to detect, analyze and classify malwares. It enables faster responses during incidents with a detailed understanding of the threat",
   "version": "1.14.0",
   "configuration": {
-    "title": "GlimpsConfiguration",
+    "title": "GLIMPSConfiguration",
     "type": "object",
     "properties": {
       "api_key": {

Glimps/pyproject.toml

@@ -6,9 +6,9 @@ authors = []
 
 [tool.poetry.dependencies]
 python = ">=3.10,<3.12"
-sekoia-automation-sdk = "^1.13.0"
+sekoia-automation-sdk = "^1.17.0"
 tenacity = "*"
-gdetect = "^0.7.0"
+gdetect = "^0.8.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "*"

Glimps/tests/conftest.py

@@ -8,7 +8,7 @@
 from glimps.retrieve_analysis_action import RetrieveAnalysis
 from glimps.search_analysis_by_sha256_action import SearchPreviousAnalysis
 from glimps.submit_file_to_be_analysed_action import WaitForFile
-from glimps.models import GlimpsConfiguration
+from glimps.models import GLIMPSConfiguration
 
 
 @pytest.fixture(scope="session")
@@ -30,7 +30,7 @@ def symphony_storage():
 @pytest.fixture(scope="session")
 def set_up_retrieve_analysis_action(token):
     action = RetrieveAnalysis()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url="https://gmalware.ggp.glimps.re"
     )
     return action
@@ -39,7 +39,7 @@ def set_up_retrieve_analysis_action(token):
 @pytest.fixture(scope="session")
 def set_up_search_analysis_action(token):
     action = SearchPreviousAnalysis()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url="https://gmalware.ggp.glimps.re"
     )
     return action
@@ -48,7 +48,7 @@ def set_up_search_analysis_action(token):
 @pytest.fixture(scope="session")
 def set_up_wait_for_action(token, symphony_storage):
     action = WaitForFile(data_path=symphony_storage)
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url="https://gmalware.ggp.glimps.re"
     )
     return action

Glimps/tests/test_export.py

@@ -1,54 +1,56 @@
 import pytest
 from glimps.models import (
-    GlimpsConfiguration,
+    GLIMPSConfiguration,
     ExportSubmissionArguments,
 )
 from glimps.export_action import ExportSubmission
 from unittest.mock import patch
 from gdetect import GDetectError
 from pydantic.error_wrappers import ValidationError
-# import os
-# from glimps.submit_file_to_be_analysed_action import (
-#     WaitForFile,
-#     WaitForResultArgument,
-#     AnalysisResponse,
-# )
+import os
+from glimps.submit_file_to_be_analysed_action import (
+    WaitForFile,
+    WaitForResultArgument,
+    AnalysisResponse,
+)
 
 test_base_url = "https://gmalware.ggp.glimps.re"
 
 
 # NB: GGP lite version doesn't yet allow to export result analysis
-# @pytest.mark.skipif("'GLIMPS_API_KEY' not in os.environ.keys()")
-# def test_integration_get_status(add_file_to_storage):
-#     symphony_storage, file, _ = add_file_to_storage
-#     module_configuration = GlimpsConfiguration(
-#         api_key=os.environ["GLIMPS_API_KEY"],
-#         base_url=test_base_url,
-#     )
-
-#     prepare = WaitForFile(data_path=symphony_storage)
-#     prepare.module.configuration = module_configuration
-
-#     arguments = WaitForResultArgument(file_name=file)
-#     response: AnalysisResponse = prepare.run(arguments)
-#     assert response is not None
-#     assert response.get("analysis").get("status") is True
-#     assert response.get("analysis").get("uuid") != ""
-
-#     action = ExportSubmission()
-#     action.module.configuration = module_configuration
-#     args = ExportSubmissionArguments(
-#         uuid=response.get("analysis").get("uuid"), format="csv", layout="en"
-#     )
-
-#     response: bytes = action.run(args)
-#     assert response is not None
-#     assert response.decode("utf-8") != ""
+@pytest.mark.skipif(
+    "{'GLIMPS_API_KEY', 'GLIMPS_API_URL'}.issubset(os.environ.keys()) == False"
+)
+def test_integration_get_export(add_file_to_storage):
+    symphony_storage, file, _ = add_file_to_storage
+    module_configuration = GLIMPSConfiguration(
+        api_key=os.environ["GLIMPS_API_KEY"],
+        base_url=os.environ["GLIMPS_API_URL"],
+    )
+
+    prepare = WaitForFile(data_path=symphony_storage)
+    prepare.module.configuration = module_configuration
+
+    arguments = WaitForResultArgument(file_name=file)
+    response: AnalysisResponse = prepare.run(arguments)
+    assert response is not None
+    assert response.get("analysis").get("status") is True
+    assert response.get("analysis").get("uuid") != ""
+
+    action = ExportSubmission()
+    action.module.configuration = module_configuration
+    args = ExportSubmissionArguments(
+        uuid=response.get("analysis").get("uuid"), format="csv", layout="en"
+    )
+
+    response: bytes = action.run(args)
+    assert response is not None
+    assert response.decode("utf-8") != ""
 
 
 def test_export_succeed(token):
     action = ExportSubmission()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url=test_base_url
     )
     uuid = "1da0cb84-c5cc-4832-8882-4a7e9df11ed2"
@@ -64,7 +66,7 @@ def test_export_succeed(token):
 
 def test_export_error(token):
     action = ExportSubmission()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url=test_base_url
     )
     uuid = "1da0cb84-c5cc-4832-8882-4a7e9df11ed2"
@@ -78,7 +80,7 @@ def test_export_error(token):
 
 def test_export_bad_format(token):
     action = ExportSubmission()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url=test_base_url
     )
     uuid = "1da0cb84-c5cc-4832-8882-4a7e9df11ed2"
@@ -88,7 +90,7 @@ def test_export_bad_format(token):
 
 def test_export_bad_layout(token):
     action = ExportSubmission()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url=test_base_url
     )
     uuid = "1da0cb84-c5cc-4832-8882-4a7e9df11ed2"

Glimps/tests/test_get_status.py

@@ -1,16 +1,18 @@
 import pytest
 import os
 import json
-from glimps.models import GlimpsConfiguration, ProfileStatus
+from glimps.models import GLIMPSConfiguration, ProfileStatus
 from glimps.get_status_action import GetStatus
 from unittest.mock import patch
 import requests
 
 
-@pytest.mark.skipif("'GLIMPS_API_KEY' not in os.environ.keys()")
+@pytest.mark.skipif(
+    "{'GLIMPS_API_KEY', 'GLIMPS_API_URL'}.issubset(os.environ.keys()) == False"
+)
 def test_integration_get_status():
     action = GetStatus()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=os.environ["GLIMPS_API_KEY"], base_url="https://gmalware.ggp.glimps.re"
     )
 
@@ -21,7 +23,7 @@ def test_integration_get_status():
 
 def test_get_status_error(token):
     action = GetStatus()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url="https://gmalware.ggp.glimps.re"
     )
 
@@ -40,7 +42,7 @@ def test_get_status_error(token):
 
 def test_get_status_ok(token):
     action = GetStatus()
-    action.module.configuration = GlimpsConfiguration(
+    action.module.configuration = GLIMPSConfiguration(
         api_key=token, base_url="https://gmalware.ggp.glimps.re"
     )
 

Glimps/tests/test_retrieve_analysis.py

@@ -8,18 +8,20 @@
     SubmitArgument,
     SubmitResponse,
     AnalysisResponse,
-    GlimpsConfiguration,
+    GLIMPSConfiguration,
     GetAnalysisByUUIDArgument,
 )
 from gdetect import BadUUIDError
 
 
-@pytest.mark.skipif("'GLIMPS_API_KEY' not in os.environ.keys()")
+@pytest.mark.skipif(
+    "{'GLIMPS_API_KEY', 'GLIMPS_API_URL'}.issubset(os.environ.keys()) == False"
+)
 def test_integration_retrieve_analysis(add_file_to_storage):
     symphony_storage, file, _ = add_file_to_storage
-    module_configuration = GlimpsConfiguration(
+    module_configuration = GLIMPSConfiguration(
         api_key=os.environ["GLIMPS_API_KEY"],
-        base_url="https://gmalware.ggp.glimps.re",
+        base_url=os.environ["GLIMPS_API_URL"],
     )
     prepare = SubmitFile(data_path=symphony_storage)
     prepare.module.configuration = module_configuration

Glimps/tests/test_search_analysis_by_sha256.py

@@ -8,17 +8,19 @@
     SubmitArgument,
     SubmitResponse,
     AnalysisResponse,
-    GlimpsConfiguration,
+    GLIMPSConfiguration,
     SearchAnalysisBySha256Argument,
 )
 from gdetect import BadSHA256Error
 
 
-@pytest.mark.skipif("'GLIMPS_API_KEY' not in os.environ.keys()")
+@pytest.mark.skipif(
+    "{'GLIMPS_API_KEY', 'GLIMPS_API_URL'}.issubset(os.environ.keys()) == False"
+)
 def test_integration_search_analysis(add_file_to_storage):
     symphony_storage, file, sha256 = add_file_to_storage
-    module_configuration = GlimpsConfiguration(
-        api_key=os.environ["GLIMPS_API_KEY"], base_url="https://gmalware.ggp.glimps.re"
+    module_configuration = GLIMPSConfiguration(
+        api_key=os.environ["GLIMPS_API_KEY"], base_url=os.environ["GLIMPS_API_URL"]
     )
     prepare = SubmitFile(data_path=symphony_storage)
     prepare.module.configuration = module_configuration