Updates to CLI and programatic API (#2474)

* Updated contract API to allow only a single contract file. Includes changes to publish API

* More updates to contract API

* Implemented PR feedback: re-introduced old functions, changed dataset identifier. Exposed publish_contract to API

* Fix rogue dataset_identifiers arguments

* Change deprecate import

* Fix dataset_id being `None` in the results

* PR feedback

Author: Niels-b

soda-core/src/soda_core/cli/cli.py

@@ -110,15 +110,13 @@ def _setup_contract_verify_command(contract_parsers) -> None:
         "-c",
         "--contract",
         type=str,
-        nargs="+",
-        help="One or more contract file paths. Use this to work with local contracts.",
+        help="Contract file path to verify. Use this to work with local contracts.",
     )
     verify_parser.add_argument(
         "-d",
         "--dataset",
         type=str,
-        nargs="+",
-        help="Names of datasets to verify. Use this to work with remote contracts present in Soda Cloud.",
+        help="Name of dataset to verify. Use this to work with remote contracts present in Soda Cloud.",
     )
 
     verify_parser.add_argument(
@@ -180,8 +178,8 @@ def _setup_contract_verify_command(contract_parsers) -> None:
     )
 
     def handle(args):
-        contract_file_paths = args.contract
-        dataset_identifiers = args.dataset
+        contract_file_path = args.contract
+        dataset_identifier = args.dataset
         data_source_file_paths = args.data_source
         soda_cloud_file_path = args.soda_cloud
         variables = _parse_variables(args.set)
@@ -195,8 +193,8 @@ def handle(args):
         diagnostics_warehouse_file_path = args.diagnostics_warehouse
 
         exit_code = handle_verify_contract(
-            contract_file_paths,
-            dataset_identifiers,
+            contract_file_path,
+            dataset_identifier,
             data_source_file_paths,
             soda_cloud_file_path,
             variables,
@@ -236,7 +234,7 @@ def _parse_variables(variables: Optional[List[str]]) -> Optional[Dict[str, str]]
 
 def _setup_contract_publish_command(contract_parsers) -> None:
     publish_parser = contract_parsers.add_parser("publish", help="Publish a contract")
-    publish_parser.add_argument("-c", "--contract", type=str, nargs="+", help="One or more contract file paths.")
+    publish_parser.add_argument("-c", "--contract", type=str, help="Contract file path to publish.")
 
     publish_parser.add_argument(
         "-sc",
@@ -256,17 +254,17 @@ def _setup_contract_publish_command(contract_parsers) -> None:
     )
 
     def handle(args):
-        contract_file_paths = args.contract
+        contract_file_path = args.contract
         soda_cloud_file_path = args.soda_cloud
-        exit_code = handle_publish_contract(contract_file_paths, soda_cloud_file_path)
+        exit_code = handle_publish_contract(contract_file_path, soda_cloud_file_path)
         exit_with_code(exit_code)
 
     publish_parser.set_defaults(handler_func=handle)
 
 
 def _setup_contract_test_command(contract_parsers) -> None:
     test_contract_parser = contract_parsers.add_parser(name="test", help="Test a contract syntax without executing it")
-    test_contract_parser.add_argument("-c", "--contract", type=str, nargs="+", help="One or more contract file paths.")
+    test_contract_parser.add_argument("-c", "--contract", type=str, help="Contract file path to test.")
 
     test_contract_parser.add_argument(
         "-v",
@@ -278,9 +276,9 @@ def _setup_contract_test_command(contract_parsers) -> None:
     )
 
     def handle(args):
-        contract_file_paths = args.contract
+        contract_file_path = args.contract
 
-        exit_code = handle_test_contract(contract_file_paths, {})
+        exit_code = handle_test_contract(contract_file_path, {})
         exit_with_code(exit_code)
 
     test_contract_parser.set_defaults(handler_func=handle)

soda-core/src/soda_core/cli/handlers/contract.py

@@ -10,14 +10,14 @@
 )
 from soda_core.common.logging_constants import Emoticons, soda_logger
 from soda_core.common.yaml import ContractYamlSource
-from soda_core.contracts.api import test_contracts, verify_contracts
-from soda_core.contracts.contract_publication import ContractPublication
+from soda_core.contracts.api import test_contract, verify_contract
+from soda_core.contracts.api.publish_api import publish_contract
 from soda_core.contracts.contract_verification import ContractVerificationSessionResult
 
 
 def handle_verify_contract(
-    contract_file_paths: Optional[list[str]],
-    dataset_identifiers: Optional[list[str]],
+    contract_file_path: Optional[str],
+    dataset_identifier: Optional[str],
     data_source_file_paths: Optional[str],
     soda_cloud_file_path: Optional[str],
     variables: Optional[Dict[str, str]],
@@ -29,9 +29,9 @@ def handle_verify_contract(
     diagnostics_warehouse_file_path: Optional[str],
 ) -> ExitCode:
     try:
-        contract_verification_result = verify_contracts(
-            contract_file_paths=contract_file_paths,
-            dataset_identifiers=dataset_identifiers,
+        contract_verification_result = verify_contract(
+            contract_file_path=contract_file_path,
+            dataset_identifier=dataset_identifier,
             data_source_file_path=None,
             data_source_file_paths=data_source_file_paths,
             soda_cloud_file_path=soda_cloud_file_path,
@@ -74,19 +74,11 @@ def interpret_contract_verification_result(verification_result: ContractVerifica
 
 
 def handle_publish_contract(
-    contract_file_paths: Optional[list[str]],
+    contract_file_path: Optional[str],
     soda_cloud_file_path: Optional[str],
 ) -> ExitCode:
     try:
-        contract_publication_builder = ContractPublication.builder()
-
-        for contract_file_path in contract_file_paths:
-            contract_publication_builder.with_contract_yaml_file(contract_file_path)
-
-        if soda_cloud_file_path:
-            contract_publication_builder.with_soda_cloud_yaml_file(soda_cloud_file_path)
-
-        contract_publication_result = contract_publication_builder.build().execute()
+        contract_publication_result = publish_contract(contract_file_path, soda_cloud_file_path)
         if contract_publication_result.has_errors:
             # TODO: detect/deal with exit code 4?
             return ExitCode.LOG_ERRORS
@@ -101,18 +93,15 @@ def handle_publish_contract(
 
 
 def handle_test_contract(
-    contract_file_paths: Optional[list[str]],
+    contract_file_path: Optional[str],
     variables: Optional[Dict[str, str]],
 ) -> ExitCode:
-    for contract_file_path in contract_file_paths:
-        contract_verification_result = test_contracts(contract_file_paths=[contract_file_path], variables=variables)
-        if contract_verification_result.has_errors:
-            return ExitCode.LOG_ERRORS
-        else:
-            soda_logger.info(f"{Emoticons.WHITE_CHECK_MARK} {contract_file_path} is valid")
-            return ExitCode.OK
-
-    return ExitCode.OK
+    contract_verification_result = test_contract(contract_file_path=contract_file_path, variables=variables)
+    if contract_verification_result.has_errors:
+        return ExitCode.LOG_ERRORS
+    else:
+        soda_logger.info(f"{Emoticons.WHITE_CHECK_MARK} {contract_file_path} is valid")
+        return ExitCode.OK
 
 
 def handle_fetch_contract(

soda-core/src/soda_core/common/soda_cloud.py

@@ -478,6 +478,7 @@ def publish_contract(self, contract_yaml: Optional[ContractYaml]) -> ContractPub
                     soda_cloud_file_id=response_json.get("fileId", None),
                 ),
                 soda_qualified_dataset_name=contract_yaml.dataset,
+                dataset_id=response_json.get("publishedContract", {}).get("datasetId", None),
             ),
         )
 

soda-core/src/soda_core/contracts/__init__.py

@@ -1,13 +1,19 @@
 from soda_core.contracts.api import (
-    test_contracts,
-    verify_contracts,
+    publish_contract,
+    test_contract,
+    verify_contract,
+    verify_contract_locally,
+    verify_contract_on_agent,
     verify_contracts_locally,
     verify_contracts_on_agent,
 )
 
 __all__ = [
-    "test_contracts",
-    "verify_contracts",
+    "test_contract",
+    "verify_contract",
+    "verify_contract_locally",
+    "verify_contract_on_agent",
     "verify_contracts_locally",
     "verify_contracts_on_agent",
+    "publish_contract",
 ]

soda-core/src/soda_core/contracts/api/__init__.py

@@ -1,13 +1,19 @@
-from soda_core.contracts.api.test_api import test_contracts
+from soda_core.contracts.api.publish_api import publish_contract
+from soda_core.contracts.api.test_api import test_contract
 from soda_core.contracts.api.verify_api import (
-    verify_contracts,
+    verify_contract,
+    verify_contract_locally,
+    verify_contract_on_agent,
     verify_contracts_locally,
     verify_contracts_on_agent,
 )
 
 __all__ = [
-    "test_contracts",
-    "verify_contracts",
+    "test_contract",
+    "verify_contract",
+    "verify_contract_locally",
+    "verify_contract_on_agent",
     "verify_contracts_locally",
     "verify_contracts_on_agent",
+    "publish_contract",
 ]

soda-core/src/soda_core/contracts/api/publish_api.py

@@ -0,0 +1,15 @@
+from soda_core.contracts.contract_publication import (
+    ContractPublication,
+    ContractPublicationResultList,
+)
+
+
+def publish_contract(contract_file_path: str, soda_cloud_file_path: str) -> ContractPublicationResultList:
+    contract_publication_builder = ContractPublication.builder()
+
+    contract_publication_builder.with_contract_yaml_file(contract_file_path)
+    contract_publication_builder.with_soda_cloud_yaml_file(soda_cloud_file_path)
+
+    contract_publication_result = contract_publication_builder.build().execute()
+
+    return contract_publication_result

soda-core/src/soda_core/contracts/api/test_api.py

@@ -1,26 +1,40 @@
 from typing import Dict, Optional, Union
 
+from soda_core.common.exceptions import InvalidArgumentException
 from soda_core.common.yaml import ContractYamlSource
 from soda_core.contracts.contract_verification import (
     ContractVerificationSession,
     ContractVerificationSessionResult,
 )
 from soda_core.telemetry.soda_telemetry import SodaTelemetry
+from typing_extensions import deprecated
 
 soda_telemetry = SodaTelemetry()
 
 
+@deprecated("Use test_contract_locally instead")
 def test_contracts(
     contract_file_paths: Union[str, list[str]],
     variables: Optional[Dict[str, str]] = None,
     verbose: bool = False,
 ) -> ContractVerificationSessionResult:
-    if isinstance(contract_file_paths, str):
-        contract_file_paths = [contract_file_paths]
+    # Limit the contract file paths to only 1. Throw an error if more than 1 is provided.
+    if isinstance(contract_file_paths, list) and len(contract_file_paths) > 1:
+        raise InvalidArgumentException("Only one contract is allowed at a time")
 
-    contract_yaml_sources = [
-        ContractYamlSource.from_file_path(contract_file_path) for contract_file_path in contract_file_paths
-    ]
+    return test_contract(
+        contract_file_path=contract_file_paths[0],
+        variables=variables,
+        verbose=verbose,
+    )
+
+
+def test_contract(
+    contract_file_path: str = None,
+    variables: Optional[Dict[str, str]] = None,
+    verbose: bool = False,
+) -> ContractVerificationSessionResult:
+    contract_yaml_sources = [ContractYamlSource.from_file_path(contract_file_path)]
 
     contract_verification_result = ContractVerificationSession.execute(
         contract_yaml_sources=contract_yaml_sources,