Merge pull request #20 from Renfu-Li/fix/outPath

Issue 12 make outPath accept both str and Path

src/onc/modules/_DataProductFile.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from time import sleep, time
 from warnings import warn
 
@@ -41,7 +42,7 @@ def download(
         self,
         timeout: int,
         pollPeriod: float,
-        outPath: str,
+        outPath: Path,
         maxRetries: int,
         overwrite: bool,
     ):

src/onc/modules/_OncArchive.py

@@ -1,5 +1,6 @@
 import os
 import time
+from pathlib import Path
 
 import humanize
 import requests
@@ -50,7 +51,7 @@ def getFile(self, filename: str = "", overwrite: bool = False):
 
         if response.ok:
             # Save file to output path
-            outPath = self._config("outPath")
+            outPath: Path = self._config("outPath")
             saveAsFile(response, outPath, filename, overwrite)
 
         else:
@@ -109,8 +110,8 @@ def getDirectFiles(
         downInfos = []
         for filename in dataRows["files"]:
             # only download if file doesn't exist (or overwrite is True)
-            outPath = self._config("outPath")
-            filePath = f"{outPath}/{filename}"
+            outPath: Path = self._config("outPath")
+            filePath = outPath / filename
             fileExists = os.path.exists(filePath)
 
             if (not fileExists) or (fileExists and overwrite):

src/onc/modules/_util.py

@@ -1,28 +1,24 @@
-import os
 from datetime import timedelta
+from pathlib import Path
 
 import humanize
 import requests
 
 
 def saveAsFile(
-    response: requests.Response, filePath: str, fileName: str, overwrite: bool
+    response: requests.Response, outPath: Path, fileName: str, overwrite: bool
 ) -> None:
     """
     Saves the file downloaded in the response object, in the outPath, with filename
     If overwrite, will overwrite files with the same name
     """
-    fullPath = fileName
-    if len(filePath) > 0:
-        fullPath = filePath + "/" + fileName
-        # Create outPath directory if not exists
-        if not os.path.exists(filePath):
-            os.makedirs(filePath)
+    filePath = outPath / fileName
+    outPath.mkdir(parents=True, exist_ok=True)
 
     # Save file in outPath if it doesn't exist yet
-    if os.path.exists(fullPath) and not overwrite:
-        raise FileExistsError(str(fullPath))
-    with open(fullPath, "wb+") as file:
+    if Path.exists(filePath) and not overwrite:
+        raise FileExistsError(filePath)
+    with open(filePath, "wb+") as file:
         file.write(response.content)
 
 

src/onc/onc.py

@@ -30,17 +30,9 @@ def __init__(
         self.showInfo = showInfo
         self.timeout = timeout
         self.baseUrl = "https://data.oceannetworks.ca/"
-        self.outPath = ""
+        self._out_path = Path(outPath).resolve()
 
-        outPath = str(outPath)
-        # sanitize outPath
-        if len(outPath) > 0:
-            outPath = outPath.replace("\\", "/")
-            if outPath[-1] == "/":
-                outPath = outPath[:-1]
-            self.outPath = outPath
-
-        # switch to qa if needed
+        # Switch to qa if needed
         if not production:
             self.baseUrl = "https://qa.oceannetworks.ca/"
 
@@ -50,16 +42,30 @@ def __init__(
         self.realTime = _OncRealTime(self)
         self.archive = _OncArchive(self)
 
+    # Add getter and setter for self._out_path
+    @property
+    def outPath(self):
+        return self._out_path
+
+    @outPath.setter
+    def outPath(self, outPath):
+        self._out_path = Path(outPath).resolve()
+
     def print(self, obj, filename: str = ""):
         """
         Helper for printing a JSON dictionary to the console or to a file
-        @filename: if present, creates the file and writes the output in it
+        @filename: if present, creates a file with a ".json" extension
+            in "self._out_path" directory, and writes the output to the file.
+            if not present, prints the output to the console.
         """
         text = json.dumps(obj, indent=4)
         if filename == "":
             print(text)
         else:
-            with open(filename, "w+") as file:
+            filePath = self._out_path / filename
+            filePath = filePath.with_suffix(".json")
+
+            with open(filePath, "w+") as file:
                 file.write(text)
 
     def formatUtc(self, dateString: str = "now"):

tests/README.md

@@ -1,84 +1,94 @@
 # Testing Documentation
 
-This directory contains an automated test suite written for the Python API client using 
+This directory contains an automated test suite written for the Python API client using
 the [Robot Framework](http://robotframework.org) (RF from now on) as well as pytest.
 
 Directory structure is as follows:
 
-* libraries: Python 3 library files used in the tests
-* output:    Default output directory for methods that download files (i.e. orderDataProduct())
-* pytests:   Tests converted from RF to pytest format
-* resources: Robot generic scripts to be reused by tests
-* suites:    Test suites
+- libraries: Python 3 library files used in the tests
+- output: Default output directory for methods that download files (i.e. orderDataProduct())
+- pytests: Tests converted from RF to pytest format
+- resources: Robot generic scripts to be reused by tests
+- suites: Test suites
 
 Read the test suites (.robot files) in "suites" to understand what exactly is being tested.
 Test suites contain the test cases in the "Test Cases" section, and are written in a language similar to english.
 
-
 ## Testing Requirements
 
 1. Make sure Python 3 and pip are installed properly. It is highly suggested to use a virtual environment.
 2. Install [Robot Framework](https://robotframework.org/) and [python-dotenv](https://saurabh-kumar.com/python-dotenv/)
+
 ```shell
 pip install robotframework python-dotenv
 ```
+
 (or use "pip3" depending on your system configuration)
 
 3. Optional: install [pabot](https://pabot.org/) for test parallelization:
+
 ```shell
 pip install -U robotframework-pabot
 ```
+
 4. Install this project in editable mode (assume the current directory is the root)
+
 ```shell
 pip install -e .
 ```
 
-
 ## Running the Tests
 
-In the terminal, run all tests from the root directory. 
+In the terminal, run all tests from the root directory.
 Tests can also be run from a different folder. Just change the relative path of the test suites.
 
 Create a `.env` file under tests folder and put TOKEN variable in the file.
 If you are on Windows, make sure the encoding of `.env` file is UTF-8 after using the command below.
+
 ```shell
 echo TOKEN=${YOUR_TOKEN} > .env
 ```
 
-The default testing environment is PROD. If you are an internal developer, add the following line to .env so that the tests are running against QA. 
+The default testing environment is PROD. If you are an internal developer, add the following line to .env so that the tests are running against QA.
 
 ```shell
 echo ONC_ENV=QA >> .env
 ```
+
 Change ONC_ENV value from QA to PROD if testing in PROD is needed. Removing the line also does the trick.
 
-*To run all the RF test suites (parallelized):*
+_To run all the RF test suites (parallelized):_
+
 ```shell
-pabot --testlevelsplit tests/suites
+pabot --testlevelsplit tests/robot/suites
 ```
 
-*To run a single RF test suite (replace 0X with the prefix of the test file name, e.g., 01):*
+_To run a single RF test suite (replace 0X with the prefix of the test file name, e.g., 01):_
+
 ```shell
-robot tests/suites/01*    # robot tests/suites/0X*
+robot tests/robot/suites/01*    # robot tests/robot/suites/0X*
 ```
 
-*To run a single RF test in a test suite (replace Y with the prefix of the test name, e.g., 01):*
+_To run a single RF test in a test suite (replace Y with the prefix of the test name, e.g., 01):_
+
 ```shell
-robot --test "01*" tests/suites/01*  # robot --test "Y*" tests/suites/0X*
+robot --test "01*" tests/robot/suites/01*  # robot --test "Y*" tests/robot/suites/0X*
 ```
 
-*To run pytest*
+_To run pytest_
+
 ```shell
 pytest
 ```
 
-*`--variable TOKEN:${YOUR_TOKEN}` can be used if no `.env` file is present*
+_`--variable TOKEN:${YOUR_TOKEN}` can be used if no `.env` file is present_
+
 ```shell
-robot --variable TOKEN:${YOUR_TOKEN} tests/suites/01*
+robot --variable TOKEN:${YOUR_TOKEN} tests/robot/suites/01*
 ```
 
 Additionally, You can check the three bash files (testall, testcoverage and testsuite) for running the test suites.
-Robot Framework also has plugins for IDEs like VS Code and Pycharm that makes running tests easier. 
+Robot Framework also has plugins for IDEs like VS Code and Pycharm that makes running tests easier.
 
 After tests finish, review the summary and logs in the root directory.
 
@@ -92,18 +102,16 @@ just make the required changes, no coding knowledge is required.
 For anything more advanced than that, please read the Robot Framework Documentation and consider keeping
 the directory structure relevant.
 
-
 ## Code Documentation
 
 Robot Framework promotes test cases written almost in plain english (if you need to document it, you're writing it wrong).
-Still, code documentation is welcome if ever required. 
+Still, code documentation is welcome if ever required.
 If you are an internal user of Ocean Networks Canada, please refer to the [internal documentation page](https://internal.oceannetworks.ca/display/ONCData/11+-+Automated+User+Tests+for+API+Client+Libraries).
 
-
 ## Acknowledgements
 
 Initial author: Dany Cabrera
 
 Maintainers: Kan Fu
 
-Previous maintainers: Dany Cabrera
+Previous maintainers: Dany Cabrera

tests/robot/libraries/delivery.py

@@ -1,5 +1,7 @@
 # delivery services' tests
 
+from pathlib import Path
+
 from common import onc
 
 

tests/robot/suites/00__initial.robot

@@ -20,5 +20,5 @@ Resource         ../resources/general.robot
     Prepare output directory  output/00/03
     ${onc3}=                Make ONC with path         output/00/03
     ${result}=              Call Method     ${onc3}  getLocations  ${F_LOCATIONCODE}
-    Call Method             ${onc3}         print    ${result}     output/00/03/03.json
+    Call Method             ${onc3}         print    ${result}     03.json
     File Should Exist       output/00/03/03.json