xpk 0.17.3__py3-none-any.whl → 1.1.0__py3-none-any.whl

integration/gcluster_test.py

@@ -1,107 +0,0 @@
-"""
-Copyright 2024 Google LLC
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-from xpk.core.docker_manager import DockerManager
-from xpk.core.gcluster_manager import GclusterManager
-from xpk.core.blueprint.blueprint_generator import BlueprintGenerator
-import os
-import pytest
-import shutil
-
-ctk_gcloud_cfg = os.getenv("GCLOUD_CFG_PATH")
-project_id = os.getenv("PROJECT_ID")
-region = os.getenv("REGION")
-zone = os.getenv("ZONE")
-auth_cidr = os.getenv("AUTH_CIDR")
-cluster_name = os.getenv("GKE_ML_TEST_CLUSTER_NAME")
-
-uploads_dir = "uploads"
-
-
-def prepare_test(docker_path: str, bp_path: str) -> None:
-  if not os.path.exists(docker_path):
-    os.makedirs(docker_path)
-  if not os.path.exists(bp_path):
-    os.makedirs(bp_path)
-
-
-@pytest.mark.skip(reason="Credentails not working. Skipping for now")
-def test_create_deployment():
-  assert project_id is not None
-  assert region is not None
-  assert zone is not None
-  assert auth_cidr is not None
-  assert ctk_gcloud_cfg is not None
-  assert cluster_name is not None
-
-  pwd = os.getcwd()
-  test_docker_working_dir = os.path.join(
-      pwd, "xpkclusters/tests/xpk_test_docker_dir"
-  )
-  test_bp_dir = os.path.join(pwd, "xpkclusters/tests/xpk_test_bp_dir")
-  prepare_test(test_docker_working_dir, test_bp_dir)
-  blueprint_name = "my-test-blueprint"
-  prefix = "prefix"
-
-  docker_manager = DockerManager(
-      gcloud_cfg_path=ctk_gcloud_cfg, working_dir=test_docker_working_dir
-  )
-  docker_manager.initialize()
-
-  bpm = BlueprintGenerator(storage_path=test_bp_dir)
-  ml_gke_blueprint = bpm.generate_gke_ml_blueprint(
-      cluster_name=cluster_name,
-      blueprint_name=blueprint_name,
-      prefix=prefix,
-      region=region,
-      project_id=project_id,
-      auth_cidr=auth_cidr,
-  )
-  blueprint_test_path = os.path.join(
-      test_bp_dir, prefix, f"{blueprint_name}.yaml"
-  )
-  # there are no files in ghcp stage for this blueprint
-  blueprint_deps_test_path = ""
-
-  assert ml_gke_blueprint.blueprint_file == blueprint_test_path
-  assert ml_gke_blueprint.blueprint_dependencies == blueprint_deps_test_path
-
-  assert os.path.exists(blueprint_test_path)
-
-  gcluster_manager = GclusterManager(
-      gcluster_command_runner=docker_manager, remote_state_client=None
-  )
-
-  staged_bp_path = gcluster_manager.stage_files(
-      blueprint_file=ml_gke_blueprint.blueprint_file,
-      blueprint_dependencies=ml_gke_blueprint.blueprint_dependencies,
-      prefix=prefix,
-  )
-
-  assert staged_bp_path == os.path.join(
-      "/out", uploads_dir, prefix, f"{blueprint_name}.yaml"
-  )
-
-  gcluster_manager.deploy(
-      blueprint_path=staged_bp_path,
-      deployment_name=blueprint_name,
-      prefix=prefix,
-  )
-  gcluster_manager.destroy_deployment(
-      deployment_name=blueprint_name, prefix=prefix
-  )
-  shutil.rmtree(test_docker_working_dir)
-  shutil.rmtree(test_bp_dir)

xpk/commands/kind.py

@@ -1,265 +0,0 @@
-"""
-Copyright 2024 Google LLC
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-from ..core.kueue_manager import (KueueConfig, KueueManager)
-from ..core.commands import (
-    run_command_for_value,
-    run_command_with_updates,
-)
-from ..core.cluster import set_jobset_on_cluster, setup_k8s_env
-from ..core.scheduling import get_total_chips_requested_from_args
-from ..core.storage import install_storage_crd
-from ..core.system_characteristics import (
-    SystemCharacteristics,
-    AcceleratorType,
-    DockerPlatform,
-)
-from ..utils.console import (xpk_exit, xpk_print)
-from ..utils.validation import validate_dependencies_list, SystemDependency, should_validate_dependencies
-
-
-def cluster_create(args) -> None:
-  """Function around cluster creation.
-
-  Args:
-    args: user provided arguments for running the command.
-
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  if should_validate_dependencies(args):
-    validate_dependencies_list([
-        SystemDependency.KUBECTL,
-        SystemDependency.GCLOUD,
-    ])
-  xpk_print(f'Starting cluster create for cluster {args.cluster}:', flush=True)
-
-  create_cluster_command_code = create_cluster_if_necessary(args)
-  if create_cluster_command_code != 0:
-    xpk_exit(create_cluster_command_code)
-
-  set_cluster_command_code = set_local_cluster_command(args)
-  if set_cluster_command_code != 0:
-    xpk_exit(set_cluster_command_code)
-
-  xpk_print(
-      'Enabling the jobset API on our cluster, to be deprecated when Jobset is'
-      ' globally available'
-  )
-  set_jobset_on_cluster_code = set_jobset_on_cluster(args)
-  if set_jobset_on_cluster_code != 0:
-    xpk_exit(set_jobset_on_cluster_code)
-
-  k8s_client = setup_k8s_env(args)
-  install_storage_crd(k8s_client)
-
-  args.num_slices = 1
-  args.enable_pathways = False
-  system = SystemCharacteristics(
-      'N/A',
-      1,
-      'N/A',
-      'N/A',
-      1,
-      AcceleratorType.CPU,
-      'kind',
-      supports_sub_slicing=False,
-      supports_super_slicing=False,
-      docker_platform=DockerPlatform.ARM,
-  )
-
-  kueue_manager = KueueManager(project='', zone='')
-  kueue_manager.install_or_upgrade(
-      KueueConfig(
-          system,
-          total_chips=get_total_chips_requested_from_args(args, system),
-          autoprovisioning_enabled=False,
-          num_slices=args.num_slices,
-          memory_limit='',
-          cpu_limit=0,
-          is_pathways_cluster=False,
-          flex=False,
-          configure_sub_slicing=False,
-          configure_super_slicing=False,
-      ),
-  )
-
-  xpk_print('Kind commands done! Resources are created.')
-  xpk_exit(0)
-
-
-def cluster_delete(args) -> None:
-  """Function around cluster delete.
-
-  Args:
-    args: user provided arguments for running the command.
-
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  if should_validate_dependencies(args):
-    validate_dependencies_list([SystemDependency.GCLOUD])
-  xpk_print(f'Starting cluster delete for cluster: {args.cluster}', flush=True)
-
-  run_kind_cluster_delete_command_code = run_kind_cluster_delete_command(args)
-  if run_kind_cluster_delete_command_code != 0:
-    xpk_exit(run_kind_cluster_delete_command_code)
-  xpk_print(f'Kind commands done! Cluster {args.cluster} deleted.')
-  xpk_exit(0)
-
-
-def cluster_list(args) -> None:
-  """Function around cluster list.
-
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  if should_validate_dependencies(args):
-    validate_dependencies_list([SystemDependency.GCLOUD])
-  if run_kind_clusters_list_command():
-    xpk_exit(1)
-  xpk_exit(0)
-
-
-def create_cluster_if_necessary(args) -> int:
-  """Creates cluster if not present in the project.
-
-  Args:
-    args: user provided arguments for running the command.
-
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  all_clusters, return_code = get_all_local_clusters_programmatic()
-  if return_code > 0:
-    xpk_print('Listing all clusters failed!')
-    return 1
-  if args.cluster in all_clusters:
-    xpk_print('Skipping cluster creation since it already exists.')
-    return 0
-  else:
-    return run_kind_cluster_create_command(args)
-
-
-def run_kind_cluster_delete_command(args) -> int:
-  """Run the Delete Kind Cluster request.
-
-  Args:
-    args: user provided arguments for running the command.
-
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  command = 'kind delete cluster'
-
-  if args.cluster:
-    command += f' --name={args.cluster}'
-
-  return_code = run_command_with_updates(command, 'Cluster Delete')
-  if return_code != 0:
-    xpk_print(f'Cluster delete request returned ERROR {return_code}')
-    return 1
-
-  return 0
-
-
-def run_kind_clusters_list_command() -> int:
-  """List Kind Clusters within the project and location.
-
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  command = 'kind get clusters'
-  return_code = run_command_with_updates(command, 'Cluster List')
-  if return_code != 0:
-    xpk_print(f'Cluster list request returned ERROR {return_code}')
-    return 1
-
-  return 0
-
-
-def run_kind_cluster_create_command(args) -> int:
-  """Run the Create Kind Cluster request.
-
-  Args:
-    args: user provided arguments for running the command.
-
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  command = 'kind create cluster'
-
-  if args.cluster:
-    command += f' --name={args.cluster}'
-
-  if args.k8s_version:
-    command += f' --image=kindest/node:v{args.k8s_version}'
-
-  return_code = run_command_with_updates(command, 'Kind Cluster Create')
-  if return_code != 0:
-    xpk_print(f'GKE Cluster Create request returned ERROR {return_code}')
-    return 1
-  return 0
-
-
-def get_all_local_clusters_programmatic() -> tuple[list[str], int]:
-  """Gets all the local clusters.
-
-  Returns:
-    List of cluster names and 0 if successful and 1 otherwise.
-  """
-  command = 'kind get clusters'
-  return_code, raw_cluster_output = run_command_for_value(
-      command, 'Find if Cluster Exists'
-  )
-  if return_code != 0:
-    xpk_print(f'Find if Cluster Exists returned ERROR {return_code}')
-    return [], return_code
-
-  return raw_cluster_output.splitlines(), 0
-
-
-def set_local_cluster_command(args) -> int:
-  """Run local cluster configuration command to set the kubectl config.
-
-  Args:
-    args: user provided arguments for running the command.
-
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  if not args.cluster:
-    command = 'kubectl config current-context'
-    return_code, current_context = run_command_for_value(
-        command, 'get current-context'
-    )
-    xpk_print(
-        'No local cluster name specified. Using current-context'
-        f' `{current_context.strip()}`'
-    )
-    return return_code
-
-  command = (
-      f'kubectl config use-context kind-{args.cluster} --namespace=default'
-  )
-  task = f'switch to cluster {args.cluster}'
-  return_code = run_command_with_updates(
-      command,
-      task,
-  )
-  if return_code != 0:
-    xpk_print(f'{task} returned ERROR {return_code}')
-  return return_code

xpk/parser/kind.py

@@ -1,95 +0,0 @@
-"""
-Copyright 2024 Google LLC
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-from ..commands.kind import (
-    cluster_create,
-    cluster_delete,
-    cluster_list,
-)
-from .common import add_global_arguments
-from .validators import name_type
-
-
-def set_kind_parser(kind_parser):
-  cluster_subcommands = kind_parser.add_subparsers(
-      title='kind subcommands',
-      dest='xpk_kind_subcommands',
-      help=(
-          'These are commands related to kind management. Look at help for'
-          ' specific subcommands for more details.'
-      ),
-  )
-
-  ### "cluster create" command parser ###
-  cluster_create_parser = cluster_subcommands.add_parser(
-      'create', help='Create local clusters.'
-  )
-
-  ### Optional Arguments
-  cluster_create_parser.add_argument(
-      '--cluster',
-      type=name_type,
-      default='kind',
-      help=(
-          'The name of the cluster. Will be used as the prefix for internal'
-          ' objects in the cluster.'
-      ),
-      required=False,
-  )
-
-  cluster_create_parser.add_argument(
-      '--k8s-version',
-      type=str,
-      default='',
-      help='The Kubernetes version of the cluster.',
-      required=False,
-  )
-
-  add_global_arguments(cluster_create_parser)
-  cluster_create_parser.set_defaults(func=cluster_create)
-
-  ### "cluster delete" command parser ###
-  cluster_delete_parser = cluster_subcommands.add_parser(
-      'delete',
-      help='Delete cloud clusters.',
-  )
-
-  cluster_delete_required_arguments = cluster_delete_parser.add_argument_group(
-      'Required Arguments',
-      'Arguments required for cluster delete.',
-  )
-
-  ### Required arguments
-  cluster_delete_required_arguments.add_argument(
-      '--cluster',
-      type=name_type,
-      default=None,
-      help='The name of the cluster to be deleted.',
-      required=True,
-  )
-
-  ### Optional Arguments
-  add_global_arguments(cluster_delete_parser)
-  cluster_delete_parser.set_defaults(func=cluster_delete)
-
-  # "cluster list" command parser.
-  cluster_list_parser = cluster_subcommands.add_parser(
-      'list', help='List cloud clusters.'
-  )
-
-  ### Optional Arguments
-  add_global_arguments(cluster_list_parser)
-  cluster_list_parser.set_defaults(func=cluster_list)

xpk/utils/user_input.py

@@ -1,48 +0,0 @@
-"""
-Copyright 2025 Google LLC
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-from typing import Literal
-
-from .console import xpk_print
-from .execution_context import is_quiet
-
-
-def ask_for_user_consent(
-    question: str, default_option: Literal["Y", "N"] = "N"
-) -> bool:
-  """Prompts user with the given question, asking for a yes/no answer and returns a relevant boolean.
-  Important: immediatelly returns `True` in quiet mode!
-
-  Example prompt for `question='Continue?'`: `[XPK] Continue? (y/N): `.
-
-  Args:
-    question: The question to ask the user.
-    default_option: Option to use when user response is empty.
-  """
-  if is_quiet():
-    return True
-
-  options = "y/N" if default_option == "N" else "Y/n"
-  prompt = f"[XPK] {question} ({options}): "
-
-  while True:
-    user_input = input(prompt) or default_option
-    if user_input.lower() in ["yes", "y"]:
-      return True
-    elif user_input.lower() in ["no", "n"]:
-      return False
-    else:
-      xpk_print("Invalid input. Please enter: yes/no/y/n.")

xpk/utils/user_input_test.py

@@ -1,92 +0,0 @@
-"""
-Copyright 2025 Google LLC
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-     https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-from unittest.mock import MagicMock, patch
-import pytest
-from pytest_mock import MockerFixture
-
-from xpk.utils.user_input import ask_for_user_consent
-
-
-@pytest.fixture(autouse=True)
-def mock_is_quiet(mocker: MockerFixture):
-  return mocker.patch("xpk.utils.user_input.is_quiet", return_value=False)
-
-
-@pytest.mark.parametrize(
-    "user_input,expected",
-    [
-        ("yes", True),
-        ("y", True),
-        ("Y", True),
-        ("Yes", True),
-        ("YES", True),
-        ("no", False),
-        ("n", False),
-        ("N", False),
-        ("No", False),
-        ("NO", False),
-    ],
-)
-@patch("xpk.utils.user_input.input")
-def test_ask_for_user_consent(mock_input: MagicMock, user_input, expected):
-  mock_input.return_value = user_input
-
-  assert ask_for_user_consent("Test question?") is expected
-
-
-def fake_input_factory(user_inputs: list[str]):
-  def fake_input(prompt: str) -> str:
-    return user_inputs.pop(0)
-
-  return fake_input
-
-
-@patch("xpk.utils.user_input.input", wraps=fake_input_factory(["invalid", "y"]))
-def test_ask_for_user_consent_invalid_input(mock_input: MagicMock):
-  agreed = ask_for_user_consent("Test question?")
-
-  assert agreed is True
-  assert mock_input.call_count == 2
-
-
-@patch("xpk.utils.user_input.input", return_value="")
-def test_ask_for_user_consent_default_No(mock_input: MagicMock):
-  agreed = ask_for_user_consent("Test question?", default_option="N")
-
-  assert agreed is False
-  mock_input.assert_called_once_with("[XPK] Test question? (y/N): ")
-
-
-@patch("xpk.utils.user_input.input", return_value="")
-def test_ask_for_user_consent_default_Yes(mock_input: MagicMock):
-  agreed = ask_for_user_consent("Test question?", default_option="Y")
-
-  assert agreed is True
-  mock_input.assert_called_once_with("[XPK] Test question? (Y/n): ")
-
-
-@patch("xpk.utils.user_input.input")
-def test_ask_for_user_consent_with_quiet_mode_always_agrees(
-    mock_input: MagicMock,
-    mock_is_quiet: MagicMock,
-):
-  mock_is_quiet.return_value = True
-
-  agreed = ask_for_user_consent("Test question?", default_option="N")
-
-  assert agreed is True
-  mock_input.assert_not_called()

xpk-0.17.3.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-integration
-xpk