Merge pull request #34 from fossology/feat/support-1.1.0

Feat/support 1.1.0

Author: deveaud-m

.github/workflows/fossologytests.yml

@@ -32,7 +32,7 @@ jobs:
         run: nmap fossology -p 80
       - name: Run tests
         run: |
-          poetry run coverage run --source=fossology tests/tests.py
+          poetry run coverage run --source=fossology -m pytest
           poetry run coverage report -m
           poetry run codecov -t ${{ secrets.CODECOV_TOKEN }}
  

README.rst

@@ -22,7 +22,7 @@ A simple wrapper for the Fossology REST API.
 
 See `the OpenAPI specification <https://raw.githubusercontent.com/fossology/fossology/master/src/www/ui/api/documentation/openapi.yaml>`_ used to implement this library.
 
-   Compatible with API version 1.0.16
+   Compatible with API version 1.1.0
 
 Documentation
 =============
@@ -151,6 +151,6 @@ The testsuite available in this project expects a running Fossology instance und
 
   .. code:: shell
 
-     poetry run coverage run --source=fossology tests/tests.py
+     poetry run coverage run --source=fossology -m pytest
      poetry run coverage report -m
      poetry run coverage html

fossology/__init__.py

@@ -6,12 +6,17 @@
 import requests
 from datetime import date, timedelta
 
-from .obj import Agents, User, TokenScope, SearchTypes
-from .folders import Folders
-from .uploads import Uploads
-from .jobs import Jobs
-from .report import Report
-from .exceptions import AuthenticationError, FossologyApiError
+from typing import List
+from fossology.obj import Agents, User, File, TokenScope, SearchTypes, get_options
+from fossology.folders import Folders
+from fossology.uploads import Uploads
+from fossology.jobs import Jobs
+from fossology.report import Report
+from fossology.exceptions import (
+    AuthenticationError,
+    AuthorizationError,
+    FossologyApiError,
+)
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
@@ -36,12 +41,12 @@ def fossology_token(
     :param password: the password of the user
     :param name: the name of the token
     :param scope: the scope of the token (default: READ)
-    :param expire: the expire date of the token (default max. 30 days)
+    :param expire: the expire date of the token (default: max. 30 days)
     :type url: string
     :type username: string
     :type password: string
     :type name: string
-    :type scope: TokenScope (default TokenScope.READ)
+    :type scope: TokenScope (default: TokenScope.READ)
     :type expire: string, e.g. 2019-12-25
     :return: the new token
     :rtype: string
@@ -208,7 +213,7 @@ def delete_user(self, user):
         :raises FossologyApiError: if the REST call failed
         """
         response = self.session.delete(f"{self.api}/users/{user.id}")
-        print(response.json())
+
         if response.status_code == 202:
             return
         else:
@@ -224,6 +229,7 @@ def search(
         filesizemax=None,
         license=None,
         copyright=None,
+        group=None,
     ):
         """Search for a specific file
 
@@ -236,16 +242,19 @@ def search(
         :param filesizemax: Max filesize in bytes
         :param license: License search filter
         :param copyright: Copyright search filter
+        :param group: the group name to choose while performing search (default: None)
         :type searchType: SearchType Enum
         :type filename: string
         :type tag: string
         :type filesizemin: int
         :type filesizemax: int
         :type license: string
         :type copyright: string
+        :type group: string
         :return: list of items corresponding to the search criteria
         :rtype: JSON
         :raises FossologyApiError: if the REST call failed
+        :raises AuthorizationError: if the user can't access the group
         """
         headers = {"searchType": searchType.value}
         if filename:
@@ -260,10 +269,61 @@ def search(
             headers["license"] = license
         if copyright:
             headers["copyright"] = copyright
+        if group:
+            headers["groupName"] = group
 
         response = self.session.get(f"{self.api}/search", headers=headers)
+
         if response.status_code == 200:
             return response.json()
+
+        elif response.status_code == 403:
+            description = f"Searching {get_options(group)}not authorized"
+            raise AuthorizationError(description, response)
+
         else:
             description = "Unable to get a result with the given search criteria"
             raise FossologyApiError(description, response)
+
+    def filesearch(
+        self, filelist: List = [], group: str = None,
+    ):
+        """Search for files from hash sum
+
+        API Endpoint: POST /filesearch
+
+        The response does not generate Python objects yet, the plain JSON data is simply returned.
+
+        :param filelist: the list of files (or containers) to search for (default: [])
+        :param group: the group name to choose while performing search (default: None)
+        :type filelist: list
+        :return: list of items corresponding to the search criteria
+        :type group: string
+        :rtype: JSON
+        :raises FossologyApiError: if the REST call failed
+        :raises AuthorizationError: if the user can't access the group
+        """
+        headers = {}
+        if group:
+            headers["groupName"] = group
+
+        response = self.session.post(
+            f"{self.api}/filesearch", headers=headers, json=filelist
+        )
+
+        if response.status_code == 200:
+            all_files = []
+            for hash_file in response.json():
+                if hash_file.get("findings"):
+                    all_files.append(File.from_json(hash_file))
+                else:
+                    return "Unable to get a result with the given filesearch criteria"
+            return all_files
+
+        elif response.status_code == 403:
+            description = f"Searching {get_options(group)}not authorized"
+            raise AuthorizationError(description, response)
+
+        else:
+            description = "Unable to get a result with the given filesearch criteria"
+            raise FossologyApiError(description, response)

fossology/exceptions.py

@@ -35,7 +35,7 @@ def __init__(self, description, response):
 class FossologyApiError(Error):
     """Error during a Fossology GET request"""
 
-    def __init__(self, description, response):
+    def __init__(self, description, response=None):
         try:
             message = response.json().get("message")
         except JSONDecodeError:

fossology/folders.py

@@ -3,8 +3,8 @@
 
 import logging
 
-from .obj import Folder
-from .exceptions import AuthorizationError, FossologyApiError
+from fossology.obj import Folder, get_options
+from fossology.exceptions import AuthorizationError, FossologyApiError
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
@@ -58,7 +58,7 @@ def detail_folder(self, folder_id):
             description = f"Error while getting details for folder {folder_id}"
             raise FossologyApiError(description, response)
 
-    def create_folder(self, parent, name, description=None):
+    def create_folder(self, parent, name, description=None, group=None):
         """Create a new (sub)folder
 
         The name of the new folder must be unique under the same parent.
@@ -67,20 +67,25 @@ def create_folder(self, parent, name, description=None):
 
         :param parent: the parent folder
         :param name: the name of the folder
-        :param description: a meaningful description for the folder (optional)
+        :param description: a meaningful description for the folder (default: None)
+        :param group: the name of the group chosen to create the folder (default: None)
         :type parent: Folder() object
         :type name: str
         :type description: str
+        :type group: string
         :return: the folder newly created (or already existing) - or None
         :rtype: Folder() object
         :raises FossologyApiError: if the REST call failed
-        :raises AuthorizationError: if the user is not allowed to write in the folder
+        :raises AuthorizationError: if the user is not allowed to write in the folder or access the group
         """
         headers = {
             "parentFolder": f"{parent.id}",
             "folderName": f"{name}",
             "folderDescription": f"{description}",
         }
+        if group:
+            headers["groupName"] = group
+
         response = self.session.post(f"{self.api}/folders", headers=headers)
 
         if response.status_code == 200:
@@ -96,7 +101,7 @@ def create_folder(self, parent, name, description=None):
             return self.detail_folder(response.json()["message"])
 
         elif response.status_code == 403:
-            description = f"Folder creation in parent {parent} not authorized"
+            description = f"Folder creation {get_options(group, parent)}not authorized"
             raise AuthorizationError(description, response)
         else:
             description = f"Unable to create folder {name} under {parent}"
@@ -130,7 +135,7 @@ def update_folder(self, folder, name=None, description=None):
             logger.info(f"{folder} has been updated")
             return folder
         else:
-            description = f"Unable to update folder {folder}"
+            description = f"Unable to update folder {folder.id}"
             raise FossologyApiError(description, response)
 
     def delete_folder(self, folder):

fossology/jobs.py

@@ -5,8 +5,8 @@
 import time
 import logging
 
-from .obj import Job
-from .exceptions import FossologyApiError
+from fossology.obj import Job, get_options
+from fossology.exceptions import AuthorizationError, FossologyApiError
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
@@ -15,30 +15,28 @@
 class Jobs:
     """Class dedicated to all "jobs" related endpoints"""
 
-    def list_jobs(self, page_size=20, pages=1, upload=None):
+    def list_jobs(self, page_size=20, page=1, upload=None):
         """Get all available jobs
 
         API Endpoint: GET /jobs
 
         The answer is limited to the first page of 20 results by default
 
         :param page_size: the maximum number of results per page
-        :param pages: the number of pages to be retrieved
+        :param page: the number of pages to be retrieved
         :param upload: list only jobs of the given upload (default: None)
         :type page_size: int (default: 20)
-        :type pages: int (default: 1)
+        :type page: int (default: 1)
         :type upload: Upload
         :return: the jobs data
         :rtype: list of Job
         :raises FossologyApiError: if the REST call failed
         """
-        headers = {"limit": str(page_size), "pages": str(pages)}
+        params = {}
+        headers = {"limit": str(page_size), "page": str(page)}
         if upload:
-            response = self.session.get(
-                f"{self.api}/jobs?upload={upload.id}", headers=headers
-            )
-        else:
-            response = self.session.get(f"{self.api}/jobs", headers=headers)
+            params["upload"] = upload.id
+        response = self.session.get(f"{self.api}/jobs", params=params, headers=headers)
         if response.status_code == 200:
             jobs_list = list()
             for job in response.json():
@@ -54,7 +52,7 @@ def detail_job(self, job_id, wait=False, timeout=30):
         API Endpoint: GET /jobs/{id}
 
         :param job_id: the id of the job
-        :param wait: wait until the job is finisched (default: False)
+        :param wait: wait until the job is finished (default: False)
         :param timeout: stop waiting after x seconds (default: 30)
         :type: int
         :type wait: boolean
@@ -84,7 +82,7 @@ def detail_job(self, job_id, wait=False, timeout=30):
             description = f"Error while getting details for job {job_id}"
             raise FossologyApiError(description, response)
 
-    def schedule_jobs(self, folder, upload, spec, wait=False, timeout=30):
+    def schedule_jobs(self, folder, upload, spec, group=None, wait=False, timeout=30):
         """Schedule jobs for a specific upload
 
         API Endpoint: POST /jobs
@@ -123,30 +121,42 @@ def schedule_jobs(self, folder, upload, spec, wait=False, timeout=30):
         :param folder: the upload folder
         :param upload: the upload for which jobs will be scheduled
         :param spec: the job specification
+        :param group: the group name to choose while scheduling jobs (default: None)
         :param wait: wait for the scheduled job to finish (default: False)
         :param timeout: stop waiting after x seconds (default: 30)
         :type upload: Upload
         :type folder: Folder
         :type spec: dict
+        :type group: string
         :type wait: boolean
         :type timeout: 30
         :return: the job id
         :rtype: Job
         :raises FossologyApiError: if the REST call failed
+        :raises AuthorizationError: if the user can't access the group
         """
         headers = {
             "folderId": str(folder.id),
             "uploadId": str(upload.id),
             "Content-Type": "application/json",
         }
+        if group:
+            headers["groupName"] = group
+
         response = self.session.post(
             f"{self.api}/jobs", headers=headers, data=json.dumps(spec)
         )
+
         if response.status_code == 201:
             detailled_job = self.detail_job(
                 response.json()["message"], wait=wait, timeout=timeout
             )
             return detailled_job
+
+        elif response.status_code == 403:
+            description = f"Scheduling job {get_options(group)}not authorized"
+            raise AuthorizationError(description, response)
+
         else:
-            description = "Scheduling jobs for upload {upload.uploadname} failed"
+            description = f"Scheduling jobs for upload {upload.uploadname} failed"
             raise FossologyApiError(description, response)