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

integration/gcluster_a3ultra_test.py

@@ -1,187 +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.
-"""
-
-import os
-import shutil
-
-import pytest
-
-from xpk.commands.cluster_gcluster import get_unique_name
-from xpk.core.blueprint.blueprint_generator import BlueprintGenerator
-from xpk.core.capacity import CapacityType
-from xpk.core.docker_manager import DockerManager
-from xpk.core.gcluster_manager import GclusterManager
-from xpk.utils.versions import ReleaseChannel
-
-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("A3_ULTRA_TEST_CLUSTER_NAME")
-release_channel = os.getenv("RELEASE_CHANNEL")
-cluster_version = os.getenv("CLUSTER_VERSION")
-
-
-@pytest.fixture(name="setup_tests")
-def prepare_test():
-  pwd = os.getcwd()
-  docker_path = os.path.join(pwd, "xpk_test_docker_dir")
-  bp_path = os.path.join(pwd, "xpk_test_bp_dir")
-  if not os.path.exists(docker_path):
-    os.makedirs(docker_path)
-  if not os.path.exists(bp_path):
-    os.makedirs(bp_path)
-  yield (docker_path, bp_path)
-  shutil.rmtree(docker_path)
-  shutil.rmtree(bp_path)
-
-
-@pytest.mark.skip(
-    reason=(
-        "This test requires A3 capacity, therefore it should not be run on each"
-        " build. Please invoke it manually if needed. "
-    )
-)
-def test_create_a3_ultra_deployment_files(setup_tests):
-  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
-  assert release_channel is not None
-  assert cluster_version is not None
-  docker_path, bp_path = setup_tests[0], setup_tests[1]
-  blueprint_name = f"{cluster_name}-a3-ultra-xpk"
-
-  docker_manager = DockerManager(
-      gcloud_cfg_path=ctk_gcloud_cfg, working_dir=docker_path
-  )
-  docker_manager.initialize()
-  prefix = f"{project_id}-{region}".lower()
-  bpm = BlueprintGenerator(storage_path=bp_path)
-  a3_mega_blueprint = bpm.generate_a3_ultra_blueprint(
-      cluster_name=cluster_name,
-      blueprint_name=blueprint_name,
-      region=region,
-      project_id=project_id,
-      auth_cidr=auth_cidr,
-      zone=zone,
-      reservation="foo",
-      num_nodes=1,
-      system_node_pool_machine_type="e2-standard-16",
-      prefix=prefix,
-      release_channel=ReleaseChannel(release_channel),
-      cluster_version=cluster_version,
-  )
-  blueprint_test_path = os.path.join(bp_path, prefix, f"{blueprint_name}.yaml")
-  blueprint_deps_test_path = os.path.join(bp_path, blueprint_name)
-  assert a3_mega_blueprint.blueprint_file == blueprint_test_path
-  assert a3_mega_blueprint.blueprint_dependencies == blueprint_deps_test_path
-
-  assert os.path.isfile(blueprint_test_path)
-  assert os.path.isdir(blueprint_deps_test_path)
-  assert os.path.isfile(
-      os.path.join(blueprint_deps_test_path, "mlgru-disable.yaml")
-  )
-  assert os.path.isfile(
-      os.path.join(blueprint_deps_test_path, "nccl-installer.yaml")
-  )
-  gcluster_manager = GclusterManager(
-      gcluster_command_runner=docker_manager, remote_state_client=None
-  )
-
-  staged_bp_path = gcluster_manager.stage_files(
-      blueprint_file=a3_mega_blueprint.blueprint_file,
-      blueprint_dependencies=a3_mega_blueprint.blueprint_dependencies,
-      prefix=prefix,
-  )
-  assert staged_bp_path == os.path.join(
-      "/out/uploads", prefix, f"{blueprint_name}.yaml"
-  )
-  unique_name = get_unique_name(project_id, region, zone)
-  gcluster_manager.deploy(
-      blueprint_path=staged_bp_path, deployment_name=unique_name, dry_run=True
-  )
-
-
-@pytest.mark.skip(
-    reason=(
-        "This test requires A3 capacity, therefore it should not be run on each"
-        " build. Please invoke it manually if needed. "
-    )
-)
-def test_create_a3_ultra_deployment(setup_tests):
-  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
-  assert release_channel is not None
-  assert cluster_version is not None
-  docker_path, bp_path = setup_tests[0], setup_tests[1]
-  blueprint_name = f"{cluster_name}-a3-ultra-xpk"
-
-  docker_manager = DockerManager(
-      gcloud_cfg_path=ctk_gcloud_cfg, working_dir=docker_path
-  )
-  docker_manager.initialize()
-
-  bpm = BlueprintGenerator(storage_path=bp_path)
-  a3_mega_blueprint = bpm.generate_a3_ultra_blueprint(
-      cluster_name=cluster_name,
-      blueprint_name=blueprint_name,
-      region=region,
-      project_id=project_id,
-      auth_cidr=auth_cidr,
-      zone=zone,
-      capacity_type=CapacityType.SPOT,
-      num_nodes=1,
-      system_node_pool_machine_type="e2-standard-16",
-      release_channel=ReleaseChannel(release_channel),
-      cluster_version=cluster_version,
-  )
-  blueprint_test_path = os.path.join(bp_path, f"{blueprint_name}.yaml")
-  blueprint_deps_test_path = os.path.join(bp_path, blueprint_name)
-
-  assert a3_mega_blueprint.blueprint_file == blueprint_test_path
-  assert a3_mega_blueprint.blueprint_dependencies == blueprint_deps_test_path
-
-  assert os.path.isfile(blueprint_test_path)
-  assert os.path.isdir(blueprint_deps_test_path)
-  assert os.path.isfile(
-      os.path.join(blueprint_deps_test_path, "mlgru-disable.yaml")
-  )
-  assert os.path.isfile(
-      os.path.join(blueprint_deps_test_path, "nccl-installer.yaml")
-  )
-  gcluster_manager = GclusterManager(
-      gcluster_command_runner=docker_manager, remote_state_client=None
-  )
-
-  staged_bp_path = gcluster_manager.stage_files(
-      blueprint_file=a3_mega_blueprint.blueprint_file,
-      blueprint_dependencies=a3_mega_blueprint.blueprint_dependencies,
-  )
-
-  gcluster_manager.deploy(
-      blueprint_path=staged_bp_path, deployment_name=blueprint_name
-  )
-
-  #   cleanup part
-  gcluster_manager.destroy_deployment(deployment_name=blueprint_name)

integration/gcluster_a4_test.py

@@ -1,187 +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.
-"""
-
-import os
-import shutil
-
-import pytest
-
-from xpk.commands.cluster_gcluster import get_unique_name
-from xpk.core.blueprint.blueprint_generator import BlueprintGenerator
-from xpk.core.capacity import CapacityType
-from xpk.core.docker_manager import DockerManager
-from xpk.core.gcluster_manager import GclusterManager
-from xpk.utils.versions import ReleaseChannel
-
-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("A4_TEST_CLUSTER_NAME")
-release_channel = os.getenv("RELEASE_CHANNEL")
-cluster_version = os.getenv("CLUSTER_VERSION")
-
-
-@pytest.fixture(name="setup_tests")
-def prepare_test():
-  pwd = os.getcwd()
-  docker_path = os.path.join(pwd, "xpk_test_docker_dir")
-  bp_path = os.path.join(pwd, "xpk_test_bp_dir")
-  if not os.path.exists(docker_path):
-    os.makedirs(docker_path)
-  if not os.path.exists(bp_path):
-    os.makedirs(bp_path)
-  yield (docker_path, bp_path)
-  shutil.rmtree(docker_path)
-  shutil.rmtree(bp_path)
-
-
-@pytest.mark.skip(
-    reason=(
-        "This test requires A4 capacity, therefore it should not be run on each"
-        " build. Please invoke it manually if needed. "
-    )
-)
-def test_create_a4_deployment_files(setup_tests):
-  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
-  assert release_channel is not None
-  assert cluster_version is not None
-  docker_path, bp_path = setup_tests[0], setup_tests[1]
-  blueprint_name = f"{cluster_name}-a4-xpk"
-
-  docker_manager = DockerManager(
-      gcloud_cfg_path=ctk_gcloud_cfg, working_dir=docker_path
-  )
-  docker_manager.initialize()
-  prefix = f"{project_id}-{region}".lower()
-  bpm = BlueprintGenerator(storage_path=bp_path)
-  a4_blueprint = bpm.generate_a4_blueprint(
-      cluster_name=cluster_name,
-      blueprint_name=blueprint_name,
-      region=region,
-      project_id=project_id,
-      auth_cidr=auth_cidr,
-      zone=zone,
-      reservation="foo",
-      num_nodes=1,
-      system_node_pool_machine_type="e2-standard-16",
-      prefix=prefix,
-      release_channel=ReleaseChannel(release_channel),
-      cluster_version=cluster_version,
-  )
-  blueprint_test_path = os.path.join(bp_path, prefix, f"{blueprint_name}.yaml")
-  blueprint_deps_test_path = os.path.join(bp_path, blueprint_name)
-  assert a4_blueprint.blueprint_file == blueprint_test_path
-  assert a4_blueprint.blueprint_dependencies == blueprint_deps_test_path
-
-  assert os.path.isfile(blueprint_test_path)
-  assert os.path.isdir(blueprint_deps_test_path)
-  assert os.path.isfile(
-      os.path.join(blueprint_deps_test_path, "mlgru-disable.yaml")
-  )
-  assert os.path.isfile(
-      os.path.join(blueprint_deps_test_path, "nccl-installer.yaml")
-  )
-  gcluster_manager = GclusterManager(
-      gcluster_command_runner=docker_manager, remote_state_client=None
-  )
-
-  staged_bp_path = gcluster_manager.stage_files(
-      blueprint_file=a4_blueprint.blueprint_file,
-      blueprint_dependencies=a4_blueprint.blueprint_dependencies,
-      prefix=prefix,
-  )
-  assert staged_bp_path == os.path.join(
-      "/out/uploads", prefix, f"{blueprint_name}.yaml"
-  )
-  unique_name = get_unique_name(project_id, region, zone)
-  gcluster_manager.deploy(
-      blueprint_path=staged_bp_path, deployment_name=unique_name, dry_run=True
-  )
-
-
-@pytest.mark.skip(
-    reason=(
-        "This test requires A4 capacity, therefore it should not be run on each"
-        " build. Please invoke it manually if needed. "
-    )
-)
-def test_create_a4_deployment(setup_tests):
-  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
-  assert release_channel is not None
-  assert cluster_version is not None
-  docker_path, bp_path = setup_tests[0], setup_tests[1]
-  blueprint_name = f"{cluster_name}-a4-xpk"
-
-  docker_manager = DockerManager(
-      gcloud_cfg_path=ctk_gcloud_cfg, working_dir=docker_path
-  )
-  docker_manager.initialize()
-
-  bpm = BlueprintGenerator(storage_path=bp_path)
-  a4_blueprint = bpm.generate_a4_blueprint(
-      cluster_name=cluster_name,
-      blueprint_name=blueprint_name,
-      region=region,
-      project_id=project_id,
-      auth_cidr=auth_cidr,
-      zone=zone,
-      capacity_type=CapacityType.SPOT,
-      num_nodes=1,
-      system_node_pool_machine_type="e2-standard-16",
-      release_channel=ReleaseChannel(release_channel),
-      cluster_version=cluster_version,
-  )
-  blueprint_test_path = os.path.join(bp_path, f"{blueprint_name}.yaml")
-  blueprint_deps_test_path = os.path.join(bp_path, blueprint_name)
-
-  assert a4_blueprint.blueprint_file == blueprint_test_path
-  assert a4_blueprint.blueprint_dependencies == blueprint_deps_test_path
-
-  assert os.path.isfile(blueprint_test_path)
-  assert os.path.isdir(blueprint_deps_test_path)
-  assert os.path.isfile(
-      os.path.join(blueprint_deps_test_path, "mlgru-disable.yaml")
-  )
-  assert os.path.isfile(
-      os.path.join(blueprint_deps_test_path, "nccl-installer.yaml")
-  )
-  gcluster_manager = GclusterManager(
-      gcluster_command_runner=docker_manager, remote_state_client=None
-  )
-
-  staged_bp_path = gcluster_manager.stage_files(
-      blueprint_file=a4_blueprint.blueprint_file,
-      blueprint_dependencies=a4_blueprint.blueprint_dependencies,
-  )
-
-  gcluster_manager.deploy(
-      blueprint_path=staged_bp_path, deployment_name=blueprint_name
-  )
-
-  #   cleanup part
-  gcluster_manager.destroy_deployment(deployment_name=blueprint_name)

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/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-1.0.0.dist-info/top_level.txt

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