Merge pull request #24 from FiniteStateInc/ASOC-2593

[Asoc-2593] Create unittests

Author: facundoArgeniss

finite_state_sdk/__init__.py

@@ -1997,9 +1997,9 @@ def update_finding_statuses(token, organization_context, user_id=None, finding_i
         dict: Response JSON from the GraphQL query of type UpdateFindingsStatusesResponse. For details see https://docs.finitestate.io/types/update-findings-statuses-response
     """
     if not user_id:
-        raise ValueError("User ID is required")
+        raise ValueError("User Id is required")
     if not finding_ids:
-        raise ValueError("Finding ID is required")
+        raise ValueError("Finding Ids is required")
     if not status:
         raise ValueError("Status is required")
 
@@ -2041,9 +2041,9 @@ def upload_file_for_binary_analysis(token, organization_context, test_id=None, f
     # To upload a file for Binary Analysis, you must use the generateMultiplePartUploadUrl mutation
 
     if not test_id:
-        raise ValueError("Test ID is required")
+        raise ValueError("Test Id is required")
     if not file_path:
-        raise ValueError("File path is required")
+        raise ValueError("File Path is required")
 
     # Start Multi-part Upload
     graphql_query = '''
@@ -2168,9 +2168,9 @@ def upload_test_results_file(token, organization_context, test_id=None, file_pat
         dict: The response from the GraphQL query, a completeTestResultUpload Object.
     """
     if not test_id:
-        raise ValueError("Test ID is required")
+        raise ValueError("Test Id is required")
     if not file_path:
-        raise ValueError("File path is required")
+        raise ValueError("File Path is required")
 
     # Gerneate Test Result Upload URL
     graphql_query = '''

pyproject.toml

@@ -17,7 +17,7 @@ description = "The official Finite State Python SDK."
 readme = "README.md"
 license = "MIT"
 classifiers = [
-    "Programming Language :: Python :: 3.8.1",
+    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",

tests/test_create_artifact.py

@@ -0,0 +1,69 @@
+from unittest.mock import patch
+
+from finite_state_sdk import create_artifact
+
+
+class TestArtifacts:
+    # Define test data
+    auth_token = "your_auth_token"
+    organization_context = "your_organization_context"
+    business_unit_id = "business_unit_id"
+    created_by_user_id = "user_id"
+    asset_version_id = "asset_version_id"
+    artifact_name = "artifact_name"
+    product_id = "product_id"
+
+    # Define a mock response
+    mock_response = {
+        "data": {
+            "createArtifact": {
+                "id": "mock_artifact_id",
+                "name": "artifact_name",
+                "assetVersion": {
+                    "id": "asset_version_id",
+                    "name": "asset_version_name",
+                    "asset": {
+                        "id": "asset_id",
+                        "name": "asset_name"
+                    }
+                },
+                "createdBy": {
+                    "id": "user_id",
+                    "email": "[email protected]"
+                },
+                "ctx": {
+                    "asset": "asset_version_id",
+                    "products": ["product_id"],
+                    "businessUnits": ["business_unit_id"]
+                }
+            }
+        }
+    }
+
+    @patch("finite_state_sdk.send_graphql_query")
+    def test_create_artifact(self, mock_send_query):
+        mock_send_query.return_value = self.mock_response
+        response = create_artifact(
+            token=self.auth_token,
+            organization_context=self.organization_context,
+            business_unit_id=self.business_unit_id,
+            created_by_user_id=self.created_by_user_id,
+            asset_version_id=self.asset_version_id,
+            artifact_name=self.artifact_name,
+            product_id=self.product_id
+        )
+        mock_send_query.assert_called_once()
+
+        assert response['createArtifact']['id'] == self.mock_response['data']['createArtifact']['id']
+        assert response['createArtifact']['name'] == self.mock_response['data']['createArtifact']['name']
+        assert response['createArtifact']['assetVersion']['id'] == self.mock_response['data']['createArtifact']['assetVersion']['id']
+        assert response['createArtifact']['assetVersion']['name'] == self.mock_response['data']['createArtifact']['assetVersion']['name']
+        assert response['createArtifact']['assetVersion']['asset']['id'] == self.mock_response['data']['createArtifact']['assetVersion']['asset']['id']
+        assert response['createArtifact']['assetVersion']['asset']['name'] == self.mock_response['data']['createArtifact']['assetVersion']['asset']['name']
+        assert response['createArtifact']['createdBy']['id'] == self.mock_response['data']['createArtifact']['createdBy']['id']
+        assert response['createArtifact']['createdBy']['email'] == self.mock_response['data']['createArtifact']['createdBy']['email']
+        assert response['createArtifact']['ctx']['asset'] == self.mock_response['data']['createArtifact']['ctx']['asset']
+        assert response['createArtifact']['ctx']['products'] == self.mock_response['data']['createArtifact']['ctx']['products']
+        assert response['createArtifact']['ctx']['businessUnits'] == self.mock_response['data']['createArtifact']['ctx']['businessUnits']
+
+# Run the test...

tests/test_create_asset.py

@@ -0,0 +1,61 @@
+from unittest.mock import patch
+
+from finite_state_sdk import create_asset
+
+
+class TestCreateAsset:
+    # Define test data
+    auth_token = "your_auth_token"
+    organization_context = "your_organization_context"
+    business_unit_id = "business_unit_id"
+    created_by_user_id = "user_id"
+    asset_name = "asset_name"
+    product_id = "product_id"
+
+    # Define a mock response
+    mock_response = {
+        "data": {
+            "createAsset": {
+                "id": "mock_asset_id",
+                "name": "asset_name",
+                "dependentProducts": [],
+                "group": {
+                    "id": "business_unit_id",
+                    "name": "business_unit_name"
+                },
+                "createdBy": {
+                    "id": "user_id",
+                    "email": "[email protected]"
+                },
+                "ctx": {
+                    "asset": "mock_asset_id",
+                    "products": ["product_id"],
+                    "businessUnits": ["business_unit_id"]
+                }
+            }
+        }
+    }
+
+    @patch("finite_state_sdk.send_graphql_query")
+    def test_create_asset(self, mock_send_query):
+        mock_send_query.return_value = self.mock_response
+        response = create_asset(
+            token=self.auth_token,
+            organization_context=self.organization_context,
+            business_unit_id=self.business_unit_id,
+            created_by_user_id=self.created_by_user_id,
+            asset_name=self.asset_name,
+            product_id=self.product_id
+        )
+        mock_send_query.assert_called_once()
+
+        assert response['createAsset']['id'] == self.mock_response['data']['createAsset']['id']
+        assert response['createAsset']['name'] == self.mock_response['data']['createAsset']['name']
+        assert response['createAsset']['dependentProducts'] == self.mock_response['data']['createAsset']['dependentProducts']
+        assert response['createAsset']['group']['id'] == self.mock_response['data']['createAsset']['group']['id']
+        assert response['createAsset']['group']['name'] == self.mock_response['data']['createAsset']['group']['name']
+        assert response['createAsset']['createdBy']['id'] == self.mock_response['data']['createAsset']['createdBy']['id']
+        assert response['createAsset']['createdBy']['email'] == self.mock_response['data']['createAsset']['createdBy']['email']
+        assert response['createAsset']['ctx']['asset'] == self.mock_response['data']['createAsset']['ctx']['asset']
+        assert response['createAsset']['ctx']['products'] == self.mock_response['data']['createAsset']['ctx']['products']
+        assert response['createAsset']['ctx']['businessUnits'] == self.mock_response['data']['createAsset']['ctx']['businessUnits']

tests/test_create_asset_version.py

@@ -0,0 +1,61 @@
+from unittest.mock import patch
+
+from finite_state_sdk import create_asset_version
+
+
+class TestCreateAssetVersion:
+    # Define test data
+    auth_token = "your_auth_token"
+    organization_context = "your_organization_context"
+    business_unit_id = "business_unit_id"
+    created_by_user_id = "user_id"
+    asset_id = "asset_id"
+    asset_version_name = "asset_version_name"
+    product_id = "product_id"
+
+    # Define a mock response
+    mock_response = {
+        "data": {
+            "createAssetVersion": {
+                "id": "mock_asset_version_id",
+                "name": "asset_version_name",
+                "asset": {
+                    "id": "asset_id",
+                    "name": "asset_name"
+                },
+                "createdBy": {
+                    "id": "user_id",
+                    "email": "[email protected]"
+                },
+                "ctx": {
+                    "asset": "asset_id",
+                    "products": ["product_id"],
+                    "businessUnits": ["business_unit_id"]
+                }
+            }
+        }
+    }
+
+    @patch("finite_state_sdk.send_graphql_query")
+    def test_create_asset_version(self, mock_send_query):
+        mock_send_query.return_value = self.mock_response
+        response = create_asset_version(
+            token=self.auth_token,
+            organization_context=self.organization_context,
+            business_unit_id=self.business_unit_id,
+            created_by_user_id=self.created_by_user_id,
+            asset_id=self.asset_id,
+            asset_version_name=self.asset_version_name,
+            product_id=self.product_id
+        )
+        mock_send_query.assert_called_once()
+
+        assert response['createAssetVersion']['id'] == self.mock_response['data']['createAssetVersion']['id']
+        assert response['createAssetVersion']['name'] == self.mock_response['data']['createAssetVersion']['name']
+        assert response['createAssetVersion']['asset']['id'] == self.mock_response['data']['createAssetVersion']['asset']['id']
+        assert response['createAssetVersion']['asset']['name'] == self.mock_response['data']['createAssetVersion']['asset']['name']
+        assert response['createAssetVersion']['createdBy']['id'] == self.mock_response['data']['createAssetVersion']['createdBy']['id']
+        assert response['createAssetVersion']['createdBy']['email'] == self.mock_response['data']['createAssetVersion']['createdBy']['email']
+        assert response['createAssetVersion']['ctx']['asset'] == self.mock_response['data']['createAssetVersion']['ctx']['asset']
+        assert response['createAssetVersion']['ctx']['products'] == self.mock_response['data']['createAssetVersion']['ctx']['products']
+        assert response['createAssetVersion']['ctx']['businessUnits'] == self.mock_response['data']['createAssetVersion']['ctx']['businessUnits']

tests/test_create_new_asset_version_and_upload_binary.py

@@ -0,0 +1,64 @@
+from unittest.mock import patch
+from finite_state_sdk import create_new_asset_version_and_upload_binary, UploadMethod
+
+
+class TestCreateNewAssetVersionAndUploadBinary:
+    # Define test data
+    auth_token = "your_auth_token"
+    organization_context = "your_organization_context"
+    business_unit_id = "business_unit_id"
+    created_by_user_id = "user_id"
+    asset_id = "asset_id"
+    version = "version"
+    file_path = "file_path"
+    product_id = "product_id"
+    artifact_description = "artifact_description"
+    quick_scan = False
+    upload_method = UploadMethod.API
+
+    # Define mock responses for each mocked function
+    mock_response_create_test = {
+        "id": "test_id"
+    }
+
+    @patch("finite_state_sdk.create_new_asset_version_artifact_and_test_for_upload")
+    @patch("finite_state_sdk.upload_file_for_binary_analysis")
+    def test_create_new_asset_version_and_upload_binary(self, mock_upload_file, mock_create_asset_version):
+        mock_create_asset_version.return_value = self.mock_response_create_test['id']
+        mock_upload_file.return_value = {}
+
+        response = create_new_asset_version_and_upload_binary(
+            token=self.auth_token,
+            organization_context=self.organization_context,
+            business_unit_id=self.business_unit_id,
+            created_by_user_id=self.created_by_user_id,
+            asset_id=self.asset_id,
+            version=self.version,
+            file_path=self.file_path,
+            product_id=self.product_id,
+            artifact_description=self.artifact_description,
+            quick_scan=self.quick_scan,
+            upload_method=self.upload_method
+        )
+
+        mock_create_asset_version.assert_called_once_with(
+            self.auth_token,
+            self.organization_context,
+            business_unit_id=self.business_unit_id,
+            created_by_user_id=self.created_by_user_id,
+            asset_id=self.asset_id,
+            version=self.version,
+            product_id=self.product_id,
+            test_type="finite_state_binary_analysis",
+            artifact_description=self.artifact_description,
+            upload_method=self.upload_method
+        )
+        mock_upload_file.assert_called_once_with(
+            self.auth_token,
+            self.organization_context,
+            test_id=self.mock_response_create_test['id'],
+            file_path=self.file_path,
+            quick_scan=self.quick_scan
+        )
+
+        assert response == {}

tests/test_create_new_asset_version_and_upload_test_results.py

@@ -0,0 +1,61 @@
+from unittest.mock import patch
+from finite_state_sdk import create_new_asset_version_and_upload_test_results, UploadMethod
+
+
+class TestCreateNewAssetVersionAndUploadTestResults:
+    # Define test data
+    auth_token = "your_auth_token"
+    organization_context = "your_organization_context"
+    business_unit_id = "business_unit_id"
+    created_by_user_id = "user_id"
+    asset_id = "asset_id"
+    version = "version"
+    file_path = "file_path"
+    product_id = "product_id"
+    test_type = "test_type"
+    artifact_description = "artifact_description"
+    upload_method = UploadMethod.API
+
+    # Define mock responses for each mocked function
+    mock_response_create_test = "test_id"
+
+    @patch("finite_state_sdk.create_new_asset_version_artifact_and_test_for_upload")
+    @patch("finite_state_sdk.upload_test_results_file")
+    def test_create_new_asset_version_and_upload_test_results(self, mock_upload_file, mock_create_asset_version):
+        mock_create_asset_version.return_value = self.mock_response_create_test
+        mock_upload_file.return_value = {}
+
+        response = create_new_asset_version_and_upload_test_results(
+            self.auth_token,
+            self.organization_context,
+            business_unit_id=self.business_unit_id,
+            created_by_user_id=self.created_by_user_id,
+            asset_id=self.asset_id,
+            version=self.version,
+            file_path=self.file_path,
+            product_id=self.product_id,
+            test_type=self.test_type,
+            artifact_description=self.artifact_description,
+            upload_method=self.upload_method
+        )
+
+        mock_create_asset_version.assert_called_once_with(
+            self.auth_token,
+            self.organization_context,
+            business_unit_id=self.business_unit_id,
+            created_by_user_id=self.created_by_user_id,
+            asset_id=self.asset_id,
+            version=self.version,
+            product_id=self.product_id,
+            test_type=self.test_type,
+            artifact_description=self.artifact_description,
+            upload_method=self.upload_method
+        )
+        mock_upload_file.assert_called_once_with(
+            self.auth_token,
+            self.organization_context,
+            test_id=self.mock_response_create_test,
+            file_path=self.file_path
+        )
+
+        assert response == {}