pyVersioning

pyVersioning/__init__.py
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
# ==================================================================================================================== #
#            __     __            _             _                                                                      #
#  _ __  _   \ \   / /__ _ __ ___(_) ___  _ __ (_)_ __   __ _                                                          #
# | '_ \| | | \ \ / / _ \ '__/ __| |/ _ \| '_ \| | '_ \ / _` |                                                         #
# | |_) | |_| |\ V /  __/ |  \__ \ | (_) | | | | | | | | (_| |                                                         #
# | .__/ \__, | \_/ \___|_|  |___/_|\___/|_| |_|_|_| |_|\__, |                                                         #
# |_|    |___/                                          |___/                                                          #
# ==================================================================================================================== #
# Authors:                                                                                                             #
#   Patrick Lehmann                                                                                                    #
#                                                                                                                      #
# License:                                                                                                             #
# ==================================================================================================================== #
# Copyright 2020-2024 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                                                                                  #
# ==================================================================================================================== #
#
__author__ =    "Patrick Lehmann"
__email__ =     "Paebbels@gmail.com"
__copyright__ = "2020-2024, Patrick Lehmann"
__license__ =   "Apache License, Version 2.0"
__version__ =   "0.16.4"
__keywords__ =  ["Python3", "Template", "Versioning", "Git"]

from dataclasses  import make_dataclass
from datetime     import date, time, datetime
from enum         import Enum, auto
from os           import environ
from subprocess   import run as subprocess_run, PIPE, CalledProcessError
from sys          import version_info
from typing       import Union, Any, Dict, Tuple, ClassVar, Generator, Optional as Nullable, List

from pyTooling.Decorators       import export, readonly
from pyTooling.MetaClasses      import ExtendedType
from pyTooling.Versioning       import SemanticVersion
from pyTooling.TerminalUI       import ILineTerminal

from pyVersioning.Configuration import Configuration, Project, Compiler, Build


@export
class VersioningException(Exception):
	"""Base-exception for all exceptions thrown by pyVersioning."""

	# WORKAROUND: for Python <3.11
	# Implementing a dummy method for Python versions before
	__notes__: List[str]
	if version_info < (3, 11):  # pragma: no cover
		def add_note(self, message: str) -> None:
			try:
				self.__notes__.append(message)
			except AttributeError:
				self.__notes__ = [message]


@export
class ToolException(VersioningException):
	"""Exception thrown when a data collection tools has an error."""

	command:      str    #: Command that caused the exception.
	errorMessage: str    #: Error message returned by the tool.

	def __init__(self, command: str, errorMessage: str) -> None:
		"""

		:param command:      Command that caused the exception.
		:param errorMessage: Error message returned by the tool.
		"""
		super().__init__(errorMessage)
		self.command = command
		self.errorMessage = errorMessage


@export
class SelfDescriptive(metaclass=ExtendedType, slots=True, mixin=True):
	# TODO: could this be filled with a decorator?
	_public: ClassVar[Tuple[str, ...]]

	def Keys(self) -> Generator[str, None, None]:
		for element in self._public:
			yield element

	def KeyValuePairs(self) -> Generator[Tuple[str, Any], None, None]:
		for element in self._public:
			value = self.__getattribute__(element)
			yield element, value


@export
class Tool(SelfDescriptive):
	"""This data structure class describes the tool name and version of pyVersioning."""

	_name:    str
	_version: SemanticVersion

	_public:  ClassVar[Tuple[str, ...]] = ("name", "version")

	def __init__(self, name: str, version: SemanticVersion) -> None:
		"""
		Initialize a tool with name and version.

		:param name:    The tool's name.
		:param version: The tool's version.
		"""
		self._name = name
		self._version = version

	@readonly
	def name(self) -> str:
		"""
		Read-only property to return the name of the tool.

		:return: Name of the tool.
		"""
		return self._name

	@readonly
	def version(self) -> SemanticVersion:
		"""
		Read-only property to return the version of the tool.

		:return: Version of the tool as :class:`SemanticVersion`.
		"""
		return self._version

	def __str__(self) -> str:
		return f"{self._name} {self._version}"


@export
class Date(date, SelfDescriptive):
	_public: ClassVar[Tuple[str, ...]] = ("day", "month", "year")


@export
class Time(time, SelfDescriptive):
	_public: ClassVar[Tuple[str, ...]] = ("hour", "minute", "second")


@export
class Person(SelfDescriptive):
	"""
	This data structure class describes a person with name and email address.

	This class is used to describe an author or committer in a version control system.
	"""

	_name:  str    #: Name of the person.
	_email: str    #: Email address of the person.

	_public: ClassVar[Tuple[str, ...]] = ("name", "email")

	def __init__(self, name: str, email: str) -> None:
		"""
		Initialize a person with name and email address.

		:param name:  The person's name.
		:param email: The person's email address.
		"""
		self._name = name
		self._email = email

	@readonly
	def name(self) -> str:
		"""
		Read-only property to return the name of the person.

		:return: Name of the person.
		"""
		return self._name

	@readonly
	def email(self) -> str:
		"""
		Read-only property to return the email address of the person.

		:return: Email address of the person.
		"""
		return self._email

	def __str__(self) -> str:
		return f"{self._name} <{self._email}>"


@export
class Commit(SelfDescriptive):
	_hash:      str
	_date:      date
	_time:      time
	_author:    Person
	_committer: Person
	_comment:   str
	_oneline:   Union[str,  bool] = False

	_public: ClassVar[Tuple[str, ...]] = ("hash", "date", "time", "author", "committer", "comment", "oneline")

	def __init__(self, hash: str, date: date, time: time, author: Person, committer: Person, comment: str) -> None:
		"""
		Initialize a commit.

		:param hash:      The commit's hash.
		:param date:      The commit's date.
		:param time:      The commit's time.
		:param author:    The commit's author.
		:param committer: The commit's committer.
		:param comment:   The commit's comment.
		"""
		self._hash = hash
		self._date = date
		self._time = time
		self._author = author
		self._committer = committer
		self._comment = comment

		if comment != "":
			self._oneline = comment.split("\n")[0]

	@readonly
	def hash(self) -> str:
		"""
		Read-only property to return the hash of the commit.

		:return: Hash of the commit as string.
		"""
		return self._hash

	@readonly
	def date(self) -> date:
		"""
		Read-only property to return the date of the commit.

		:return: Date of the commit as :class:`date`.
		"""
		return self._date

	@readonly
	def time(self) -> time:
		"""
		Read-only property to return the time of the commit.

		:return: Time of the commit as :class:`time`.
		"""
		return self._time

	@readonly
	def author(self) -> Person:
		"""
		Read-only property to return the author of the commit.

		:return: Author of the commit as :class:`Person`.
		"""
		return self._author

	@readonly
	def committer(self) -> Person:
		"""
		Read-only property to return the committer of the commit.

		:return: Committer of the commit as :class:`Person`.
		"""
		return self._committer

	@readonly
	def comment(self) -> str:
		"""
		Read-only property to return the comment of the commit.

		:return: Author of the comment as string.
		"""
		return self._comment

	@readonly
	def oneline(self) -> Union[str,  bool]:
		return self._oneline


@export
class Git(SelfDescriptive):
	_commit:     Commit
	_reference:  str = ""
	_tag:        str = ""
	_branch:     str = ""
	_repository: str = ""

	_public: ClassVar[Tuple[str, ...]] = ("commit", "reference", "tag", "branch", "repository")

	def __init__(self, commit: Commit, repository: str, tag: str = "", branch: str = "") -> None:
		self._commit = commit
		self._tag = tag
		self._branch = branch
		self._repository = repository

		if tag != "":
			self._reference = tag
		elif branch != "":
			self._reference = branch
		else:
			self._reference = "[Detached HEAD]"

	@readonly
	def commit(self) -> Commit:
		"""
		Read-only property to return the Git commit.

		:return: The commit information as :class:`Commit`.
		"""
		return self._commit

	@readonly
	def reference(self) -> str:
		"""
		Read-only property to return the Git reference.

		A reference is either a branch or tag.

		:return: The current Git reference as string.
		"""
		return self._reference

	@readonly
	def tag(self) -> str:
		"""
		Read-only property to return the Git tag.

		:return: The current Git tag name as string.
		"""
		return self._tag

	@readonly
	def branch(self) -> str:
		"""
		Read-only property to return the Git branch.

		:return: The current Git branch name as string.
		"""
		return self._branch

	@readonly
	def repository(self) -> str:
		"""
		Read-only property to return the Git repository URL.

		:return: The current Git repository URL as string.
		"""
		return self._repository


@export
class Project(SelfDescriptive):
	"""This data structure class describes a project."""

	_name:     str                #: Name of the project.
	_variant:  str                #: Variant of the project.
	_version:  SemanticVersion    #: Version of the project.

	_public: ClassVar[Tuple[str, ...]] = ("name", "variant", "version")

	def __init__(self, name: str, version: Union[str, SemanticVersion, None] = None, variant: Nullable[str] = None) -> None:
		"""Assign fields and convert version string to a `Version` object."""

		self._name    = name    if name    is not None else ""
		self._variant = variant if variant is not None else ""

		if isinstance(version, SemanticVersion):
			self._version = version
		elif isinstance(version, str):
			self._version = SemanticVersion.Parse(version)
		elif version is None:
			self._version = SemanticVersion.Parse("v0.0.0")

	@readonly
	def name(self) -> str:
		"""
		Read-only property to return the name of the project.

		:return: The project's name as string.
		"""
		return self._name

	@readonly
	def variant(self) -> str:
		"""
		Read-only property to return the variant name of the project.

		:return: The project's variant as string.
		"""
		return self._variant

	@readonly
	def version(self) -> SemanticVersion:
		"""
		Read-only property to return the version of the project.

		:return: The project's version.
		"""
		return self._version

	def __str__(self) -> str:
		return f"{self._name} - {self._variant} {self._version}"


@export
class Compiler(SelfDescriptive):
	_name:          str
	_version:       SemanticVersion
	_configuration: str
	_options:       str

	_public: ClassVar[Tuple[str, ...]] = ("name", "version", "configuration", "options")

	def __init__(self, name: str, version: Union[str, SemanticVersion] = "", configuration: str = "", options: str = "") -> None:
		"""Assign fields and convert version string to a `Version` object."""

		self._name          = name          if name          is not None else ""
		self._configuration = configuration if configuration is not None else ""
		self._options       = options       if options       is not None else ""

		if isinstance(version, SemanticVersion):
			self._version = version
		elif isinstance(version, str):
			self._version = SemanticVersion.Parse(version)
		elif version is None:
			self._version = SemanticVersion.Parse("v0.0.0")

	@readonly
	def name(self) -> str:
		"""
		Read-only property to return the name of the compiler.

		:return: The compiler's name as string.
		"""
		return self._name

	@readonly
	def version(self) -> SemanticVersion:
		"""
		Read-only property to return the version of the compiler.

		:return: The compiler's version.
		"""
		return self._version

	@readonly
	def configuration(self) -> str:
		"""
		Read-only property to return the configuration of the compiler.

		:return: The compiler's configuration.
		"""
		return self._configuration

	@readonly
	def options(self) -> str:
		"""
		Read-only property to return the options of the compiler.

		:return: The compiler's options.
		"""
		return self._options


@export
class Build(SelfDescriptive):
	_date:     date
	_time:     time
	_compiler: Compiler

	_public: ClassVar[Tuple[str, ...]] = ("date", "time", "compiler")

	def __init__(self, date: date, time: time, compiler: Compiler) -> None:
		self._date = date
		self._time = time
		self._compiler = compiler

	@readonly
	def date(self) -> date:
		"""
		Read-only property to return the date of the build.

		:return: Date of the build as :class:`date`.
		"""
		return self._date

	@readonly
	def time(self) -> time:
		"""
		Read-only property to return the time of the build.

		:return: Time of the build as :class:`date`.
		"""
		return self._time

	@readonly
	def compiler(self) -> Compiler:
		return self._compiler


@export
class Platforms(Enum):
	"""An enumeration of platforms supported by pyTooling."""
	Workstation = auto()    #: A local work station, server, PC or laptop.
	AppVeyor =    auto()    #: A CI service operated by `AppVeyor <https://www.appveyor.com/>`__.
	GitHub =      auto()    #: A CI service offered by `GitHub <https://github.com/>`__ called GitHub Actions.
	GitLab =      auto()    #: A CI service offered by `GitLab <https://about.gitlab.com/>`__.
	Travis =      auto()    #: A CI service operated by `Travis <https://www.travis-ci.com/>`__.


@export
class Platform(SelfDescriptive):
	""".. todo:: Platform needs documentation"""

	_ciService: str
	_public:  ClassVar[Tuple[str, ...]] = ('ci_service', )

	def __init__(self, ciService: str) -> None:
		self._ciService = ciService

	@readonly
	def ci_service(self) -> str:
		return self._ciService


@export
class BaseService(metaclass=ExtendedType):
	"""Base-class to collect platform and environment information from e.g. environment variables."""

	# @abstractmethod
	def GetPlatform(self) -> Platform:  # type: ignore[empty-body]
		"""
		.. todo::
		   getPlatform needs documentation

		"""


@export
class GitShowCommand(Enum):
	CommitDateTime =       auto()
	CommitAuthorName =     auto()
	CommitAuthorEmail =    auto()
	CommitCommitterName =  auto()
	CommitCommitterEmail = auto()
	CommitHash =           auto()
	CommitComment =        auto()


@export
class GitHelperMixin(metaclass=ExtendedType, mixin=True):
	__GIT_SHOW_COMMAND_TO_FORMAT_LOOKUP = {
		GitShowCommand.CommitHash:           "%H",
		GitShowCommand.CommitDateTime:       "%ct",
		GitShowCommand.CommitAuthorName:     "%an",
		GitShowCommand.CommitAuthorEmail:    "%ae",
		GitShowCommand.CommitCommitterName:  "%cn",
		GitShowCommand.CommitCommitterEmail: "%ce",
		GitShowCommand.CommitComment:        "%B",
	}

	def ExecuteGitShow(self, cmd: GitShowCommand, ref: str = "HEAD") -> str:
		format = f"--format='{self.__GIT_SHOW_COMMAND_TO_FORMAT_LOOKUP[cmd]}'"

		command = "git"
		arguments = ("show", "-s", format, ref)
		try:
			completed = subprocess_run((command, *arguments), stdout=PIPE, stderr=PIPE)
		except CalledProcessError as ex:
			raise ToolException(f"{command} {' '.join(arguments)}", str(ex))

		if completed.returncode == 0:
			comment = completed.stdout.decode("utf-8")
			return comment[1:-2]
		else:
			message = completed.stderr.decode("utf-8")
			raise ToolException(f"{command} {' '.join(arguments)}", message)


@export
class Versioning(ILineTerminal, GitHelperMixin):
	_variables: Dict[str, Any]
	_platform:  Platforms = Platforms.Workstation
	_service:   BaseService

	def __init__(self, terminal: ILineTerminal) -> None:
		super().__init__(terminal)

		self._variables = {}

		if "APPVEYOR" in environ:
			self._platform = Platforms.AppVeyor
		elif "GITHUB_ACTIONS" in environ:
			self._platform = Platforms.GitHub
		elif "GITLAB_CI" in environ:
			self._platform = Platforms.GitLab
		elif "TRAVIS" in environ:
			self._platform = Platforms.Travis
		else:
			self._platform = Platforms.Workstation

		self.WriteDebug(f"Detected platform: {self._platform.name}")

	@readonly
	def Variables(self) -> Dict[str, Any]:
		return self._variables

	@readonly
	def Platform(self) -> Platforms:
		return self._platform

	def LoadDataFromConfiguration(self, config: Configuration) -> None:
		"""Preload versioning information from configuration file."""

		self._variables["project"] = self.GetProject(config.project)
		self._variables["build"]   = self.GetBuild(config.build)
		self._variables["version"] = self.GetVersion(config.project)

	def CollectData(self) -> None:
		"""Collect versioning information from environment including CI services (if available)."""

		from pyVersioning.AppVeyor      import AppVeyor
		from pyVersioning.CIService     import WorkStation
		from pyVersioning.GitLab        import GitLab
		from pyVersioning.GitHub        import GitHub
		from pyVersioning.Travis        import Travis

		if self._platform is Platforms.AppVeyor:
			self._service                = AppVeyor()
			self._variables["appveyor"]  = self._service.GetEnvironment()
		elif self._platform is Platforms.GitHub:
			self._service                = GitHub()
			self._variables["github"]    = self._service.GetEnvironment()
		elif self._platform is Platforms.GitLab:
			self._service                = GitLab()
			self._variables["gitlab"]    = self._service.GetEnvironment()
		elif self._platform is Platforms.Travis:
			self._service                = Travis()
			self._variables["travis"]    = self._service.GetEnvironment()
		else:
			self._service                = WorkStation()

		self._variables["tool"]     = Tool("pyVersioning", SemanticVersion.Parse(__version__))
		self._variables["git"]      = self.GetGitInformation()
		self._variables["env"]      = self.GetEnvironment()
		self._variables["platform"] = self._service.GetPlatform()

		self.CalculateData()

	def CalculateData(self) -> None:
		if self._variables["git"].tag != "":
			pass

	def GetVersion(self, config: Project) -> SemanticVersion:
		if config.version is not None:
			return config.version
		else:
			return SemanticVersion.Parse("0.0.0")

	def GetGitInformation(self) -> Git:
		return Git(
			commit=self.GetLastCommit(),
			tag=self.GetGitTag(),
			branch=self.GetGitLocalBranch(),
			repository=self.GetGitRemoteURL()
		)

	def GetLastCommit(self) -> Commit:
		dt = self.GetCommitDate()

		return Commit(
			hash=self.GetGitHash(),
			date=dt.date(),
			time=dt.time(),
			author=self.GetCommitAuthor(),
			committer=self.GetCommitCommitter(),
			comment=self.GetCommitComment()
		)

	def GetGitHash(self) -> str:
		if self._platform is not Platforms.Workstation:
			return self._service.GetGitHash()

		return self.ExecuteGitShow(GitShowCommand.CommitHash)

	def GetCommitDate(self) -> datetime:
		if self._platform is not Platforms.Workstation:
			return self._service.GetCommitDate()

		datetimeString = self.ExecuteGitShow(GitShowCommand.CommitDateTime)
		return datetime.fromtimestamp(int(datetimeString))

	def GetCommitAuthor(self) -> Person:
		return Person(
			name=self.GetCommitAuthorName(),
			email=self.GetCommitAuthorEmail()
		)

	def GetCommitAuthorName(self) -> str:
		return self.ExecuteGitShow(GitShowCommand.CommitAuthorName)

	def GetCommitAuthorEmail(self) -> str:
		return self.ExecuteGitShow(GitShowCommand.CommitAuthorEmail)

	def GetCommitCommitter(self) -> Person:
		return Person(
			name=self.GetCommitCommitterName(),
			email=self.GetCommitCommitterEmail()
		)

	def GetCommitCommitterName(self) -> str:
		return self.ExecuteGitShow(GitShowCommand.CommitCommitterName)

	def GetCommitCommitterEmail(self) -> str:
		return self.ExecuteGitShow(GitShowCommand.CommitCommitterEmail)

	def GetCommitComment(self) -> str:
		return self.ExecuteGitShow(GitShowCommand.CommitComment)

	def GetGitLocalBranch(self) -> str:
		if self._platform is not Platforms.Workstation:
			return self._service.GetGitBranch()

		command = "git"
		arguments = ("branch", "--show-current")
		try:
			completed = subprocess_run((command, *arguments), stdout=PIPE, stderr=PIPE)
		except CalledProcessError:
			return ""

		if completed.returncode == 0:
			return completed.stdout.decode("utf-8").split("\n")[0]
		else:
			message = completed.stderr.decode("utf-8")
			self.WriteFatal(f"Message from '{command} {' '.join(arguments)}': {message}")

	def GetGitRemoteBranch(self, localBranch: Nullable[str] = None) -> str:
		if self._platform is not Platforms.Workstation:
			return self._service.GetGitBranch()

		if localBranch is None:
			localBranch = self.GetGitLocalBranch()

		command = "git"
		arguments = ("config", f"branch.{localBranch}.merge")
		try:
			completed = subprocess_run((command, *arguments), stdout=PIPE, stderr=PIPE)
		except CalledProcessError:
			raise Exception()  # XXX: needs error message

		if completed.returncode == 0:
			return completed.stdout.decode("utf-8").split("\n")[0]
		else:
			message = completed.stderr.decode("utf-8")
			self.WriteFatal(f"Message from '{command} {' '.join(arguments)}': {message}")
			raise Exception()  # XXX: needs error message

	def GetGitRemote(self, localBranch: Nullable[str] = None) -> str:
		if localBranch is None:
			localBranch = self.GetGitLocalBranch()

		command = "git"
		arguments = ("config", f"branch.{localBranch}.remote")
		try:
			completed = subprocess_run((command, *arguments), stdout=PIPE, stderr=PIPE)
		except CalledProcessError:
			raise Exception()  # XXX: needs error message

		if completed.returncode == 0:
			return completed.stdout.decode("utf-8").split("\n")[0]
		elif completed.returncode == 1:
			self.WriteWarning(f"Branch '{localBranch}' is not pushed to a remote.")
			return f"(local) {localBranch}"
		else:
			message = completed.stderr.decode("utf-8")
			self.WriteFatal(f"Message from '{command} {' '.join(arguments)}': {message}")
			raise Exception()  # XXX: needs error message

	def GetGitTag(self) -> str:
		if self._platform is not Platforms.Workstation:
			return self._service.GetGitTag()

		command = "git"
		arguments = ("tag", "--points-at", "HEAD")
		try:
			completed = subprocess_run((command, *arguments), stdout=PIPE, stderr=PIPE)
		except CalledProcessError:
			raise Exception()  # XXX: needs error message

		if completed.returncode == 0:
			return completed.stdout.decode("utf-8").split("\n")[0]
		else:
			message = completed.stderr.decode("utf-8")
			self.WriteFatal(f"Message from '{command} {' '.join(arguments)}': {message}")
			raise Exception()  # XXX: needs error message

	def GetGitRemoteURL(self, remote: Nullable[str] = None) -> str:
		if self._platform is not Platforms.Workstation:
			return self._service.GetGitRepository()

		if remote is None:
			remote = self.GetGitRemote()

		command = "git"
		arguments = ("config", f"remote.{remote}.url")
		try:
			completed = subprocess_run((command, *arguments), stdout=PIPE, stderr=PIPE)
		except CalledProcessError:
			raise Exception()  # XXX: needs error message

		if completed.returncode == 0:
			return completed.stdout.decode("utf-8").split("\n")[0]
		else:
			message = completed.stderr.decode("utf-8")
			self.WriteFatal(f"Message from '{command} {' '.join(arguments)}': {message}")
			raise Exception()  # XXX: needs error message

	# 		self.WriteFatal(f"Message from '{command}': {message}")

	def GetProject(self, config: Project) -> Project:
		return Project(
			name=config.name,
			version=config.version,
			variant=config.variant
		)

	def GetBuild(self, config: Build) -> Build:
		dt = datetime.now()
		return Build(
			date=dt.date(),
			time=dt.time(),
			compiler=self.GetCompiler(config.compiler)
		)

	def GetCompiler(self, config: Compiler) -> Compiler:
		return Compiler(
			name=config.name,
			version=SemanticVersion.Parse(config.version),
			configuration=config.configuration,
			options=config.options
		)

	def GetEnvironment(self) -> Any:
		env = {}
		for key, value in environ.items():
			if not key.isidentifier():
				self.WriteWarning(f"Skipping environment variable '{key}', because it's not a valid Python identifier.")
				continue
			key = key.replace("(", "_")
			key = key.replace(")", "_")
			key = key.replace(" ", "_")
			env[key] = value

		def func(s) -> Generator[Tuple[str, Any], None, None]:
			for e in env.keys():
				yield e, s.__getattribute__(e)

		Environment = make_dataclass(
			"Environment",
			[(name, str) for name in env.keys()],
#			bases=(SelfDescriptive,),
			namespace={
				"as_dict":       lambda self: env,
				"Keys":          lambda self: env.keys(),
				"KeyValuePairs": lambda self: func(self)
			},
			repr=True
		)

		return Environment(**env)

	def FillOutTemplate(self, template: str, **kwargs) -> str:
		# apply variables
		try:
			return template.format(**self._variables, **kwargs)
		except AttributeError as ex:
			self.WriteFatal(f"Syntax error in template. Accessing field '{ex.name}' of '{ex.obj.__class__.__name__}'.")