ciocore 8.0.1__py2.py3-none-any.whl → 8.1.0__py2.py3-none-any.whl

{ciocore-8.0.1.dist-info → ciocore-8.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ciocore
-Version: 8.0.1
+Version: 8.1.0
 Summary: Core functionality for Conductor's client tools
 Home-page: https://github.com/ConductorTechnologies/ciocore
 Author: conductor
@@ -51,6 +51,10 @@ See [CONTRIBUTING](CONTRIBUTING.md)
 
 ## Changelog
 
+## Version:8.1.0 -- 10 Jun 2024
+
+* Adds two new calls to the API to get usage; get_compute_usage() and get_storage_usage()
+
 ## Version:8.0.1 -- 22 Apr 2024
 
 * The uploader now sends all error messages to the dashboard - not just the first error.

{ciocore-8.0.1.dist-info → ciocore-8.1.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-ciocore/VERSION,sha256=NUqt24vsbMosc7cU07CLlLBV2gAdKgs8roFBqy0xjlA,5
+ciocore/VERSION,sha256=tLQREuN8_s0dGaKmIQt0W8MTSuMhtDpdcGwzW80I8nk,5
 ciocore/__init__.py,sha256=aTP7LeeosQA8BZE67gDV4jgfTK5zxmwZRjiTRu_ZWj0,646
-ciocore/api_client.py,sha256=TyHXGmK4uTmKV93O_IpAvttZhbexIIZTGP-IVn_WyWM,24599
+ciocore/api_client.py,sha256=SBxEwAiwn2XtH7T_ipefUbWhczXjoNdNbQBur1RV-Bw,32810
 ciocore/cli.py,sha256=jZ1lOKQiUcrMhsVmD9SVmPMFwHtgDF4SaoAf2-PBS54,15449
 ciocore/client_db.py,sha256=tTz3bl2xeDPPcYSDS3g3QgV_xYihJMx0Kj6OeN2klK0,12978
 ciocore/common.py,sha256=mBIS6KiYoQsjWe6aIFUGRRvCMl8BIN2kmLZ4J8icap8,14982
@@ -24,10 +24,10 @@ ciocore/auth/server.py,sha256=8btX9-EokUl6q55V8muDmEV2tvvbTBD0BHeWFbwkzUc,3892
 ciocore/docsite/404.html,sha256=zUCnDe9r5yFZh8MXcTmzDaFyYBuRHz1gvuyJS2rYiTI,17207
 ciocore/docsite/index.html,sha256=xz215H_KHWBYI1HT7IRpAZ4d1ptUiO8Y4DlOmbEPgPk,20945
 ciocore/docsite/logo.png,sha256=gArgFFWdw8w985-0TkuGIgU_pW9sziEMZdqytXb5WLo,2825
-ciocore/docsite/objects.inv,sha256=s2FKStLlVIQbfG7U2-nw-7rz4unvd1W0u00YtLBxAKo,758
+ciocore/docsite/objects.inv,sha256=XwmLactPEWWC4fAWqHNPBXGsluRxLLTrwDLQqq51ONY,775
 ciocore/docsite/sitemap.xml,sha256=M_V85zl0y2adRvzJAnoCxlZH_Hl7TLnIb1A-6l_xGmI,109
-ciocore/docsite/sitemap.xml.gz,sha256=mBXMN84utPFOOhXBKJnq47kV3Zp6NvUz5Xxy7lDOxq8,127
-ciocore/docsite/apidoc/api_client/index.html,sha256=0AdyUY-LmL5ZqUeqxIjjzmoZDbupNcImCWf7RFeO5-o,170218
+ciocore/docsite/sitemap.xml.gz,sha256=rZcI755TcvgYJvqQWgKtBrKCVKxIJd1pLTDyxi4NFv8,127
+ciocore/docsite/apidoc/api_client/index.html,sha256=mh9VwU1J3Ks6MWvo5a-PcUt5GYdm8s7KsIVDWfnOeXY,188372
 ciocore/docsite/apidoc/apidoc/index.html,sha256=KGsHBY6GBF380w338GfOIMWnwAyyLvw2i1RQFORdwlE,26171
 ciocore/docsite/apidoc/config/index.html,sha256=n3koKPRUza5-uHUt8hK8H8XyH6HG_U2CsGobdaN4KfY,72559
 ciocore/docsite/apidoc/data/index.html,sha256=QhqiXUd_3qk_jGRYB5JiqlJTem8Jg7aKa5mPPDT1978,50850
@@ -81,7 +81,7 @@ ciocore/docsite/cmdline/downloader/index.html,sha256=917XE3waukGnIXI9qxl0zYEf3vH
 ciocore/docsite/cmdline/packages/index.html,sha256=Ssb2R7eSubBNR824oc3jjhJfrG3JKOPojA-uiAczgeQ,20923
 ciocore/docsite/cmdline/uploader/index.html,sha256=TtLbHNlu4ofZ4bQBqam87RelWdHnVDSL7_rw_YqBbC8,25123
 ciocore/docsite/how-to-guides/index.html,sha256=rF-DMyk4k_jGUJRF3dKtMMiOgXS8OvBqAn-zxWy3AGs,20100
-ciocore/docsite/search/search_index.json,sha256=ZMAbHLAlwOTujgA32XJTA7SHogRYh9i-ioPFOxjjJ0s,182633
+ciocore/docsite/search/search_index.json,sha256=vBLU-rkC0pxOPX0O3MNKXRKGfgsaS1-91KsV17Gf9SY,189092
 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
@@ -103,7 +103,7 @@ tests/extra_env_fixtures.py,sha256=8qvU4d8SXGKzRVNR5whVqKCQOwOVMiFVfbKBAjxa2gE,1
 tests/instance_type_fixtures.py,sha256=uIzQduqKQVgjllMuyXaYnRC-pwqk5lnTx3NY2M5Nujo,4320
 tests/package_fixtures.py,sha256=CsJnhB7oYzIxJH7b1tCOPyvnnVSCqEbSPhtCnsHL-nA,5070
 tests/project_fixtures.py,sha256=iBm_th_JtAw76vlNu7Jjhh9tLH4oOaNi-MgtPzCV7yQ,138
-tests/test_api_client.py,sha256=tnYkIYvDILGJRatZM0nrtr83x8yBJstMP0Rt151U2gI,6757
+tests/test_api_client.py,sha256=4jhj-YrBPcLj7XZn3ngguau2DPxpCYGMSuqPJ3hW0GQ,14497
 tests/test_base_downloader.py,sha256=SS7tWKv2ZZhpUDk4UCg1TkrNrpntjSewgzLl1mEubSE,3603
 tests/test_cli.py,sha256=_WTs2SWlEgd6wtg1hmOBlFnbWVdFLvqp0KqNhy-y2e8,5532
 tests/test_common.py,sha256=tY_-SY-JmJX09UehFs9RIDqZ785AmhfTl6eVKJeIUFY,763
@@ -120,8 +120,8 @@ tests/test_uploader.py,sha256=B1llTJt_fqR6e_V_Jxfw9z73QgkFlEPU87xLYGzt-TQ,2914
 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-8.0.1.dist-info/METADATA,sha256=798KBccoox0YMHAcd09zV7pIzVkXN_GNoBWhckmK4D4,18440
-ciocore-8.0.1.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-ciocore-8.0.1.dist-info/entry_points.txt,sha256=cCqcALMYbC4d8545V9w0Zysfg9MVuKWhzDQ2er4UfGE,47
-ciocore-8.0.1.dist-info/top_level.txt,sha256=SvlM5JlqULzAz00JZWfiUhfjhqDzYzSWssA87zdJl0o,14
-ciocore-8.0.1.dist-info/RECORD,,
+ciocore-8.1.0.dist-info/METADATA,sha256=lXpW_6Xfu_wAL__6D_ePH3DcB7oyBRtIMNvv_3sK3bo,18564
+ciocore-8.1.0.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+ciocore-8.1.0.dist-info/entry_points.txt,sha256=cCqcALMYbC4d8545V9w0Zysfg9MVuKWhzDQ2er4UfGE,47
+ciocore-8.1.0.dist-info/top_level.txt,sha256=SvlM5JlqULzAz00JZWfiUhfjhqDzYzSWssA87zdJl0o,14
+ciocore-8.1.0.dist-info/RECORD,,

tests/test_api_client.py

@@ -2,9 +2,11 @@
 
    isort:skip_file
 """
+import datetime
+import json
 import sys
 import unittest
-import json
+
 try:
     from unittest import mock
 except ImportError:
@@ -13,6 +15,8 @@ except ImportError:
 from ciocore import api_client
 
 from ciocore.api_client import request_extra_environment
+from ciocore.api_client import _get_compute_usage, get_compute_usage
+from ciocore.api_client import _get_storage_usage, get_storage_usage
 
 class ApiClientTest(unittest.TestCase):
     @staticmethod
@@ -164,3 +168,172 @@ class TestRequestExtraEnvironment(unittest.TestCase):
 
         self.assertEqual("Error: Could not get account environment!", str(context.exception))
         mock_ApiClient.assert_called_once()
+
+class TestGetComputeUsage(unittest.TestCase):
+
+    def setUp(self):
+        
+        # Precison is rounded to 4 places to avoid FP issues.
+        self.compute_response_data = {
+            "data": [
+                {
+                    "cores": 0.5, 
+                    "instance_cost": 0.0200, 
+                    "license_cost": 0.0200, 
+                    "minutes": 6.9700, 
+                    "self_link": 0, 
+                    "start_time": "Tue, 09 Jan 2024 18:00:00 GMT"
+                }, 
+                {
+                    "cores": 0.4, 
+                    "instance_cost": 0.0200, 
+                    "license_cost": 0.0200, 
+                    "minutes": 6.9600, 
+                    "self_link": 1, 
+                    "start_time": "Tue, 09 Jan 2024 19:00:00 GMT"
+                }, 
+                {
+                    "cores": 0.9613, 
+                    "instance_cost": 0.0400, 
+                    "license_cost": 0.0800, 
+                    "minutes": 7.2100, 
+                    "self_link": 2, 
+                    "start_time": "Tue, 16 Jan 2024 17:00:00 GMT"
+                }, 
+            ]
+        }
+     
+        self.response_ok = mock.MagicMock(status_code=200, text=json.dumps(self.compute_response_data))
+        self.response_error = mock.MagicMock(status_code=500, text=json.dumps({"error": "Internal Server Error"}))
+
+    @mock.patch("ciocore.api_client.ApiClient")
+    @mock.patch("ciocore.api_client.read_conductor_credentials")
+    @mock.patch("ciocore.api_client.account_id_from_jwt")
+    def test_query_raw_compute_usage(self, mock_account_id_from_jwt, mock_read_conductor_credentials, mock_ApiClient):
+        # Set up mocks for successful execution
+        mock_read_conductor_credentials.return_value = "valid_token"
+        mock_account_id_from_jwt.return_value = "123"
+        mock_api_instance = mock_ApiClient.return_value
+        mock_api_instance.make_request.return_value = (self.response_ok.text, self.response_ok.status_code)
+
+        start_time = datetime.datetime(2024, 1, 1)
+        end_time = datetime.datetime(2024, 3, 20)
+
+        result = _get_compute_usage(start_time, end_time)
+
+        self.assertEqual(result, self.compute_response_data['data'])
+        
+    @mock.patch("ciocore.api_client.ApiClient")
+    @mock.patch("ciocore.api_client.read_conductor_credentials")
+    @mock.patch("ciocore.api_client.account_id_from_jwt")
+    def test_compute_usage(self, mock_account_id_from_jwt, mock_read_conductor_credentials, mock_ApiClient):
+        # Set up mocks for successful execution
+        mock_read_conductor_credentials.return_value = "valid_token"
+        mock_account_id_from_jwt.return_value = "123"
+        mock_api_instance = mock_ApiClient.return_value
+        mock_api_instance.make_request.return_value = (self.response_ok.text, self.response_ok.status_code)
+
+        start_time = datetime.datetime(2024, 1, 1)
+        end_time = datetime.datetime(2024, 3, 20)
+
+        result = get_compute_usage(start_time=start_time, end_time=end_time)
+
+        self.assertEqual(result, {  '2024-01-09': {'cost': 0.08,
+                                                 'corehours': 0.9, 
+                                                 'walltime': 13.93},
+                                    '2024-01-16': { 'cost': 0.12,
+                                                    'corehours': 0.9613, 
+                                                    'walltime': 7.21}})
+        
+    @mock.patch("ciocore.api_client.ApiClient")
+    def test_get_compute_usage_api_failure(self, mock_ApiClient):
+        # Set up mock for API failure
+        mock_api_instance = mock_ApiClient.return_value
+        mock_api_instance.make_request.return_value = (self.response_error.text, self.response_error.status_code)
+
+        start_time = datetime.datetime(2024, 1, 1)
+        end_time = datetime.datetime(2024, 3, 20)
+        
+        # Assert exception raised when the API call fails
+        with self.assertRaises(Exception) as context:
+            get_compute_usage(start_time, end_time)
+
+        self.assertIn('Failed to query compute usage', str(context.exception))
+        mock_ApiClient.assert_called_once()    
+class TestGetStorageUsage(unittest.TestCase):
+
+    def setUp(self):
+               
+        self.storage_response_data = {
+            "data": [
+                {
+                "cost": "28.96", 
+                "cost_per_day": [
+                    4.022,
+                    4.502, 
+                    4.502, 
+                    5.102, 
+                    5.102, 
+                    5.732
+                ], 
+                "currency": "USD", 
+                "daily_price": "0.006", 
+                "end_date": "2024-01-07", 
+                "gibs_per_day": [
+                    679.714,
+                    750.34, 
+                    750.34, 
+                    850.36, 
+                    850.35, 
+                    955.32
+                ], 
+                "gibs_used": "806.07", 
+                "monthly_price": "0.18", 
+                "start_date": "2024-01-01", 
+                "storage_unit": "GiB"
+                }
+            ]
+            }
+        
+        self.response_ok = mock.MagicMock(status_code=200, text=json.dumps(self.storage_response_data))
+        self.response_error = mock.MagicMock(status_code=500, text=json.dumps({"error": "Internal Server Error"}))
+        
+    @mock.patch("ciocore.api_client.ApiClient")
+    @mock.patch("ciocore.api_client.read_conductor_credentials")
+    @mock.patch("ciocore.api_client.account_id_from_jwt")
+    def test_query_raw_storage_usage(self, mock_account_id_from_jwt, mock_read_conductor_credentials, mock_ApiClient):
+        # Set up mocks for successful execution
+        mock_read_conductor_credentials.return_value = "valid_token"
+        mock_account_id_from_jwt.return_value = "123"
+        mock_api_instance = mock_ApiClient.return_value
+        mock_api_instance.make_request.return_value = (self.response_ok.text, self.response_ok.status_code)
+
+        start_time = datetime.datetime(2024, 5, 1)
+        end_time = datetime.datetime(2024, 5, 17)
+
+        result = _get_storage_usage(start_time, end_time)
+
+        self.assertEqual(result, self.storage_response_data['data'][0])
+
+    @mock.patch("ciocore.api_client.ApiClient")
+    @mock.patch("ciocore.api_client.read_conductor_credentials")
+    @mock.patch("ciocore.api_client.account_id_from_jwt")
+    def test_storage_usage(self, mock_account_id_from_jwt, mock_read_conductor_credentials, mock_ApiClient):
+        # Set up mocks for successful execution
+        mock_read_conductor_credentials.return_value = "valid_token"
+        mock_account_id_from_jwt.return_value = "123"
+        mock_api_instance = mock_ApiClient.return_value
+        mock_api_instance.make_request.return_value = (self.response_ok.text, self.response_ok.status_code)
+
+        start_time = datetime.datetime(2024, 1, 1)
+        end_time = datetime.datetime(2024, 1, 7)
+
+        result = get_storage_usage(start_time=start_time, end_time=end_time)
+        
+        self.assertEqual(result, {  '2024-01-01': {'cost': 4.022, 'GiB': 679.714},
+                                    '2024-01-02': {'cost': 4.502, 'GiB': 750.34},
+                                    '2024-01-03': {'cost': 4.502, 'GiB': 750.34},
+                                    '2024-01-04': {'cost': 5.102, 'GiB': 850.36},
+                                    '2024-01-05': {'cost': 5.102, 'GiB': 850.35},
+                                    '2024-01-06': {'cost': 5.732, 'GiB': 955.32}
+                                  })