From 4405f803416ae01d9b9566354ef880d804fc8b73 Mon Sep 17 00:00:00 2001
From: Paul Spooren <mail@aparcar.org>
Date: Fri, 29 Sep 2023 17:10:28 +0200
Subject: [PATCH] rename `working_dir` to `workdir` for consistency

Currently `podman-py` uses all three versions of `work_dir`,
`working_dir` and `workdir` (not to mention `WorkingDir`).

This commit tries to unify the parameter usage by allowing `workdir` for
container `create` or `run`. For backwards compatibility `working_dir`
still works but a deprecation warning is added.

Since upstream Podman uses a variety of *workdir* versions the
`podman-py` codebase can't be simplified further.

Fix: #330

Signed-off-by: Paul Spooren <mail@aparcar.org>
---
 podman/domain/containers_create.py                | 8 ++++++--
 podman/tests/integration/test_container_create.py | 6 ++++++
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/podman/domain/containers_create.py b/podman/domain/containers_create.py
index d9724b0b..ecb9c4cd 100644
--- a/podman/domain/containers_create.py
+++ b/podman/domain/containers_create.py
@@ -4,6 +4,7 @@
 import re
 from contextlib import suppress
 from typing import Any, Dict, List, MutableMapping, Union
+import warnings
 
 from podman import api
 from podman.domain.containers import Container
@@ -287,7 +288,7 @@ def create(
                     }
 
             volumes_from (List[str]): List of container names or IDs to get volumes from.
-            working_dir (str): Path to the working directory.
+            workdir (str): Path to the working directory.
 
         Returns:
             A Container object.
@@ -403,6 +404,9 @@ def to_bytes(size: Union[int, str, None]) -> Union[int, None]:
                     f"or int (found : {size_type})"
                 )
 
+        if "working_dir" in args:
+            warnings.warn("working_dir is deprecated, use workdir instead", PendingDeprecationWarning)
+
         # Transform keywords into parameters
         params = {
             "annotations": pop("annotations"),  # TODO document, podman only
@@ -484,7 +488,7 @@ def to_bytes(size: Union[int, str, None]) -> Union[int, None]:
             "version": pop("version"),
             "volumes": [],
             "volumes_from": pop("volumes_from"),
-            "work_dir": pop("working_dir"),
+            "work_dir": pop("workdir") or pop("working_dir"),
         }
 
         for device in args.pop("devices", []):
diff --git a/podman/tests/integration/test_container_create.py b/podman/tests/integration/test_container_create.py
index fdd98c77..2e6dee83 100644
--- a/podman/tests/integration/test_container_create.py
+++ b/podman/tests/integration/test_container_create.py
@@ -322,6 +322,12 @@ def test_read_write_tmpfs(self):
                     print(inspect)
                     self.assertIn(expected_output, logs)
 
+    def test_container_working_dir_deprecation(self):
+        with self.assertWarns(DeprecationWarning):
+            self.client.containers.create(
+                self.alpine_image, working_dir="/tmp", command=["/bin/ls", "-l", "/"]
+            )
+
 
 if __name__ == '__main__':
     unittest.main()