Merge pull request #1295 from lisongmin/fix-pull-can-not-set-to-pull-policy

fix: `--pull` option in `build` and `up` command can not set to pull policy

Author: p12tic

newsfragments/pull-option-can-not-set-to-pull-policy.bugfix

@@ -0,0 +1 @@
+Fixed `--pull` option in `build` and `up` command can not set to pull policy explicitly.

podman_compose.py

@@ -32,6 +32,7 @@
 from typing import Any
 from typing import Callable
 from typing import Iterable
+from typing import Sequence
 from typing import Union
 from typing import overload
 
@@ -1249,7 +1250,7 @@ async def container_to_args(
         podman_args.extend(["--pid", cnt["pid"]])
     pull_policy = cnt.get("pull_policy")
     if pull_policy is not None and pull_policy != "build":
-        podman_args.extend(["--pull", pull_policy])
+        podman_args.append(f"--pull={pull_policy}")
     if cnt.get("restart") is not None:
         podman_args.extend(["--restart", cnt["restart"]])
     container_to_ulimit_args(cnt, podman_args)
@@ -3011,10 +3012,11 @@ def cleanup_temp_dockfile() -> None:
     container_to_ulimit_build_args(cnt, build_args)
     if getattr(args, "no_cache", None):
         build_args.append("--no-cache")
-    if getattr(args, "pull_always", None):
-        build_args.append("--pull-always")
-    elif getattr(args, "pull", None):
-        build_args.append("--pull")
+
+    pull_policy = getattr(args, "pull", None)
+    if pull_policy:
+        build_args.append(f"--pull={pull_policy}")
+
     args_list = norm_as_list(build_desc.get("args", {}))
     for build_arg in args_list + args.build_arg:
         build_args.extend((
@@ -4215,18 +4217,40 @@ def compose_ps_parse(parser: argparse.ArgumentParser) -> None:
     parser.add_argument("-q", "--quiet", help="Only display container IDs", action="store_true")
 
 
+class PullPolicyAction(argparse.Action):
+    def __call__(
+        self,
+        parser: argparse.ArgumentParser,
+        namespace: argparse.Namespace,
+        values: str | Sequence[str] | None,
+        option_string: str | None = None,
+    ) -> None:
+        if option_string == "--pull-always":
+            if values in (None, "true"):
+                namespace.pull = "always"
+
+            return
+
+        namespace.pull = "newer" if values is None else values
+
+
 @cmd_parse(podman_compose, ["build", "up"])
 def compose_build_up_parse(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         "--pull",
-        help="attempt to pull a newer version of the image",
-        action="store_true",
+        help="Pull image policy (always|missing|never|newer)."
+        " Set to 'newer' if specify --pull without a value."
+        " default (pull_policy in compose file).",
+        action=PullPolicyAction,
+        nargs="?",
+        choices=["always", "missing", "never", "newer"],
     )
     parser.add_argument(
         "--pull-always",
-        help="attempt to pull a newer version of the image, Raise an error even if the image is "
-        "present locally.",
-        action="store_true",
+        help="Deprecated, use --pull=always instead",
+        action=PullPolicyAction,
+        nargs="?",
+        choices=["true", "false"],
     )
     parser.add_argument(
         "--build-arg",

tests/unit/test_container_to_build_args.py

@@ -31,6 +31,7 @@ def get_minimal_container():
 def get_minimal_args():
     args = mock.Mock()
     args.build_arg = []
+    args.pull = None
     return args
 
 
@@ -50,7 +51,6 @@ def test_minimal(self):
                 '-t',
                 'new-image',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -73,7 +73,6 @@ def test_platform(self):
                 '--platform',
                 'linux/amd64',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -98,7 +97,6 @@ def test_tags(self):
                 '-t',
                 'some-tag2:2',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -123,7 +121,6 @@ def test_labels(self):
                 '--label',
                 'some-label2.2',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -145,7 +142,6 @@ def test_caches(self):
                 '-t',
                 'new-image',
                 '--no-cache',
-                '--pull-always',
                 '--cache-from',
                 'registry/image1',
                 '--cache-from',
@@ -195,7 +191,6 @@ def test_context_git_url(self):
                 '-t',
                 'new-image',
                 '--no-cache',
-                '--pull-always',
                 'https://github.com/test_repo.git',
             ],
         )
@@ -228,7 +223,6 @@ def test_build_ssh_absolute_path(self):
                 '--ssh',
                 'id1=/test1',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -251,7 +245,6 @@ def test_build_ssh_relative_path(self):
                 '--ssh',
                 'id1=test_dirname/id1/test1',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -274,7 +267,6 @@ def test_build_ssh_working_dir(self):
                 '--ssh',
                 'id1=test_dirname/./test1',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -298,7 +290,6 @@ def test_build_ssh_path_home_dir(self):
                 '--ssh',
                 'id1=/home/user/test1',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -323,7 +314,6 @@ def test_build_ssh_map(self):
                 '--ssh',
                 'id2=test_dirname/test2',
                 '--no-cache',
-                '--pull-always',
                 '.',
             ],
         )
@@ -348,7 +338,26 @@ def test_build_ssh_array(self):
                 '--ssh',
                 'id2=test_dirname/test2',
                 '--no-cache',
-                '--pull-always',
+                '.',
+            ],
+        )
+
+    def test_pull_always(self):
+        c = create_compose_mock()
+        cnt = get_minimal_container()
+        args = get_minimal_args()
+        args.pull = 'always'
+
+        args = container_to_build_args(c, cnt, args, lambda path: True)
+        self.assertEqual(
+            args,
+            [
+                '-f',
+                'Containerfile',
+                '-t',
+                'new-image',
+                '--no-cache',
+                '--pull=always',
                 '.',
             ],
         )