Implement dependecies validation (#366)

*Implement dependencies validation

Signed-off-by: Piotr Pawłowski <ppawl@google.com>

---------

Signed-off-by: Piotr Pawłowski <ppawl@google.com>

Author: pawloch00

README.md

@@ -90,7 +90,7 @@ Following tools must be installed:
 # sudo may be required
 apt-get -y install make
 ```
-In addition, below dependencies will be installed with `make install` command:
+In addition, below dependencies can be installed either using provided links or using `make install` command, if xpk is downloaded via `git clone` command:
 - kueuectl (install from [here](https://kueue.sigs.k8s.io/docs/reference/kubectl-kueue/installation/))
 - kjob (installation instructions [here](https://github.com/kubernetes-sigs/kjob/blob/main/docs/installation.md))
 

pytype-conf.cfg

@@ -25,7 +25,7 @@ exclude =
 # Keep going past errors to analyze as many files as possible.
 keep_going = True
 
-jobs = 5
+jobs = auto
 
 # Platform (e.g., "linux", "win32") that the target code runs on.
 platform = linux

src/xpk/commands/version.py

@@ -18,6 +18,10 @@
 from ..utils.console import xpk_print
 
 
+def get_xpk_version() -> str:
+  return __version__
+
+
 def version(args) -> None:  # pylint: disable=unused-argument
   """Get version of xpk."""
   xpk_version, git_hash = __version__.split('+')

src/xpk/core/commands.py

@@ -246,7 +246,7 @@ def run_command_for_value(
     int: return_code, default is 0
     str: return_val, default is '0'
   """
-  if global_args.dry_run:
+  if global_args is not None and global_args.dry_run:
     xpk_print(
         f'Task: `{task}` is implemented by the following command'
         ' not running since it is a dry run.'

src/xpk/core/config.py

@@ -34,11 +34,16 @@
 CLUSTER_NAME_KEY = 'cluster-name'
 PROJECT_KEY = 'project-id'
 ZONE_KEY = 'zone'
+CONFIGS_KEY = 'configs'
+DEPENDENCIES_KEY = 'deps-verified-version'
+XPK_CONFIG_FILE = os.path.expanduser('~/.config/xpk/config.yaml')
+
 DEFAULT_KEYS = [
     CFG_BUCKET_KEY,
     CLUSTER_NAME_KEY,
     PROJECT_KEY,
     ZONE_KEY,
+    DEPENDENCIES_KEY,
 ]
 VERTEX_TENSORBOARD_FEATURE_FLAG = XPK_CURRENT_VERSION >= '0.4.0'
 GCS_FUSE_ANNOTATION = 'gke-gcsfuse/volumes: "true"'
@@ -92,7 +97,7 @@ def get(self, key: str) -> str | None:
       return None
 
     vals: dict[str, str] = config_yaml[CONFIGS_KEY]
-    return vals[key]
+    return vals.get(key)
 
   def get_all(
       self,

src/xpk/main.py

@@ -36,10 +36,11 @@
 
 from .parser.core import set_parser
 from .utils.console import xpk_print
-
+from .utils.validation import validate_dependencies
 ################### Compatibility Check ###################
 # Check that the user runs the below version or greater.
 
+
 major_version_supported = 3
 minor_version_supported = 10
 
@@ -60,6 +61,7 @@
 set_parser(parser=parser)
 
 xpk_print('Starting xpk', flush=True)
+validate_dependencies()
 main_args = parser.parse_args()
 main_args.enable_ray_cluster = False
 main_args.func(main_args)

src/xpk/utils/validation.py

@@ -0,0 +1,80 @@
+"""
+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 ..core.commands import run_command_for_value
+from .console import xpk_exit, xpk_print
+from ..commands.config import xpk_cfg
+from ..core.config import DEPENDENCIES_KEY
+from ..commands.version import get_xpk_version
+
+
+validation_commands = {
+    'kubectl': {
+        'command': 'kubectl --help',
+        'message': (
+            '`kubectl` not installed. Please follow'
+            ' https://github.com/AI-Hypercomputer/xpk?tab=readme-ov-file#prerequisites'
+            ' to install xpk prerequisites.'
+        ),
+    },
+    'kjob': {
+        'command': 'kubectl kjob --help',
+        'message': (
+            '`kjobctl` not installed. Please follow'
+            ' https://github.com/AI-Hypercomputer/xpk?tab=readme-ov-file#prerequisites'
+            ' to install xpk prerequisites.'
+        ),
+    },
+    'gcloud': {
+        'command': 'gcloud version',
+        'message': (
+            '`gcloud not installed. Please follow'
+            ' https://github.com/AI-Hypercomputer/xpk?tab=readme-ov-file#prerequisites'
+            ' to install xpk prerequisites.'
+        ),
+    },
+    'docker': {
+        'command': 'docker version',
+        'message': (
+            '`docker` not installed. Please follow'
+            ' https://github.com/AI-Hypercomputer/xpk?tab=readme-ov-file#prerequisites'
+            ' to install xpk prerequisites.'
+        ),
+    },
+    'kueuectl': {
+        'command': 'kubectl kueue --help',
+        'message': (
+            '`kueuectl` not installed. Please follow'
+            ' https://github.com/AI-Hypercomputer/xpk?tab=readme-ov-file#prerequisites'
+            ' to install xpk prerequisites.'
+        ),
+    },
+}
+
+
+def validate_dependencies():
+  deps_version = xpk_cfg.get(DEPENDENCIES_KEY)
+  xpk_version = get_xpk_version()
+  if deps_version is None or deps_version != xpk_version:
+    for name, check in validation_commands.items():
+      cmd, message = check['command'], check['message']
+      code, _ = run_command_for_value(
+          cmd, f'Validate {name} installation.', None
+      )
+      if code != 0:
+        xpk_print(message)
+        xpk_exit(code)
+    xpk_cfg.set(DEPENDENCIES_KEY, get_xpk_version())