formatting fixes

Author: harsh97

ads/feature_store/docs/source/index.rst

@@ -27,7 +27,7 @@ Feature Store
 .. toctree::
     :maxdepth: 2
     :caption: Getting started:
-    
+
     overview
     setup_feature_store
     quickstart

ads/feature_store/docs/source/setup_feature_store.rst

@@ -69,7 +69,7 @@ Known Issues
 -------------
 
 1. Deployment doesn't work in Virtual Nodepool as the Feature Store API server relies on Instance Principal authentication.
- 
+
 
 .. toctree::
   :maxdepth: 1

ads/feature_store/docs/source/user_guides.setup.helm_chart.rst

@@ -54,7 +54,7 @@ To login to Container Registry using the Helm CLI:
    - Click Generate Token. The new auth token is displayed.
    - Copy the auth token immediately to a secure location from where you can retrieve it later, because you won't see the auth token again in the Console.
    - Close the Generate Token dialog.
-  
+
 - In a terminal window on the client machine running Docker, log in to Container Registry by entering  ``helm registry login <region-key>.ocir.io``, where <region-key> corresponds to the key for the Container Registry region you're using. For example, ``helm registry login iad.ocir.io``. See `Availability by Region <https://docs.oracle.com/en-us/iaas/Content/Registry/Concepts/registryprerequisites.htm#regional-availability>`_.
 - When prompted for a username, enter your username in the format <tenancy-namespace>/<username>, where <tenancy-namespace> is the auto-generated Object Storage namespace string of your tenancy (as shown on the Tenancy Information page). For example, ansh81vru1zp/jdoe@acme.com. If your tenancy is federated with Oracle Identity Cloud Service, use the format <tenancy-namespace>/oracleidentitycloudservice/<username>.
 - When prompted for a password, enter the auth token you copied earlier.
@@ -188,4 +188,3 @@ __________________________________________________________
       periodSeconds:
       timeoutSeconds:
       failureThreshold:
-

ads/opctl/operator/cmd.py

@@ -34,7 +34,7 @@
     OPERATOR_BASE_DOCKER_GPU_FILE,
     OPERATOR_BASE_GPU_IMAGE,
     OPERATOR_BASE_IMAGE,
-    OPERATOR_BACKEND_SECTION_NAME
+    OPERATOR_BACKEND_SECTION_NAME,
 )
 from ads.opctl.operator.common.operator_loader import OperatorInfo, OperatorLoader
 from ads.opctl.utils import publish_image as publish_image_cmd
@@ -190,7 +190,6 @@ def init(
         logger.debug(ex)
         print_traceback()
 
-
     # copy README and original schema files into a destination folder
     for src_file in ("README.md", "schema.yaml", "environment.yaml"):
         ads_common_utils.copy_file(

ads/opctl/operator/common/utils.py

@@ -159,12 +159,15 @@ def default_signer(**kwargs):
     from ads.common.auth import default_signer
 
     return default_signer(**kwargs)
+
+
 def remove_prefix(text: str, prefix: str):
     if text.startswith(prefix):
         return text[len(prefix) :]
     else:
         return text
 
+
 def print_traceback():
     if logger.level == logging.DEBUG:
         ex_type, ex, tb = sys.exc_info()

ads/opctl/operator/lowcode/feature_store_marketplace/README.md

@@ -1,5 +1,5 @@
 # Feature Store Marketplace Operator
-The Feature Store Marketplace Operator simplifies the process of deploying Feature Store stack from Marketplace to your existing OKE cluster. 
+The Feature Store Marketplace Operator simplifies the process of deploying Feature Store stack from Marketplace to your existing OKE cluster.
 
 Below are the steps to configure and run the Marketplace Operator:
 ## 1. Prerequisites

ads/opctl/operator/lowcode/feature_store_marketplace/errors.py

@@ -4,6 +4,7 @@
 # Copyright (c) 2023 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
+
 class ForecastSchemaYamlError(Exception):
     """Exception raised when there is an issue with the schema."""
 

tests/unitary/with_extras/operator/feature-store/test_local_marketplace.py

@@ -4,63 +4,73 @@
 import mock
 import yaml
 
-from ads.opctl.backend.marketplace.local_marketplace import LocalMarketplaceOperatorBackend
-from ads.opctl.backend.marketplace.models.marketplace_type import HelmMarketplaceListingDetails
+from ads.opctl.backend.marketplace.local_marketplace import (
+    LocalMarketplaceOperatorBackend,
+)
+from ads.opctl.backend.marketplace.models.marketplace_type import (
+    HelmMarketplaceListingDetails,
+)
 from ads.opctl.operator.common.operator_loader import OperatorInfo
 
 
-@patch('ads.opctl.backend.marketplace.local_marketplace.fsspec.open', new_callable=mock.mock_open())
+@patch(
+    "ads.opctl.backend.marketplace.local_marketplace.fsspec.open",
+    new_callable=mock.mock_open(),
+)
 def test_helm_values_to_yaml(file_writer: Mock):
     sample_helm_value = {
-        "key1": {
-            "inner_key1": "inner_value1",
-            "inner_key2": "inner_value2"
-        },
-        "key2": {
-            "inner_key3": "inner_value3",
-            "inner_key4": "inner_value4"
-        }
+        "key1": {"inner_key1": "inner_value1", "inner_key2": "inner_value2"},
+        "key2": {"inner_key3": "inner_value3", "inner_key4": "inner_value4"},
     }
     path = LocalMarketplaceOperatorBackend._save_helm_values_to_yaml_(sample_helm_value)
-    assert path.endswith('values.yaml')
-    file_writer.assert_called_with(path, mode='w')
-    file_writer.return_value.__enter__().write.assert_called_once_with(yaml.dump(sample_helm_value))
+    assert path.endswith("values.yaml")
+    file_writer.assert_called_with(path, mode="w")
+    file_writer.return_value.__enter__().write.assert_called_once_with(
+        yaml.dump(sample_helm_value)
+    )
 
 
-@patch('ads.opctl.backend.marketplace.local_marketplace.MarketplaceBackendRunner')
-@patch('ads.opctl.backend.marketplace.local_marketplace.operator_runtime')
+@patch("ads.opctl.backend.marketplace.local_marketplace.MarketplaceBackendRunner")
+@patch("ads.opctl.backend.marketplace.local_marketplace.operator_runtime")
 def test_run_with_python_success(operator_runtime: Mock, backend_runner: Mock):
-    local_marketplace_operator = LocalMarketplaceOperatorBackend(config={'execution': {}}, operator_info=OperatorInfo())
+    local_marketplace_operator = LocalMarketplaceOperatorBackend(
+        config={"execution": {}}, operator_info=OperatorInfo()
+    )
     local_marketplace_operator.process_helm_listing = Mock(return_value=0)
 
     mock_helm_detail = Mock(spec=HelmMarketplaceListingDetails)
     mock_helm_detail.helm_values = {}
-    mock_helm_detail.helm_app_name = 'helm_app_name'
-    mock_helm_detail.ocir_fully_qualified_url = 'ocir_fully_qualified_url'
-    mock_helm_detail.helm_chart_tag = 'helm_chart_tag'
-    mock_helm_detail.namespace = 'namespace'
+    mock_helm_detail.helm_app_name = "helm_app_name"
+    mock_helm_detail.ocir_fully_qualified_url = "ocir_fully_qualified_url"
+    mock_helm_detail.helm_chart_tag = "helm_chart_tag"
+    mock_helm_detail.namespace = "namespace"
     backend_runner.return_value.get_listing_details.return_value = mock_helm_detail
     # helm_install_api.return_value.returncode = 0
     assert local_marketplace_operator._run_with_python_() == 0
 
 
-@patch('ads.opctl.backend.marketplace.local_marketplace.check_helm_login')
-@patch('ads.opctl.backend.marketplace.local_marketplace.check_prerequisites')
-@patch('ads.opctl.backend.marketplace.local_marketplace.run_helm_install')
-@patch('ads.opctl.backend.marketplace.local_marketplace.MarketplaceBackendRunner')
-@patch('ads.opctl.backend.marketplace.local_marketplace.operator_runtime')
-def test_run_with_python_failure(operator_runtime: Mock, backend_runner: Mock, helm_install_api: Mock,
-                                 check_prerequisites: Mock,
-                                 check_helm_login: Mock
-                                 ):
-    local_marketplace_operator = LocalMarketplaceOperatorBackend(config={'execution': {}}, operator_info=OperatorInfo())
+@patch("ads.opctl.backend.marketplace.local_marketplace.check_helm_login")
+@patch("ads.opctl.backend.marketplace.local_marketplace.check_prerequisites")
+@patch("ads.opctl.backend.marketplace.local_marketplace.run_helm_install")
+@patch("ads.opctl.backend.marketplace.local_marketplace.MarketplaceBackendRunner")
+@patch("ads.opctl.backend.marketplace.local_marketplace.operator_runtime")
+def test_run_with_python_failure(
+    operator_runtime: Mock,
+    backend_runner: Mock,
+    helm_install_api: Mock,
+    check_prerequisites: Mock,
+    check_helm_login: Mock,
+):
+    local_marketplace_operator = LocalMarketplaceOperatorBackend(
+        config={"execution": {}}, operator_info=OperatorInfo()
+    )
     local_marketplace_operator.process_helm_listing = Mock(return_value=-1)
     mock_helm_detail = Mock(spec=HelmMarketplaceListingDetails)
     mock_helm_detail.helm_values = {}
-    mock_helm_detail.helm_app_name = 'helm_app_name'
-    mock_helm_detail.ocir_fully_qualified_url = 'ocir_fully_qualified_url'
-    mock_helm_detail.helm_chart_tag = 'helm_chart_tag'
-    mock_helm_detail.namespace = 'namespace'
+    mock_helm_detail.helm_app_name = "helm_app_name"
+    mock_helm_detail.ocir_fully_qualified_url = "ocir_fully_qualified_url"
+    mock_helm_detail.helm_chart_tag = "helm_chart_tag"
+    mock_helm_detail.namespace = "namespace"
     backend_runner.return_value.get_listing_details.return_value = mock_helm_detail
     helm_install_api.return_value.returncode = -1
     assert local_marketplace_operator._run_with_python_() == -1

tests/unitary/with_extras/operator/feature-store/test_prerequisite_checker.py

@@ -4,19 +4,31 @@
 import pytest
 from oci.marketplace.models import AcceptedAgreementSummary, AgreementSummary
 
-from ads.opctl.backend.marketplace.models.marketplace_type import HelmMarketplaceListingDetails, \
-    MarketplaceListingDetails
-from ads.opctl.backend.marketplace.prerequisite_checker import check_prerequisites, _prompt_kubernetes_confirmation_, \
-    _check_binaries_, _check_license_for_listing_, BinaryValidation
+from ads.opctl.backend.marketplace.models.marketplace_type import (
+    HelmMarketplaceListingDetails,
+    MarketplaceListingDetails,
+)
+from ads.opctl.backend.marketplace.prerequisite_checker import (
+    check_prerequisites,
+    _prompt_kubernetes_confirmation_,
+    _check_binaries_,
+    _check_license_for_listing_,
+    BinaryValidation,
+)
 
 
 @patch(
-    "ads.opctl.backend.marketplace.prerequisite_checker._prompt_kubernetes_confirmation_")
+    "ads.opctl.backend.marketplace.prerequisite_checker._prompt_kubernetes_confirmation_"
+)
 @patch("ads.opctl.backend.marketplace.prerequisite_checker._check_kubernetes_secret_")
 @patch("ads.opctl.backend.marketplace.prerequisite_checker._check_binaries_")
 @patch("ads.opctl.backend.marketplace.prerequisite_checker._check_license_for_listing_")
-def test_check_prerequisites(license_api: Mock, check_binary_api: Mock, prompt_kubernetes_confirmation_api: Mock,
-                             check_kubernetes_secret_api: Mock):
+def test_check_prerequisites(
+    license_api: Mock,
+    check_binary_api: Mock,
+    prompt_kubernetes_confirmation_api: Mock,
+    check_kubernetes_secret_api: Mock,
+):
     listing_detail = Mock(spec=HelmMarketplaceListingDetails)
     check_prerequisites(listing_detail)
     license_api.assert_called_once()
@@ -28,18 +40,22 @@ def test_check_prerequisites(license_api: Mock, check_binary_api: Mock, prompt_k
 @patch("ads.opctl.backend.marketplace.prerequisite_checker.click")
 def test_prompt_kubernetes_confirmation(click: Mock):
     _prompt_kubernetes_confirmation_()
-    click.confirm.assert_called_once_with(text='Is it safe to proceed?', default=False, abort=True)
+    click.confirm.assert_called_once_with(
+        text="Is it safe to proceed?", default=False, abort=True
+    )
 
 
 @patch("ads.opctl.backend.marketplace.prerequisite_checker.subprocess.run")
 def test_check_binaries_success(subprocess_runner: Mock):
     binaries = [BinaryValidation("bin_a", ""), BinaryValidation("bin_b", "")]
     subprocess_runner.return_value = CompletedProcess(args="", returncode=0)
     _check_binaries_(binaries)
-    subprocess_runner.assert_has_calls([
-        call(['which', 'bin_a'], capture_output=True),
-        call(['which', 'bin_b'], capture_output=True)
-    ])
+    subprocess_runner.assert_has_calls(
+        [
+            call(["which", "bin_a"], capture_output=True),
+            call(["which", "bin_b"], capture_output=True),
+        ]
+    )
 
 
 @patch("ads.opctl.backend.marketplace.prerequisite_checker.subprocess.run")
@@ -48,39 +64,60 @@ def test_check_binaries_failure(subprocess_runner: Mock):
         binaries = [BinaryValidation("bin_a", ""), BinaryValidation("bin_b", "")]
         subprocess_runner.return_value = CompletedProcess(args="", returncode=-1)
         _check_binaries_(binaries)
-        subprocess_runner.assert_has_calls([
-            call(['which', 'bin_a'], capture_output=True),
-            call(['which', 'bin_b'], capture_output=True)
-        ])
+        subprocess_runner.assert_has_calls(
+            [
+                call(["which", "bin_a"], capture_output=True),
+                call(["which", "bin_b"], capture_output=True),
+            ]
+        )
 
 
 @patch("ads.opctl.backend.marketplace.prerequisite_checker.get_marketplace_client")
 def test_check_license_for_listing_when_already_accepted(marketplace_client: Mock):
-    listing_detail = MarketplaceListingDetails(listing_id="lid", compartment_id="c_id", version="1.0")
-
-    accepted_agreement = AcceptedAgreementSummary(agreement_id="accepted_agreement_ocid")
-    marketplace_client.return_value.list_accepted_agreements.return_value.data = [accepted_agreement]
-    marketplace_client.return_value.list_agreements.return_value.data = [AgreementSummary(id="accepted_agreement_ocid")]
+    listing_detail = MarketplaceListingDetails(
+        listing_id="lid", compartment_id="c_id", version="1.0"
+    )
+
+    accepted_agreement = AcceptedAgreementSummary(
+        agreement_id="accepted_agreement_ocid"
+    )
+    marketplace_client.return_value.list_accepted_agreements.return_value.data = [
+        accepted_agreement
+    ]
+    marketplace_client.return_value.list_agreements.return_value.data = [
+        AgreementSummary(id="accepted_agreement_ocid")
+    ]
 
     _check_license_for_listing_(listing_detail)
     marketplace_client.assert_called_once()
     marketplace_client.return_value.list_accepted_agreements.assert_called_once()
     marketplace_client.return_value.list_agreements.assert_called_once()
 
+
 @patch("ads.opctl.backend.marketplace.prerequisite_checker.click")
 @patch("ads.opctl.backend.marketplace.prerequisite_checker.time")
 @patch("ads.opctl.backend.marketplace.prerequisite_checker.webbrowser.open")
 @patch("ads.opctl.backend.marketplace.prerequisite_checker.get_marketplace_client")
-def test_check_license_for_listing_pending_and_accepted(marketplace_client: Mock, web_client:Mock, timer:Mock, click:Mock):
-    listing_detail = MarketplaceListingDetails(listing_id="lid", compartment_id="c_id", version="1.0")
+def test_check_license_for_listing_pending_and_accepted(
+    marketplace_client: Mock, web_client: Mock, timer: Mock, click: Mock
+):
+    listing_detail = MarketplaceListingDetails(
+        listing_id="lid", compartment_id="c_id", version="1.0"
+    )
     AGREEMENT_CONTENT_URL = "https://test.content.url"
     AGREEMENT_PROMPT = "test-prompt"
 
     click.confirm.return_value = True
     marketplace_client.return_value.list_accepted_agreements.return_value.data = []
-    marketplace_client.return_value.list_agreements.return_value.data = [AgreementSummary(id="accepted_agreement_ocid")]
-    marketplace_client.return_value.get_agreement.return_value.data.content_url = AGREEMENT_CONTENT_URL
-    marketplace_client.return_value.get_agreement.return_value.data.prompt = AGREEMENT_PROMPT
+    marketplace_client.return_value.list_agreements.return_value.data = [
+        AgreementSummary(id="accepted_agreement_ocid")
+    ]
+    marketplace_client.return_value.get_agreement.return_value.data.content_url = (
+        AGREEMENT_CONTENT_URL
+    )
+    marketplace_client.return_value.get_agreement.return_value.data.prompt = (
+        AGREEMENT_PROMPT
+    )
 
     _check_license_for_listing_(listing_detail)
 
@@ -89,4 +126,4 @@ def test_check_license_for_listing_pending_and_accepted(marketplace_client: Mock
     marketplace_client.return_value.list_agreements.assert_called_once()
     web_client.assert_called_once_with(AGREEMENT_CONTENT_URL)
     click.confirm.assert_called_once_with(AGREEMENT_PROMPT, default=False)
-    marketplace_client.return_value.create_accepted_agreement.assert_called_once()
+    marketplace_client.return_value.create_accepted_agreement.assert_called_once()