1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
# ==================================================================================================================== #
# _____ _ _ ____ _ ___ _ _ _ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ / ___| | |_ _| / \ | |__ ___| |_ _ __ __ _ ___| |_(_) ___ _ __ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` || | | | | | / _ \ | '_ \/ __| __| '__/ _` |/ __| __| |/ _ \| '_ \ #
# | |_) | |_| || | (_) | (_) | | | | | | (_| || |___| |___ | | / ___ \| |_) \__ \ |_| | | (_| | (__| |_| | (_) | | | | #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____|_____|___/_/ \_\_.__/|___/\__|_| \__,_|\___|\__|_|\___/|_| |_| #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2025 Patrick Lehmann - Bötzingen, Germany #
# #
# 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 #
# #
# http://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. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""
Testcase for operating system program ``mkdir``.
:copyright: Copyright 2007-2025 Patrick Lehmann - Bötzingen, Germany
:license: Apache License, Version 2.0
"""
from pathlib import Path
from typing import Any
from pytest import mark
from sys import platform as sys_platform
from unittest import TestCase
from pyTooling.CLIAbstraction import Program, CLIAbstractionException, CLIArgument
from pyTooling.CLIAbstraction.Flag import LongFlag
from . import Helper
from .Examples import GitArgumentsMixin
if __name__ == "__main__": # pragma: no cover
print("ERROR: you called a testcase declaration file as an executable module.")
print("Use: 'python -m unittest <testcase module>'")
exit(1)
class Git(Program, GitArgumentsMixin):
def __new__(cls, *args: Any, **kwargs: Any):
cls._executableNames = {
"Darwin": "git",
"FreeBSD": "git",
"Linux": "git",
"Windows": "git.exe"
}
return super().__new__(cls)
class Gitt(Program):
_executableNames = {
"Darwin": "gitt",
"FreeBSD": "gitt",
"Linux": "gitt",
"Windows": "gitt.exe"
}
@CLIArgument()
class FlagVersion(LongFlag, name="version"):
...
class GitUnknownOS(Program):
_executableNames = {
"UnknownOS": "git"
}
@mark.skipif(sys_platform in ("darwin", "linux", "win32"), reason="Don't run these tests on Linux, macOS and Windows.")
class ExplicitPathsOnFreeBSD(TestCase, Helper):
_binaryDirectoryPath = Path("/usr/local/bin")
def test_BinaryDirectory(self) -> None:
tool = Git(binaryDirectoryPath=self._binaryDirectoryPath)
executable = self.GetExecutablePath("git", self._binaryDirectoryPath)
self.assertEqual(Path(executable), tool.Path)
self.assertListEqual([executable], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\"]", repr(tool))
self.assertEqual(f"\"{executable}\"", str(tool))
def test_BinaryDirectory_NotAPath(self) -> None:
with self.assertRaises(TypeError):
_ = Git(binaryDirectoryPath=str(self._binaryDirectoryPath))
def test_BinaryDirectory_DoesNotExist(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = Git(binaryDirectoryPath=self._binaryDirectoryPath / "git")
def test_ExecutablePath(self) -> None:
tool = Git(executablePath=self._binaryDirectoryPath / "git")
executable = self.GetExecutablePath("git", self._binaryDirectoryPath)
self.assertEqual(Path(executable), tool.Path)
self.assertListEqual([executable], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\"]", repr(tool))
self.assertEqual(f"\"{executable}\"", str(tool))
def test_ExecutablePath_NotAPath(self) -> None:
with self.assertRaises(TypeError):
_ = Git(executablePath=str(self._binaryDirectoryPath / "git"))
def test_ExecutablePath_DoesNotExist(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = Git(executablePath=self._binaryDirectoryPath / "gitt")
@mark.skipif(sys_platform in ("freebsd", "win32"), reason="Don't run these tests on FreeBSD and Windows.")
class ExplicitPathsOnLinux(TestCase, Helper):
_binaryDirectoryPath = Path("/usr/bin")
def test_BinaryDirectory(self) -> None:
tool = Git(binaryDirectoryPath=self._binaryDirectoryPath)
executable = self.GetExecutablePath("git", self._binaryDirectoryPath)
self.assertEqual(Path(executable), tool.Path)
self.assertListEqual([executable], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\"]", repr(tool))
self.assertEqual(f"\"{executable}\"", str(tool))
def test_BinaryDirectory_NotAPath(self) -> None:
with self.assertRaises(TypeError):
_ = Git(binaryDirectoryPath=str(self._binaryDirectoryPath))
def test_BinaryDirectory_DoesNotExist(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = Git(binaryDirectoryPath=self._binaryDirectoryPath / "git")
def test_ExecutablePath(self) -> None:
tool = Git(executablePath=self._binaryDirectoryPath / "git")
executable = self.GetExecutablePath("git", self._binaryDirectoryPath)
self.assertEqual(Path(executable), tool.Path)
self.assertListEqual([executable], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\"]", repr(tool))
self.assertEqual(f"\"{executable}\"", str(tool))
def test_ExecutablePath_NotAPath(self) -> None:
with self.assertRaises(TypeError):
_ = Git(executablePath=str(self._binaryDirectoryPath / "git"))
def test_ExecutablePath_DoesNotExist(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = Git(executablePath=self._binaryDirectoryPath / "gitt")
@mark.skipif(sys_platform in ("darwin", "freebsd", "linux"), reason="Don't run these tests on FreeBSD, Linux or macOS.")
class ExplicitPathsOnWindows(TestCase, Helper):
_binaryDirectoryPath = Path(r"C:\Program Files\Git\cmd")
def test_BinaryDirectory(self) -> None:
tool = Git(binaryDirectoryPath=self._binaryDirectoryPath)
executable = self.GetExecutablePath("git", self._binaryDirectoryPath)
self.assertEqual(Path(executable), tool.Path)
self.assertListEqual([executable], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\"]", repr(tool))
self.assertEqual(f"\"{executable}\"", str(tool))
def test_BinaryDirectory_NotAPath(self) -> None:
with self.assertRaises(TypeError):
_ = Git(binaryDirectoryPath=str(self._binaryDirectoryPath))
def test_BinaryDirectory_DoesNotExist(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = Git(binaryDirectoryPath=self._binaryDirectoryPath / "git")
def test_ExecutablePath(self) -> None:
tool = Git(executablePath=self._binaryDirectoryPath / "git.exe")
executable = self.GetExecutablePath("git", self._binaryDirectoryPath)
self.assertEqual(Path(executable), tool.Path)
self.assertListEqual([executable], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\"]", repr(tool))
self.assertEqual(f"\"{executable}\"", str(tool))
def test_ExecutablePath_NotAPath(self) -> None:
with self.assertRaises(TypeError):
_ = Git(executablePath=str(self._binaryDirectoryPath / "git.exe"))
def test_ExecutablePath_DoesNotExist(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = Git(executablePath=self._binaryDirectoryPath / "gitt.exe")
class CommonOptions(TestCase, Helper):
def test_UnknownOS(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = GitUnknownOS()
def test_BinaryDirectory_UnknownOS(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = GitUnknownOS(binaryDirectoryPath=Path(""))
def test_NotInPath(self) -> None:
with self.assertRaises(CLIAbstractionException):
_ = Gitt()
def test_SetUnknownFlag(self) -> None:
tool = Git()
with self.assertRaises(TypeError):
tool["version"] = True
with self.assertRaises(KeyError):
tool[Gitt.FlagVersion] = True
tool[tool.FlagVersion] = True
with self.assertRaises(KeyError):
tool[tool.FlagVersion] = True
def test_GetUnknownFlag(self) -> None:
tool = Git()
with self.assertRaises(KeyError):
_ = tool[tool.FlagVersion]
tool[tool.FlagVersion] = True
with self.assertRaises(TypeError):
_ = tool["version"]
def test_VersionFlag(self) -> None:
tool = Git()
tool[tool.FlagVersion] = True
executable = self.GetExecutablePath("git")
self.assertListEqual([executable, "--version"], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\", \"--version\"]", repr(tool))
def test_HelpFlag(self) -> None:
tool = Git()
tool[tool.FlagHelp] = True
executable = self.GetExecutablePath("git")
self.assertListEqual([executable, "--help"], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\", \"--help\"]", repr(tool))
def test_HelpCommand(self) -> None:
tool = Git()
tool[tool.CommandHelp] = True
executable = self.GetExecutablePath("git")
self.assertListEqual([executable, "help"], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\", \"help\"]", repr(tool))
class Commit(TestCase, Helper):
def test_CommitWithMessage(self) -> None:
tool = Git()
tool[tool.CommandCommit] = True
tool[tool.ValueCommitMessage] = "Initial commit."
executable = self.GetExecutablePath("git")
self.assertListEqual([executable, "commit", "-m", "Initial commit."], tool.ToArgumentList())
self.assertEqual(f"[\"{executable}\", \"commit\", \"-m\", \"Initial commit.\"]", repr(tool))
|
