v0.0.2 updates

refactored handlers to return type
added get project inventory and inventory summary
added more tests
updated models

Author: zkarpinski

codeinsight_sdk/client.py

@@ -9,11 +9,13 @@
 class CodeInsightClient:
     def __init__(self,
                  base_url: str,
-                 api_token: str
+                 api_token: str,
+                 page_size: int = 100
                  ):
         self.base_url = base_url
         self.api_url = f"{base_url}/codeinsight/api"
         self.api_token = api_token
+        self.page_size = page_size
         self.api_headers = {
             'Content-Type': 'application/json',
             "Authorization": "Bearer %s" % self.api_token,
@@ -35,11 +37,7 @@ def request(self, method, url_part: str, params: dict = None):
     def projects(self) -> Handler:
         return Handler.create(self, Project)
 
-    @property
-    def project_inventory(self) -> Handler:
-        return Handler.create(self, ProjectInventory)
 
-
     # Coming soon...?
     def inventories(self):
         raise NotImplementedError("Inventories are not yet implemented")

codeinsight_sdk/handlers.py

@@ -1,4 +1,7 @@
 import abc
+from typing import List
+
+from codeinsight_sdk.models import Project, ProjectInventory, ProjectInventoryItem
 
 class Handler(abc.ABC):
     def __init__(self, client, cls):
@@ -8,8 +11,8 @@ def __init__(self, client, cls):
     @staticmethod
     def create(client, cls):
         k = cls.__name__
-        handlers = {"Project": ProjectHandler,
-                     "ProjectInventory": ProjectInventoryHandler}
+        handlers = {"Project": ProjectHandler, 
+            }
         handler = handlers.get(k)
         return handler(client, cls)
 
@@ -19,20 +22,21 @@ def get(self):
 
 class ProjectHandler(Handler):
     #Note API endpoints switch between projects and project...
-    def all(self):
+    def all(self) -> List[Project]:
         path = "projects"
         resp = self.client.request("GET", url_part=path)
         projects = []
         for project_data in resp.json()['data']:
             projects.append(self.cls.from_dict(project_data))
         return projects
 
-    def get(self, id:str):
+    def get(self, id:str) -> Project:
         path = f"projects/{id}"
         resp = self.client.request("GET", url_part=path)
-        project_data = resp.json()
+        project_data = resp.json()['data']
+        return self.cls.from_dict(project_data)
 
-    def get_id(self, projectName:str):
+    def get_id(self, projectName:str) -> int:
             """
             Retrieves the ID of a project based on its name.
 
@@ -47,12 +51,23 @@ def get_id(self, projectName:str):
             resp = self.client.request("GET", url_part=path, params=params)
             projectId = resp.json()['Content']
             return projectId
-
-class ProjectInventoryHandler(Handler):
-    def get(self, id:str, skip_vulnerabilities: bool = False):
-        path = f"project/inventory/{id}"
+    
+    def get_inventory_summary(self, project_id:int) -> List[ProjectInventoryItem]:
+        path = f"projects/{project_id}/inventorySummary"
+        resp = self.client.request("GET", url_part=path)
+        inventory = []
+        for inv_item in resp.json()['data']:
+            inventory.append(ProjectInventoryItem.from_dict(inv_item))
+        return inventory
+    
+    def get_inventory(self,project_id:int,
+                      skip_vulnerabilities: bool = False,
+                      published:bool = True,
+                      ) -> ProjectInventory:
+        path = f"project/inventory/{project_id}"
         params = {"skipVulnerabilities": skip_vulnerabilities}
         resp = self.client.request("GET", url_part=path, params=params)
         project_inventory = resp.json()
-        project_cls = self.cls.from_dict(project_inventory)
+        project_cls = ProjectInventory.from_dict(project_inventory)
         return project_cls
+

codeinsight_sdk/models.py

@@ -1,7 +1,6 @@
 from dataclasses import dataclass
 from dataclasses_json import DataClassJsonMixin, dataclass_json
-from typing import Any, Optional, List
-from .handlers import Handler
+from typing import Any, Optional, List, Dict
 
 @dataclass
 class Project(DataClassJsonMixin):
@@ -11,10 +10,10 @@ class Project(DataClassJsonMixin):
     owner: Optional[str] = None
     description: Optional[str] = None
     dateCreated: Optional[str] = None
+    projectPath: Optional[str] = None
+    # TODO: Should this be a dictionary or another class? This structure is reused in a few APIs
+    vulnerabilities: Optional[Dict[str, Dict]] = None
 
-    @property
-    def inventory(self) -> Handler:
-        return Handler.create(self, ProjectInventory)
 
 @dataclass
 class Vulnerability(DataClassJsonMixin):
@@ -28,15 +27,17 @@ class Vulnerability(DataClassJsonMixin):
 class ProjectInventoryItem(DataClassJsonMixin):
     itemNumber: int
     id: int
+    componentName: str
+    componentVersionName: str
     name: str
     type: str
     priority: str
     createdBy: str
     createdOn: str
     updatedOn: str
-    componentName: str
-    componentVersionName: str
+    url: Optional[str] = None
     vulnerabilites: Optional[List[Vulnerability]] = None
+    vulnerabilitySummary: Optional[Dict[str, Dict]] = None
     filePaths: Optional[List[str]] = None
 
 @dataclass_json #Trying this style instead of DataClassJsonMixin

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codeinsight_sdk"
-version = "0.0.1"
+version = "0.0.2"
 description = "A Python client for the Revenera Code Insight"
 authors = ["Zachary Karpinski <1206496+zkarpinski@users.noreply.github.com>"]
 readme = "README.md"

tests/test_client.py

@@ -33,35 +33,103 @@ def test_get_all_projects(self, client):
             projects = client.projects.all()
         assert len(projects) > 0
 
-    def test_get_project(self,client):
+    def test_get_project_id(self,client):
         projectName = "Test"
         with requests_mock.Mocker() as m:
             m.get(f"{TEST_URL}/codeinsight/api/project/id", text='{ "Content": 1 }')
             project_id = client.projects.get_id(projectName)
         assert project_id == 1
+    
+    def test_get_project(self,client):
+        project_id = 1
+        fake_response_json = """ { "data": {
+            "id": 1,
+            "name": "Test",
+            "description": "Test project",
+            "createdBy": "Zach",
+            "createdOn": "Today",
+            "updatedOn": "Tomorrow",
+            "projectType": "maven",
+            "projectUrl": "",
+            "vulnerabilities": {
+                "CvssV2": {
+                    "High": 2,
+                    "Medium": 2,
+                    "Low": 3,
+                    "Unknown": 4
+                },
+                "CvssV3": {
+                    "Critical": 1,
+                    "High": 1,
+                    "Medium": 2,
+                    "Low": 6,
+                    "Unknown": 1
+                }
+            }
+        }}
+        """
+        with requests_mock.Mocker() as m:
+            m.get(f"{TEST_URL}/codeinsight/api/projects/{project_id}", text=fake_response_json)
+            project = client.projects.get(project_id)
+        assert project.id == 1
+        assert project.name == "Test"
+        assert project.vulnerabilities["CvssV3"]["Critical"] == 1
+        assert project.vulnerabilities["CvssV3"]["High"] == 1
+        assert project.vulnerabilities["CvssV2"]["High"] == 2
+        assert project.vulnerabilities["CvssV2"]["Unknown"] == 4
 
     def test_get_project_inventory(self,client):
         project_id = 1
-        fake_json = """
+        fake_response_json = """
 { "projectId": 1, "inventoryItems": [
     {"itemNumber":1, "id":1234, "name":"Example component","type":"component","priority":"low","createdBy":"Zach","createdOn":"Today","updatedOn":"Tomorrow","componentName":"snakeyaml","componentVersionName":"2.0"},
     {"itemNumber":2, "id":1235, "name":"Example component 2","type":"component","priority":"low","createdBy":"Zach","createdOn":"Today","updatedOn":"Tomorrow","componentName":"snakeyaml","componentVersionName":"2.0"}
     ]}
 """
         with requests_mock.Mocker() as m:
             m.get(f"{TEST_URL}/codeinsight/api/project/inventory/{project_id}",
-                text=fake_json)
-            projectInventory = client.project_inventory.get(project_id)
-        print(projectInventory)
+                text=fake_response_json)
+            projectInventory = client.projects.get_inventory(project_id)
         assert projectInventory.projectId == project_id
         assert len(projectInventory.inventoryItems) >= 2
-    
 
-    ## Coming soon features ##
-    def test_inventories(self, client):
-        with pytest.raises(NotImplementedError):
-            client.inventories() != None
+    #### FIX THIS! ####
+    def test_get_project_inventory_summary(self,client):
+        project_id = 1
+        fake_response_json = """ { "data": [
+            {
+                "itemNumber": 1,
+                "id": 12345,
+                "name": "Inventory Item 1",
+                "type":"component",
+                "priority":"low",
+                "createdBy":"Zach",
+                "createdOn":"Today",
+                "updatedOn":"Tomorrow",
+                "componentName":"snakeyaml",
+                "componentVersionName":"2.0"
+            },
+            {
+                "itemNumber": 2,
+                "id": 12346,
+                "name": "Inventory Item 2",
+                "type":"component",
+                "priority":"low",
+                "createdBy":"Zach",
+                "createdOn":"Today",
+                "updatedOn":"Tomorrow",
+                "componentName":"snakeyaml",
+                "componentVersionName":"2.0"
+            }
+            ]
     
-    def test_vulnerabilities(self, client):
-        with pytest.raises(NotImplementedError):
-            client.vulnerabilites() != None
+        }
+        """
+        with requests_mock.Mocker() as m:
+            m.get(f"{TEST_URL}/codeinsight/api/projects/{project_id}/inventorySummary",
+                text=fake_response_json)
+            project_inventory_summary = client.projects.get_inventory_summary(project_id)
+
+        assert len(project_inventory_summary) == 2
+        assert project_inventory_summary[1].id == 12346
+

tests/test_handlers.py

@@ -0,0 +1,19 @@
+import pytest
+
+from codeinsight_sdk import CodeInsightClient
+from codeinsight_sdk.handlers import *
+from codeinsight_sdk.models import *
+
+class TestHandlers(object):
+    @pytest.fixture
+    def client(self):
+        return CodeInsightClient("","")
+    
+    def test_bad_handler(self, client):
+        with pytest.raises(Exception):
+            Handler.create(client, "BadClass")
+    
+    def test_project_handler(self, client):
+        project_handler = Handler.create(client, Project)
+        assert isinstance(project_handler, ProjectHandler)
+        assert issubclass(ProjectHandler, Handler)

tests/test_not_implemented.py

@@ -0,0 +1,46 @@
+import pytest
+
+from codeinsight_sdk import CodeInsightClient
+
+class TestNotImplemented(object):
+
+    @pytest.fixture
+    def client(self):
+        return CodeInsightClient("","")
+
+    ## Coming soon features ##
+    def test_inventories(self, client):
+        with pytest.raises(NotImplementedError):
+            client.inventories() != None
+    
+    def test_vulnerabilities(self, client):
+        with pytest.raises(NotImplementedError):
+            client.vulnerabilites() != None
+    
+    def test_users(self, client):
+        with pytest.raises(NotImplementedError):
+            client.users() != None
+    
+    def test_licenses(self, client):
+        with pytest.raises(NotImplementedError):
+            client.licenses() != None
+
+    def test_tasks(self, client):
+        with pytest.raises(NotImplementedError):
+            client.tasks() != None
+
+    def test_rules(self, client):
+        with pytest.raises(NotImplementedError):
+            client.rules() != None
+
+    def test_reports(self, client):
+        with pytest.raises(NotImplementedError):
+            client.reports() != None
+
+    def test_files(self, client):
+        with pytest.raises(NotImplementedError):
+            client.files() != None
+
+    def test_folders(self, client):
+        with pytest.raises(NotImplementedError):
+            client.folders() != None