ciocore 9.1.0rc2__py2.py3-none-any.whl → 9.1.1b1__py2.py3-none-any.whl

{ciocore-9.1.0rc2.dist-info → ciocore-9.1.1b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ciocore
-Version: 9.1.0rc2
+Version: 9.1.1b1
 Summary: Core functionality for Conductor's client tools
 Home-page: https://github.com/ConductorTechnologies/ciocore
 Author: conductor
@@ -34,8 +34,10 @@ conductor --help
 Get help for a specific sub command
 ```bash
 conductor downloader --help
-conductor uploader --help
-conductor software --help
+conductor upload --help
+conductor download --help
+conductor packages --help
+conductor docs --help
 ```
 
 Example API usage
@@ -46,14 +48,76 @@ print(api_client.request_software_packages()[0])
 ```
 ## Contributing
 
-See [CONTRIBUTING](CONTRIBUTING.md)
+If you are contributing to the Conductor Core project, it's recommended to set up a virtual environment to manage dependencies and isolate your development environment. Follow these steps to get started:
+
+### Setting Up a Virtual Environment
+
+1. **Create a Virtual Environment:**
+
+   Navigate to the root directory of the project and create a virtual environment:
+
+   ```bash
+   python -m venv venv
+   ```
+
+2. **Activate the Virtual Environment:**
+
+   - On Windows:
+
+     ```bash
+     .\venv\Scripts\activate
+     ```
+
+   - On macOS and Linux:
+
+     ```bash
+     source venv/bin/activate
+     ```
+
+3. **Install the Package in Editable Mode:**
+
+   With the virtual environment activated, install the package in editable mode. This allows you to make changes to the code and test them without reinstalling the package:
+
+   ```bash
+   pip install -r requirements.txt # if you want to publish and so on. 
+   pip install -e . # To develop and test the package. 
+   ```
+
+### Running Conductor Commands
+
+Once the package is installed, you can run any Conductor command. Here are a few examples:
+
+- **Display Help for the Main Command:**
+
+  ```bash
+  conductor --help
+  ```
+
+- **Get Help for Specific Subcommands:**
+
+  ```bash
+  conductor download --help
+  conductor upload --help
+  conductor packages --help
+  conductor docs
+  ```
+
+These commands will provide you with detailed information on how to use the Conductor CLI and its subcommands.
+
+For more detailed contribution guidelines, please refer to the [CONTRIBUTING](CONTRIBUTING.md) document.
 
 ## Changelog
 
-## Version:9.1.0-rc.2 -- 12 Dec 2024
+## Version:9.1.1-beta.1 -- 20 Feb 2025
+
+* Added contributor guidelines section to README.md
+* Added validation for job IDs and output paths in download command
+* Improved output path handling in BaseDownloader class
+
+## Version:9.1.0 -- 20 Dec 2024
 
-  * Use the new required jwt parameters
-  * Removing py2.7 compatibility
+  * Added support for new required JWT authentication parameters
+  * Removed Python 2.7 compatibility to focus on modern Python versions
 
 ## Version:8.3.3 -- 04 Dec 2024
 

{ciocore-9.1.0rc2.dist-info → ciocore-9.1.1b1.dist-info}/RECORD

@@ -1,7 +1,7 @@
-ciocore/VERSION,sha256=rK2e-XPKebjaWLwloD4dWey9U5CMdVkZh1nVx-IOI3s,10
+ciocore/VERSION,sha256=FuQPkXEkRVKmKtO24mViA1RsTr3EjFrrRdgT_pg8YAg,12
 ciocore/__init__.py,sha256=aTP7LeeosQA8BZE67gDV4jgfTK5zxmwZRjiTRu_ZWj0,646
 ciocore/api_client.py,sha256=KKL7TsYygNcfkFZDPPq1CSJsrVN_QLK4PqP44vXsCQg,33101
-ciocore/cli.py,sha256=jZ1lOKQiUcrMhsVmD9SVmPMFwHtgDF4SaoAf2-PBS54,15449
+ciocore/cli.py,sha256=Vzoc_3UBQIQfGaoG-Ef2Klh2IBMj5dJCAEiWvWH6tns,17477
 ciocore/client_db.py,sha256=tTz3bl2xeDPPcYSDS3g3QgV_xYihJMx0Kj6OeN2klK0,12978
 ciocore/common.py,sha256=mBIS6KiYoQsjWe6aIFUGRRvCMl8BIN2kmLZ4J8icap8,14982
 ciocore/conductor_submit.py,sha256=bxvzdyNzscAOOOsqTvAYh5DQsTWyCQJNb16Mf-n_F0M,9702
@@ -25,14 +25,14 @@ ciocore/docsite/index.html,sha256=NEK4HaX2yaetTajVtQuTmS9C5cPnkAtxgeKEj7wQ9t0,20
 ciocore/docsite/logo.png,sha256=gArgFFWdw8w985-0TkuGIgU_pW9sziEMZdqytXb5WLo,2825
 ciocore/docsite/objects.inv,sha256=XwmLactPEWWC4fAWqHNPBXGsluRxLLTrwDLQqq51ONY,775
 ciocore/docsite/sitemap.xml,sha256=M_V85zl0y2adRvzJAnoCxlZH_Hl7TLnIb1A-6l_xGmI,109
-ciocore/docsite/sitemap.xml.gz,sha256=5N9BP1xbOEPkbpLHoqTsfzUJD3N4IJB55-_WR8JLfrc,127
-ciocore/docsite/apidoc/api_client/index.html,sha256=kkhKzA7OThkpASLveONRPNS7gGppf8Ot2rxek1lZxHc,189722
+ciocore/docsite/sitemap.xml.gz,sha256=frEWw8iRQPdzBRxKi34sMHbxRw6VmtUsfa4Rvqf6Su8,127
+ciocore/docsite/apidoc/api_client/index.html,sha256=6d-3jDp3qOOWjLlOjbJY8SehOb2ZeX3iXPNEynrA3yA,190619
 ciocore/docsite/apidoc/apidoc/index.html,sha256=GOSvv6KZPOtgekgshRE4j7aDvJkkaiBQLwA_By9J94g,26171
-ciocore/docsite/apidoc/config/index.html,sha256=WDqy4MLR3EMp9T_2-Z9Op61rTFkvb0aTWmtjiR8sbjA,72559
-ciocore/docsite/apidoc/data/index.html,sha256=8ldmfisgelzdWtTqGY8uebvVRcskhbv-reO3hMcIgGI,51627
-ciocore/docsite/apidoc/hardware_set/index.html,sha256=SpYg-lwuCvfLPbNIIM7aQL2jGt-NA5wlVMlIKixGwBo,123042
-ciocore/docsite/apidoc/package_environment/index.html,sha256=V6_ah3V1_4_aOwJbEcITCdwuHxe1vGtfn0maRrbflUs,69248
-ciocore/docsite/apidoc/package_tree/index.html,sha256=5_4vV8x_GmpsyWHnMP62gBaAcdzfM7L-mP7uQKh_DH4,109054
+ciocore/docsite/apidoc/config/index.html,sha256=NAPA-09l_r0CLYPruJZNeRzX_FTucV_oExMpK83EAcY,72835
+ciocore/docsite/apidoc/data/index.html,sha256=ogsCr6IaLXojBInDdIWh74KAsq7W5AILVsHWJa-3t0A,51926
+ciocore/docsite/apidoc/hardware_set/index.html,sha256=9dT-7TuEu8bknDmL51a3nuwUli1BWw1_nMfJRaqqIc4,123985
+ciocore/docsite/apidoc/package_environment/index.html,sha256=mP0vktOJJxo3etQ4755etLDNiO_LrDXVVcoG0s6lIng,69570
+ciocore/docsite/apidoc/package_tree/index.html,sha256=lsXi0MT4PHABR-uhPKb8Yaq4jWMve4Yxk5V3EgG0zxQ,109859
 ciocore/docsite/assets/_mkdocstrings.css,sha256=K3bqYEmxlOHQ3-M11JNbBWHCBDBLarkFRm8HuEYrAG4,341
 ciocore/docsite/assets/images/favicon.png,sha256=AjhUxD_Eslt5XuSVHIAZ494Fk__rb5GLXR8qm0elfP4,1870
 ciocore/docsite/assets/javascripts/bundle.4e31edb1.min.js,sha256=vMxCR_BtNIcbmbPV6j8Z-YDLQ9ckt4RzvGuzCTg034s,97250
@@ -79,12 +79,12 @@ ciocore/docsite/cmdline/docs/index.html,sha256=-TMLZX8gnXwRcWoaylF8zHRwWAo4BHk6g
 ciocore/docsite/cmdline/downloader/index.html,sha256=nygj-0GQmpD79B5AxHjwzQxOFv8vxHiu6LP_T2dN_kg,23171
 ciocore/docsite/cmdline/packages/index.html,sha256=_kXB85PBAgrqW09OerYpxnJuyERHMbcLn6qBGRdyHwk,20923
 ciocore/docsite/cmdline/uploader/index.html,sha256=vuQ06Gys9Eoxs87PXlqnM5AgB6Ag00BlDIy6oaprjis,25123
-ciocore/docsite/how-to-guides/index.html,sha256=KifCHl2S3RfPBZhP1UXwUNWuhcXPlPPqM4Gk6rVGhjQ,20100
+ciocore/docsite/how-to-guides/index.html,sha256=9ZSygr8m3nRpE2JTvifeS9RHleoD3kPjCGZGCs6x-Rk,20192
 ciocore/docsite/search/search_index.json,sha256=LP1ck_wuTP9A_dWTyaVF8Fugg22q1O0XS6hGqg2zk0M,189860
 ciocore/docsite/stylesheets/extra.css,sha256=_Cxe9Dhg1BBi6Kqaz_iZD9z9VyqxA9vtONRjP4PVic0,354
 ciocore/docsite/stylesheets/tables.css,sha256=LE_zwGRxGcdPIy-9QiVPecOzlEBSqZb_WP5vDkFE0ZM,3235
 ciocore/downloader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ciocore/downloader/base_downloader.py,sha256=9PVmP1qy-dop4MbVsmLFvf5W6LKQLUKHPDYE6AEt71g,25784
+ciocore/downloader/base_downloader.py,sha256=yO2gDOeWatJGmHomns9Bvo_dafdtG-_NPWY89-iNCgc,27417
 ciocore/downloader/download_runner_base.py,sha256=cWTWKhFX5FLG84Wh8_s7xpk3n0nmQ4fDiD2rYV6a3u0,1612
 ciocore/downloader/job_downloader.py,sha256=HAhr95RyCsj3KTp5W58Znc4JmqHY-mrM5b8vo6kRIJ0,5697
 ciocore/downloader/legacy_downloader.py,sha256=LIbT3BxuY56lq_UW_io9FSgK_2VIKwFVMENyF-5KllA,51158
@@ -101,10 +101,10 @@ tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/instance_type_fixtures.py,sha256=uIzQduqKQVgjllMuyXaYnRC-pwqk5lnTx3NY2M5Nujo,4320
 tests/package_fixtures.py,sha256=od7ZHofG8ubpQ3PqlUsrcHBcbmD3qVWih9eiIg1WtSQ,5361
 tests/test_api_client.py,sha256=isntMDs3QTyTWdghBa_LbFAiC7ydZD1RWb655oEZo24,14452
-tests/test_base_downloader.py,sha256=SS7tWKv2ZZhpUDk4UCg1TkrNrpntjSewgzLl1mEubSE,3603
+tests/test_base_downloader.py,sha256=Oj50qzt0jNPu34r1tdPRC0crLw1gYeQaDvDNsozYWn4,11804
 tests/test_cli.py,sha256=_WTs2SWlEgd6wtg1hmOBlFnbWVdFLvqp0KqNhy-y2e8,5532
 tests/test_common.py,sha256=5N9xeeGVuwN4kcjIg30eBliUD8PePzCNNLuLipGuTgk,410
-tests/test_config.py,sha256=iiMPwoVA9C3vvGGR6_gKKMbYkSxheNLdljeOA-iPrJU,13295
+tests/test_config.py,sha256=ahDLB6yVX8pA-B1qvxEpcJ1Wf1HS499rEg7lloeyxfk,11526
 tests/test_data.py,sha256=o320GdvOJ2TouWtuA8jcs8Cr_gQWlQ6KxWVSWtmARlY,7614
 tests/test_downloader.py,sha256=hceljsjnuvk5Vk5X4mHgavIEcpbv8ylPwpz7rTwJ-aE,4721
 tests/test_hardware_set.py,sha256=hW7A_suyYdU7WkB7qoHSBPLxaAP2CKqI0i_ULfO5GeY,4408
@@ -118,8 +118,8 @@ tests/test_uploader.py,sha256=JGp6GEyqRXRtbQSb-IW-cCX_BzNotWdCbnJnLwZvpUM,2869
 tests/test_validator.py,sha256=2fY66ayNc08PGyj2vTI-V_1yeCWJDngkj2zkUM5TTCI,1526
 tests/mocks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/mocks/glob.py,sha256=J2MH7nqi6NJOHuGdVWxhfeBd700_Ckj6cLh_8jSNkfg,215
-ciocore-9.1.0rc2.dist-info/METADATA,sha256=5ckG7OoC_iQTAE6keOl-Sc3GgfEihq4xc-2BvA10ZnU,18999
-ciocore-9.1.0rc2.dist-info/WHEEL,sha256=qUzzGenXXuJTzyjFah76kDVqDvnk-YDzY00svnrl84w,109
-ciocore-9.1.0rc2.dist-info/entry_points.txt,sha256=cCqcALMYbC4d8545V9w0Zysfg9MVuKWhzDQ2er4UfGE,47
-ciocore-9.1.0rc2.dist-info/top_level.txt,sha256=SvlM5JlqULzAz00JZWfiUhfjhqDzYzSWssA87zdJl0o,14
-ciocore-9.1.0rc2.dist-info/RECORD,,
+ciocore-9.1.1b1.dist-info/METADATA,sha256=ffXtlEfKw2KYi6mtX-XRyCAaghtxUUDzVhTNflXV5D4,20826
+ciocore-9.1.1b1.dist-info/WHEEL,sha256=qUzzGenXXuJTzyjFah76kDVqDvnk-YDzY00svnrl84w,109
+ciocore-9.1.1b1.dist-info/entry_points.txt,sha256=cCqcALMYbC4d8545V9w0Zysfg9MVuKWhzDQ2er4UfGE,47
+ciocore-9.1.1b1.dist-info/top_level.txt,sha256=SvlM5JlqULzAz00JZWfiUhfjhqDzYzSWssA87zdJl0o,14
+ciocore-9.1.1b1.dist-info/RECORD,,

tests/test_base_downloader.py

@@ -1,21 +1,20 @@
+from concurrent.futures import ThreadPoolExecutor
+from unittest import mock
+from unittest.mock import patch, PropertyMock
+import unittest
+
+from ciocore import api_client
 from ciocore.downloader.base_downloader import (
     BaseDownloader,
-    DEFAULT_NUM_THREADS,
-    DEFAULT_PROGRESS_INTERVAL,
-    DEFAULT_MAX_ATTEMPTS,
     DEFAULT_DELAY,
     DEFAULT_JITTER,
+    DEFAULT_MAX_ATTEMPTS,
+    DEFAULT_NUM_THREADS,
     DEFAULT_PAGE_SIZE,
+    DEFAULT_PROGRESS_INTERVAL,
+    ensure_writable_output_path,
+    ensure_path_valid
 )
-import unittest
-from unittest import mock
-
-from ciocore import api_client
-
-from unittest.mock import  patch
-
-from concurrent.futures import ThreadPoolExecutor
-
 
 class TestBaseDownloaderInit(unittest.TestCase):
     def test_default_values(self):
@@ -37,7 +36,6 @@ class TestBaseDownloaderInit(unittest.TestCase):
         self.assertEqual(downloader.jitter, DEFAULT_JITTER)
         self.assertIsNone(downloader.regex)
 
-
     def test_custom_values(self):
         output_path = "/path/to/destination"
         num_threads = 4
@@ -102,3 +100,181 @@ class TestBaseDownloaderRun(unittest.TestCase):
 
             mock_get_some_tasks.assert_called_with(None)
             self.downloader.download_tasks.assert_called_with(tasks, my_mock_executor)
+
+
+class TestEnsureWritableOutputPath(unittest.TestCase):
+
+    @patch("ciocore.downloader.base_downloader.ensure_path_valid", return_value=True)
+    def test_user_specified_path_is_returned_with_job_id_if_valid(
+        self, mock_ensure_path_valid
+    ):
+        file_info = {"job_id": "00123", "task_id": "task1", "relative_path": "file.txt"}
+        task_info = {"job_id": "00123"}
+        user_specified_path = "/my/new/path"
+
+        result = ensure_writable_output_path(file_info, task_info, user_specified_path)
+        self.assertEqual(result, "/my/new/path/00123")
+        mock_ensure_path_valid.assert_called_with("/my/new/path/00123")
+
+    @patch("ciocore.downloader.base_downloader.ensure_path_valid")
+    @patch("ciocore.downloader.base_downloader.get_fallback_path")
+    def test_user_specified_path_is_invalid_so_fallback_path_is_returned(
+        self, mock_get_fallback_path, mock_ensure_path_valid
+    ):
+        file_info = {"job_id": "00123", "task_id": "task1", "relative_path": "file.txt"}
+        task_info = {"job_id": "00123"}
+        user_specified_path = "/invalid/path"
+
+        # Mock ensure_path_valid to return False for user_specified_path and True for fallback path
+        mock_ensure_path_valid.side_effect = lambda path: "invalid" not in path
+
+        # Mock get_fallback_path to return a specific fallback path
+        fallback_path = "/valid/fallback/path/00123"
+        mock_get_fallback_path.return_value = fallback_path
+
+        result = ensure_writable_output_path(file_info, task_info, user_specified_path)
+
+        # Assert that the fallback path is returned
+        self.assertEqual(result, fallback_path)
+
+        # Ensure that ensure_path_valid was called with the correct paths
+        mock_ensure_path_valid.assert_any_call("/invalid/path/00123")
+        mock_ensure_path_valid.assert_any_call(fallback_path)
+
+        # Ensure get_fallback_path was called with the correct job_id
+        mock_get_fallback_path.assert_called_with(task_info["job_id"])
+
+    @patch("ciocore.downloader.base_downloader.ensure_path_valid")
+    @patch("ciocore.downloader.base_downloader.get_fallback_path") 
+    def test_user_specified_path_and_fallback_path_are_invalid_so_none_is_returned(
+        self, mock_get_fallback_path, mock_ensure_path_valid
+    ):
+        file_info = {
+            "job_id": "00123",
+            "task_id": "task1",
+            "relative_path": "file.txt"
+        }
+        task_info = {"job_id": "00123"}
+        user_specified_path = "/invalid/user/path"
+
+        # Mock ensure_path_valid to return False for all paths
+        mock_ensure_path_valid.return_value = False
+
+        # Mock get_fallback_path to return a specific fallback path
+        mock_get_fallback_path.return_value = "/invalid/fallback/path/00123"
+
+        result = ensure_writable_output_path(file_info, task_info, user_specified_path)
+
+        # Assert that None is returned when no valid paths are found
+        self.assertIsNone(result)
+
+        # Ensure that ensure_path_valid was called with both paths
+        mock_ensure_path_valid.assert_any_call("/invalid/user/path/00123")
+        mock_ensure_path_valid.assert_any_call("/invalid/fallback/path/00123")
+
+        # Ensure get_fallback_path was called with the correct job_id
+        mock_get_fallback_path.assert_called_with(task_info["job_id"])
+
+    @patch("ciocore.downloader.base_downloader.ensure_path_valid", return_value=True)
+    def test_output_dir_is_returned_if_valid_and_no_user_specified_path(
+        self, mock_ensure_path_valid
+    ):
+        file_info = {"output_dir": "/valid/output/dir", "job_id": "00123", "task_id": "task1", "relative_path": "file.txt"}
+        task_info = {"job_id": "00123"}
+ 
+        result = ensure_writable_output_path(file_info, task_info)
+
+        # Assert that the output directory from file_info is returned
+        self.assertEqual(result, file_info["output_dir"])
+
+        # Ensure that ensure_path_valid was called with the correct path
+        mock_ensure_path_valid.assert_called_with(file_info["output_dir"])
+
+    @patch("ciocore.downloader.base_downloader.ensure_path_valid")
+    @patch("ciocore.downloader.base_downloader.get_fallback_path")
+    def test_fallback_path_is_returned_if_output_dir_is_invalid_and_no_user_specified_path(
+        self, mock_get_fallback_path, mock_ensure_path_valid
+    ):
+        file_info = {"output_dir": "/invalid/output/dir", "job_id": "00123", "task_id": "task1", "relative_path": "file.txt"}
+        task_info = {"job_id": "00123"}
+        user_specified_path = None  # No user-specified path
+        fallback_path = "/valid/fallback/path/00123"
+
+        # Mock ensure_path_valid to return False for output_dir and True for fallback path
+        mock_ensure_path_valid.side_effect = lambda path: path == fallback_path
+
+        # Mock get_fallback_path to return a specific fallback path
+        mock_get_fallback_path.return_value = fallback_path
+
+        result = ensure_writable_output_path(file_info, task_info, user_specified_path)
+
+        # Assert that the fallback path is returned
+        self.assertEqual(result, fallback_path)
+
+        # Ensure that ensure_path_valid was called with the correct paths
+        mock_ensure_path_valid.assert_any_call(file_info["output_dir"])
+        mock_ensure_path_valid.assert_any_call(fallback_path)
+
+        # Ensure get_fallback_path was called with the correct job_id
+        mock_get_fallback_path.assert_called_with(task_info["job_id"])
+
+    @patch("ciocore.downloader.base_downloader.ensure_path_valid", return_value=False)
+    @patch("ciocore.downloader.base_downloader.get_fallback_path")
+    def test_none_is_returned_if_output_dir_and_fallback_path_are_invalid(
+        self, mock_get_fallback_path, mock_ensure_path_valid
+    ):
+        file_info = {"output_dir": "/invalid/output/dir", "job_id": "00123", "task_id": "task1", "relative_path": "file.txt"}
+        task_info = {"job_id": "00123"}
+        user_specified_path = None  # No user-specified path
+        fallback_path = "/invalid/fallback/path/00123"
+
+        # Mock get_fallback_path to return a specific fallback path
+        mock_get_fallback_path.return_value = fallback_path
+
+        result = ensure_writable_output_path(file_info, task_info, user_specified_path)
+
+        # Assert that None is returned when no valid paths are found
+        self.assertIsNone(result)
+
+        # Ensure that ensure_path_valid was called with both paths
+        mock_ensure_path_valid.assert_any_call(file_info["output_dir"])
+        mock_ensure_path_valid.assert_any_call(fallback_path)
+
+        # Ensure get_fallback_path was called with the correct job_id
+        mock_get_fallback_path.assert_called_with(task_info["job_id"])
+
+
+class TestEnsurePathValid(unittest.TestCase):
+
+    @patch("ciocore.downloader.base_downloader.os.makedirs")
+    @patch("ciocore.downloader.base_downloader.os")
+    def test_drive_letter_path_on_linux_returns_false(self, mock_os, mock_makedirs):
+        # Set os.name to 'posix' to simulate a Linux environment
+        mock_os.name = 'posix'
+
+        # Define a path with a drive letter
+        path_with_drive_letter = "C:/some/path"
+
+        # Call ensure_path_valid and assert it returns False
+        result = ensure_path_valid(path_with_drive_letter)
+        self.assertFalse(result)
+
+        # Ensure os.makedirs is not called since the path is already invalid
+        mock_makedirs.assert_not_called()
+        
+        
+    @patch("ciocore.downloader.base_downloader.os.makedirs")
+    @patch("ciocore.downloader.base_downloader.os")
+    def test_drive_letter_path_on_windows_calls_makedirs_and_returns_true(self, mock_os, mock_makedirs):
+        # Set os.name to 'nt' to simulate a Windows environment
+        mock_os.name = 'nt'
+
+        # Define a path with a drive letter
+        path_with_drive_letter = "C:/some/path"
+
+        # Call ensure_path_valid and assert it returns True
+        result = ensure_path_valid(path_with_drive_letter)
+        self.assertTrue(result)
+
+        # Ensure os.makedirs is called since the path is valid
+        mock_makedirs.assert_called_with(path_with_drive_letter, exist_ok=True)

tests/test_config.py

@@ -8,7 +8,18 @@ import logging
 
 from unittest import mock
 
-APIKEY = '{"auth_provider_x509_cert_url": "https://www.exampleapis.com/oauth2/v1/certs", "auth_uri": "https://accounts.example.com/o/oauth2/auth", "client_email": "account-5641301770895360@eloquent-vector-104019.iam.gserviceaccount.com", "client_id": "106815243682887997903", "client_x509_cert_url": "https://www.exampleapis.com/robot/v1/metadata/x509/account-5641301770895360%40eloquent-vector-104019.iam.gserviceaccount.com", "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDcadqRWyd7VpYN\n804fEn07qlqNXU0ihz6g2dfbj9gzZDhHGVCI5QvPFskAQcV91k8cDdFu380m+sh1\nz9wlcdaM/lksRV/DRJiV76qrqyrNi0gSekZUuYhSsyMWUGvG4aSbf5BzVf1j8W4I\nUArH+ht5pgdSjowNc4zQIqmMH2XY+Ntr+NysBBfIv1PI6GoHFgDYOTSzsvz0qFYS\nWuonYGTjzNz4CY9Yh5ki8iq0/ijKzpUWeRUkpK9uF7WBoxrj3EyFFHejtfhVX2l0\n2KxrIF0kkmy5nmxVUck76FqdQ6vyvaHudREd3z/08hgdYogemQUTKFE/0LQmKuBV\nIJipPvORAgMBAAECggEAZvPMozN8LBikC00XstzMgRePp1MqydN5NeG6+TPlrQ+F\nV/RjkSXHT8oZRdTy3dXB6t0rc4n2xdvC0YCvGBBlwkK1vT+EPO2oBfTF99yCKDME\nDZlui3mDyvkgjPYweVuBKx65Bp5mNo4ZMqnMd18EAVxDM9UgZtIPtlJSdoBd7qtk\nyCGr03l+SV0krmvPV+KS9vyDOg/7Km5gMhTMaIveNyS1pG6AmZ0ggQA5djg/P2iF\nxGwYdvfADY5cBzg0OG5ELv9hvyA4CKN6RLfYv3JJS2gbNaMknjmsjaM/p0LtE2HL\n+uFPL0ZjoMwV3BlEFQIHwhNWS63H43ISBa1/2XvGPwKBgQDw4a4kQ9+Ce3edWonz\n3Fm/3no+HrMSVjbv28qphAHMFrSUdbMejQm4QSbNeOW1pEcVvW21u8tYagrJEsaU\ns4DulFXRep36teVDWpc1FrNowWEPPVeC8CO74VfssK1h2Itqis8JPbzXOcNtSH9+\nAg1EvrB9XnyEvJuM6GOGo3juTwKBgQDqP058+H3iSZe6al4P6Ib3g/82nr2dHeN5\n4xxGu1fzTMNX5lopbNji6tQcsMoMVPdOvCQy5c0PEUbvo7mxfZ8fOZwgBjIcXbYg\nzIJkPTSv7nxSE5M5lW5juzLkdq2k5k0qt9ByWuWEA3PSn/DEANa5888phSCoJSw/\nPjpwHhZoHwKBgQDCoQbMxI6e5lYCrToT8PIPhpptAO8dnM2sxoGcsE2ncp0b63H7\n+GdnGjVZBhtMxdyt4y33DjLCUIRAbUxIsDU4EGC67oEhJsGEx3iva5Uwyjc7UgwY\nfyHQV8ZsN2EQUyBqyJd6VwjzOff+n/prfQrthcoisiqYMbDZjJeGHSXEHwKBgAo4\nBsmG4Z78jOTx/PZ+s1ya4ohUdnsjMahAkxw20ghoIeF0yBwkhnWnvucdg0L0dfF2\nXbHmuoJcw5ZyswgeLdHj5n6zJn58TBS0Nz/+N40xPzUpa3PIpA8vvHGhB8Q408b4\nS9yhQH/40pWuqocybiugijoKd7k+HecIZO49MccLAoGBAPDScJHSxKPW6wJKjxDC\nXXWWQ2flbwv4Sja487QV/trWMSRnHJHnCVHqv/F7ThPaoHM+MJSzrJ7wr/CJhk0H\noEt+0Rn6qPd/A36bSjTfXMFLXWi75ovek+IJGKxr7B46jrcS/oe1XIIOlV1+OvOY\nVoO6vgYkPhpMkth2hyZ/luea\n-----END PRIVATE KEY-----\n", "private_key_id": "3dfe3bdc40d4dc431d283bf22feb113c9b622dd3", "project_id": "eloquent-vector-104019", "token_uri": "https://oauth2.exampleapis.com/token", "type": "service_account"}'
+MOCK_API_KEY = '''{
+    "type": "service_account",
+    "project_id": "mock-project",
+    "private_key_id": "mock-key-id",
+    "private_key": "-----BEGIN PRIVATE KEY-----\\nMOCKKEY\\n-----END PRIVATE KEY-----\\n",
+    "client_email": "mock@example.com",
+    "client_id": "123456789",
+    "auth_uri": "https://accounts.example.com/oauth2/auth",
+    "token_uri": "https://oauth2.example.com/token",
+    "auth_provider_x509_cert_url": "https://www.example.com/oauth2/v1/certs",
+    "client_x509_cert_url": "https://www.example.com/robot/v1/metadata/x509/mock%40example.com"
+}'''
 
 PY3 = sys.version_info >= (3, 0)
 BUILTIN_OPEN = "builtins.open" if PY3 else "__builtin__.open"
@@ -264,7 +275,7 @@ class ApiKeyFromVariableTest(unittest.TestCase):
         self.down()
 
     def test_returns_dict_if_key_is_b64encoded(self):
-        key = APIKEY
+        key = MOCK_API_KEY
         if sys.version_info < (3, 0):
             self.up(env={"CONDUCTOR_API_KEY": base64.b64encode(key)})
         else:
@@ -299,7 +310,7 @@ class ApiKeyFromFileTest(unittest.TestCase):
         self.assertEqual(result, None)
         self.down()
 
-    @mock.patch(BUILTIN_OPEN, new_callable=mock.mock_open, read_data=APIKEY, create=True)
+    @mock.patch(BUILTIN_OPEN, new_callable=mock.mock_open, read_data=MOCK_API_KEY, create=True)
     def test_open_called_with_api_key_path(self, mock_file_open):
         self.up(env={"CONDUCTOR_API_KEY_PATH": "path/to/api_key"})
         config.Config.get_api_key_from_file()
@@ -313,7 +324,7 @@ class ApiKeyFromFileTest(unittest.TestCase):
             config.Config.get_api_key_from_file()
         self.down()
 
-    @mock.patch(BUILTIN_OPEN, new_callable=mock.mock_open, read_data=APIKEY, create=True)
+    @mock.patch(BUILTIN_OPEN, new_callable=mock.mock_open, read_data=MOCK_API_KEY, create=True)
     def test_returns_dict_if_key_is_valid_json(self, mock_file_open):
         self.up(env={"CONDUCTOR_API_KEY_PATH": "path/to/api_key"})
         result = config.Config.get_api_key_from_file()