Add --debug option to show exec_cmd and run_cmd commands

bin/ramalama

@@ -73,6 +73,8 @@ def main(args):
     except AttributeError:
         parser.print_usage()
         print("ramalama: requires a subcommand")
+        if args.debug:
+            raise
     except IndexError as e:
         ramalama.perror("Error: " + str(e).strip("'"))
         sys.exit(errno.EINVAL)

docs/ramalama.1.md

@@ -76,6 +76,9 @@ $ cat /usr/share/ramalama/shortnames.conf
 run RamaLama in the default container (default: True)
 use environment variable "RAMALAMA_IN_CONTAINER=false" to change default.
 
+#### **--debug**
+print debug messages
+
 #### **--dryrun**
 show container runtime command without executing it (default: False)
 

ramalama/cli.py

@@ -84,6 +84,11 @@ def init_cli():
         help="""run RamaLama in the default container.
 The RAMALAMA_IN_CONTAINER environment variable modifies default behaviour.""",
     )
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        help="display debug messages",
+    )
     parser.add_argument(
         "--dryrun", dest="dryrun", action="store_true", help="show container runtime command without executing it"
     )
@@ -674,7 +679,7 @@ def cleanup():
 
     atexit.register(cleanup)
 
-    run_cmd(conman_args, stdout=None)
+    run_cmd(conman_args, stdout=None, debug=args.debug)
 
 
 def dry_run(args):

ramalama/common.py

@@ -59,9 +59,9 @@ def available(cmd):
     return shutil.which(cmd) is not None
 
 
-def exec_cmd(args, stderr=True):
-    if x:
-        print(*args)
+def exec_cmd(args, stderr=True, debug=False):
+    if debug:
+        perror("exec_cmd: ", *args)
 
     if not stderr:
         # Redirecting stderr to /dev/null
@@ -75,16 +75,16 @@ def exec_cmd(args, stderr=True):
         raise
 
 
-def run_cmd(args, cwd=None, stdout=subprocess.PIPE, ignore_stderr=False):
+def run_cmd(args, cwd=None, stdout=subprocess.PIPE, ignore_stderr=False, debug=False):
     """
     Run the given command arguments.
 
     Args:
     args: command line arguments to execute in a subprocess
     cwd: optional working directory to run the command from
     """
-    if x:
-        print(*args)
+    if debug:
+        perror("run_cmd: ", *args)
 
     stderr = None
     if ignore_stderr:

ramalama/huggingface.py

@@ -61,7 +61,7 @@ def pull(self, args):
             # Symlink is already correct, no need to update it
             return symlink_path
 
-        run_cmd(["ln", "-sf", relative_target_path, symlink_path])
+        run_cmd(["ln", "-sf", relative_target_path, symlink_path], debug=args.debug)
 
         return symlink_path
 
@@ -79,7 +79,8 @@ def push(self, source, args):
                     args.store + "/repos/huggingface/.cache",
                     "--local-dir",
                     args.store + "/repos/huggingface/" + self.directory,
-                ]
+                ],
+                debug=args.debug,
             )
             return proc.stdout.decode("utf-8")
         except FileNotFoundError as e:
@@ -95,7 +96,7 @@ def symlink_path(self, args):
 
     def exec(self, args):
         try:
-            exec_cmd(args)
+            exec_cmd(args, args.debug)
         except FileNotFoundError as e:
             raise NotImplementedError(
                 """\

ramalama/model.py

@@ -121,7 +121,7 @@ def run(self, args):
             exec_args.append("-cnv")
 
         try:
-            exec_cmd(exec_args, False)
+            exec_cmd(exec_args, False, debug=args.debug)
         except FileNotFoundError as e:
             if in_container():
                 raise NotImplementedError(file_not_found_in_container % (exec_args[0], str(e).strip("'")))
@@ -140,7 +140,7 @@ def serve(self, args):
             return self.kube(symlink_path, args, exec_args)
 
         try:
-            exec_cmd(exec_args)
+            exec_cmd(exec_args, debug=args.debug)
         except FileNotFoundError as e:
             if in_container():
                 raise NotImplementedError(file_not_found_in_container % (exec_args[0], str(e).strip("'")))

ramalama/oci.py

@@ -43,13 +43,12 @@ def login(self, args):
         if args.passwordstdin:
             conman_args.append("--password-stdin")
         conman_args.append(args.REGISTRY.removeprefix(prefix))
-        print(" ".join(conman_args))
-        return exec_cmd(conman_args)
+        return exec_cmd(conman_args, debug=args.debug)
 
     def logout(self, args):
         conman_args = [self.conman, "logout"]
         conman_args.append(self.model)
-        return exec_cmd(conman_args)
+        return exec_cmd(conman_args, debug=args.debug)
 
     def _target_decompose(self, model):
         # Remove the prefix and extract target details
@@ -83,7 +82,9 @@ def _build(self, source, target, args):
 COPY {model} /{model_name}
 """
             )
-        run_cmd([self.conman, "build", "-t", target, "-f", containerfile.name, contextdir], stdout=None)
+        run_cmd(
+            [self.conman, "build", "-t", target, "-f", containerfile.name, contextdir], stdout=None, debug=args.debug
+        )
 
     def push(self, source, args):
         target = self.model.removeprefix(prefix)

ramalama/ollama.py

@@ -160,7 +160,11 @@ def pull(self, args):
         registry = "https://registry.ollama.ai"
         accept = "Accept: application/vnd.docker.distribution.manifest.v2+json"
         registry_head = f"{registry}/v2/{model_name}"
-        return init_pull(repos, accept, registry_head, model_name, model_tag, models, symlink_path, self.model)
+        try:
+            return init_pull(repos, accept, registry_head, model_name, model_tag, models, symlink_path, self.model)
+        except urllib.error.HTTPError as e:
+            raise KeyError(f"failed to pull {registry_head}: " +str(e).strip("'"))
+
 
     def symlink_path(self, args):
         models = args.store + "/models/ollama"

test/system/015-help.bats

@@ -133,7 +133,7 @@ function check_help() {
     # Test for regression of #7273 (spurious "--remote" help on output)
     for helpopt in help --help -h; do
         run_ramalama $helpopt
-        is "${lines[0]}" "usage: ramalama [-h] [--container] [--dryrun] [--engine ENGINE]" \
+        is "${lines[0]}" "usage: ramalama [-h] [--container] [--debug] [--dryrun] [--engine ENGINE]" \
            "ramalama $helpopt: first line of output"
     done
 

test/system/050-pull.bats

@@ -23,6 +23,10 @@ load setup_suite
     run_ramalama list
     is "$output" ".*ollama://tinyllama:1.1b" "image was actually pulled locally"
     run_ramalama rm ollama://tinyllama ollama://tinyllama:1.1b
+
+    random_image_name=i_$(safename)
+    run_ramalama 1 pull ${random_image_name}
+    is "$output" "Error: failed to pull https://registry.ollama.ai/v2/library/${random_image_name}: HTTP Error 404: Not Found" "image does not exist"
 }
 
 # bats test_tags=distro-integration