Coverage for src/container_collection/docker/make_docker_job.py: 100%

1from __future__ import annotations 

2 

3 

4def make_docker_job(name: str, image: str, environment: list[str] | None = None) -> dict: 

5 """ 

6 Create docker job definition. 

7 

8 Environment variables are passed as strings using the following structure: 

9 

10 .. code-block:: python 

11 

12 [ 

13 "envName1=envValue1", 

14 "envName2=envValue2", 

15 ... 

16 ] 

17 

18 Parameters 

19 ---------- 

20 name 

21 Job definition name. 

22 image 

23 Docker image. 

24 environment 

25 List of environment variables as strings. 

26 

27 Returns 

28 ------- 

29 : 

30 Job definition. 

31 """ 

32 

33 job_definition = { 

34 "image": image, 

35 "name": name, 

36 "volumes": ["/mnt"], 

37 } 

38 

39 if environment is not None: 

40 job_definition["environment"] = environment 

41 

42 return job_definition