", year)
)
except FileNotFoundError as e:
raise e
else:
raise ValueError
def _remove_outdated_lines(
content: str, cleanup_regexes: list[re.Pattern]
) -> Optional[str]:
"""Remove lines that contain outdated copyright header ..."""
changed = False
splitted_lines = content.splitlines()
i = 0
for line in splitted_lines[:20]:
if i > 3 and re.match(r"^(([#*]|//) ?$)", line):
splitted_lines.pop(i)
continue
for regex in cleanup_regexes:
if regex.match(line):
changed = True
splitted_lines.pop(i)
i = i - 1
break
i = i + 1
if changed:
new_content = "\n".join(splitted_lines) + "\n"
return new_content
return None
def update_file(
file: Path,
year: str,
license_id: str,
company: str,
*,
cleanup: bool = False,
single_year: bool = False,
) -> None:
"""Function to update the header of the given file
Checks if header exists. If not it adds an header to that file, otherwise it
checks if year is up to date
"""
copyright_regex = _compile_copyright_regex()
cleanup_regexes = _compile_outdated_regex() if cleanup else None
try:
with file.open("r+") as fp:
found = False
i = 10 # assume that copyright is in the first 10 lines
while not found and i > 0:
line = fp.readline()
if line == "":
i = 0
continue
found, copyright_match = _find_copyright(
line=line, copyright_regex=copyright_regex
)
i = i - 1
# header not found, add header
if i == 0 and not found:
try:
header = _add_header(
file.suffix,
license_id,
company,
year,
)
if header:
fp.seek(0) # back to beginning of file
rest_of_file = fp.read()
fp.seek(0)
fp.write(header + "\n" + rest_of_file)
print(f"{file}: Added license header.")
return
except ValueError:
print(
f"{file}: No license header for the"
f" format {file.suffix} found.",
)
except FileNotFoundError:
print(
f"{file}: License file for {license_id} "
"is not existing."
)
return
# replace found header and write it to file
if copyright_match:
# use different target license formats depending on provided single_year argument
if single_year:
copyright_term = (
f"SPDX-FileCopyrightText: "
f"{copyright_match.creation_year} "
f"{company}"
)
else:
copyright_term = (
f"SPDX-FileCopyrightText: "
f"{copyright_match.creation_year}"
f"-{year} {company}"
)
with_multi_year = (
copyright_match.creation_year
and copyright_match.modification_year
)
with_single_year_outdated = (
not copyright_match.modification_year
and int(copyright_match.creation_year) < int(year)
)
with_multi_year_outdated = False
if with_multi_year:
# assert to silence mypy
assert isinstance(copyright_match.modification_year, str)
with_multi_year_outdated = int(
copyright_match.modification_year
) < int(year)
if single_year and with_multi_year:
_substitute_license_text(
fp, line, copyright_regex, copyright_term
)
print(
f"{file}: Changed License Header Copyright Year format to single year "
f"{copyright_match.creation_year}-{year} -> "
f"{copyright_match.creation_year}"
)
elif not single_year and (
with_multi_year_outdated or with_single_year_outdated
):
_substitute_license_text(
fp, line, copyright_regex, copyright_term
)
print(
f"{file}: Changed License Header Copyright Year "
f"{copyright_match.modification_year} -> "
f"{year}"
)
else:
print(f"{file}: License Header is ok.")
except FileNotFoundError as e:
print(f"{file}: File is not existing.")
raise e
except UnicodeDecodeError as e:
print(f"{file}: Ignoring binary file.")
raise e
# old header existing - cleanup?
if cleanup_regexes:
old_content = file.read_text(encoding="utf-8")
new_content = _remove_outdated_lines(
content=old_content, cleanup_regexes=cleanup_regexes
)
if new_content:
file.write_text(new_content, encoding="utf-8")
print(f"{file}: Cleaned up!")
def _substitute_license_text(
fp: io.TextIOWrapper,
line: str,
copyright_regex: re.Pattern,
copyright_term: str,
) -> None:
"""Substitute the old license text in file fp, starting on provided line, with the new one provided in copyright_term"""
new_line = re.sub(copyright_regex, copyright_term, line)
fp_write = fp.tell() - len(line) # save position to insert
rest_of_file = fp.read()
fp.seek(fp_write)
fp.write(new_line)
fp.write(rest_of_file)
# in some cases we replace "YYYY - YYYY" with "YYYY-YYYY"
# resulting in 2 characters left at the end of the file
# so we truncate the file, just in case!
fp.truncate()
def _get_exclude_list(
exclude_file: Path, directories: list[Path]
) -> list[Path]:
"""Tries to get the list of excluded files / directories.
If a file is given, it will be used. Otherwise it will be searched
in the executed root path.
The ignore file should only contain relative paths like *.py,
not absolute as **/*.py
"""
if exclude_file is None:
exclude_file = Path(".pontos-header-ignore")
if not exclude_file.is_file():
return []
exclude_lines = exclude_file.read_text(encoding="utf-8").splitlines()
expanded_globs = [
directory.rglob(line.strip())
for directory in directories
for line in exclude_lines
if line
]
exclude_list = []
for glob_paths in expanded_globs:
for path in glob_paths:
if path.is_dir():
for efile in path.rglob("*"):
exclude_list.append(efile.absolute())
else:
exclude_list.append(path.absolute())
return exclude_list
@cache
def _compile_outdated_regex() -> list[re.Pattern]:
"""prepare regex patterns to remove old copyright lines"""
return [re.compile(rf"^(([#*]|//) ?)?{line}") for line in OLD_LINES]
@cache
def _compile_copyright_regex() -> re.Pattern:
"""prepare the copyright regex"""
c_str = r"(SPDX-FileCopyrightText:|[Cc]opyright)"
d_str = r"(19[0-9]{2}|20[0-9]{2})"
return re.compile(rf"{c_str}.*? {d_str}?-? ?{d_str}? (.+)")
def main(args: Optional[Sequence[str]] = None) -> None:
parsed_args = parse_args(args)
exclude_list = []
year: str = parsed_args.year
license_id: str = parsed_args.license_id
company: str = parsed_args.company
changed: bool = parsed_args.changed
quiet: bool = parsed_args.quiet
cleanup: bool = parsed_args.cleanup
single_year: bool = parsed_args.single_year
if quiet:
term: Union[NullTerminal, RichTerminal] = NullTerminal()
else:
term = RichTerminal()
term.bold_info("pontos-update-header")
if parsed_args.directories:
if isinstance(parsed_args.directories, list):
directories = [
Path(directory) for directory in parsed_args.directories
]
else:
directories = [Path(parsed_args.directories)]
# get file paths to exclude
exclude_list = _get_exclude_list(parsed_args.exclude_file, directories)
# get files to update
files = [
Path(file)
for directory in directories
for file in directory.rglob("*")
if file.is_file()
]
elif parsed_args.files:
if isinstance(parsed_args.files, list):
files = [Path(name) for name in parsed_args.files]
else:
files = [Path(parsed_args.files)]
else:
# should never happen
term.error("Specify files to update!")
sys.exit(1)
for file in files:
try:
if file.absolute() in exclude_list:
term.warning(f"{file}: Ignoring file from exclusion list.")
else:
if changed:
try:
year = _get_modified_year(file)
except PontosError:
term.warning(
f"{file}: Could not get date of last modification"
f" via git, using {year} instead."
)
update_file(
file,
year,
license_id,
company,
cleanup=cleanup,
single_year=single_year,
)
except (FileNotFoundError, UnicodeDecodeError, ValueError):
continue
if __name__ == "__main__":
main()
pontos-25.3.2/pontos/version/ 0000775 0000000 0000000 00000000000 14762555663 0016157 5 ustar 00root root 0000000 0000000 pontos-25.3.2/pontos/version/__init__.py 0000664 0000000 0000000 00000000712 14762555663 0020270 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from .__version__ import __version__
from ._calculator import VersionCalculator
from ._errors import VersionError
from ._main import main
from ._version import ParseVersionFuncType, Version, VersionUpdate
__all__ = (
"__version__",
"VersionError",
"ParseVersionFuncType",
"Version",
"VersionCalculator",
"VersionUpdate",
"main",
)
pontos-25.3.2/pontos/version/__main__.py 0000664 0000000 0000000 00000000301 14762555663 0020243 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=invalid-name
from ._main import main
if __name__ == "__main__":
main()
pontos-25.3.2/pontos/version/__version__.py 0000664 0000000 0000000 00000000147 14762555663 0021014 0 ustar 00root root 0000000 0000000 # pylint: disable=invalid-name
# THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
__version__ = "25.3.2"
pontos-25.3.2/pontos/version/_calculator.py 0000664 0000000 0000000 00000020214 14762555663 0021020 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from abc import ABC, abstractmethod
from datetime import datetime
from typing import Type
from ._errors import VersionError
from ._version import Version
class VersionCalculator(ABC):
"""
An abstract base class for calculating a next version from a version
"""
version_cls: Type[Version]
@classmethod
def version_from_string(cls, version: str) -> Version:
"""
Create a version from a version string
Args:
version: Version string to parse
Raises:
VersionError: If the version string is invalid.
Returns:
A new version instance
"""
return cls.version_cls.from_string(version)
@classmethod
def next_calendar_version(cls, current_version: Version) -> Version:
"""
Find the correct next calendar version by checking latest version and
the today's date
Raises:
VersionError: If version is invalid.
"""
today = datetime.today()
current_year_short = today.year % 100
if current_version.major > 2000:
# version expected to be YYYY.MM.P
current_year = today.year
else:
# version expected to be YY.MM.P
current_year = current_year_short
if current_version.major < current_year or (
current_version.major == current_year
and current_version.minor < today.month
):
return cls.version_from_string(f"{current_year}.{today.month}.0")
if (
current_version.major == current_year
and current_version.minor == today.month
):
if current_version.dev is None:
release_version = cls.version_from_string(
f"{current_year}.{today.month}."
f"{current_version.patch + 1}"
)
else:
release_version = cls.version_from_string(
f"{current_year}.{today.month}." f"{current_version.patch}"
)
return release_version
else:
raise VersionError(
f"'{current_version}' is higher than "
f"'{current_year}.{today.month}'."
)
@classmethod
def next_major_version(cls, current_version: Version) -> Version:
"""
Get the next major version from a valid version
Examples:
"1.2.3" will return "2.0.0"
"1.2.3.dev1" will return "1.2.3"
"1.2.3-alpha1" will return "1.2.3"
"1.0.0" will return "2.0.0"
"1.0.0-a1" will return "1.0.0"
"1.0.0.dev1" will return "1.0.0"
"0.5.0-a1" will return "1.0.0"
"0.5.0.dev1" will return "1.0.0"
"""
if (
(current_version.is_pre_release or current_version.is_dev_release)
and current_version.patch == 0
and current_version.minor == 0
):
return cls.version_from_string(
f"{current_version.major}.{current_version.minor}."
f"{current_version.patch}"
)
return cls.version_from_string(f"{current_version.major + 1}.0.0")
@classmethod
def next_minor_version(cls, current_version: Version) -> Version:
"""
Get the next minor version from a valid version
Examples:
"1.2.3" will return "1.3.0"
"1.2.3.dev1" will return "1.3.0"
"1.2.3-alpha1" will return "1.3.0"
"1.0.0" will return "1.1.0"
"1.0.0-a1" will return "1.0.0"
"1.0.0.dev1" will return "1.0.0"
"0.5.0-a1" will return "0.5.0"
"0.5.0.dev1" will return "0.5.0"
"""
if (
current_version.is_pre_release or current_version.is_dev_release
) and current_version.patch == 0:
return cls.version_from_string(
f"{current_version.major}.{current_version.minor}."
f"{current_version.patch}"
)
return cls.version_from_string(
f"{current_version.major}.{current_version.minor + 1}.0"
)
@classmethod
def next_patch_version(cls, current_version: Version) -> Version:
"""
Get the next patch version from a valid version
Examples:
"1.2.3" will return "1.2.4"
"1.2.3.dev1" will return "1.2.3"
"1.2.3-dev1" will return "1.2.3"
"1.2.3+dev1" will return "1.2.4"
"1.2.3-alpha1" will return "1.2.3"
"1.0.0" will return "1.0.1"
"1.0.0-a1" will return "1.0.0"
"1.0.0.dev1" will return "1.0.0"
"0.5.0-a1" will return "0.5.0"
"0.5.0.dev1" will return "0.5.0"
"""
if not current_version:
raise VersionError("No current version passed.")
if current_version.is_dev_release or current_version.is_pre_release:
next_version = cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
)
else:
next_version = cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}"
)
return next_version
@staticmethod
@abstractmethod
def next_dev_version(current_version: Version) -> Version:
"""
Get the next development version from a valid version
Examples:
"1.2.3" will return "1.2.4-dev1"
"1.2.3.dev1" will return "1.2.3.dev2"
"1.2.3-dev1" will return "1.2.3-dev2"
"1.2.3+dev1" will return "1.2.4-dev1"
"1.2.3-alpha1" will return "1.2.3-alpha2-dev1"
"1.0.0" will return "1.0.1-dev1"
"1.0.0-a1" will return "1.0.0-a2-dev1"
"1.0.0.dev1" will return "1.0.0.dev2"
"0.5.0-a1" will return "0.5.0-a2-dev1"
"0.5.0.dev1" will return "0.5.0.dev2"
"""
@staticmethod
@abstractmethod
def next_alpha_version(current_version: Version) -> Version:
"""
Get the next alpha version from a valid version
Examples:
"1.2.3" will return "1.2.4-alpha1"
"1.2.3.dev1" will return "1.2.3-alpha1"
"1.2.3-dev1" will return "1.2.3-alpha1"
"1.2.3+dev1" will return "1.2.4-alpha1"
"1.2.3-alpha1" will return "1.2.3-alpha2"
"1.0.0" will return "1.0.1-alpha1"
"1.0.0-a1" will return "1.0.1-alpha1"
"1.0.0.dev1" will return "1.0.0-alpha1"
"0.5.0-a1" will return "0.5.1-alpha1"
"0.5.0.dev1" will return "0.5.0-alpha1"
"""
@staticmethod
@abstractmethod
def next_beta_version(current_version: Version) -> Version:
"""
Get the next beta version from a valid version
Examples:
"1.2.3" will return "1.2.4-beta1"
"1.2.3.dev1" will return "1.2.3-beta1"
"1.2.3-dev1" will return "1.2.3-beta1"
"1.2.3+dev1" will return "1.2.4-beta1"
"1.2.3-alpha1" will return "1.2.3-beta1"
"1.0.0" will return "1.0.1-beta1"
"1.0.0-a1" will return "1.0.1-beta1"
"1.0.0.dev1" will return "1.0.0-beta1"
"0.5.0-a1" will return "0.5.1-beta1"
"0.5.0.dev1" will return "0.5.0-beta1"
"""
@staticmethod
@abstractmethod
def next_release_candidate_version(current_version: Version) -> Version:
"""
Get the next release candidate version from a valid version
Examples:
"1.2.3" will return "1.2.4-rc1"
"1.2.3.dev1" will return "1.2.3-rc1"
"1.2.3-dev1" will return "1.2.3-rc1"
"1.2.3+dev1" will return "1.2.4-rc1"
"1.2.3-alpha1" will return "1.2.3-rc1"
"1.0.0" will return "1.0.1-rc1"
"1.0.0-a1" will return "1.0.1-rc1"
"1.0.0.dev1" will return "1.0.0-rc1"
"0.5.0-a1" will return "0.5.1-rc1"
"0.5.0.dev1" will return "0.5.0-rc"
"""
pontos-25.3.2/pontos/version/_errors.py 0000664 0000000 0000000 00000000507 14762555663 0020206 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from pontos.errors import PontosError
class VersionError(PontosError):
"""
Some error has occurred during version handling
"""
class ProjectError(PontosError):
"""
An error has occured while gathering a project
"""
pontos-25.3.2/pontos/version/_main.py 0000664 0000000 0000000 00000005730 14762555663 0017621 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import sys
from enum import IntEnum, auto
from typing import List, NoReturn, Optional
from pontos.errors import PontosError
from ._parser import parse_args
from .project import Project
from .schemes import VersioningScheme
class VersionExitCode(IntEnum):
SUCCESS = 0
NO_PROJECT = auto()
UPDATE_ERROR = auto()
CURRENT_VERSION_ERROR = auto()
VERIFY_ERROR = auto()
NEXT_VERSION_ERROR = auto()
def main(args: Optional[List[str]] = None) -> NoReturn:
parsed_args = parse_args(args)
try:
project = Project(parsed_args.versioning_scheme)
except PontosError:
print("No project found.", file=sys.stderr)
sys.exit(VersionExitCode.NO_PROJECT)
if parsed_args.command == "update":
try:
update = project.update_version(
parsed_args.version, force=parsed_args.force
)
except PontosError as e:
print(str(e), file=sys.stderr)
sys.exit(VersionExitCode.UPDATE_ERROR)
if update.new == update.previous:
print("Version is already up-to-date.")
else:
print(f"Updated version from {update.previous} to {update.new}.")
elif parsed_args.command == "show":
try:
print(str(project.get_current_version()))
except PontosError as e:
print(str(e), file=sys.stderr)
sys.exit(VersionExitCode.CURRENT_VERSION_ERROR)
elif parsed_args.command == "verify":
try:
project.verify_version(parsed_args.version)
except PontosError as e:
print(str(e), file=sys.stderr)
sys.exit(VersionExitCode.VERIFY_ERROR)
elif parsed_args.command == "next":
scheme: VersioningScheme = parsed_args.versioning_scheme
calculator = scheme.calculator()
try:
current_version = project.get_current_version()
except PontosError as e:
print(str(e), file=sys.stderr)
sys.exit(VersionExitCode.CURRENT_VERSION_ERROR)
if parsed_args.type == "dev":
print(calculator.next_dev_version(current_version))
elif parsed_args.type == "calendar":
print(calculator.next_calendar_version(current_version))
elif parsed_args.type == "alpha":
print(calculator.next_alpha_version(current_version))
elif parsed_args.type == "beta":
print(calculator.next_beta_version(current_version))
elif parsed_args.type == "rc":
print(calculator.next_release_candidate_version(current_version))
elif parsed_args.type == "patch":
print(calculator.next_patch_version(current_version))
elif parsed_args.type == "minor":
print(calculator.next_minor_version(current_version))
elif parsed_args.type == "major":
print(calculator.next_major_version(current_version))
sys.exit(VersionExitCode.SUCCESS)
pontos-25.3.2/pontos/version/_parser.py 0000664 0000000 0000000 00000007316 14762555663 0020173 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023-2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import argparse
from typing import Optional, Sequence
import shtab
from pontos.errors import PontosError
from pontos.version.schemes import (
VERSIONING_SCHEMES,
VersioningScheme,
versioning_scheme_argument_type,
)
def initialize_default_parser() -> argparse.ArgumentParser:
"""
Returns a default argument parser containing:
- verify
- show
- update
"""
parser = argparse.ArgumentParser(
description="Version handling utilities.",
prog="version",
)
shtab.add_argument_to(parser)
subparsers = parser.add_subparsers(
title="subcommands",
description="Valid subcommands",
help="Additional help",
dest="command",
required=True,
)
verify_parser = subparsers.add_parser(
"verify", help="Verify version in the current project"
)
verify_parser.add_argument(
"version",
help="Version string to compare",
nargs="?",
)
verify_parser.add_argument(
"--versioning-scheme",
help="Versioning scheme to use for parsing and handling version "
f"information. Choices are {', '.join(VERSIONING_SCHEMES.keys())}. "
"Default: %(default)s",
default="pep440",
type=versioning_scheme_argument_type,
)
show_parser = subparsers.add_parser(
"show", help="Show version information of the current project"
)
show_parser.add_argument(
"--versioning-scheme",
help="Versioning scheme to use for parsing and handling version "
f"information. Choices are {', '.join(VERSIONING_SCHEMES.keys())}. "
"Default: %(default)s",
default="pep440",
type=versioning_scheme_argument_type,
)
update_parser = subparsers.add_parser(
"update", help="Update version in the current project"
)
update_parser.add_argument(
"version",
help="Version string to use",
)
update_parser.add_argument(
"--versioning-scheme",
help="Versioning scheme to use for parsing and handling version "
f"information. Choices are {', '.join(VERSIONING_SCHEMES.keys())}. "
"Default: %(default)s",
default="pep440",
type=versioning_scheme_argument_type,
)
update_parser.add_argument(
"--force",
help="Don't check if version is already set. "
"This will override existing version information!",
action="store_true",
)
next_parser = subparsers.add_parser(
"next", help="Calculate the next release version"
)
next_parser.add_argument(
"type",
help="Next version type",
choices=[
"dev",
"calendar",
"alpha",
"beta",
"rc",
"patch",
"minor",
"major",
],
)
next_parser.add_argument(
"--versioning-scheme",
help="Versioning scheme to use for parsing and handling version "
f"information. Choices are {', '.join(VERSIONING_SCHEMES.keys())}. "
"Default: %(default)s",
default="pep440",
type=versioning_scheme_argument_type,
)
return parser
def parse_args(args: Optional[Sequence[str]] = None) -> argparse.Namespace:
parser = initialize_default_parser()
parsed_args = parser.parse_args(args)
scheme: VersioningScheme = parsed_args.versioning_scheme
version = getattr(parsed_args, "version", None)
if version and version != "current":
try:
parsed_args.version = scheme.parse_version(parsed_args.version)
except PontosError as e:
parser.error(str(e))
return parsed_args
pontos-25.3.2/pontos/version/_version.py 0000664 0000000 0000000 00000012121 14762555663 0020352 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from abc import ABC, abstractmethod
from dataclasses import dataclass, field
from pathlib import Path
from typing import Any, Callable, Optional
class Version(ABC):
"""
An abstract base class for version information
A version implementation must consider the following constraints:
* Version strings containing `-dev`, and `.dev` are considered development
versions.
* Version strings containing `+dev` are not considered as development
versions.
* Development versions are are also pre releases. The following version
string is a development version and a pre release: `1.2.3-alpha1-dev1`
* A version must return a pre for development versions for version strings
containing a pre release version like `1.2.3-alpha1-dev1`
* A development version has no local part
* Alpha, Beta, Release Candidate and Development versions are pre releases
* Alpha, Beta and Release Candidate versions pre must return the following
names for the first value in the tuple: `alpha`, `beta`, `rc` and `dev`
"""
def __init__(self, original_version: str) -> None:
self._parsed_version = original_version
@property
def parsed_version(self) -> str:
"""
Original version string from which the version has been parsed
"""
return self._parsed_version
@property
@abstractmethod
def major(self) -> int:
"""The first item of the version or ``0`` if unavailable."""
@property
@abstractmethod
def minor(self) -> int:
"""The second item of the version or ``0`` if unavailable."""
@property
@abstractmethod
def patch(self) -> int:
"""The third item of the version or ``0`` if unavailable."""
@property
@abstractmethod
def pre(self) -> Optional[tuple[str, int]]:
"""The pre-release segment of the version."""
@property
@abstractmethod
def dev(self) -> Optional[int]:
"""The development number of the version."""
@property
@abstractmethod
def local(self) -> Optional[tuple[str, int]]:
"""The local version segment of the version."""
@property
@abstractmethod
def is_pre_release(self) -> bool:
"""
Whether this version is a pre-release (alpha, beta, release candidate).
"""
@property
@abstractmethod
def is_dev_release(self) -> bool:
"""Whether this version is a development release."""
@property
@abstractmethod
def is_alpha_release(self) -> bool:
"""Whether this version is an alpha release."""
@property
@abstractmethod
def is_beta_release(self) -> bool:
"""Whether this version is a beta release."""
@property
@abstractmethod
def is_release_candidate(self) -> bool:
"""Whether this version is a release candidate."""
@classmethod
@abstractmethod
def from_string(cls, version: str) -> "Version":
"""
Create a version from a version string
Args:
version: Version string to parse
Raises:
VersionError: If the version string is invalid.
Returns:
A new version instance
"""
@classmethod
@abstractmethod
def from_version(cls, version: "Version") -> "Version":
"""
Convert a version (if necessary)
This method can be used to convert version instances from different
versioning schemes.
"""
@abstractmethod
def __eq__(self, other: Any) -> bool:
pass
@abstractmethod
def __ne__(self, other: Any) -> bool:
pass
@abstractmethod
def __gt__(self, other: Any) -> bool:
pass
@abstractmethod
def __ge__(self, other: Any) -> bool:
pass
@abstractmethod
def __lt__(self, other: Any) -> bool:
pass
@abstractmethod
def __le__(self, other: Any) -> bool:
pass
@abstractmethod
def __str__(self) -> str:
"""A string representation of the version"""
def __repr__(self) -> str:
"""A representation of the Version"""
return f"<{self.__class__.__name__}('{self}')>"
ParseVersionFuncType = Callable[[str], Version]
@dataclass
class VersionUpdate:
"""
Represents a version update from a previous version to a new version.
If previous and new are equal the version was not updated and changed_files
should be empty.
If there is no previous version for example in an initial release previous
should be None.
Example:
.. code-block:: python
from pathlib import Path
from python.version import Version, VersionUpdate
update = VersionUpdate(
previous=Version("1.2.3"),
new=Version("2.0.0"),
changed_files=[Path("package.json"), Path("version.js")],
)
"""
previous: Optional[Version]
new: Version
changed_files: list[Path] = field(default_factory=list)
@property
def is_update(self) -> bool:
return self.previous != self.new
pontos-25.3.2/pontos/version/commands/ 0000775 0000000 0000000 00000000000 14762555663 0017760 5 ustar 00root root 0000000 0000000 pontos-25.3.2/pontos/version/commands/__init__.py 0000664 0000000 0000000 00000001736 14762555663 0022100 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from typing import Iterable, Tuple, Type
from ._cargo import CargoVersionCommand
from ._cmake import CMakeVersionCommand
from ._command import VersionCommand
from ._go import GoVersionCommand
from ._java import JavaVersionCommand
from ._javascript import JavaScriptVersionCommand
from ._python import PythonVersionCommand
__all__ = (
"VersionCommand",
"CMakeVersionCommand",
"GoVersionCommand",
"JavaScriptVersionCommand",
"JavaVersionCommand",
"PythonVersionCommand",
"CargoVersionCommand",
"get_commands",
)
__COMMANDS: Tuple[Type[VersionCommand]] = ( # type: ignore[assignment]
CMakeVersionCommand,
GoVersionCommand,
JavaVersionCommand,
JavaScriptVersionCommand,
PythonVersionCommand,
CargoVersionCommand,
)
def get_commands() -> Iterable[Type[VersionCommand]]:
"""
Returns the available VersionCommands
"""
return __COMMANDS
pontos-25.3.2/pontos/version/commands/_cargo.py 0000664 0000000 0000000 00000005731 14762555663 0021572 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
from pathlib import Path
from typing import Iterator, Literal, Tuple, Union
import tomlkit
from .._errors import VersionError
from .._version import Version, VersionUpdate
from ._command import VersionCommand
class CargoVersionCommand(VersionCommand):
project_file_name = "Cargo.toml"
def __as_project_document(
self, origin: Path
) -> Iterator[Tuple[Path, tomlkit.TOMLDocument],]:
"""
Parse the given origin and yields a tuple of path to a
cargo toml that contains a version
If the origin is invalid toml than it will raise a VersionError.
"""
content = origin.read_text(encoding="utf-8")
content = tomlkit.parse(content)
package = content.get("package")
if package:
version = package.get("version")
if version:
yield (origin, content)
else:
workspace = content.get("workspace")
if workspace:
members = workspace.get("members")
for member in members:
yield from self.__as_project_document(
origin.parent / member / self.project_file_name
)
return None
def update_version(
self, new_version: Version, *, force: bool = False
) -> VersionUpdate:
try:
previous_version = self.get_current_version()
if not force and new_version == previous_version:
return VersionUpdate(previous=previous_version, new=new_version)
except VersionError:
# just ignore current version and override it
previous_version = None
changed_files = []
for project_path, project in self.__as_project_document(
self.project_file_path
):
project["package"]["version"] = str(new_version) # type: ignore[index] # noqa: E501
project_path.write_text(tomlkit.dumps(project))
changed_files.append(project_path)
return VersionUpdate(
previous=previous_version,
new=new_version,
changed_files=changed_files,
)
def get_current_version(self) -> Version:
(_, document) = next(self.__as_project_document(self.project_file_path))
current_version = self.versioning_scheme.parse_version(
document["package"]["version"] # type: ignore[index, arg-type]
)
return self.versioning_scheme.from_version(current_version)
def verify_version(
self, version: Union[Literal["current"], Version, None]
) -> None:
current_version = self.get_current_version()
if not version or version == "current":
return
if current_version != version:
raise VersionError(
f"Provided version {version} does not match the "
f"current version {current_version}."
)
pontos-25.3.2/pontos/version/commands/_cmake.py 0000664 0000000 0000000 00000020046 14762555663 0021553 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import re
from typing import Iterator, Literal, Optional, Tuple, Union
from .._errors import VersionError
from .._version import Version, VersionUpdate
from ..schemes import PEP440VersioningScheme
from ._command import VersionCommand
class CMakeVersionCommand(VersionCommand):
project_file_name = "CMakeLists.txt"
def update_version(
self, new_version: Version, *, force: bool = False
) -> VersionUpdate:
content = self.project_file_path.read_text(encoding="utf-8")
cmake_version_parser = CMakeVersionParser(content)
try:
previous_version = self.get_current_version()
if not force and new_version == previous_version:
return VersionUpdate(previous=previous_version, new=new_version)
except VersionError:
# just ignore current version and override it
previous_version = None
new_content = cmake_version_parser.update_version(new_version)
self.project_file_path.write_text(new_content, encoding="utf-8")
return VersionUpdate(
previous=previous_version,
new=new_version,
changed_files=[self.project_file_path],
)
def get_current_version(self) -> Version:
if not self.project_file_path.exists():
raise VersionError(f"{self.project_file_path} not found.")
content = self.project_file_path.read_text(encoding="utf-8")
current_version = CMakeVersionParser(content).get_current_version()
return self.versioning_scheme.from_version(current_version)
def verify_version(
self, version: Union[Literal["current"], Version, None]
) -> None:
current_version = self.get_current_version()
if not version or version == "current":
return
if current_version != version:
raise VersionError(
f"Provided version {version} does not match the "
f"current version {current_version}."
)
class CMakeVersionParser:
def __init__(self, cmake_content_lines: str):
line_no, current_version, pd_line_no, pd = self._find_version_in_cmake(
cmake_content_lines
)
self._cmake_content_lines = cmake_content_lines.split("\n")
self._version_line_number = line_no
self._current_version = current_version
self._project_dev_version_line_number = pd_line_no
self._project_dev_version = pd
# The tokenizer is used to parse and identify specific elements in CMake scripts.
# We are interested in identifying words that represent functions, variables, and their values.
# Specifically, we want to scan for the words 'project', 'version', 'set', 'PROJECT_DEV_VERSION',
# and their respective values, as we need to modify them.
__cmake_scanner = re.Scanner( # type: ignore
[
(
r"#.*",
lambda _, token: ("comment", token),
), # so that we can skip ahead
(
r'"[^"]*"',
lambda _, token: ("string", token),
), # so that we can verify if a value is a string value
(
r'"[0-9]+"',
lambda _, token: ("number", token),
), # so that we can verify if a value is numeric
(
r"\(",
lambda _, token: ("open_bracket", token),
), # so that we can identify function calls
(
r"\)",
lambda _, token: ("close_bracket", token),
), # so that we can identify end of function calls
(
r'[^ \t\r\n()#"]+',
lambda _, token: ("word", token),
), # so that we can identify words (identifiers)
(
r"\n",
lambda _, token: ("newline", token),
), # so that we can keep track of the position
(
r"\s+",
lambda _, token: ("special_printable", token),
), # so that we can keep track of the position
]
)
def get_current_version(self) -> Version:
return (
PEP440VersioningScheme.parse_version(
f"{self._current_version}.dev1"
)
if self.is_dev_version()
else PEP440VersioningScheme.parse_version(self._current_version)
)
def update_version(self, new_version: Version) -> str:
if new_version.is_dev_release:
new_version = PEP440VersioningScheme.parse_version(
f"{str(new_version.major)}."
f"{str(new_version.minor)}."
f"{str(new_version.patch)}"
)
develop = True
else:
develop = False
to_update = self._cmake_content_lines[self._version_line_number]
updated = to_update.replace(self._current_version, str(new_version))
self._cmake_content_lines[self._version_line_number] = updated
self._current_version = str(new_version)
if self._project_dev_version_line_number:
self._cmake_content_lines[self._project_dev_version_line_number] = (
self._cmake_content_lines[
self._project_dev_version_line_number
].replace(str(int(not develop)), str(int(develop)))
)
self._project_dev_version = str(int(develop))
return "\n".join(self._cmake_content_lines)
def _find_version_in_cmake(
self, content: str
) -> Tuple[int, str, Optional[int], Optional[str]]:
in_project = False
in_version = False
version_line_no: Optional[int] = None
version: Optional[str] = None
in_set = False
in_project_dev_version = False
project_dev_version_line_no: Optional[int] = None
project_dev_version: Optional[str] = None
for lineno, token_type, value in self._tokenize(content):
if token_type == "word" and value == "project":
in_project = True
elif in_project and token_type == "word" and value == "VERSION":
in_version = True
elif in_version and (
token_type == "word" or token_type == "string"
):
version_line_no = lineno
version = value
in_project = False
in_version = False
elif token_type == "word" and value == "set":
in_set = True
elif in_set and token_type == "close_bracket":
in_set = False
elif (
in_set
and token_type == "word"
and value == "PROJECT_DEV_VERSION"
):
in_project_dev_version = True
elif in_project_dev_version and (
token_type == "word" or token_type == "number"
):
project_dev_version_line_no = lineno
project_dev_version = value
in_project_dev_version = False
elif in_project and token_type == "close_bracket":
raise ValueError("unable to find cmake version in project.")
if not version or version_line_no is None:
raise ValueError("unable to find cmake version.")
return (
version_line_no,
version,
project_dev_version_line_no,
project_dev_version,
)
def is_dev_version(self) -> bool:
return (
int(self._project_dev_version) == 1
if self._project_dev_version
else False
)
def _tokenize( # type: ignore
self, content: str
) -> Iterator[Tuple[int, str, str]]:
toks, remainder = self.__cmake_scanner.scan(content)
if remainder != "":
print(f"WARNING: unrecognized cmake tokens: {remainder}")
line_num = 0
for tok_type, tok_contents in toks:
line_num += tok_contents.count("\n")
yield line_num, tok_type, tok_contents.strip()
pontos-25.3.2/pontos/version/commands/_command.py 0000664 0000000 0000000 00000003655 14762555663 0022120 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from abc import ABC, abstractmethod
from pathlib import Path
from typing import Literal, Union
from .._version import Version, VersionUpdate
from ..schemes import VersioningScheme
class VersionCommand(ABC):
"""Generic class usable to implement the
version commands for several programming languages"""
project_file_name: str
def __init__(
self, versioning_scheme: Union[VersioningScheme, type[VersioningScheme]]
) -> None:
self.project_file_path = Path.cwd() / self.project_file_name
self.versioning_scheme = versioning_scheme
@abstractmethod
def get_current_version(self) -> Version:
"""Get the current version of this project"""
@abstractmethod
def verify_version(
self, version: Union[Literal["current"], Version, None]
) -> None:
"""
Verify the current version of this project
Args:
version: Version to check against the current applied version of
this project. If version is None or "current" the command should
verify if all version information is consistent, for example if
the version information in several files is the same.
"""
@abstractmethod
def update_version(
self, new_version: Version, *, force: bool = False
) -> VersionUpdate:
"""
Update the current version of this project
Args:
new_version: Use this version in the update
force: Force updating the version even if the current version is the
same as the new version
Returns:
The version update including the changed files
"""
def project_found(self) -> bool:
"""
Returns True if a command has detected a corresponding project
"""
return self.project_file_path.exists()
pontos-25.3.2/pontos/version/commands/_go.py 0000664 0000000 0000000 00000006172 14762555663 0021104 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import re
from pathlib import Path
from typing import Literal, Union
from .._errors import VersionError
from .._version import Version, VersionUpdate
from ._command import VersionCommand
VERSION_MATCH = r'var [Vv]ersion = "(.+)"'
TEMPLATE = """package main
// THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
var version = "{}"
\n"""
# This class is used for Go Version command(s)
class GoVersionCommand(VersionCommand):
project_file_name = "go.mod"
version_file_path = Path("version.go")
def _update_version_file(self, new_version: Version) -> None:
"""
Update the version file with the new version
"""
if self.version_file_path.exists():
version = self.get_current_version()
template = self.version_file_path.read_text(
encoding="utf-8"
).replace(str(version), str(new_version))
else:
template = TEMPLATE.format(str(new_version))
self.version_file_path.write_text(template, encoding="utf-8")
def get_current_version(self) -> Version:
"""Get the current version of this project
In go the version is only defined within the repository
tags, thus we need to check git, what tag is the latest"""
if self.version_file_path.exists():
version_file_text = self.version_file_path.read_text(
encoding="utf-8"
)
match = re.search(VERSION_MATCH, version_file_text)
if match:
return self.versioning_scheme.parse_version(match.group(1))
else:
raise VersionError(
f"No version found in the {self.version_file_path} file."
)
else:
raise VersionError(
f"No {self.version_file_path} file found. "
"This file is required for pontos"
)
def verify_version(
self, version: Union[Literal["current"], Version, None]
) -> None:
"""Verify the current version of this project"""
current_version = self.get_current_version()
if not version or version == "current":
return
if current_version != version:
raise VersionError(
f"Provided version {version} does not match the "
f"current version {current_version}."
)
def update_version(
self, new_version: Version, *, force: bool = False
) -> VersionUpdate:
"""Update the current version of this project"""
try:
current_version = self.get_current_version()
if not force and new_version == current_version:
return VersionUpdate(previous=current_version, new=new_version)
except VersionError:
# just ignore current version and override it
current_version = None
self._update_version_file(new_version=new_version)
return VersionUpdate(
previous=current_version,
new=new_version,
changed_files=[self.version_file_path],
)
pontos-25.3.2/pontos/version/commands/_java.py 0000664 0000000 0000000 00000013442 14762555663 0021416 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import json
import re
from pathlib import Path
from typing import Any, Dict, List, Literal, Union
from .._errors import VersionError
from .._version import Version, VersionUpdate
from ._command import VersionCommand
# This class is used for Java Version command(s)
class JavaVersionCommand(VersionCommand):
VERSION_PATTERN = (
r"^(?P.*[^\d])?"
r"("
r"?P\d+\.\d+\.\d+"
r"([-\.]+(dev|rc|beta|a|alpha|b)\d+)*"
r")"
r"(?P.*$)"
)
project_file_name = "upgradeVersion.json"
def get_current_version(self) -> Version:
file_versions = self._read_versions_from_files()
last_version = self._verify_version(file_versions)
if last_version == "":
raise VersionError("no version found")
return self.versioning_scheme.parse_version(last_version)
def verify_version(
self, version: Union[Literal["current"], Version, None]
) -> None:
file_versions = self._read_versions_from_files()
last_version = self._verify_version(file_versions)
if last_version != str(version):
raise VersionError(
f"Provided version {version} does not match the "
f"current version {last_version} "
f"in '{self.project_file_path}'"
)
def update_version(
self, new_version: Version, *, force: bool = False
) -> VersionUpdate:
try:
current_version = self.get_current_version()
if not force and new_version == current_version:
return VersionUpdate(previous=current_version, new=new_version)
except VersionError:
# just ignore current version and override it
current_version = None
changed_files = self._update_version_files(new_version)
return VersionUpdate(
previous=current_version,
new=new_version,
changed_files=changed_files,
)
def parse_line(self, version_line: str):
return re.match(self.VERSION_PATTERN, version_line, re.DOTALL)
def _update_version_files(self, new_version) -> List[Path]:
config = self._load_config()
changed_files: List[Path] = []
for file_config in config["files"]:
file_path = file_config["path"]
with (Path.cwd() / file_path).open("r") as input_file_handle:
lines = input_file_handle.readlines()
line_number = file_config["line"]
version_line = lines[line_number - 1]
matches = self.parse_line(version_line)
if matches is None:
raise VersionError(
f"Line has no version, "
f"file:'{file_path}' "
f"lineNo:{line_number} "
f"content:'{version_line}'"
)
lines[line_number - 1] = (
matches.group("pre")
+ str(new_version)
+ matches.group("post")
)
content = "".join(lines)
with (Path.cwd() / file_path).open("w") as output_file_handle:
output_file_handle.write(content)
changed_files.append(Path(file_config["path"]))
return changed_files
def _load_config(self) -> Dict[str, Any]:
version_config_file = Path.cwd() / "upgradeVersion.json"
if not version_config_file.exists():
raise VersionError(
f"No {version_config_file} config file found. "
"This file is required for pontos"
)
with version_config_file.open("r") as f:
json_string = f.read()
config = json.loads(json_string)
return config
def _read_versions_from_files(self) -> Dict[str, str]:
config = self._load_config()
file_versions = {}
for file_config in config["files"]:
file_path = file_config["path"]
file = Path.cwd() / file_path
if not file.exists():
raise VersionError(f"No {file} file found.")
with file.open("r") as f:
line_number = file_config["line"]
readlines = f.readlines()
if line_number - 1 > len(readlines):
raise VersionError(
f"Line number:{line_number} "
f"is beyond file lines:{len(readlines) + 1} "
f"file:'{file_path}'"
)
version_line = readlines[line_number - 1]
matches = self.parse_line(version_line)
if matches is None:
raise VersionError(
f"Line has no version, "
f"file:'{file_path}' "
f"lineNo:{line_number} "
f"content:'{version_line}'"
)
file_versions[file_path] = matches.group("version")
return file_versions
def _verify_version(self, file_versions: Dict[str, str]) -> str:
last_version = ""
last_file_name = ""
for file_name, version in file_versions.items():
if last_version == "":
last_version = version
last_file_name = file_name
continue
if last_version != version:
raise VersionError(
f"Versions are not the same "
f"last_file_name:'{last_file_name}' "
f"last_version:'{last_version}' "
f"file_name:'{file_name}' "
f"version:'{version}'"
)
return last_version
pontos-25.3.2/pontos/version/commands/_javascript.py 0000664 0000000 0000000 00000013402 14762555663 0022637 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import json
import re
from pathlib import Path
from typing import Any, Dict, Literal, Optional, Union
from .._errors import VersionError
from .._version import Version, VersionUpdate
from ._command import VersionCommand
# This class is used for JavaScript Version command(s)
class JavaScriptVersionCommand(VersionCommand):
project_file_name = "package.json"
version_file_paths = (Path("src", "version.js"), Path("src", "version.ts"))
_package = None
@property
def package(self) -> Dict[str, Any]:
if self._package:
return self._package
if not self.project_file_path.exists():
raise VersionError(f"{self.project_file_path} file not found.")
try:
with self.project_file_path.open(mode="r", encoding="utf-8") as fp:
self._package = json.load(fp)
except OSError as e:
raise VersionError(
"No version tag found. Maybe this "
"module has not been released at all."
) from e
except json.JSONDecodeError as e:
raise VersionError(
"No valid JSON found. Maybe this "
"module has not been released at all."
) from e
if not self._package.get("version", None):
raise VersionError(
f"Version field missing in {self.project_file_path}."
)
return self._package
def _get_current_file_version(
self, version_file: Path
) -> Optional[Version]:
if not version_file.exists():
return None
content = version_file.read_text(encoding="utf-8")
match = re.search(r'VERSION = "(?P.*)";', content)
if not match:
raise VersionError(f"VERSION variable not found in {version_file}")
return self.versioning_scheme.parse_version(match.group("version"))
def get_current_version(self) -> Version:
"""Get the current version of this project
In go the version is only defined within the repository
tags, thus we need to check git, what tag is the latest"""
return self.versioning_scheme.parse_version(self.package["version"])
def verify_version(
self, version: Union[Literal["current"], Version, None]
) -> None:
"""Verify the current version of this project"""
current_version = self.get_current_version()
if not version or version == "current":
for version_file in self.version_file_paths:
file_version = self._get_current_file_version(version_file)
if file_version and file_version != current_version:
raise VersionError(
f"The version {file_version} in "
f"{version_file} doesn't match the current "
f"version {current_version}."
)
return
if current_version != version:
raise VersionError(
f"Provided version {version} does not match the "
f"current version {current_version} in "
f"{self.project_file_path}."
)
for version_file in self.version_file_paths:
file_version = self._get_current_file_version(version_file)
if file_version and file_version != version:
raise VersionError(
f"Provided version {version} does not match the "
f"current version {file_version} in {version_file}."
)
def _update_package_json(self, new_version: Version) -> None:
"""
Update the version in the package.json file
"""
try:
self.package["version"] = str(new_version)
with self.project_file_path.open(mode="w") as fp:
json.dump(obj=self.package, fp=fp, indent=2)
except EnvironmentError as e:
raise VersionError(
"No version tag found. Maybe this "
"module has not been released at all."
) from e
except json.JSONDecodeError as e:
raise VersionError("Couldn't load JSON") from e
def _update_version_file(
self, version_file: Path, new_version: Version
) -> bool:
"""
Update the version file with the new version
"""
if not version_file.exists():
return False
content = version_file.read_text(encoding="utf-8")
match = re.search(
pattern=r'VERSION = (?P[\'"])(?P.*)(?P=quote)',
string=content,
)
if not match:
return False
content = content.replace(match.group("version"), str(new_version))
version_file.write_text(content, encoding="utf-8")
return True
def update_version(
self, new_version: Version, *, force: bool = False
) -> VersionUpdate:
try:
package_version = self.get_current_version()
if not force and new_version == package_version:
return VersionUpdate(previous=package_version, new=new_version)
except VersionError:
# just ignore current version and override it
package_version = None
changed_files = [self.project_file_path]
self._update_package_json(new_version=new_version)
for version_file in self.version_file_paths:
updated = self._update_version_file(
version_file, new_version=new_version
)
if updated:
changed_files.append(version_file)
return VersionUpdate(
previous=package_version,
new=new_version,
changed_files=changed_files,
)
pontos-25.3.2/pontos/version/commands/_python.py 0000664 0000000 0000000 00000017602 14762555663 0022020 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import importlib.util
from pathlib import Path
from typing import Literal, Union
import tomlkit
from .._errors import VersionError
from .._version import Version, VersionUpdate
from ..schemes import PEP440VersioningScheme
from ._command import VersionCommand
TEMPLATE = """# pylint: disable=invalid-name
# THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
__version__ = "{}"\n"""
# This class is used for Python Version command(s)
class PythonVersionCommand(VersionCommand):
project_file_name = "pyproject.toml"
_version_file_path = None
_pyproject_toml = None
def _get_version_from_pyproject_toml(self) -> Version:
"""
Return the version information from the [tool.poetry] section of the
pyproject.toml file. The version may be in non standardized form.
"""
if (
"tool" in self.pyproject_toml
and "poetry" in self.pyproject_toml["tool"] # type: ignore[operator] # noqa: E501
and "version" in self.pyproject_toml["tool"]["poetry"] # type: ignore[operator,index] # noqa: E501
):
return PEP440VersioningScheme.parse_version(
str(self.pyproject_toml["tool"]["poetry"]["version"]) # type: ignore[index] # noqa: E501
)
raise VersionError(
"Version information not found in "
f"{self.project_file_path} file."
)
def _update_version_file(self, new_version: Version) -> None:
"""
Update the version file with the new version
"""
self.version_file_path.write_text(
TEMPLATE.format(str(new_version)), encoding="utf-8"
)
def _update_pyproject_version(
self,
new_version: Version,
) -> None:
"""
Update the version in the pyproject.toml file
"""
pyproject_toml = tomlkit.parse(
self.project_file_path.read_text(encoding="utf-8")
)
if "tool" not in pyproject_toml:
tool_table = tomlkit.table()
pyproject_toml["tool"] = tool_table
if "poetry" not in pyproject_toml["tool"]: # type: ignore
poetry_table = tomlkit.table()
# pylint: disable=line-too-long, no-member # ignore pylint (2.13.9) error: pontos/version/python.py:128:12: E1101: Instance of 'OutOfOrderTableProxy' has no 'add' member (no-member) # noqa: E501
pyproject_toml["tool"].add("poetry", poetry_table) # type: ignore
pyproject_toml["tool"]["poetry"]["version"] = str(new_version) # type: ignore # pylint: disable=line-too-long # noqa: E501
self.project_file_path.write_text(
tomlkit.dumps(pyproject_toml), encoding="utf-8"
)
@property
def pyproject_toml(self) -> tomlkit.TOMLDocument:
if self._pyproject_toml:
return self._pyproject_toml
if not self.project_file_path.exists():
raise VersionError("pyproject.toml file not found.")
self._pyproject_toml = tomlkit.parse(
self.project_file_path.read_text(encoding="utf-8")
)
return self._pyproject_toml
@property
def version_file_path(self) -> Path:
if self._version_file_path:
return self._version_file_path
if (
"tool" not in self.pyproject_toml
or "pontos" not in self.pyproject_toml["tool"] # type: ignore
or "version" not in self.pyproject_toml["tool"]["pontos"] # type: ignore # pylint: disable=line-too-long # noqa: E501
):
raise VersionError(
"[tool.pontos.version] section missing "
f"in {self.project_file_path}."
)
pontos_version_settings = self.pyproject_toml["tool"]["pontos"][ # type: ignore # pylint: disable=line-too-long # noqa: E501
"version"
]
try:
self._version_file_path = Path(
pontos_version_settings["version-module-file"] # type: ignore
)
return self._version_file_path
except tomlkit.exceptions.NonExistentKey:
raise VersionError(
"version-module-file key not set in [tool.pontos.version] "
f"section of {str(self.project_file_path)}."
) from None
def get_current_version(self) -> Version:
version_module_name = self.version_file_path.stem
module_parts = list(self.version_file_path.parts[:-1]) + [
version_module_name
]
module_name = ".".join(module_parts)
try:
spec = importlib.util.spec_from_file_location(
module_name, self.version_file_path
)
if not spec:
raise VersionError(
f"Could not load version from '{module_name}'. "
)
version_module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(version_module) # type: ignore[union-attr]
return PEP440VersioningScheme.parse_version(
version_module.__version__
)
except FileNotFoundError:
raise VersionError(
f"Could not load version from '{module_name}'. "
f"{self.version_file_path} not found."
) from None
except ModuleNotFoundError:
raise VersionError(
f"Could not load version from '{module_name}'. Import failed."
) from None
def verify_version(
self, version: Union[Literal["current"], Version, None]
) -> None:
current_version = self.get_current_version()
pyproject_version = self._get_version_from_pyproject_toml()
if pyproject_version != current_version:
raise VersionError(
f"The version {pyproject_version} in "
f"{str(self.project_file_path)} doesn't match the current "
f"version {current_version}."
)
if version and version != "current":
if version != current_version:
raise VersionError(
f"Provided version {version} does not match the "
f"current version {current_version}."
)
def update_version(
self, new_version: Version, *, force: bool = False
) -> VersionUpdate:
new_pep440_version = PEP440VersioningScheme.from_version(new_version)
try:
try:
current_version = self.get_current_version()
except VersionError:
# maybe no version module exists yet. fallback to version from
# pyproject.toml
current_version = self._get_version_from_pyproject_toml()
current_converted_version = self.versioning_scheme.from_version(
current_version
)
if not force and new_pep440_version == current_version:
return VersionUpdate(
previous=current_converted_version, new=new_version
)
except VersionError:
# just ignore current version and override it
current_converted_version = None
try:
self._update_pyproject_version(new_version=new_pep440_version)
except OSError as e:
raise VersionError(
"Unable to update version in "
f"{self.project_file_path.absolute()}. Error was {e}"
) from e
try:
self._update_version_file(new_version=new_pep440_version)
except OSError as e:
raise VersionError(
"Unable to update version in "
f"{self.version_file_path.absolute()}. Error was {e}"
) from e
return VersionUpdate(
previous=current_converted_version,
new=new_version,
changed_files=[self.version_file_path, self.project_file_path],
)
pontos-25.3.2/pontos/version/helper.py 0000664 0000000 0000000 00000004626 14762555663 0020020 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from typing import Iterator, Optional
from pontos.git import DEFAULT_TAG_SORT_SUFFIX, Git, TagSort
from ._errors import VersionError
from ._version import ParseVersionFuncType, Version
def get_last_release_versions(
parse_version: ParseVersionFuncType,
*,
git: Optional[Git] = None,
git_tag_prefix: Optional[str] = "",
ignore_pre_releases: Optional[bool] = False,
tag_name: Optional[str] = None,
) -> Iterator[Version]:
"""Get the last released Versions from git.
Args:
git: Git instance to use
git_tag_prefix: Git tag prefix to consider
ignore_pre_release: Ignore pre releases and only consider non pre
releases. Default is False.
tag_name: A pattern for filtering the tags. For example: "1.2.*"
Returns:
List of released versions
"""
git = git or Git()
tag_list = git.list_tags(
sort=TagSort.VERSION,
sort_suffix=DEFAULT_TAG_SORT_SUFFIX,
tag_name=tag_name,
)
tag_list.reverse()
for tag in tag_list:
last_release_version = tag.strip(git_tag_prefix)
try:
version = parse_version(last_release_version)
except VersionError:
# be safe and ignore invalid versions
continue
if version.is_pre_release and ignore_pre_releases:
continue
yield version
def get_last_release_version(
parse_version: ParseVersionFuncType,
*,
git: Optional[Git] = None,
git_tag_prefix: Optional[str] = "",
ignore_pre_releases: Optional[bool] = False,
tag_name: Optional[str] = None,
) -> Optional[Version]:
"""Get the last released Version from git.
Args:
git: Git instance to use
git_tag_prefix: Git tag prefix to consider
ignore_pre_release: Ignore pre releases and only consider non pre
releases. Default is False.
tag_name: A pattern for filtering the tags. For example: "1.2.*"
Returns:
Last released git tag as Version if tags were found
or None
"""
it = get_last_release_versions(
git=git,
parse_version=parse_version,
git_tag_prefix=git_tag_prefix,
ignore_pre_releases=ignore_pre_releases,
tag_name=tag_name,
)
try:
return next(it)
except StopIteration:
return None
pontos-25.3.2/pontos/version/project.py 0000664 0000000 0000000 00000006141 14762555663 0020201 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from typing import List, Literal, Type, Union
from ._errors import ProjectError
from ._version import Version, VersionUpdate
from .commands import VersionCommand, get_commands
from .schemes import VersioningScheme
__all__ = ("Project",)
class Project:
"""
A project for handling versioning
Example:
.. code-block:: python
from pontos.version.scheme import PEP440VersioningScheme
from pontos.version.project import Project
project = Project(PEP440VersioningScheme)
"""
def __init__(
self, versioning_scheme: Union[VersioningScheme, Type[VersioningScheme]]
) -> None:
"""
Creates a new project instance
Args:
versioning_scheme: Scheme for version handling
Raises:
ProjectError: If no fitting VersionCommand could be found
"""
self._versioning_scheme = versioning_scheme
self._commands = self._gather_commands()
def _gather_commands(self) -> List[VersionCommand]:
"""
Initialize the project with the fitting VersionCommands of the current
working directory
Raises:
ProjectError: If no fitting VersionCommand could be found
"""
commands = []
for cmd in get_commands():
command = cmd(versioning_scheme=self._versioning_scheme)
if command.project_found():
commands.append(command)
if not commands:
raise ProjectError("No project settings file found")
return commands
def update_version(
self, new_version: Version, *, force: bool = False
) -> VersionUpdate:
"""
Update the current version of this project
Args:
new_version: Use this version in the update
force: Force updating the version even if the current version is the
same as the new version
Returns:
The version update including the changed files
"""
update = self._commands[0].update_version(new_version, force=force)
for cmd in self._commands[1:]:
next_update = cmd.update_version(new_version, force=force)
update.changed_files.extend(next_update.changed_files)
return update
def get_current_version(self) -> Version:
"""
Get the current version of the project
Returns:
The current version
"""
return self._commands[0].get_current_version()
def verify_version(
self, version: Union[Literal["current"], Version]
) -> None:
"""
Verify the current version of this project
Args:
version: Version to check against the current applied version of
this project. If version is "current" the command should verify
if all version information is consistent, for example if the
version information in several files is the same.
"""
for cmd in self._commands:
cmd.verify_version(version)
pontos-25.3.2/pontos/version/schemes/ 0000775 0000000 0000000 00000000000 14762555663 0017606 5 ustar 00root root 0000000 0000000 pontos-25.3.2/pontos/version/schemes/__init__.py 0000664 0000000 0000000 00000003042 14762555663 0021716 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from argparse import ArgumentTypeError
from ._pep440 import PEP440VersioningScheme
from ._scheme import VersioningScheme
from ._semantic import SemanticVersioningScheme
__all__ = (
"VERSIONING_SCHEMES",
"versioning_scheme_argument_type",
"VersioningScheme",
"PEP440VersioningScheme",
"SemanticVersioningScheme",
)
#: Dictionary with available versioning schemes
VERSIONING_SCHEMES: dict[str, type[VersioningScheme]] = {
"pep440": PEP440VersioningScheme,
"semver": SemanticVersioningScheme,
}
def versioning_scheme_argument_type(value: str) -> type[VersioningScheme]:
"""
Verifies if the passed value is a valid versioning scheme and returns
the corresponding versioning scheme.
Intended to be used as in `ArgumentParser.add_argument` as the type.
Raises:
ArgumentTypeError: If the passed value is not a valid versioning scheme
Example:
.. code-block:: python
from argparse import ArgumentParser
from pontos.version.scheme versioning_scheme_argument_type
parser = ArgumentParser()
parser.add_argument(
"--versioning-scheme",
type=versioning_scheme_argument_type,
)
"""
try:
return VERSIONING_SCHEMES[value]
except KeyError:
raise ArgumentTypeError(
f"invalid value {value}. Expected one of "
f"{', '.join(VERSIONING_SCHEMES.keys())}."
) from None
pontos-25.3.2/pontos/version/schemes/_pep440.py 0000664 0000000 0000000 00000034127 14762555663 0021342 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import re
from typing import Any, Optional, Tuple
from packaging.version import InvalidVersion
from packaging.version import Version as PackagingVersion
from .._calculator import VersionCalculator
from .._errors import VersionError
from .._version import Version
from ._scheme import VersioningScheme
__all__ = (
"PEP440Version",
"PEP440VersionCalculator",
"PEP440VersioningScheme",
)
_LOCAL_RELEASE_REGEXP = re.compile(
r"^(?P[a-zA-Z]+)(?P0|[1-9][0-9]*)$"
)
_PRE_RELEASE_NAME = {"a": "alpha", "b": "beta"}
def _pre_release_name(name: str) -> str:
return _PRE_RELEASE_NAME.get(name, name)
class PEP440Version(Version):
"""
A class handling PEP 440 based version information
"""
def __init__(self, version: str) -> None:
super().__init__(version)
self._version = PackagingVersion(version)
self._parse_local()
def _parse_local(self):
self._local = None
if self._version.local:
match = _LOCAL_RELEASE_REGEXP.match(self._version.local)
if match:
self._local = (
match.group("name"),
int(match.group("version")),
)
@property
def major(self) -> int:
"""The first item of the version"""
return self._version.major
@property
def minor(self) -> int:
"""The second item of :attr:`release` or ``0`` if unavailable."""
return self._version.minor
@property
def patch(self) -> int:
"""The third item of :attr:`release` or ``0`` if unavailable."""
return self._version.micro
@property
def pre(self) -> Optional[Tuple[str, int]]:
"""The pre-release segment of the version."""
if not self._version.pre:
return None
return (_pre_release_name(self._version.pre[0]), self._version.pre[1])
@property
def dev(self) -> Optional[int]:
"""The development number of the version."""
return self._version.dev
@property
def local(self) -> Optional[Tuple[str, int]]:
"""The local version segment of the version."""
return self._local
@property
def is_pre_release(self) -> bool:
"""
Whether this version is a pre-release (alpha, beta, release candidate
and development).
"""
return self._version.is_prerelease
@property
def is_dev_release(self) -> bool:
"""Whether this version is a development release."""
return self._version.is_devrelease
@property
def is_alpha_release(self) -> bool:
"""Whether this version is a alpha release."""
return bool(self.is_pre_release and self.pre and self.pre[0] == "alpha")
@property
def is_beta_release(self) -> bool:
"""Whether this version is a beta release."""
return bool(self.is_pre_release and self.pre and self.pre[0] == "beta")
@property
def is_release_candidate(self) -> bool:
"""Whether this version is a release candidate."""
return bool(self.is_pre_release and self.pre and self.pre[0] == "rc")
@classmethod
def from_string(cls, version: str) -> "PEP440Version":
"""
Create a version from a version string
Args:
version: Version string to parse
Raises:
VersionError: If the version string is invalid.
Returns:
A new version instance
"""
try:
return cls(version)
except InvalidVersion as e:
raise VersionError(e) from None
@classmethod
def from_version(cls, version: "Version") -> "PEP440Version":
"""
Convert a version (if necessary)
This method can be used to convert version instances from different
versioning schemes.
"""
if isinstance(version, cls):
return version
try:
# try to parse the original version string
return cls.from_string(version.parsed_version)
except VersionError:
pass
version_local = (
f"+{version.local[0]}{version.local[1]}" if version.local else ""
)
if version.is_dev_release:
if not version.pre:
new_version = cls.from_string(
f"{version.major}."
f"{version.minor}."
f"{version.patch}"
f".dev{version.dev}"
f"{version_local}"
)
else:
new_version = cls.from_string(
f"{version.major}."
f"{version.minor}."
f"{version.patch}"
f"-{version.pre[0]}{version.pre[1]}"
f".dev{version.dev}"
)
elif version.is_pre_release:
new_version = cls.from_string(
f"{version.major}."
f"{version.minor}."
f"{version.patch}"
f"-{version.pre[0]}{version.pre[1]}" # type: ignore[index]
f"{version_local}"
)
else:
new_version = cls.from_string(str(version))
new_version._parsed_version = version.parsed_version
return new_version
def __eq__(self, other: Any) -> bool:
if other is None:
return False
if isinstance(other, str):
# allow to compare against "current" for now
return False
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return self._version == other._version
def __ne__(self, other: Any) -> bool:
if other is None:
return True
if isinstance(other, str):
# allow to compare against "current" for now
return True
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return self._version != other._version
def __gt__(self, other: Any) -> bool:
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return self._version > other._version
def __ge__(self, other: Any) -> bool:
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return self._version >= other._version
def __lt__(self, other: Any) -> bool:
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return self._version < other._version
def __le__(self, other: Any) -> bool:
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return self._version <= other._version
def __str__(self) -> str:
return str(self._version)
class PEP440VersionCalculator(VersionCalculator):
version_cls = PEP440Version
"""
A PEP 440 version calculator
"""
@classmethod
def next_dev_version(cls, current_version: Version) -> Version:
"""
Get the next development version from a valid version
Examples:
"1.2.3" will return "1.2.4.dev1"
"1.2.3.dev1" will return "1.2.3.dev2"
"""
if current_version.is_dev_release:
if current_version.pre:
return cls.version_from_string(
f"{current_version.major}." # type: ignore[operator]
f"{current_version.minor}."
f"{current_version.patch}"
f"-{current_version.pre[0]}{current_version.pre[1]}" # type: ignore[index] # noqa: E501
f".dev{current_version.dev + 1}" # type: ignore[operator]
)
return cls.version_from_string(
f"{current_version.major}." # type: ignore[operator]
f"{current_version.minor}."
f"{current_version.patch}"
f".dev{current_version.dev + 1}" # type: ignore[operator]
)
if current_version.is_pre_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"{current_version.pre[0]}{current_version.pre[1] + 1}.dev1" # type: ignore[index] # noqa: E501
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}.dev1"
)
@classmethod
def next_alpha_version(cls, current_version: Version) -> Version:
"""
Get the next alpha version from a valid version
Examples:
"1.2.3" will return "1.2.4a1"
"1.2.3.dev1" will return "1.2.3a1"
"""
if current_version.is_dev_release:
if current_version.pre:
if current_version.pre[0] == "alpha":
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"a{current_version.pre[1]}"
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}a1"
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}a1"
)
if current_version.is_alpha_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}a{current_version.pre[1] + 1}" # type: ignore[index] # noqa: E501
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}a1"
)
@classmethod
def next_beta_version(cls, current_version: Version) -> Version:
"""
Get the next beta version from a valid version
Examples:
"1.2.3" will return "1.2.4b1"
"1.2.3.dev1" will return "1.2.3b1"
"""
if current_version.is_dev_release and current_version.pre:
if current_version.pre[0] == "beta":
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"b{current_version.pre[1]}"
)
if current_version.pre[0] == "rc":
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}b1"
)
if current_version.is_dev_release or current_version.is_alpha_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}b1"
)
if current_version.is_beta_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"b{current_version.pre[1] + 1}" # type: ignore[index]
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}b1"
)
@classmethod
def next_release_candidate_version(
cls, current_version: Version
) -> Version:
"""
Get the next release candidate version from a valid version
Examples:
"1.2.3" will return "1.2.4rc1"
"1.2.3.dev1" will return "1.2.3rc1"
"""
if current_version.is_dev_release:
if current_version.pre and current_version.pre[0] == "rc":
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"rc{current_version.pre[1]}"
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}rc1"
)
if current_version.is_alpha_release or current_version.is_beta_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}rc1"
)
if current_version.is_release_candidate:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}rc{current_version.pre[1] + 1}" # type: ignore[index] # noqa: E501
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}rc1"
)
class PEP440VersioningScheme(VersioningScheme):
"""
PEP 440 versioning scheme
"""
version_calculator_cls = PEP440VersionCalculator
version_cls = PEP440Version
name = "PEP440"
pontos-25.3.2/pontos/version/schemes/_scheme.py 0000664 0000000 0000000 00000002766 14762555663 0021576 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from abc import ABC
from typing import Type
from .._calculator import VersionCalculator
from .._version import Version
class VersioningScheme(ABC):
"""
An abstract base class for versioning schemes
Example:
Example on how to implement a new VersioningScheme
.. code-block:: python
from pontos.version.scheme import VersioningScheme
class MyVersioningScheme(VersioningScheme):
version_cls = MyVersion
version_calculator_cls = MyVersionCalculator
"""
version_cls: Type[Version]
version_calculator_cls: Type[VersionCalculator]
name: str
@classmethod
def parse_version(cls, version: str) -> Version:
"""
Parse a version from a version string
Raises:
:py:class:`pontos.version.error.VersionError`: If the version
string contains an invalid version
Returns:
A version instance
"""
return cls.version_cls.from_string(version)
@classmethod
def from_version(cls, version: Version) -> Version:
return cls.version_cls.from_version(version)
@classmethod
def calculator(cls) -> Type[VersionCalculator]:
"""
Return a matching version calculator for the implemented versioning
schema.
Returns:
A version calculator
"""
return cls.version_calculator_cls
pontos-25.3.2/pontos/version/schemes/_semantic.py 0000664 0000000 0000000 00000040675 14762555663 0022136 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import re
from typing import Any, Optional, Tuple
from semver import VersionInfo
from .._calculator import VersionCalculator
from .._errors import VersionError
from .._version import Version
from ._scheme import VersioningScheme
# Note: This regex currently support any kind of
# word-number combination for pre releases
_PRE_RELEASE_REGEXP = re.compile(
r"^(?P[a-zA-Z]+)(?P0|[1-9][0-9]*)"
r"(?:-(?P[a-zA-Z]+)(?P0|[1-9][0-9]*))?$"
)
class SemanticVersion(Version):
"""
A Version implementation based on
`Semantic Versioning`_
"""
def __init__(
self,
version: str,
) -> None:
super().__init__(version)
self._version_info = VersionInfo.parse(version)
self._parse_build()
self._parse_pre_release()
def _parse_pre_release(self) -> None:
self._dev = None
self._pre_release = None
if self._version_info.prerelease:
match = _PRE_RELEASE_REGEXP.match(self._version_info.prerelease)
if not match:
raise VersionError(
f"Invalid prerelease {self._version_info.prerelease} in "
f"{self._version_info}"
)
name = match.group("name")
version = int(match.group("version"))
if name == "dev":
self._dev = version
else:
self._pre_release = (
name,
version,
)
extra = match.group("extra")
if extra == "dev":
if name == "dev":
raise VersionError(
f"Invalid prerelease {self._version_info.prerelease} "
f"in {self._version_info}"
)
self._dev = int(match.group("extra_version"))
def _parse_build(self) -> None:
self._build = None
if self._version_info.build:
match = _PRE_RELEASE_REGEXP.match(self._version_info.build)
if match:
self._build = (
match.group("name"),
int(match.group("version")),
)
@property
def pre(self) -> Optional[Tuple[str, int]]:
"""The pre-release segment of the version."""
return self._pre_release
@property
def dev(self) -> Optional[int]:
"""The development number of the version."""
return self._dev
@property
def local(self) -> Optional[Tuple[str, int]]:
"""The local version segment of the version."""
return self._build
@property
def is_pre_release(self) -> bool:
"""
Whether this version is a pre-release (alpha, beta, release candidate).
"""
return self._pre_release is not None
@property
def is_dev_release(self) -> bool:
"""Whether this version is a development release."""
return self._dev is not None
@property
def is_alpha_release(self) -> bool:
"""Whether this version is a alpha release."""
return self.is_pre_release and self.pre[0] == "alpha" # type: ignore[index] # noqa: E501
@property
def is_beta_release(self) -> bool:
"""Whether this version is a beta release."""
return self.is_pre_release and self.pre[0] == "beta" # type: ignore[index] # noqa: E501
@property
def is_release_candidate(self) -> bool:
"""Whether this version is a release candidate."""
return self.is_pre_release and self.pre[0] == "rc" # type: ignore[index] # noqa: E501
@property
def major(self) -> int:
"""The first item of :attr:`release` or ``0`` if unavailable."""
return self._version_info.major
@property
def minor(self) -> int:
"""The second item of :attr:`release` or ``0`` if unavailable."""
return self._version_info.minor
@property
def patch(self) -> int:
"""The third item of :attr:`release` or ``0`` if unavailable."""
return self._version_info.patch
def __eq__(self, other: Any) -> bool:
if other is None:
return False
if isinstance(other, str):
# allow to compare against "current" for now
return False
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return (
self._version_info == other._version_info
and self._version_info.build == other._version_info.build
)
def __ne__(self, other: Any) -> bool:
return not self == other
def __gt__(self, other: Any) -> bool:
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
if self._version_info.to_tuple()[:3] > other._version_info[:3]: # type: ignore[operator] # noqa: E501
return True
if self._version_info.to_tuple()[:3] < other._version_info[:3]: # type: ignore[operator] # noqa: E501
return False
# major, minor and patch are equal
if self.is_dev_release:
if not other.is_pre_release and not other.is_dev_release:
return False
if not self.is_pre_release and other.is_pre_release:
return False
if not self.is_pre_release:
return self.dev > other.dev # type: ignore[operator]
if self.is_pre_release:
if other.is_dev_release and self.pre == other.pre:
return self.dev > other.dev # type: ignore[operator]
return self.pre > other.pre # type: ignore[operator]
# not a dev release
if self.is_pre_release:
if not other.is_pre_release and not other.is_dev_release:
return False
if other.is_pre_release:
if other.is_dev_release:
return self.pre >= other.pre # type: ignore[operator]
return self.pre > other.pre # type: ignore[operator]
# other is a dev release
return True
if other.is_dev_release or other.is_pre_release:
return True
# both are equal
return False
def __ge__(self, other: Any) -> bool:
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return self > other or self == other
def __lt__(self, other: Any) -> bool:
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return (not self > other) and self != other
def __le__(self, other: Any) -> bool:
if not isinstance(other, Version):
raise ValueError(f"Can't compare {type(self)} with {type(other)}")
if not isinstance(other, type(self)):
other = self.from_version(other)
return not self > other or self == other
def __str__(self) -> str:
"""A string representation of the version"""
return str(self._version_info)
@classmethod
def from_string(cls, version: str) -> "SemanticVersion":
"""
Create a version from a version string
Args:
version: Version string to parse
Raises:
VersionError: If the version string is invalid.
Returns:
A new version instance
"""
try:
return cls(version)
except ValueError as e:
raise VersionError(e) from None
@classmethod
def from_version(cls, version: "Version") -> "SemanticVersion":
"""
Convert a version (if necessary)
This method can be used to convert version instances from different
versioning schemes.
"""
if isinstance(version, cls):
return version
try:
# try to parse the original version string
return cls.from_string(version.parsed_version)
except VersionError:
pass
version_local = (
f"+{version.local[0]}{version.local[1]}" if version.local else ""
)
if version.is_dev_release:
if not version.pre:
new_version = cls.from_string(
f"{version.major}."
f"{version.minor}."
f"{version.patch}"
f"-dev{version.dev}"
f"{version_local}"
)
else:
new_version = cls.from_string(
f"{version.major}."
f"{version.minor}."
f"{version.patch}"
f"-{version.pre[0]}{version.pre[1]}"
f"-dev{version.dev}"
)
elif version.is_alpha_release:
new_version = cls.from_string(
f"{version.major}."
f"{version.minor}."
f"{version.patch}"
f"-alpha{version.pre[1]}" # type: ignore[index]
f"{version_local}"
)
elif version.is_beta_release:
new_version = cls.from_string(
f"{version.major}."
f"{version.minor}."
f"{version.patch}"
f"-beta{version.pre[1]}" # type: ignore[index]
f"{version_local}"
)
elif version.is_pre_release:
new_version = cls.from_string(
f"{version.major}."
f"{version.minor}."
f"{version.patch}"
f"-{version.pre[0]}{version.pre[1]}" # type: ignore[index]
f"{version_local}"
)
else:
new_version = cls.from_string(str(version))
new_version._parsed_version = version.parsed_version
return new_version
# pylint: disable=protected-access
class SemanticVersionCalculator(VersionCalculator):
version_cls = SemanticVersion
@classmethod
def next_dev_version(cls, current_version: Version) -> Version:
"""
Get the next development version from a valid version
"""
if current_version.is_dev_release:
if current_version.pre:
return cls.version_from_string(
f"{current_version.major}." # type: ignore[operator]
f"{current_version.minor}."
f"{current_version.patch}"
f"-{current_version.pre[0]}{current_version.pre[1]}"
f"-dev{current_version.dev + 1}" # type: ignore[operator]
)
return cls.version_from_string(
f"{current_version.major}." # type: ignore[operator]
f"{current_version.minor}."
f"{current_version.patch}"
f"-dev{current_version.dev + 1}" # type: ignore[operator]
)
if current_version.is_pre_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}-"
f"{current_version.pre[0]}{current_version.pre[1] + 1}-dev1" # type: ignore[index] # noqa: E501
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}"
"-dev1"
)
@classmethod
def next_alpha_version(cls, current_version: Version) -> Version:
"""
Get the next alpha version from a valid version
"""
if current_version.is_dev_release:
if current_version.pre:
if current_version.pre[0] == "alpha":
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"-alpha{current_version.pre[1]}"
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}-alpha1"
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}-alpha1"
)
if current_version.is_alpha_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"-alpha{current_version.pre[1] + 1}" # type: ignore[index]
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}"
"-alpha1"
)
@classmethod
def next_beta_version(cls, current_version: Version) -> Version:
"""
Get the next alpha version from a valid version
"""
if current_version.is_dev_release and current_version.pre:
if current_version.pre[0] == "beta":
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"-beta{current_version.pre[1]}"
)
if current_version.pre[0] == "rc":
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}-beta1"
)
if current_version.is_dev_release or current_version.is_alpha_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
"-beta1"
)
if current_version.is_beta_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"-beta{current_version.pre[1] + 1}" # type: ignore[index]
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}"
"-beta1"
)
@classmethod
def next_release_candidate_version(
cls, current_version: Version
) -> Version:
"""
Get the next release candidate version from a valid version
"""
if current_version.is_dev_release:
if current_version.pre and current_version.pre[0] == "rc":
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"-rc{current_version.pre[1]}"
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}-rc1"
)
if current_version.is_alpha_release or current_version.is_beta_release:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}-rc1"
)
if current_version.is_release_candidate:
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch}"
f"-rc{current_version.pre[1] + 1}" # type: ignore[index]
)
return cls.version_from_string(
f"{current_version.major}."
f"{current_version.minor}."
f"{current_version.patch + 1}"
"-rc1"
)
class SemanticVersioningScheme(VersioningScheme):
version_cls = SemanticVersion
version_calculator_cls = SemanticVersionCalculator
name = "SemVer"
pontos-25.3.2/pyproject.toml 0000664 0000000 0000000 00000006662 14762555663 0016076 0 ustar 00root root 0000000 0000000 [tool.poetry]
name = "pontos"
version = "25.3.2"
description = "Common utilities and tools maintained by Greenbone Networks"
authors = ["Greenbone AG "]
license = "GPL-3.0-or-later"
readme = "README.md"
homepage = "https://github.com/greenbone/pontos/"
repository = "https://github.com/greenbone/pontos/"
documentation = "https://greenbone.github.io/pontos/"
classifiers = [
# Full list: https://pypi.org/pypi?%3Aaction=list_classifiers
"Development Status :: 4 - Beta",
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", # pylint: disable=line-too-long
"Environment :: Console",
"Intended Audience :: Developers",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Operating System :: OS Independent",
"Topic :: Software Development :: Libraries :: Python Modules",
]
packages = [
{ include = "pontos" },
{ include = "tests", format = "sdist" },
{ include = "poetry.lock", format = "sdist" },
]
include = ["pontos/updateheader/templates/", "pontos/github/pr_template.md"]
[tool.poetry.dependencies]
python = "^3.9"
colorful = ">=0.5.4"
tomlkit = ">=0.5.11"
packaging = ">=20.3"
httpx = { extras = ["http2"], version = ">=0.23" }
rich = ">=12.4.4"
python-dateutil = ">=2.8.2"
semver = ">=2.13"
lxml = ">=4.9.0"
shtab = ">=1.7.0"
[tool.poetry.group.dev.dependencies]
autohooks = ">=22.7.0"
autohooks-plugin-black = ">=22.7.0"
autohooks-plugin-ruff = ">=23.6.1"
autohooks-plugin-mypy = ">=23.3.0"
rope = ">=1.9.0"
coverage = ">=7.2"
myst-parser = ">=0.19.1"
Sphinx = ">=7.0.1"
furo = ">=2023.5.20"
sphinx-autobuild = ">=2021.3.14"
[tool.black]
line-length = 80
target-version = ['py39', 'py310', 'py311', 'py312']
exclude = '''
/(
\.git
| \.venv
| \.github
| \.vscode
| _build
| build
| dist
| docs
)/
'''
[tool.autohooks]
pre-commit = [
'autohooks.plugins.black',
'autohooks.plugins.ruff',
'autohooks.plugins.mypy',
]
mode = "poetry"
[tool.isort]
profile = "black"
line_length = 80
[tool.ruff]
line-length = 80
target-version = "py39"
[tool.ruff.lint]
extend-select = ["I", "PLE", "PLW"]
[tool.mypy]
files = "pontos"
ignore_missing_imports = true
explicit_package_bases = true
allow_redefinition = true
exclude = 'pontos/updateheader/templates/.*/*\.py'
[[tool.mypy.overrides]]
module = "dateutil"
ignore_missing_imports = true
[tool.pontos.version]
version-module-file = "pontos/version/__version__.py"
[tool.coverage.run]
branch = true
omit = ["tests/*", "pontos/github/scripts/*", "*/__init__.py"]
source = ["pontos"]
[tool.poetry.scripts]
pontos = 'pontos:main'
pontos-version = 'pontos.version:main'
pontos-release = 'pontos.release:main'
pontos-update-header = 'pontos.updateheader:main'
pontos-changelog = 'pontos.changelog:main'
pontos-github = 'pontos.github:main'
pontos-github-actions = 'pontos.github.actions:main'
pontos-github-script = 'pontos.github.script:main'
pontos-nvd-cve = 'pontos.nvd.cve:cve_main'
pontos-nvd-cves = 'pontos.nvd.cve:cves_main'
pontos-nvd-cve-changes = 'pontos.nvd.cve_changes:main'
pontos-nvd-cpe = 'pontos.nvd.cpe:cpe_main'
pontos-nvd-cpes = 'pontos.nvd.cpe:cpes_main'
pontos-nvd-cpe-match = 'pontos.nvd.cpe_matches:cpe_match_main'
pontos-nvd-cpe-matches = 'pontos.nvd.cpe_matches:cpe_matches_main'
pontos-nvd-sources = 'pontos.nvd.source:main'
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
pontos-25.3.2/tests/ 0000775 0000000 0000000 00000000000 14762555663 0014312 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/__init__.py 0000664 0000000 0000000 00000001576 14762555663 0016434 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=no-name-in-module,no-member,unnecessary-dunder-call
import builtins
import sys
from unittest import IsolatedAsyncioTestCase
from unittest.mock import AsyncMock
from pontos.testing import AsyncIteratorMock
if sys.version_info.minor < 10:
# aiter and anext have been added in Python 3.10
def aiter(obj): # pylint: disable=redefined-builtin
return obj.__aiter__()
def anext(obj): # pylint: disable=redefined-builtin
return obj.__anext__()
else:
def aiter(obj): # pylint: disable=redefined-builtin
return builtins.aiter(obj)
def anext(obj): # pylint: disable=redefined-builtin
return builtins.anext(obj)
__all__ = (
"IsolatedAsyncioTestCase",
"AsyncMock",
"AsyncIteratorMock",
"aiter",
"anext",
)
pontos-25.3.2/tests/changelog/ 0000775 0000000 0000000 00000000000 14762555663 0016241 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/changelog/__init__.py 0000664 0000000 0000000 00000000627 14762555663 0020357 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import os
from contextlib import contextmanager
from pathlib import Path
@contextmanager
def use_cwd(path: Path) -> None:
"""
Context Manager to change the current working directory temporaryly
"""
current_cwd = Path.cwd()
os.chdir(str(path))
yield
os.chdir(str(current_cwd))
pontos-25.3.2/tests/changelog/changelog.toml 0000664 0000000 0000000 00000000567 14762555663 0021075 0 ustar 00root root 0000000 0000000 commit_types = [
{ message = "^add", group = "Added"},
{ message = "^remove", group = "Removed"},
{ message = "^change", group = "Changed"},
{ message = "^fix", group = "Bug Fixes"},
{ message = "^doc", group = "Documentation"},
{ message = "^refactor", group = "Refactor"},
{ message = "^test", group = "Testing"},
]
changelog_dir = "changelog"
pontos-25.3.2/tests/changelog/test_conventional_commits.py 0000664 0000000 0000000 00000043653 14762555663 0024117 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from dataclasses import dataclass
from datetime import datetime
from pathlib import Path
from unittest.mock import MagicMock, patch
from pontos.changelog.conventional_commits import (
ChangelogBuilder,
ChangelogBuilderError,
ConventionalCommits,
)
from pontos.testing import temp_directory
@dataclass
class StdOutput:
stdout: bytes
class ChangelogBuilderTestCase(unittest.TestCase):
maxDiff = None
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_changelog_builder_with_config(self, git_mock: MagicMock):
today = datetime.today().strftime("%Y-%m-%d")
own_path = Path(__file__).absolute().parent
config_toml = own_path / "changelog.toml"
git_mock.return_value.list_tags.return_value = ["v0.0.1"]
git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
]
expected_output = f"""## [0.0.2] - {today}
## Added
* foo bar [1234567](https://github.com/foo/bar/commit/1234567)
* bar baz [8abcdef](https://github.com/foo/bar/commit/8abcdef)
## Removed
* foo bar again [42a42a4](https://github.com/foo/bar/commit/42a42a4)
## Changed
* bar to baz [1337abc](https://github.com/foo/bar/commit/1337abc)
## Bug Fixes
* bar baz fixing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
## Documentation
* bar baz documenting [d0c4d0c](https://github.com/foo/bar/commit/d0c4d0c)
## Refactor
* bar baz ref [dead901](https://github.com/foo/bar/commit/dead901)
## Testing
* bar baz testing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
[0.0.2]: https://github.com/foo/bar/compare/v0.0.1...v0.0.2"""
changelog_builder = ChangelogBuilder(
repository="foo/bar",
config=config_toml,
)
changelog = changelog_builder.create_changelog(
last_version="0.0.1", next_version="0.0.2"
)
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(
"v0.0.1..HEAD", oneline=True
)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_changelog_builder_no_commits(self, git_mock: MagicMock):
today = datetime.today().strftime("%Y-%m-%d")
own_path = Path(__file__).absolute().parent
config_toml = own_path / "changelog.toml"
expected_output = f"""## [0.0.2] - {today}
[0.0.2]: https://github.com/foo/bar/compare/v0.0.1...v0.0.2"""
git_mock.return_value.log.return_value = []
changelog_builder = ChangelogBuilder(
repository="foo/bar",
config=config_toml,
)
changelog = changelog_builder.create_changelog(
last_version="0.0.1", next_version="0.0.2"
)
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(
"v0.0.1..HEAD", oneline=True
)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_changelog_builder_no_last_version(self, git_mock: MagicMock):
today = datetime.today().strftime("%Y-%m-%d")
own_path = Path(__file__).absolute().parent
config_toml = own_path / "changelog.toml"
git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
]
git_mock.return_value.rev_list.return_value = ["123"]
expected_output = f"""## [0.0.2] - {today}
## Added
* foo bar [1234567](https://github.com/foo/bar/commit/1234567)
* bar baz [8abcdef](https://github.com/foo/bar/commit/8abcdef)
## Removed
* foo bar again [42a42a4](https://github.com/foo/bar/commit/42a42a4)
## Changed
* bar to baz [1337abc](https://github.com/foo/bar/commit/1337abc)
## Bug Fixes
* bar baz fixing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
## Documentation
* bar baz documenting [d0c4d0c](https://github.com/foo/bar/commit/d0c4d0c)
## Refactor
* bar baz ref [dead901](https://github.com/foo/bar/commit/dead901)
## Testing
* bar baz testing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
[0.0.2]: https://github.com/foo/bar/compare/123...v0.0.2"""
changelog_builder = ChangelogBuilder(
repository="foo/bar",
config=config_toml,
)
changelog = changelog_builder.create_changelog(next_version="0.0.2")
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(oneline=True)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_changelog_builder_no_next_version(self, git_mock: MagicMock):
own_path = Path(__file__).absolute().parent
config_toml = own_path / "changelog.toml"
git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
]
git_mock.return_value.rev_list.return_value = ["123"]
expected_output = """## [Unreleased]
## Added
* foo bar [1234567](https://github.com/foo/bar/commit/1234567)
* bar baz [8abcdef](https://github.com/foo/bar/commit/8abcdef)
## Removed
* foo bar again [42a42a4](https://github.com/foo/bar/commit/42a42a4)
## Changed
* bar to baz [1337abc](https://github.com/foo/bar/commit/1337abc)
## Bug Fixes
* bar baz fixing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
## Documentation
* bar baz documenting [d0c4d0c](https://github.com/foo/bar/commit/d0c4d0c)
## Refactor
* bar baz ref [dead901](https://github.com/foo/bar/commit/dead901)
## Testing
* bar baz testing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
[Unreleased]: https://github.com/foo/bar/compare/v0.0.1...HEAD"""
changelog_builder = ChangelogBuilder(
repository="foo/bar",
config=config_toml,
)
changelog = changelog_builder.create_changelog(last_version="0.0.1")
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(
"v0.0.1..HEAD", oneline=True
)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_changelog_builder_no_next_and_last_version(
self, git_mock: MagicMock
):
own_path = Path(__file__).absolute().parent
config_toml = own_path / "changelog.toml"
git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
]
git_mock.return_value.rev_list.return_value = ["123"]
expected_output = """## [Unreleased]
## Added
* foo bar [1234567](https://github.com/foo/bar/commit/1234567)
* bar baz [8abcdef](https://github.com/foo/bar/commit/8abcdef)
## Removed
* foo bar again [42a42a4](https://github.com/foo/bar/commit/42a42a4)
## Changed
* bar to baz [1337abc](https://github.com/foo/bar/commit/1337abc)
## Bug Fixes
* bar baz fixing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
## Documentation
* bar baz documenting [d0c4d0c](https://github.com/foo/bar/commit/d0c4d0c)
## Refactor
* bar baz ref [dead901](https://github.com/foo/bar/commit/dead901)
## Testing
* bar baz testing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
[Unreleased]: https://github.com/foo/bar/compare/123...HEAD"""
changelog_builder = ChangelogBuilder(
repository="foo/bar",
config=config_toml,
)
changelog = changelog_builder.create_changelog()
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(oneline=True)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_changelog_builder_no_conventional_commits(
self, git_mock: MagicMock
):
today = datetime.today().strftime("%Y-%m-%d")
own_path = Path(__file__).absolute().parent
config_toml = own_path / "changelog.toml"
expected_output = f"""## [0.0.2] - {today}
[0.0.2]: https://github.com/foo/bar/compare/v0.0.1...v0.0.2"""
git_mock.return_value.list_tags.return_value = ["v0.0.1"]
git_mock.return_value.log.return_value = [
"1234567 foo bar",
"8abcdef bar baz",
]
changelog_builder = ChangelogBuilder(
repository="foo/bar",
config=config_toml,
)
changelog = changelog_builder.create_changelog(
last_version="0.0.1", next_version="0.0.2"
)
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(
"v0.0.1..HEAD", oneline=True
)
def test_changelog_builder_config_file_not_exists(self):
with (
temp_directory() as temp_dir,
self.assertRaisesRegex(
ChangelogBuilderError,
r"Changelog Config file '.*\.toml' does not exist\.",
),
):
ChangelogBuilder(
repository="foo/bar",
config=temp_dir / "changelog.toml",
)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_changelog_builder_with_default_changelog_config(
self, git_mock: MagicMock
):
today = datetime.today().strftime("%Y-%m-%d")
git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
"a1c5a0b Deps: Update foo from 1.2.3 to 3.2.1",
]
changelog_builder = ChangelogBuilder(
repository="foo/bar",
)
expected_output = f"""## [0.0.2] - {today}
## Added
* foo bar [1234567](https://github.com/foo/bar/commit/1234567)
* bar baz [8abcdef](https://github.com/foo/bar/commit/8abcdef)
## Removed
* foo bar again [42a42a4](https://github.com/foo/bar/commit/42a42a4)
## Changed
* bar to baz [1337abc](https://github.com/foo/bar/commit/1337abc)
## Bug Fixes
* bar baz fixing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
## Dependencies
* Update foo from 1.2.3 to 3.2.1 [a1c5a0b](https://github.com/foo/bar/commit/a1c5a0b)
[0.0.2]: https://github.com/foo/bar/compare/v0.0.1...v0.0.2"""
changelog = changelog_builder.create_changelog(
last_version="0.0.1", next_version="0.0.2"
)
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(
"v0.0.1..HEAD", oneline=True
)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_changelog_builder_with_empty_git_tag_prefix(
self, git_mock: MagicMock
):
today = datetime.today().strftime("%Y-%m-%d")
git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
]
changelog_builder = ChangelogBuilder(
repository="foo/bar",
git_tag_prefix="",
)
expected_output = f"""## [0.0.2] - {today}
## Added
* foo bar [1234567](https://github.com/foo/bar/commit/1234567)
* bar baz [8abcdef](https://github.com/foo/bar/commit/8abcdef)
## Removed
* foo bar again [42a42a4](https://github.com/foo/bar/commit/42a42a4)
## Changed
* bar to baz [1337abc](https://github.com/foo/bar/commit/1337abc)
## Bug Fixes
* bar baz fixing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
[0.0.2]: https://github.com/foo/bar/compare/0.0.1...0.0.2"""
changelog = changelog_builder.create_changelog(
last_version="0.0.1", next_version="0.0.2"
)
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(
"0.0.1..HEAD", oneline=True
)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_write_changelog_to_file(self, git_mock: MagicMock):
today = datetime.today().strftime("%Y-%m-%d")
own_path = Path(__file__).absolute().parent
config_toml = own_path / "changelog.toml"
git_mock.return_value.list_tags.return_value = ["v0.0.1"]
git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
]
expected_output = f"""## [0.0.2] - {today}
## Added
* foo bar [1234567](https://github.com/foo/bar/commit/1234567)
* bar baz [8abcdef](https://github.com/foo/bar/commit/8abcdef)
## Removed
* foo bar again [42a42a4](https://github.com/foo/bar/commit/42a42a4)
## Changed
* bar to baz [1337abc](https://github.com/foo/bar/commit/1337abc)
## Bug Fixes
* bar baz fixing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
## Documentation
* bar baz documenting [d0c4d0c](https://github.com/foo/bar/commit/d0c4d0c)
## Refactor
* bar baz ref [dead901](https://github.com/foo/bar/commit/dead901)
## Testing
* bar baz testing [fedcba8](https://github.com/foo/bar/commit/fedcba8)
[0.0.2]: https://github.com/foo/bar/compare/v0.0.1...v0.0.2"""
changelog_builder = ChangelogBuilder(
repository="foo/bar",
config=config_toml,
)
with temp_directory() as temp_dir:
changelog_file = temp_dir / "changelog.md"
changelog_builder.create_changelog_file(
changelog_file, last_version="0.0.1", next_version="0.0.2"
)
changelog = changelog_file.read_text(encoding="utf8")
self.assertEqual(changelog, expected_output)
git_mock.return_value.log.assert_called_once_with(
"v0.0.1..HEAD", oneline=True
)
class ConventionalCommitsTestCase(unittest.TestCase):
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
def test_get_commits(self, git_mock: MagicMock):
git_mock.return_value.list_tags.return_value = ["v0.0.1"]
git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
]
conventional_commits = ConventionalCommits()
commits = conventional_commits.get_commits(from_ref="0.0.1")
self.assertEqual(len(commits), 4) # four commit types
self.assertEqual(len(commits["Added"]), 2)
self.assertEqual(len(commits["Changed"]), 1)
self.assertEqual(len(commits["Removed"]), 1)
self.assertEqual(len(commits["Bug Fixes"]), 1)
removed = commits["Removed"][0]
self.assertEqual(removed.commit_id, "42a42a4")
self.assertEqual(removed.message, "foo bar again")
commit_id, message = removed
self.assertEqual(commit_id, "42a42a4")
self.assertEqual(message, "foo bar again")
def test_default_config(self):
conventional_commits = ConventionalCommits()
categories = conventional_commits.commit_types()
self.assertEqual(len(categories), 5)
add = categories[0]
self.assertEqual(add["message"], "^add")
self.assertEqual(add["group"], "Added")
remove = categories[1]
self.assertEqual(remove["message"], "^remove")
self.assertEqual(remove["group"], "Removed")
change = categories[2]
self.assertEqual(change["message"], "^change")
self.assertEqual(change["group"], "Changed")
fix = categories[3]
self.assertEqual(fix["message"], "^fix")
self.assertEqual(fix["group"], "Bug Fixes")
deps = categories[4]
self.assertEqual(deps["message"], "^deps")
self.assertEqual(deps["group"], "Dependencies")
pontos-25.3.2/tests/changelog/test_parser.py 0000664 0000000 0000000 00000002264 14762555663 0021152 0 ustar 00root root 0000000 0000000 # Copyright (C) 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pathlib import Path
from pontos.changelog.main import parse_args
from pontos.version.schemes._pep440 import PEP440Version
class ParseArgsTestCase(unittest.TestCase):
def test_parse_args(self):
parsed_args = parse_args(
[
"-q",
"--repository",
"urghs/bla",
"--config",
"foo.toml",
"--current-version",
"1.2.3",
"--next-version",
"2.3.4",
"--git-tag-prefix",
"a",
"--output",
"changelog.md",
]
)
self.assertTrue(parsed_args.quiet)
self.assertEqual(parsed_args.repository, "urghs/bla")
self.assertEqual(parsed_args.config, Path("foo.toml"))
self.assertEqual(parsed_args.current_version, PEP440Version("1.2.3"))
self.assertEqual(parsed_args.next_version, PEP440Version("2.3.4"))
self.assertEqual(parsed_args.git_tag_prefix, "a")
self.assertEqual(parsed_args.output, Path("changelog.md"))
pontos-25.3.2/tests/cpe/ 0000775 0000000 0000000 00000000000 14762555663 0015061 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/cpe/__init__.py 0000664 0000000 0000000 00000000132 14762555663 0017166 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
pontos-25.3.2/tests/cpe/test_cpe.py 0000664 0000000 0000000 00000070365 14762555663 0017254 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022 - 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa: E501
import unittest
from pontos.cpe import ANY, CPE, NA, CPEParsingError, Part
from pontos.cpe._cpe import (
bind_value_for_formatted_string,
convert_double_backslash,
split_cpe,
unbind_value_from_formatted_string,
unquote_attribute_value,
)
class SplitCpeTestCase(unittest.TestCase):
def test_split_uri_cpe(self):
parts = split_cpe("cpe:/o:microsoft:windows_xp:::pro")
self.assertEqual(len(parts), 7)
self.assertEqual(parts[0], "cpe")
self.assertEqual(parts[1], "/o")
self.assertEqual(parts[2], "microsoft")
self.assertEqual(parts[3], "windows_xp")
self.assertEqual(parts[4], "")
self.assertEqual(parts[5], "")
self.assertEqual(parts[6], "pro")
def test_split_formatted_cpe(self):
parts = split_cpe(
"cpe:2.3:a:microsoft:internet_explorer:8.0.6001:beta:*:*:*:*:*:*"
)
self.assertEqual(len(parts), 13)
self.assertEqual(parts[0], "cpe")
self.assertEqual(parts[1], "2.3")
self.assertEqual(parts[2], "a")
self.assertEqual(parts[3], "microsoft")
self.assertEqual(parts[4], "internet_explorer")
self.assertEqual(parts[5], "8.0.6001")
self.assertEqual(parts[6], "beta")
self.assertEqual(parts[7], "*")
self.assertEqual(parts[8], "*")
self.assertEqual(parts[9], "*")
self.assertEqual(parts[10], "*")
self.assertEqual(parts[11], "*")
self.assertEqual(parts[12], "*")
parts = split_cpe("cpe:2.3:a:foo:bar\:mumble:1.0:*:*:*:*:*:*:*")
self.assertEqual(len(parts), 13)
self.assertEqual(parts[0], "cpe")
self.assertEqual(parts[1], "2.3")
self.assertEqual(parts[2], "a")
self.assertEqual(parts[3], "foo")
self.assertEqual(parts[4], "bar\\:mumble")
self.assertEqual(parts[5], "1.0")
self.assertEqual(parts[6], "*")
self.assertEqual(parts[7], "*")
self.assertEqual(parts[8], "*")
self.assertEqual(parts[9], "*")
self.assertEqual(parts[10], "*")
self.assertEqual(parts[11], "*")
self.assertEqual(parts[12], "*")
class ConvertDoubleBackslashTestCase(unittest.TestCase):
def test_remove_backslash(self):
self.assertEqual(convert_double_backslash("foo-bar"), "foo-bar")
self.assertEqual(convert_double_backslash("foo\\bar"), "foo\\bar")
self.assertEqual(convert_double_backslash("foo\\\\bar"), "foo\\bar")
class UnbindValueFromFormattedStringTestCase(unittest.TestCase):
def test_unchanged(self):
self.assertIsNone(unbind_value_from_formatted_string(None))
self.assertEqual(unbind_value_from_formatted_string(ANY), ANY)
self.assertEqual(unbind_value_from_formatted_string(NA), NA)
self.assertEqual(
unbind_value_from_formatted_string("foo_bar"), "foo_bar"
)
self.assertEqual(
unbind_value_from_formatted_string("foo\\:bar"), "foo\\:bar"
)
self.assertEqual(
unbind_value_from_formatted_string("1\\.2\\.3"), "1\\.2\\.3"
)
def test_quoting(self):
self.assertEqual(
unbind_value_from_formatted_string("foo-bar"), "foo\\-bar"
)
self.assertEqual( # not sure if this can happen and if it's valid
unbind_value_from_formatted_string("foo:bar"), "foo\\:bar"
)
self.assertEqual(
unbind_value_from_formatted_string("1.2.3"), "1\\.2\\.3"
)
def test_asterisk(self):
self.assertEqual(unbind_value_from_formatted_string("*foo"), "*foo")
self.assertEqual(unbind_value_from_formatted_string("foo*"), "foo*")
self.assertEqual(unbind_value_from_formatted_string("foo\\*"), "foo\\*")
with self.assertRaisesRegex(
CPEParsingError,
"An unquoted asterisk must appear at the beginning or end of "
"'foo\*bar'",
):
unbind_value_from_formatted_string("foo*bar")
with self.assertRaisesRegex(
CPEParsingError,
"An unquoted asterisk must appear at the beginning or end of "
"'\*\*foo'",
):
unbind_value_from_formatted_string("**foo")
def test_question_mark(self):
self.assertEqual(unbind_value_from_formatted_string("?foo"), "?foo")
self.assertEqual(unbind_value_from_formatted_string("??foo"), "??foo")
self.assertEqual(unbind_value_from_formatted_string("foo?"), "foo?")
self.assertEqual(unbind_value_from_formatted_string("foo??"), "foo??")
self.assertEqual(unbind_value_from_formatted_string("foo\\?"), "foo\\?")
with self.assertRaisesRegex(
CPEParsingError,
"An unquoted question mark must appear at the beginning or end, "
"or in a leading or trailing sequence 'foo\?bar'",
):
unbind_value_from_formatted_string("foo?bar")
class BindValueForFormattedStringTestCase(unittest.TestCase):
def test_any(self):
self.assertEqual(bind_value_for_formatted_string(None), ANY)
self.assertEqual(bind_value_for_formatted_string(""), ANY)
self.assertEqual(bind_value_for_formatted_string(ANY), ANY)
def test_na(self):
self.assertEqual(bind_value_for_formatted_string(NA), NA)
def test_remove_quoting(self):
self.assertEqual(bind_value_for_formatted_string("1\\.2\\.3"), "1.2.3")
# _ doesn't get quoted during unbinding therefore unquoting it here
# doesn't really make sense bit it's in the standard!
self.assertEqual(
bind_value_for_formatted_string("foo\\_bar"), "foo_bar"
)
self.assertEqual(
bind_value_for_formatted_string("foo\\-bar"), "foo-bar"
)
def test_unchanged(self):
self.assertEqual(
bind_value_for_formatted_string("foo\\:bar"), "foo\\:bar"
)
self.assertEqual(bind_value_for_formatted_string("?foo"), "?foo")
self.assertEqual(bind_value_for_formatted_string("foo*"), "foo*")
self.assertEqual(bind_value_for_formatted_string("foo\\*"), "foo\\*")
class UnquoteAttributeValueTestCase(unittest.TestCase):
def test_unchanged(self):
self.assertIsNone(unquote_attribute_value(None))
self.assertEqual(unquote_attribute_value(""), "")
self.assertEqual(unquote_attribute_value(ANY), ANY)
self.assertEqual(unquote_attribute_value("?"), "?")
self.assertEqual(unquote_attribute_value("foo-bar"), "foo-bar")
self.assertEqual(unquote_attribute_value("foo_bar"), "foo_bar")
self.assertEqual(unquote_attribute_value("1.2.3"), "1.2.3")
def test_special(self):
self.assertEqual(unquote_attribute_value("foo\\?bar"), "foo\\?bar")
self.assertEqual(unquote_attribute_value("foo\\*bar"), "foo\\*bar")
def test_unquote(self):
self.assertEqual(unquote_attribute_value("foo\\\\bar"), "foo\\bar")
self.assertEqual(unquote_attribute_value("foo\\:bar"), "foo:bar")
self.assertEqual(unquote_attribute_value("1\\.2\\.3"), "1.2.3")
class CPETestCase(unittest.TestCase):
def test_uri_binding(self):
cpe_string = "cpe:/o:microsoft:windows_xp:::pro"
cpe = CPE.from_string(cpe_string)
self.assertEqual(str(cpe), "cpe:/o:microsoft:windows_xp:::pro")
self.assertEqual(
cpe.as_uri_binding(), "cpe:/o:microsoft:windows_xp:::pro"
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:o:microsoft:windows_xp:*:*:pro:*:*:*:*:*",
)
self.assertTrue(cpe.is_uri_binding())
self.assertFalse(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.OPERATING_SYSTEM)
self.assertEqual(cpe.vendor, "microsoft")
self.assertEqual(cpe.product, "windows_xp")
self.assertEqual(cpe.edition, "pro")
self.assertEqual(cpe.version, ANY)
self.assertEqual(cpe.update, ANY)
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.sw_edition)
self.assertIsNone(cpe.target_sw)
self.assertIsNone(cpe.target_hw)
self.assertIsNone(cpe.other)
cpe = CPE.from_string(
"cpe:/a:foo%5cbar:big%24money_manager_2010:::~~special~ipod_touch~80gb~"
)
self.assertEqual(
str(cpe),
"cpe:/a:foo%5cbar:big%24money_manager_2010:::~~special~ipod_touch~80gb~",
)
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:foo%5cbar:big%24money_manager_2010:::~~special~ipod_touch~80gb~",
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:a:foo\\\\bar:big\$money_manager_2010:*:*:*:*:special:ipod_touch:80gb:*",
)
self.assertTrue(cpe.is_uri_binding())
self.assertFalse(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "foo\\bar")
self.assertEqual(cpe.product, "big$money_manager_2010")
self.assertEqual(cpe.version, ANY)
self.assertEqual(cpe.update, ANY)
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.edition)
self.assertEqual(cpe.sw_edition, "special")
self.assertEqual(cpe.target_sw, "ipod_touch")
self.assertEqual(cpe.target_hw, "80gb")
self.assertIsNone(cpe.other)
def test_formatted_string_binding(self):
cpe_string = (
"cpe:2.3:a:qrokes:qr_twitter_widget:*:*:*:*:*:wordpress:*:*"
)
cpe = CPE.from_string(cpe_string)
self.assertEqual(
str(cpe),
"cpe:2.3:a:qrokes:qr_twitter_widget:*:*:*:*:*:wordpress:*:*",
)
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:qrokes:qr_twitter_widget:::~~~wordpress~~",
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:a:qrokes:qr_twitter_widget:*:*:*:*:*:wordpress:*:*",
)
self.assertFalse(cpe.is_uri_binding())
self.assertTrue(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "qrokes")
self.assertEqual(cpe.product, "qr_twitter_widget")
self.assertEqual(cpe.version, ANY)
self.assertEqual(cpe.update, ANY)
self.assertEqual(cpe.edition, ANY)
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.sw_edition, ANY)
self.assertEqual(cpe.target_sw, "wordpress")
self.assertEqual(cpe.target_hw, ANY)
self.assertEqual(cpe.other, ANY)
def test_uri_bind_examples(self):
# test examples from https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7695.pdf
# example 1
cpe = CPE(
part=Part.APPLICATION,
vendor="microsoft",
product="internet_explorer",
version="8\.0\.6001",
update="beta",
edition=ANY,
)
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:microsoft:internet_explorer:8.0.6001:beta",
)
# example 2
cpe = CPE(
part=Part.APPLICATION,
vendor="microsoft",
product="internet_explorer",
version="8\.*",
update="sp?",
)
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:microsoft:internet_explorer:8.%02:sp%01",
)
# example 3
cpe = CPE(
part=Part.APPLICATION,
vendor="hp",
product="insight_diagnostics",
version="7\.4\.0\.1570",
update=NA,
sw_edition="online",
target_sw="win2003",
target_hw="x64",
)
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:hp:insight_diagnostics:7.4.0.1570:-:~~online~win2003~x64~",
)
# example 4
cpe = CPE(
part=Part.APPLICATION,
vendor="hp",
product="openview_network_manager",
version="7\.51",
target_sw="linux",
)
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:hp:openview_network_manager:7.51::~~~linux~~",
)
# example 5
cpe = CPE(
part=Part.APPLICATION,
vendor="foo\\\\bar",
product="big\$money_manager_2010",
sw_edition="special",
target_sw="ipod_touch",
target_hw="80gb",
)
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:foo%5cbar:big%24money_manager_2010:::~~special~ipod_touch~80gb~",
)
def test_uri_unbind_examples(self):
# test examples from https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7695.pdf
# example 1
cpe = CPE.from_string(
"cpe:/a:microsoft:internet_explorer:8.0.6001:beta"
)
self.assertTrue(cpe.is_uri_binding())
self.assertFalse(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "microsoft")
self.assertEqual(cpe.product, "internet_explorer")
self.assertEqual(cpe.version, "8.0.6001")
self.assertEqual(cpe.update, "beta")
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.edition)
self.assertIsNone(cpe.sw_edition)
self.assertIsNone(cpe.target_sw)
self.assertIsNone(cpe.target_hw)
self.assertIsNone(cpe.other)
# example 2
cpe = CPE.from_string("cpe:/a:microsoft:internet_explorer:8.%2a:sp%3f")
self.assertTrue(cpe.is_uri_binding())
self.assertFalse(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "microsoft")
self.assertEqual(cpe.product, "internet_explorer")
self.assertEqual(cpe.version, "8.\\*")
self.assertEqual(cpe.update, "sp\\?")
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.edition)
self.assertIsNone(cpe.sw_edition)
self.assertIsNone(cpe.target_sw)
self.assertIsNone(cpe.target_hw)
self.assertIsNone(cpe.other)
# example 3
cpe = CPE.from_string("cpe:/a:microsoft:internet_explorer:8.%02:sp%01")
self.assertTrue(cpe.is_uri_binding())
self.assertFalse(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "microsoft")
self.assertEqual(cpe.product, "internet_explorer")
self.assertEqual(cpe.version, "8.*")
self.assertEqual(cpe.update, "sp?")
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.edition)
self.assertIsNone(cpe.sw_edition)
self.assertIsNone(cpe.target_sw)
self.assertIsNone(cpe.target_hw)
self.assertIsNone(cpe.other)
# example 4
cpe = CPE.from_string(
"cpe:/a:hp:insight_diagnostics:7.4.0.1570::~~online~win2003~x64~"
)
self.assertTrue(cpe.is_uri_binding())
self.assertFalse(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "hp")
self.assertEqual(cpe.product, "insight_diagnostics")
self.assertEqual(cpe.version, "7.4.0.1570")
self.assertEqual(cpe.update, ANY)
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.edition)
self.assertEqual(cpe.sw_edition, "online")
self.assertEqual(cpe.target_sw, "win2003")
self.assertEqual(cpe.target_hw, "x64")
self.assertIsNone(cpe.other)
# example 5
cpe = CPE.from_string(
"cpe:/a:hp:openview_network_manager:7.51:-:~~~linux~~"
)
self.assertTrue(cpe.is_uri_binding())
self.assertFalse(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "hp")
self.assertEqual(cpe.product, "openview_network_manager")
self.assertEqual(cpe.version, "7.51")
self.assertEqual(cpe.update, NA)
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.edition)
self.assertIsNone(cpe.sw_edition)
self.assertEqual(cpe.target_sw, "linux")
self.assertIsNone(cpe.target_hw)
self.assertIsNone(cpe.other)
# example 6
# with self.assertRaises(CPEParsingError):
# CPE.from_string(
# "cpe:/a:foo%5cbar:big%24money_2010%07:::~~special~ipod_touch~80gb~"
# )
# example 7
cpe = CPE.from_string("cpe:/a:foo~bar:big%7emoney_2010")
self.assertTrue(cpe.is_uri_binding())
self.assertFalse(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "foo~bar")
self.assertEqual(cpe.product, "big~money_2010")
self.assertIsNone(cpe.version)
self.assertIsNone(cpe.update)
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.edition)
self.assertIsNone(cpe.sw_edition)
self.assertIsNone(cpe.target_sw)
self.assertIsNone(cpe.target_hw)
self.assertIsNone(cpe.other)
# example 7a
cpe = CPE.from_string("cpe:2.3:*:Microsoft")
self.assertFalse(cpe.is_uri_binding())
self.assertTrue(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.WILDCARD)
self.assertEqual(cpe.vendor, "microsoft")
self.assertIsNone(cpe.product)
self.assertIsNone(cpe.version)
self.assertIsNone(cpe.update)
self.assertIsNone(cpe.language)
self.assertIsNone(cpe.edition)
self.assertIsNone(cpe.sw_edition)
self.assertIsNone(cpe.target_sw)
self.assertIsNone(cpe.target_hw)
self.assertIsNone(cpe.other)
# example 8
with self.assertRaisesRegex(
CPEParsingError,
"^Percent-encoded asterisk is no at the beginning or the end "
"of '12.%02.1234'$",
):
CPE.from_string("cpe:/a:foo:bar:12.%02.1234")
def test_formatted_bind_examples(self):
# test examples from https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7695.pdf
# example 1
cpe = CPE(
part=Part.APPLICATION,
vendor="microsoft",
product="internet_explorer",
version="8\.0\.6001",
update="beta",
edition=ANY,
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:a:microsoft:internet_explorer:8.0.6001:beta:*:*:*:*:*:*",
)
# example 2
cpe = CPE(
part=Part.APPLICATION,
vendor="microsoft",
product="internet_explorer",
version="8\.*",
update="sp?",
edition=ANY,
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:a:microsoft:internet_explorer:8.*:sp?:*:*:*:*:*:*",
)
cpe = CPE(
part=Part.APPLICATION,
vendor="microsoft",
product="internet_explorer",
version="8\.\*",
update="sp?",
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:a:microsoft:internet_explorer:8.\*:sp?:*:*:*:*:*:*",
)
# example 3
cpe = CPE(
part=Part.APPLICATION,
vendor="hp",
product="insight",
version="7\.4\.0\.1570",
update=NA,
sw_edition="online",
target_sw="win2003",
target_hw="x64",
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:a:hp:insight:7.4.0.1570:-:*:*:online:win2003:x64:*",
)
# example 4
cpe = CPE(
part=Part.APPLICATION,
vendor="hp",
product="openview_network_manager",
version="7\.51",
target_sw="linux",
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:a:hp:openview_network_manager:7.51:*:*:*:*:linux:*:*",
)
# example 5
cpe = CPE(
part=Part.APPLICATION,
vendor="foo\\\\bar",
product="big\$money_2010",
sw_edition="special",
target_sw="ipod_touch",
target_hw="80gb",
)
self.assertEqual(
cpe.as_formatted_string_binding(),
"cpe:2.3:a:foo\\\\bar:big\$money_2010:*:*:*:*:special:ipod_touch:80gb:*",
)
def test_formatted_unbind_examples(self):
# test examples from https://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7695.pdf
# example 1
cpe = CPE.from_string(
"cpe:2.3:a:microsoft:internet_explorer:8.0.6001:beta:*:*:*:*:*:*"
)
self.assertFalse(cpe.is_uri_binding())
self.assertTrue(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "microsoft")
self.assertEqual(cpe.product, "internet_explorer")
self.assertEqual(cpe.version, "8.0.6001")
self.assertEqual(cpe.update, "beta")
self.assertEqual(cpe.edition, ANY)
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.sw_edition, ANY)
self.assertEqual(cpe.target_sw, ANY)
self.assertEqual(cpe.target_hw, ANY)
self.assertEqual(cpe.other, ANY)
# example 2
cpe = CPE.from_string(
"cpe:2.3:a:microsoft:internet_explorer:8.*:sp?:*:*:*:*:*:*"
)
self.assertFalse(cpe.is_uri_binding())
self.assertTrue(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "microsoft")
self.assertEqual(cpe.product, "internet_explorer")
self.assertEqual(cpe.version, "8.*")
self.assertEqual(cpe.update, "sp?")
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.edition, ANY)
self.assertEqual(cpe.sw_edition, ANY)
self.assertEqual(cpe.target_sw, ANY)
self.assertEqual(cpe.target_hw, ANY)
self.assertEqual(cpe.other, ANY)
# example 3
cpe = CPE.from_string(
"cpe:2.3:a:hp:insight_diagnostics:7.4.0.1570:-:*:*:online:win2003:x64:*"
)
self.assertFalse(cpe.is_uri_binding())
self.assertTrue(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "hp")
self.assertEqual(cpe.product, "insight_diagnostics")
self.assertEqual(cpe.version, "7.4.0.1570")
self.assertEqual(cpe.update, NA)
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.edition, ANY)
self.assertEqual(cpe.sw_edition, "online")
self.assertEqual(cpe.target_sw, "win2003")
self.assertEqual(cpe.target_hw, "x64")
self.assertEqual(cpe.other, ANY)
with self.assertRaisesRegex(
CPEParsingError,
"^An unquoted asterisk must appear at the beginning or end of "
"'7.4.*.1570'$",
):
# embedded unquoted asterisk in the version attribute
CPE.from_string(
"cpe:2.3:a:hp:insight_diagnostics:7.4.*.1570:*:*:*:*:*:*"
)
# example 4
cpe = CPE.from_string(
"cpe:2.3:a:foo\\\\bar:big\$money:2010:*:*:*:special:ipod_touch:80gb:*"
)
self.assertFalse(cpe.is_uri_binding())
self.assertTrue(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "foo\\bar")
self.assertEqual(cpe.product, "big$money")
self.assertEqual(cpe.version, "2010")
self.assertEqual(cpe.update, ANY)
self.assertEqual(cpe.edition, ANY)
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.sw_edition, "special")
self.assertEqual(cpe.target_sw, "ipod_touch")
self.assertEqual(cpe.target_hw, "80gb")
self.assertEqual(cpe.other, ANY)
cpe = CPE.from_string("cpe:2.3:a:foo:bar\:mumble:1.0:*:*:*:*:*:*:*")
self.assertFalse(cpe.is_uri_binding())
self.assertTrue(cpe.is_formatted_string_binding())
self.assertEqual(cpe.part, Part.APPLICATION)
self.assertEqual(cpe.vendor, "foo")
self.assertEqual(cpe.product, "bar:mumble")
self.assertEqual(cpe.version, "1.0")
self.assertEqual(cpe.update, ANY)
self.assertEqual(cpe.edition, ANY)
self.assertEqual(cpe.language, ANY)
self.assertEqual(cpe.sw_edition, ANY)
self.assertEqual(cpe.target_sw, ANY)
self.assertEqual(cpe.target_hw, ANY)
self.assertEqual(cpe.other, ANY)
def test_as_uri_binding(self):
cpe = CPE.from_string("cpe:2.3:a:microsoft:internet_explorer:8\\.*:sp?")
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:microsoft:internet_explorer:8.%02:sp%01",
)
cpe = CPE.from_string("cpe:2.3:a:cgiirc:cgi\:irc:0.5.7:*:*:*:*:*:*:*")
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:cgiirc:cgi%3airc:0.5.7",
)
def test_as_uri_binding_with_edition(self):
cpe_string = "cpe:2.3:a:hp:insight_diagnostics:7.4.0.1570:-:*:*:online:win2003:x64"
cpe = CPE.from_string(cpe_string)
self.assertEqual(
cpe.as_uri_binding(),
"cpe:/a:hp:insight_diagnostics:7.4.0.1570:-:~~online~win2003~x64~",
)
def test_parse_error(self):
with self.assertRaisesRegex(
CPEParsingError,
"^Invalid CPE string 'foo/bar'. CPE does not start with 'cpe:/' "
"or 'cpe:2.3'$",
):
CPE.from_string("foo/bar")
def test_str(self):
cpe = CPE(part=Part.APPLICATION, vendor="foo", product="bar")
self.assertEqual(str(cpe), "cpe:/a:foo:bar")
cpe = CPE(
part=Part.APPLICATION,
vendor="foo",
product="bar",
target_sw="ipsum",
)
self.assertEqual(str(cpe), "cpe:2.3:a:foo:bar:*:*:*:*:*:ipsum:*:*")
cpe = CPE(
cpe_string="cpe:2.3:a:foo:bar",
part=Part.APPLICATION,
vendor="foo",
product="bar",
)
self.assertEqual(str(cpe), "cpe:2.3:a:foo:bar")
def test_has_extended_attribute(self):
cpe = CPE(part=Part.APPLICATION, vendor="foo", product="bar")
self.assertFalse(cpe.has_extended_attribute())
cpe = CPE(
part=Part.APPLICATION,
vendor="foo",
product="bar",
target_sw="ipsum",
)
self.assertTrue(cpe.has_extended_attribute())
def test_clone(self):
cpe = CPE.from_string(
"cpe:2.3:a:hp:openview_network_manager:7.51:*:*:*:*:linux:*:*"
)
cpe2 = cpe.clone()
self.assertIsNot(cpe, cpe2)
cpe = CPE.from_string(
"cpe:2.3:a:hp:openview_network_manager:7.51:*:*:*:*:linux:*:*"
)
cpe2 = cpe.clone(version=ANY)
self.assertIsNot(cpe, cpe2)
self.assertEqual(cpe.version, "7.51")
self.assertEqual(cpe2.version, ANY)
def test_equal(self):
cpe1 = CPE.from_string("cpe:2.3:a:3com:3cdaemon:-:*:*:*:*:*:*:*")
cpe2 = CPE.from_string("cpe:2.3:a:adobe:flash_player:-:*:*:*:*:*:*:*")
cpe3 = CPE.from_string("cpe:2.3:a:3com:3cdaemon:-:*:*:*:*:*:*:*")
self.assertNotEqual(cpe1, None)
self.assertNotEqual(cpe1, "foo")
self.assertNotEqual(cpe1, cpe2)
self.assertIsNot(cpe1, cpe3)
self.assertEqual(cpe1, cpe3)
def test_hashable(self):
cpe1 = CPE.from_string("cpe:2.3:a:3com:3cdaemon:-:*:*:*:*:*:*:*")
cpe2 = CPE.from_string("cpe:2.3:a:adobe:flash_player:-:*:*:*:*:*:*:*")
cpe3 = CPE.from_string("cpe:2.3:a:3com:3cdaemon:-:*:*:*:*:*:*:*")
cpe_list = [cpe1, cpe2, cpe3, cpe1]
self.assertTrue(len(cpe_list), 4)
cpe_set = set(cpe_list)
self.assertTrue(len(cpe_set), 2)
def test_repr(self):
cpe1 = CPE.from_string("cpe:2.3:a:3com:3cdaemon:-:*:*:*:*:*:*:*")
self.assertEqual(
repr(cpe1),
'',
)
pontos-25.3.2/tests/fake_pyproject.toml 0000664 0000000 0000000 00000000105 14762555663 0020210 0 ustar 00root root 0000000 0000000 [tool.pontos.version]
version-module-file = "foo/bar/__version__.py"
pontos-25.3.2/tests/git/ 0000775 0000000 0000000 00000000000 14762555663 0015075 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/git/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0017202 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/git/test_git.py 0000664 0000000 0000000 00000101742 14762555663 0017276 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pathlib import Path
from unittest.mock import MagicMock, patch
from pontos.git import (
DEFAULT_TAG_SORT_SUFFIX,
ConfigScope,
Git,
GitError,
MergeStrategy,
ResetMode,
Status,
TagSort,
)
from pontos.testing import temp_directory, temp_git_repository
class GitTestCase(unittest.TestCase):
@patch("pontos.git._git.exec_git")
def test_exec(self, exec_git_mock):
git = Git()
git.exec("foo", "bar", "baz")
exec_git_mock.assert_called_once_with("foo", "bar", "baz", cwd=None)
@patch("pontos.git._git.exec_git")
def test_clone(self, exec_git_mock):
git = Git()
git.clone("http://foo/foo.git", Path("/bar"))
exec_git_mock.assert_called_once_with(
"clone", "http://foo/foo.git", "/bar", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_clone_with_remote(self, exec_git_mock):
git = Git()
git.clone("http://foo/foo.git", Path("/bar"), remote="foo")
exec_git_mock.assert_called_once_with(
"clone", "-o", "foo", "http://foo/foo.git", "/bar", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_clone_with_branch(self, exec_git_mock):
git = Git()
git.clone("http://foo/foo.git", Path("/bar"), branch="foo")
exec_git_mock.assert_called_once_with(
"clone", "-b", "foo", "http://foo/foo.git", "/bar", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_clone_with_depth(self, exec_git_mock):
git = Git()
git.clone("http://foo/foo.git", Path("/bar"), depth=1)
exec_git_mock.assert_called_once_with(
"clone", "--depth", "1", "http://foo/foo.git", "/bar", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_init(self, exec_git_mock):
git = Git()
git.init()
exec_git_mock.assert_called_once_with("init", cwd=None)
@patch("pontos.git._git.exec_git")
def test_init_bare(self, exec_git_mock):
git = Git()
git.init(bare=True)
exec_git_mock.assert_called_once_with("init", "--bare", cwd=None)
def test_cwd(self):
git = Git()
self.assertIsNone(git.cwd)
new_cwd = Path("foo")
git.cwd = new_cwd
self.assertEqual(git.cwd, new_cwd.absolute())
@patch("pontos.git._git.exec_git")
def test_create_branch(self, exec_git_mock):
git = Git()
git.create_branch("foo")
exec_git_mock.assert_called_once_with("checkout", "-b", "foo", cwd=None)
@patch("pontos.git._git.exec_git")
def test_create_branch_with_starting_point(self, exec_git_mock):
git = Git()
git.create_branch("foo", start_point="bar")
exec_git_mock.assert_called_once_with(
"checkout", "-b", "foo", "bar", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_rebase(self, exec_git_mock):
git = Git()
git.rebase("foo")
exec_git_mock.assert_called_once_with("rebase", "foo", cwd=None)
@patch("pontos.git._git.exec_git")
def test_rebase_with_head(self, exec_git_mock):
git = Git()
git.rebase("foo", head="bar")
exec_git_mock.assert_called_once_with("rebase", "foo", "bar", cwd=None)
@patch("pontos.git._git.exec_git")
def test_rebase_with_head_and_onto(self, exec_git_mock):
git = Git()
git.rebase("foo", head="bar", onto="staging")
exec_git_mock.assert_called_once_with(
"rebase", "--onto", "staging", "foo", "bar", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_rebase_with_octopus_strategy(self, exec_git_mock):
git = Git()
git.rebase("foo", strategy=MergeStrategy.OCTOPUS)
exec_git_mock.assert_called_once_with(
"rebase", "--strategy", "octopus", "foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_rebase_with_ort_ours_strategy(self, exec_git_mock):
git = Git()
git.rebase("foo", strategy=MergeStrategy.ORT_OURS)
exec_git_mock.assert_called_once_with(
"rebase", "--strategy", "ort", "-X", "ours", "foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_push(self, exec_git_mock):
git = Git()
git.push()
exec_git_mock.assert_called_once_with("push", cwd=None)
@patch("pontos.git._git.exec_git")
def test_push_with_remote(self, exec_git_mock):
git = Git()
git.push(remote="foo")
exec_git_mock.assert_called_once_with("push", "foo", cwd=None)
@patch("pontos.git._git.exec_git")
def test_push_with_remote_and_branch(self, exec_git_mock):
git = Git()
git.push(remote="foo", branch="bar")
exec_git_mock.assert_called_once_with("push", "foo", "bar", cwd=None)
@patch("pontos.git._git.exec_git")
def test_push_with_follow_tags(self, exec_git_mock):
git = Git()
git.push(follow_tags=True)
exec_git_mock.assert_called_once_with("push", "--follow-tags", cwd=None)
@patch("pontos.git._git.exec_git")
def test_push_with_follow_tags_false(self, exec_git_mock):
git = Git()
git.push(follow_tags=False)
exec_git_mock.assert_called_once_with("push", cwd=None)
@patch("pontos.git._git.exec_git")
def test_push_with_force(self, exec_git_mock):
git = Git()
git.push(force=True)
exec_git_mock.assert_called_once_with("push", "--force", cwd=None)
@patch("pontos.git._git.exec_git")
def test_push_with_force_false(self, exec_git_mock):
git = Git()
git.push(force=False)
exec_git_mock.assert_called_once_with("push", cwd=None)
@patch("pontos.git._git.exec_git")
def test_push_branch_with_delete(self, exec_git_mock):
git = Git()
git.push(delete=True, branch="v1.2.3", remote="origin")
exec_git_mock.assert_called_once_with(
"push", "--delete", "origin", "v1.2.3", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_push_refspec_with_delete(self, exec_git_mock):
git = Git()
git.push("v1.2.3", delete=True)
exec_git_mock.assert_called_once_with(
"push", "--delete", "v1.2.3", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_push_refspec(self, exec_git_mock):
git = Git()
git.push("v1.2.3")
exec_git_mock.assert_called_once_with("push", "v1.2.3", cwd=None)
@patch("pontos.git._git.exec_git")
def test_push_refspecs(self, exec_git_mock):
git = Git()
git.push(["v1.2.3", "main"])
exec_git_mock.assert_called_once_with(
"push", "v1.2.3", "main", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_config_get(self, exec_git_mock):
git = Git()
git.config("foo")
exec_git_mock.assert_called_once_with("config", "foo", cwd=None)
@patch("pontos.git._git.exec_git")
def test_config_set(self, exec_git_mock):
git = Git()
git.config("foo", "bar")
exec_git_mock.assert_called_once_with("config", "foo", "bar", cwd=None)
@patch("pontos.git._git.exec_git")
def test_config_get_local_scope(self, exec_git_mock):
git = Git()
git.config("foo", scope=ConfigScope.LOCAL)
exec_git_mock.assert_called_once_with(
"config", "--local", "foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_config_get_system_scope(self, exec_git_mock):
git = Git()
git.config("foo", scope=ConfigScope.SYSTEM)
exec_git_mock.assert_called_once_with(
"config", "--system", "foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_config_get_global_scope(self, exec_git_mock):
git = Git()
git.config("foo", scope=ConfigScope.GLOBAL)
exec_git_mock.assert_called_once_with(
"config", "--global", "foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_config_get_worktree_scope(self, exec_git_mock):
git = Git()
git.config("foo", scope=ConfigScope.WORKTREE)
exec_git_mock.assert_called_once_with(
"config", "--worktree", "foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_cherry_pick(self, exec_git_mock):
git = Git()
git.cherry_pick(["foo", "bar"])
exec_git_mock.assert_called_once_with(
"cherry-pick", "foo", "bar", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_cherry_pick_single_commit(self, exec_git_mock):
git = Git()
git.cherry_pick("foo")
exec_git_mock.assert_called_once_with("cherry-pick", "foo", cwd=None)
@patch("pontos.git._git.exec_git")
def test_list_tags(self, exec_git_mock):
exec_git_mock.return_value = "v1.0\nv2.0\nv2.1\n"
git = Git()
tags = git.list_tags()
exec_git_mock.assert_called_once_with("tag", "-l", cwd=None)
self.assertEqual(len(tags), 3)
self.assertEqual(tags[0], "v1.0")
self.assertEqual(tags[1], "v2.0")
self.assertEqual(tags[2], "v2.1")
@patch("pontos.git._git.exec_git")
def test_list_tags_with_version_sort(self, exec_git_mock):
exec_git_mock.return_value = "v1.0\nv2.0\nv2.1\n"
git = Git()
tags = git.list_tags(sort=TagSort.VERSION)
exec_git_mock.assert_called_once_with(
"tag",
"-l",
"--sort=version:refname",
cwd=None,
)
self.assertEqual(len(tags), 3)
self.assertEqual(tags[0], "v1.0")
self.assertEqual(tags[1], "v2.0")
self.assertEqual(tags[2], "v2.1")
@patch("pontos.git._git.exec_git")
def test_list_tags_with_version_suffix_sort(self, exec_git_mock):
exec_git_mock.return_value = "v1.0\nv2.0\nv2.1\n"
git = Git()
tags = git.list_tags(
sort=TagSort.VERSION, sort_suffix=DEFAULT_TAG_SORT_SUFFIX
)
exec_git_mock.assert_called_once_with(
"-c",
"versionsort.suffix=-alpha",
"-c",
"versionsort.suffix=a",
"-c",
"versionsort.suffix=-beta",
"-c",
"versionsort.suffix=b",
"-c",
"versionsort.suffix=-rc",
"-c",
"versionsort.suffix=rc",
"tag",
"-l",
"--sort=version:refname",
cwd=None,
)
self.assertEqual(len(tags), 3)
self.assertEqual(tags[0], "v1.0")
self.assertEqual(tags[1], "v2.0")
self.assertEqual(tags[2], "v2.1")
@patch("pontos.git._git.exec_git")
def test_list_tags_with_tag_name(self, exec_git_mock):
exec_git_mock.return_value = "v2.0\nv2.1\n"
git = Git()
tags = git.list_tags(tag_name="v2.*")
exec_git_mock.assert_called_once_with("tag", "-l", "v2.*", cwd=None)
self.assertEqual(len(tags), 2)
self.assertEqual(tags[0], "v2.0")
self.assertEqual(tags[1], "v2.1")
@patch("pontos.git._git.exec_git")
def test_add_single_file(self, exec_git_mock):
git = Git()
git.add("foo")
exec_git_mock.assert_called_once_with("add", "foo", cwd=None)
@patch("pontos.git._git.exec_git")
def test_add(self, exec_git_mock):
git = Git()
git.add(["foo", "bar"])
exec_git_mock.assert_called_once_with("add", "foo", "bar", cwd=None)
@patch("pontos.git._git.exec_git")
def test_commit(self, exec_git_mock):
git = Git()
git.commit("Add foo")
exec_git_mock.assert_called_once_with(
"commit", "-m", "Add foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_commit_with_signing_key(self, exec_git_mock):
git = Git()
git.commit(
"Add foo",
gpg_signing_key="8AE4BE429B60A59B311C2E739823FAA60ED1E580",
)
exec_git_mock.assert_called_once_with(
"commit",
"-S8AE4BE429B60A59B311C2E739823FAA60ED1E580",
"-m",
"Add foo",
cwd=None,
)
@patch("pontos.git._git.exec_git")
def test_commit_without_verify(self, exec_git_mock):
git = Git()
git.commit("Add foo", verify=False)
exec_git_mock.assert_called_once_with(
"commit", "--no-verify", "-m", "Add foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_commit_without_gpg_sign(self, exec_git_mock):
git = Git()
git.commit("Add foo", gpg_sign=False)
exec_git_mock.assert_called_once_with(
"commit", "--no-gpg-sign", "-m", "Add foo", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_tag(self, exec_git_mock):
git = Git()
git.tag(tag="test")
exec_git_mock.assert_called_once_with("tag", "test", cwd=None)
@patch("pontos.git._git.exec_git")
def test_tag_with_gpg_key(self, exec_git_mock):
git = Git()
git.tag("test", gpg_key_id="0x123")
exec_git_mock.assert_called_once_with(
"tag", "-u", "0x123", "test", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_tag_with_message(self, exec_git_mock):
git = Git()
git.tag("test", message="Tag for 123 release")
exec_git_mock.assert_called_once_with(
"tag", "-m", "Tag for 123 release", "test", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_tag_with_force(self, exec_git_mock):
git = Git()
git.tag("test", force=True)
exec_git_mock.assert_called_once_with(
"tag", "--force", "test", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_tag_without_sign(self, exec_git_mock):
git = Git()
git.tag("test", sign=False)
exec_git_mock.assert_called_once_with(
"tag", "--no-sign", "test", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_fetch(self, exec_git_mock):
git = Git()
git.fetch()
exec_git_mock.assert_called_once_with("fetch", cwd=None)
@patch("pontos.git._git.exec_git")
def test_fetch_with_remote(self, exec_git_mock):
git = Git()
git.fetch("foo")
exec_git_mock.assert_called_once_with("fetch", "foo", cwd=None)
@patch("pontos.git._git.exec_git")
def test_fetch_with_remote_and_refspec(self, exec_git_mock):
git = Git()
git.fetch("foo", "my-branch")
exec_git_mock.assert_called_once_with(
"fetch", "foo", "my-branch", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_fetch_with_verbose(self, exec_git_mock):
git = Git()
git.fetch(verbose=True)
exec_git_mock.assert_called_once_with("fetch", "-v", cwd=None)
@patch("pontos.git._git.exec_git")
def test_add_remote(self, exec_git_mock):
git = Git()
git.add_remote("foo", "https://foo.bar/foo.git")
exec_git_mock.assert_called_once_with(
"remote", "add", "foo", "https://foo.bar/foo.git", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_checkout(self, exec_git_mock):
git = Git()
git.checkout("foo")
exec_git_mock.assert_called_once_with("checkout", "foo", cwd=None)
@patch("pontos.git._git.exec_git")
def test_checkout_with_start_point(self, exec_git_mock):
git = Git()
git.checkout("foo", start_point="bar")
exec_git_mock.assert_called_once_with(
"checkout", "-b", "foo", "bar", cwd=None
)
@patch("pontos.git._git.exec_git")
def test_remote_url(self, exec_git_mock):
url = "git@github.com:foo/foo.git"
exec_git_mock.return_value = url
git = Git()
remote = git.remote_url("foo")
exec_git_mock.assert_called_once_with(
"remote", "get-url", "foo", cwd=None
)
self.assertEqual(remote, url)
@patch("pontos.git._git.exec_git")
def test_remote_url_with_default(self, exec_git_mock):
url = "git@github.com:foo/foo.git"
exec_git_mock.return_value = url
git = Git()
remote = git.remote_url()
exec_git_mock.assert_called_once_with(
"remote", "get-url", "origin", cwd=None
)
self.assertEqual(remote, url)
@patch("pontos.git._git.exec_git")
def test_log(self, exec_git_mock):
# pylint: disable=line-too-long
exec_git_mock.return_value = """commit 68c6c3785bbb049df63dc51f8b5b709eb19f8517
Author: Björn Ricks
Date: Wed Apr 8 15:16:05 2020 +0200
Add a draft for a README.md document
commit 464f24d43d7293091b168c6b37ee37978a650958
Author: Björn Ricks
Date: Wed Apr 8 14:28:53 2020 +0200
Initial commit
""" # noqa: E501
git = Git()
logs = git.log()
exec_git_mock.assert_called_once_with("log", cwd=None)
self.assertEqual(
logs[0], "commit 68c6c3785bbb049df63dc51f8b5b709eb19f8517"
)
self.assertEqual(
logs[6], "commit 464f24d43d7293091b168c6b37ee37978a650958"
)
@patch("pontos.git._git.exec_git")
def test_log_with_oneline(self, exec_git_mock):
exec_git_mock.return_value = """50f9963 Add CircleCI config for pontos
9a8feaa Rename to pontos only
047cfae Update README for installation and development
e6ea80d Update README
68c6c37 Add a draft for a README.md document
464f24d Initial commit"""
git = Git()
logs = git.log(oneline=True)
exec_git_mock.assert_called_once_with("log", "--oneline", cwd=None)
self.assertEqual(logs[0], "50f9963 Add CircleCI config for pontos")
self.assertEqual(logs[5], "464f24d Initial commit")
@patch("pontos.git._git.exec_git")
def test_log_with_format(self, exec_git_mock):
exec_git_mock.return_value = """Add CircleCI config for pontos
Rename to pontos only
Update README for installation and development
Update README
Add a draft for a README.md document
Initial commit"""
git = Git()
logs = git.log(format="format:%s")
exec_git_mock.assert_called_once_with(
"log", "--format=format:%s", cwd=None
)
self.assertEqual(logs[0], "Add CircleCI config for pontos")
self.assertEqual(logs[5], "Initial commit")
@patch("pontos.git._git.exec_git")
def test_rev_list(self, exec_git_mock):
git = Git()
git.rev_list("foo", "bar", "baz", max_parents=123, abbrev_commit=True)
exec_git_mock.assert_called_once_with(
"rev-list",
"--max-parents=123",
"--abbrev-commit",
"foo",
"bar",
"baz",
cwd=None,
)
@patch("pontos.git._git.exec_git")
def test_move(self, exec_git_mock):
git = Git()
git.move("foo", "bar")
exec_git_mock.assert_called_once_with(
"mv",
"foo",
"bar",
cwd=None,
)
@patch("pontos.git._git.exec_git")
def test_remove(self, exec_git_mock):
git = Git()
git.remove("foo")
exec_git_mock.assert_called_once_with(
"rm",
"foo",
cwd=None,
)
@patch("pontos.git._git.exec_git")
def test_status(self, exec_git_mock):
git = Git()
git.status()
exec_git_mock.assert_called_once_with(
"status",
"-z",
"--ignore-submodules",
"--untracked-files=no",
cwd=None,
)
@patch("pontos.git._git.exec_git")
def test_status_with_files(self, exec_git_mock):
git = Git()
git.status(["foo", "bar", "baz"])
exec_git_mock.assert_called_once_with(
"status",
"-z",
"--ignore-submodules",
"--untracked-files=no",
"--",
"foo",
"bar",
"baz",
cwd=None,
)
@patch("pontos.git._git.exec_git")
def test_version(self, exec_git_mock: MagicMock):
exec_git_mock.return_value = "git version 1.2.3"
git = Git()
self.assertEqual(git.version, "1.2.3")
def test_version_runs(self):
"""Getting the git version should not raise an error"""
git = Git()
git.version
@patch("pontos.git._git.exec_git")
def test_show_with_online_and_objects(self, exec_git_mock: MagicMock):
exec_git_mock.return_value = """9a8feaa Rename to pontos only
047cfae Update README for installation and development
"""
git = Git()
show = git.show(oneline=True, objects=["9a8feaa", "047cfae"])
exec_git_mock.assert_called_once_with(
"show", "--oneline", "9a8feaa", "047cfae", cwd=None
)
self.assertEqual(show[0], "9a8feaa Rename to pontos only")
self.assertEqual(
show[1], "047cfae Update README for installation and development"
)
@patch("pontos.git._git.exec_git")
def test_show_with_format(self, exec_git_mock: MagicMock):
exec_git_mock.return_value = """Rename to pontos only
"""
git = Git()
show = git.show(format="format:%s")
exec_git_mock.assert_called_once_with(
"show", "--format=format:%s", cwd=None
)
self.assertEqual(show, "Rename to pontos only")
@patch("pontos.git._git.exec_git")
def test_show_with_single_object(self, exec_git_mock: MagicMock):
content = """commit a6956fb1398cae9426e7ced0396248a90dc1ff64
Author: Björn Ricks
Date: Wed Jul 19 15:07:03 2023 +0200
Add: Allow to get the git version string
diff --git a/pontos.git._git.py b/pontos.git._git.py
index a83eed8..09aed3d 100644
--- a/pontos.git._git.py
+++ b/pontos.git._git.py
@@ -168,6 +168,14 @@ class Git:
...
"""
exec_git_mock.return_value = content
git = Git()
show = git.show(objects="9a8feaa")
exec_git_mock.assert_called_once_with("show", "9a8feaa", cwd=None)
self.assertEqual(show, content.strip())
@patch("pontos.git._git.exec_git")
def test_show_with_patch(self, exec_git_mock: MagicMock):
content = """commit a6956fb1398cae9426e7ced0396248a90dc1ff64
Author: Björn Ricks
Date: Wed Jul 19 15:07:03 2023 +0200
Add: Allow to get the git version string
diff --git a/pontos.git._git.py b/pontos.git._git.py
index a83eed8..09aed3d 100644
--- a/pontos.git._git.py
+++ b/pontos.git._git.py
@@ -168,6 +168,14 @@ class Git:
...
"""
exec_git_mock.return_value = content
git = Git()
show = git.show(patch=True)
exec_git_mock.assert_called_once_with("show", "--patch", cwd=None)
self.assertEqual(show, content.strip())
@patch("pontos.git._git.exec_git")
def test_show_with_no_patch(self, exec_git_mock: MagicMock):
content = """commit a6956fb1398cae9426e7ced0396248a90dc1ff64
Author: Björn Ricks
Date: Wed Jul 19 15:07:03 2023 +0200
Add: Allow to get the git version string
"""
exec_git_mock.return_value = content
git = Git()
show = git.show(patch=False)
exec_git_mock.assert_called_once_with("show", "--no-patch", cwd=None)
self.assertEqual(show, content.strip())
@patch("pontos.git._git.exec_git")
def test_delete_tag(self, exec_git_mock):
git = Git()
git.delete_tag("v1.2.3")
exec_git_mock.assert_called_once_with("tag", "-d", "v1.2.3", cwd=None)
@patch("pontos.git._git.exec_git")
def test_reset_mixed(self, exec_git_mock):
git = Git()
git.reset("c1234", mode=ResetMode.MIXED)
exec_git_mock.assert_called_once_with(
"reset", "--mixed", "c1234", cwd=None
)
class GitExtendedTestCase(unittest.TestCase):
def test_semantic_list_tags(self):
with temp_git_repository() as tmp_git:
tags = [
"v0.6.5-alpha3",
"v0.6.5-beta1",
"v0.6.5-alpha2",
"v0.6.5-rc1",
"v0.6.5-alpha1",
"v0.6.5",
"v0.6.4",
"v0.6.3-alpha1",
"v1.0.0",
]
git = Git(tmp_git)
git.config("commit.gpgSign", "false", scope=ConfigScope.LOCAL)
git.config("tag.gpgSign", "false", scope=ConfigScope.LOCAL)
git.config("tag.sort", "refname", scope=ConfigScope.LOCAL)
tmp_file = tmp_git / "foo.txt"
tmp_file.touch()
git.add(tmp_file)
git.commit("some commit")
for tag in tags:
git.tag(tag)
tags = git.list_tags()
self.assertEqual(
tags,
[
"v0.6.3-alpha1",
"v0.6.4",
"v0.6.5",
"v0.6.5-alpha1",
"v0.6.5-alpha2",
"v0.6.5-alpha3",
"v0.6.5-beta1",
"v0.6.5-rc1",
"v1.0.0",
],
)
tags = git.list_tags(sort=TagSort.VERSION)
self.assertEqual(
tags,
[
"v0.6.3-alpha1",
"v0.6.4",
"v0.6.5",
"v0.6.5-alpha1",
"v0.6.5-alpha2",
"v0.6.5-alpha3",
"v0.6.5-beta1",
"v0.6.5-rc1",
"v1.0.0",
],
)
tags = git.list_tags(sort=TagSort.VERSION, tag_name="v0.6*")
self.assertEqual(
tags,
[
"v0.6.3-alpha1",
"v0.6.4",
"v0.6.5",
"v0.6.5-alpha1",
"v0.6.5-alpha2",
"v0.6.5-alpha3",
"v0.6.5-beta1",
"v0.6.5-rc1",
],
)
tags = git.list_tags(sort=TagSort.VERSION, tag_name="v0.6.5*")
self.assertEqual(
tags,
[
"v0.6.5",
"v0.6.5-alpha1",
"v0.6.5-alpha2",
"v0.6.5-alpha3",
"v0.6.5-beta1",
"v0.6.5-rc1",
],
)
tags = git.list_tags(tag_name="v0.6.5*")
self.assertEqual(
tags,
[
"v0.6.5",
"v0.6.5-alpha1",
"v0.6.5-alpha2",
"v0.6.5-alpha3",
"v0.6.5-beta1",
"v0.6.5-rc1",
],
)
tags = git.list_tags(
sort=TagSort.VERSION, sort_suffix=DEFAULT_TAG_SORT_SUFFIX
)
self.assertEqual(
tags,
[
"v0.6.3-alpha1",
"v0.6.4",
"v0.6.5-alpha1",
"v0.6.5-alpha2",
"v0.6.5-alpha3",
"v0.6.5-beta1",
"v0.6.5-rc1",
"v0.6.5",
"v1.0.0",
],
)
def test_pep440_list_tags(self):
with temp_git_repository() as tmp_git:
tags = [
"v0.6.5a3",
"v0.6.5b1",
"v0.6.5a2",
"v0.6.5rc1",
"v0.6.5a1",
"v0.6.5",
"v0.6.4",
"v0.6.3a1",
"v1.0.0",
]
git = Git(tmp_git)
git.config("commit.gpgSign", "false", scope=ConfigScope.LOCAL)
git.config("tag.gpgSign", "false", scope=ConfigScope.LOCAL)
git.config("tag.sort", "refname", scope=ConfigScope.LOCAL)
tmp_file = tmp_git / "foo.txt"
tmp_file.touch()
git.add(tmp_file)
git.commit("some commit")
for tag in tags:
git.tag(tag)
tags = git.list_tags()
self.assertEqual(
tags,
[
"v0.6.3a1",
"v0.6.4",
"v0.6.5",
"v0.6.5a1",
"v0.6.5a2",
"v0.6.5a3",
"v0.6.5b1",
"v0.6.5rc1",
"v1.0.0",
],
)
tags = git.list_tags(sort=TagSort.VERSION)
self.assertEqual(
tags,
[
"v0.6.3a1",
"v0.6.4",
"v0.6.5",
"v0.6.5a1",
"v0.6.5a2",
"v0.6.5a3",
"v0.6.5b1",
"v0.6.5rc1",
"v1.0.0",
],
)
tags = git.list_tags(
sort=TagSort.VERSION, sort_suffix=DEFAULT_TAG_SORT_SUFFIX
)
self.assertEqual(
tags,
[
"v0.6.3a1",
"v0.6.4",
"v0.6.5a1",
"v0.6.5a2",
"v0.6.5a3",
"v0.6.5b1",
"v0.6.5rc1",
"v0.6.5",
"v1.0.0",
],
)
def test_git_status(self):
with temp_git_repository() as tmp_git:
tracked_file = tmp_git / "foo.json"
tracked_file.write_text("sed diam nonumy eirmod", encoding="utf8")
changed_file = tmp_git / "bar.json"
changed_file.touch()
staged_changed_file = tmp_git / "ipsum.json"
staged_changed_file.write_text("tempor invidunt ut labore")
removed_file = tmp_git / "lorem.json"
removed_file.write_text(
"consetetur sadipscing elitr", encoding="utf8"
)
renamed_file = tmp_git / "foo.md"
renamed_file.write_text(
"et dolore magna aliquyam erat", encoding="utf8"
)
git = Git(tmp_git)
git.config("commit.gpgSign", "false", scope=ConfigScope.LOCAL)
git.add(
[
tracked_file,
changed_file,
staged_changed_file,
removed_file,
renamed_file,
]
)
git.commit("Some commit")
changed_file.write_text("Lorem Ipsum", encoding="utf8")
staged_changed_file.write_text("Lorem Ipsum", encoding="utf8")
added_file = tmp_git / "foo.txt"
added_file.touch()
added_modified_file = tmp_git / "ipsum.txt"
added_modified_file.touch()
git.add([added_file, staged_changed_file, added_modified_file])
staged_changed_file.write_text("Dolor sit", encoding="utf8")
added_modified_file.write_text("Lorem Ipsum", encoding="utf8")
git.move(renamed_file, "foo.rst")
git.remove(removed_file)
untracked_file = tmp_git / "bar.txt"
untracked_file.touch()
it = git.status()
status = next(it)
self.assertEqual(status.index, Status.UNMODIFIED)
self.assertEqual(status.working_tree, Status.MODIFIED)
self.assertEqual(status.path, Path("bar.json"))
status = next(it)
self.assertEqual(status.index, Status.RENAMED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("foo.rst"))
self.assertEqual(status.old_path, Path("foo.md"))
status = next(it)
self.assertEqual(status.index, Status.ADDED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("foo.txt"))
status = next(it)
self.assertEqual(status.index, Status.MODIFIED)
self.assertEqual(status.working_tree, Status.MODIFIED)
self.assertEqual(status.path, Path("ipsum.json"))
status = next(it)
self.assertEqual(status.index, Status.ADDED)
self.assertEqual(status.working_tree, Status.MODIFIED)
self.assertEqual(status.path, Path("ipsum.txt"))
status = next(it)
self.assertEqual(status.index, Status.DELETED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("lorem.json"))
with self.assertRaises(StopIteration):
next(it)
def test_git_error(self):
with (
temp_directory(change_into=True),
self.assertRaises(GitError) as cm,
):
Git().log()
self.assertEqual(cm.exception.returncode, 128)
self.assertEqual(
cm.exception.stderr,
"fatal: not a git repository (or any of the parent directories): "
".git\n",
)
self.assertEqual(cm.exception.stdout, "")
self.assertEqual(cm.exception.cmd, ["git", "log"])
pontos-25.3.2/tests/git/test_status.py 0000664 0000000 0000000 00000006776 14762555663 0020051 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import os
import unittest
from pathlib import Path
from pontos.git._status import Status, StatusEntry, parse_git_status
class StatusEntryTestCase(unittest.TestCase):
def test_parse_modified_modified(self):
status = StatusEntry("MM foo.txt")
self.assertEqual(status.index, Status.MODIFIED)
self.assertEqual(status.working_tree, Status.MODIFIED)
self.assertEqual(status.path, Path("foo.txt"))
def test_parse_modified_unmodified(self):
status = StatusEntry("M foo.txt")
self.assertEqual(status.index, Status.MODIFIED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("foo.txt"))
def test_parse_deleted(self):
status = StatusEntry("D foo.txt")
self.assertEqual(status.index, Status.DELETED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("foo.txt"))
def test_parse_added(self):
status = StatusEntry("A foo.txt")
self.assertEqual(status.index, Status.ADDED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("foo.txt"))
def test_parse_untracked(self):
status = StatusEntry("?? foo.txt")
self.assertEqual(status.index, Status.UNTRACKED)
self.assertEqual(status.working_tree, Status.UNTRACKED)
self.assertEqual(status.path, Path("foo.txt"))
def test_parse_ignored_untracked(self):
status = StatusEntry("!? foo.txt")
self.assertEqual(status.index, Status.IGNORED)
self.assertEqual(status.working_tree, Status.UNTRACKED)
self.assertEqual(status.path, Path("foo.txt"))
def test_pathlike(self):
status = StatusEntry("MM foo.txt")
self.assertEqual(os.fspath(status), "foo.txt")
class ParseGitStatusTestCase(unittest.TestCase):
def test_parse_git_status(self):
output = (
b" M bar.json\x00R foo.rst\x00foo.md\x00A foo.txt\x00"
b"MM ipsum.json\x00AM ipsum.txt\x00D lorem.json\x00"
)
it = parse_git_status(output.decode("utf-8"))
status = next(it)
self.assertEqual(status.index, Status.UNMODIFIED)
self.assertEqual(status.working_tree, Status.MODIFIED)
self.assertEqual(status.path, Path("bar.json"))
status = next(it)
self.assertEqual(status.index, Status.RENAMED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("foo.rst"))
self.assertEqual(status.old_path, Path("foo.md"))
status = next(it)
self.assertEqual(status.index, Status.ADDED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("foo.txt"))
status = next(it)
self.assertEqual(status.index, Status.MODIFIED)
self.assertEqual(status.working_tree, Status.MODIFIED)
self.assertEqual(status.path, Path("ipsum.json"))
status = next(it)
self.assertEqual(status.index, Status.ADDED)
self.assertEqual(status.working_tree, Status.MODIFIED)
self.assertEqual(status.path, Path("ipsum.txt"))
status = next(it)
self.assertEqual(status.index, Status.DELETED)
self.assertEqual(status.working_tree, Status.UNMODIFIED)
self.assertEqual(status.path, Path("lorem.json"))
with self.assertRaises(StopIteration):
next(it)
pontos-25.3.2/tests/github/ 0000775 0000000 0000000 00000000000 14762555663 0015574 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/github/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0017701 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/github/actions/ 0000775 0000000 0000000 00000000000 14762555663 0017234 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/github/actions/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0021341 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/github/actions/test-pull-request-event.json 0000664 0000000 0000000 00000071674 14762555663 0024704 0 ustar 00root root 0000000 0000000 {
"action": "labeled",
"label": {
"color": "a2eeef",
"default": true,
"description": "New feature or request",
"id": 3665050984,
"name": "enhancement",
"node_id": "LA_kwDOGkcHwM7adD1o",
"url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/labels/enhancement"
},
"number": 1,
"pull_request": {
"_links": {
"comments": {
"href": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/1/comments"
},
"commits": {
"href": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls/1/commits"
},
"html": {
"href": "https://github.com/bjoernricks/pull-request-backport-action/pull/1"
},
"issue": {
"href": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/1"
},
"review_comment": {
"href": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls/comments{/number}"
},
"review_comments": {
"href": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls/1/comments"
},
"self": {
"href": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls/1"
},
"statuses": {
"href": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/statuses/beeecfeee02f5a9e69c1f69dba6757df6e5c20f7"
}
},
"active_lock_reason": null,
"additions": 25,
"assignee": null,
"assignees": [],
"author_association": "OWNER",
"auto_merge": null,
"base": {
"label": "bjoernricks:main",
"ref": "main",
"repo": {
"allow_auto_merge": false,
"allow_forking": true,
"allow_merge_commit": true,
"allow_rebase_merge": true,
"allow_squash_merge": true,
"allow_update_branch": false,
"archive_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/{archive_format}{/ref}",
"archived": false,
"assignees_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/assignees{/user}",
"blobs_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/branches{/branch}",
"clone_url": "https://github.com/bjoernricks/pull-request-backport-action.git",
"collaborators_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/comments{/number}",
"commits_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/commits{/sha}",
"compare_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/contents/{+path}",
"contributors_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/contributors",
"created_at": "2021-12-22T13:13:11Z",
"default_branch": "main",
"delete_branch_on_merge": false,
"deployments_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/deployments",
"description": null,
"disabled": false,
"downloads_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/downloads",
"events_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/events",
"fork": false,
"forks": 0,
"forks_count": 0,
"forks_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/forks",
"full_name": "bjoernricks/pull-request-backport-action",
"git_commits_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/tags{/sha}",
"git_url": "git://github.com/bjoernricks/pull-request-backport-action.git",
"has_downloads": true,
"has_issues": true,
"has_pages": false,
"has_projects": true,
"has_wiki": true,
"homepage": null,
"hooks_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/hooks",
"html_url": "https://github.com/bjoernricks/pull-request-backport-action",
"id": 440862656,
"is_template": false,
"issue_comment_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/events{/number}",
"issues_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues{/number}",
"keys_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/keys{/key_id}",
"labels_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/labels{/name}",
"language": "Python",
"languages_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/languages",
"license": {
"key": "gpl-3.0",
"name": "GNU General Public License v3.0",
"node_id": "MDc6TGljZW5zZTk=",
"spdx_id": "GPL-3.0",
"url": "https://api.github.com/licenses/gpl-3.0"
},
"merges_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/merges",
"milestones_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/milestones{/number}",
"mirror_url": null,
"name": "pull-request-backport-action",
"node_id": "R_kgDOGkcHwA",
"notifications_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/notifications{?since,all,participating}",
"open_issues": 1,
"open_issues_count": 1,
"owner": {
"avatar_url": "https://avatars.githubusercontent.com/u/897575?v=4",
"events_url": "https://api.github.com/users/bjoernricks/events{/privacy}",
"followers_url": "https://api.github.com/users/bjoernricks/followers",
"following_url": "https://api.github.com/users/bjoernricks/following{/other_user}",
"gists_url": "https://api.github.com/users/bjoernricks/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/bjoernricks",
"id": 897575,
"login": "bjoernricks",
"node_id": "MDQ6VXNlcjg5NzU3NQ==",
"organizations_url": "https://api.github.com/users/bjoernricks/orgs",
"received_events_url": "https://api.github.com/users/bjoernricks/received_events",
"repos_url": "https://api.github.com/users/bjoernricks/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/bjoernricks/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/bjoernricks/subscriptions",
"type": "User",
"url": "https://api.github.com/users/bjoernricks"
},
"private": false,
"pulls_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls{/number}",
"pushed_at": "2021-12-23T06:59:02Z",
"releases_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/releases{/id}",
"size": 41,
"ssh_url": "git@github.com:bjoernricks/pull-request-backport-action.git",
"stargazers_count": 0,
"stargazers_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/stargazers",
"statuses_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/subscribers",
"subscription_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/subscription",
"svn_url": "https://github.com/bjoernricks/pull-request-backport-action",
"tags_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/tags",
"teams_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/teams",
"topics": [],
"trees_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/trees{/sha}",
"updated_at": "2021-12-22T17:28:48Z",
"url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action",
"visibility": "public",
"watchers": 0,
"watchers_count": 0
},
"sha": "50c0fbe90d0c19dba08165b707e8b720d604ed5d",
"user": {
"avatar_url": "https://avatars.githubusercontent.com/u/897575?v=4",
"events_url": "https://api.github.com/users/bjoernricks/events{/privacy}",
"followers_url": "https://api.github.com/users/bjoernricks/followers",
"following_url": "https://api.github.com/users/bjoernricks/following{/other_user}",
"gists_url": "https://api.github.com/users/bjoernricks/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/bjoernricks",
"id": 897575,
"login": "bjoernricks",
"node_id": "MDQ6VXNlcjg5NzU3NQ==",
"organizations_url": "https://api.github.com/users/bjoernricks/orgs",
"received_events_url": "https://api.github.com/users/bjoernricks/received_events",
"repos_url": "https://api.github.com/users/bjoernricks/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/bjoernricks/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/bjoernricks/subscriptions",
"type": "User",
"url": "https://api.github.com/users/bjoernricks"
}
},
"body": null,
"changed_files": 3,
"closed_at": null,
"comments": 0,
"comments_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/1/comments",
"commits": 3,
"commits_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls/1/commits",
"created_at": "2021-12-23T06:45:17Z",
"deletions": 1,
"diff_url": "https://github.com/bjoernricks/pull-request-backport-action/pull/1.diff",
"draft": false,
"head": {
"label": "bjoernricks:label-test",
"ref": "label-test",
"repo": {
"allow_auto_merge": false,
"allow_forking": true,
"allow_merge_commit": true,
"allow_rebase_merge": true,
"allow_squash_merge": true,
"allow_update_branch": false,
"archive_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/{archive_format}{/ref}",
"archived": false,
"assignees_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/assignees{/user}",
"blobs_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/branches{/branch}",
"clone_url": "https://github.com/bjoernricks/pull-request-backport-action.git",
"collaborators_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/comments{/number}",
"commits_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/commits{/sha}",
"compare_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/contents/{+path}",
"contributors_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/contributors",
"created_at": "2021-12-22T13:13:11Z",
"default_branch": "main",
"delete_branch_on_merge": false,
"deployments_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/deployments",
"description": null,
"disabled": false,
"downloads_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/downloads",
"events_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/events",
"fork": false,
"forks": 0,
"forks_count": 0,
"forks_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/forks",
"full_name": "bjoernricks/pull-request-backport-action",
"git_commits_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/tags{/sha}",
"git_url": "git://github.com/bjoernricks/pull-request-backport-action.git",
"has_downloads": true,
"has_issues": true,
"has_pages": false,
"has_projects": true,
"has_wiki": true,
"homepage": null,
"hooks_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/hooks",
"html_url": "https://github.com/bjoernricks/pull-request-backport-action",
"id": 440862656,
"is_template": false,
"issue_comment_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/events{/number}",
"issues_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues{/number}",
"keys_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/keys{/key_id}",
"labels_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/labels{/name}",
"language": "Python",
"languages_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/languages",
"license": {
"key": "gpl-3.0",
"name": "GNU General Public License v3.0",
"node_id": "MDc6TGljZW5zZTk=",
"spdx_id": "GPL-3.0",
"url": "https://api.github.com/licenses/gpl-3.0"
},
"merges_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/merges",
"milestones_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/milestones{/number}",
"mirror_url": null,
"name": "pull-request-backport-action",
"node_id": "R_kgDOGkcHwA",
"notifications_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/notifications{?since,all,participating}",
"open_issues": 1,
"open_issues_count": 1,
"owner": {
"avatar_url": "https://avatars.githubusercontent.com/u/897575?v=4",
"events_url": "https://api.github.com/users/bjoernricks/events{/privacy}",
"followers_url": "https://api.github.com/users/bjoernricks/followers",
"following_url": "https://api.github.com/users/bjoernricks/following{/other_user}",
"gists_url": "https://api.github.com/users/bjoernricks/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/bjoernricks",
"id": 897575,
"login": "bjoernricks",
"node_id": "MDQ6VXNlcjg5NzU3NQ==",
"organizations_url": "https://api.github.com/users/bjoernricks/orgs",
"received_events_url": "https://api.github.com/users/bjoernricks/received_events",
"repos_url": "https://api.github.com/users/bjoernricks/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/bjoernricks/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/bjoernricks/subscriptions",
"type": "User",
"url": "https://api.github.com/users/bjoernricks"
},
"private": false,
"pulls_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls{/number}",
"pushed_at": "2021-12-23T06:59:02Z",
"releases_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/releases{/id}",
"size": 41,
"ssh_url": "git@github.com:bjoernricks/pull-request-backport-action.git",
"stargazers_count": 0,
"stargazers_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/stargazers",
"statuses_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/subscribers",
"subscription_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/subscription",
"svn_url": "https://github.com/bjoernricks/pull-request-backport-action",
"tags_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/tags",
"teams_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/teams",
"topics": [],
"trees_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/trees{/sha}",
"updated_at": "2021-12-22T17:28:48Z",
"url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action",
"visibility": "public",
"watchers": 0,
"watchers_count": 0
},
"sha": "beeecfeee02f5a9e69c1f69dba6757df6e5c20f7",
"user": {
"avatar_url": "https://avatars.githubusercontent.com/u/897575?v=4",
"events_url": "https://api.github.com/users/bjoernricks/events{/privacy}",
"followers_url": "https://api.github.com/users/bjoernricks/followers",
"following_url": "https://api.github.com/users/bjoernricks/following{/other_user}",
"gists_url": "https://api.github.com/users/bjoernricks/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/bjoernricks",
"id": 897575,
"login": "bjoernricks",
"node_id": "MDQ6VXNlcjg5NzU3NQ==",
"organizations_url": "https://api.github.com/users/bjoernricks/orgs",
"received_events_url": "https://api.github.com/users/bjoernricks/received_events",
"repos_url": "https://api.github.com/users/bjoernricks/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/bjoernricks/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/bjoernricks/subscriptions",
"type": "User",
"url": "https://api.github.com/users/bjoernricks"
}
},
"html_url": "https://github.com/bjoernricks/pull-request-backport-action/pull/1",
"id": 808914229,
"issue_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/1",
"labels": [
{
"color": "a2eeef",
"default": true,
"description": "New feature or request",
"id": 3665050984,
"name": "enhancement",
"node_id": "LA_kwDOGkcHwM7adD1o",
"url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/labels/enhancement"
}
],
"locked": false,
"maintainer_can_modify": false,
"merge_commit_sha": "0e34b424155397fe4cfc6a52db4b4c4a7961db79",
"mergeable": true,
"mergeable_state": "unstable",
"merged": false,
"merged_at": null,
"merged_by": null,
"milestone": null,
"node_id": "PR_kwDOGkcHwM4wNw01",
"number": 1,
"patch_url": "https://github.com/bjoernricks/pull-request-backport-action/pull/1.patch",
"rebaseable": true,
"requested_reviewers": [],
"requested_teams": [],
"review_comment_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls/comments{/number}",
"review_comments": 0,
"review_comments_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls/1/comments",
"state": "open",
"statuses_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/statuses/beeecfeee02f5a9e69c1f69dba6757df6e5c20f7",
"title": "Add foo for bar",
"updated_at": "2021-12-23T06:59:30Z",
"url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls/1",
"user": {
"avatar_url": "https://avatars.githubusercontent.com/u/897575?v=4",
"events_url": "https://api.github.com/users/bjoernricks/events{/privacy}",
"followers_url": "https://api.github.com/users/bjoernricks/followers",
"following_url": "https://api.github.com/users/bjoernricks/following{/other_user}",
"gists_url": "https://api.github.com/users/bjoernricks/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/bjoernricks",
"id": 897575,
"login": "bjoernricks",
"node_id": "MDQ6VXNlcjg5NzU3NQ==",
"organizations_url": "https://api.github.com/users/bjoernricks/orgs",
"received_events_url": "https://api.github.com/users/bjoernricks/received_events",
"repos_url": "https://api.github.com/users/bjoernricks/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/bjoernricks/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/bjoernricks/subscriptions",
"type": "User",
"url": "https://api.github.com/users/bjoernricks"
}
},
"repository": {
"allow_forking": true,
"archive_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/{archive_format}{/ref}",
"archived": false,
"assignees_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/assignees{/user}",
"blobs_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/branches{/branch}",
"clone_url": "https://github.com/bjoernricks/pull-request-backport-action.git",
"collaborators_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/comments{/number}",
"commits_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/commits{/sha}",
"compare_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/contents/{+path}",
"contributors_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/contributors",
"created_at": "2021-12-22T13:13:11Z",
"default_branch": "main",
"deployments_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/deployments",
"description": null,
"disabled": false,
"downloads_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/downloads",
"events_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/events",
"fork": false,
"forks": 0,
"forks_count": 0,
"forks_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/forks",
"full_name": "bjoernricks/pull-request-backport-action",
"git_commits_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/tags{/sha}",
"git_url": "git://github.com/bjoernricks/pull-request-backport-action.git",
"has_downloads": true,
"has_issues": true,
"has_pages": false,
"has_projects": true,
"has_wiki": true,
"homepage": null,
"hooks_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/hooks",
"html_url": "https://github.com/bjoernricks/pull-request-backport-action",
"id": 440862656,
"is_template": false,
"issue_comment_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues/events{/number}",
"issues_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/issues{/number}",
"keys_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/keys{/key_id}",
"labels_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/labels{/name}",
"language": "Python",
"languages_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/languages",
"license": {
"key": "gpl-3.0",
"name": "GNU General Public License v3.0",
"node_id": "MDc6TGljZW5zZTk=",
"spdx_id": "GPL-3.0",
"url": "https://api.github.com/licenses/gpl-3.0"
},
"merges_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/merges",
"milestones_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/milestones{/number}",
"mirror_url": null,
"name": "pull-request-backport-action",
"node_id": "R_kgDOGkcHwA",
"notifications_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/notifications{?since,all,participating}",
"open_issues": 1,
"open_issues_count": 1,
"owner": {
"avatar_url": "https://avatars.githubusercontent.com/u/897575?v=4",
"events_url": "https://api.github.com/users/bjoernricks/events{/privacy}",
"followers_url": "https://api.github.com/users/bjoernricks/followers",
"following_url": "https://api.github.com/users/bjoernricks/following{/other_user}",
"gists_url": "https://api.github.com/users/bjoernricks/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/bjoernricks",
"id": 897575,
"login": "bjoernricks",
"node_id": "MDQ6VXNlcjg5NzU3NQ==",
"organizations_url": "https://api.github.com/users/bjoernricks/orgs",
"received_events_url": "https://api.github.com/users/bjoernricks/received_events",
"repos_url": "https://api.github.com/users/bjoernricks/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/bjoernricks/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/bjoernricks/subscriptions",
"type": "User",
"url": "https://api.github.com/users/bjoernricks"
},
"private": false,
"pulls_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/pulls{/number}",
"pushed_at": "2021-12-23T06:59:02Z",
"releases_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/releases{/id}",
"size": 41,
"ssh_url": "git@github.com:bjoernricks/pull-request-backport-action.git",
"stargazers_count": 0,
"stargazers_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/stargazers",
"statuses_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/subscribers",
"subscription_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/subscription",
"svn_url": "https://github.com/bjoernricks/pull-request-backport-action",
"tags_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/tags",
"teams_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/teams",
"topics": [],
"trees_url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action/git/trees{/sha}",
"updated_at": "2021-12-22T17:28:48Z",
"url": "https://api.github.com/repos/bjoernricks/pull-request-backport-action",
"visibility": "public",
"watchers": 0,
"watchers_count": 0
},
"sender": {
"avatar_url": "https://avatars.githubusercontent.com/u/897575?v=4",
"events_url": "https://api.github.com/users/bjoernricks/events{/privacy}",
"followers_url": "https://api.github.com/users/bjoernricks/followers",
"following_url": "https://api.github.com/users/bjoernricks/following{/other_user}",
"gists_url": "https://api.github.com/users/bjoernricks/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/bjoernricks",
"id": 897575,
"login": "bjoernricks",
"node_id": "MDQ6VXNlcjg5NzU3NQ==",
"organizations_url": "https://api.github.com/users/bjoernricks/orgs",
"received_events_url": "https://api.github.com/users/bjoernricks/received_events",
"repos_url": "https://api.github.com/users/bjoernricks/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/bjoernricks/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/bjoernricks/subscriptions",
"type": "User",
"url": "https://api.github.com/users/bjoernricks"
}
}
pontos-25.3.2/tests/github/actions/test_core.py 0000664 0000000 0000000 00000012616 14762555663 0021603 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from unittest.mock import patch
from pontos.github.actions.core import ActionIO, Console
from pontos.github.actions.errors import GitHubActionsError
from pontos.testing import temp_directory
@patch("builtins.print")
class ConsoleTestCase(unittest.TestCase):
def test_start_group(self, print_mock):
Console.start_group("Foo")
print_mock.assert_called_once_with("::group::Foo")
def test_end_group(self, print_mock):
Console.end_group()
print_mock.assert_called_once_with("::endgroup::")
def test_group(self, print_mock):
with Console.group("Foo"):
print_mock.assert_called_once_with("::group::Foo")
print_mock.assert_called_with("::endgroup::")
def test_warning(self, print_mock):
Console.warning(
"foo",
name="bar",
line="123",
end_line="234",
column="1",
end_column="2",
title="Foo Bar",
)
print_mock.assert_called_once_with(
"::warning file=bar,line=123,endLine=234,col=1,endColumn=2,title=Foo Bar::foo" # pylint: disable=line-too-long # noqa: E501
)
def test_error(self, print_mock):
Console.error(
"foo",
name="bar",
line="123",
end_line="234",
column="1",
end_column="2",
title="Foo Bar",
)
print_mock.assert_called_once_with(
"::error file=bar,line=123,endLine=234,col=1,endColumn=2,title=Foo Bar::foo" # pylint: disable=line-too-long # noqa: E501
)
def test_notice(self, print_mock):
Console.notice(
"foo",
name="bar",
line="123",
end_line="234",
column="1",
end_column="2",
title="Foo Bar",
)
print_mock.assert_called_once_with(
"::notice file=bar,line=123,endLine=234,col=1,endColumn=2,title=Foo Bar::foo" # pylint: disable=line-too-long # noqa: E501
)
def test_log(self, print_mock):
Console.log("foo")
print_mock.assert_called_once_with("foo")
def test_debug(self, print_mock):
Console.debug("foo")
print_mock.assert_called_once_with("::debug::foo")
class ActionIOTestCase(unittest.TestCase):
@patch.dict(
"os.environ", {"INPUT_FOO": "1234", "INPUT_FOO_BAR": "2345"}, clear=True
)
def test_input(self):
self.assertEqual(ActionIO.input("foo"), "1234")
self.assertEqual(ActionIO.input("FOO"), "1234")
self.assertEqual(ActionIO.input("FoO"), "1234")
self.assertEqual(ActionIO.input("foo bar"), "2345")
self.assertEqual(ActionIO.input("FOO_BAR"), "2345")
self.assertEqual(ActionIO.input("FoO BaR"), "2345")
def test_output(self):
with temp_directory() as temp_dir:
file_path = temp_dir / "github.output"
with patch.dict(
"os.environ", {"GITHUB_OUTPUT": str(file_path)}, clear=True
):
ActionIO.output("foo", "bar")
ActionIO.output("lorem", "ipsum")
output = file_path.read_text(encoding="utf8")
self.assertEqual(output, "foo=bar\nlorem=ipsum\n")
@patch("uuid.uuid1")
def test_multiline_output(self, uuid_mock):
deadbeef = "deadbeef"
name = "foo"
ml_string = """bar
baz
boing"""
expected_output = f"{name}<<{deadbeef}{ml_string}{deadbeef}"
uuid_mock.return_value = deadbeef
with temp_directory() as temp_dir:
file_path = temp_dir / "github.output"
with patch.dict(
"os.environ", {"GITHUB_OUTPUT": str(file_path)}, clear=True
):
ActionIO.multiline_output("foo", ml_string)
output = file_path.read_text(encoding="utf8")
self.assertEqual(output, expected_output)
@patch.dict("os.environ", {}, clear=True)
def test_output_no_env(self):
with self.assertRaises(GitHubActionsError):
ActionIO.output("foo", "bar")
@patch.dict("os.environ", {"GITHUB_OUTPUT": ""}, clear=True)
def test_output_empty_env(self):
with self.assertRaises(GitHubActionsError):
ActionIO.output("foo", "bar")
@patch.dict("os.environ", {}, clear=True)
def test_no_github_output(self):
self.assertFalse(ActionIO.has_output())
@patch.dict(
"os.environ", {"GITHUB_OUTPUT": "/foo/github.output"}, clear=True
)
def test_has_github_output(self):
self.assertTrue(ActionIO.has_output())
def test_out(self):
with temp_directory() as temp_dir:
outfile = temp_dir / "github.output"
with patch.dict(
"os.environ",
{"GITHUB_OUTPUT": str(outfile.absolute())},
clear=True,
):
with ActionIO.out() as output:
output.write("foo", "bar")
self.assertEqual(outfile.read_text(encoding="utf8"), "foo=bar\n")
@patch.dict("os.environ", {}, clear=True)
def test_out_failure(self):
with self.assertRaisesRegex(
GitHubActionsError,
"GITHUB_OUTPUT environment variable not set. Can't write "
"action output.",
):
with ActionIO.out():
pass
pontos-25.3.2/tests/github/actions/test_env.py 0000664 0000000 0000000 00000005543 14762555663 0021444 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pathlib import Path
from unittest.mock import patch
from pontos.github.actions.env import GitHubEnvironment
class GitHubEnvironmentTestCase(unittest.TestCase):
@patch.dict("os.environ", {"GITHUB_WORKSPACE": "/foo/bar"}, clear=True)
def test_workspace(self):
env = GitHubEnvironment()
self.assertEqual(env.workspace, Path("/foo/bar"))
@patch.dict("os.environ", {"GITHUB_REPOSITORY": "foo/bar"}, clear=True)
def test_repository(self):
env = GitHubEnvironment()
self.assertEqual(env.repository, "foo/bar")
@patch.dict("os.environ", {"GITHUB_SHA": "123456"}, clear=True)
def test_sha(self):
env = GitHubEnvironment()
self.assertEqual(env.sha, "123456")
@patch.dict("os.environ", {"GITHUB_REF": "ref/branches/main"}, clear=True)
def test_ref(self):
env = GitHubEnvironment()
self.assertEqual(env.ref, "ref/branches/main")
@patch.dict("os.environ", {"GITHUB_REF_NAME": "main"}, clear=True)
def test_ref_name(self):
env = GitHubEnvironment()
self.assertEqual(env.ref_name, "main")
@patch.dict("os.environ", {"GITHUB_EVENT_PATH": "/foo/bar"}, clear=True)
def test_event_path(self):
env = GitHubEnvironment()
self.assertEqual(env.event_path, Path("/foo/bar"))
@patch.dict("os.environ", {"GITHUB_HEAD_REF": "foo"}, clear=True)
def test_head_ref(self):
env = GitHubEnvironment()
self.assertEqual(env.head_ref, "foo")
@patch.dict("os.environ", {"GITHUB_BASE_REF": "main"}, clear=True)
def test_base_ref(self):
env = GitHubEnvironment()
self.assertEqual(env.base_ref, "main")
@patch.dict(
"os.environ", {"GITHUB_API_URL": "https://api.github.com"}, clear=True
)
def test_api_url(self):
env = GitHubEnvironment()
self.assertEqual(env.api_url, "https://api.github.com")
@patch.dict("os.environ", {"GITHUB_ACTOR": "greenbonebot"}, clear=True)
def test_actor(self):
env = GitHubEnvironment()
self.assertEqual(env.actor, "greenbonebot")
@patch.dict("os.environ", {"GITHUB_RUN_ID": "12345"}, clear=True)
def test_run_id(self):
env = GitHubEnvironment()
self.assertEqual(env.run_id, "12345")
@patch.dict("os.environ", {"GITHUB_ACTION": "54321"}, clear=True)
def test_action_id(self):
env = GitHubEnvironment()
self.assertEqual(env.action_id, "54321")
@patch.dict("os.environ", {"RUNNER_DEBUG": "1"}, clear=True)
def test_is_debug_enabled(self):
env = GitHubEnvironment()
self.assertTrue(env.is_debug)
@patch.dict("os.environ", {"RUNNER_DEBUG": ""}, clear=True)
def test_is_debug_disabled(self):
env = GitHubEnvironment()
self.assertFalse(env.is_debug)
pontos-25.3.2/tests/github/actions/test_event.py 0000664 0000000 0000000 00000002666 14762555663 0022000 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pathlib import Path
from pontos.github.actions.event import GitHubEvent, PullRequestState
here = Path(__file__).parent
class GitHubPullRequestEventTestCase(unittest.TestCase):
def setUp(self) -> None:
event_path = Path(here / "test-pull-request-event.json")
event = GitHubEvent(event_path)
self.pull_request = event.pull_request
def test_draft(self):
self.assertFalse(self.pull_request.draft)
def test_labels(self):
self.assertEqual(len(self.pull_request.labels), 1)
self.assertEqual(self.pull_request.labels[0].name, "enhancement")
def test_number(self):
self.assertEqual(self.pull_request.number, 1)
def test_title(self):
self.assertEqual(self.pull_request.title, "Add foo for bar")
def test_state(self):
self.assertEqual(self.pull_request.state, PullRequestState.OPEN)
def test_base(self):
base = self.pull_request.base
self.assertEqual(base.name, "main")
self.assertEqual(base.sha, "50c0fbe90d0c19dba08165b707e8b720d604ed5d")
def test_head(self):
head = self.pull_request.head
self.assertEqual(head.name, "label-test")
self.assertEqual(head.sha, "beeecfeee02f5a9e69c1f69dba6757df6e5c20f7")
def test_merged(self):
self.assertEqual(self.pull_request.merged, False)
pontos-25.3.2/tests/github/api/ 0000775 0000000 0000000 00000000000 14762555663 0016345 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/github/api/__init__.py 0000664 0000000 0000000 00000001145 14762555663 0020457 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from unittest.mock import MagicMock
import httpx
from pontos.github.api.client import GitHubAsyncREST, GitHubAsyncRESTClient
from tests import AsyncMock, IsolatedAsyncioTestCase
def create_response(*args, **kwargs) -> MagicMock:
return MagicMock(spec=httpx.Response, *args, **kwargs)
class GitHubAsyncRESTTestCase(IsolatedAsyncioTestCase):
api_cls = GitHubAsyncREST
def setUp(self) -> None:
self.client = AsyncMock(spec=GitHubAsyncRESTClient)
self.api = self.api_cls(self.client)
pontos-25.3.2/tests/github/api/pr-files.json 0000664 0000000 0000000 00000047065 14762555663 0020775 0 ustar 00root root 0000000 0000000 [
{
"sha": "cad83468a60da7af39549d2ac07b86b51563618e",
"filename": "gvm/protocols/gmpv2110/__init__.py",
"status": "modified",
"additions": 2,
"deletions": 1,
"changes": 3,
"blob_url": "https://github.com/greenbone/python-gvm/blob/63b99dab803c778eff05783025334a61e58614e7/gvm/protocols/gmpv2110/__init__.py",
"raw_url": "https://github.com/greenbone/python-gvm/raw/63b99dab803c778eff05783025334a61e58614e7/gvm/protocols/gmpv2110/__init__.py",
"contents_url": "https://api.github.com/repos/greenbone/python-gvm/contents/gvm/protocols/gmpv2110/__init__.py?ref=63b99dab803c778eff05783025334a61e58614e7",
"patch": "@@ -127,9 +127,10 @@\n AliveTest,\n TargetsMixin,\n )\n-from gvm.protocols.gmpv214.entities.users import UsersMixin\n \n # NEW IN 2110\n+from gvm.protocols.gmpv2110.entities.users import UsersMixin\n+\n from gvm.protocols.gmpv2110.system.version import VersionMixin\n \n from gvm.connections import GvmConnection"
},
{
"sha": "f22f0818d145afaa3031fee6b85a434768b3d0ce",
"filename": "gvm/protocols/gmpv2110/entities/users.py",
"status": "added",
"additions": 191,
"deletions": 0,
"changes": 191,
"blob_url": "https://github.com/greenbone/python-gvm/blob/63b99dab803c778eff05783025334a61e58614e7/gvm/protocols/gmpv2110/entities/users.py",
"raw_url": "https://github.com/greenbone/python-gvm/raw/63b99dab803c778eff05783025334a61e58614e7/gvm/protocols/gmpv2110/entities/users.py",
"contents_url": "https://api.github.com/repos/greenbone/python-gvm/contents/gvm/protocols/gmpv2110/entities/users.py?ref=63b99dab803c778eff05783025334a61e58614e7",
"patch": "@@ -0,0 +1,191 @@\n+# -*- coding: utf-8 -*-\n+# Copyright (C) 2022 Greenbone AG\n+#\n+# SPDX-License-Identifier: GPL-3.0-or-later\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+# pylint: disable=arguments-differ, arguments-renamed\n+\n+from typing import Any, List, Optional\n+\n+from gvm.errors import RequiredArgument\n+from gvm.protocols.gmpv214.entities.users import (\n+ UsersMixin as Gmp214UsersMixin,\n+ UserAuthType,\n+)\n+from gvm.utils import deprecation, to_comma_list, to_bool\n+from gvm.xml import XmlCommand\n+\n+\n+class UsersMixin(Gmp214UsersMixin):\n+ def create_user(\n+ self,\n+ name: str,\n+ *,\n+ password: Optional[str] = None,\n+ hosts: Optional[List[str]] = None,\n+ hosts_allow: Optional[bool] = False,\n+ ifaces: Any = None,\n+ ifaces_allow: Any = None,\n+ role_ids: Optional[List[str]] = None,\n+ ) -> Any:\n+ \"\"\"Create a new user\n+\n+ Arguments:\n+ name: Name of the user\n+ password: Password of the user\n+ hosts: A list of host addresses (IPs, DNS names)\n+ hosts_allow: If True allow only access to passed hosts otherwise\n+ deny access. Default is False for deny hosts.\n+ ifaces: deprecated\n+ ifaces_allow: deprecated\n+ role_ids: A list of role UUIDs for the user\n+\n+ Returns:\n+ The response. See :py:meth:`send_command` for details.\n+ \"\"\"\n+ if not name:\n+ raise RequiredArgument(\n+ function=self.create_user.__name__, argument='name'\n+ )\n+\n+ cmd = XmlCommand(\"create_user\")\n+ cmd.add_element(\"name\", name)\n+\n+ if password:\n+ cmd.add_element(\"password\", password)\n+\n+ if hosts:\n+ cmd.add_element(\n+ \"hosts\",\n+ to_comma_list(hosts),\n+ attrs={\"allow\": to_bool(hosts_allow)},\n+ )\n+\n+ if ifaces is not None:\n+ major, minor = self.get_protocol_version()\n+ deprecation(\n+ \"The ifaces parameter has been removed in GMP\"\n+ f\" version {major}{minor}\"\n+ )\n+\n+ if ifaces_allow is not None:\n+ major, minor = self.get_protocol_version()\n+ deprecation(\n+ \"The ifaces_allow parameter has been removed in GMP\"\n+ f\" version {major}{minor}\"\n+ )\n+\n+ if role_ids:\n+ for role in role_ids:\n+ cmd.add_element(\"role\", attrs={\"id\": role})\n+\n+ return self._send_xml_command(cmd)\n+\n+ def modify_user(\n+ self,\n+ user_id: str = None,\n+ *,\n+ name: Optional[str] = None,\n+ comment: Optional[str] = None,\n+ password: Optional[str] = None,\n+ auth_source: Optional[UserAuthType] = None,\n+ role_ids: Optional[List[str]] = None,\n+ hosts: Optional[List[str]] = None,\n+ hosts_allow: Optional[bool] = False,\n+ ifaces: Any = None,\n+ ifaces_allow: Any = None,\n+ group_ids: Optional[List[str]] = None,\n+ ) -> Any:\n+ \"\"\"Modifies an existing user.\n+\n+ Most of the fields need to be supplied\n+ for changing a single field even if no change is wanted for those.\n+ Else empty values are inserted for the missing fields instead.\n+\n+ Arguments:\n+ user_id: UUID of the user to be modified.\n+ name: The new name for the user.\n+ comment: Comment on the user.\n+ password: The password for the user.\n+ auth_source: Source allowed for authentication for this user.\n+ roles_id: List of roles UUIDs for the user.\n+ hosts: User access rules: List of hosts.\n+ hosts_allow: Defines how the hosts list is to be interpreted.\n+ If False (default) the list is treated as a deny list.\n+ All hosts are allowed by default except those provided by\n+ the hosts parameter. If True the list is treated as a\n+ allow list. All hosts are denied by default except those\n+ provided by the hosts parameter.\n+ ifaces: deprecated\n+ ifaces_allow: deprecated\n+ group_ids: List of group UUIDs for the user.\n+\n+ Returns:\n+ The response. See :py:meth:`send_command` for details.\n+ \"\"\"\n+ if not user_id:\n+ raise RequiredArgument(\n+ function=self.modify_user.__name__, argument='user_id'\n+ )\n+\n+ cmd = XmlCommand(\"modify_user\")\n+\n+ cmd.set_attribute(\"user_id\", user_id)\n+\n+ if name:\n+ cmd.add_element(\"new_name\", name)\n+\n+ if role_ids:\n+ for role in role_ids:\n+ cmd.add_element(\"role\", attrs={\"id\": role})\n+\n+ if hosts:\n+ cmd.add_element(\n+ \"hosts\",\n+ to_comma_list(hosts),\n+ attrs={\"allow\": to_bool(hosts_allow)},\n+ )\n+\n+ if ifaces is not None:\n+ major, minor = self.get_protocol_version()\n+ deprecation(\n+ \"The ifaces parameter has been removed in GMP\"\n+ f\" version {major}{minor}\"\n+ )\n+\n+ if ifaces_allow is not None:\n+ major, minor = self.get_protocol_version()\n+ deprecation(\n+ \"The ifaces_allow parameter has been removed in GMP\"\n+ f\" version {major}{minor}\"\n+ )\n+\n+ if comment:\n+ cmd.add_element(\"comment\", comment)\n+\n+ if password:\n+ cmd.add_element(\"password\", password)\n+\n+ if auth_source:\n+ _xmlauthsrc = cmd.add_element(\"sources\")\n+ _xmlauthsrc.add_element(\"source\", auth_source.value)\n+\n+ if group_ids:\n+ _xmlgroups = cmd.add_element(\"groups\")\n+ for group_id in group_ids:\n+ _xmlgroups.add_element(\"group\", attrs={\"id\": group_id})\n+\n+ return self._send_xml_command(cmd)"
},
{
"sha": "dd464f0e6f137ed440c141e08957973a03e1317a",
"filename": "tests/protocols/gmpv2110/entities/test_users.py",
"status": "modified",
"additions": 1,
"deletions": 2,
"changes": 3,
"blob_url": "https://github.com/greenbone/python-gvm/blob/63b99dab803c778eff05783025334a61e58614e7/tests/protocols/gmpv2110/entities/test_users.py",
"raw_url": "https://github.com/greenbone/python-gvm/raw/63b99dab803c778eff05783025334a61e58614e7/tests/protocols/gmpv2110/entities/test_users.py",
"contents_url": "https://api.github.com/repos/greenbone/python-gvm/contents/tests/protocols/gmpv2110/entities/test_users.py?ref=63b99dab803c778eff05783025334a61e58614e7",
"patch": "@@ -17,9 +17,8 @@\n # along with this program. If not, see .\n \n from ...gmpv2110 import Gmpv2110TestCase\n-from .users import GmpModifyUserTestMixin\n+from .users import GmpCreateUserTestMixin, GmpModifyUserTestMixin\n from ...gmpv208.entities.users import (\n- GmpCreateUserTestMixin,\n GmpCloneUserTestMixin,\n GmpDeleteUserTestMixin,\n GmpGetUsersTestMixin,"
},
{
"sha": "bc37e6b01a09b2427df50cc7a470f9cef0c1f651",
"filename": "tests/protocols/gmpv2110/entities/users/__init__.py",
"status": "modified",
"additions": 1,
"deletions": 0,
"changes": 1,
"blob_url": "https://github.com/greenbone/python-gvm/blob/63b99dab803c778eff05783025334a61e58614e7/tests/protocols/gmpv2110/entities/users/__init__.py",
"raw_url": "https://github.com/greenbone/python-gvm/raw/63b99dab803c778eff05783025334a61e58614e7/tests/protocols/gmpv2110/entities/users/__init__.py",
"contents_url": "https://api.github.com/repos/greenbone/python-gvm/contents/tests/protocols/gmpv2110/entities/users/__init__.py?ref=63b99dab803c778eff05783025334a61e58614e7",
"patch": "@@ -16,4 +16,5 @@\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n+from .test_create_user import GmpCreateUserTestMixin\n from .test_modify_user import GmpModifyUserTestMixin"
},
{
"sha": "8b9c51973a7667e43aeb77471a63f77b401be838",
"filename": "tests/protocols/gmpv2110/entities/users/test_create_user.py",
"status": "added",
"additions": 122,
"deletions": 0,
"changes": 122,
"blob_url": "https://github.com/greenbone/python-gvm/blob/63b99dab803c778eff05783025334a61e58614e7/tests/protocols/gmpv2110/entities/users/test_create_user.py",
"raw_url": "https://github.com/greenbone/python-gvm/raw/63b99dab803c778eff05783025334a61e58614e7/tests/protocols/gmpv2110/entities/users/test_create_user.py",
"contents_url": "https://api.github.com/repos/greenbone/python-gvm/contents/tests/protocols/gmpv2110/entities/users/test_create_user.py?ref=63b99dab803c778eff05783025334a61e58614e7",
"patch": "@@ -0,0 +1,122 @@\n+# -*- coding: utf-8 -*-\n+# Copyright (C) 2018-2022 Greenbone AG\n+#\n+# SPDX-License-Identifier: GPL-3.0-or-later\n+#\n+# This program is free software: you can redistribute it and/or modify\n+# it under the terms of the GNU General Public License as published by\n+# the Free Software Foundation, either version 3 of the License, or\n+# (at your option) any later version.\n+#\n+# This program is distributed in the hope that it will be useful,\n+# but WITHOUT ANY WARRANTY; without even the implied warranty of\n+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n+# GNU General Public License for more details.\n+#\n+# You should have received a copy of the GNU General Public License\n+# along with this program. If not, see .\n+\n+from unittest.mock import patch, call\n+from gvm.errors import RequiredArgument\n+\n+\n+class GmpCreateUserTestMixin:\n+ def test_create_user_missing_name(self):\n+ with self.assertRaises(RequiredArgument):\n+ self.gmp.create_user(name=None)\n+\n+ with self.assertRaises(RequiredArgument):\n+ self.gmp.create_user(name='')\n+\n+ def test_create_user(self):\n+ self.gmp.create_user(name='foo')\n+\n+ self.connection.send.has_been_called_with(\n+ '' 'foo' ''\n+ )\n+\n+ def test_create_user_with_password(self):\n+ self.gmp.create_user(name='foo', password='bar')\n+\n+ self.connection.send.has_been_called_with(\n+ ''\n+ 'foo'\n+ 'bar'\n+ ''\n+ )\n+\n+ def test_create_user_with_hosts(self):\n+ self.gmp.create_user(name='foo', hosts=['h1', 'h2'], hosts_allow=True)\n+\n+ self.connection.send.has_been_called_with(\n+ ''\n+ 'foo'\n+ 'h1,h2'\n+ ''\n+ )\n+\n+ self.gmp.create_user(name='foo', hosts=['h1', 'h2'])\n+\n+ self.connection.send.has_been_called_with(\n+ ''\n+ 'foo'\n+ 'h1,h2'\n+ ''\n+ )\n+\n+ self.gmp.create_user(name='foo', hosts=['h1', 'h2'], hosts_allow=False)\n+\n+ self.connection.send.has_been_called_with(\n+ ''\n+ 'foo'\n+ 'h1,h2'\n+ ''\n+ )\n+\n+ @patch('gvm.protocols.gmpv2110.entities.users.deprecation')\n+ def test_create_user_with_ifaces(self, deprecation_mock):\n+ self.gmp.create_user(name='foo', ifaces=['h1', 'h2'], ifaces_allow=True)\n+\n+ self.connection.send.has_been_called_with(\n+ '' 'foo' ''\n+ )\n+\n+ self.gmp.create_user(name='foo', ifaces=['h1', 'h2'])\n+\n+ self.connection.send.has_been_called_with(\n+ '' 'foo' ''\n+ )\n+\n+ self.gmp.create_user(\n+ name='foo', ifaces=['h1', 'h2'], ifaces_allow=False\n+ )\n+\n+ self.connection.send.has_been_called_with(\n+ '' 'foo' ''\n+ )\n+\n+ # pylint: disable=line-too-long\n+ deprecation_calls = [\n+ call('The ifaces parameter has been removed in GMP version 2110'),\n+ call(\n+ 'The ifaces_allow parameter has been removed in GMP version 2110'\n+ ),\n+ call('The ifaces parameter has been removed in GMP version 2110'),\n+ call('The ifaces parameter has been removed in GMP version 2110'),\n+ call(\n+ 'The ifaces_allow parameter has been removed in GMP version 2110'\n+ ),\n+ ]\n+ # pylint: enable=line-too-long\n+ deprecation_mock.assert_has_calls(deprecation_calls)\n+\n+ def test_create_user_with_role_ids(self):\n+ self.gmp.create_user(name='foo', role_ids=['r1', 'r2'])\n+\n+ self.connection.send.has_been_called_with(\n+ ''\n+ 'foo'\n+ ''\n+ ''\n+ ''\n+ )"
},
{
"sha": "156d04f50e99207706cd5068c2fb3bdd5930cab5",
"filename": "tests/protocols/gmpv2110/entities/users/test_modify_user.py",
"status": "modified",
"additions": 29,
"deletions": 27,
"changes": 56,
"blob_url": "https://github.com/greenbone/python-gvm/blob/63b99dab803c778eff05783025334a61e58614e7/tests/protocols/gmpv2110/entities/users/test_modify_user.py",
"raw_url": "https://github.com/greenbone/python-gvm/raw/63b99dab803c778eff05783025334a61e58614e7/tests/protocols/gmpv2110/entities/users/test_modify_user.py",
"contents_url": "https://api.github.com/repos/greenbone/python-gvm/contents/tests/protocols/gmpv2110/entities/users/test_modify_user.py?ref=63b99dab803c778eff05783025334a61e58614e7",
"patch": "@@ -16,6 +16,7 @@\n # You should have received a copy of the GNU General Public License\n # along with this program. If not, see .\n \n+from unittest.mock import patch, call\n from gvm.errors import RequiredArgument\n from gvm.protocols.gmpv2110 import UserAuthType\n \n@@ -156,43 +157,44 @@ def test_modify_user_with_hosts(self):\n ''\n )\n \n- def test_modify_user_with_ifaces(self):\n+ @patch('gvm.protocols.gmpv2110.entities.users.deprecation')\n+ def test_modify_user_with_ifaces(self, deprecation_mock):\n self.gmp.modify_user(user_id='u1', ifaces=[])\n \n self.connection.send.has_been_called_with('')\n \n- self.gmp.modify_user(user_id='u1', ifaces=['foo'])\n+ self.gmp.modify_user(user_id='u2', ifaces=['foo'])\n \n- self.connection.send.has_been_called_with(\n- ''\n- 'foo'\n- ''\n- )\n+ self.connection.send.has_been_called_with('')\n \n- self.gmp.modify_user(user_id='u1', ifaces=['foo', 'bar'])\n+ self.gmp.modify_user(user_id='u3', ifaces=['foo', 'bar'])\n \n- self.connection.send.has_been_called_with(\n- ''\n- 'foo,bar'\n- ''\n- )\n+ self.connection.send.has_been_called_with('')\n \n self.gmp.modify_user(\n- user_id='u1', ifaces=['foo', 'bar'], ifaces_allow=False\n+ user_id='u4', ifaces=['foo', 'bar'], ifaces_allow=False\n )\n \n- self.connection.send.has_been_called_with(\n- ''\n- 'foo,bar'\n- ''\n- )\n+ self.connection.send.has_been_called_with('')\n \n self.gmp.modify_user(\n- user_id='u1', ifaces=['foo', 'bar'], ifaces_allow=True\n- )\n-\n- self.connection.send.has_been_called_with(\n- ''\n- 'foo,bar'\n- ''\n- )\n+ user_id='u5', ifaces=['foo', 'bar'], ifaces_allow=True\n+ )\n+\n+ self.connection.send.has_been_called_with('')\n+\n+ # pylint: disable=line-too-long\n+ deprecation_calls = [\n+ call('The ifaces parameter has been removed in GMP version 2110'),\n+ call('The ifaces parameter has been removed in GMP version 2110'),\n+ call('The ifaces parameter has been removed in GMP version 2110'),\n+ call(\n+ 'The ifaces_allow parameter has been removed in GMP version 2110'\n+ ),\n+ call('The ifaces parameter has been removed in GMP version 2110'),\n+ call(\n+ 'The ifaces_allow parameter has been removed in GMP version 2110'\n+ ),\n+ ]\n+ # pylint: enable=line-too-long\n+ deprecation_mock.assert_has_calls(deprecation_calls)"
}
]
pontos-25.3.2/tests/github/api/release-response.json 0000664 0000000 0000000 00000012770 14762555663 0022523 0 ustar 00root root 0000000 0000000 {
"url": "https://api.github.com/repos/greenbone/pontos/releases/52499047",
"assets_url": "https://api.github.com/repos/greenbone/pontos/releases/52499047/assets",
"upload_url": "https://uploads.github.com/repos/greenbone/pontos/releases/52499047/assets{?name,label}",
"html_url": "https://github.com/greenbone/pontos/releases/tag/v21.11.0",
"id": 52499047,
"author": {
"login": "greenbonebot",
"id": 85254666,
"node_id": "MDQ6VXNlcjg1MjU0NjY2",
"avatar_url": "https://avatars.githubusercontent.com/u/85254666?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbonebot",
"html_url": "https://github.com/greenbonebot",
"followers_url": "https://api.github.com/users/greenbonebot/followers",
"following_url": "https://api.github.com/users/greenbonebot/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbonebot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbonebot/subscriptions",
"organizations_url": "https://api.github.com/users/greenbonebot/orgs",
"repos_url": "https://api.github.com/users/greenbonebot/repos",
"events_url": "https://api.github.com/users/greenbonebot/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbonebot/received_events",
"type": "User",
"site_admin": false
},
"node_id": "RE_kwDODyT54s4DIRJn",
"tag_name": "v21.11.0",
"target_commitish": "main",
"name": "pontos 21.11.0",
"draft": false,
"prerelease": false,
"created_at": "2021-11-02T08:21:21Z",
"published_at": "2021-11-02T08:21:24Z",
"assets": [
{
"url": "https://api.github.com/repos/greenbone/pontos/releases/assets/48415828",
"id": 48415828,
"node_id": "RA_kwDODyT54s4C4sRU",
"name": "pontos-21.11.0.tar.gz.asc",
"label": "",
"uploader": {
"login": "greenbonebot",
"id": 85254666,
"node_id": "MDQ6VXNlcjg1MjU0NjY2",
"avatar_url": "https://avatars.githubusercontent.com/u/85254666?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbonebot",
"html_url": "https://github.com/greenbonebot",
"followers_url": "https://api.github.com/users/greenbonebot/followers",
"following_url": "https://api.github.com/users/greenbonebot/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbonebot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbonebot/subscriptions",
"organizations_url": "https://api.github.com/users/greenbonebot/orgs",
"repos_url": "https://api.github.com/users/greenbonebot/repos",
"events_url": "https://api.github.com/users/greenbonebot/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbonebot/received_events",
"type": "User",
"site_admin": false
},
"content_type": "application/octet-stream",
"state": "uploaded",
"size": 833,
"download_count": 1,
"created_at": "2021-11-02T08:21:31Z",
"updated_at": "2021-11-02T08:21:31Z",
"browser_download_url": "https://github.com/greenbone/pontos/releases/download/v21.11.0/pontos-21.11.0.tar.gz.asc"
},
{
"url": "https://api.github.com/repos/greenbone/pontos/releases/assets/48415827",
"id": 48415827,
"node_id": "RA_kwDODyT54s4C4sRT",
"name": "pontos-21.11.0.zip.asc",
"label": "",
"uploader": {
"login": "greenbonebot",
"id": 85254666,
"node_id": "MDQ6VXNlcjg1MjU0NjY2",
"avatar_url": "https://avatars.githubusercontent.com/u/85254666?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbonebot",
"html_url": "https://github.com/greenbonebot",
"followers_url": "https://api.github.com/users/greenbonebot/followers",
"following_url": "https://api.github.com/users/greenbonebot/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbonebot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbonebot/subscriptions",
"organizations_url": "https://api.github.com/users/greenbonebot/orgs",
"repos_url": "https://api.github.com/users/greenbonebot/repos",
"events_url": "https://api.github.com/users/greenbonebot/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbonebot/received_events",
"type": "User",
"site_admin": false
},
"content_type": "application/octet-stream",
"state": "uploaded",
"size": 833,
"download_count": 1,
"created_at": "2021-11-02T08:21:31Z",
"updated_at": "2021-11-02T08:21:31Z",
"browser_download_url": "https://github.com/greenbone/pontos/releases/download/v21.11.0/pontos-21.11.0.zip.asc"
}
],
"tarball_url": "https://api.github.com/repos/greenbone/pontos/tarball/v21.11.0",
"zipball_url": "https://api.github.com/repos/greenbone/pontos/zipball/v21.11.0",
"body": "## [21.11.0] - 2021-11-02\r\n\r\n## Bug Fixes\r\n* Using the regex like this [:-|] is incorrect, because of the special purpose of - in a set. Use [:|-] instead [50479dc](https://github.com/greenbone/pontos/commit/50479dc)\r\n\r\n[21.11.0]: https://github.com/greenbone/pontos/compare/v21.10.2...v21.11.0"
}
pontos-25.3.2/tests/github/api/test_artifacts.py 0000664 0000000 0000000 00000026301 14762555663 0021740 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=redefined-builtin, line-too-long
from pathlib import Path
from unittest.mock import MagicMock
import httpx
from pontos.github.api.artifacts import GitHubAsyncRESTArtifacts
from tests import AsyncIteratorMock, AsyncMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
here = Path(__file__).parent
class GitHubAsyncRESTArtifactsTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTArtifacts
async def test_get(self):
response = create_response()
response.json.return_value = {
"id": 1,
"node_id": "MDg6QXJ0aWZhY3QxMQ==",
"name": "Rails",
"size_in_bytes": 556,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
"expired": False,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332938,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3",
},
}
self.client.get.return_value = response
artifact = await self.api.get("foo/bar", "123")
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/actions/artifacts/123"
)
self.assertEqual(artifact.id, 1)
async def test_get_failure(self):
response = create_response()
self.client.get.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.get("foo/bar", "123")
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/actions/artifacts/123"
)
async def test_get_all(self):
response1 = create_response()
response1.json.return_value = {
"artifacts": [
{
"id": 1,
"node_id": "MDg6QXJ0aWZhY3QxMQ==",
"name": "Rails",
"size_in_bytes": 556,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
"expired": False,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332938,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3",
},
}
]
}
response2 = create_response()
response2.json.return_value = {
"artifacts": [
{
"id": 2,
"node_id": "MDg6QXJ0aWZhY3QxMw==",
"name": "Test output",
"size_in_bytes": 453,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/2",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/2/zip",
"expired": False,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332942,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652",
},
},
{
"id": 3,
"node_id": "MDg6QXJ0aWZhY3QxMw==",
"name": "Test output",
"size_in_bytes": 123,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/3",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/3/zip",
"expired": False,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332942,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652",
},
},
]
}
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.get_all("foo/bar"))
artifact = await anext(async_it)
self.assertEqual(artifact.id, 1)
artifact = await anext(async_it)
self.assertEqual(artifact.id, 2)
artifact = await anext(async_it)
self.assertEqual(artifact.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/actions/artifacts",
params={"per_page": "100"},
)
async def test_get_workflow_run_artifacts(self):
response1 = create_response()
response1.json.return_value = {
"artifacts": [
{
"id": 1,
"node_id": "MDg6QXJ0aWZhY3QxMQ==",
"name": "Rails",
"size_in_bytes": 556,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/1",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/1/zip",
"expired": False,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332938,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3",
},
}
]
}
response2 = create_response()
response2.json.return_value = {
"artifacts": [
{
"id": 2,
"node_id": "MDg6QXJ0aWZhY3QxMQ==",
"name": "Rails",
"size_in_bytes": 556,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/2",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/2/zip",
"expired": False,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332938,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3",
},
},
{
"id": 3,
"node_id": "MDg6QXJ0aWZhY3QxMw==",
"name": "Test output",
"size_in_bytes": 453,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/3",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/3/zip",
"expired": False,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332942,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652",
},
},
]
}
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.get_workflow_run_artifacts("foo/bar", "123"))
artifact = await anext(async_it)
self.assertEqual(artifact.id, 1)
artifact = await anext(async_it)
self.assertEqual(artifact.id, 2)
artifact = await anext(async_it)
self.assertEqual(artifact.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/actions/runs/123/artifacts",
params={"per_page": "100"},
)
async def test_delete(self):
response = create_response()
self.client.delete.return_value = response
await self.api.delete("foo/bar", "123")
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/actions/artifacts/123"
)
async def test_delete_failure(self):
response = create_response()
self.client.delete.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.delete("foo/bar", "123")
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/actions/artifacts/123"
)
async def test_download(self):
response = create_response(headers=MagicMock())
response.headers.get.return_value = 2
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
stream_context = AsyncMock()
stream_context.__aenter__.return_value = response
self.client.stream.return_value = stream_context
async with self.api.download("foo/bar", 123) as download_iterable:
it = aiter(download_iterable)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
self.client.stream.assert_called_once_with(
"/repos/foo/bar/actions/artifacts/123/zip"
)
pontos-25.3.2/tests/github/api/test_billing.py 0000664 0000000 0000000 00000004062 14762555663 0021400 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
from pontos.github.api.billing import GitHubAsyncRESTBilling
from tests.github.api import GitHubAsyncRESTTestCase, create_response
class GitHubAsyncRESTBillingTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTBilling
async def test_actions(self):
response = create_response()
response.json.return_value = {
"total_minutes_used": 305,
"total_paid_minutes_used": 0,
"included_minutes": 3000,
"minutes_used_breakdown": {
"UBUNTU": 205,
"MACOS": 10,
"WINDOWS": 90,
},
}
self.client.get.return_value = response
billing = await self.api.actions("foo")
self.client.get.assert_awaited_once_with(
"/orgs/foo/settings/billing/actions",
)
self.assertEqual(billing.total_minutes_used, 305)
async def test_packages(self):
response = create_response()
response.json.return_value = {
"total_gigabytes_bandwidth_used": 50,
"total_paid_gigabytes_bandwidth_used": 40,
"included_gigabytes_bandwidth": 10,
}
self.client.get.return_value = response
billing = await self.api.packages("foo")
self.client.get.assert_awaited_once_with(
"/orgs/foo/settings/billing/packages",
)
self.assertEqual(billing.total_gigabytes_bandwidth_used, 50)
async def test_storage(self):
response = create_response()
response.json.return_value = {
"days_left_in_billing_cycle": 20,
"estimated_paid_storage_for_month": 15,
"estimated_storage_for_month": 40,
}
self.client.get.return_value = response
billing = await self.api.storage("foo")
self.client.get.assert_awaited_once_with(
"/orgs/foo/settings/billing/shared-storage",
)
self.assertEqual(billing.days_left_in_billing_cycle, 20)
pontos-25.3.2/tests/github/api/test_branch.py 0000664 0000000 0000000 00000046025 14762555663 0021222 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
import unittest
from pathlib import Path
from unittest.mock import MagicMock
from httpx import HTTPStatusError
from pontos.github.api.branch import (
GitHubAsyncRESTBranches,
update_from_applied_settings,
)
from pontos.github.models.branch import BranchProtection
from tests.github.api import GitHubAsyncRESTTestCase, create_response
here = Path(__file__).parent
class UpdateFromAppliedSettingsTestCase(unittest.TestCase):
def test_update_from_applied_settings(self):
branch_protection = BranchProtection.from_dict(
{
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions",
"users_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/users",
"teams_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/teams",
"apps_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/apps",
"users": [
{
"login": "greenbonebot",
"id": 123,
"node_id": "MDQ6VXNlcjg1MjU0NjY2",
"avatar_url": "https://avatars.githubusercontent.com/u/85254666?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbonebot",
"html_url": "https://github.com/greenbonebot",
"followers_url": "https://api.github.com/users/greenbonebot/followers",
"following_url": "https://api.github.com/users/greenbonebot/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbonebot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbonebot/subscriptions",
"organizations_url": "https://api.github.com/users/greenbonebot/orgs",
"repos_url": "https://api.github.com/users/greenbonebot/repos",
"events_url": "https://api.github.com/users/greenbonebot/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbonebot/received_events",
"type": "User",
"site_admin": False,
}
],
"teams": [],
"apps": [],
"lock_branch": {"enabled": False},
"allow_fork_syncing": {"enabled": False},
"required_signatures": {"enabled": False},
}
)
kwargs = update_from_applied_settings(
branch_protection=branch_protection,
lock_branch=True,
allow_fork_syncing=True,
allow_deletions=True,
allow_force_pushes=True,
)
self.assertTrue(kwargs["lock_branch"])
self.assertTrue(kwargs["allow_fork_syncing"])
self.assertTrue(kwargs["allow_deletions"])
self.assertTrue(kwargs["allow_force_pushes"])
self.assertFalse(kwargs["required_signatures"])
self.assertIsNone(kwargs["required_linear_history"])
self.assertIsNone(kwargs["block_creations"])
self.assertIsNone(kwargs["required_conversation_resolution"])
self.assertIsNone(kwargs["enforce_admins"])
class GitHubAsyncRESTBranchesTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTBranches
async def test_exists(self):
response = create_response(is_success=True)
self.client.get.return_value = response
self.assertTrue(await self.api.exists("foo/bar", "baz"))
self.client.get.assert_awaited_once_with("/repos/foo/bar/branches/baz")
async def test_not_exists(self):
response = create_response(is_success=False)
self.client.get.return_value = response
self.assertFalse(await self.api.exists("foo/bar", "baz"))
self.client.get.assert_awaited_once_with("/repos/foo/bar/branches/baz")
async def test_delete_branch(self):
response = create_response()
self.client.delete.return_value = response
await self.api.delete("foo/bar", "baz")
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/git/refs/baz"
)
async def test_delete_branch_failure(self):
response = create_response()
error = HTTPStatusError("404", request=MagicMock(), response=response)
response.raise_for_status.side_effect = error
self.client.delete.return_value = response
with self.assertRaises(HTTPStatusError):
await self.api.delete("foo/bar", "baz")
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/git/refs/baz"
)
async def test_protection_rules(self):
rules = {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
"required_signatures": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/required_signatures",
"enabled": False,
},
"enforce_admins": {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection/enforce_admins",
"enabled": False,
},
}
response = create_response()
response.json.return_value = rules
self.client.get.return_value = response
data = await self.api.protection_rules("foo/bar", "baz")
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection"
)
self.assertEqual(
data.url,
"https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
)
async def test_protection_rules_failure(self):
response = create_response()
error = HTTPStatusError("404", request=MagicMock(), response=response)
response.raise_for_status.side_effect = error
self.client.get.return_value = response
with self.assertRaises(HTTPStatusError):
await self.api.protection_rules("foo/bar", "baz")
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection"
)
async def test_delete_protection_rules(self):
response = create_response()
self.client.delete.return_value = response
await self.api.delete_protection_rules("foo/bar", "baz")
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection"
)
async def test_delete_protection_rules_failure(self):
response = create_response()
error = HTTPStatusError("404", request=MagicMock(), response=response)
response.raise_for_status.side_effect = error
self.client.delete.return_value = response
with self.assertRaises(HTTPStatusError):
await self.api.delete_protection_rules("foo/bar", "baz")
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection"
)
async def test_update_protection_rules_defaults(self):
response = create_response()
response.json.return_value = {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
}
self.client.put.return_value = response
rules = await self.api.update_protection_rules(
"foo/bar",
"baz",
)
self.client.put.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection",
data={
"required_status_checks": None,
"enforce_admins": None,
"required_pull_request_reviews": None,
"restrictions": None,
},
)
self.assertEqual(
rules.url,
"https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
)
async def test_update_protection_rules(self):
response = create_response()
response.json.return_value = {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
}
self.client.put.return_value = response
rules = await self.api.update_protection_rules(
"foo/bar",
"baz",
required_status_checks=[("foo", "123"), ("bar", None)],
require_branches_to_be_up_to_date=True,
enforce_admins=True,
dismissal_restrictions_users=("foo", "bar"),
dismissal_restrictions_teams=("team_foo", "team_bar"),
dismissal_restrictions_apps=("123", "321"),
dismiss_stale_reviews=True,
require_code_owner_reviews=True,
required_approving_review_count=2,
require_last_push_approval=True,
bypass_pull_request_allowances_users=("foo", "bar"),
bypass_pull_request_allowances_teams=("team_foo", "team_bar"),
bypass_pull_request_allowances_apps=("123", "321"),
restrictions_users=("foo", "bar"),
restrictions_teams=("team_foo", "team_bar"),
restrictions_apps=("123", "321"),
required_linear_history=True,
allow_force_pushes=True,
allow_deletions=True,
block_creations=True,
required_conversation_resolution=True,
lock_branch=True,
allow_fork_syncing=True,
)
self.client.put.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection",
data={
"required_status_checks": {
"strict": True,
"checks": [
{"context": "foo", "app_id": "123"},
{"context": "bar"},
],
},
"enforce_admins": True,
"required_pull_request_reviews": {
"dismissal_restrictions": {
"users": ["foo", "bar"],
"teams": ["team_foo", "team_bar"],
"apps": ["123", "321"],
},
"dismiss_stale_reviews": True,
"require_code_owner_reviews": True,
"required_approving_review_count": 2,
"require_last_push_approval": True,
"bypass_pull_request_allowances": {
"users": ["foo", "bar"],
"teams": ["team_foo", "team_bar"],
"apps": ["123", "321"],
},
},
"restrictions": {
"users": ["foo", "bar"],
"teams": ["team_foo", "team_bar"],
"apps": ["123", "321"],
},
"required_linear_history": True,
"allow_force_pushes": True,
"allow_deletions": True,
"block_creations": True,
"required_conversation_resolution": True,
"lock_branch": True,
"allow_fork_syncing": True,
},
)
self.assertEqual(
rules.url,
"https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
)
async def test_update_protection_defaults(self):
response = create_response()
response.json.return_value = {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
}
self.client.put.return_value = response
rules = await self.api.update_protection_rules(
"foo/bar",
"baz",
)
self.client.put.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection",
data={
"required_status_checks": None,
"enforce_admins": None,
"required_pull_request_reviews": None,
"restrictions": None,
},
)
self.assertEqual(
rules.url,
"https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
)
async def test_update_protection_rules_up_to_date_branch(self):
response = create_response()
response.json.return_value = {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
}
self.client.put.return_value = response
rules = await self.api.update_protection_rules(
"foo/bar",
"baz",
require_branches_to_be_up_to_date=True,
)
self.client.put.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection",
data={
"required_status_checks": {
"strict": True,
"checks": [],
},
"enforce_admins": None,
"required_pull_request_reviews": None,
"restrictions": None,
},
)
self.assertEqual(
rules.url,
"https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
)
async def test_update_protection_rules_restriction_users(self):
response = create_response()
response.json.return_value = {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
}
self.client.put.return_value = response
rules = await self.api.update_protection_rules(
"foo/bar", "baz", restrictions_users=["foo", "bar"]
)
self.client.put.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection",
data={
"enforce_admins": None,
"required_pull_request_reviews": None,
"required_status_checks": None,
"restrictions": {"users": ["foo", "bar"], "teams": []},
},
)
self.assertEqual(
rules.url,
"https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
)
async def test_update_protection_rules_restriction_teams(self):
response = create_response()
response.json.return_value = {
"url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
}
self.client.put.return_value = response
rules = await self.api.update_protection_rules(
"foo/bar", "baz", restrictions_teams=["foo", "bar"]
)
self.client.put.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection",
data={
"enforce_admins": None,
"required_pull_request_reviews": None,
"required_status_checks": None,
"restrictions": {"teams": ["foo", "bar"], "users": []},
},
)
self.assertEqual(
rules.url,
"https://api.github.com/repos/octocat/Hello-World/branches/main/protection",
)
async def test_update_protection_rules_failure(self):
response = create_response()
error = HTTPStatusError("404", request=MagicMock(), response=response)
response.raise_for_status.side_effect = error
self.client.put.return_value = response
with self.assertRaises(HTTPStatusError):
await self.api.update_protection_rules(
"foo/bar",
"baz",
enforce_admins=True,
)
self.client.put.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection",
data={
"enforce_admins": True,
"required_status_checks": None,
"required_pull_request_reviews": None,
"restrictions": None,
},
)
async def test_enable_enforce_admins(self):
response = create_response()
self.client.post.return_value = response
await self.api.set_enforce_admins("foo/bar", "baz", enforce_admins=True)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection/enforce_admins"
)
async def test_disable_enforce_admins(self):
response = create_response()
self.client.delete.return_value = response
await self.api.set_enforce_admins(
"foo/bar", "baz", enforce_admins=False
)
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection/enforce_admins"
)
async def test_enable_required_signatures(self):
response = create_response()
self.client.post.return_value = response
await self.api.set_required_signatures(
"foo/bar", "baz", required_signatures=True
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection/required_signatures"
)
async def test_disable_required_signatures(self):
response = create_response()
self.client.delete.return_value = response
await self.api.set_required_signatures(
"foo/bar", "baz", required_signatures=False
)
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection/required_signatures"
)
async def test_update_required_status_checks(self):
response = create_response()
self.client.patch.return_value = response
await self.api.update_required_status_checks(
"foo/bar",
"baz",
required_status_checks=[("foo", "123"), ("bar", None)],
require_branches_to_be_up_to_date=True,
)
self.client.patch.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection/required_status_checks",
data={
"strict": True,
"checks": [
{"context": "foo", "app_id": "123"},
{"context": "bar"},
],
},
)
async def test_remove_required_required_status_checks(self):
response = create_response()
self.client.delete.return_value = response
await self.api.remove_required_status_checks("foo/bar", "baz")
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection/required_status_checks"
)
async def test_remove_required_required_status_checks_failure(self):
response = create_response()
error = HTTPStatusError("404", request=MagicMock(), response=response)
response.raise_for_status.side_effect = error
self.client.delete.return_value = response
with self.assertRaises(HTTPStatusError):
await self.api.remove_required_status_checks("foo/bar", "baz")
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/branches/baz/protection/required_status_checks"
)
pontos-25.3.2/tests/github/api/test_client.py 0000664 0000000 0000000 00000021450 14762555663 0021236 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=arguments-differ,redefined-builtin
from unittest.mock import MagicMock, call, patch
from pontos.github.api.client import (
DEFAULT_ACCEPT_HEADER,
GITHUB_API_VERSION,
GitHubAsyncRESTClient,
)
from pontos.github.api.helper import DEFAULT_GITHUB_API_URL
from tests import AsyncMock, IsolatedAsyncioTestCase, aiter, anext
class GitHubAsyncRESTClientTestCase(IsolatedAsyncioTestCase):
@patch("pontos.github.api.client.httpx.AsyncClient")
def setUp(self, async_client: MagicMock) -> None:
self.http_client = AsyncMock()
async_client.return_value = self.http_client
self.client = GitHubAsyncRESTClient("token")
async def test_get(self):
await self.client.get("/foo/bar")
self.http_client.get.assert_awaited_once_with(
f"{DEFAULT_GITHUB_API_URL}/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
params=None,
follow_redirects=True,
)
async def test_get_url(self):
await self.client.get("https://github.com/foo/bar")
self.http_client.get.assert_awaited_once_with(
"https://github.com/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
params=None,
follow_redirects=True,
)
async def test_get_all(self):
url = "https://foo.bar"
response1 = MagicMock(links={"next": {"url": url}})
response2 = MagicMock(links=None)
self.http_client.get.side_effect = [
response1,
response2,
]
it = aiter(self.client.get_all("/foo/bar"))
await anext(it)
await anext(it)
with self.assertRaises(StopAsyncIteration):
await anext(it)
self.http_client.get.assert_has_awaits(
[
call(
f"{DEFAULT_GITHUB_API_URL}/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
params=None,
follow_redirects=True,
),
call(
f"{url}",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
params=None,
follow_redirects=True,
),
]
)
async def test_delete(self):
await self.client.delete("/foo/bar")
self.http_client.delete.assert_awaited_once_with(
f"{DEFAULT_GITHUB_API_URL}/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
params=None,
)
async def test_delete_url(self):
await self.client.delete("https://github.com/foo/bar")
self.http_client.delete.assert_awaited_once_with(
"https://github.com/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
params=None,
)
async def test_post(self):
await self.client.post("/foo/bar", data={"foo": "bar"})
self.http_client.post.assert_awaited_once_with(
f"{DEFAULT_GITHUB_API_URL}/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
json={"foo": "bar"},
params=None,
content=None,
)
async def test_post_url(self):
await self.client.post(
"https://github.com/foo/bar", data={"foo": "bar"}
)
self.http_client.post.assert_awaited_once_with(
"https://github.com/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
json={"foo": "bar"},
params=None,
content=None,
)
async def test_post_with_content_length(self):
await self.client.post(
"/foo/bar", data={"foo": "bar"}, content_length=123
)
self.http_client.post.assert_awaited_once_with(
f"{DEFAULT_GITHUB_API_URL}/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
"Content-Length": "123",
},
json={"foo": "bar"},
params=None,
content=None,
)
async def test_put(self):
await self.client.put("/foo/bar", data={"foo": "bar"})
self.http_client.put.assert_awaited_once_with(
f"{DEFAULT_GITHUB_API_URL}/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
json={"foo": "bar"},
params=None,
content=None,
)
async def test_put_url(self):
await self.client.put("https://github.com/foo/bar", data={"foo": "bar"})
self.http_client.put.assert_awaited_once_with(
"https://github.com/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
json={"foo": "bar"},
params=None,
content=None,
)
async def test_patch(self):
await self.client.patch("/foo/bar", data={"foo": "bar"})
self.http_client.patch.assert_awaited_once_with(
f"{DEFAULT_GITHUB_API_URL}/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
json={"foo": "bar"},
params=None,
content=None,
)
async def test_patch_url(self):
await self.client.patch(
"https://github.com/foo/bar", data={"foo": "bar"}
)
self.http_client.patch.assert_awaited_once_with(
"https://github.com/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
json={"foo": "bar"},
params=None,
content=None,
)
async def test_stream(self):
response = MagicMock()
response.__aenter__.return_value = MagicMock()
self.http_client.stream = MagicMock()
self.http_client.stream.return_value = response
async with self.client.stream("/foo/bar"):
pass
self.http_client.stream.assert_called_once_with(
"GET",
f"{DEFAULT_GITHUB_API_URL}/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
follow_redirects=True,
)
async def test_stream_url(self):
response = MagicMock()
response.__aenter__.return_value = MagicMock()
self.http_client.stream = MagicMock()
self.http_client.stream.return_value = response
async with self.client.stream("https://github.com/foo/bar"):
pass
self.http_client.stream.assert_called_once_with(
"GET",
"https://github.com/foo/bar",
headers={
"Accept": DEFAULT_ACCEPT_HEADER,
"Authorization": "token token",
"X-GitHub-Api-Version": GITHUB_API_VERSION,
},
follow_redirects=True,
)
async def test_context_manager(self):
async with self.client:
pass
self.http_client.__aenter__.assert_awaited_once()
self.http_client.__aexit__.assert_awaited_once()
pontos-25.3.2/tests/github/api/test_code_scanning.py 0000664 0000000 0000000 00000163622 14762555663 0022562 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
import json
from pontos.github.api.code_scanning import GitHubAsyncRESTCodeScanning
from pontos.github.models.base import SortOrder
from pontos.github.models.code_scanning import (
AlertSort,
AlertState,
DefaultSetupState,
DismissedReason,
Language,
QuerySuite,
SarifProcessingStatus,
Severity,
)
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
ALERTS = [
{
"number": 4,
"created_at": "2020-02-13T12:29:18Z",
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4",
"html_url": "https://github.com/octocat/hello-world/code-scanning/4",
"state": "open",
"dismissed_by": None,
"dismissed_at": None,
"dismissed_reason": None,
"dismissed_comment": None,
"rule": {
"id": "js/zipslip",
"severity": "error",
"tags": ["security", "external/cwe/cwe-022"],
"description": "Arbitrary file write during zip extraction",
"name": "js/zipslip",
},
"tool": {"name": "CodeQL", "guid": None, "version": "2.4.0"},
"most_recent_instance": {
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"environment": "{}",
"state": "open",
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
"message": {"text": "This path depends on a user-provided value."},
"location": {
"path": "spec-main/api-session-spec.ts",
"start_line": 917,
"end_line": 917,
"start_column": 7,
"end_column": 18,
},
"classifications": ["test"],
},
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
},
},
{
"number": 3,
"created_at": "2020-02-13T12:29:18Z",
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3",
"html_url": "https://github.com/octocat/hello-world/code-scanning/3",
"state": "dismissed",
"dismissed_by": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"dismissed_at": "2020-02-14T12:29:18Z",
"dismissed_reason": "false positive",
"dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
"rule": {
"id": "js/zipslip",
"severity": "error",
"tags": ["security", "external/cwe/cwe-022"],
"description": "Arbitrary file write during zip extraction",
"name": "js/zipslip",
},
"tool": {"name": "CodeQL", "guid": None, "version": "2.4.0"},
"most_recent_instance": {
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"environment": "{}",
"state": "open",
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
"message": {"text": "This path depends on a user-provided value."},
"location": {
"path": "lib/ab12-gen.js",
"start_line": 917,
"end_line": 917,
"start_column": 7,
"end_column": 18,
},
"classifications": [],
},
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
},
},
]
ANALYSES = [
{
"ref": "refs/heads/main",
"commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83",
"analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
"environment": '{"language":"python"}',
"error": "",
"category": ".github/workflows/codeql-analysis.yml:analyze/language:python",
"created_at": "2020-08-27T15:05:21Z",
"results_count": 17,
"rules_count": 49,
"id": 201,
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
"sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
"tool": {"name": "CodeQL", "guid": None, "version": "2.4.0"},
"deletable": True,
"warning": "",
},
{
"ref": "refs/heads/my-branch",
"commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321",
"analysis_key": ".github/workflows/shiftleft.yml:build",
"environment": "{}",
"error": "",
"category": ".github/workflows/shiftleft.yml:build/",
"created_at": "2020-08-31T22:46:44Z",
"results_count": 17,
"rules_count": 32,
"id": 200,
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200",
"sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582",
"tool": {
"name": "Python Security Analysis",
"guid": None,
"version": "1.2.0",
},
"deletable": True,
"warning": "",
},
]
class GitHubAsyncRESTCodeScanningTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTCodeScanning
async def test_organization_alerts(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.organization_alerts("foo"))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/code-scanning/alerts",
params={"per_page": "100", "sort": "created", "direction": "desc"},
)
async def test_organization_alerts_state(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", state=AlertState.FIXED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"state": "fixed",
},
)
async def test_organization_alerts_tool_name(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", tool_name="CodeQL")
)
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"tool_name": "CodeQL",
},
)
async def test_organization_alerts_tool_guid(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.organization_alerts("foo", tool_guid=None))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"tool_guid": None,
},
)
async def test_organization_alerts_severity(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", severity=Severity.ERROR)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"severity": "error",
},
)
async def test_organization_alerts_sort(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", sort=AlertSort.UPDATED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/code-scanning/alerts",
params={
"per_page": "100",
"sort": "updated",
"direction": "desc",
},
)
async def test_organization_alerts_direction(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", direction=SortOrder.ASC)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "asc",
},
)
async def test_alerts(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar"))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/alerts",
params={"per_page": "100", "sort": "created", "direction": "desc"},
)
async def test_alerts_state(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", state=AlertState.FIXED))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"state": "fixed",
},
)
async def test_alerts_tool_name(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", tool_name="CodeQL"))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"tool_name": "CodeQL",
},
)
async def test_alerts_tool_guid(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", tool_guid=None))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"tool_guid": None,
},
)
async def test_alerts_severity(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", severity=Severity.ERROR))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"severity": "error",
},
)
async def test_alerts_sort(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", sort=AlertSort.UPDATED))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/alerts",
params={
"per_page": "100",
"sort": "updated",
"direction": "desc",
},
)
async def test_alerts_direction(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", direction=SortOrder.ASC))
alert = await anext(async_it)
self.assertEqual(alert.number, 4)
alert = await anext(async_it)
self.assertEqual(alert.number, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "asc",
},
)
async def test_alert(self):
response = create_response()
response.json.return_value = {
"number": 42,
"created_at": "2020-06-19T11:21:34Z",
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42",
"html_url": "https://github.com/octocat/hello-world/code-scanning/42",
"state": "dismissed",
"fixed_at": None,
"dismissed_by": {
"login": "octocat",
"id": 54933897,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"dismissed_at": "2020-02-14T12:29:18Z",
"dismissed_reason": "false positive",
"dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": 'Arbitrary file write during zip extraction ("Zip Slip")',
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
"tags": ["security", "external/cwe/cwe-022"],
"help": '# Arbitrary file write during zip extraction ("Zip Slip")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...',
"help_uri": "https://codeql.github.com/",
},
"tool": {"name": "CodeQL", "guid": None, "version": "2.4.0"},
"most_recent_instance": {
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"environment": "{}",
"state": "dismissed",
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
"message": {
"text": "This path depends on a user-provided value."
},
"location": {
"path": "spec-main/api-session-spec.ts",
"start_line": 917,
"end_line": 917,
"start_column": 7,
"end_column": 18,
},
"classifications": ["test"],
},
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances",
}
self.client.get.return_value = response
alert = await self.api.alert(
"foo/bar",
42,
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/code-scanning/alerts/42",
)
self.assertEqual(alert.number, 42)
async def test_update(self):
response = create_response()
response.json.return_value = {
"number": 42,
"created_at": "2020-08-25T21:28:36Z",
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42",
"html_url": "https://github.com/octocat/hello-world/code-scanning/42",
"state": "dismissed",
"fixed_at": None,
"dismissed_by": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"dismissed_at": "2020-09-02T22:34:56Z",
"dismissed_reason": "false positive",
"dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
"rule": {
"id": "js/zipslip",
"severity": "error",
"security_severity_level": "high",
"description": 'Arbitrary file write during zip extraction ("Zip Slip")',
"name": "js/zipslip",
"full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
"tags": ["security", "external/cwe/cwe-022"],
"help": '# Arbitrary file write during zip extraction ("Zip Slip")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...',
"help_uri": "https://codeql.github.com/",
},
"tool": {"name": "CodeQL", "guid": None, "version": "2.4.0"},
"most_recent_instance": {
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"environment": "{}",
"state": "dismissed",
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
"message": {
"text": "This path depends on a user-provided value."
},
"location": {
"path": "spec-main/api-session-spec.ts",
"start_line": 917,
"end_line": 917,
"start_column": 7,
"end_column": 18,
},
"classifications": ["test"],
},
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances",
}
self.client.patch.return_value = response
alert = await self.api.update_alert(
"foo/bar",
42,
AlertState.DISMISSED,
dismissed_reason=DismissedReason.USED_IN_TESTS,
dismissed_comment="Only used in tests",
)
self.client.patch.assert_awaited_once_with(
"/repos/foo/bar/code-scanning/alerts/42",
data={
"state": "dismissed",
"dismissed_reason": "used in tests",
"dismissed_comment": "Only used in tests",
},
)
self.assertEqual(alert.number, 42)
self.assertIsNone(alert.repository)
async def test_alerts_instances(self):
response = create_response()
response.json.return_value = [
{
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"environment": "",
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"state": "open",
"fixed_at": None,
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
"message": {
"text": "This path depends on a user-provided value."
},
"location": {
"path": "lib/ab12-gen.js",
"start_line": 917,
"end_line": 917,
"start_column": 7,
"end_column": 18,
},
"classifications": ["library"],
},
{
"ref": "refs/pull/3740/merge",
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"environment": "",
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"state": "fixed",
"fixed_at": "2020-02-14T12:29:18Z",
"commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2",
"message": {
"text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1."
},
"location": {
"path": "app/script.js",
"start_line": 2,
"end_line": 2,
"start_column": 10,
"end_column": 50,
},
"classifications": ["source"],
},
]
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.instances("foo/bar", 1))
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/main")
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/pull/3740/merge")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/alerts/1/instances",
params={
"per_page": "100",
},
)
async def test_analyses(self):
response = create_response()
response.json.return_value = ANALYSES
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.analyses("foo/bar"))
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/main")
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/my-branch")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/analyses",
params={
"per_page": "100",
"direction": "desc",
},
)
async def test_analyses_tool_name(self):
response = create_response()
response.json.return_value = ANALYSES
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.analyses("foo/bar", tool_name="CodeQL"))
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/main")
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/my-branch")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/analyses",
params={
"per_page": "100",
"direction": "desc",
"tool_name": "CodeQL",
},
)
async def test_analyses_tool_guid(self):
response = create_response()
response.json.return_value = ANALYSES
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.analyses("foo/bar", tool_guid="123"))
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/main")
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/my-branch")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/analyses",
params={
"per_page": "100",
"direction": "desc",
"tool_guid": "123",
},
)
async def test_analyses_sarif_id(self):
response = create_response()
response.json.return_value = ANALYSES
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.analyses("foo/bar", sarif_id="123"))
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/main")
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/my-branch")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/analyses",
params={
"per_page": "100",
"direction": "desc",
"sarif_id": "123",
},
)
async def test_analyses_ref(self):
response = create_response()
response.json.return_value = ANALYSES
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.analyses("foo/bar", ref="refs/heads/main"))
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/main")
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/my-branch")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/analyses",
params={
"per_page": "100",
"direction": "desc",
"ref": "refs/heads/main",
},
)
async def test_analyses_direction(self):
response = create_response()
response.json.return_value = ANALYSES
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.analyses("foo/bar", direction=SortOrder.ASC))
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/main")
instance = await anext(async_it)
self.assertEqual(instance.ref, "refs/heads/my-branch")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/analyses",
params={
"per_page": "100",
"direction": "asc",
},
)
async def test_analysis(self):
response = create_response()
response.json.return_value = {
"ref": "refs/heads/main",
"commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
"analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
"environment": '{"language":"javascript"}',
"error": "",
"category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript",
"created_at": "2021-01-13T11:55:49Z",
"results_count": 3,
"rules_count": 67,
"id": 3602840,
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
"sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6",
"tool": {"name": "CodeQL", "guid": None, "version": "2.4.0"},
"deletable": True,
"warning": "",
}
self.client.get.return_value = response
alert = await self.api.analysis(
"foo/bar",
42,
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/code-scanning/analyses/42",
)
self.assertEqual(alert.ref, "refs/heads/main")
async def test_delete_analysis(self):
response = create_response()
response.json.return_value = {
"next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41",
"confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete",
}
self.client.delete.return_value = response
resp = await self.api.delete_analysis(
"foo/bar",
42,
)
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/code-scanning/analyses/42",
)
self.assertEqual(
resp["next_analysis_url"],
"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41",
)
self.assertEqual(
resp["confirm_delete_url"],
"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete",
)
async def test_codeql_databases(self):
response = create_response()
response.json.return_value = [
{
"id": 1,
"name": "database.zip",
"language": "java",
"uploader": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"content_type": "application/zip",
"size": 1024,
"created_at": "2022-09-12T12:14:32Z",
"updated_at": "2022-09-12T12:14:32Z",
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
"commit_oid": 12345678901234567000,
},
{
"id": 2,
"name": "database.zip",
"language": "ruby",
"uploader": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"content_type": "application/zip",
"size": 1024,
"created_at": "2022-09-12T12:14:32Z",
"updated_at": "2022-09-12T12:14:32Z",
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby",
"commit_oid": 23456789012345680000,
},
]
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.codeql_databases("foo/bar"))
db = await anext(async_it)
self.assertEqual(db.id, 1)
alert = await anext(async_it)
self.assertEqual(alert.id, 2)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/code-scanning/codeql/databases",
params={
"per_page": "100",
},
)
async def test_codeql_database(self):
response = create_response()
response.json.return_value = {
"id": 1,
"name": "database.zip",
"language": "java",
"uploader": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"content_type": "application/zip",
"size": 1024,
"created_at": "2022-09-12T12:14:32Z",
"updated_at": "2022-09-12T12:14:32Z",
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
"commit_oid": 12345678901234567000,
}
self.client.get.return_value = response
alert = await self.api.codeql_database(
"foo/bar",
"java",
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/code-scanning/codeql/databases/java",
)
self.assertEqual(alert.id, 1)
async def test_default_setup(self):
response = create_response()
response.json.return_value = {
"state": "configured",
"languages": ["ruby", "python"],
"query_suite": "default",
"updated_at": "2023-01-19T11:21:34Z",
"schedule": "weekly",
}
self.client.get.return_value = response
setup = await self.api.default_setup(
"foo/bar",
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/code-scanning/default-setup",
)
self.assertEqual(setup.state, DefaultSetupState.CONFIGURED)
async def test_update_default_setup(self):
response = create_response()
response.json.return_value = {
"run_id": 42,
"run_url": "https://api.github.com/repos/octoorg/octocat/actions/runs/42",
}
self.client.patch.return_value = response
resp = await self.api.update_default_setup(
"foo/bar",
state=DefaultSetupState.CONFIGURED,
query_suite=QuerySuite.EXTENDED,
languages=[Language.GO],
)
self.client.patch.assert_awaited_once_with(
"/repos/foo/bar/code-scanning/code-scanning/default-setup",
data={
"state": "configured",
"query_suite": "extended",
"languages": ["go"],
},
)
self.assertEqual(
resp["run_id"],
42,
)
self.assertEqual(
resp["run_url"],
"https://api.github.com/repos/octoorg/octocat/actions/runs/42",
)
async def test_upload_sarif_data(self):
sarif = {
"version": "2.1.0",
"$schema": "http://json.schemastore.org/sarif-2.1.0-rtm.4",
"runs": [
{
"tool": {
"driver": {
"name": "ESLint",
"informationUri": "https://eslint.org",
"rules": [
{
"id": "no-unused-vars",
"shortDescription": {
"text": "disallow unused variables"
},
"helpUri": "https://eslint.org/docs/rules/no-unused-vars",
"properties": {"category": "Variables"},
}
],
}
},
"artifacts": [
{
"location": {
"uri": "file:///C:/dev/sarif/sarif-tutorials/samples/Introduction/simple-example.js"
}
}
],
"results": [
{
"level": "error",
"message": {
"text": "'x' is assigned a value but never used."
},
"locations": [
{
"physicalLocation": {
"artifactLocation": {
"uri": "file:///C:/dev/sarif/sarif-tutorials/samples/Introduction/simple-example.js",
"index": 0,
},
"region": {
"startLine": 1,
"startColumn": 5,
},
}
}
],
"ruleId": "no-unused-vars",
"ruleIndex": 0,
}
],
}
],
}
response = create_response()
response.json.return_value = {
"id": "47177e22-5596-11eb-80a1-c1e54ef945c6",
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6",
}
self.client.post.return_value = response
resp = await self.api.upload_sarif_data(
"foo/bar",
commit_sha="4b6472266afd7b471e86085a6659e8c7f2b119da",
ref="refs/heads/master",
sarif=json.dumps(sarif).encode(),
)
self.assertEqual(self.client.post.await_count, 1)
args = self.client.post.await_args
self.assertEqual(args.args, ("/repos/foo/bar/code-scanning/sarifs",))
data = args.kwargs["data"]
self.assertEqual(
data["commit_sha"],
"4b6472266afd7b471e86085a6659e8c7f2b119da",
)
self.assertEqual(
data["ref"],
"refs/heads/master",
)
# it's not possible to check the sarif data in Python < 3.11 because
# gzip creates different content on each run
self.assertTrue("sarif" in data)
self.assertEqual(resp["id"], "47177e22-5596-11eb-80a1-c1e54ef945c6")
self.assertEqual(
resp["url"],
"https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6",
)
async def test_sarif(self):
response = create_response()
response.json.return_value = {
"processing_status": "complete",
"analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6",
}
self.client.get.return_value = response
resp = await self.api.sarif(
"foo/bar", "47177e22-5596-11eb-80a1-c1e54ef945c6"
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6",
)
self.assertEqual(resp.processing_status, SarifProcessingStatus.COMPLETE)
self.assertEqual(
resp.analyses_url,
"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6",
)
self.assertIsNone(resp.errors)
pontos-25.3.2/tests/github/api/test_contents.py 0000664 0000000 0000000 00000002674 14762555663 0021624 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from pathlib import Path
from pontos.github.api.contents import GitHubAsyncRESTContent
from tests.github.api import GitHubAsyncRESTTestCase, create_response
here = Path(__file__).parent
class GitHubAsyncRESTContentTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTContent
async def test_path_exists(self):
response = create_response(is_success=True)
self.client.get.return_value = response
self.assertTrue(await self.api.path_exists("foo/bar", "a/file.txt"))
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/contents/a/file.txt", params={}
)
async def test_path_exists_with_branch(self):
response = create_response(is_success=True)
self.client.get.return_value = response
self.assertTrue(
await self.api.path_exists("foo/bar", "a/file.txt", branch="baz")
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/contents/a/file.txt", params={"ref": "baz"}
)
async def test_path_not_exists(self):
response = create_response(is_success=False)
self.client.get.return_value = response
self.assertFalse(await self.api.path_exists("foo/bar", "a/file.txt"))
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/contents/a/file.txt", params={}
)
pontos-25.3.2/tests/github/api/test_dependabot.py 0000664 0000000 0000000 00000126750 14762555663 0022076 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
from pontos.github.api.dependabot import GitHubAsyncRESTDependabot
from pontos.github.models.base import SortOrder
from pontos.github.models.dependabot import (
AlertSort,
AlertState,
DependencyScope,
DismissedReason,
Severity,
)
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
ALERTS = [
{
"number": 2,
"state": "dismissed",
"dependency": {
"package": {"ecosystem": "pip", "name": "django"},
"manifest_path": "path/to/requirements.txt",
"scope": "runtime",
},
"security_advisory": {
"ghsa_id": "GHSA-rf4j-j272-fj86",
"cve_id": "CVE-2018-6188",
"summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive",
"description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
"vulnerabilities": [
{
"package": {"ecosystem": "pip", "name": "django"},
"severity": "high",
"vulnerable_version_range": ">= 2.0.0, < 2.0.2",
"first_patched_version": {"identifier": "2.0.2"},
},
{
"package": {"ecosystem": "pip", "name": "django"},
"severity": "high",
"vulnerable_version_range": ">= 1.11.8, < 1.11.10",
"first_patched_version": {"identifier": "1.11.10"},
},
],
"severity": "high",
"cvss": {
"vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
"score": 7.5,
},
"cwes": [
{
"cwe_id": "CWE-200",
"name": "Exposure of Sensitive Information to an Unauthorized Actor",
}
],
"identifiers": [
{"type": "GHSA", "value": "GHSA-rf4j-j272-fj86"},
{"type": "CVE", "value": "CVE-2018-6188"},
],
"references": [
{"url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"},
{"url": "https://github.com/advisories/GHSA-rf4j-j272-fj86"},
{"url": "https://usn.ubuntu.com/3559-1/"},
{
"url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/"
},
{"url": "http://www.securitytracker.com/id/1040422"},
],
"published_at": "2018-10-03T21:13:54Z",
"updated_at": "2022-04-26T18:35:37Z",
"withdrawn_at": None,
},
"security_vulnerability": {
"package": {"ecosystem": "pip", "name": "django"},
"severity": "high",
"vulnerable_version_range": ">= 2.0.0, < 2.0.2",
"first_patched_version": {"identifier": "2.0.2"},
},
"url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2",
"html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2",
"created_at": "2022-06-15T07:43:03Z",
"updated_at": "2022-08-23T14:29:47Z",
"dismissed_at": "2022-08-23T14:29:47Z",
"dismissed_by": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"dismissed_reason": "tolerable_risk",
"dismissed_comment": "This alert is accurate but we use a sanitizer.",
"fixed_at": None,
"repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"owner": {
"login": "octo-org",
"id": 6811672,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"repos_url": "https://api.github.com/users/octo-org/repos",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"type": "Organization",
"site_admin": False,
},
"private": True,
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
},
},
{
"number": 1,
"state": "open",
"dependency": {
"package": {"ecosystem": "pip", "name": "ansible"},
"manifest_path": "path/to/requirements.txt",
"scope": "runtime",
},
"security_advisory": {
"ghsa_id": "GHSA-8f4m-hccc-8qph",
"cve_id": "CVE-2021-20191",
"summary": "Insertion of Sensitive Information into Log File in ansible",
"description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.",
"vulnerabilities": [
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": ">= 2.9.0, < 2.9.18",
"first_patched_version": {"identifier": "2.9.18"},
},
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": "< 2.8.19",
"first_patched_version": {"identifier": "2.8.19"},
},
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": ">= 2.10.0, < 2.10.7",
"first_patched_version": {"identifier": "2.10.7"},
},
],
"severity": "medium",
"cvss": {
"vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N",
"score": 5.5,
},
"cwes": [
{
"cwe_id": "CWE-532",
"name": "Insertion of Sensitive Information into Log File",
}
],
"identifiers": [
{"type": "GHSA", "value": "GHSA-8f4m-hccc-8qph"},
{"type": "CVE", "value": "CVE-2021-20191"},
],
"references": [
{"url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191"},
{
"url": "https://access.redhat.com/security/cve/cve-2021-20191"
},
{"url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813"},
],
"published_at": "2021-06-01T17:38:00Z",
"updated_at": "2021-08-12T23:06:00Z",
"withdrawn_at": None,
},
"security_vulnerability": {
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": "< 2.8.19",
"first_patched_version": {"identifier": "2.8.19"},
},
"url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1",
"html_url": "https://github.com/octo-org/hello-world/security/dependabot/1",
"created_at": "2022-06-14T15:21:52Z",
"updated_at": "2022-06-14T15:21:52Z",
"dismissed_at": None,
"dismissed_by": None,
"dismissed_reason": None,
"dismissed_comment": None,
"fixed_at": None,
"repository": {
"id": 664700648,
"node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=",
"name": "hello-world",
"full_name": "octo-org/hello-world",
"owner": {
"login": "octo-org",
"id": 6811672,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"repos_url": "https://api.github.com/users/octo-org/repos",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"type": "Organization",
"site_admin": False,
},
"private": True,
"html_url": "https://github.com/octo-org/hello-world",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/hello-world",
"archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}",
"commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}",
"compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors",
"deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments",
"downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads",
"events_url": "https://api.github.com/repos/octo-org/hello-world/events",
"forks_url": "https://api.github.com/repos/octo-org/hello-world/forks",
"git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}",
"hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks",
"issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}",
"keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}",
"languages_url": "https://api.github.com/repos/octo-org/hello-world/languages",
"merges_url": "https://api.github.com/repos/octo-org/hello-world/merges",
"milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}",
"releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers",
"statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription",
"tags_url": "https://api.github.com/repos/octo-org/hello-world/tags",
"teams_url": "https://api.github.com/repos/octo-org/hello-world/teams",
"trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}",
},
},
]
class GitHubAsyncRESTDependabotTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTDependabot
async def test_enterprise_alerts(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.enterprise_alerts("foo"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/dependabot/alerts",
params={"per_page": "100", "sort": "created", "direction": "desc"},
)
async def test_enterprise_alerts_state(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts("foo", state=AlertState.FIXED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"state": "fixed",
},
)
async def test_enterprise_alerts_severity(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts("foo", severity=Severity.CRITICAL)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"severity": "critical",
},
)
async def test_enterprise_alerts_ecosystem(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.enterprise_alerts("foo", ecosystem="pip"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"ecosystem": "pip",
},
)
async def test_enterprise_alerts_scope(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts("foo", scope=DependencyScope.RUNTIME)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"scope": "runtime",
},
)
async def test_enterprise_alerts_sort(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts("foo", sort=AlertSort.UPDATED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "updated",
"direction": "desc",
},
)
async def test_enterprise_alerts_direction(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts("foo", direction=SortOrder.ASC)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "asc",
},
)
async def test_organization_alerts(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.organization_alerts("foo"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/dependabot/alerts",
params={"per_page": "100", "sort": "created", "direction": "desc"},
)
async def test_organization_alerts_state(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", state=AlertState.FIXED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"state": "fixed",
},
)
async def test_organization_alerts_severity(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", severity=Severity.CRITICAL)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"severity": "critical",
},
)
async def test_organization_alerts_ecosystem(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.organization_alerts("foo", ecosystem="pip"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"ecosystem": "pip",
},
)
async def test_organization_alerts_scope(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", scope=DependencyScope.RUNTIME)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"scope": "runtime",
},
)
async def test_organization_alerts_sort(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", sort=AlertSort.UPDATED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "updated",
"direction": "desc",
},
)
async def test_organization_alerts_direction(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", direction=SortOrder.ASC)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "asc",
},
)
async def test_alerts(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/dependabot/alerts",
params={"per_page": "100", "sort": "created", "direction": "desc"},
)
async def test_alerts_state(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", state=AlertState.FIXED))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"state": "fixed",
},
)
async def test_alerts_severity(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", severity=Severity.CRITICAL))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"severity": "critical",
},
)
async def test_alerts_ecosystem(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", ecosystem="pip"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"ecosystem": "pip",
},
)
async def test_alerts_scope(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.alerts("foo/bar", scope=DependencyScope.RUNTIME)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"scope": "runtime",
},
)
async def test_alerts_sort(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", sort=AlertSort.UPDATED))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/dependabot/alerts",
params={
"per_page": "100",
"sort": "updated",
"direction": "desc",
},
)
async def test_alerts_direction(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", direction=SortOrder.ASC))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/dependabot/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "asc",
},
)
async def test_alert(self):
response = create_response()
response.json.return_value = {
"number": 1,
"state": "open",
"dependency": {
"package": {"ecosystem": "pip", "name": "ansible"},
"manifest_path": "path/to/requirements.txt",
"scope": "runtime",
},
"security_advisory": {
"ghsa_id": "GHSA-8f4m-hccc-8qph",
"cve_id": "CVE-2021-20191",
"summary": "Insertion of Sensitive Information into Log File in ansible",
"description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.",
"vulnerabilities": [
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": ">= 2.9.0, < 2.9.18",
"first_patched_version": {"identifier": "2.9.18"},
},
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": "< 2.8.19",
"first_patched_version": {"identifier": "2.8.19"},
},
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": ">= 2.10.0, < 2.10.7",
"first_patched_version": {"identifier": "2.10.7"},
},
],
"severity": "medium",
"cvss": {
"vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N",
"score": 5.5,
},
"cwes": [
{
"cwe_id": "CWE-532",
"name": "Insertion of Sensitive Information into Log File",
}
],
"identifiers": [
{"type": "GHSA", "value": "GHSA-8f4m-hccc-8qph"},
{"type": "CVE", "value": "CVE-2021-20191"},
],
"references": [
{"url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191"},
{
"url": "https://access.redhat.com/security/cve/cve-2021-20191"
},
{
"url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813"
},
],
"published_at": "2021-06-01T17:38:00Z",
"updated_at": "2021-08-12T23:06:00Z",
"withdrawn_at": None,
},
"security_vulnerability": {
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": "< 2.8.19",
"first_patched_version": {"identifier": "2.8.19"},
},
"url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1",
"html_url": "https://github.com/octocat/hello-world/security/dependabot/1",
"created_at": "2022-06-14T15:21:52Z",
"updated_at": "2022-06-14T15:21:52Z",
"dismissed_at": None,
"dismissed_by": None,
"dismissed_reason": None,
"dismissed_comment": None,
"fixed_at": None,
}
self.client.get.return_value = response
alert = await self.api.alert(
"foo/bar",
1,
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/dependabot/alerts/1",
)
self.assertEqual(alert.number, 1)
async def test_update(self):
response = create_response()
response.json.return_value = {
"number": 1,
"state": "open",
"dependency": {
"package": {"ecosystem": "pip", "name": "ansible"},
"manifest_path": "path/to/requirements.txt",
"scope": "runtime",
},
"security_advisory": {
"ghsa_id": "GHSA-8f4m-hccc-8qph",
"cve_id": "CVE-2021-20191",
"summary": "Insertion of Sensitive Information into Log File in ansible",
"description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.",
"vulnerabilities": [
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": ">= 2.9.0, < 2.9.18",
"first_patched_version": {"identifier": "2.9.18"},
},
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": "< 2.8.19",
"first_patched_version": {"identifier": "2.8.19"},
},
{
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": ">= 2.10.0, < 2.10.7",
"first_patched_version": {"identifier": "2.10.7"},
},
],
"severity": "medium",
"cvss": {
"vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N",
"score": 5.5,
},
"cwes": [
{
"cwe_id": "CWE-532",
"name": "Insertion of Sensitive Information into Log File",
}
],
"identifiers": [
{"type": "GHSA", "value": "GHSA-8f4m-hccc-8qph"},
{"type": "CVE", "value": "CVE-2021-20191"},
],
"references": [
{"url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191"},
{
"url": "https://access.redhat.com/security/cve/cve-2021-20191"
},
{
"url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813"
},
],
"published_at": "2021-06-01T17:38:00Z",
"updated_at": "2021-08-12T23:06:00Z",
"withdrawn_at": None,
},
"security_vulnerability": {
"package": {"ecosystem": "pip", "name": "ansible"},
"severity": "medium",
"vulnerable_version_range": "< 2.8.19",
"first_patched_version": {"identifier": "2.8.19"},
},
"url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1",
"html_url": "https://github.com/octocat/hello-world/security/dependabot/1",
"created_at": "2022-06-14T15:21:52Z",
"updated_at": "2022-06-14T15:21:52Z",
"dismissed_at": None,
"dismissed_by": None,
"dismissed_reason": None,
"dismissed_comment": None,
"fixed_at": None,
}
self.client.patch.return_value = response
alert = await self.api.update_alert(
"foo/bar",
1,
AlertState.DISMISSED,
dismissed_reason=DismissedReason.NOT_USED,
dismissed_comment="Dependency is not used.",
)
self.client.patch.assert_awaited_once_with(
"/repos/foo/bar/dependabot/alerts/1",
data={
"state": "dismissed",
"dismissed_reason": "not_used",
"dismissed_comment": "Dependency is not used.",
},
)
self.assertEqual(alert.number, 1)
pontos-25.3.2/tests/github/api/test_labels.py 0000664 0000000 0000000 00000004646 14762555663 0021232 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=redefined-builtin
from unittest.mock import MagicMock
import httpx
from pontos.github.api.labels import GitHubAsyncRESTLabels
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
class GitHubAsyncRESTLabelsTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTLabels
async def test_get_all(self):
response1 = create_response()
response1.json.return_value = [{"id": 1, "name": "a"}]
response2 = create_response()
response2.json.return_value = [
{"id": 2, "name": "b"},
{"id": 3, "name": "c"},
]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.get_all("foo/bar", 123))
label = await anext(async_it)
self.assertEqual(label, "a")
label = await anext(async_it)
self.assertEqual(label, "b")
label = await anext(async_it)
self.assertEqual(label, "c")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/issues/123/labels",
params={"per_page": "100"},
)
async def test_delete_all(self):
response = create_response()
self.client.delete.return_value = response
await self.api.delete_all("foo/bar", 123)
self.client.delete.assert_awaited_once_with(
"/repos/foo/bar/issues/123/labels"
)
async def test_set_all(self):
response = create_response()
self.client.post.return_value = response
await self.api.set_all("foo/bar", 123, ["a", "b"])
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/issues/123/labels", data={"labels": ["a", "b"]}
)
async def test_set_labels_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.set_all("foo/bar", 123, ["a", "b"])
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/issues/123/labels", data={"labels": ["a", "b"]}
)
pontos-25.3.2/tests/github/api/test_organizations.py 0000664 0000000 0000000 00000045264 14762555663 0022660 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=too-many-lines, redefined-builtin, line-too-long
from copy import deepcopy
from pathlib import Path
from unittest.mock import MagicMock
import httpx
from pontos.github.api.errors import GitHubApiError
from pontos.github.api.organizations import (
GitHubAsyncRESTOrganizations,
InvitationRole,
MemberFilter,
MemberRole,
)
from pontos.github.models.organization import RepositoryType
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
here = Path(__file__).parent
REPOSITORY_DICT = {
"id": 1,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": False,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {"admin": False, "push": False, "pull": True},
"forks": 1,
"open_issues": 0,
"watchers": 1,
}
MEMBER_DICT = {
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
}
class GitHubAsyncRESTOrganizationsTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTOrganizations
async def test_exists(self):
response = create_response(is_success=True)
self.client.get.return_value = response
self.assertTrue(await self.api.exists("foo"))
self.client.get.assert_awaited_once_with("/orgs/foo")
async def test_not_exists(self):
response = create_response(is_success=False)
self.client.get.return_value = response
self.assertFalse(await self.api.exists("foo"))
self.client.get.assert_awaited_once_with("/orgs/foo")
async def test_get_repositories(self):
response1 = create_response()
response1.json.return_value = [REPOSITORY_DICT]
response2 = create_response()
repository_dict2 = deepcopy(REPOSITORY_DICT)
repository_dict2["id"] = 2
repository_dict3 = deepcopy(REPOSITORY_DICT)
repository_dict3["id"] = 3
response2.json.return_value = [repository_dict2, repository_dict3]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.get_repositories("foo"))
repo = await anext(async_it)
self.assertEqual(repo.id, 1)
repo = await anext(async_it)
self.assertEqual(repo.id, 2)
repo = await anext(async_it)
self.assertEqual(repo.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/repos",
params={"per_page": "100", "type": "all"},
)
async def test_get_private_repositories(self):
response1 = create_response()
response1.json.return_value = [REPOSITORY_DICT]
response2 = create_response()
repository_dict2 = deepcopy(REPOSITORY_DICT)
repository_dict2["id"] = 2
repository_dict3 = deepcopy(REPOSITORY_DICT)
repository_dict3["id"] = 3
response2.json.return_value = [repository_dict2, repository_dict3]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(
self.api.get_repositories(
"foo", repository_type=RepositoryType.PRIVATE
)
)
repo = await anext(async_it)
self.assertEqual(repo.id, 1)
repo = await anext(async_it)
self.assertEqual(repo.id, 2)
repo = await anext(async_it)
self.assertEqual(repo.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/repos",
params={"per_page": "100", "type": "private"},
)
async def test_members(self):
response1 = create_response()
response1.json.return_value = [MEMBER_DICT]
response2 = create_response()
member_dict2 = deepcopy(MEMBER_DICT)
member_dict2["id"] = 2
member_dict3 = deepcopy(MEMBER_DICT)
member_dict3["id"] = 3
response2.json.return_value = [member_dict2, member_dict3]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.members("foo"))
member = await anext(async_it)
self.assertEqual(member.id, 1)
member = await anext(async_it)
self.assertEqual(member.id, 2)
member = await anext(async_it)
self.assertEqual(member.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/members",
params={"per_page": "100", "filter": "all", "role": "all"},
)
async def test_members_admins(self):
response1 = create_response()
response1.json.return_value = [MEMBER_DICT]
response2 = create_response()
member_dict2 = deepcopy(MEMBER_DICT)
member_dict2["id"] = 2
member_dict3 = deepcopy(MEMBER_DICT)
member_dict3["id"] = 3
response2.json.return_value = [member_dict2, member_dict3]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.members("foo", role=MemberRole.ADMIN))
member = await anext(async_it)
self.assertEqual(member.id, 1)
member = await anext(async_it)
self.assertEqual(member.id, 2)
member = await anext(async_it)
self.assertEqual(member.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/members",
params={"per_page": "100", "filter": "all", "role": "admin"},
)
async def test_members_filter(self):
response1 = create_response()
response1.json.return_value = [MEMBER_DICT]
response2 = create_response()
member_dict2 = deepcopy(MEMBER_DICT)
member_dict2["id"] = 2
member_dict3 = deepcopy(MEMBER_DICT)
member_dict3["id"] = 3
response2.json.return_value = [member_dict2, member_dict3]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(
self.api.members("foo", member_filter=MemberFilter.TWO_FA_DISABLED)
)
member = await anext(async_it)
self.assertEqual(member.id, 1)
member = await anext(async_it)
self.assertEqual(member.id, 2)
member = await anext(async_it)
self.assertEqual(member.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/members",
params={"per_page": "100", "filter": "2fa_disabled", "role": "all"},
)
async def test_invite_email(self):
response = create_response(is_success=False)
self.client.post.return_value = response
await self.api.invite(
"foo",
email="foo@bar.com",
)
self.client.post.assert_awaited_once_with(
"/orgs/foo/invitations",
data={"role": "direct_member", "email": "foo@bar.com"},
)
async def test_invite_invitee(self):
response = create_response(is_success=False)
self.client.post.return_value = response
await self.api.invite(
"foo",
invitee_id="foo",
)
self.client.post.assert_awaited_once_with(
"/orgs/foo/invitations",
data={"role": "direct_member", "invitee_id": "foo"},
)
async def test_invite_missing_user(self):
response = create_response(is_success=False)
self.client.post.return_value = response
with self.assertRaises(GitHubApiError):
await self.api.invite("foo")
async def test_invite_with_teams(self):
response = create_response(is_success=False)
self.client.post.return_value = response
await self.api.invite("foo", email="foo@bar.com", team_ids=("1", "2"))
self.client.post.assert_awaited_once_with(
"/orgs/foo/invitations",
data={
"role": "direct_member",
"email": "foo@bar.com",
"team_ids": ["1", "2"],
},
)
async def test_invite_with_role(self):
response = create_response(is_success=False)
self.client.post.return_value = response
await self.api.invite(
"foo", email="foo@bar.com", role=InvitationRole.ADMIN
)
self.client.post.assert_awaited_once_with(
"/orgs/foo/invitations",
data={
"role": "admin",
"email": "foo@bar.com",
},
)
async def test_remove_member(self):
response = create_response(is_success=False)
self.client.delete.return_value = response
await self.api.remove_member("foo", "bar")
self.client.delete.assert_awaited_once_with(
"/orgs/foo/memberships/bar",
)
async def test_remove_member_failure(self):
response = create_response()
self.client.delete.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.remove_member("foo", "bar")
self.client.delete.assert_awaited_once_with(
"/orgs/foo/memberships/bar",
)
async def test_outside_collaborators(self):
response1 = create_response()
response1.json.return_value = [MEMBER_DICT]
response2 = create_response()
member_dict2 = deepcopy(MEMBER_DICT)
member_dict2["id"] = 2
member_dict3 = deepcopy(MEMBER_DICT)
member_dict3["id"] = 3
response2.json.return_value = [member_dict2, member_dict3]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.outside_collaborators("foo"))
member = await anext(async_it)
self.assertEqual(member.id, 1)
member = await anext(async_it)
self.assertEqual(member.id, 2)
member = await anext(async_it)
self.assertEqual(member.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/outside_collaborators",
params={"per_page": "100", "filter": "all"},
)
async def test_outside_collaborators_filter(self):
response1 = create_response()
response1.json.return_value = [MEMBER_DICT]
response2 = create_response()
member_dict2 = deepcopy(MEMBER_DICT)
member_dict2["id"] = 2
member_dict3 = deepcopy(MEMBER_DICT)
member_dict3["id"] = 3
response2.json.return_value = [member_dict2, member_dict3]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(
self.api.outside_collaborators(
"foo", member_filter=MemberFilter.TWO_FA_DISABLED
)
)
member = await anext(async_it)
self.assertEqual(member.id, 1)
member = await anext(async_it)
self.assertEqual(member.id, 2)
member = await anext(async_it)
self.assertEqual(member.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/outside_collaborators",
params={"per_page": "100", "filter": "2fa_disabled"},
)
async def test_remove_outside_collaborator(self):
response = create_response(is_success=False)
self.client.delete.return_value = response
await self.api.remove_outside_collaborator("foo", "bar")
self.client.delete.assert_awaited_once_with(
"/orgs/foo/outside_collaborators/bar",
)
async def test_remove_outside_collaborator_failure(self):
response = create_response()
self.client.delete.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.remove_outside_collaborator("foo", "bar")
self.client.delete.assert_awaited_once_with(
"/orgs/foo/outside_collaborators/bar",
)
pontos-25.3.2/tests/github/api/test_packages.py 0000664 0000000 0000000 00000022174 14762555663 0021542 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
from pontos.github.api.packages import GitHubAsyncRESTPackages
from pontos.github.models.packages import (
Package,
PackageType,
PackageVersion,
PackageVisibility,
)
from pontos.testing import AsyncIteratorMock
from tests import aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
from .test_organizations import MEMBER_DICT, REPOSITORY_DICT
PACKAGE_VERSION = {
"id": 1,
"name": "v1.0.0",
"url": "https://api.github.com/orgs/foo/packages/container/bar/versions/1",
"package_html_url": "https://github.com/orgs/foo/packages/container/bar/versions",
"created_at": "2022-01-01T00:00:00Z",
"updated_at": "2022-01-01T00:00:00Z",
"html_url": "https://github.com/orgs/foo/packages/container/bar/1",
"metadata": {
"package_type": "container",
"container": {"tags": ["latest"]},
},
}
class GitHubAsyncRESTPackagesTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTPackages
async def test_exists(self):
response = create_response(is_success=True)
self.client.get.return_value = response
self.assertTrue(
await self.api.exists(
organization="foo",
package_type=PackageType.CONTAINER,
package_name="bar",
)
)
self.client.get.assert_awaited_once_with(
"/orgs/foo/packages/container/bar"
)
async def test_package(self):
response = create_response()
response.json.return_value = {
"id": 1,
"name": "bar",
"package_type": "container",
"owner": MEMBER_DICT,
"version_count": 1,
"visibility": "public",
"url": "https://api.github.com/orgs/foo/packages/container/bar",
"tags": ["foo", "bar", "baz"],
"created_at": "2022-01-01T00:00:00Z",
"updated_at": "2022-01-01T00:00:00Z",
"repository": REPOSITORY_DICT,
"html_url": "https://github.com/orgs/foo/packages/container/repo/bar",
}
self.client.get.return_value = response
package = await self.api.package("foo", PackageType.CONTAINER, "bar")
self.client.get.assert_awaited_once_with(
"/orgs/foo/packages/container/bar"
)
self.assertIsInstance(package, Package)
self.assertEqual(package.owner.login, "octocat")
self.assertEqual(package.name, "bar")
self.assertEqual(package.version_count, 1)
self.assertEqual(package.visibility, PackageVisibility.PUBLIC)
self.assertEqual(
package.url,
"https://api.github.com/orgs/foo/packages/container/bar",
)
self.assertEqual(package.tags, ["foo", "bar", "baz"])
self.assertEqual(package.created_at, "2022-01-01T00:00:00Z")
self.assertEqual(package.updated_at, "2022-01-01T00:00:00Z")
self.assertEqual(
package.html_url,
"https://github.com/orgs/foo/packages/container/repo/bar",
)
async def test_packages(self):
response = create_response()
response.json.return_value = [
{
"id": 1,
"name": "bar",
"package_type": "container",
"owner": MEMBER_DICT,
"version_count": 1,
"visibility": "public",
"url": "https://api.github.com/orgs/foo/packages/container/bar",
"tags": ["foo", "bar", "baz"],
"created_at": "2022-01-01T00:00:00Z",
"updated_at": "2022-01-01T00:00:00Z",
"repository": REPOSITORY_DICT,
"html_url": "https://github.com/orgs/foo/packages/container/repo/bar",
}
]
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.packages("foo", package_type=PackageType.CONTAINER)
)
package = await anext(async_it)
self.assertEqual(package.id, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/packages/container",
params={"per_page": "100"},
)
async def test_package_version(self):
response = create_response()
response.json.return_value = PACKAGE_VERSION
self.client.get.return_value = response
package_version: PackageVersion = await self.api.package_version(
"foo", PackageType.CONTAINER, "bar", 1
)
self.client.get.assert_awaited_once_with(
"/orgs/foo/packages/container/bar/versions/1"
)
self.assertEqual(package_version.id, 1)
self.assertEqual(package_version.name, "v1.0.0")
self.assertEqual(
package_version.url,
"https://api.github.com/orgs/foo/packages/container/bar/versions/1",
)
self.assertEqual(
package_version.package_html_url,
"https://github.com/orgs/foo/packages/container/bar/versions",
)
self.assertEqual(package_version.created_at, "2022-01-01T00:00:00Z")
self.assertEqual(package_version.updated_at, "2022-01-01T00:00:00Z")
self.assertEqual(
package_version.html_url,
"https://github.com/orgs/foo/packages/container/bar/1",
)
self.assertEqual(
package_version.metadata.package_type, PackageType.CONTAINER
)
self.assertEqual(package_version.metadata.container.tags, ["latest"])
async def test_package_version_tags(self):
response = create_response()
response.json.return_value = {
"metadata": {"container": {"tags": ["latest", "stable"]}}
}
self.client.get.return_value = response
tags = await self.api.package_version_tags(
organization="foo",
package_type=PackageType.CONTAINER,
package_name="bar",
version=1,
)
self.client.get.assert_awaited_once_with(
"/orgs/foo/packages/container/bar/versions/1"
)
self.assertEqual(tags, ["latest", "stable"])
async def test_delete_package(self):
response = create_response(is_success=True)
self.client.delete.return_value = response
await self.api.delete_package(
organization="foo",
package_type=PackageType.CONTAINER,
package_name="bar",
)
self.client.delete.assert_awaited_once_with(
"/orgs/foo/packages/container/bar"
)
async def test_delete_package_version(self):
response = create_response(is_success=True)
self.client.delete.return_value = response
await self.api.delete_package_version(
organization="foo",
package_type=PackageType.CONTAINER,
package_name="bar",
version=1,
)
self.client.delete.assert_awaited_once_with(
"/orgs/foo/packages/container/bar/versions/1"
)
async def test_package_versions(self):
response1 = create_response()
response1.json.return_value = [PACKAGE_VERSION]
response2 = create_response()
package_version2 = PACKAGE_VERSION.copy()
package_version2["id"] = 2
response2.json.return_value = [package_version2]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(
self.api.package_versions("foo", PackageType.CONTAINER, "bar")
)
package_version = await anext(async_it)
self.assertEqual(package_version.id, 1)
package_version = await anext(async_it)
self.assertEqual(package_version.id, 2)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/packages/container/bar/versions"
)
async def test_delete_package_with_tag(self):
response = create_response(is_success=True)
self.client.delete.return_value = response
package_version_response = create_response()
package_version_response.json.return_value = [PACKAGE_VERSION]
self.client.get_all.return_value = AsyncIteratorMock(
[package_version_response]
)
tags_response = create_response()
tags_response.json.return_value = {
"metadata": {"container": {"tags": ["latest", "stable"]}}
}
self.client.get.return_value = tags_response
await self.api.delete_package_with_tag(
organization="foo",
package_type=PackageType.CONTAINER,
package_name="bar",
tag="latest",
)
self.client.get_all.assert_called_once_with(
"/orgs/foo/packages/container/bar/versions"
)
self.client.get.assert_awaited_once_with(
"/orgs/foo/packages/container/bar/versions/1"
)
self.client.delete.assert_awaited_once_with(
"/orgs/foo/packages/container/bar/versions/1"
)
pontos-25.3.2/tests/github/api/test_pull_requests.py 0000664 0000000 0000000 00000161071 14762555663 0022673 0 ustar 00root root 0000000 0000000 # Copyright (C) 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=redefined-builtin, line-too-long, too-many-lines
# ruff: noqa: E501
from pathlib import Path
from unittest.mock import MagicMock
from httpx import HTTPStatusError
from pontos.github.api.pull_requests import GitHubAsyncRESTPullRequests
from pontos.github.models.base import FileStatus
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
here = Path(__file__).parent
PULL_REQUEST_JSON = {
"url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
"id": 1,
"node_id": "MDExOlB1bGxSZXF1ZXN0MQ==",
"html_url": "https://github.com/octocat/Hello-World/pull/1347",
"diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
"patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",
"issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
"review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
"review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"number": 1347,
"state": "open",
"locked": True,
"title": "Amazing new feature",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"body": "Please pull these awesome changes in!",
"labels": [
{
"id": 208045946,
"node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
"url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
"name": "bug",
"description": "Something isn't working",
"color": "f29513",
"default": True,
}
],
"milestone": {
"url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
"html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
"id": 1002604,
"node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
"number": 1,
"state": "open",
"title": "v1.0",
"description": "Tracking milestone for version 1.0",
"creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"open_issues": 4,
"closed_issues": 8,
"created_at": "2011-04-10T20:09:31Z",
"updated_at": "2014-03-03T18:58:10Z",
"closed_at": "2013-02-12T13:22:01Z",
"due_on": "2012-10-09T23:39:01Z",
},
"active_lock_reason": "too heated",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:01:12Z",
"closed_at": "2011-01-26T19:01:12Z",
"merged_at": "2011-01-26T19:01:12Z",
"merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
"assignee": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"assignees": [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
{
"login": "hubot",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/hubot_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/hubot",
"html_url": "https://github.com/hubot",
"followers_url": "https://api.github.com/users/hubot/followers",
"following_url": "https://api.github.com/users/hubot/following{/other_user}",
"gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
"organizations_url": "https://api.github.com/users/hubot/orgs",
"repos_url": "https://api.github.com/users/hubot/repos",
"events_url": "https://api.github.com/users/hubot/events{/privacy}",
"received_events_url": "https://api.github.com/users/hubot/received_events",
"type": "User",
"site_admin": True,
},
],
"requested_reviewers": [
{
"login": "other_user",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/other_user_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/other_user",
"html_url": "https://github.com/other_user",
"followers_url": "https://api.github.com/users/other_user/followers",
"following_url": "https://api.github.com/users/other_user/following{/other_user}",
"gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
"starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
"organizations_url": "https://api.github.com/users/other_user/orgs",
"repos_url": "https://api.github.com/users/other_user/repos",
"events_url": "https://api.github.com/users/other_user/events{/privacy}",
"received_events_url": "https://api.github.com/users/other_user/received_events",
"type": "User",
"site_admin": False,
}
],
"requested_teams": [
{
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
}
],
"head": {
"label": "octocat:new-topic",
"ref": "new-topic",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"repo": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": False,
"push": False,
"pull": True,
},
"allow_rebase_merge": True,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": True,
"allow_merge_commit": True,
"allow_forking": True,
"forks": 123,
"open_issues": 123,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
},
"watchers": 123,
},
},
"base": {
"label": "octocat:master",
"ref": "master",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"repo": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": False,
"push": False,
"pull": True,
},
"allow_rebase_merge": True,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": True,
"allow_merge_commit": True,
"forks": 123,
"open_issues": 123,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
},
"watchers": 123,
},
},
"_links": {
"self": {
"href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
},
"html": {"href": "https://github.com/octocat/Hello-World/pull/1347"},
"issue": {
"href": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
},
"comments": {
"href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments"
},
"review_comments": {
"href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments"
},
"review_comment": {
"href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}"
},
"commits": {
"href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits"
},
"statuses": {
"href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e"
},
},
"author_association": "OWNER",
"auto_merge": None,
"draft": False,
"merged": False,
"mergeable": True,
"rebaseable": True,
"mergeable_state": "clean",
"merged_by": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"comments": 10,
"review_comments": 0,
"maintainer_can_modify": True,
"commits": 3,
"additions": 100,
"deletions": 3,
"changed_files": 5,
}
COMMENT_JSON = {
"id": 1,
"node_id": "MDEyOklzc3VlQ29tbWVudDE=",
"url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
"html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1",
"body": "Me too",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"created_at": "2011-04-14T16:00:49Z",
"updated_at": "2011-04-14T16:00:49Z",
"issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
"author_association": "COLLABORATOR",
}
class GitHubAsyncRESTPullRequestsTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTPullRequests
async def test_exists(self):
response = create_response(is_success=True)
self.client.get.return_value = response
self.assertTrue(await self.api.exists("foo/bar", 123))
self.client.get.assert_awaited_once_with("/repos/foo/bar/pulls/123")
async def test_not_exists(self):
response = create_response(is_success=False)
self.client.get.return_value = response
self.assertFalse(await self.api.exists("foo/bar", 123))
self.client.get.assert_awaited_once_with("/repos/foo/bar/pulls/123")
async def test_commits(self):
response1 = create_response()
response1.json.return_value = [
{
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db51",
"node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
"html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
"commit": {
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"author": {
"name": "Monalisa Octocat",
"email": "support@github.com",
"date": "2011-04-14T16:00:49Z",
},
"committer": {
"name": "Monalisa Octocat",
"email": "support@github.com",
"date": "2011-04-14T16:00:49Z",
},
"message": "Fix all the bugs",
"tree": {
"url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
},
"comment_count": 0,
"verification": {
"verified": False,
"reason": "unsigned",
"signature": None,
"payload": None,
},
},
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"committer": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"parents": [
{
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
}
],
}
]
response2 = create_response()
response2.json.return_value = [
{
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db52",
"node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==",
"html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
"commit": {
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"author": {
"name": "Monalisa Octocat",
"email": "support@github.com",
"date": "2011-04-14T16:00:49Z",
},
"committer": {
"name": "Monalisa Octocat",
"email": "support@github.com",
"date": "2011-04-14T16:00:49Z",
},
"message": "Fix all the bugs",
"tree": {
"url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
},
"comment_count": 0,
"verification": {
"verified": False,
"reason": "unsigned",
"signature": None,
"payload": None,
},
},
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"committer": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"parents": [
{
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
}
],
},
{
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db53",
"node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", # noqa: E501
"html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments",
"commit": {
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"author": {
"name": "Monalisa Octocat",
"email": "support@github.com",
"date": "2011-04-14T16:00:49Z",
},
"committer": {
"name": "Monalisa Octocat",
"email": "support@github.com",
"date": "2011-04-14T16:00:49Z",
},
"message": "Fix all the bugs",
"tree": {
"url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
},
"comment_count": 0,
"verification": {
"verified": False,
"reason": "unsigned",
"signature": None,
"payload": None,
},
},
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"committer": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"parents": [
{
"url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
}
],
},
]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.commits("foo/bar", 123))
commit = await anext(async_it)
self.assertEqual(commit.sha, "6dcb09b5b57875f334f61aebed695e2e4193db51")
commit = await anext(async_it)
self.assertEqual(commit.sha, "6dcb09b5b57875f334f61aebed695e2e4193db52")
commit = await anext(async_it)
self.assertEqual(commit.sha, "6dcb09b5b57875f334f61aebed695e2e4193db53")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/pulls/123/commits",
params={"per_page": "100"},
)
async def test_create(self):
response = create_response()
response.json.return_value = PULL_REQUEST_JSON
self.client.post.return_value = response
pr = await self.api.create(
"foo/bar",
head_branch="main",
base_branch="baz",
title="Lorem",
body="Ipsum",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/pulls",
data={
"head": "main",
"base": "baz",
"title": "Lorem",
"body": "Ipsum",
},
)
self.assertEqual(pr.id, 1)
async def test_create_failure(self):
response = create_response()
self.client.post.side_effect = HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(HTTPStatusError):
await self.api.create(
"foo/bar",
head_branch="main",
base_branch="baz",
title="Lorem",
body="Ipsum",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/pulls",
data={
"head": "main",
"base": "baz",
"title": "Lorem",
"body": "Ipsum",
},
)
async def test_update(self):
response = create_response()
response.json.return_value = PULL_REQUEST_JSON
self.client.post.return_value = response
pr = await self.api.update(
"foo/bar",
123,
base_branch="baz",
title="Lorem",
body="Ipsum",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/pulls/123",
data={
"base": "baz",
"title": "Lorem",
"body": "Ipsum",
},
)
self.assertEqual(pr.id, 1)
async def test_update_simple(self):
response = create_response()
response.json.return_value = PULL_REQUEST_JSON
self.client.post.return_value = response
pr = await self.api.update(
"foo/bar",
123,
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/pulls/123",
data={},
)
self.assertEqual(pr.id, 1)
async def test_update_failure(self):
response = create_response()
self.client.post.side_effect = HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(HTTPStatusError):
await self.api.update(
"foo/bar",
123,
base_branch="baz",
title="Lorem",
body="Ipsum",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/pulls/123",
data={
"base": "baz",
"title": "Lorem",
"body": "Ipsum",
},
)
async def test_add_comment(self):
response = create_response()
response.json.return_value = COMMENT_JSON
self.client.post.return_value = response
comment = await self.api.add_comment(
"foo/bar",
123,
"Lorem Ipsum",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/issues/123/comments",
data={
"body": "Lorem Ipsum",
},
)
self.assertEqual(comment.id, 1)
async def test_add_comment_failure(self):
response = create_response()
self.client.post.side_effect = HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(HTTPStatusError):
await self.api.add_comment(
"foo/bar",
123,
"Lorem Ipsum",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/issues/123/comments",
data={
"body": "Lorem Ipsum",
},
)
async def test_update_comment(self):
response = create_response()
response.json.return_value = COMMENT_JSON
self.client.post.return_value = response
comment = await self.api.update_comment(
"foo/bar",
123,
"Lorem Ipsum",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/issues/comments/123",
data={
"body": "Lorem Ipsum",
},
)
self.assertEqual(comment.id, 1)
async def test_update_comment_failure(self):
response = create_response()
self.client.post.side_effect = HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(HTTPStatusError):
await self.api.update_comment(
"foo/bar",
123,
"Lorem Ipsum",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/issues/comments/123",
data={
"body": "Lorem Ipsum",
},
)
async def test_comments(self):
response1 = create_response()
response1.json.return_value = [
{
"id": 1,
"node_id": "MDEyOklzc3VlQ29tbWVudDE=",
"url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
"html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1",
"body": "Me too",
"created_at": "2011-04-14T16:00:49Z",
"updated_at": "2011-04-14T16:00:49Z",
"issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
"author_association": "COLLABORATOR",
},
{
"id": 2,
"node_id": "MDEyOklzc3VlQ29tbWVudDE=",
"url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/2",
"html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-2",
"body": "Me too",
"created_at": "2011-04-14T16:00:49Z",
"updated_at": "2011-04-14T16:00:49Z",
"issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
"author_association": "COLLABORATOR",
},
]
response2 = create_response()
response2.json.return_value = [
{
"id": 3,
"node_id": "MDEyOklzc3VlQ29tbWVudDE=",
"url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/3",
"html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-3",
"body": "Me too",
"created_at": "2011-04-14T16:00:49Z",
"updated_at": "2011-04-14T16:00:49Z",
"issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
"author_association": "COLLABORATOR",
},
]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
it = aiter(self.api.comments("foo/bar", 123))
comment = await anext(it)
self.assertEqual(comment.id, 1)
comment = await anext(it)
self.assertEqual(comment.id, 2)
comment = await anext(it)
self.assertEqual(comment.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/issues/123/comments",
params={"per_page": "100"},
)
async def test_comments_failure(self):
response = create_response()
self.client.get_all.side_effect = [
HTTPStatusError("404", request=MagicMock(), response=response)
]
it = aiter(self.api.comments("foo/bar", 123))
with self.assertRaises(HTTPStatusError):
await anext(it)
async def test_files(self):
response1 = create_response()
response1.json.return_value = [
{"filename": "baz", "status": FileStatus.MODIFIED.value}
]
response2 = create_response()
response2.json.return_value = [
{"filename": "foo", "status": FileStatus.DELETED.value},
{"filename": "bar", "status": FileStatus.MODIFIED.value},
]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
files = await self.api.files("foo/bar", 123)
self.assertEqual(len(files), 2)
self.assertEqual(len(files[FileStatus.MODIFIED]), 2)
self.assertEqual(len(files[FileStatus.DELETED]), 1)
self.assertEqual(len(files[FileStatus.ADDED]), 0)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/pulls/123/files",
params={"per_page": "100"},
)
async def test_files_failure(self):
response = create_response()
self.client.get_all.side_effect = [
HTTPStatusError("404", request=MagicMock(), response=response)
]
with self.assertRaises(HTTPStatusError):
await self.api.files("foo/bar", 123)
async def test_files_with_status_list(self):
response1 = create_response()
response1.json.return_value = [
{"filename": "baz", "status": FileStatus.MODIFIED.value}
]
response2 = create_response()
response2.json.return_value = [
{"filename": "foo", "status": FileStatus.DELETED.value},
{"filename": "bar", "status": FileStatus.MODIFIED.value},
]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
files = await self.api.files(
"foo/bar", 123, status_list=[FileStatus.ADDED, FileStatus.MODIFIED]
)
self.assertEqual(len(files), 1)
self.assertEqual(len(files[FileStatus.MODIFIED]), 2)
self.assertEqual(len(files[FileStatus.DELETED]), 0)
self.assertEqual(len(files[FileStatus.ADDED]), 0)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/pulls/123/files",
params={"per_page": "100"},
)
async def test_get(self):
response = create_response()
response.json.return_value = PULL_REQUEST_JSON
self.client.get.return_value = response
pr = await self.api.get(
"foo/bar",
1,
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/pulls/1",
)
self.assertEqual(pr.id, 1)
async def test_get_failure(self):
response = create_response()
self.client.get.side_effect = HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(HTTPStatusError):
await self.api.get("foo/bar", 123)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/pulls/123",
)
pontos-25.3.2/tests/github/api/test_release.py 0000664 0000000 0000000 00000041507 14762555663 0021405 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=redefined-builtin, line-too-long, too-many-lines
from pathlib import Path
from unittest.mock import MagicMock, call
import httpx
from pontos.github.api.release import GitHubAsyncRESTReleases
from tests import AsyncIteratorMock, AsyncMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
here = Path(__file__).parent
RELEASE_JSON = {
"url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
"html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
"assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
"upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
"tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
"zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
"discussion_url": "https://github.com/octocat/Hello-World/discussions/90",
"id": 1,
"node_id": "MDc6UmVsZWFzZTE=",
"tag_name": "v1.0.0",
"target_commitish": "master",
"name": "v1.0.0",
"body": "Description of the release",
"draft": False,
"prerelease": False,
"created_at": "2013-02-27T19:35:32Z",
"published_at": "2013-02-27T19:35:32Z",
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"assets": [
{
"url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
"browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
"id": 1,
"node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
"name": "example.zip",
"label": "short description",
"state": "uploaded",
"content_type": "application/zip",
"size": 1024,
"download_count": 42,
"created_at": "2013-02-27T19:35:32Z",
"updated_at": "2013-02-27T19:35:32Z",
"uploader": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
}
],
}
class GitHubAsyncRESTReleasesTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTReleases
async def test_exists(self):
response = create_response(is_success=True)
self.client.get.return_value = response
self.assertTrue(await self.api.exists("foo/bar", "v1.2.3"))
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/releases/tags/v1.2.3"
)
async def test_not_exists(self):
response = create_response(is_success=False)
self.client.get.return_value = response
self.assertFalse(await self.api.exists("foo/bar", "v1.2.3"))
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/releases/tags/v1.2.3"
)
async def test_create(self):
response = create_response()
response.json.return_value = RELEASE_JSON
self.client.post.return_value = response
release = await self.api.create(
"foo/bar",
"v1.2.3",
body="foo",
name="baz",
target_commitish="stable",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/releases",
data={
"tag_name": "v1.2.3",
"draft": False,
"prerelease": False,
"name": "baz",
"body": "foo",
"target_commitish": "stable",
},
)
self.assertEqual(release.id, 1)
async def test_create_simple(self):
response = create_response()
response.json.return_value = RELEASE_JSON
self.client.post.return_value = response
release = await self.api.create(
"foo/bar",
"v1.2.3",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/releases",
data={
"tag_name": "v1.2.3",
"draft": False,
"prerelease": False,
},
)
self.assertEqual(release.id, 1)
async def test_create_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.create(
"foo/bar",
"v1.2.3",
body="foo",
name="baz",
target_commitish="stable",
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/releases",
data={
"tag_name": "v1.2.3",
"draft": False,
"prerelease": False,
"name": "baz",
"body": "foo",
"target_commitish": "stable",
},
)
async def test_get(self):
response = create_response()
response.json.return_value = RELEASE_JSON
self.client.get.return_value = response
release = await self.api.get(
"foo/bar",
"v1.2.3",
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/releases/tags/v1.2.3",
)
self.assertEqual(release.id, 1)
async def test_get_failure(self):
response = create_response()
self.client.get.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.get(
"foo/bar",
"v1.2.3",
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/releases/tags/v1.2.3",
)
async def test_download_release_tarball(self):
response = create_response(headers=MagicMock())
response.headers.get.return_value = 2
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
stream_context = AsyncMock()
stream_context.__aenter__.return_value = response
self.client.stream.return_value = stream_context
async with self.api.download_release_tarball(
"foo/bar", "v1.2.3"
) as download_iterable:
it = aiter(download_iterable)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
self.client.stream.assert_called_once_with(
"https://github.com/foo/bar/archive/refs/tags/v1.2.3.tar.gz"
)
async def test_download_release_zip(self):
response = create_response(headers=MagicMock())
response.headers.get.return_value = 2
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
stream_context = AsyncMock()
stream_context.__aenter__.return_value = response
self.client.stream.return_value = stream_context
async with self.api.download_release_zip(
"foo/bar", "v1.2.3"
) as download_iterable:
it = aiter(download_iterable)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
self.client.stream.assert_called_once_with(
"https://github.com/foo/bar/archive/refs/tags/v1.2.3.zip"
)
async def test_download_release_assets(self):
get_assets_url_response = create_response()
data = RELEASE_JSON.copy()
data.update({"assets_url": "https://foo.bar/assets"})
get_assets_url_response.json.return_value = data
get_assets_response = create_response()
get_assets_response.json.return_value = [
{"browser_download_url": "http://bar", "name": "bar"},
{"browser_download_url": "http://baz", "name": "baz"},
]
response = create_response(headers=MagicMock())
response.headers.get.return_value = 2
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
stream_context = AsyncMock()
stream_context.__aenter__.return_value = response
self.client.stream.return_value = stream_context
self.client.get.side_effect = [
get_assets_url_response,
get_assets_response,
]
assets_it = aiter(self.api.download_release_assets("foo/bar", "v1.2.3"))
name, cm = await anext(assets_it)
self.client.get.assert_has_awaits(
[
call("/repos/foo/bar/releases/tags/v1.2.3"),
call("https://foo.bar/assets"),
]
)
self.client.stream.assert_called_once_with("http://bar")
self.assertEqual(name, "bar")
async with cm as progress_it:
it = aiter(progress_it)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
self.client.stream.reset_mock()
response = create_response(headers=MagicMock())
response.headers.get.return_value = 2
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
stream_context = AsyncMock()
stream_context.__aenter__.return_value = response
self.client.stream.return_value = stream_context
name, cm = await anext(assets_it)
self.client.stream.assert_called_once_with("http://baz")
self.assertEqual(name, "baz")
async with cm as progress_it:
it = aiter(progress_it)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
with self.assertRaises(StopAsyncIteration):
await anext(assets_it)
async def test_download_release_assets_no_assets_url(self):
get_assets_url_response = create_response()
data = RELEASE_JSON.copy()
data.update({"assets_url": None})
get_assets_url_response.json.return_value = data
self.client.get.return_value = get_assets_url_response
assets_it = aiter(self.api.download_release_assets("foo/bar", "v1.2.3"))
with self.assertRaises(RuntimeError):
await anext(assets_it)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/releases/tags/v1.2.3"
)
async def test_download_release_assets_filter(self):
get_assets_url_response = create_response()
data = RELEASE_JSON.copy()
data.update({"assets_url": "https://foo.bar/assets"})
get_assets_url_response.json.return_value = data
get_assets_response = create_response()
get_assets_response.json.return_value = [
{"browser_download_url": "http://bar", "name": "bar"},
{"browser_download_url": "http://baz", "name": "baz"},
]
response = create_response(headers=MagicMock())
response.headers.get.return_value = 2
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
stream_context = AsyncMock()
stream_context.__aenter__.return_value = response
self.client.stream.return_value = stream_context
self.client.get.side_effect = [
get_assets_url_response,
get_assets_response,
]
assets_it = aiter(
self.api.download_release_assets(
"foo/bar", "v1.2.3", match_pattern="*r"
)
)
name, cm = await anext(assets_it)
self.client.get.assert_has_awaits(
[
call("/repos/foo/bar/releases/tags/v1.2.3"),
call("https://foo.bar/assets"),
]
)
self.client.stream.assert_called_once_with("http://bar")
self.assertEqual(name, "bar")
async with cm as progress_it:
it = aiter(progress_it)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
with self.assertRaises(StopAsyncIteration):
await anext(assets_it)
async def test_upload_release_assets(self):
response = create_response()
data = RELEASE_JSON.copy()
data.update({"upload_url": "https://uploads/assets{?name,label}"})
response.json.return_value = data
post_response = create_response()
self.client.get.return_value = response
self.client.post.return_value = post_response
file1 = MagicMock(spec=Path)
file1.name = "foo.txt"
content1 = b"foo"
file1.open.return_value.__enter__.return_value.read.side_effect = [
content1
]
file2 = MagicMock(spec=Path)
file2.name = "bar.pdf"
content2 = b"bar"
file2.open.return_value.__enter__.return_value.read.side_effect = [
content2
]
upload_files = [file1, (file2, "application/pdf")]
def assert_file1(index: int):
args = self.client.post.await_args_list[index].args
self.assertEqual(args, ("https://uploads/assets",))
kwargs = self.client.post.await_args_list[index].kwargs
self.assertEqual(kwargs["params"], {"name": "foo.txt"})
self.assertEqual(kwargs["content_type"], "application/octet-stream")
def assert_file2(index: int):
args = self.client.post.await_args_list[index].args
self.assertEqual(args, ("https://uploads/assets",))
kwargs = self.client.post.await_args_list[index].kwargs
self.assertEqual(kwargs["params"], {"name": "bar.pdf"})
self.assertEqual(kwargs["content_type"], "application/pdf")
it = aiter(
self.api.upload_release_assets("foo/bar", "v1.2.3", upload_files)
)
# the order of the files is non-deterministic
f = await anext(it)
if f == file1:
assert_file1(0)
else:
assert_file2(0)
f = await anext(it)
if f == file1:
assert_file1(1)
else:
assert_file2(1)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/releases/tags/v1.2.3"
)
pontos-25.3.2/tests/github/api/test_repositories.py 0000664 0000000 0000000 00000112567 14762555663 0022521 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
from unittest.mock import MagicMock
import httpx
from pontos.github.api.repositories import (
GitHubAsyncRESTRepositories,
GitIgnoreTemplate,
LicenseType,
MergeCommitMessage,
MergeCommitTitle,
SquashMergeCommitMessage,
SquashMergeCommitTitle,
)
from tests.github.api import GitHubAsyncRESTTestCase, create_response
REPOSITORY_JSON = {
"id": 1,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,
"watchers_count": 80,
"watchers": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"open_issues": 0,
"is_template": False,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {"pull": True, "push": False, "admin": False},
"allow_rebase_merge": True,
"template_repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World-Template",
"full_name": "octocat/Hello-World-Template",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World-Template",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World-Template",
"archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World-Template.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World-Template.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World-Template.git",
"mirror_url": "git:git.example.com/octocat/Hello-World-Template",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World-Template",
"homepage": "https://github.com",
"language": None,
"forks": 9,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"watchers": 80,
"size": 108,
"default_branch": "master",
"open_issues": 0,
"open_issues_count": 0,
"is_template": True,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://api.github.com/licenses/mit",
},
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {"admin": False, "push": False, "pull": True},
"allow_rebase_merge": True,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": True,
"allow_auto_merge": False,
"delete_branch_on_merge": True,
"allow_merge_commit": True,
"subscribers_count": 42,
"network_count": 0,
},
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": True,
"allow_auto_merge": False,
"delete_branch_on_merge": True,
"allow_merge_commit": True,
"subscribers_count": 42,
"network_count": 0,
"license": {
"key": "mit",
"name": "MIT License",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit",
"node_id": "MDc6TGljZW5zZW1pdA==",
},
"organization": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "Organization",
"site_admin": False,
},
"parent": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": True,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {"admin": False, "push": False, "pull": True},
"allow_rebase_merge": True,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": True,
"allow_auto_merge": False,
"delete_branch_on_merge": True,
"allow_merge_commit": True,
"subscribers_count": 42,
"network_count": 0,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://api.github.com/licenses/mit",
},
"forks": 1,
"open_issues": 1,
"watchers": 1,
},
"source": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": True,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {"admin": False, "push": False, "pull": True},
"allow_rebase_merge": True,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": True,
"allow_auto_merge": False,
"delete_branch_on_merge": True,
"allow_merge_commit": True,
"subscribers_count": 42,
"network_count": 0,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://api.github.com/licenses/mit",
},
"forks": 1,
"open_issues": 1,
"watchers": 1,
},
}
class GitHubAsyncRESTRepositoriesTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTRepositories
async def test_get(self):
response = create_response()
response.json.return_value = REPOSITORY_JSON
self.client.get.return_value = response
repo = await self.api.get("foo/bar")
self.client.get.assert_awaited_once_with("/repos/foo/bar")
self.assertEqual(repo.id, 1)
async def test_get_failure(self):
response = create_response()
self.client.get.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.get("foo/bar")
self.client.get.assert_awaited_once_with("/repos/foo/bar")
async def test_delete(self):
response = create_response()
self.client.delete.return_value = response
await self.api.delete("foo/bar")
self.client.delete.assert_awaited_once_with("/repos/foo/bar")
async def test_delete_failure(self):
response = create_response()
self.client.delete.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.delete("foo/bar")
self.client.delete.assert_awaited_once_with("/repos/foo/bar")
async def test_create_with_defaults(self):
response = create_response()
response.json.return_value = REPOSITORY_JSON
self.client.post.return_value = response
repo = await self.api.create("foo", "bar")
self.client.post.assert_awaited_once_with(
"/orgs/foo/repos",
data={
"name": "bar",
"private": False,
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"is_template": False,
"has_downloads": True,
"auto_init": False,
"allow_squash_merge": True,
"allow_merge_commit": True,
"allow_rebase_merge": True,
"allow_auto_merge": False,
"allow_update_branch": False,
"delete_branch_on_merge": False,
},
)
self.assertEqual(repo.id, 1)
async def test_create(self):
response = create_response()
response.json.return_value = REPOSITORY_JSON
self.client.post.return_value = response
repo = await self.api.create(
"foo",
"bar",
private=True,
has_issues=False,
has_projects=False,
has_wiki=False,
is_template=True,
team_id="123",
has_downloads=False,
auto_init=True,
gitignore_template=GitIgnoreTemplate.PYTHON,
license_template=LicenseType.MIT,
allow_squash_merge=False,
allow_merge_commit=False,
allow_rebase_merge=False,
allow_auto_merge=True,
allow_update_branch=True,
delete_branch_on_merge=True,
squash_merge_commit_title=SquashMergeCommitTitle.COMMIT_OR_PR_TITLE,
squash_merge_commit_message=SquashMergeCommitMessage.PR_BODY,
merge_commit_title=MergeCommitTitle.MERGE_MESSAGE,
merge_commit_message=MergeCommitMessage.PR_BODY,
)
self.client.post.assert_awaited_once_with(
"/orgs/foo/repos",
data={
"name": "bar",
"private": True,
"has_issues": False,
"has_projects": False,
"has_wiki": False,
"is_template": True,
"team_id": "123",
"has_downloads": False,
"auto_init": True,
"license_template": "mit",
"gitignore_template": "Python",
"allow_squash_merge": False,
"allow_merge_commit": False,
"allow_rebase_merge": False,
"allow_auto_merge": True,
"allow_update_branch": True,
"delete_branch_on_merge": True,
"squash_merge_commit_title": "COMMIT_OR_PR_TITLE",
"squash_merge_commit_message": "PR_BODY",
"merge_commit_title": "MERGE_MESSAGE",
"merge_commit_message": "PR_BODY",
},
)
self.assertEqual(repo.id, 1)
async def test_archive(self):
response = create_response()
self.client.post.return_value = response
await self.api.archive("foo/bar")
self.client.post.assert_awaited_once_with(
"/repos/foo/bar", data={"archived": True}
)
async def test_archive_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.archive("foo/bar")
self.client.post.assert_awaited_once_with(
"/repos/foo/bar", data={"archived": True}
)
async def test_update(self):
response = create_response()
response.json.return_value = REPOSITORY_JSON
self.client.post.return_value = response
repo = await self.api.update(
"foo/bar",
name="baz",
description="A new Baz",
homepage="http://baz.com",
private=True,
has_issues=False,
has_projects=False,
has_wiki=False,
is_template=True,
allow_squash_merge=False,
allow_merge_commit=False,
allow_rebase_merge=False,
allow_auto_merge=True,
allow_update_branch=True,
delete_branch_on_merge=True,
squash_merge_commit_title=SquashMergeCommitTitle.PR_TITLE,
squash_merge_commit_message=SquashMergeCommitMessage.PR_BODY,
merge_commit_title=MergeCommitTitle.PR_TITLE,
merge_commit_message=MergeCommitMessage.PR_BODY,
allow_forking=True,
web_commit_signoff_required=True,
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar",
data={
"name": "baz",
"description": "A new Baz",
"homepage": "http://baz.com",
"private": True,
"has_issues": False,
"has_projects": False,
"has_wiki": False,
"is_template": True,
"allow_squash_merge": False,
"allow_merge_commit": False,
"allow_rebase_merge": False,
"allow_auto_merge": True,
"allow_update_branch": True,
"delete_branch_on_merge": True,
"squash_merge_commit_title": "PR_TITLE",
"squash_merge_commit_message": "PR_BODY",
"merge_commit_title": "PR_TITLE",
"merge_commit_message": "PR_BODY",
"allow_forking": True,
"web_commit_signoff_required": True,
},
)
self.assertEqual(repo.id, 1)
async def test_update_with_defaults(self):
response = create_response()
response.json.return_value = REPOSITORY_JSON
self.client.post.return_value = response
repo = await self.api.update("foo/bar")
self.client.post.assert_awaited_once_with(
"/repos/foo/bar",
data={
"private": False,
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"is_template": False,
"allow_squash_merge": True,
"allow_merge_commit": True,
"allow_rebase_merge": True,
"allow_auto_merge": False,
"allow_update_branch": False,
"delete_branch_on_merge": False,
"allow_forking": False,
"web_commit_signoff_required": False,
},
)
self.assertEqual(repo.id, 1)
async def test_update_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.update("foo/bar")
self.client.post.assert_awaited_once_with(
"/repos/foo/bar",
data={
"private": False,
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"is_template": False,
"allow_squash_merge": True,
"allow_merge_commit": True,
"allow_rebase_merge": True,
"allow_auto_merge": False,
"allow_update_branch": False,
"delete_branch_on_merge": False,
"allow_forking": False,
"web_commit_signoff_required": False,
},
)
async def test_get_topics(self):
response = create_response()
response.json.return_value = {"names": ["foo", "bar", "baz"]}
self.client.get.return_value = response
topics = await self.api.topics("foo/bar")
self.client.get.assert_awaited_once_with("/repos/foo/bar/topics")
self.assertEqual(len(topics), 3)
self.assertEqual(topics, ["foo", "bar", "baz"])
async def test_update_topics(self):
response = create_response()
response.json.return_value = {}
response.json.return_value = {"names": ["foo", "bar"]}
self.client.put.return_value = response
new_topics = await self.api.update_topics(
"foo/bar",
(
"foo",
"bar",
),
)
self.client.put.assert_awaited_once_with(
"/repos/foo/bar/topics", data={"names": ["foo", "bar"]}
)
self.assertEqual(len(new_topics), 2)
self.assertEqual(new_topics, ["foo", "bar"])
pontos-25.3.2/tests/github/api/test_search.py 0000664 0000000 0000000 00000056460 14762555663 0021236 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=redefined-builtin, line-too-long
from pontos.github.api.search import GitHubAsyncRESTSearch
from pontos.github.models.search import (
InNameQualifier,
IsPublicQualifier,
OrganizationQualifier,
RepositorySort,
SortOrder,
)
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
class GitHubAsyncRESTSeachTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTSearch
async def test_search_repositories(self):
response1 = create_response()
response1.json.return_value = {
"items": [
{
"id": 1,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": False,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": False,
"push": False,
"pull": True,
},
"forks": 1,
"open_issues": 0,
"watchers": 1,
}
]
}
response2 = create_response()
response2.json.return_value = {
"items": [
{
"id": 2,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": False,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": False,
"push": False,
"pull": True,
},
"forks": 1,
"open_issues": 0,
"watchers": 1,
},
{
"id": 3,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": False,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": False,
"push": False,
"pull": True,
},
"forks": 1,
"open_issues": 0,
"watchers": 1,
},
]
}
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(
self.api.repositories(
keywords=["hello"],
qualifiers=[
InNameQualifier(),
IsPublicQualifier(),
OrganizationQualifier("octocat"),
],
sort=RepositorySort.UPDATED,
order=SortOrder.DESC,
)
)
repo = await anext(async_it)
self.assertEqual(repo.id, 1)
repo = await anext(async_it)
self.assertEqual(repo.id, 2)
repo = await anext(async_it)
self.assertEqual(repo.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/search/repositories",
params={
"per_page": "100",
"order": "desc",
"sort": "updated",
"q": "hello in:name is:public org:octocat",
},
)
pontos-25.3.2/tests/github/api/test_secret_scanning.py 0000664 0000000 0000000 00000110020 14762555663 0023115 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
from pontos.github.api.secret_scanning import GitHubAsyncRESTSecretScanning
from pontos.github.models.base import SortOrder
from pontos.github.models.secret_scanning import (
AlertSort,
AlertState,
LocationType,
Resolution,
)
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
ALERTS = [
{
"number": 2,
"created_at": "2020-11-06T18:48:51Z",
"url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2",
"html_url": "https://github.com/owner/private-repo/security/secret-scanning/2",
"locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations",
"state": "resolved",
"resolution": "false_positive",
"resolved_at": "2020-11-07T02:47:13Z",
"resolved_by": {
"login": "monalisa",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://alambic.github.com/avatars/u/2?",
"gravatar_id": "",
"url": "https://api.github.com/users/monalisa",
"html_url": "https://github.com/monalisa",
"followers_url": "https://api.github.com/users/monalisa/followers",
"following_url": "https://api.github.com/users/monalisa/following{/other_user}",
"gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
"starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
"organizations_url": "https://api.github.com/users/monalisa/orgs",
"repos_url": "https://api.github.com/users/monalisa/repos",
"events_url": "https://api.github.com/users/monalisa/events{/privacy}",
"received_events_url": "https://api.github.com/users/monalisa/received_events",
"type": "User",
"site_admin": True,
},
"secret_type": "adafruit_io_key",
"secret_type_display_name": "Adafruit IO Key",
"secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
},
"push_protection_bypassed_by": {
"login": "monalisa",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://alambic.github.com/avatars/u/2?",
"gravatar_id": "",
"url": "https://api.github.com/users/monalisa",
"html_url": "https://github.com/monalisa",
"followers_url": "https://api.github.com/users/monalisa/followers",
"following_url": "https://api.github.com/users/monalisa/following{/other_user}",
"gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
"starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
"organizations_url": "https://api.github.com/users/monalisa/orgs",
"repos_url": "https://api.github.com/users/monalisa/repos",
"events_url": "https://api.github.com/users/monalisa/events{/privacy}",
"received_events_url": "https://api.github.com/users/monalisa/received_events",
"type": "User",
"site_admin": True,
},
"push_protection_bypassed": True,
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
"resolution_comment": "Example comment",
},
{
"number": 1,
"created_at": "2020-11-06T18:18:30Z",
"url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1",
"html_url": "https://github.com/owner/repo/security/secret-scanning/1",
"locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations",
"state": "open",
"resolution": None,
"resolved_at": None,
"resolved_by": None,
"secret_type": "mailchimp_api_key",
"secret_type_display_name": "Mailchimp API Key",
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
},
"push_protection_bypassed_by": None,
"push_protection_bypassed": False,
"push_protection_bypassed_at": None,
"resolution_comment": None,
},
]
class GitHubAsyncRESTSecretScanningTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTSecretScanning
async def test_enterprise_alerts(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.enterprise_alerts("foo"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/secret-scanning/alerts",
params={"per_page": "100", "sort": "created", "direction": "desc"},
)
async def test_enterprise_alerts_state(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts("foo", state=AlertState.RESOLVED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"state": "resolved",
},
)
async def test_enterprise_alerts_secret_types(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts(
"foo",
secret_types=[
"google_api_key",
"hashicorp_vault_service_token",
],
)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"secret_type": "google_api_key,hashicorp_vault_service_token",
},
)
async def test_enterprise_alerts_resolutions(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts(
"foo",
resolutions=["false_positive", "wont_fix", "revoked"],
)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"resolution": "false_positive,wont_fix,revoked",
},
)
async def test_enterprise_alerts_sort(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts("foo", sort=AlertSort.UPDATED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "updated",
"direction": "desc",
},
)
async def test_enterprise_alerts_direction(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.enterprise_alerts("foo", direction=SortOrder.ASC)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/enterprises/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "asc",
},
)
async def test_organization_alerts(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.organization_alerts("foo"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/secret-scanning/alerts",
params={"per_page": "100", "sort": "created", "direction": "desc"},
)
async def test_organization_alerts_state(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", state=AlertState.RESOLVED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"state": "resolved",
},
)
async def test_organization_alerts_secret_types(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts(
"foo",
secret_types=[
"google_api_key",
"hashicorp_vault_service_token",
],
)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"secret_type": "google_api_key,hashicorp_vault_service_token",
},
)
async def test_organization_alerts_resolutions(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts(
"foo",
resolutions=["false_positive", "wont_fix", "revoked"],
)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"resolution": "false_positive,wont_fix,revoked",
},
)
async def test_organization_alerts_sort(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", sort=AlertSort.UPDATED)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "updated",
"direction": "desc",
},
)
async def test_organization_alerts_direction(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.organization_alerts("foo", direction=SortOrder.ASC)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "asc",
},
)
async def test_alerts(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar"))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/secret-scanning/alerts",
params={"per_page": "100", "sort": "created", "direction": "desc"},
)
async def test_alerts_state(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", state=AlertState.RESOLVED))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"state": "resolved",
},
)
async def test_alerts_secret_types(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.alerts(
"foo/bar",
secret_types=[
"google_api_key",
"hashicorp_vault_service_token",
],
)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"secret_type": "google_api_key,hashicorp_vault_service_token",
},
)
async def test_alerts_resolutions(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(
self.api.alerts(
"foo/bar",
resolutions=["false_positive", "wont_fix", "revoked"],
)
)
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "desc",
"resolution": "false_positive,wont_fix,revoked",
},
)
async def test_alerts_sort(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", sort=AlertSort.UPDATED))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "updated",
"direction": "desc",
},
)
async def test_alerts_direction(self):
response = create_response()
response.json.return_value = ALERTS
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.alerts("foo/bar", direction=SortOrder.ASC))
alert = await anext(async_it)
self.assertEqual(alert.number, 2)
alert = await anext(async_it)
self.assertEqual(alert.number, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/secret-scanning/alerts",
params={
"per_page": "100",
"sort": "created",
"direction": "asc",
},
)
async def test_alert(self):
response = create_response()
response.json.return_value = {
"number": 42,
"created_at": "2020-11-06T18:18:30Z",
"url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42",
"html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
"locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
"state": "open",
"resolution": None,
"resolved_at": None,
"resolved_by": None,
"secret_type": "mailchimp_api_key",
"secret_type_display_name": "Mailchimp API Key",
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
"push_protection_bypassed_by": None,
"push_protection_bypassed": False,
"push_protection_bypassed_at": None,
"resolution_comment": None,
}
self.client.get.return_value = response
alert = await self.api.alert(
"foo/bar",
42,
)
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/secret-scanning/alerts/42",
)
self.assertEqual(alert.number, 42)
async def test_update(self):
response = create_response()
response.json.return_value = {
"number": 42,
"created_at": "2020-11-06T18:18:30Z",
"url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42",
"html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
"locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
"state": "resolved",
"resolution": "used_in_tests",
"resolved_at": "2020-11-16T22:42:07Z",
"resolved_by": {
"login": "monalisa",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://alambic.github.com/avatars/u/2?",
"gravatar_id": "",
"url": "https://api.github.com/users/monalisa",
"html_url": "https://github.com/monalisa",
"followers_url": "https://api.github.com/users/monalisa/followers",
"following_url": "https://api.github.com/users/monalisa/following{/other_user}",
"gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
"starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
"organizations_url": "https://api.github.com/users/monalisa/orgs",
"repos_url": "https://api.github.com/users/monalisa/repos",
"events_url": "https://api.github.com/users/monalisa/events{/privacy}",
"received_events_url": "https://api.github.com/users/monalisa/received_events",
"type": "User",
"site_admin": True,
},
"secret_type": "mailchimp_api_key",
"secret_type_display_name": "Mailchimp API Key",
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
"push_protection_bypassed": False,
"push_protection_bypassed_by": None,
"push_protection_bypassed_at": None,
"resolution_comment": "Example comment",
}
self.client.patch.return_value = response
alert = await self.api.update_alert(
"foo/bar",
1,
AlertState.RESOLVED,
resolution=Resolution.USED_IN_TESTS,
resolution_comment="Only used in tests",
)
self.client.patch.assert_awaited_once_with(
"/repos/foo/bar/secret-scanning/alerts/1",
data={
"state": "resolved",
"resolution": "used_in_tests",
"resolution_comment": "Only used in tests",
},
)
self.assertEqual(alert.number, 42)
self.assertIsNone(alert.repository)
async def test_alerts_locations(self):
response = create_response()
response.json.return_value = [
{
"type": "commit",
"details": {
"path": "/example/secrets.txt",
"start_line": 1,
"end_line": 1,
"start_column": 1,
"end_column": 64,
"blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
"blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b",
"commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b",
"commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b",
},
},
{
"type": "issue_title",
"details": {
"issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
},
},
{
"type": "issue_body",
"details": {
"issue_body_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
},
},
{
"type": "issue_comment",
"details": {
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451"
},
},
]
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.locations("foo/bar", 123))
location = await anext(async_it)
self.assertEqual(location.type, LocationType.COMMIT)
location = await anext(async_it)
self.assertEqual(location.type, LocationType.ISSUE_TITLE)
location = await anext(async_it)
self.assertEqual(location.type, LocationType.ISSUE_BODY)
location = await anext(async_it)
self.assertEqual(location.type, LocationType.ISSUE_COMMENT)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/secret-scanning/alerts/123/locations",
params={
"per_page": "100",
},
)
pontos-25.3.2/tests/github/api/test_tags.py 0000664 0000000 0000000 00000021247 14762555663 0020722 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=too-many-lines, redefined-builtin, line-too-long
# ruff: noqa: E501
from datetime import datetime, timezone
from unittest.mock import MagicMock
import httpx
from pontos.github.api.tags import GitHubAsyncRESTTags
from pontos.github.models.tag import GitObjectType, Tag, VerificationReason
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
TAG_JSON = {
"node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==",
"tag": "v0.0.1",
"sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac",
"url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
"message": "initial version",
"tagger": {
"name": "Monalisa Octocat",
"email": "octocat@github.com",
"date": "2014-11-07T22:01:45Z",
},
"object": {
"type": "commit",
"sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
},
"verification": {
"verified": False,
"reason": "unsigned",
"signature": None,
"payload": None,
},
}
TAGS_JSON = [
{
"name": "v0.1.0",
"zipball_url": "https://api.github.com/repos/foo/ui/zipball/refs/tags/v0.1.0",
"tarball_url": "https://api.github.com/repos/foo/ui/tarball/refs/tags/v0.1.0",
"commit": {
"sha": "b55408280162c20cf0ffef155618270d26fe7352",
"url": "https://api.github.com/repos/foo/ui/commits/b55408280162c20cf0ffef155618270d26fe7352",
},
"node_id": "REF_kwDOHeuT1rByZWZzL3RhZ3MvdjAuMS4w",
},
{
"name": "0.0.72",
"zipball_url": "https://api.github.com/repos/foo/ui/zipball/refs/tags/0.0.72",
"tarball_url": "https://api.github.com/repos/foo/ui/tarball/refs/tags/0.0.72",
"commit": {
"sha": "fd54097278df75332917d9d1a2d940083513a6b2",
"url": "https://api.github.com/repos/foo/ui/commits/fd54097278df75332917d9d1a2d940083513a6b2",
},
"node_id": "REF_kwDOHeuT1rByZWZzL3RhZ3MvMC4wLjcy",
},
]
class GitHubAsyncRESTTagsTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTTags
def assertTag(self, tag: Tag): # pylint: disable=invalid-name
self.assertEqual(
tag.node_id,
"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==",
)
self.assertEqual(tag.tag, "v0.0.1")
self.assertEqual(tag.sha, "940bd336248efae0f9ee5bc7b2d5c985887b16ac")
self.assertEqual(
tag.url,
"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
)
self.assertEqual(tag.message, "initial version")
tagger = tag.tagger
self.assertEqual(tagger.name, "Monalisa Octocat")
self.assertEqual(tagger.email, "octocat@github.com")
self.assertEqual(
tagger.date, datetime(2014, 11, 7, 22, 1, 45, tzinfo=timezone.utc)
)
tag_object = tag.object
self.assertEqual(tag_object.type, GitObjectType.COMMIT)
self.assertEqual(
tag_object.sha, "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c"
)
self.assertEqual(
tag_object.url,
"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
)
verification = tag.verification
self.assertFalse(verification.verified)
self.assertEqual(verification.reason, VerificationReason.UNSIGNED)
self.assertIsNone(verification.payload)
self.assertIsNone(verification.signature)
async def test_create(self):
response = create_response()
response.json.return_value = TAG_JSON
self.client.post.return_value = response
tag = await self.api.create(
"octocat/Hello-World",
"v0.0.1",
"initial version",
"Monalisa Octocat",
"octocat@github.com",
"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
)
self.client.post.assert_awaited_once_with(
"/repos/octocat/Hello-World/git/tags",
data={
"tag": "v0.0.1",
"message": "initial version",
"object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
"type": "commit",
"tagger": {
"name": "Monalisa Octocat",
"email": "octocat@github.com",
},
},
)
self.assertTag(tag)
async def test_create_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.create(
"octocat/Hello-World",
"v0.0.1",
"initial version",
"Monalisa Octocat",
"octocat@github.com",
"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
)
self.client.post.assert_awaited_once_with(
"/repos/octocat/Hello-World/git/tags",
data={
"tag": "v0.0.1",
"message": "initial version",
"object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
"type": "commit",
"tagger": {
"name": "Monalisa Octocat",
"email": "octocat@github.com",
},
},
)
async def test_create_tag_reference(self):
response = create_response()
self.client.post.return_value = response
await self.api.create_tag_reference(
"foo/bar", "v1.0.0", "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c"
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/git/refs",
data={
"ref": "refs/tags/v1.0.0",
"sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
},
)
async def test_create_tag_reference_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.create_tag_reference(
"foo/bar", "v1.0.0", "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c"
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/git/refs",
data={
"ref": "refs/tags/v1.0.0",
"sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
},
)
async def test_get(self):
response = create_response()
response.json.return_value = TAG_JSON
self.client.get.return_value = response
tag = await self.api.get("octocat/Hello-World", "v0.0.1")
self.client.get.assert_awaited_once_with(
"/repos/octocat/Hello-World/git/tags/v0.0.1"
)
self.assertTag(tag)
async def test_get_failure(self):
response = create_response()
self.client.get.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.get("octocat/Hello-World", "v0.0.1")
self.client.get.assert_awaited_once_with(
"/repos/octocat/Hello-World/git/tags/v0.0.1"
)
async def test_get_all(self):
response = create_response()
response.json.return_value = TAGS_JSON
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.get_all("foo"))
tag = await anext(async_it)
self.assertEqual(tag.name, "v0.1.0")
self.assertEqual(
tag.commit.sha, "b55408280162c20cf0ffef155618270d26fe7352"
)
self.assertEqual(
tag.commit.url,
"https://api.github.com/repos/foo/ui/commits/b55408280162c20cf0ffef155618270d26fe7352",
)
self.assertEqual(
tag.zipball_url,
"https://api.github.com/repos/foo/ui/zipball/refs/tags/v0.1.0",
)
self.assertEqual(
tag.tarball_url,
"https://api.github.com/repos/foo/ui/tarball/refs/tags/v0.1.0",
)
self.assertEqual(tag.node_id, "REF_kwDOHeuT1rByZWZzL3RhZ3MvdjAuMS4w")
tag2 = await anext(async_it)
self.assertEqual(tag2.name, "0.0.72")
pontos-25.3.2/tests/github/api/test_teams.py 0000664 0000000 0000000 00000113032 14762555663 0021067 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=redefined-builtin, line-too-long
from unittest.mock import MagicMock
import httpx
from pontos.github.api.teams import GitHubAsyncRESTTeams, TeamPrivacy, TeamRole
from pontos.github.models.base import Permission
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
class GitHubAsyncRESTTeamsTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTTeams
async def test_get_all(self):
response1 = create_response()
response1.json.return_value = [
{
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": None,
}
]
response2 = create_response()
response2.json.return_value = [
{
"id": 2,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": None,
},
{
"id": 3,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": None,
},
]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.get_all("foo"))
team = await anext(async_it)
self.assertEqual(team.id, 1)
team = await anext(async_it)
self.assertEqual(team.id, 2)
team = await anext(async_it)
self.assertEqual(team.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/teams",
params={"per_page": "100"},
)
async def test_create(self):
response = create_response()
response.json.return_value = {
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": None,
}
self.client.post.return_value = response
team = await self.api.create(
"foo",
"bar",
description="A description",
maintainers=["foo", "bar"],
repo_names=["foo/bar", "foo/baz"],
privacy=TeamPrivacy.CLOSED,
parent_team_id="123",
)
self.client.post.assert_awaited_once_with(
"/orgs/foo/teams",
data={
"name": "bar",
"description": "A description",
"maintainers": ["foo", "bar"],
"repo_names": ["foo/bar", "foo/baz"],
"privacy": "closed",
"parent_team_id": "123",
},
)
self.assertEqual(team.id, 1)
async def test_create_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.create(
"foo",
"bar",
description="A description",
maintainers=["foo", "bar"],
repo_names=["foo/bar", "foo/baz"],
privacy=TeamPrivacy.CLOSED,
parent_team_id="123",
)
self.client.post.assert_awaited_once_with(
"/orgs/foo/teams",
data={
"name": "bar",
"description": "A description",
"maintainers": ["foo", "bar"],
"repo_names": ["foo/bar", "foo/baz"],
"privacy": "closed",
"parent_team_id": "123",
},
)
async def test_get(self):
response = create_response()
response.json.return_value = {
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": None,
}
self.client.get.return_value = response
team = await self.api.get("foo", "bar")
self.client.get.assert_awaited_once_with(
"/orgs/foo/teams/bar",
)
self.assertEqual(team.id, 1)
async def test_get_failure(self):
response = create_response()
self.client.get.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.get("foo", "bar")
self.client.get.assert_awaited_once_with(
"/orgs/foo/teams/bar",
)
async def test_update(self):
response = create_response()
response.json.return_value = {
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "baz",
"slug": "justice-league",
"description": "A description",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": None,
}
self.client.post.return_value = response
team = await self.api.update(
"foo",
"bar",
name="baz",
description="A description",
privacy=TeamPrivacy.CLOSED,
parent_team_id="123",
)
self.client.post.assert_awaited_once_with(
"/orgs/foo/teams/bar",
data={
"name": "baz",
"description": "A description",
"privacy": "closed",
"parent_team_id": "123",
},
)
self.assertEqual(team.id, 1)
async def test_update_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.update(
"foo",
"bar",
name="baz",
description="A description",
privacy=TeamPrivacy.CLOSED,
parent_team_id="123",
)
self.client.post.assert_awaited_once_with(
"/orgs/foo/teams/bar",
data={
"name": "baz",
"description": "A description",
"privacy": "closed",
"parent_team_id": "123",
},
)
async def test_delete(self):
response = create_response()
self.client.delete.return_value = response
await self.api.delete("foo", "bar")
self.client.delete.assert_awaited_once_with(
"/orgs/foo/teams/bar",
)
async def test_delete_failure(self):
response = create_response()
self.client.delete.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.delete("foo", "bar")
self.client.delete.assert_awaited_once_with(
"/orgs/foo/teams/bar",
)
async def test_members(self):
response1 = create_response()
response1.json.return_value = [
{
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
}
]
response2 = create_response()
response2.json.return_value = [
{
"id": 2,
"login": "octocat2",
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
{
"id": 3,
"login": "octocat3",
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.members("foo", "bar"))
member = await anext(async_it)
self.assertEqual(member.id, 1)
member = await anext(async_it)
self.assertEqual(member.id, 2)
member = await anext(async_it)
self.assertEqual(member.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/teams/bar/members",
params={"per_page": "100"},
)
async def test_update_member(self):
response = create_response()
self.client.put.return_value = response
await self.api.update_member(
"foo", "bar", "baz", role=TeamRole.MAINTAINER
)
self.client.put.assert_awaited_once_with(
"/orgs/foo/teams/bar/memberships/baz", data={"role": "maintainer"}
)
async def test_add_member(self):
response = create_response()
self.client.put.return_value = response
await self.api.add_member("foo", "bar", "baz", role=TeamRole.MAINTAINER)
self.client.put.assert_awaited_once_with(
"/orgs/foo/teams/bar/memberships/baz", data={"role": "maintainer"}
)
async def test_update_member_failure(self):
response = create_response()
self.client.put.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.update_member("foo", "bar", "baz")
self.client.put.assert_awaited_once_with(
"/orgs/foo/teams/bar/memberships/baz", data={"role": "member"}
)
async def test_remove_member(self):
response = create_response()
self.client.delete.return_value = response
await self.api.remove_member("foo", "bar", "baz")
self.client.delete.assert_awaited_once_with(
"/orgs/foo/teams/bar/memberships/baz"
)
async def test_remove_member_failure(self):
response = create_response()
self.client.delete.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.remove_member("foo", "bar", "baz")
self.client.delete.assert_awaited_once_with(
"/orgs/foo/teams/bar/memberships/baz"
)
async def test_repositories(self):
response1 = create_response()
response1.json.return_value = [
{
"id": 1,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": False,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {"admin": False, "push": False, "pull": True},
}
]
response2 = create_response()
response2.json.return_value = [
{
"id": 2,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": False,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {"admin": False, "push": False, "pull": True},
},
{
"id": 3,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": False,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {"admin": False, "push": False, "pull": True},
},
]
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.repositories("foo", "bar"))
repo = await anext(async_it)
self.assertEqual(repo.id, 1)
repo = await anext(async_it)
self.assertEqual(repo.id, 2)
repo = await anext(async_it)
self.assertEqual(repo.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/orgs/foo/teams/bar/repos",
params={"per_page": "100"},
)
async def test_update_permissions(self):
response = create_response()
self.client.put.return_value = response
await self.api.update_permission("foo", "bar", "baz", Permission.TRIAGE)
self.client.put.assert_awaited_once_with(
"/orgs/foo/teams/bar/repos/foo/baz", data={"permission": "triage"}
)
async def test_add_permissions(self):
response = create_response()
self.client.put.return_value = response
await self.api.add_permission("foo", "bar", "baz", Permission.ADMIN)
self.client.put.assert_awaited_once_with(
"/orgs/foo/teams/bar/repos/foo/baz", data={"permission": "admin"}
)
async def test_update_permissions_failure(self):
response = create_response()
self.client.put.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.update_permission(
"foo", "bar", "baz", Permission.TRIAGE
)
self.client.put.assert_awaited_once_with(
"/orgs/foo/teams/bar/repos/foo/baz", data={"permission": "triage"}
)
pontos-25.3.2/tests/github/api/test_users.py 0000664 0000000 0000000 00000023146 14762555663 0021125 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
from pontos.github.api.users import GitHubAsyncRESTUsers
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
class GitHubAsyncRESTUsersTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTUsers
async def test_users(self):
response = create_response()
response.json.return_value = [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
}
]
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.users())
user = await anext(async_it)
self.assertEqual(user.id, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/users",
params={"per_page": "100"},
)
async def test_user(self):
response = create_response()
response.json.return_value = {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
"name": "monalisa octocat",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"hireable": False,
"bio": "There once was...",
"twitter_username": "monatheoctocat",
"public_repos": 2,
"public_gists": 1,
"followers": 20,
"following": 0,
"created_at": "2008-01-14T04:33:35Z",
"updated_at": "2008-01-14T04:33:35Z",
}
self.client.get.return_value = response
user = await self.api.user(
"octocat",
)
self.client.get.assert_awaited_once_with(
"/users/octocat",
)
self.assertEqual(user.id, 1)
async def test_current_user(self):
response = create_response()
response.json.return_value = {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
"name": "monalisa octocat",
"company": "GitHub",
"blog": "https://github.com/blog",
"location": "San Francisco",
"email": "octocat@github.com",
"hireable": False,
"bio": "There once was...",
"twitter_username": "monatheoctocat",
"public_repos": 2,
"public_gists": 1,
"followers": 20,
"following": 0,
"created_at": "2008-01-14T04:33:35Z",
"updated_at": "2008-01-14T04:33:35Z",
}
self.client.get.return_value = response
user = await self.api.current_user()
self.client.get.assert_awaited_once_with("/user")
self.assertEqual(user.id, 1)
async def test_user_keys(self):
response = create_response()
response.json.return_value = [{"id": 1, "key": "ssh-rsa AAA..."}]
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.user_keys("foo"))
key = await anext(async_it)
self.assertEqual(key.id, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/users/foo/keys",
params={"per_page": "100"},
)
async def test_keys(self):
response = create_response()
response.json.return_value = [{"id": 1, "key": "ssh-rsa AAA..."}]
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.keys())
key = await anext(async_it)
self.assertEqual(key.id, 1)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/user/keys",
params={"per_page": "100"},
)
async def test_emails(self):
response = create_response()
response.json.return_value = [
{
"email": "octocat@github.com",
"verified": True,
"primary": True,
"visibility": "public",
}
]
self.client.get_all.return_value = AsyncIteratorMock([response])
async_it = aiter(self.api.emails())
email = await anext(async_it)
self.assertEqual(email.email, "octocat@github.com")
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/user/emails",
params={"per_page": "100"},
)
async def test_key(self):
response = create_response()
response.json.return_value = {
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z",
"verified": False,
"read_only": False,
}
self.client.get.return_value = response
key = await self.api.key(2)
self.client.get.assert_awaited_once_with(
"/user/keys/2",
)
self.assertEqual(key.id, 2)
async def test_delete_key(self):
response = create_response()
self.client.get.return_value = response
await self.api.delete_key(2)
self.client.delete.assert_awaited_once_with(
"/user/keys/2",
)
async def test_create_key(self):
response = create_response()
response.json.return_value = {
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z",
"verified": False,
"read_only": False,
}
self.client.post.return_value = response
key = await self.api.create_key(
"ssh-rsa AAAAB3NzaC1yc2EAAA",
"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
)
self.client.post.assert_awaited_once_with(
"/user/keys",
data={
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
},
)
self.assertEqual(key.id, 2)
pontos-25.3.2/tests/github/api/test_workflows.py 0000664 0000000 0000000 00000373327 14762555663 0022032 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=too-many-lines, redefined-builtin, line-too-long
from pathlib import Path
from unittest.mock import MagicMock
import httpx
from pontos.github.api.workflows import GitHubAsyncRESTWorkflows
from tests import AsyncIteratorMock, aiter, anext
from tests.github.api import GitHubAsyncRESTTestCase, create_response
here = Path(__file__).parent
class GitHubAsyncRESTWorkflowsTestCase(GitHubAsyncRESTTestCase):
api_cls = GitHubAsyncRESTWorkflows
async def test_get(self):
response = create_response()
response.json.return_value = {
"id": 1,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "CI",
"path": ".github/workflows/blank.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg",
}
self.client.get.return_value = response
workflow = await self.api.get("foo/bar", "ci.yml")
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/actions/workflows/ci.yml"
)
self.assertEqual(workflow.id, 1)
async def test_get_failure(self):
response = create_response()
self.client.get.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.get("foo/bar", "ci.yml")
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/actions/workflows/ci.yml"
)
async def test_get_all(self):
response1 = create_response()
response1.json.return_value = {
"workflows": [
{
"id": 1,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "CI",
"path": ".github/workflows/blank.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg",
}
]
}
response2 = create_response()
response2.json.return_value = {
"workflows": [
{
"id": 2,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "CI",
"path": ".github/workflows/blank.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg",
},
{
"id": 3,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "CI",
"path": ".github/workflows/blank.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg",
},
]
}
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(self.api.get_all("foo/bar"))
workflow = await anext(async_it)
self.assertEqual(workflow.id, 1)
workflow = await anext(async_it)
self.assertEqual(workflow.id, 2)
workflow = await anext(async_it)
self.assertEqual(workflow.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/actions/workflows",
params={"per_page": "100"},
)
async def test_get_workflow_runs(self):
response1 = create_response()
response1.json.return_value = {
"workflow_runs": [
{
"id": 1,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": None,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com",
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com",
},
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": True,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
},
}
]
}
response2 = create_response()
response2.json.return_value = {
"workflow_runs": [
{
"id": 2,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": None,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com",
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com",
},
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": True,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
},
},
{
"id": 3,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": None,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com",
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com",
},
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": True,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
},
},
]
}
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(
self.api.get_workflow_runs(
"foo/bar",
actor="foo",
branch="stable",
exclude_pull_requests=True,
)
)
run = await anext(async_it)
self.assertEqual(run.id, 1)
run = await anext(async_it)
self.assertEqual(run.id, 2)
run = await anext(async_it)
self.assertEqual(run.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/actions/runs",
params={
"actor": "foo",
"branch": "stable",
"exclude_pull_requests": True,
"per_page": "100",
},
)
async def test_get_workflow_runs_for_workflow(self):
response1 = create_response()
response1.json.return_value = {
"workflow_runs": [
{
"id": 1,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": None,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com",
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com",
},
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": True,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
},
}
]
}
response2 = create_response()
response2.json.return_value = {
"workflow_runs": [
{
"id": 2,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": None,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com",
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com",
},
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": True,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
},
},
{
"id": 3,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": None,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com",
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com",
},
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": True,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
},
},
]
}
self.client.get_all.return_value = AsyncIteratorMock(
[response1, response2]
)
async_it = aiter(
self.api.get_workflow_runs(
"foo/bar",
"ci.yml",
actor="foo",
branch="stable",
exclude_pull_requests=True,
)
)
run = await anext(async_it)
self.assertEqual(run.id, 1)
run = await anext(async_it)
self.assertEqual(run.id, 2)
run = await anext(async_it)
self.assertEqual(run.id, 3)
with self.assertRaises(StopAsyncIteration):
await anext(async_it)
self.client.get_all.assert_called_once_with(
"/repos/foo/bar/actions/workflows/ci.yml/runs",
params={
"actor": "foo",
"branch": "stable",
"exclude_pull_requests": True,
"per_page": "100",
},
)
async def test_get_workflow_run(self):
response = create_response()
response.json.return_value = {
"id": 1,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": None,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com",
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com",
},
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": True,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
},
}
self.client.get.return_value = response
workflow = await self.api.get_workflow_run("foo/bar", "123")
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/actions/runs/123"
)
self.assertEqual(workflow.id, 1)
async def test_get_workflow_run_failure(self):
response = create_response()
self.client.get.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
with self.assertRaises(httpx.HTTPStatusError):
await self.api.get_workflow_run("foo/bar", "123")
self.client.get.assert_awaited_once_with(
"/repos/foo/bar/actions/runs/123"
)
async def test_create_workflow_dispatch(self):
response = create_response()
self.client.post.return_value = response
input_dict = {"foo": "bar"}
await self.api.create_workflow_dispatch(
"foo/bar", "ci.yml", ref="stable", inputs=input_dict
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/actions/workflows/ci.yml/dispatches",
data={"ref": "stable", "inputs": input_dict},
)
async def test_create_workflow_dispatch_failure(self):
response = create_response()
self.client.post.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
input_dict = {"foo": "bar"}
with self.assertRaises(httpx.HTTPStatusError):
await self.api.create_workflow_dispatch(
"foo/bar", "ci.yml", ref="stable", inputs=input_dict
)
self.client.post.assert_awaited_once_with(
"/repos/foo/bar/actions/workflows/ci.yml/dispatches",
data={"ref": "stable", "inputs": input_dict},
)
pontos-25.3.2/tests/github/models/ 0000775 0000000 0000000 00000000000 14762555663 0017057 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/github/models/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0021164 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/github/models/test_artifact.py 0000664 0000000 0000000 00000005037 14762555663 0022272 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
import unittest
from datetime import datetime, timezone
from pontos.github.models.artifact import Artifact
class ArtifactTestCase(unittest.TestCase):
def test_from_dict(self):
artifact = Artifact.from_dict(
{
"id": 1,
"node_id": "MDg6QXJ0aWZhY3QxMQ==",
"name": "Rails",
"size_in_bytes": 556,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
"expired": False,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 1,
"repository_id": 2,
"head_repository_id": 3,
"head_branch": "main",
"head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3",
},
}
)
self.assertEqual(artifact.id, 1)
self.assertEqual(artifact.node_id, "MDg6QXJ0aWZhY3QxMQ==")
self.assertEqual(artifact.name, "Rails")
self.assertEqual(artifact.size_in_bytes, 556)
self.assertEqual(
artifact.url,
"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
)
self.assertEqual(
artifact.archive_download_url,
"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
)
self.assertFalse(artifact.expired)
self.assertEqual(
artifact.created_at,
datetime(2020, 1, 10, 14, 59, 22, tzinfo=timezone.utc),
)
self.assertEqual(
artifact.expires_at,
datetime(2020, 3, 21, 14, 59, 22, tzinfo=timezone.utc),
)
self.assertEqual(
artifact.updated_at,
datetime(2020, 2, 21, 14, 59, 22, tzinfo=timezone.utc),
)
workflow_run = artifact.workflow_run
self.assertEqual(workflow_run.id, 1)
self.assertEqual(workflow_run.repository_id, 2)
self.assertEqual(workflow_run.head_repository_id, 3)
self.assertEqual(workflow_run.head_branch, "main")
self.assertEqual(
workflow_run.head_sha, "328faa0536e6fef19753d9d91dc96a9931694ce3"
)
pontos-25.3.2/tests/github/models/test_base.py 0000664 0000000 0000000 00000021774 14762555663 0021415 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
import unittest
from pontos.github.api.teams import TeamPrivacy
from pontos.github.models.base import App, Permission, Team, User
class UserTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"login": "greenbone",
"id": 31986857,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjMxOTg2ODU3",
"avatar_url": "https://avatars.githubusercontent.com/u/31986857?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbone",
"html_url": "https://github.com/greenbone",
"followers_url": "https://api.github.com/users/greenbone/followers",
"following_url": "https://api.github.com/users/greenbone/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbone/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbone/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbone/subscriptions",
"organizations_url": "https://api.github.com/users/greenbone/orgs",
"repos_url": "https://api.github.com/users/greenbone/repos",
"events_url": "https://api.github.com/users/greenbone/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbone/received_events",
"type": "Organization",
"site_admin": False,
}
user = User.from_dict(data)
self.assertEqual(user.login, "greenbone")
self.assertEqual(user.id, 31986857)
self.assertEqual(user.node_id, "MDEyOk9yZ2FuaXphdGlvbjMxOTg2ODU3")
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/greenbone")
self.assertEqual(user.html_url, "https://github.com/greenbone")
self.assertEqual(
user.followers_url,
"https://api.github.com/users/greenbone/followers",
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/greenbone/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/greenbone/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/greenbone/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/greenbone/subscriptions",
)
self.assertEqual(
user.organizations_url,
"https://api.github.com/users/greenbone/orgs",
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/greenbone/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/greenbone/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/greenbone/received_events",
)
self.assertEqual(user.type, "Organization")
self.assertFalse(user.site_admin)
class TeamTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"name": "python-gvm-maintainers",
"id": 3764115,
"node_id": "MDQ6VGVhbTM3NjQxMTU=",
"slug": "python-gvm-maintainers",
"description": "Maintainers of python code at GVM",
"privacy": "closed",
"url": "https://api.github.com/organizations/31986857/team/3764115",
"html_url": "https://github.com/orgs/greenbone/teams/python-gvm-maintainers",
"members_url": "https://api.github.com/organizations/31986857/team/3764115/members{/member}",
"repositories_url": "https://api.github.com/organizations/31986857/team/3764115/repos",
"permission": "pull",
"parent": None,
}
team = Team.from_dict(data)
self.assertEqual(team.name, "python-gvm-maintainers")
self.assertEqual(team.id, 3764115)
self.assertEqual(team.node_id, "MDQ6VGVhbTM3NjQxMTU=")
self.assertEqual(team.slug, "python-gvm-maintainers")
self.assertEqual(team.description, "Maintainers of python code at GVM")
self.assertEqual(team.privacy, TeamPrivacy.CLOSED)
self.assertEqual(
team.url,
"https://api.github.com/organizations/31986857/team/3764115",
)
self.assertEqual(
team.html_url,
"https://github.com/orgs/greenbone/teams/python-gvm-maintainers",
)
self.assertEqual(
team.members_url,
"https://api.github.com/organizations/31986857/team/3764115/members{/member}",
)
self.assertEqual(
team.repositories_url,
"https://api.github.com/organizations/31986857/team/3764115/repos",
)
self.assertEqual(team.permission, Permission.PULL)
self.assertIsNone(team.parent)
class AppTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"id": 1,
"slug": "octoapp",
"node_id": "MDExOkludGVncmF0aW9uMQ==",
"owner": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/orgs/github",
"html_url": "https://github.com/github",
"followers_url": "https://api.github.com/users/github/followers",
"following_url": "https://api.github.com/users/github/following{/other_user}",
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
"organizations_url": "https://api.github.com/users/github/orgs",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"received_events_url": "https://api.github.com/users/github/received_events",
"type": "Organization",
"site_admin": False,
},
"name": "Octocat App",
"description": "",
"external_url": "https://example.com",
"html_url": "https://github.com/apps/octoapp",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"events": ["push", "pull_request"],
}
app = App.from_dict(data)
self.assertEqual(app.id, 1)
self.assertEqual(app.slug, "octoapp")
self.assertEqual(app.node_id, "MDExOkludGVncmF0aW9uMQ==")
self.assertEqual(app.owner.login, "github")
self.assertEqual(app.owner.id, 1)
self.assertEqual(app.owner.node_id, "MDEyOk9yZ2FuaXphdGlvbjE=")
self.assertEqual(
app.owner.avatar_url,
"https://github.com/images/error/octocat_happy.gif",
)
self.assertEqual(app.owner.gravatar_id, "")
self.assertEqual(app.owner.url, "https://api.github.com/orgs/github")
self.assertEqual(app.owner.html_url, "https://github.com/github")
self.assertEqual(
app.owner.followers_url,
"https://api.github.com/users/github/followers",
)
self.assertEqual(
app.owner.following_url,
"https://api.github.com/users/github/following{/other_user}",
)
self.assertEqual(
app.owner.gists_url,
"https://api.github.com/users/github/gists{/gist_id}",
)
self.assertEqual(
app.owner.starred_url,
"https://api.github.com/users/github/starred{/owner}{/repo}",
)
self.assertEqual(
app.owner.subscriptions_url,
"https://api.github.com/users/github/subscriptions",
)
self.assertEqual(
app.owner.organizations_url,
"https://api.github.com/users/github/orgs",
)
self.assertEqual(
app.owner.repos_url, "https://api.github.com/orgs/github/repos"
)
self.assertEqual(
app.owner.events_url, "https://api.github.com/orgs/github/events"
)
self.assertEqual(app.owner.type, "Organization")
self.assertFalse(app.owner.site_admin)
self.assertEqual(app.name, "Octocat App")
self.assertEqual(app.description, "")
self.assertEqual(app.external_url, "https://example.com")
self.assertEqual(app.html_url, "https://github.com/apps/octoapp")
self.assertEqual(app.created_at, "2017-07-08T16:18:44-04:00")
self.assertEqual(app.updated_at, "2017-07-08T16:18:44-04:00")
self.assertEqual(app.events, ["push", "pull_request"])
pontos-25.3.2/tests/github/models/test_billing.py 0000664 0000000 0000000 00000004232 14762555663 0022111 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
import unittest
from pontos.github.models.billing import (
ActionsBilling,
PackagesBilling,
StorageBilling,
)
class ActionsBillingTestCase(unittest.TestCase):
def test_from_dict(self):
billing = ActionsBilling.from_dict(
{
"total_minutes_used": 305,
"total_paid_minutes_used": 0,
"included_minutes": 3000,
"minutes_used_breakdown": {
"UBUNTU": 205,
"MACOS": 10,
"WINDOWS": 90,
},
}
)
self.assertEqual(billing.total_minutes_used, 305)
self.assertEqual(billing.total_paid_minutes_used, 0)
self.assertEqual(billing.included_minutes, 3000)
self.assertEqual(billing.minutes_used_breakdown.UBUNTU, 205)
self.assertEqual(billing.minutes_used_breakdown.MACOS, 10)
self.assertEqual(billing.minutes_used_breakdown.WINDOWS, 90)
self.assertIsNone(billing.minutes_used_breakdown.total)
class PackagesBillingTestCase(unittest.TestCase):
def test_from_dict(self):
billing = PackagesBilling.from_dict(
{
"total_gigabytes_bandwidth_used": 50,
"total_paid_gigabytes_bandwidth_used": 40,
"included_gigabytes_bandwidth": 10,
}
)
self.assertEqual(billing.total_gigabytes_bandwidth_used, 50)
self.assertEqual(billing.total_paid_gigabytes_bandwidth_used, 40)
self.assertEqual(billing.included_gigabytes_bandwidth, 10)
class StorageBillingTestCase(unittest.TestCase):
def test_from_dict(self):
billing = StorageBilling.from_dict(
{
"days_left_in_billing_cycle": 20,
"estimated_paid_storage_for_month": 15,
"estimated_storage_for_month": 40,
}
)
self.assertEqual(billing.days_left_in_billing_cycle, 20)
self.assertEqual(billing.estimated_paid_storage_for_month, 15)
self.assertEqual(billing.estimated_storage_for_month, 40)
pontos-25.3.2/tests/github/models/test_branch.py 0000664 0000000 0000000 00000075026 14762555663 0021737 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
import unittest
from pontos.github.api.teams import TeamPrivacy
from pontos.github.models.base import Permission
from pontos.github.models.branch import (
BranchProtection,
RequiredPullRequestReviews,
RequiredStatusChecks,
Restrictions,
)
class RestrictionsTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions",
"users_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/users",
"teams_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/teams",
"apps_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/apps",
"users": [
{
"login": "greenbonebot",
"id": 123,
"node_id": "MDQ6VXNlcjg1MjU0NjY2",
"avatar_url": "https://avatars.githubusercontent.com/u/85254666?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbonebot",
"html_url": "https://github.com/greenbonebot",
"followers_url": "https://api.github.com/users/greenbonebot/followers",
"following_url": "https://api.github.com/users/greenbonebot/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbonebot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbonebot/subscriptions",
"organizations_url": "https://api.github.com/users/greenbonebot/orgs",
"repos_url": "https://api.github.com/users/greenbonebot/repos",
"events_url": "https://api.github.com/users/greenbonebot/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbonebot/received_events",
"type": "User",
"site_admin": False,
}
],
"teams": [],
"apps": [],
}
restrictions = Restrictions.from_dict(data)
self.assertEqual(
restrictions.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions",
)
self.assertEqual(
restrictions.users_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/users",
)
self.assertEqual(
restrictions.teams_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/teams",
)
self.assertEqual(
restrictions.apps_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/apps",
)
user = restrictions.users[0]
self.assertEqual(len(restrictions.users), 1)
self.assertEqual(user.login, "greenbonebot")
self.assertEqual(user.node_id, "MDQ6VXNlcjg1MjU0NjY2")
self.assertEqual(
user.avatar_url,
"https://avatars.githubusercontent.com/u/85254666?v=4",
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/greenbonebot")
self.assertEqual(user.html_url, "https://github.com/greenbonebot")
self.assertEqual(
user.followers_url,
"https://api.github.com/users/greenbonebot/followers",
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/greenbonebot/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/greenbonebot/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/greenbonebot/subscriptions",
)
self.assertEqual(
user.organizations_url,
"https://api.github.com/users/greenbonebot/orgs",
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/greenbonebot/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/greenbonebot/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/greenbonebot/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
self.assertEqual(restrictions.teams, [])
self.assertEqual(restrictions.apps, [])
class RequiredStatusChecksTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_status_checks",
"strict": True,
"checks": [
{"context": "unittests", "app_id": 123},
{"context": "linting"},
],
}
checks = RequiredStatusChecks.from_dict(data)
self.assertEqual(
checks.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_status_checks",
)
self.assertTrue(checks.strict)
self.assertEqual(len(checks.checks), 2)
self.assertEqual(checks.checks[0].context, "unittests")
self.assertEqual(checks.checks[0].app_id, 123)
self.assertEqual(checks.checks[1].context, "linting")
self.assertIsNone(checks.checks[1].app_id)
class RequiredPullRequestReviewsTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_pull_request_reviews",
"dismiss_stale_reviews": True,
"require_code_owner_reviews": True,
"require_last_push_approval": True,
"required_approving_review_count": 1,
"dismissal_restrictions": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions",
"users_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions/users",
"teams_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions/teams",
"users": [
{
"login": "greenbonebot",
"id": 123,
"node_id": "MDQ6VXNlcjg1MjU0NjY2",
"avatar_url": "https://avatars.githubusercontent.com/u/85254666?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbonebot",
"html_url": "https://github.com/greenbonebot",
"followers_url": "https://api.github.com/users/greenbonebot/followers",
"following_url": "https://api.github.com/users/greenbonebot/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbonebot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbonebot/subscriptions",
"organizations_url": "https://api.github.com/users/greenbonebot/orgs",
"repos_url": "https://api.github.com/users/greenbonebot/repos",
"events_url": "https://api.github.com/users/greenbonebot/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbonebot/received_events",
"type": "User",
"site_admin": False,
}
],
"teams": [
{
"name": "devops",
"id": 123,
"node_id": "T_kwDOAegUqc4AUtL1",
"slug": "devops",
"description": "Team responsible for DevOps",
"privacy": "closed",
"url": "https://api.github.com/organizations/321/team/123",
"html_url": "https://github.com/orgs/foo/teams/devops",
"members_url": "https://api.github.com/organizations/321/team/123/members{/member}",
"repositories_url": "https://api.github.com/organizations/321/team/123/repos",
"permission": "pull",
"parent": None,
}
],
"apps": [],
},
}
reviews = RequiredPullRequestReviews.from_dict(data)
self.assertEqual(
reviews.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_pull_request_reviews",
)
self.assertTrue(reviews.dismiss_stale_reviews)
self.assertTrue(reviews.require_code_owner_reviews)
self.assertTrue(reviews.require_last_push_approval)
self.assertEqual(
reviews.required_approving_review_count,
1,
)
dismissal_restrictions = reviews.dismissal_restrictions
self.assertEqual(
dismissal_restrictions.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions",
)
self.assertEqual(
dismissal_restrictions.users_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions/users",
)
self.assertEqual(
dismissal_restrictions.teams_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions/teams",
)
self.assertEqual(dismissal_restrictions.apps, [])
user = dismissal_restrictions.users[0]
self.assertEqual(len(dismissal_restrictions.users), 1)
self.assertEqual(user.login, "greenbonebot")
self.assertEqual(user.node_id, "MDQ6VXNlcjg1MjU0NjY2")
self.assertEqual(
user.avatar_url,
"https://avatars.githubusercontent.com/u/85254666?v=4",
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/greenbonebot")
self.assertEqual(user.html_url, "https://github.com/greenbonebot")
self.assertEqual(
user.followers_url,
"https://api.github.com/users/greenbonebot/followers",
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/greenbonebot/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/greenbonebot/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/greenbonebot/subscriptions",
)
self.assertEqual(
user.organizations_url,
"https://api.github.com/users/greenbonebot/orgs",
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/greenbonebot/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/greenbonebot/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/greenbonebot/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
self.assertEqual(len(dismissal_restrictions.teams), 1)
team = dismissal_restrictions.teams[0]
self.assertEqual(team.name, "devops")
self.assertEqual(team.id, 123)
self.assertEqual(team.node_id, "T_kwDOAegUqc4AUtL1")
self.assertEqual(team.slug, "devops")
self.assertEqual(team.description, "Team responsible for DevOps")
self.assertEqual(team.permission, Permission.PULL)
self.assertEqual(team.privacy, TeamPrivacy.CLOSED)
self.assertEqual(
team.url, "https://api.github.com/organizations/321/team/123"
)
self.assertEqual(
team.html_url, "https://github.com/orgs/foo/teams/devops"
)
self.assertEqual(
team.members_url,
"https://api.github.com/organizations/321/team/123/members{/member}",
)
self.assertEqual(
team.repositories_url,
"https://api.github.com/organizations/321/team/123/repos",
)
self.assertIsNone(team.parent)
class BranchProtectionTestCase(unittest.TestCase):
def test_from_dict_minimal(self):
data = {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection",
"required_signatures": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_signatures",
"enabled": False,
},
"enforce_admins": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/enforce_admins",
"enabled": False,
},
"required_linear_history": {"enabled": False},
"allow_force_pushes": {"enabled": False},
"allow_deletions": {"enabled": False},
"block_creations": {"enabled": False},
"required_conversation_resolution": {"enabled": False},
"lock_branch": {"enabled": True},
"allow_fork_syncing": {"enabled": False},
}
protection = BranchProtection.from_dict(data)
self.assertEqual(
protection.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection",
)
self.assertEqual(
protection.required_signatures.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_signatures",
)
self.assertFalse(protection.required_signatures.enabled)
self.assertEqual(
protection.enforce_admins.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/enforce_admins",
)
self.assertFalse(protection.enforce_admins.enabled)
self.assertFalse(protection.required_linear_history.enabled)
self.assertFalse(protection.allow_force_pushes.enabled)
self.assertFalse(protection.allow_deletions.enabled)
self.assertFalse(protection.block_creations.enabled)
self.assertFalse(protection.required_conversation_resolution.enabled)
self.assertTrue(protection.lock_branch.enabled)
self.assertFalse(protection.allow_fork_syncing.enabled)
self.assertIsNone(protection.required_status_checks)
self.assertIsNone(protection.required_pull_request_reviews)
self.assertIsNone(protection.restrictions)
def test_from_dict(self):
data = {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection",
"required_status_checks": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_status_checks",
"strict": True,
"checks": [],
},
"restrictions": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions",
"users_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/users",
"teams_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/teams",
"apps_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/apps",
"users": [
{
"login": "greenbonebot",
"id": 123,
"node_id": "MDQ6VXNlcjg1MjU0NjY2",
"avatar_url": "https://avatars.githubusercontent.com/u/85254666?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbonebot",
"html_url": "https://github.com/greenbonebot",
"followers_url": "https://api.github.com/users/greenbonebot/followers",
"following_url": "https://api.github.com/users/greenbonebot/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbonebot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbonebot/subscriptions",
"organizations_url": "https://api.github.com/users/greenbonebot/orgs",
"repos_url": "https://api.github.com/users/greenbonebot/repos",
"events_url": "https://api.github.com/users/greenbonebot/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbonebot/received_events",
"type": "User",
"site_admin": False,
}
],
"teams": [],
"apps": [],
},
"required_pull_request_reviews": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_pull_request_reviews",
"dismiss_stale_reviews": True,
"require_code_owner_reviews": True,
"require_last_push_approval": True,
"required_approving_review_count": 1,
"dismissal_restrictions": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions",
"users_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions/users",
"teams_url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions/teams",
"users": [
{
"login": "greenbonebot",
"id": 123,
"node_id": "MDQ6VXNlcjg1MjU0NjY2",
"avatar_url": "https://avatars.githubusercontent.com/u/85254666?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbonebot",
"html_url": "https://github.com/greenbonebot",
"followers_url": "https://api.github.com/users/greenbonebot/followers",
"following_url": "https://api.github.com/users/greenbonebot/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbonebot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbonebot/subscriptions",
"organizations_url": "https://api.github.com/users/greenbonebot/orgs",
"repos_url": "https://api.github.com/users/greenbonebot/repos",
"events_url": "https://api.github.com/users/greenbonebot/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbonebot/received_events",
"type": "User",
"site_admin": False,
}
],
"teams": [
{
"name": "devops",
"id": 123,
"node_id": "T_kwDOAegUqc4AUtL1",
"slug": "devops",
"description": "Team responsible for DevOps",
"privacy": "closed",
"url": "https://api.github.com/organizations/321/team/123",
"html_url": "https://github.com/orgs/foo/teams/devops",
"members_url": "https://api.github.com/organizations/321/team/123/members{/member}",
"repositories_url": "https://api.github.com/organizations/321/team/123/repos",
"permission": "pull",
"parent": None,
}
],
"apps": [],
},
},
"required_signatures": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_signatures",
"enabled": True,
},
"enforce_admins": {
"url": "https://api.github.com/repos/foo/bar/branches/branch_protection/protection/enforce_admins",
"enabled": True,
},
"required_linear_history": {"enabled": True},
"allow_force_pushes": {"enabled": False},
"allow_deletions": {"enabled": False},
"block_creations": {"enabled": True},
"required_conversation_resolution": {"enabled": True},
"lock_branch": {"enabled": True},
"allow_fork_syncing": {"enabled": False},
}
protection = BranchProtection.from_dict(data)
self.assertEqual(
protection.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection",
)
self.assertEqual(
protection.required_signatures.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_signatures",
)
self.assertTrue(protection.required_signatures.enabled)
self.assertEqual(
protection.enforce_admins.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/enforce_admins",
)
self.assertTrue(protection.enforce_admins.enabled)
self.assertTrue(protection.required_linear_history.enabled)
self.assertFalse(protection.allow_force_pushes.enabled)
self.assertFalse(protection.allow_deletions.enabled)
self.assertTrue(protection.block_creations.enabled)
self.assertTrue(protection.required_conversation_resolution.enabled)
self.assertTrue(protection.lock_branch.enabled)
self.assertFalse(protection.allow_fork_syncing.enabled)
self.assertEqual(
protection.required_status_checks.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_status_checks",
)
self.assertTrue(protection.required_status_checks.strict)
self.assertEqual(protection.required_status_checks.checks, [])
self.assertEqual(
protection.required_pull_request_reviews.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/required_pull_request_reviews",
)
self.assertTrue(
protection.required_pull_request_reviews.dismiss_stale_reviews
)
self.assertTrue(
protection.required_pull_request_reviews.require_code_owner_reviews
)
self.assertTrue(
protection.required_pull_request_reviews.require_last_push_approval
)
self.assertEqual(
protection.required_pull_request_reviews.required_approving_review_count,
1,
)
dismissal_restrictions = (
protection.required_pull_request_reviews.dismissal_restrictions
)
self.assertEqual(
dismissal_restrictions.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions",
)
self.assertEqual(
dismissal_restrictions.users_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions/users",
)
self.assertEqual(
dismissal_restrictions.teams_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/dismissal_restrictions/teams",
)
self.assertEqual(dismissal_restrictions.apps, [])
user = dismissal_restrictions.users[0]
self.assertEqual(len(dismissal_restrictions.users), 1)
self.assertEqual(user.login, "greenbonebot")
self.assertEqual(user.node_id, "MDQ6VXNlcjg1MjU0NjY2")
self.assertEqual(
user.avatar_url,
"https://avatars.githubusercontent.com/u/85254666?v=4",
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/greenbonebot")
self.assertEqual(user.html_url, "https://github.com/greenbonebot")
self.assertEqual(
user.followers_url,
"https://api.github.com/users/greenbonebot/followers",
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/greenbonebot/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/greenbonebot/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/greenbonebot/subscriptions",
)
self.assertEqual(
user.organizations_url,
"https://api.github.com/users/greenbonebot/orgs",
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/greenbonebot/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/greenbonebot/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/greenbonebot/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
self.assertEqual(len(dismissal_restrictions.teams), 1)
team = dismissal_restrictions.teams[0]
self.assertEqual(team.name, "devops")
self.assertEqual(team.id, 123)
self.assertEqual(team.node_id, "T_kwDOAegUqc4AUtL1")
self.assertEqual(team.slug, "devops")
self.assertEqual(team.description, "Team responsible for DevOps")
self.assertEqual(team.permission, Permission.PULL)
self.assertEqual(team.privacy, TeamPrivacy.CLOSED)
self.assertEqual(
team.url, "https://api.github.com/organizations/321/team/123"
)
self.assertEqual(
team.html_url, "https://github.com/orgs/foo/teams/devops"
)
self.assertEqual(
team.members_url,
"https://api.github.com/organizations/321/team/123/members{/member}",
)
self.assertEqual(
team.repositories_url,
"https://api.github.com/organizations/321/team/123/repos",
)
self.assertIsNone(team.parent)
self.assertEqual(
protection.restrictions.url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions",
)
self.assertEqual(
protection.restrictions.users_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/users",
)
self.assertEqual(
protection.restrictions.teams_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/teams",
)
self.assertEqual(
protection.restrictions.apps_url,
"https://api.github.com/repos/foo/bar/branches/branch_protection/protection/restrictions/apps",
)
user = protection.restrictions.users[0]
self.assertEqual(len(protection.restrictions.users), 1)
self.assertEqual(user.login, "greenbonebot")
self.assertEqual(user.node_id, "MDQ6VXNlcjg1MjU0NjY2")
self.assertEqual(
user.avatar_url,
"https://avatars.githubusercontent.com/u/85254666?v=4",
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/greenbonebot")
self.assertEqual(user.html_url, "https://github.com/greenbonebot")
self.assertEqual(
user.followers_url,
"https://api.github.com/users/greenbonebot/followers",
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/greenbonebot/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/greenbonebot/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/greenbonebot/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/greenbonebot/subscriptions",
)
self.assertEqual(
user.organizations_url,
"https://api.github.com/users/greenbonebot/orgs",
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/greenbonebot/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/greenbonebot/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/greenbonebot/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
self.assertEqual(protection.restrictions.teams, [])
self.assertEqual(protection.restrictions.apps, [])
pontos-25.3.2/tests/github/models/test_code_scanning.py 0000664 0000000 0000000 00000046305 14762555663 0023272 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
import unittest
from datetime import datetime, timezone
from pontos.github.models.code_scanning import (
AlertState,
Analysis,
CodeQLDatabase,
CodeScanningAlert,
DefaultSetup,
DefaultSetupState,
Instance,
Language,
Location,
QuerySuite,
Rule,
SarifProcessingStatus,
SarifUploadInformation,
Severity,
Tool,
)
ALERT = {
"number": 3,
"created_at": "2020-02-13T12:29:18Z",
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3",
"html_url": "https://github.com/octocat/hello-world/code-scanning/3",
"state": "dismissed",
"dismissed_by": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"dismissed_at": "2020-02-14T12:29:18Z",
"dismissed_reason": "false positive",
"dismissed_comment": "This alert is not actually correct, because there's "
"a sanitizer included in the library.",
"rule": {
"id": "js/zipslip",
"severity": "error",
"tags": ["security", "external/cwe/cwe-022"],
"description": "Arbitrary file write during zip extraction",
"name": "js/zipslip",
},
"tool": {"name": "CodeQL", "guid": None, "version": "2.4.0"},
"most_recent_instance": {
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"environment": "{}",
"state": "open",
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
"message": {"text": "This path depends on a user-provided value."},
"location": {
"path": "lib/ab12-gen.js",
"start_line": 917,
"end_line": 917,
"start_column": 7,
"end_column": 18,
},
"classifications": [],
},
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
},
}
class RuleTestCase(unittest.TestCase):
def test_from_dict(self):
rule = Rule.from_dict(
{
"id": "js/zipslip",
"severity": "error",
"tags": ["security", "external/cwe/cwe-022"],
"description": "Arbitrary file write during zip extraction",
"name": "js/zipslip",
}
)
self.assertEqual(rule.id, "js/zipslip")
self.assertEqual(rule.name, "js/zipslip")
self.assertEqual(rule.severity, Severity.ERROR)
self.assertEqual(len(rule.tags), 2)
self.assertEqual(rule.tags, ["security", "external/cwe/cwe-022"])
self.assertEqual(
rule.description, "Arbitrary file write during zip extraction"
)
class LocationTestCase(unittest.TestCase):
def test_from_dict(self):
location = Location.from_dict(
{
"path": "lib/ab12-gen.js",
"start_line": 917,
"end_line": 917,
"start_column": 7,
"end_column": 18,
}
)
self.assertEqual(location.path, "lib/ab12-gen.js")
self.assertEqual(location.start_line, 917)
self.assertEqual(location.end_line, 917)
self.assertEqual(location.start_column, 7)
self.assertEqual(location.end_column, 18)
class InstanceTestCase(unittest.TestCase):
def test_from_dict(self):
instance = Instance.from_dict(
{
"ref": "refs/heads/main",
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
"environment": "{}",
"state": "open",
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
"message": {
"text": "This path depends on a user-provided value."
},
"location": {
"path": "lib/ab12-gen.js",
"start_line": 917,
"end_line": 917,
"start_column": 7,
"end_column": 18,
},
"classifications": [],
}
)
self.assertEqual(instance.ref, "refs/heads/main")
self.assertEqual(
instance.analysis_key,
".github/workflows/codeql-analysis.yml:CodeQL-Build",
)
self.assertEqual(
instance.category,
".github/workflows/codeql-analysis.yml:CodeQL-Build",
)
self.assertEqual(instance.environment, "{}")
self.assertEqual(instance.state, AlertState.OPEN)
self.assertEqual(
instance.commit_sha, "39406e42cb832f683daa691dd652a8dc36ee8930"
)
self.assertEqual(
instance.message.text, "This path depends on a user-provided value."
)
self.assertEqual(instance.location.path, "lib/ab12-gen.js")
self.assertEqual(instance.location.start_line, 917)
self.assertEqual(instance.location.end_line, 917)
self.assertEqual(instance.location.start_column, 7)
self.assertEqual(instance.location.end_column, 18)
self.assertEqual(len(instance.classifications), 0)
class ToolTestCase(unittest.TestCase):
def test_from_dict(self):
tool = Tool.from_dict(
{"name": "CodeQL", "guid": None, "version": "2.4.0"}
)
self.assertEqual(tool.name, "CodeQL")
self.assertEqual(tool.version, "2.4.0")
self.assertIsNone(tool.guid)
class CodeScanningAlertTestCase(unittest.TestCase):
def test_from_dict(self):
alert = CodeScanningAlert.from_dict(ALERT)
self.assertEqual(alert.number, 3)
self.assertEqual(
alert.created_at,
datetime(2020, 2, 13, 12, 29, 18, tzinfo=timezone.utc),
)
self.assertEqual(
alert.url,
"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3",
)
self.assertEqual(
alert.html_url,
"https://github.com/octocat/hello-world/code-scanning/3",
)
self.assertEqual(alert.state, AlertState.DISMISSED)
self.assertEqual(
alert.dismissed_at,
datetime(2020, 2, 14, 12, 29, 18, tzinfo=timezone.utc),
)
self.assertEqual(alert.dismissed_by.login, "octocat")
self.assertEqual(
alert.dismissed_comment,
"This alert is not actually correct, because there's a sanitizer "
"included in the library.",
)
self.assertEqual(alert.rule.id, "js/zipslip")
self.assertEqual(alert.tool.name, "CodeQL")
self.assertEqual(alert.most_recent_instance.ref, "refs/heads/main")
self.assertEqual(
alert.most_recent_instance.location.path, "lib/ab12-gen.js"
)
self.assertEqual(
alert.instances_url,
"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances",
)
self.assertEqual(alert.repository.id, 1296269)
class AnalysisTestCase(unittest.TestCase):
def test_from_dict(self):
analysis = Analysis.from_dict(
{
"ref": "refs/heads/main",
"commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83",
"analysis_key": ".github/workflows/codeql-analysis.yml:analyze",
"environment": '{"language":"python"}',
"error": "",
"category": ".github/workflows/codeql-analysis.yml:analyze/language:python",
"created_at": "2020-08-27T15:05:21Z",
"results_count": 17,
"rules_count": 49,
"id": 201,
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
"sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
"tool": {"name": "CodeQL", "guid": None, "version": "2.4.0"},
"deletable": True,
"warning": "",
}
)
self.assertEqual(analysis.ref, "refs/heads/main")
self.assertEqual(
analysis.commit_sha, "d99612c3e1f2970085cfbaeadf8f010ef69bad83"
)
self.assertEqual(
analysis.analysis_key,
".github/workflows/codeql-analysis.yml:analyze",
)
self.assertEqual(analysis.environment, '{"language":"python"}')
self.assertEqual(analysis.error, "")
self.assertEqual(analysis.warning, "")
self.assertEqual(
analysis.category,
".github/workflows/codeql-analysis.yml:analyze/language:python",
)
self.assertEqual(
analysis.created_at,
datetime(2020, 8, 27, 15, 5, 21, tzinfo=timezone.utc),
)
self.assertEqual(analysis.results_count, 17)
self.assertEqual(analysis.rules_count, 49)
self.assertEqual(analysis.id, 201)
self.assertEqual(
analysis.url,
"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201",
)
self.assertEqual(
analysis.sarif_id, "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53"
)
self.assertEqual(analysis.tool.name, "CodeQL")
self.assertEqual(analysis.tool.version, "2.4.0")
self.assertIsNone(analysis.tool.guid)
self.assertTrue(analysis.deletable)
class CodeQLDatabaseTestCase(unittest.TestCase):
def test_from_dict(self):
db = CodeQLDatabase.from_dict(
{
"id": 1,
"name": "database.zip",
"language": "java",
"uploader": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"content_type": "application/zip",
"size": 1024,
"created_at": "2022-09-12T12:14:32Z",
"updated_at": "2022-09-12T12:14:32Z",
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
"commit_oid": "12345678901234567000",
}
)
self.assertEqual(db.id, 1)
self.assertEqual(db.name, "database.zip")
self.assertEqual(db.language, "java")
self.assertEqual(db.uploader.id, 1)
self.assertEqual(db.content_type, "application/zip")
self.assertEqual(db.size, 1024)
self.assertEqual(
db.created_at,
datetime(2022, 9, 12, 12, 14, 32, tzinfo=timezone.utc),
)
self.assertEqual(
db.updated_at,
datetime(2022, 9, 12, 12, 14, 32, tzinfo=timezone.utc),
)
self.assertEqual(
db.url,
"https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java",
)
self.assertEqual(db.commit_oid, "12345678901234567000")
class DefaultSetupTestCase(unittest.TestCase):
def test_from_dict(self):
setup = DefaultSetup.from_dict(
{
"state": "configured",
"languages": ["ruby", "python"],
"query_suite": "default",
"updated_at": "2023-01-19T11:21:34Z",
"schedule": "weekly",
}
)
self.assertEqual(setup.state, DefaultSetupState.CONFIGURED)
self.assertEqual(setup.languages, [Language.RUBY, Language.PYTHON])
self.assertEqual(setup.query_suite, QuerySuite.DEFAULT)
self.assertEqual(
setup.updated_at,
datetime(2023, 1, 19, 11, 21, 34, tzinfo=timezone.utc),
)
self.assertEqual(setup.schedule, "weekly")
class SarifUploadInformationTestCase(unittest.TestCase):
def test_from_dict(self):
sarif = SarifUploadInformation.from_dict(
{
"processing_status": "complete",
"analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6",
}
)
self.assertEqual(
sarif.processing_status, SarifProcessingStatus.COMPLETE
)
self.assertEqual(
sarif.analyses_url,
"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6",
)
self.assertIsNone(sarif.errors)
pontos-25.3.2/tests/github/models/test_dependabot.py 0000664 0000000 0000000 00000051043 14762555663 0022600 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
import unittest
from datetime import datetime, timezone
from pontos.github.models.dependabot import (
AlertState,
DependabotAlert,
DependencyScope,
DismissedReason,
IdentifierType,
SecurityAdvisory,
Severity,
Vulnerability,
VulnerablePackage,
)
class VulnerablePackageTestCase(unittest.TestCase):
def test_from_dict(self):
package = VulnerablePackage.from_dict(
{
"ecosystem": "pip",
"name": "django",
}
)
self.assertEqual(package.ecosystem, "pip")
self.assertEqual(package.name, "django")
class VulnerabilityTestCase(unittest.TestCase):
def test_from_dict(self):
vulnerability = Vulnerability.from_dict(
{
"package": {
"ecosystem": "pip",
"name": "django",
},
"severity": "high",
"vulnerable_version_range": ">= 2.0.0, < 2.0.2",
"first_patched_version": {"identifier": "2.0.2"},
}
)
self.assertEqual(vulnerability.package.ecosystem, "pip")
self.assertEqual(vulnerability.package.name, "django")
self.assertEqual(vulnerability.severity, Severity.HIGH)
self.assertEqual(
vulnerability.vulnerable_version_range, ">= 2.0.0, < 2.0.2"
)
self.assertEqual(
vulnerability.first_patched_version.identifier, "2.0.2"
)
vulnerability = Vulnerability.from_dict(
{
"package": {
"ecosystem": "pip",
"name": "django",
},
"severity": "high",
"vulnerable_version_range": ">= 2.0.0, < 2.0.2",
}
)
self.assertEqual(vulnerability.package.ecosystem, "pip")
self.assertEqual(vulnerability.package.name, "django")
self.assertEqual(vulnerability.severity, Severity.HIGH)
self.assertIsNone(vulnerability.first_patched_version)
SECURITY_ADVISORY = {
"ghsa_id": "GHSA-rf4j-j272-fj86",
"cve_id": "CVE-2018-6188",
"summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive",
"description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
"vulnerabilities": [
{
"package": {"ecosystem": "pip", "name": "django"},
"severity": "high",
"vulnerable_version_range": ">= 2.0.0, < 2.0.2",
"first_patched_version": {"identifier": "2.0.2"},
},
{
"package": {"ecosystem": "pip", "name": "django"},
"severity": "high",
"vulnerable_version_range": ">= 1.11.8, < 1.11.10",
"first_patched_version": {"identifier": "1.11.10"},
},
],
"severity": "high",
"cvss": {
"vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
"score": 7.5,
},
"cwes": [
{
"cwe_id": "CWE-200",
"name": "Exposure of Sensitive Information to an Unauthorized Actor",
}
],
"identifiers": [
{"type": "GHSA", "value": "GHSA-rf4j-j272-fj86"},
{"type": "CVE", "value": "CVE-2018-6188"},
],
"references": [
{"url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"},
{"url": "https://github.com/advisories/GHSA-rf4j-j272-fj86"},
{"url": "https://usn.ubuntu.com/3559-1/"},
{
"url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/"
},
{"url": "http://www.securitytracker.com/id/1040422"},
],
"published_at": "2018-10-03T21:13:54Z",
"updated_at": "2022-04-26T18:35:37Z",
"withdrawn_at": None,
}
class SecurityAdvisoryTestCase(unittest.TestCase):
def test_from_dict(self):
advisory = SecurityAdvisory.from_dict(SECURITY_ADVISORY)
self.assertEqual(advisory.cve_id, "CVE-2018-6188")
self.assertEqual(advisory.ghsa_id, "GHSA-rf4j-j272-fj86")
self.assertEqual(
advisory.cvss.vector_string,
"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
)
self.assertEqual(advisory.cvss.score, 7.5)
self.assertRegex(advisory.summary, "^Django allows remote attacker.*")
self.assertRegex(
advisory.description,
"^django\.contrib\.auth\.forms\.AuthenticationForm in Django 2\.0.*",
)
self.assertEqual(len(advisory.vulnerabilities), 2)
vuln = advisory.vulnerabilities[0]
self.assertEqual(vuln.package.ecosystem, "pip")
self.assertEqual(vuln.package.name, "django")
self.assertEqual(vuln.severity, Severity.HIGH)
self.assertEqual(vuln.vulnerable_version_range, ">= 2.0.0, < 2.0.2")
self.assertEqual(vuln.first_patched_version.identifier, "2.0.2")
vuln = advisory.vulnerabilities[1]
self.assertEqual(vuln.package.ecosystem, "pip")
self.assertEqual(vuln.package.name, "django")
self.assertEqual(vuln.severity, Severity.HIGH)
self.assertEqual(vuln.vulnerable_version_range, ">= 1.11.8, < 1.11.10")
self.assertEqual(vuln.first_patched_version.identifier, "1.11.10")
self.assertEqual(len(advisory.cwes), 1)
cwe = advisory.cwes[0]
self.assertEqual(cwe.cwe_id, "CWE-200")
self.assertEqual(
cwe.name,
"Exposure of Sensitive Information to an Unauthorized Actor",
)
self.assertEqual(len(advisory.identifiers), 2)
identifier = advisory.identifiers[0]
self.assertEqual(identifier.type, IdentifierType.GHSA)
self.assertEqual(identifier.value, "GHSA-rf4j-j272-fj86")
identifier = advisory.identifiers[1]
self.assertEqual(identifier.type, IdentifierType.CVE)
self.assertEqual(identifier.value, "CVE-2018-6188")
self.assertEqual(len(advisory.references), 5)
self.assertEqual(
advisory.references[0].url,
"https://nvd.nist.gov/vuln/detail/CVE-2018-6188",
)
self.assertEqual(
advisory.published_at,
datetime(2018, 10, 3, 21, 13, 54, tzinfo=timezone.utc),
)
self.assertEqual(
advisory.updated_at,
datetime(2022, 4, 26, 18, 35, 37, tzinfo=timezone.utc),
)
self.assertIsNone(advisory.withdrawn_at)
DEPENDABOT_ALERT = {
"number": 2,
"state": "dismissed",
"dependency": {
"package": {"ecosystem": "pip", "name": "django"},
"manifest_path": "path/to/requirements.txt",
"scope": "runtime",
},
"security_advisory": {
"ghsa_id": "GHSA-rf4j-j272-fj86",
"cve_id": "CVE-2018-6188",
"summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive",
"description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
"vulnerabilities": [
{
"package": {"ecosystem": "pip", "name": "django"},
"severity": "high",
"vulnerable_version_range": ">= 2.0.0, < 2.0.2",
"first_patched_version": {"identifier": "2.0.2"},
},
{
"package": {"ecosystem": "pip", "name": "django"},
"severity": "high",
"vulnerable_version_range": ">= 1.11.8, < 1.11.10",
"first_patched_version": {"identifier": "1.11.10"},
},
],
"severity": "high",
"cvss": {
"vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
"score": 7.5,
},
"cwes": [
{
"cwe_id": "CWE-200",
"name": "Exposure of Sensitive Information to an Unauthorized Actor",
}
],
"identifiers": [
{"type": "GHSA", "value": "GHSA-rf4j-j272-fj86"},
{"type": "CVE", "value": "CVE-2018-6188"},
],
"references": [
{"url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"},
{"url": "https://github.com/advisories/GHSA-rf4j-j272-fj86"},
{"url": "https://usn.ubuntu.com/3559-1/"},
{
"url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/"
},
{"url": "http://www.securitytracker.com/id/1040422"},
],
"published_at": "2018-10-03T21:13:54Z",
"updated_at": "2022-04-26T18:35:37Z",
"withdrawn_at": None,
},
"security_vulnerability": {
"package": {"ecosystem": "pip", "name": "django"},
"severity": "high",
"vulnerable_version_range": ">= 2.0.0, < 2.0.2",
"first_patched_version": {"identifier": "2.0.2"},
},
"url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2",
"html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2",
"created_at": "2022-06-15T07:43:03Z",
"updated_at": "2022-08-23T14:29:47Z",
"dismissed_at": "2022-08-23T14:29:47Z",
"dismissed_by": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"dismissed_reason": "tolerable_risk",
"dismissed_comment": "This alert is accurate but we use a sanitizer.",
"fixed_at": None,
"repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"owner": {
"login": "octo-org",
"id": 6811672,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"repos_url": "https://api.github.com/users/octo-org/repos",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"type": "Organization",
"site_admin": False,
},
"private": True,
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
},
}
class DependabotAlertTestCase(unittest.TestCase):
def test_from_dict(self):
alert = DependabotAlert.from_dict(DEPENDABOT_ALERT)
self.assertEqual(alert.number, 2)
self.assertEqual(alert.state, AlertState.DISMISSED)
self.assertEqual(alert.dependency.package.ecosystem, "pip")
self.assertEqual(alert.dependency.package.name, "django")
self.assertEqual(
alert.dependency.manifest_path, "path/to/requirements.txt"
)
self.assertEqual(alert.dependency.scope, DependencyScope.RUNTIME)
self.assertEqual(alert.security_advisory.cve_id, "CVE-2018-6188")
self.assertEqual(alert.security_advisory.ghsa_id, "GHSA-rf4j-j272-fj86")
self.assertEqual(
alert.security_advisory.cvss.vector_string,
"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N",
)
self.assertEqual(alert.security_advisory.cvss.score, 7.5)
self.assertRegex(
alert.security_advisory.summary, "^Django allows remote attacker.*"
)
self.assertRegex(
alert.security_advisory.description,
"^django\.contrib\.auth\.forms\.AuthenticationForm in Django 2\.0.*",
)
self.assertEqual(len(alert.security_advisory.vulnerabilities), 2)
vuln = alert.security_advisory.vulnerabilities[0]
self.assertEqual(vuln.package.ecosystem, "pip")
self.assertEqual(vuln.package.name, "django")
self.assertEqual(vuln.severity, Severity.HIGH)
self.assertEqual(vuln.vulnerable_version_range, ">= 2.0.0, < 2.0.2")
self.assertEqual(vuln.first_patched_version.identifier, "2.0.2")
vuln = alert.security_advisory.vulnerabilities[1]
self.assertEqual(vuln.package.ecosystem, "pip")
self.assertEqual(vuln.package.name, "django")
self.assertEqual(vuln.severity, Severity.HIGH)
self.assertEqual(vuln.vulnerable_version_range, ">= 1.11.8, < 1.11.10")
self.assertEqual(vuln.first_patched_version.identifier, "1.11.10")
self.assertEqual(len(alert.security_advisory.cwes), 1)
cwe = alert.security_advisory.cwes[0]
self.assertEqual(cwe.cwe_id, "CWE-200")
self.assertEqual(
cwe.name,
"Exposure of Sensitive Information to an Unauthorized Actor",
)
self.assertEqual(len(alert.security_advisory.identifiers), 2)
identifier = alert.security_advisory.identifiers[0]
self.assertEqual(identifier.type, IdentifierType.GHSA)
self.assertEqual(identifier.value, "GHSA-rf4j-j272-fj86")
identifier = alert.security_advisory.identifiers[1]
self.assertEqual(identifier.type, IdentifierType.CVE)
self.assertEqual(identifier.value, "CVE-2018-6188")
self.assertEqual(len(alert.security_advisory.references), 5)
self.assertEqual(
alert.security_advisory.references[0].url,
"https://nvd.nist.gov/vuln/detail/CVE-2018-6188",
)
self.assertEqual(
alert.security_advisory.published_at,
datetime(2018, 10, 3, 21, 13, 54, tzinfo=timezone.utc),
)
self.assertEqual(
alert.security_advisory.updated_at,
datetime(2022, 4, 26, 18, 35, 37, tzinfo=timezone.utc),
)
self.assertIsNone(alert.security_advisory.withdrawn_at)
self.assertEqual(alert.security_vulnerability.package.ecosystem, "pip")
self.assertEqual(alert.security_vulnerability.package.name, "django")
self.assertEqual(
alert.security_vulnerability.vulnerable_version_range,
">= 2.0.0, < 2.0.2",
)
self.assertEqual(
alert.security_vulnerability.first_patched_version.identifier,
"2.0.2",
)
self.assertEqual(alert.security_vulnerability.severity, Severity.HIGH)
self.assertEqual(
alert.url,
"https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2",
)
self.assertEqual(
alert.html_url,
"https://github.com/octo-org/octo-repo/security/dependabot/2",
)
self.assertEqual(
alert.created_at,
datetime(2022, 6, 15, 7, 43, 3, tzinfo=timezone.utc),
)
self.assertEqual(
alert.updated_at,
datetime(2022, 8, 23, 14, 29, 47, tzinfo=timezone.utc),
)
self.assertEqual(
alert.dismissed_at,
datetime(2022, 8, 23, 14, 29, 47, tzinfo=timezone.utc),
)
self.assertEqual(alert.dismissed_by.login, "octocat")
self.assertEqual(alert.dismissed_reason, DismissedReason.TOLERABLE_RISK)
self.assertEqual(
alert.dismissed_comment,
"This alert is accurate but we use a sanitizer.",
)
self.assertIsNone(alert.fixed_at)
self.assertIsNone(alert.auto_dismissed_at)
self.assertEqual(alert.repository.id, 217723378)
pontos-25.3.2/tests/github/models/test_organization.py 0000664 0000000 0000000 00000045512 14762555663 0023203 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long, redefined-builtin
# ruff: noqa: E501
import unittest
from datetime import datetime, timezone
from pontos.github.models.organization import License, Repository
class LicenseTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"key": "gpl-3.0",
"name": "GNU General Public License v3.0",
"spdx_id": "GPL-3.0",
"url": "https://api.github.com/licenses/gpl-3.0",
"node_id": "MDc6TGljZW5zZTk=",
}
license = License.from_dict(data)
self.assertEqual(license.key, "gpl-3.0")
self.assertEqual(license.name, "GNU General Public License v3.0")
self.assertEqual(license.spdx_id, "GPL-3.0")
self.assertEqual(license.url, "https://api.github.com/licenses/gpl-3.0")
self.assertEqual(license.node_id, "MDc6TGljZW5zZTk=")
class RepositoryTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"id": 103647077,
"node_id": "MDEwOlJlcG9zaXRvcnkxMDM2NDcwNzc=",
"name": "gvm-tools",
"full_name": "greenbone/gvm-tools",
"private": False,
"owner": {
"login": "greenbone",
"id": 31986857,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjMxOTg2ODU3",
"avatar_url": "https://avatars.githubusercontent.com/u/31986857?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/greenbone",
"html_url": "https://github.com/greenbone",
"followers_url": "https://api.github.com/users/greenbone/followers",
"following_url": "https://api.github.com/users/greenbone/following{/other_user}",
"gists_url": "https://api.github.com/users/greenbone/gists{/gist_id}",
"starred_url": "https://api.github.com/users/greenbone/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/greenbone/subscriptions",
"organizations_url": "https://api.github.com/users/greenbone/orgs",
"repos_url": "https://api.github.com/users/greenbone/repos",
"events_url": "https://api.github.com/users/greenbone/events{/privacy}",
"received_events_url": "https://api.github.com/users/greenbone/received_events",
"type": "Organization",
"site_admin": False,
},
"html_url": "https://github.com/greenbone/gvm-tools",
"description": "Remote control your Greenbone Community Edition or Greenbone Enterprise Appliance",
"fork": False,
"url": "https://api.github.com/repos/greenbone/gvm-tools",
"forks_url": "https://api.github.com/repos/greenbone/gvm-tools/forks",
"keys_url": "https://api.github.com/repos/greenbone/gvm-tools/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/greenbone/gvm-tools/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/greenbone/gvm-tools/teams",
"hooks_url": "https://api.github.com/repos/greenbone/gvm-tools/hooks",
"issue_events_url": "https://api.github.com/repos/greenbone/gvm-tools/issues/events{/number}",
"events_url": "https://api.github.com/repos/greenbone/gvm-tools/events",
"assignees_url": "https://api.github.com/repos/greenbone/gvm-tools/assignees{/user}",
"branches_url": "https://api.github.com/repos/greenbone/gvm-tools/branches{/branch}",
"tags_url": "https://api.github.com/repos/greenbone/gvm-tools/tags",
"blobs_url": "https://api.github.com/repos/greenbone/gvm-tools/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/greenbone/gvm-tools/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/greenbone/gvm-tools/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/greenbone/gvm-tools/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/greenbone/gvm-tools/statuses/{sha}",
"languages_url": "https://api.github.com/repos/greenbone/gvm-tools/languages",
"stargazers_url": "https://api.github.com/repos/greenbone/gvm-tools/stargazers",
"contributors_url": "https://api.github.com/repos/greenbone/gvm-tools/contributors",
"subscribers_url": "https://api.github.com/repos/greenbone/gvm-tools/subscribers",
"subscription_url": "https://api.github.com/repos/greenbone/gvm-tools/subscription",
"commits_url": "https://api.github.com/repos/greenbone/gvm-tools/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/greenbone/gvm-tools/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/greenbone/gvm-tools/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/greenbone/gvm-tools/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/greenbone/gvm-tools/contents/{+path}",
"compare_url": "https://api.github.com/repos/greenbone/gvm-tools/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/greenbone/gvm-tools/merges",
"archive_url": "https://api.github.com/repos/greenbone/gvm-tools/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/greenbone/gvm-tools/downloads",
"issues_url": "https://api.github.com/repos/greenbone/gvm-tools/issues{/number}",
"pulls_url": "https://api.github.com/repos/greenbone/gvm-tools/pulls{/number}",
"milestones_url": "https://api.github.com/repos/greenbone/gvm-tools/milestones{/number}",
"notifications_url": "https://api.github.com/repos/greenbone/gvm-tools/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/greenbone/gvm-tools/labels{/name}",
"releases_url": "https://api.github.com/repos/greenbone/gvm-tools/releases{/id}",
"deployments_url": "https://api.github.com/repos/greenbone/gvm-tools/deployments",
"created_at": "2017-09-15T10:54:42Z",
"updated_at": "2022-11-01T07:45:33Z",
"pushed_at": "2022-11-07T09:21:30Z",
"git_url": "git://github.com/greenbone/gvm-tools.git",
"ssh_url": "git@github.com:greenbone/gvm-tools.git",
"clone_url": "https://github.com/greenbone/gvm-tools.git",
"svn_url": "https://github.com/greenbone/gvm-tools",
"homepage": "https://greenbone.github.io/gvm-tools/",
"size": 3461,
"stargazers_count": 128,
"watchers_count": 128,
"language": "Python",
"has_issues": True,
"has_projects": False,
"has_downloads": True,
"has_wiki": True,
"has_pages": True,
"has_discussions": False,
"forks_count": 74,
"mirror_url": None,
"archived": False,
"disabled": False,
"open_issues_count": 3,
"license": {
"key": "gpl-3.0",
"name": "GNU General Public License v3.0",
"spdx_id": "GPL-3.0",
"url": "https://api.github.com/licenses/gpl-3.0",
"node_id": "MDc6TGljZW5zZTk=",
},
"allow_forking": True,
"is_template": False,
"web_commit_signoff_required": False,
"topics": [
"gmp",
"gmp-scripts",
"greenbone",
"greenbone-vulnerability-manager",
"gvm",
"gvm-cli",
"gvm-pyshell",
"gvm-script",
"omp",
"openvas",
"openvas-cli",
"osp",
"python",
"vulnerability",
"vulnerability-assessment",
"vulnerability-management",
],
"visibility": "public",
"forks": 74,
"open_issues": 3,
"watchers": 128,
"default_branch": "main",
}
repo = Repository.from_dict(data)
self.assertEqual(repo.id, 103647077)
self.assertEqual(repo.node_id, "MDEwOlJlcG9zaXRvcnkxMDM2NDcwNzc=")
self.assertEqual(repo.name, "gvm-tools")
self.assertEqual(repo.full_name, "greenbone/gvm-tools")
self.assertEqual(repo.private, False)
self.assertEqual(repo.owner.login, "greenbone")
self.assertEqual(repo.owner.id, 31986857)
self.assertEqual(repo.owner.node_id, "MDEyOk9yZ2FuaXphdGlvbjMxOTg2ODU3")
self.assertEqual(
repo.owner.avatar_url,
"https://avatars.githubusercontent.com/u/31986857?v=4",
)
self.assertEqual(repo.owner.gravatar_id, "")
self.assertEqual(
repo.owner.url, "https://api.github.com/users/greenbone"
)
self.assertEqual(repo.owner.html_url, "https://github.com/greenbone")
self.assertEqual(
repo.owner.followers_url,
"https://api.github.com/users/greenbone/followers",
)
self.assertEqual(
repo.owner.following_url,
"https://api.github.com/users/greenbone/following{/other_user}",
)
self.assertEqual(
repo.owner.gists_url,
"https://api.github.com/users/greenbone/gists{/gist_id}",
)
self.assertEqual(
repo.owner.starred_url,
"https://api.github.com/users/greenbone/starred{/owner}{/repo}",
)
self.assertEqual(
repo.owner.subscriptions_url,
"https://api.github.com/users/greenbone/subscriptions",
)
self.assertEqual(
repo.owner.organizations_url,
"https://api.github.com/users/greenbone/orgs",
)
self.assertEqual(
repo.owner.repos_url, "https://api.github.com/users/greenbone/repos"
)
self.assertEqual(
repo.owner.events_url,
"https://api.github.com/users/greenbone/events{/privacy}",
)
self.assertEqual(
repo.owner.received_events_url,
"https://api.github.com/users/greenbone/received_events",
)
self.assertEqual(repo.owner.type, "Organization")
self.assertFalse(repo.owner.site_admin)
self.assertEqual(
repo.html_url, "https://github.com/greenbone/gvm-tools"
)
self.assertEqual(
repo.description,
"Remote control your Greenbone Community Edition or Greenbone Enterprise Appliance",
)
self.assertEqual(repo.fork, False)
self.assertEqual(
repo.url, "https://api.github.com/repos/greenbone/gvm-tools"
)
self.assertEqual(
repo.forks_url,
"https://api.github.com/repos/greenbone/gvm-tools/forks",
)
self.assertEqual(
repo.keys_url,
"https://api.github.com/repos/greenbone/gvm-tools/keys{/key_id}",
)
self.assertEqual(
repo.collaborators_url,
"https://api.github.com/repos/greenbone/gvm-tools/collaborators{/collaborator}",
)
self.assertEqual(
repo.teams_url,
"https://api.github.com/repos/greenbone/gvm-tools/teams",
)
self.assertEqual(
repo.hooks_url,
"https://api.github.com/repos/greenbone/gvm-tools/hooks",
)
self.assertEqual(
repo.issue_events_url,
"https://api.github.com/repos/greenbone/gvm-tools/issues/events{/number}",
)
self.assertEqual(
repo.events_url,
"https://api.github.com/repos/greenbone/gvm-tools/events",
)
self.assertEqual(
repo.assignees_url,
"https://api.github.com/repos/greenbone/gvm-tools/assignees{/user}",
)
self.assertEqual(
repo.branches_url,
"https://api.github.com/repos/greenbone/gvm-tools/branches{/branch}",
)
self.assertEqual(
repo.tags_url,
"https://api.github.com/repos/greenbone/gvm-tools/tags",
)
self.assertEqual(
repo.blobs_url,
"https://api.github.com/repos/greenbone/gvm-tools/git/blobs{/sha}",
)
self.assertEqual(
repo.git_tags_url,
"https://api.github.com/repos/greenbone/gvm-tools/git/tags{/sha}",
)
self.assertEqual(
repo.git_refs_url,
"https://api.github.com/repos/greenbone/gvm-tools/git/refs{/sha}",
)
self.assertEqual(
repo.trees_url,
"https://api.github.com/repos/greenbone/gvm-tools/git/trees{/sha}",
)
self.assertEqual(
repo.statuses_url,
"https://api.github.com/repos/greenbone/gvm-tools/statuses/{sha}",
)
self.assertEqual(
repo.languages_url,
"https://api.github.com/repos/greenbone/gvm-tools/languages",
)
self.assertEqual(
repo.stargazers_url,
"https://api.github.com/repos/greenbone/gvm-tools/stargazers",
)
self.assertEqual(
repo.contributors_url,
"https://api.github.com/repos/greenbone/gvm-tools/contributors",
)
self.assertEqual(
repo.subscribers_url,
"https://api.github.com/repos/greenbone/gvm-tools/subscribers",
)
self.assertEqual(
repo.subscription_url,
"https://api.github.com/repos/greenbone/gvm-tools/subscription",
)
self.assertEqual(
repo.commits_url,
"https://api.github.com/repos/greenbone/gvm-tools/commits{/sha}",
)
self.assertEqual(
repo.git_commits_url,
"https://api.github.com/repos/greenbone/gvm-tools/git/commits{/sha}",
)
self.assertEqual(
repo.comments_url,
"https://api.github.com/repos/greenbone/gvm-tools/comments{/number}",
)
self.assertEqual(
repo.issue_comment_url,
"https://api.github.com/repos/greenbone/gvm-tools/issues/comments{/number}",
)
self.assertEqual(
repo.contents_url,
"https://api.github.com/repos/greenbone/gvm-tools/contents/{+path}",
)
self.assertEqual(
repo.compare_url,
"https://api.github.com/repos/greenbone/gvm-tools/compare/{base}...{head}",
)
self.assertEqual(
repo.merges_url,
"https://api.github.com/repos/greenbone/gvm-tools/merges",
)
self.assertEqual(
repo.archive_url,
"https://api.github.com/repos/greenbone/gvm-tools/{archive_format}{/ref}",
)
self.assertEqual(
repo.downloads_url,
"https://api.github.com/repos/greenbone/gvm-tools/downloads",
)
self.assertEqual(
repo.issues_url,
"https://api.github.com/repos/greenbone/gvm-tools/issues{/number}",
)
self.assertEqual(
repo.pulls_url,
"https://api.github.com/repos/greenbone/gvm-tools/pulls{/number}",
)
self.assertEqual(
repo.milestones_url,
"https://api.github.com/repos/greenbone/gvm-tools/milestones{/number}",
)
self.assertEqual(
repo.notifications_url,
"https://api.github.com/repos/greenbone/gvm-tools/notifications{?since,all,participating}",
)
self.assertEqual(
repo.labels_url,
"https://api.github.com/repos/greenbone/gvm-tools/labels{/name}",
)
self.assertEqual(
repo.releases_url,
"https://api.github.com/repos/greenbone/gvm-tools/releases{/id}",
)
self.assertEqual(
repo.deployments_url,
"https://api.github.com/repos/greenbone/gvm-tools/deployments",
)
self.assertEqual(
repo.created_at,
datetime(2017, 9, 15, 10, 54, 42, tzinfo=timezone.utc),
)
self.assertEqual(
repo.updated_at,
datetime(2022, 11, 1, 7, 45, 33, tzinfo=timezone.utc),
)
self.assertEqual(
repo.pushed_at,
datetime(2022, 11, 7, 9, 21, 30, tzinfo=timezone.utc),
)
self.assertEqual(
repo.git_url, "git://github.com/greenbone/gvm-tools.git"
)
self.assertEqual(repo.ssh_url, "git@github.com:greenbone/gvm-tools.git")
self.assertEqual(
repo.clone_url, "https://github.com/greenbone/gvm-tools.git"
)
self.assertEqual(repo.svn_url, "https://github.com/greenbone/gvm-tools")
self.assertEqual(
repo.homepage, "https://greenbone.github.io/gvm-tools/"
)
self.assertEqual(repo.size, 3461)
self.assertEqual(repo.stargazers_count, 128)
self.assertEqual(repo.watchers_count, 128)
self.assertEqual(repo.language, "Python")
self.assertEqual(repo.has_issues, True)
self.assertEqual(repo.has_projects, False)
self.assertEqual(repo.has_downloads, True)
self.assertEqual(repo.has_wiki, True)
self.assertEqual(repo.has_pages, True)
self.assertEqual(repo.has_discussions, False)
self.assertEqual(repo.forks_count, 74)
self.assertEqual(repo.mirror_url, None)
self.assertEqual(repo.archived, False)
self.assertEqual(repo.disabled, False)
self.assertEqual(repo.open_issues_count, 3)
self.assertEqual(repo.license.key, "gpl-3.0")
self.assertEqual(repo.license.name, "GNU General Public License v3.0")
self.assertEqual(repo.license.spdx_id, "GPL-3.0")
self.assertEqual(
repo.license.url, "https://api.github.com/licenses/gpl-3.0"
)
self.assertEqual(repo.license.node_id, "MDc6TGljZW5zZTk=")
self.assertTrue(repo.allow_forking)
self.assertFalse(repo.is_template)
self.assertFalse(repo.web_commit_signoff_required)
self.assertEqual(
repo.topics,
[
"gmp",
"gmp-scripts",
"greenbone",
"greenbone-vulnerability-manager",
"gvm",
"gvm-cli",
"gvm-pyshell",
"gvm-script",
"omp",
"openvas",
"openvas-cli",
"osp",
"python",
"vulnerability",
"vulnerability-assessment",
"vulnerability-management",
],
)
self.assertEqual(repo.visibility, "public")
self.assertEqual(repo.forks, 74)
self.assertEqual(repo.open_issues, 3)
self.assertEqual(repo.watchers, 128)
self.assertEqual(repo.default_branch, "main")
pontos-25.3.2/tests/github/models/test_pull_request.py 0000664 0000000 0000000 00000234623 14762555663 0023226 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long, too-many-lines
import unittest
from datetime import datetime, timezone
from pontos.github.models.base import Permission, TeamPrivacy
from pontos.github.models.pull_request import (
AuthorAssociation,
Comment,
MilestoneState,
PullRequest,
PullRequestState,
)
class PullRequestTestCase(unittest.TestCase):
def test_from_dict(self):
pr = PullRequest.from_dict(
{
"url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
"id": 1,
"node_id": "MDExOlB1bGxSZXF1ZXN0MQ==",
"html_url": "https://github.com/octocat/Hello-World/pull/1347",
"diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
"patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch",
"issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
"review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
"review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
"number": 1347,
"state": "open",
"locked": True,
"title": "Amazing new feature",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"body": "Please pull these awesome changes in!",
"labels": [
{
"id": 208045946,
"node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
"url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
"name": "bug",
"description": "Something isn't working",
"color": "f29513",
"default": True,
}
],
"milestone": {
"url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
"html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
"id": 1002604,
"node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
"number": 1,
"state": "open",
"title": "v1.0",
"description": "Tracking milestone for version 1.0",
"creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"open_issues": 4,
"closed_issues": 8,
"created_at": "2011-04-10T20:09:31Z",
"updated_at": "2014-03-03T18:58:10Z",
"closed_at": "2013-02-12T13:22:01Z",
"due_on": "2012-10-09T23:39:01Z",
},
"active_lock_reason": "too heated",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:01:12Z",
"closed_at": "2011-01-26T19:01:12Z",
"merged_at": "2011-01-26T19:01:12Z",
"merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
"assignee": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"assignees": [
{
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
{
"login": "hubot",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/hubot_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/hubot",
"html_url": "https://github.com/hubot",
"followers_url": "https://api.github.com/users/hubot/followers",
"following_url": "https://api.github.com/users/hubot/following{/other_user}",
"gists_url": "https://api.github.com/users/hubot/gists{/gist_id}",
"starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/hubot/subscriptions",
"organizations_url": "https://api.github.com/users/hubot/orgs",
"repos_url": "https://api.github.com/users/hubot/repos",
"events_url": "https://api.github.com/users/hubot/events{/privacy}",
"received_events_url": "https://api.github.com/users/hubot/received_events",
"type": "User",
"site_admin": True,
},
],
"requested_reviewers": [
{
"login": "other_user",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/other_user_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/other_user",
"html_url": "https://github.com/other_user",
"followers_url": "https://api.github.com/users/other_user/followers",
"following_url": "https://api.github.com/users/other_user/following{/other_user}",
"gists_url": "https://api.github.com/users/other_user/gists{/gist_id}",
"starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/other_user/subscriptions",
"organizations_url": "https://api.github.com/users/other_user/orgs",
"repos_url": "https://api.github.com/users/other_user/repos",
"events_url": "https://api.github.com/users/other_user/events{/privacy}",
"received_events_url": "https://api.github.com/users/other_user/received_events",
"type": "User",
"site_admin": False,
}
],
"requested_teams": [
{
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
}
],
"head": {
"label": "octocat:new-topic",
"ref": "new-topic",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"repo": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": False,
"push": False,
"pull": True,
},
"allow_rebase_merge": True,
"allow_squash_merge": True,
"allow_merge_commit": True,
"allow_forking": True,
"forks": 123,
"open_issues": 123,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
},
"watchers": 123,
},
},
"base": {
"label": "octocat:master",
"ref": "master",
"sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"repo": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": None,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"topics": ["octocat", "atom", "electron", "api"],
"has_issues": True,
"has_projects": True,
"has_wiki": True,
"has_pages": False,
"has_downloads": True,
"has_discussions": False,
"archived": False,
"disabled": False,
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": False,
"push": False,
"pull": True,
},
"allow_rebase_merge": True,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": True,
"allow_merge_commit": True,
"allow_forking": True,
"forks": 123,
"open_issues": 123,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
},
"watchers": 123,
},
},
"_links": {
"self": {
"href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347"
},
"html": {
"href": "https://github.com/octocat/Hello-World/pull/1347"
},
"issue": {
"href": "https://api.github.com/repos/octocat/Hello-World/issues/1347"
},
"comments": {
"href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments"
},
"review_comments": {
"href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments"
},
"review_comment": {
"href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}"
},
"commits": {
"href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits"
},
"statuses": {
"href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e"
},
},
"author_association": "OWNER",
"auto_merge": None,
"draft": False,
"merged": False,
"mergeable": True,
"rebaseable": True,
"mergeable_state": "clean",
"merged_by": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"comments": 10,
"review_comments": 0,
"maintainer_can_modify": True,
"commits": 3,
"additions": 100,
"deletions": 3,
"changed_files": 5,
}
)
self.assertEqual(
pr.url,
"https://api.github.com/repos/octocat/Hello-World/pulls/1347",
)
self.assertEqual(pr.id, 1)
self.assertEqual(pr.node_id, "MDExOlB1bGxSZXF1ZXN0MQ==")
self.assertEqual(
pr.html_url, "https://github.com/octocat/Hello-World/pull/1347"
)
self.assertEqual(
pr.diff_url, "https://github.com/octocat/Hello-World/pull/1347.diff"
)
self.assertEqual(
pr.patch_url,
"https://github.com/octocat/Hello-World/pull/1347.patch",
)
self.assertEqual(
pr.issue_url,
"https://api.github.com/repos/octocat/Hello-World/issues/1347",
)
self.assertEqual(
pr.commits_url,
"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits",
)
self.assertEqual(
pr.review_comments_url,
"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments",
)
self.assertEqual(
pr.review_comment_url,
"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}",
)
self.assertEqual(
pr.comments_url,
"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
)
self.assertEqual(
pr.statuses_url,
"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e",
)
self.assertEqual(pr.number, 1347)
self.assertEqual(pr.state, PullRequestState.OPEN)
self.assertTrue(pr.locked)
self.assertEqual(pr.title, "Amazing new feature")
self.assertEqual(pr.body, "Please pull these awesome changes in!")
self.assertEqual(pr.active_lock_reason, "too heated")
self.assertEqual(
pr.created_at, datetime(2011, 1, 26, 19, 1, 12, tzinfo=timezone.utc)
)
self.assertEqual(
pr.updated_at, datetime(2011, 1, 26, 19, 1, 12, tzinfo=timezone.utc)
)
self.assertEqual(
pr.closed_at, datetime(2011, 1, 26, 19, 1, 12, tzinfo=timezone.utc)
)
self.assertEqual(
pr.merged_at, datetime(2011, 1, 26, 19, 1, 12, tzinfo=timezone.utc)
)
self.assertEqual(
pr.merge_commit_sha, "e5bd3914e2e596debea16f433f57875b5b90bcd6"
)
self.assertEqual(pr.author_association, AuthorAssociation.OWNER)
self.assertEqual(pr.auto_merge, None)
self.assertEqual(pr.draft, False)
self.assertEqual(pr.merged, False)
self.assertEqual(pr.mergeable, True)
self.assertEqual(pr.rebaseable, True)
self.assertEqual(pr.mergeable_state, "clean")
self.assertEqual(pr.comments, 10)
self.assertEqual(pr.review_comments, 0)
self.assertTrue(pr.maintainer_can_modify)
self.assertEqual(pr.commits, 3)
self.assertEqual(pr.additions, 100)
self.assertEqual(pr.deletions, 3)
self.assertEqual(pr.changed_files, 5)
user = pr.user
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertFalse(user.site_admin)
self.assertEqual(len(pr.labels), 1)
label = pr.labels[0]
self.assertEqual(label.id, 208045946)
self.assertEqual(label.node_id, "MDU6TGFiZWwyMDgwNDU5NDY=")
self.assertEqual(
label.url,
"https://api.github.com/repos/octocat/Hello-World/labels/bug",
)
self.assertEqual(label.name, "bug")
self.assertEqual(label.description, "Something isn't working")
self.assertEqual(label.color, "f29513")
self.assertTrue(label.default)
milestone = pr.milestone
self.assertEqual(
milestone.url,
"https://api.github.com/repos/octocat/Hello-World/milestones/1",
)
self.assertEqual(
milestone.html_url,
"https://github.com/octocat/Hello-World/milestones/v1.0",
)
self.assertEqual(
milestone.labels_url,
"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
)
self.assertEqual(milestone.id, 1002604)
self.assertEqual(milestone.node_id, "MDk6TWlsZXN0b25lMTAwMjYwNA==")
self.assertEqual(milestone.number, 1)
self.assertEqual(milestone.state, MilestoneState.OPEN)
self.assertEqual(milestone.title, "v1.0")
self.assertEqual(
milestone.description, "Tracking milestone for version 1.0"
)
self.assertEqual(milestone.open_issues, 4)
self.assertEqual(milestone.closed_issues, 8)
self.assertEqual(
milestone.created_at,
datetime(2011, 4, 10, 20, 9, 31, tzinfo=timezone.utc),
)
self.assertEqual(
milestone.updated_at,
datetime(2014, 3, 3, 18, 58, 10, tzinfo=timezone.utc),
)
self.assertEqual(
milestone.closed_at,
datetime(2013, 2, 12, 13, 22, 1, tzinfo=timezone.utc),
)
self.assertEqual(
milestone.due_on,
datetime(2012, 10, 9, 23, 39, 1, tzinfo=timezone.utc),
)
creator = milestone.creator
self.assertEqual(creator.login, "octocat")
self.assertEqual(creator.id, 1)
self.assertEqual(creator.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
creator.avatar_url,
"https://github.com/images/error/octocat_happy.gif",
)
self.assertEqual(creator.gravatar_id, "")
self.assertEqual(creator.url, "https://api.github.com/users/octocat")
self.assertEqual(creator.html_url, "https://github.com/octocat")
self.assertEqual(
creator.followers_url,
"https://api.github.com/users/octocat/followers",
)
self.assertEqual(
creator.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
creator.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
creator.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
creator.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
creator.organizations_url,
"https://api.github.com/users/octocat/orgs",
)
self.assertEqual(
creator.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
creator.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
creator.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(creator.type, "User")
self.assertEqual(creator.site_admin, False)
user = pr.assignee
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertFalse(user.site_admin)
self.assertEqual(len(pr.assignees), 2)
user = pr.assignees[0]
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertFalse(user.site_admin)
user = pr.assignees[1]
self.assertEqual(user.login, "hubot")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/hubot_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/hubot")
self.assertEqual(user.html_url, "https://github.com/hubot")
self.assertEqual(
user.followers_url, "https://api.github.com/users/hubot/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/hubot/following{/other_user}",
)
self.assertEqual(
user.gists_url, "https://api.github.com/users/hubot/gists{/gist_id}"
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/hubot/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/hubot/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/hubot/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/hubot/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/hubot/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/hubot/received_events",
)
self.assertEqual(user.type, "User")
self.assertTrue(user.site_admin)
self.assertEqual(len(pr.requested_reviewers), 1)
reviewer = pr.requested_reviewers[0]
self.assertEqual(reviewer.login, "other_user")
self.assertEqual(reviewer.id, 1)
self.assertEqual(reviewer.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
reviewer.avatar_url,
"https://github.com/images/error/other_user_happy.gif",
)
self.assertEqual(reviewer.gravatar_id, "")
self.assertEqual(
reviewer.url, "https://api.github.com/users/other_user"
)
self.assertEqual(reviewer.html_url, "https://github.com/other_user")
self.assertEqual(
reviewer.followers_url,
"https://api.github.com/users/other_user/followers",
)
self.assertEqual(
reviewer.following_url,
"https://api.github.com/users/other_user/following{/other_user}",
)
self.assertEqual(
reviewer.gists_url,
"https://api.github.com/users/other_user/gists{/gist_id}",
)
self.assertEqual(
reviewer.starred_url,
"https://api.github.com/users/other_user/starred{/owner}{/repo}",
)
self.assertEqual(
reviewer.subscriptions_url,
"https://api.github.com/users/other_user/subscriptions",
)
self.assertEqual(
reviewer.organizations_url,
"https://api.github.com/users/other_user/orgs",
)
self.assertEqual(
reviewer.repos_url, "https://api.github.com/users/other_user/repos"
)
self.assertEqual(
reviewer.events_url,
"https://api.github.com/users/other_user/events{/privacy}",
)
self.assertEqual(
reviewer.received_events_url,
"https://api.github.com/users/other_user/received_events",
)
self.assertEqual(reviewer.type, "User")
self.assertEqual(reviewer.site_admin, False)
self.assertEqual(len(pr.requested_teams), 1)
team = pr.requested_teams[0]
self.assertEqual(team.id, 1)
self.assertEqual(team.node_id, "MDQ6VGVhbTE=")
self.assertEqual(team.url, "https://api.github.com/teams/1")
self.assertEqual(
team.html_url, "https://github.com/orgs/github/teams/justice-league"
)
self.assertEqual(team.name, "Justice League")
self.assertEqual(team.slug, "justice-league")
self.assertEqual(team.description, "A great team.")
self.assertEqual(team.privacy, TeamPrivacy.CLOSED)
self.assertEqual(team.permission, Permission.ADMIN)
self.assertEqual(
team.members_url, "https://api.github.com/teams/1/members{/member}"
)
self.assertEqual(
team.repositories_url, "https://api.github.com/teams/1/repos"
)
head = pr.head
self.assertEqual(head.label, "octocat:new-topic")
self.assertEqual(head.ref, "new-topic")
self.assertEqual(head.sha, "6dcb09b5b57875f334f61aebed695e2e4193db5e")
user = head.user
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertFalse(user.site_admin)
repo = head.repo
self.assertEqual(repo.id, 1296269)
self.assertEqual(repo.node_id, "MDEwOlJlcG9zaXRvcnkxMjk2MjY5")
self.assertEqual(repo.name, "Hello-World")
self.assertEqual(repo.full_name, "octocat/Hello-World")
self.assertFalse(repo.private)
self.assertEqual(
repo.html_url, "https://github.com/octocat/Hello-World"
)
self.assertEqual(repo.description, "This your first repo!")
self.assertEqual(repo.fork, False)
self.assertEqual(
repo.url, "https://api.github.com/repos/octocat/Hello-World"
)
self.assertEqual(
repo.archive_url,
"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
)
self.assertEqual(
repo.assignees_url,
"https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
)
self.assertEqual(
repo.blobs_url,
"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
)
self.assertEqual(
repo.branches_url,
"https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
)
self.assertEqual(
repo.collaborators_url,
"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
)
self.assertEqual(
repo.comments_url,
"https://api.github.com/repos/octocat/Hello-World/comments{/number}",
)
self.assertEqual(
repo.commits_url,
"https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
)
self.assertEqual(
repo.compare_url,
"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
)
self.assertEqual(
repo.contents_url,
"https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
)
self.assertEqual(
repo.contributors_url,
"https://api.github.com/repos/octocat/Hello-World/contributors",
)
self.assertEqual(
repo.deployments_url,
"https://api.github.com/repos/octocat/Hello-World/deployments",
)
self.assertEqual(
repo.downloads_url,
"https://api.github.com/repos/octocat/Hello-World/downloads",
)
self.assertEqual(
repo.events_url,
"https://api.github.com/repos/octocat/Hello-World/events",
)
self.assertEqual(
repo.forks_url,
"https://api.github.com/repos/octocat/Hello-World/forks",
)
self.assertEqual(
repo.git_commits_url,
"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
)
self.assertEqual(
repo.git_refs_url,
"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
)
self.assertEqual(
repo.git_tags_url,
"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
)
self.assertEqual(repo.git_url, "git:github.com/octocat/Hello-World.git")
self.assertEqual(
repo.issue_comment_url,
"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
)
self.assertEqual(
repo.issue_events_url,
"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
)
self.assertEqual(
repo.issues_url,
"https://api.github.com/repos/octocat/Hello-World/issues{/number}",
)
self.assertEqual(
repo.keys_url,
"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
)
self.assertEqual(
repo.labels_url,
"https://api.github.com/repos/octocat/Hello-World/labels{/name}",
)
self.assertEqual(
repo.languages_url,
"https://api.github.com/repos/octocat/Hello-World/languages",
)
self.assertEqual(
repo.merges_url,
"https://api.github.com/repos/octocat/Hello-World/merges",
)
self.assertEqual(
repo.milestones_url,
"https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
)
self.assertEqual(
repo.notifications_url,
"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
)
self.assertEqual(
repo.pulls_url,
"https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
)
self.assertEqual(
repo.releases_url,
"https://api.github.com/repos/octocat/Hello-World/releases{/id}",
)
self.assertEqual(repo.ssh_url, "git@github.com:octocat/Hello-World.git")
self.assertEqual(
repo.stargazers_url,
"https://api.github.com/repos/octocat/Hello-World/stargazers",
)
self.assertEqual(
repo.statuses_url,
"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
)
self.assertEqual(
repo.subscribers_url,
"https://api.github.com/repos/octocat/Hello-World/subscribers",
)
self.assertEqual(
repo.subscription_url,
"https://api.github.com/repos/octocat/Hello-World/subscription",
)
self.assertEqual(
repo.tags_url,
"https://api.github.com/repos/octocat/Hello-World/tags",
)
self.assertEqual(
repo.teams_url,
"https://api.github.com/repos/octocat/Hello-World/teams",
)
self.assertEqual(
repo.trees_url,
"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
)
self.assertEqual(
repo.clone_url, "https://github.com/octocat/Hello-World.git"
)
self.assertEqual(
repo.mirror_url, "git:git.example.com/octocat/Hello-World"
)
self.assertEqual(
repo.hooks_url,
"https://api.github.com/repos/octocat/Hello-World/hooks",
)
self.assertEqual(
repo.svn_url, "https://svn.github.com/octocat/Hello-World"
)
self.assertEqual(repo.homepage, "https://github.com")
self.assertIsNone(repo.language)
self.assertEqual(repo.forks_count, 9)
self.assertEqual(repo.stargazers_count, 80)
self.assertEqual(repo.watchers_count, 80)
self.assertEqual(repo.size, 108)
self.assertEqual(repo.default_branch, "master")
self.assertEqual(repo.open_issues_count, 0)
self.assertEqual(repo.topics, ["octocat", "atom", "electron", "api"])
self.assertTrue(repo.has_issues)
self.assertTrue(repo.has_projects)
self.assertTrue(repo.has_wiki)
self.assertFalse(repo.has_pages)
self.assertTrue(repo.has_downloads)
self.assertFalse(repo.has_discussions)
self.assertFalse(repo.archived)
self.assertFalse(repo.disabled)
self.assertEqual(
repo.pushed_at,
datetime(2011, 1, 26, 19, 6, 43, tzinfo=timezone.utc),
)
self.assertEqual(
repo.created_at,
datetime(2011, 1, 26, 19, 1, 12, tzinfo=timezone.utc),
)
self.assertEqual(
repo.updated_at,
datetime(2011, 1, 26, 19, 14, 43, tzinfo=timezone.utc),
)
self.assertTrue(repo.allow_rebase_merge)
self.assertTrue(repo.allow_squash_merge)
self.assertTrue(repo.allow_merge_commit)
self.assertTrue(repo.allow_forking)
self.assertEqual(repo.forks, 123)
self.assertEqual(repo.open_issues, 123)
self.assertEqual(repo.watchers, 123)
user = repo.owner
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertFalse(user.site_admin)
license = repo.license # pylint: disable=redefined-builtin
self.assertEqual(license.key, "mit")
self.assertEqual(license.name, "MIT License")
self.assertEqual(license.url, "https://api.github.com/licenses/mit")
self.assertEqual(license.spdx_id, "MIT")
self.assertEqual(license.node_id, "MDc6TGljZW5zZW1pdA==")
self.assertFalse(repo.permissions.admin)
self.assertFalse(repo.permissions.push)
self.assertTrue(repo.permissions.pull)
base = pr.base
self.assertEqual(base.label, "octocat:master")
self.assertEqual(base.ref, "master")
self.assertEqual(base.sha, "6dcb09b5b57875f334f61aebed695e2e4193db5e")
user = base.user
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertFalse(user.site_admin)
repo = base.repo
self.assertEqual(repo.id, 1296269)
self.assertEqual(repo.node_id, "MDEwOlJlcG9zaXRvcnkxMjk2MjY5")
self.assertEqual(repo.name, "Hello-World")
self.assertEqual(repo.full_name, "octocat/Hello-World")
self.assertFalse(repo.private)
self.assertEqual(
repo.html_url, "https://github.com/octocat/Hello-World"
)
self.assertEqual(repo.description, "This your first repo!")
self.assertEqual(repo.fork, False)
self.assertEqual(
repo.url, "https://api.github.com/repos/octocat/Hello-World"
)
self.assertEqual(
repo.archive_url,
"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
)
self.assertEqual(
repo.assignees_url,
"https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
)
self.assertEqual(
repo.blobs_url,
"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
)
self.assertEqual(
repo.branches_url,
"https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
)
self.assertEqual(
repo.collaborators_url,
"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
)
self.assertEqual(
repo.comments_url,
"https://api.github.com/repos/octocat/Hello-World/comments{/number}",
)
self.assertEqual(
repo.commits_url,
"https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
)
self.assertEqual(
repo.compare_url,
"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
)
self.assertEqual(
repo.contents_url,
"https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
)
self.assertEqual(
repo.contributors_url,
"https://api.github.com/repos/octocat/Hello-World/contributors",
)
self.assertEqual(
repo.deployments_url,
"https://api.github.com/repos/octocat/Hello-World/deployments",
)
self.assertEqual(
repo.downloads_url,
"https://api.github.com/repos/octocat/Hello-World/downloads",
)
self.assertEqual(
repo.events_url,
"https://api.github.com/repos/octocat/Hello-World/events",
)
self.assertEqual(
repo.forks_url,
"https://api.github.com/repos/octocat/Hello-World/forks",
)
self.assertEqual(
repo.git_commits_url,
"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
)
self.assertEqual(
repo.git_refs_url,
"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
)
self.assertEqual(
repo.git_tags_url,
"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
)
self.assertEqual(repo.git_url, "git:github.com/octocat/Hello-World.git")
self.assertEqual(
repo.issue_comment_url,
"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
)
self.assertEqual(
repo.issue_events_url,
"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
)
self.assertEqual(
repo.issues_url,
"https://api.github.com/repos/octocat/Hello-World/issues{/number}",
)
self.assertEqual(
repo.keys_url,
"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
)
self.assertEqual(
repo.labels_url,
"https://api.github.com/repos/octocat/Hello-World/labels{/name}",
)
self.assertEqual(
repo.languages_url,
"https://api.github.com/repos/octocat/Hello-World/languages",
)
self.assertEqual(
repo.merges_url,
"https://api.github.com/repos/octocat/Hello-World/merges",
)
self.assertEqual(
repo.milestones_url,
"https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
)
self.assertEqual(
repo.notifications_url,
"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
)
self.assertEqual(
repo.pulls_url,
"https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
)
self.assertEqual(
repo.releases_url,
"https://api.github.com/repos/octocat/Hello-World/releases{/id}",
)
self.assertEqual(repo.ssh_url, "git@github.com:octocat/Hello-World.git")
self.assertEqual(
repo.stargazers_url,
"https://api.github.com/repos/octocat/Hello-World/stargazers",
)
self.assertEqual(
repo.statuses_url,
"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
)
self.assertEqual(
repo.subscribers_url,
"https://api.github.com/repos/octocat/Hello-World/subscribers",
)
self.assertEqual(
repo.subscription_url,
"https://api.github.com/repos/octocat/Hello-World/subscription",
)
self.assertEqual(
repo.tags_url,
"https://api.github.com/repos/octocat/Hello-World/tags",
)
self.assertEqual(
repo.teams_url,
"https://api.github.com/repos/octocat/Hello-World/teams",
)
self.assertEqual(
repo.trees_url,
"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
)
self.assertEqual(
repo.clone_url, "https://github.com/octocat/Hello-World.git"
)
self.assertEqual(
repo.mirror_url, "git:git.example.com/octocat/Hello-World"
)
self.assertEqual(
repo.hooks_url,
"https://api.github.com/repos/octocat/Hello-World/hooks",
)
self.assertEqual(
repo.svn_url, "https://svn.github.com/octocat/Hello-World"
)
self.assertEqual(repo.homepage, "https://github.com")
self.assertIsNone(repo.language)
self.assertEqual(repo.forks_count, 9)
self.assertEqual(repo.stargazers_count, 80)
self.assertEqual(repo.watchers_count, 80)
self.assertEqual(repo.size, 108)
self.assertEqual(repo.default_branch, "master")
self.assertEqual(repo.open_issues_count, 0)
self.assertEqual(repo.topics, ["octocat", "atom", "electron", "api"])
self.assertTrue(repo.has_issues)
self.assertTrue(repo.has_projects)
self.assertTrue(repo.has_wiki)
self.assertFalse(repo.has_pages)
self.assertTrue(repo.has_downloads)
self.assertFalse(repo.has_discussions)
self.assertFalse(repo.archived)
self.assertFalse(repo.disabled)
self.assertEqual(
repo.pushed_at,
datetime(2011, 1, 26, 19, 6, 43, tzinfo=timezone.utc),
)
self.assertEqual(
repo.created_at,
datetime(2011, 1, 26, 19, 1, 12, tzinfo=timezone.utc),
)
self.assertEqual(
repo.updated_at,
datetime(2011, 1, 26, 19, 14, 43, tzinfo=timezone.utc),
)
self.assertTrue(repo.allow_rebase_merge)
self.assertTrue(repo.allow_squash_merge)
self.assertTrue(repo.allow_merge_commit)
self.assertTrue(repo.allow_forking)
self.assertEqual(repo.forks, 123)
self.assertEqual(repo.open_issues, 123)
self.assertEqual(repo.watchers, 123)
user = pr.merged_by
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertFalse(user.site_admin)
class CommentTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"id": 1,
"node_id": "MDEyOklzc3VlQ29tbWVudDE=",
"url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
"html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1",
"body": "Me too",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"created_at": "2011-04-14T16:00:49Z",
"updated_at": "2011-04-14T16:00:49Z",
"issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
"author_association": "COLLABORATOR",
}
comment = Comment.from_dict(data)
self.assertEqual(comment.id, 1)
self.assertEqual(comment.node_id, "MDEyOklzc3VlQ29tbWVudDE=")
self.assertEqual(
comment.url,
"https://api.github.com/repos/octocat/Hello-World/issues/comments/1",
)
self.assertEqual(
comment.html_url,
"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1",
)
self.assertEqual(comment.body, "Me too")
user = comment.user
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertFalse(user.site_admin)
self.assertEqual(
comment.issue_url,
"https://api.github.com/repos/octocat/Hello-World/issues/1347",
)
self.assertEqual(
comment.author_association, AuthorAssociation.COLLABORATOR
)
pontos-25.3.2/tests/github/models/test_release.py 0000664 0000000 0000000 00000026263 14762555663 0022121 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
import unittest
from datetime import datetime, timezone
from pontos.github.models.release import Release, ReleaseAssetState
class ReleaseTestCase(unittest.TestCase):
def test_from_dict(self):
release = Release.from_dict(
{
"url": "https://api.github.com/repos/octocat/Hello-World/releases/1",
"html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",
"assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
"upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
"tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
"zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
"discussion_url": "https://github.com/octocat/Hello-World/discussions/90",
"id": 1,
"node_id": "MDc6UmVsZWFzZTE=",
"tag_name": "v1.0.0",
"target_commitish": "master",
"name": "v1.0.0",
"body": "Description of the release",
"draft": False,
"prerelease": False,
"created_at": "2013-02-27T19:35:32Z",
"published_at": "2013-02-27T19:35:32Z",
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"assets": [
{
"url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
"browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
"id": 1,
"node_id": "MDEyOlJlbGVhc2VBc3NldDE=",
"name": "example.zip",
"label": "short description",
"state": "uploaded",
"content_type": "application/zip",
"size": 1024,
"download_count": 42,
"created_at": "2013-02-27T19:35:32Z",
"updated_at": "2013-02-27T19:35:32Z",
"uploader": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
}
],
}
)
self.assertEqual(
release.url,
"https://api.github.com/repos/octocat/Hello-World/releases/1",
)
self.assertEqual(
release.html_url,
"https://github.com/octocat/Hello-World/releases/v1.0.0",
)
self.assertEqual(
release.assets_url,
"https://api.github.com/repos/octocat/Hello-World/releases/1/assets",
)
self.assertEqual(
release.upload_url,
"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",
)
self.assertEqual(
release.tarball_url,
"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",
)
self.assertEqual(
release.zipball_url,
"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",
)
self.assertEqual(
release.discussion_url,
"https://github.com/octocat/Hello-World/discussions/90",
)
self.assertEqual(release.id, 1)
self.assertEqual(release.node_id, "MDc6UmVsZWFzZTE=")
self.assertEqual(release.tag_name, "v1.0.0")
self.assertEqual(release.target_commitish, "master")
self.assertEqual(release.name, "v1.0.0")
self.assertEqual(release.body, "Description of the release")
self.assertFalse(release.draft)
self.assertFalse(release.prerelease)
self.assertEqual(
release.created_at,
datetime(2013, 2, 27, 19, 35, 32, tzinfo=timezone.utc),
)
self.assertEqual(
release.published_at,
datetime(2013, 2, 27, 19, 35, 32, tzinfo=timezone.utc),
)
user = release.author
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
self.assertEqual(len(release.assets), 1)
asset = release.assets[0]
self.assertEqual(
asset.url,
"https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
)
self.assertEqual(
asset.browser_download_url,
"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
)
self.assertEqual(asset.id, 1)
self.assertEqual(asset.node_id, "MDEyOlJlbGVhc2VBc3NldDE=")
self.assertEqual(asset.name, "example.zip")
self.assertEqual(asset.label, "short description")
self.assertEqual(asset.state, ReleaseAssetState.UPLOADED)
self.assertEqual(asset.content_type, "application/zip")
self.assertEqual(asset.size, 1024)
self.assertEqual(asset.download_count, 42)
self.assertEqual(
asset.created_at,
datetime(2013, 2, 27, 19, 35, 32, tzinfo=timezone.utc),
)
self.assertEqual(
asset.updated_at,
datetime(2013, 2, 27, 19, 35, 32, tzinfo=timezone.utc),
)
user = asset.uploader
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
pontos-25.3.2/tests/github/models/test_search.py 0000664 0000000 0000000 00000003075 14762555663 0021742 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long, invalid-name
import unittest
from pontos.github.models.search import (
InDescriptionQualifier,
InNameQualifier,
InReadmeQualifier,
InTopicsQualifier,
IsPrivateQualifier,
IsPublicQualifier,
NotQualifier,
OrganizationQualifier,
RepositoryQualifier,
UserQualifier,
)
class QualifierTestCase(unittest.TestCase):
def test_name(self):
q = InNameQualifier()
self.assertEqual(str(q), "in:name")
def test_description(self):
q = InDescriptionQualifier()
self.assertEqual(str(q), "in:description")
def test_topics(self):
q = InTopicsQualifier()
self.assertEqual(str(q), "in:topics")
def test_readme(self):
q = InReadmeQualifier()
self.assertEqual(str(q), "in:readme")
def test_not(self):
q = NotQualifier(InNameQualifier())
self.assertEqual(str(q), "-in:name")
def test_repository(self):
q = RepositoryQualifier("foo/bar")
self.assertEqual(str(q), "repo:foo/bar")
def test_organization(self):
q = OrganizationQualifier("foo")
self.assertEqual(str(q), "org:foo")
def test_user(self):
q = UserQualifier("foo")
self.assertEqual(str(q), "user:foo")
def test_is_public(self):
q = IsPublicQualifier()
self.assertEqual(str(q), "is:public")
def test_is_private(self):
q = IsPrivateQualifier()
self.assertEqual(str(q), "is:private")
pontos-25.3.2/tests/github/models/test_secret_scanning.py 0000664 0000000 0000000 00000023137 14762555663 0023643 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
import unittest
from datetime import datetime, timezone
from pontos.github.models.secret_scanning import (
AlertState,
Resolution,
SecretScanningAlert,
)
ALERT = {
"number": 2,
"created_at": "2020-11-06T18:48:51Z",
"url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2",
"html_url": "https://github.com/owner/private-repo/security/secret-scanning/2",
"locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations",
"state": "resolved",
"resolution": "false_positive",
"resolved_at": "2020-11-07T02:47:13Z",
"resolved_by": {
"login": "monalisa",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://alambic.github.com/avatars/u/2?",
"gravatar_id": "",
"url": "https://api.github.com/users/monalisa",
"html_url": "https://github.com/monalisa",
"followers_url": "https://api.github.com/users/monalisa/followers",
"following_url": "https://api.github.com/users/monalisa/following{/other_user}",
"gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
"starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
"organizations_url": "https://api.github.com/users/monalisa/orgs",
"repos_url": "https://api.github.com/users/monalisa/repos",
"events_url": "https://api.github.com/users/monalisa/events{/privacy}",
"received_events_url": "https://api.github.com/users/monalisa/received_events",
"type": "User",
"site_admin": True,
},
"secret_type": "adafruit_io_key",
"secret_type_display_name": "Adafruit IO Key",
"secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
},
"push_protection_bypassed_by": {
"login": "monalisa",
"id": 2,
"node_id": "MDQ6VXNlcjI=",
"avatar_url": "https://alambic.github.com/avatars/u/2?",
"gravatar_id": "",
"url": "https://api.github.com/users/monalisa",
"html_url": "https://github.com/monalisa",
"followers_url": "https://api.github.com/users/monalisa/followers",
"following_url": "https://api.github.com/users/monalisa/following{/other_user}",
"gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
"starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
"organizations_url": "https://api.github.com/users/monalisa/orgs",
"repos_url": "https://api.github.com/users/monalisa/repos",
"events_url": "https://api.github.com/users/monalisa/events{/privacy}",
"received_events_url": "https://api.github.com/users/monalisa/received_events",
"type": "User",
"site_admin": True,
},
"push_protection_bypassed": True,
"push_protection_bypassed_at": "2020-11-06T21:48:51Z",
"resolution_comment": "Example comment",
}
class SecretScanningAlertTestCase(unittest.TestCase):
def test_from_dict(self):
alert = SecretScanningAlert.from_dict(ALERT)
self.assertEqual(alert.number, 2)
self.assertEqual(
alert.url,
"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2",
)
self.assertEqual(
alert.html_url,
"https://github.com/owner/private-repo/security/secret-scanning/2",
)
self.assertEqual(
alert.locations_url,
"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations",
)
self.assertEqual(alert.state, AlertState.RESOLVED)
self.assertEqual(alert.secret_type, "adafruit_io_key")
self.assertEqual(alert.secret_type_display_name, "Adafruit IO Key")
self.assertEqual(alert.secret, "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX")
self.assertEqual(alert.repository.id, 1296269)
self.assertEqual(
alert.created_at,
datetime(2020, 11, 6, 18, 48, 51, tzinfo=timezone.utc),
)
self.assertIsNone(alert.updated_at)
self.assertEqual(alert.resolution, Resolution.FALSE_POSITIVE)
self.assertEqual(alert.resolution_comment, "Example comment")
self.assertEqual(
alert.resolved_at,
datetime(2020, 11, 7, 2, 47, 13, tzinfo=timezone.utc),
)
self.assertEqual(alert.resolved_by.login, "monalisa")
self.assertTrue(alert.push_protection_bypassed)
self.assertEqual(alert.push_protection_bypassed_by.login, "monalisa")
self.assertEqual(
alert.push_protection_bypassed_at,
datetime(2020, 11, 6, 21, 48, 51, tzinfo=timezone.utc),
)
pontos-25.3.2/tests/github/models/test_tag.py 0000664 0000000 0000000 00000005360 14762555663 0021247 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
# ruff: noqa: E501
import unittest
from datetime import datetime, timezone
from pontos.github.models.tag import GitObjectType, Tag, VerificationReason
class TagModelTestCase(unittest.TestCase):
def test_from_dict(self):
data = {
"node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==",
"tag": "v0.0.1",
"sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac",
"url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
"message": "initial version",
"tagger": {
"name": "Monalisa Octocat",
"email": "octocat@github.com",
"date": "2014-11-07T22:01:45Z",
},
"object": {
"type": "commit",
"sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
"url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
},
"verification": {
"verified": False,
"reason": "unsigned",
"signature": None,
"payload": None,
},
}
tag = Tag.from_dict(data)
self.assertEqual(
tag.node_id,
"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==",
)
self.assertEqual(tag.tag, "v0.0.1")
self.assertEqual(tag.sha, "940bd336248efae0f9ee5bc7b2d5c985887b16ac")
self.assertEqual(
tag.url,
"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac",
)
self.assertEqual(tag.message, "initial version")
tagger = tag.tagger
self.assertEqual(tagger.name, "Monalisa Octocat")
self.assertEqual(tagger.email, "octocat@github.com")
self.assertEqual(
tagger.date, datetime(2014, 11, 7, 22, 1, 45, tzinfo=timezone.utc)
)
tag_object = tag.object
self.assertEqual(tag_object.type, GitObjectType.COMMIT)
self.assertEqual(
tag_object.sha, "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c"
)
self.assertEqual(
tag_object.url,
"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
)
verification = tag.verification
self.assertFalse(verification.verified)
self.assertEqual(verification.reason, VerificationReason.UNSIGNED)
self.assertIsNone(verification.payload)
self.assertIsNone(verification.signature)
pontos-25.3.2/tests/github/models/test_user.py 0000664 0000000 0000000 00000003752 14762555663 0021455 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# ruff: noqa:E501
import unittest
from datetime import datetime, timezone
from pontos.github.models.user import (
EmailInformation,
SSHPublicKey,
SSHPublicKeyExtended,
)
class SSHPublicKeyTestCase(unittest.TestCase):
def test_from_dict(self):
key = SSHPublicKey.from_dict({"id": 1, "key": "ssh-rsa AAA..."})
self.assertEqual(key.id, 1)
self.assertEqual(key.key, "ssh-rsa AAA...")
class SSHPublicKeyExtendedTestCase(unittest.TestCase):
def test_from_dict(self):
key = SSHPublicKeyExtended.from_dict(
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z",
"verified": False,
"read_only": False,
}
)
self.assertEqual(key.id, 2)
self.assertEqual(
key.key, "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
)
self.assertEqual(key.url, "https://api.github.com/user/keys/2")
self.assertEqual(key.title, "ssh-rsa AAAAB3NzaC1yc2EAAA")
self.assertFalse(key.verified)
self.assertFalse(key.read_only)
self.assertEqual(
key.created_at,
datetime(2020, 6, 11, 21, 31, 57, tzinfo=timezone.utc),
)
class EmailInformationTestCase(unittest.TestCase):
def test_from_dict(self):
email = EmailInformation.from_dict(
{
"email": "octocat@github.com",
"verified": True,
"primary": True,
"visibility": "public",
}
)
self.assertEqual(email.email, "octocat@github.com")
self.assertEqual(email.visibility, "public")
self.assertTrue(email.primary)
self.assertTrue(email.verified)
pontos-25.3.2/tests/github/models/test_workflow.py 0000664 0000000 0000000 00000117614 14762555663 0022354 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
import unittest
from datetime import datetime, timedelta, timezone
from pontos.github.models.base import Event
from pontos.github.models.workflow import (
Workflow,
WorkflowRun,
WorkflowRunStatus,
WorkflowState,
)
class WorkflowTestCase(unittest.TestCase):
def test_from_dict(self):
workflow = Workflow.from_dict(
{
"id": 1,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "CI",
"path": ".github/workflows/blank.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg",
}
)
self.assertEqual(workflow.id, 1)
self.assertEqual(workflow.node_id, "MDg6V29ya2Zsb3cxNjEzMzU=")
self.assertEqual(workflow.name, "CI")
self.assertEqual(workflow.path, ".github/workflows/blank.yaml")
self.assertEqual(workflow.state, WorkflowState.ACTIVE)
self.assertEqual(
workflow.created_at,
datetime(
2020, 1, 8, 23, 48, 37, tzinfo=timezone(timedelta(hours=-8))
),
)
self.assertEqual(
workflow.updated_at,
datetime(
2020, 1, 8, 23, 50, 21, tzinfo=timezone(timedelta(hours=-8))
),
)
self.assertEqual(
workflow.url,
"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
)
self.assertEqual(
workflow.html_url,
"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
)
self.assertEqual(
workflow.badge_url,
"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg",
)
class WorkflowRunTestCase(unittest.TestCase):
def test_from_dict(self):
run = WorkflowRun.from_dict(
{
"id": 1,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": None,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com",
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com",
},
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"private": False,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": False,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": True,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": False,
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": None,
"fork": False,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
},
}
)
self.assertEqual(run.id, 1)
self.assertEqual(run.name, "Build")
self.assertEqual(run.node_id, "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==")
self.assertEqual(run.check_suite_id, 42)
self.assertEqual(run.check_suite_node_id, "MDEwOkNoZWNrU3VpdGU0Mg==")
self.assertEqual(run.head_branch, "master")
self.assertEqual(
run.head_sha, "acb5820ced9479c074f688cc328bf03f341a511d"
)
self.assertEqual(run.run_number, 562)
self.assertEqual(run.event, Event.PUSH)
self.assertEqual(run.status, WorkflowRunStatus.QUEUED)
self.assertEqual(run.conclusion, None)
self.assertEqual(run.workflow_id, 159038)
self.assertEqual(
run.url,
"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
)
self.assertEqual(
run.html_url,
"https://github.com/octo-org/octo-repo/actions/runs/30433642",
)
self.assertEqual(run.pull_requests, [])
self.assertEqual(
run.created_at,
datetime(2020, 1, 22, 19, 33, 8, tzinfo=timezone.utc),
)
self.assertEqual(
run.updated_at,
datetime(2020, 1, 22, 19, 33, 8, tzinfo=timezone.utc),
)
self.assertEqual(run.run_attempt, 1)
self.assertEqual(
run.run_started_at,
datetime(2020, 1, 22, 19, 33, 8, tzinfo=timezone.utc),
)
self.assertEqual(
run.jobs_url,
"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
)
self.assertEqual(
run.logs_url,
"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
)
self.assertEqual(
run.check_suite_url,
"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
)
self.assertEqual(
run.artifacts_url,
"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
)
self.assertEqual(
run.cancel_url,
"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
)
self.assertEqual(
run.rerun_url,
"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
)
self.assertEqual(
run.workflow_url,
"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
)
commit = run.head_commit
self.assertEqual(commit.id, "acb5820ced9479c074f688cc328bf03f341a511d")
self.assertEqual(
commit.tree_id, "d23f6eedb1e1b9610bbc754ddb5197bfe7271223"
)
self.assertEqual(commit.message, "Create linter.yaml")
self.assertEqual(
commit.timestamp,
datetime(2020, 1, 22, 19, 33, 5, tzinfo=timezone.utc),
)
self.assertEqual(commit.author.name, "Octo Cat")
self.assertEqual(commit.author.email, "octocat@github.com")
self.assertEqual(commit.committer.name, "GitHub")
self.assertEqual(commit.committer.email, "noreply@github.com")
user = run.actor
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
user = run.triggering_actor
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
repo = run.repository
self.assertEqual(repo.id, 1296269)
self.assertEqual(repo.node_id, "MDEwOlJlcG9zaXRvcnkxMjk2MjY5")
self.assertEqual(repo.name, "Hello-World")
self.assertEqual(repo.full_name, "octocat/Hello-World")
self.assertFalse(repo.private)
self.assertEqual(
repo.html_url, "https://github.com/octocat/Hello-World"
)
self.assertEqual(repo.description, "This your first repo!")
self.assertFalse(repo.fork)
self.assertEqual(
repo.url, "https://api.github.com/repos/octocat/Hello-World"
)
self.assertEqual(
repo.archive_url,
"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
)
self.assertEqual(
repo.assignees_url,
"https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
)
self.assertEqual(
repo.blobs_url,
"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
)
self.assertEqual(
repo.branches_url,
"https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
)
self.assertEqual(
repo.collaborators_url,
"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
)
self.assertEqual(
repo.comments_url,
"https://api.github.com/repos/octocat/Hello-World/comments{/number}",
)
self.assertEqual(
repo.commits_url,
"https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
)
self.assertEqual(
repo.compare_url,
"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
)
self.assertEqual(
repo.contents_url,
"https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
)
self.assertEqual(
repo.contributors_url,
"https://api.github.com/repos/octocat/Hello-World/contributors",
)
self.assertEqual(
repo.deployments_url,
"https://api.github.com/repos/octocat/Hello-World/deployments",
)
self.assertEqual(
repo.downloads_url,
"https://api.github.com/repos/octocat/Hello-World/downloads",
)
self.assertEqual(
repo.events_url,
"https://api.github.com/repos/octocat/Hello-World/events",
)
self.assertEqual(
repo.forks_url,
"https://api.github.com/repos/octocat/Hello-World/forks",
)
self.assertEqual(
repo.git_commits_url,
"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
)
self.assertEqual(
repo.git_refs_url,
"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
)
self.assertEqual(
repo.git_tags_url,
"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
)
self.assertEqual(repo.git_url, "git:github.com/octocat/Hello-World.git")
self.assertEqual(
repo.issue_comment_url,
"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
)
self.assertEqual(
repo.issue_events_url,
"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
)
self.assertEqual(
repo.issues_url,
"https://api.github.com/repos/octocat/Hello-World/issues{/number}",
)
self.assertEqual(
repo.keys_url,
"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
)
self.assertEqual(
repo.labels_url,
"https://api.github.com/repos/octocat/Hello-World/labels{/name}",
)
self.assertEqual(
repo.languages_url,
"https://api.github.com/repos/octocat/Hello-World/languages",
)
self.assertEqual(
repo.merges_url,
"https://api.github.com/repos/octocat/Hello-World/merges",
)
self.assertEqual(
repo.milestones_url,
"https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
)
self.assertEqual(
repo.notifications_url,
"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
)
self.assertEqual(
repo.pulls_url,
"https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
)
self.assertEqual(
repo.releases_url,
"https://api.github.com/repos/octocat/Hello-World/releases{/id}",
)
self.assertEqual(repo.ssh_url, "git@github.com:octocat/Hello-World.git")
self.assertEqual(
repo.stargazers_url,
"https://api.github.com/repos/octocat/Hello-World/stargazers",
)
self.assertEqual(
repo.statuses_url,
"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
)
self.assertEqual(
repo.subscribers_url,
"https://api.github.com/repos/octocat/Hello-World/subscribers",
)
self.assertEqual(
repo.subscription_url,
"https://api.github.com/repos/octocat/Hello-World/subscription",
)
self.assertEqual(
repo.tags_url,
"https://api.github.com/repos/octocat/Hello-World/tags",
)
self.assertEqual(
repo.teams_url,
"https://api.github.com/repos/octocat/Hello-World/teams",
)
self.assertEqual(
repo.trees_url,
"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
)
self.assertEqual(
repo.hooks_url,
"http://api.github.com/repos/octocat/Hello-World/hooks",
)
user = repo.owner
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
repo = run.head_repository
self.assertEqual(repo.id, 217723378)
self.assertEqual(repo.node_id, "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=")
self.assertEqual(repo.name, "octo-repo")
self.assertEqual(repo.full_name, "octo-org/octo-repo")
self.assertTrue(repo.private)
self.assertEqual(repo.html_url, "https://github.com/octo-org/octo-repo")
self.assertIsNone(repo.description)
self.assertFalse(repo.fork)
self.assertEqual(
repo.url, "https://api.github.com/repos/octo-org/octo-repo"
)
self.assertEqual(
repo.forks_url,
"https://api.github.com/repos/octo-org/octo-repo/forks",
)
self.assertEqual(
repo.keys_url,
"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
)
self.assertEqual(
repo.collaborators_url,
"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
)
self.assertEqual(
repo.teams_url,
"https://api.github.com/repos/octo-org/octo-repo/teams",
)
self.assertEqual(
repo.hooks_url,
"https://api.github.com/repos/octo-org/octo-repo/hooks",
)
self.assertEqual(
repo.issue_events_url,
"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
)
self.assertEqual(
repo.events_url,
"https://api.github.com/repos/octo-org/octo-repo/events",
)
self.assertEqual(
repo.assignees_url,
"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
)
self.assertEqual(
repo.branches_url,
"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
)
self.assertEqual(
repo.tags_url,
"https://api.github.com/repos/octo-org/octo-repo/tags",
)
self.assertEqual(
repo.blobs_url,
"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
)
self.assertEqual(
repo.git_tags_url,
"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
)
self.assertEqual(
repo.git_refs_url,
"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
)
self.assertEqual(
repo.trees_url,
"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
)
self.assertEqual(
repo.statuses_url,
"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
)
self.assertEqual(
repo.languages_url,
"https://api.github.com/repos/octo-org/octo-repo/languages",
)
self.assertEqual(
repo.stargazers_url,
"https://api.github.com/repos/octo-org/octo-repo/stargazers",
)
self.assertEqual(
repo.contributors_url,
"https://api.github.com/repos/octo-org/octo-repo/contributors",
)
self.assertEqual(
repo.subscribers_url,
"https://api.github.com/repos/octo-org/octo-repo/subscribers",
)
self.assertEqual(
repo.subscription_url,
"https://api.github.com/repos/octo-org/octo-repo/subscription",
)
self.assertEqual(
repo.commits_url,
"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
)
self.assertEqual(
repo.git_commits_url,
"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
)
self.assertEqual(
repo.comments_url,
"https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
)
self.assertEqual(
repo.issue_comment_url,
"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
)
self.assertEqual(
repo.contents_url,
"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
)
self.assertEqual(
repo.compare_url,
"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
)
self.assertEqual(
repo.merges_url,
"https://api.github.com/repos/octo-org/octo-repo/merges",
)
self.assertEqual(
repo.archive_url,
"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
)
self.assertEqual(
repo.downloads_url,
"https://api.github.com/repos/octo-org/octo-repo/downloads",
)
self.assertEqual(
repo.issues_url,
"https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
)
self.assertEqual(
repo.pulls_url,
"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
)
self.assertEqual(
repo.milestones_url,
"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
)
self.assertEqual(
repo.notifications_url,
"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
)
self.assertEqual(
repo.labels_url,
"https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
)
self.assertEqual(
repo.releases_url,
"https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
)
self.assertEqual(
repo.deployments_url,
"https://api.github.com/repos/octo-org/octo-repo/deployments",
)
user = repo.owner
self.assertEqual(user.login, "octocat")
self.assertEqual(user.id, 1)
self.assertEqual(user.node_id, "MDQ6VXNlcjE=")
self.assertEqual(
user.avatar_url, "https://github.com/images/error/octocat_happy.gif"
)
self.assertEqual(user.gravatar_id, "")
self.assertEqual(user.url, "https://api.github.com/users/octocat")
self.assertEqual(user.html_url, "https://github.com/octocat")
self.assertEqual(
user.followers_url, "https://api.github.com/users/octocat/followers"
)
self.assertEqual(
user.following_url,
"https://api.github.com/users/octocat/following{/other_user}",
)
self.assertEqual(
user.gists_url,
"https://api.github.com/users/octocat/gists{/gist_id}",
)
self.assertEqual(
user.starred_url,
"https://api.github.com/users/octocat/starred{/owner}{/repo}",
)
self.assertEqual(
user.subscriptions_url,
"https://api.github.com/users/octocat/subscriptions",
)
self.assertEqual(
user.organizations_url, "https://api.github.com/users/octocat/orgs"
)
self.assertEqual(
user.repos_url, "https://api.github.com/users/octocat/repos"
)
self.assertEqual(
user.events_url,
"https://api.github.com/users/octocat/events{/privacy}",
)
self.assertEqual(
user.received_events_url,
"https://api.github.com/users/octocat/received_events",
)
self.assertEqual(user.type, "User")
self.assertEqual(user.site_admin, False)
pontos-25.3.2/tests/github/script/ 0000775 0000000 0000000 00000000000 14762555663 0017100 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/github/script/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0021205 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/github/script/test_load.py 0000664 0000000 0000000 00000006741 14762555663 0021440 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import io
import unittest
from argparse import ArgumentParser
from contextlib import redirect_stderr
from pontos.github.script.errors import GitHubScriptError
from pontos.github.script.load import (
load_script,
run_add_arguments_function,
run_github_script_function,
)
from pontos.testing import temp_file, temp_python_module
from tests import IsolatedAsyncioTestCase
class LoadScriptTestCase(unittest.TestCase):
def test_load_script(self):
with (
temp_file("def foo():\n\treturn 1", name="foo.py") as f,
load_script(f) as module,
):
self.assertIsNotNone(module)
self.assertIsNotNone(module.foo)
self.assertEqual(module.foo(), 1)
def test_load_script_module(self):
with (
temp_python_module(
"def foo():\n\treturn 1", name="github-foo-script"
),
load_script("github-foo-script") as module,
):
self.assertIsNotNone(module)
self.assertIsNotNone(module.foo)
self.assertEqual(module.foo(), 1)
def test_load_script_failure(self):
with self.assertRaisesRegex(
ModuleNotFoundError, "No module named 'baz'"
):
with load_script("foo/bar/baz.py"):
pass
class RunAddArgumentsFunction(unittest.TestCase):
def test_add_arguments_function(self):
with (
temp_file(
"def add_script_arguments(parser):\n\t"
"parser.add_argument('--foo')",
name="foo.py",
) as f,
load_script(f) as module,
):
parser = ArgumentParser()
run_add_arguments_function(module, parser)
args = parser.parse_args(["--foo", "123"])
self.assertEqual(args.foo, "123")
def test_no_add_arguments_function(self):
with (
temp_file(
"def foo():\n\tpass",
name="foo.py",
) as f,
load_script(f) as module,
):
parser = ArgumentParser()
run_add_arguments_function(module, parser)
with self.assertRaises(SystemExit), redirect_stderr(io.StringIO()):
parser.parse_args(["--foo", "123"])
class RunGithubScriptFunctionTestCase(IsolatedAsyncioTestCase):
def test_run_async_github_script_function(self):
with (
temp_file(
"async def github_script(api, args):\n\treturn 1",
name="foo.py",
) as f,
load_script(f) as module,
):
self.assertEqual(
run_github_script_function(module, "123", 123, {}), 1
)
def test_sync_github_script_function_not_supported(self):
with (
temp_file(
"def github_script(api, args):\n\treturn 1",
name="foo.py",
) as f,
load_script(f) as module,
):
with self.assertRaises(GitHubScriptError):
run_github_script_function(module, "123", 123, {})
def test_no_github_script_function(self):
with (
temp_file(
"def foo():\n\tpass",
name="foo.py",
) as f,
load_script(f) as module,
):
with self.assertRaises(GitHubScriptError):
run_github_script_function(module, "123", 123, {})
pontos-25.3.2/tests/github/script/test_parser.py 0000664 0000000 0000000 00000002632 14762555663 0022010 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from unittest.mock import patch
from pontos.github.api.helper import DEFAULT_TIMEOUT
from pontos.github.script._parser import create_parser
class CreateParserTestCase(unittest.TestCase):
def test_create_parser(self):
parser = create_parser()
args = parser.parse_args(
["--token", "123", "--timeout", "456", "my_script"]
)
self.assertEqual(args.token, "123")
self.assertEqual(args.timeout, 456)
self.assertEqual(args.script, "my_script")
@patch.dict("os.environ", {"GITHUB_TOKEN": "987"})
def test_parse_token(self):
parser = create_parser()
args = parser.parse_args(["my_script"])
self.assertEqual(args.token, "987")
self.assertEqual(args.script, "my_script")
args = parser.parse_args(["--token", "123", "my_script"])
self.assertEqual(args.token, "123")
self.assertEqual(args.script, "my_script")
def test_parse_timeout(self):
parser = create_parser()
args = parser.parse_args(["my_script"])
self.assertEqual(args.script, "my_script")
self.assertEqual(args.timeout, DEFAULT_TIMEOUT)
args = parser.parse_args(["--timeout", "666", "my_script"])
self.assertEqual(args.timeout, 666)
self.assertEqual(args.script, "my_script")
pontos-25.3.2/tests/github/test_cmds.py 0000664 0000000 0000000 00000021376 14762555663 0020144 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=no-member
from argparse import Namespace
from pathlib import Path
from unittest.mock import MagicMock, call, patch
from pontos.github.cmds import (
create_pull_request,
create_release,
create_tag,
file_status,
labels,
repos,
update_pull_request,
)
from pontos.github.models.base import FileStatus
from pontos.github.models.organization import RepositoryType
from pontos.testing import temp_file
from tests import AsyncIteratorMock, IsolatedAsyncioTestCase
here = Path(__file__).parent
class TestCmds(IsolatedAsyncioTestCase):
@patch("pontos.github.api.api.GitHubAsyncRESTPullRequests", spec=True)
async def test_file_status(self, api_mock):
terminal = MagicMock()
api_mock.return_value.exists.return_value = True
api_mock.return_value.files.return_value = {
FileStatus.ADDED: [Path("tests/github/foo/bar")],
FileStatus.MODIFIED: [
Path("tests/github/bar/baz"),
Path("tests/github/baz/boo"),
],
}
with (
temp_file(name="some.file") as test_file,
test_file.open("w", encoding="utf8") as output,
):
args = Namespace(
repo="foo/bar",
pull_request=8,
output=output,
status=[FileStatus.ADDED, FileStatus.MODIFIED],
token="GITHUB_TOKEN",
)
await file_status(terminal, args)
api_mock.return_value.exists.assert_awaited_once_with(
repo="foo/bar", pull_request=8
)
api_mock.return_value.files.assert_awaited_once_with(
repo="foo/bar",
pull_request=8,
status_list=[FileStatus.ADDED, FileStatus.MODIFIED],
)
output.flush()
content = test_file.read_text(encoding="utf-8")
self.assertEqual(
content, f"{here}/foo/bar\n{here}/bar/baz\n{here}/baz/boo\n"
)
@patch("pontos.github.api.api.GitHubAsyncRESTReleases", spec=True)
async def test_create_release_no_tag(self, api_mock):
terminal = MagicMock()
api_mock.return_value.exists.return_value = True
args = Namespace(
repo="foo/bar",
tag="test_tag",
name="test_release",
body=None,
target_commitish=None,
draft=False,
prerelease=False,
token="GITHUB_TOKEN",
)
with self.assertRaises(SystemExit) as syse:
await create_release(terminal, args)
self.assertEqual(syse.exception.code, 1)
api_mock.return_value.exists.assert_awaited_once_with(
repo="foo/bar", tag="test_tag"
)
@patch("pontos.github.api.api.GitHubAsyncRESTReleases", spec=True)
async def test_create_release(self, api_mock):
terminal = MagicMock()
api_mock.return_value.exists.return_value = False
api_mock.return_value.create.return_value = True
args = Namespace(
repo="foo/bar",
tag="test_tag",
name="test_release",
body=None,
target_commitish=None,
draft=False,
prerelease=False,
token="GITHUB_TOKEN",
)
await create_release(terminal, args)
api_mock.return_value.exists.assert_awaited_once_with(
repo="foo/bar", tag="test_tag"
)
api_mock.return_value.create.assert_awaited_once_with(
repo="foo/bar",
tag="test_tag",
body=None,
name="test_release",
target_commitish=None,
draft=False,
prerelease=False,
)
@patch("pontos.github.api.api.GitHubAsyncRESTTags", spec=True)
async def test_create_tag(self, api_mock):
terminal = MagicMock()
api_mock.return_value.create.return_value = MagicMock(sha="123")
api_mock.return_value.create_tag_reference.return_value = True
args = Namespace(
repo="foo/bar",
tag="test_tag",
name="test_release",
message="test msg",
git_object="commit",
git_object_type=None,
email="test@test.test",
date=None,
token="GITHUB_TOKEN",
)
await create_tag(terminal, args)
api_mock.return_value.create.assert_awaited_once_with(
repo="foo/bar",
tag="test_tag",
message="test msg",
git_object="commit",
name="test_release",
email="test@test.test",
git_object_type=None,
date=None,
)
api_mock.return_value.create_tag_reference.assert_awaited_once_with(
repo="foo/bar", tag="test_tag", sha="123"
)
@patch("pontos.github.api.api.GitHubAsyncRESTBranches", spec=True)
@patch("pontos.github.api.api.GitHubAsyncRESTPullRequests", spec=True)
async def test_create_pull_request(
self,
pulls_api_mock,
branches_api_mock,
):
terminal = MagicMock()
branches_api_mock.return_value.exists.return_value = [False, False]
pulls_api_mock.return_value.create.return_value = True
args = Namespace(
repo="foo/bar",
head="some-branch",
target="main",
title="foo",
body="foo bar",
token="GITHUB_TOKEN",
)
await create_pull_request(terminal, args)
branches_api_mock.return_value.exists.assert_has_awaits(
[
call(repo="foo/bar", branch="some-branch"),
call(repo="foo/bar", branch="main"),
]
)
pulls_api_mock.return_value.create.assert_awaited_once_with(
repo="foo/bar",
head_branch="some-branch",
base_branch="main",
title="foo",
body="foo bar",
)
@patch("pontos.github.api.api.GitHubAsyncRESTBranches", spec=True)
@patch("pontos.github.api.api.GitHubAsyncRESTPullRequests", spec=True)
async def test_update_pull_request(
self,
pulls_api_mock,
branches_api_mock,
):
terminal = MagicMock()
branches_api_mock.return_value.exists.return_value = True
pulls_api_mock.return_value.create.return_value = True
args = Namespace(
repo="foo/bar",
target="main",
pull_request=9,
title="foo",
body="foo bar",
token="GITHUB_TOKEN",
)
await update_pull_request(terminal, args)
branches_api_mock.return_value.exists.assert_awaited_once_with(
repo="foo/bar", branch="main"
)
pulls_api_mock.return_value.update.assert_awaited_once_with(
repo="foo/bar",
pull_request=9,
base_branch="main",
title="foo",
body="foo bar",
)
@patch("pontos.github.api.api.GitHubAsyncRESTPullRequests", spec=True)
@patch("pontos.github.api.api.GitHubAsyncRESTLabels", spec=True)
async def test_labels(
self,
labels_api_mock,
pulls_api_mock,
):
terminal = MagicMock()
pulls_api_mock.return_value.exists.return_value = True
labels_api_mock.return_value.get_all.return_value = AsyncIteratorMock(
["foo", "bar"]
)
args = Namespace(
repo="foo/bar",
issue=9,
labels=["baz"],
token="GITHUB_TOKEN",
)
await labels(terminal, args)
pulls_api_mock.return_value.exists.assert_awaited_once_with(
repo="foo/bar", pull_request=9
)
labels_api_mock.return_value.get_all.assert_called_once_with(
repo="foo/bar",
issue=9,
)
labels_api_mock.return_value.set_all.assert_awaited_once_with(
repo="foo/bar", issue=9, labels=["foo", "bar", "baz"]
)
@patch("pontos.github.api.api.GitHubAsyncRESTOrganizations", spec=True)
async def test_repos(self, api_mock):
terminal = MagicMock()
api_mock.return_value.exists.return_value = True
api_mock.return_value.get_repositories.return_value = AsyncIteratorMock(
["repo1", "repo2"]
)
args = Namespace(
orga="foo",
repo="bar",
path=None,
type=RepositoryType.PUBLIC,
token="GITHUB_TOKEN",
)
await repos(terminal, args)
api_mock.return_value.exists.assert_awaited_once_with("foo")
api_mock.return_value.get_repositories.assert_called_once_with(
organization="foo", repository_type=RepositoryType.PUBLIC
)
pontos-25.3.2/tests/github/test_parser.py 0000664 0000000 0000000 00000013166 14762555663 0020510 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=no-member
import io
import unittest
from argparse import Namespace
from contextlib import redirect_stderr
from pathlib import Path
from unittest.mock import Mock, patch
from pontos.github._parser import parse_args
from pontos.github.cmds import (
create_pull_request,
create_release,
create_tag,
file_status,
update_pull_request,
)
from pontos.github.models.base import FileStatus
from pontos.testing import temp_directory
class TestArgparsing(unittest.TestCase):
def setUp(self):
self.term = Mock()
def test_create_pr_parse_args(self):
argv = [
"pr",
"create",
"foo/bar",
"baz",
"main",
"baz in main",
]
with patch.dict("os.environ", {}, clear=True):
parsed_args = parse_args(argv)
template = Path().cwd() / "pontos/github/pr_template.md"
self.assertEqual(parsed_args.command, "pr")
self.assertEqual(parsed_args.token, "GITHUB_TOKEN")
self.assertEqual(parsed_args.body, template.read_text(encoding="utf-8"))
self.assertEqual(parsed_args.pr_func, create_pull_request)
self.assertEqual(parsed_args.repo, "foo/bar")
self.assertEqual(parsed_args.target, "main")
self.assertEqual(parsed_args.title, "baz in main")
def test_create_pr_parse_args_fail(self):
argv = ["pr", "create", "foo/bar"]
with self.assertRaises(SystemExit), redirect_stderr(io.StringIO()):
parse_args(argv)
def test_update_pr_parse_args(self):
argv = [
"-q",
"--log-file",
"foo",
"pr",
"update",
"foo/bar",
"123",
"--body",
"foo",
"--target",
"main",
"--title",
"baz in main",
]
with patch.dict("os.environ", {}, clear=True):
parsed_args = parse_args(argv)
self.assertEqual(parsed_args.command, "pr")
self.assertEqual(parsed_args.token, "GITHUB_TOKEN")
self.assertEqual(parsed_args.body, "foo")
self.assertEqual(parsed_args.pr_func, update_pull_request)
self.assertEqual(parsed_args.repo, "foo/bar")
self.assertEqual(parsed_args.pull_request, 123)
self.assertEqual(parsed_args.target, "main")
self.assertEqual(parsed_args.title, "baz in main")
self.assertTrue(parsed_args.quiet)
self.assertEqual(parsed_args.log_file, "foo")
def test_update_pr_parse_args_fail(self):
argv = ["pr", "update", "foo/bar"]
with self.assertRaises(SystemExit), redirect_stderr(io.StringIO()):
parse_args(argv)
def test_fs_parse_args(self):
with temp_directory(change_into=True) as tmp_dir:
argv = [
"FS",
"foo/bar",
"8",
"-o",
"some.file",
]
with patch.dict("os.environ", {}, clear=True):
parsed_args = parse_args(argv)
output = open(tmp_dir / "some.file", mode="w", encoding="utf-8")
expected_args = Namespace(
command="FS",
func=file_status,
repo="foo/bar",
pull_request=8,
output=output,
status=[FileStatus.ADDED, FileStatus.MODIFIED],
token="GITHUB_TOKEN",
)
self.assertEqual(
type(parsed_args.output), type(expected_args.output)
)
self.assertEqual(parsed_args.command, expected_args.command)
self.assertEqual(parsed_args.func, expected_args.func)
self.assertEqual(parsed_args.repo, expected_args.repo)
self.assertEqual(
parsed_args.pull_request, expected_args.pull_request
)
self.assertEqual(parsed_args.status, expected_args.status)
self.assertEqual(parsed_args.token, expected_args.token)
output.close()
parsed_args.output.close()
def test_create_release_parse_args(self):
argv = [
"re",
"create",
"foo/bar",
"123",
"release_name",
"--body",
"foo",
]
with patch.dict("os.environ", {}, clear=True):
parsed_args = parse_args(argv)
self.assertEqual(parsed_args.command, "re")
self.assertEqual(parsed_args.token, "GITHUB_TOKEN")
self.assertEqual(parsed_args.re_func, create_release)
self.assertEqual(parsed_args.repo, "foo/bar")
self.assertEqual(parsed_args.tag, "123")
self.assertEqual(parsed_args.name, "release_name")
self.assertEqual(parsed_args.body, "foo")
self.assertEqual(parsed_args.target_commitish, None)
self.assertFalse(parsed_args.draft)
self.assertFalse(parsed_args.prerelease)
def test_create_tag_parse_args(self):
argv = [
"tag",
"create",
"foo/bar",
"v1",
"test user",
"",
"sha",
"test@test.test",
]
parsed_args = parse_args(argv)
self.assertEqual(parsed_args.command, "tag")
self.assertEqual(parsed_args.tag_func, create_tag)
self.assertEqual(parsed_args.repo, "foo/bar")
self.assertEqual(parsed_args.tag, "v1")
self.assertEqual(parsed_args.message, "")
self.assertEqual(parsed_args.git_object, "sha")
self.assertEqual(parsed_args.email, "test@test.test")
pontos-25.3.2/tests/models/ 0000775 0000000 0000000 00000000000 14762555663 0015575 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/models/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0017702 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/models/test_models.py 0000664 0000000 0000000 00000015023 14762555663 0020472 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=no-member, disallowed-name
import unittest
from dataclasses import dataclass, field
from datetime import date, datetime, timedelta, timezone
from typing import Dict, List, Optional, Union
from pontos.models import Model, ModelAttribute, ModelError, dotted_attributes
class DottedAttributesTestCase(unittest.TestCase):
def test_with_new_class(self):
class Foo:
pass
foo = Foo()
attrs = {"bar": 123, "hello": "World", "baz": [1, 2, 3]}
foo = dotted_attributes(foo, attrs)
self.assertEqual(foo.bar, 123)
self.assertEqual(foo.baz, [1, 2, 3])
self.assertEqual(foo.hello, "World")
def test_with_github_model_attribute(self):
foo = ModelAttribute()
attrs = {"bar": 123, "hello": "World", "baz": [1, 2, 3]}
foo = dotted_attributes(foo, attrs)
self.assertEqual(foo.bar, 123)
self.assertEqual(foo.baz, [1, 2, 3])
self.assertEqual(foo.hello, "World")
class ModelTestCase(unittest.TestCase):
def test_from_dict(self):
model = Model.from_dict(
{
"x": 1,
"y": 2,
"hello": "World",
"baz": [1, 2, 3],
"bar": {"a": "b"},
}
)
self.assertEqual(model.x, 1)
self.assertEqual(model.y, 2)
self.assertEqual(model.hello, "World")
self.assertEqual(model.baz, [1, 2, 3])
self.assertEqual(model.bar.a, "b")
def test_from_dict_failure(self):
with self.assertRaisesRegex(
ValueError, "Invalid data for creating an instance of.*"
):
Model.from_dict("foo")
class ExampleModelTestCase(unittest.TestCase):
def test_optional(self):
@dataclass
class OtherModel(Model):
something: str
@dataclass
class ExampleModel(Model):
foo: str
bar: Optional[OtherModel] = None
model = ExampleModel.from_dict({"foo": "abc"})
self.assertIsNone(model.bar)
def test_list(self):
@dataclass
class ExampleModel(Model):
foo: List[str]
model = ExampleModel.from_dict({"foo": ["a", "b", "c"]})
self.assertEqual(model.foo, ["a", "b", "c"])
def test_list_with_default(self):
@dataclass
class ExampleModel(Model):
foo: List[str] = field(default_factory=list)
model = ExampleModel.from_dict({})
self.assertEqual(model.foo, [])
def test_datetime(self):
@dataclass
class ExampleModel(Model):
foo: datetime
model = ExampleModel.from_dict({"foo": "1988-10-01T04:00:00.000"})
self.assertEqual(
model.foo, datetime(1988, 10, 1, 4, tzinfo=timezone.utc)
)
model = ExampleModel.from_dict({"foo": "1988-10-01T04:00:00Z"})
self.assertEqual(
model.foo, datetime(1988, 10, 1, 4, tzinfo=timezone.utc)
)
model = ExampleModel.from_dict({"foo": "1988-10-01T04:00:00+00:00"})
self.assertEqual(
model.foo, datetime(1988, 10, 1, 4, tzinfo=timezone.utc)
)
model = ExampleModel.from_dict({"foo": "1988-10-01T04:00:00+01:00"})
self.assertEqual(
model.foo,
datetime(1988, 10, 1, 4, tzinfo=timezone(timedelta(hours=1))),
)
model = ExampleModel.from_dict({"foo": "2021-06-06T11:15:10.213"})
self.assertEqual(
model.foo,
datetime(2021, 6, 6, 11, 15, 10, 213000, tzinfo=timezone.utc),
)
def test_date(self):
@dataclass
class ExampleModel(Model):
foo: date
model = ExampleModel.from_dict({"foo": "1988-10-01"})
self.assertEqual(model.foo, date(1988, 10, 1))
def test_union(self):
@dataclass
class ExampleModel(Model):
foo: Union[str, int]
model = ExampleModel.from_dict({"foo": "123"})
self.assertEqual(model.foo, "123")
model = ExampleModel.from_dict({"foo": 123})
self.assertEqual(model.foo, 123)
def test_other_model(self):
@dataclass
class OtherModel(Model):
bar: str
@dataclass
class ExampleModel(Model):
foo: Optional[OtherModel] = None
model = ExampleModel.from_dict({"foo": {"bar": "baz"}})
self.assertEqual(model.foo.bar, "baz")
def test_all(self):
@dataclass
class OtherModel(Model):
something: str
@dataclass
class ExampleModel(Model):
foo: str
bar: datetime
id: Union[str, int]
baz: List[str] = field(default_factory=list)
ipsum: Optional[OtherModel] = None
model = ExampleModel.from_dict(
{
"foo": "abc",
"bar": "1988-10-01T04:00:00.000",
"id": 123,
"baz": ["a", "b", "c"],
"ipsum": {"something": "def"},
}
)
self.assertEqual(model.foo, "abc")
self.assertEqual(
model.bar, datetime(1988, 10, 1, 4, tzinfo=timezone.utc)
)
self.assertEqual(model.id, 123)
self.assertEqual(model.baz, ["a", "b", "c"])
self.assertIsNotNone(model.ipsum)
self.assertEqual(model.ipsum.something, "def")
def test_list_with_dict(self):
@dataclass
class ExampleModel(Model):
foo: List[Dict]
model = ExampleModel.from_dict({"foo": [{"a": 1}, {"b": 2}, {"c": 3}]})
self.assertEqual(model.foo, [{"a": 1}, {"b": 2}, {"c": 3}])
def test_model_error(self):
@dataclass
class ExampleModel(Model):
foo: Optional[str] = None
with self.assertRaisesRegex(
ModelError,
"Error while creating ExampleModel model. Could not set value for "
"property 'foo' from '{'bar': 'baz'}'.",
):
ExampleModel.from_dict({"foo": {"bar": "baz"}})
def test_model_error_2(self):
@dataclass
class OtherModel(Model):
something: str
@dataclass
class ExampleModel(Model):
foo: Optional[OtherModel]
with self.assertRaisesRegex(
ModelError,
"Error while creating ExampleModel model. Could not set value for "
"property 'foo' from 'abc'.",
):
ExampleModel.from_dict(
{
"foo": "abc",
}
)
pontos-25.3.2/tests/models/test_strenum.py 0000664 0000000 0000000 00000001166 14762555663 0020707 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import unittest
from pontos.models import StrEnum
class FooEnum(StrEnum):
A = "a"
B = "b"
class StrEnumTestCase(unittest.TestCase):
def test_str(self):
self.assertEqual(str(FooEnum.A), "a")
self.assertEqual(str(FooEnum.B), "b")
def test_str_append(self):
self.assertEqual("say " + FooEnum.A, "say a")
self.assertEqual("say " + FooEnum.B, "say b")
def test_f_string(self):
self.assertEqual(f"say {FooEnum.A}", "say a")
self.assertEqual(f"say {FooEnum.B}", "say b")
pontos-25.3.2/tests/nvd/ 0000775 0000000 0000000 00000000000 14762555663 0015101 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/nvd/__init__.py 0000664 0000000 0000000 00000012112 14762555663 0017207 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# pylint: disable=line-too-long
from typing import Any, Dict, Optional
def get_cve_data(data: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
cve = {
"id": "CVE-2022-45536",
"source_identifier": "cve@mitre.org",
"published": "2022-11-22T21:15:11.103",
"last_modified": "2022-11-23T16:02:07.367",
"vuln_status": "Analyzed",
"descriptions": [
{
"lang": "en",
"value": "AeroCMS v0.0.1 was discovered to contain a SQL "
"Injection vulnerability via the id parameter at "
"\\admin\\post_comments.php. This vulnerability allows "
"attackers to access database information.",
}
],
"references": [
{
"url": "https://github.com/rdyx0/CVE/blob/master/AeroCMS/AeroCMS-v0.0.1-SQLi/post_comments_sql_injection/post_comments_sql_injection.md",
"source": "cve@mitre.org",
"tags": ["Exploit", "Third Party Advisory"],
},
{
"url": "https://rdyx0.github.io/2018/09/07/AeroCMS-v0.0.1-SQLi%20post_comments_sql_injection/",
"source": "cve@mitre.org",
"tags": ["Exploit", "Third Party Advisory"],
},
],
}
if data:
cve.update(data)
return cve
def get_cpe_data(update: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
data = {
"deprecated": False,
"cpe_name": "cpe:2.3:o:microsoft:windows_10_22h2:-:*:*:*:*:*:arm64:*",
"cpe_name_id": "9BAECDB2-614D-4E9C-9936-190C30246F03",
"last_modified": "2022-12-09T18:15:16.973",
"created": "2022-12-09T16:20:06.943",
}
if update:
data.update(update)
return data
def get_cpe_match_data(
update: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
data = {
"cpe_last_modified": "2019-07-22T16:37:38.133",
"created": "2019-06-17T09:16:33.960",
"criteria": "cpe:2.3:a:sun:jre:*:update3:*:*:*:*:*:*",
"last_modified": "2019-06-17T09:16:44.000",
"match_criteria_id": "EAB2C9C2-F685-450B-9980-553966FC3B63",
"matches": [
{
"cpe_name": "cpe:2.3:a:sun:jre:1.3.0:update3:*:*:*:*:*:*",
"cpe_name_id": "2D284534-DA21-43D5-9D89-07F19AE400EA",
},
{
"cpe_name": "cpe:2.3:a:sun:jre:1.4.1:update3:*:*:*:*:*:*",
"cpe_name_id": "CE55E1DF-8EA2-41EA-9C51-1BAE728CA094",
},
{
"cpe_name": "cpe:2.3:a:sun:jre:1.4.2:update3:*:*:*:*:*:*",
"cpe_name_id": "A09C4E47-6548-40C5-8458-5C07C3292C86",
},
{
"cpe_name": "cpe:2.3:a:sun:jre:1.5.0:update3:*:*:*:*:*:*",
"cpe_name_id": "C484A93A-2677-4501-A6E0-E4ADFFFB549E",
},
{
"cpe_name": "cpe:2.3:a:sun:jre:1.6.0:update3:*:*:*:*:*:*",
"cpe_name_id": "C518A954-369E-453E-8E17-2AF639150115",
},
],
"status": "Active",
"version_end_including": "1.6.0",
}
if update:
data.update(update)
return data
def get_cve_change_data(
data: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
cve_changes = {
"cve_id": "CVE-2022-0001",
"event_name": "Initial Analysis",
"cve_change_id": "5160FDEB-0FF0-457B-AA36-0AEDCAB2522E",
"source_identifier": "nvd@nist.gov",
"created": "2022-03-18T20:13:08.123",
"details": [
{
"action": "Added",
"type": "CVSS V2",
"new_value": "NIST (AV:L/AC:L/Au:N/C:P/I:N/A:N)",
},
{
"action": "Added",
"type": "CVSS V3.1",
"new_value": "NIST AV:L/AC:L/PR:L/UI:N/S:C/C:H/I:N/A:N",
},
{
"action": "Changed",
"type": "Reference Type",
"old_value": "http://www.openwall.com/lists/oss-security/2022/03/18/2 No Types Assigned",
"new_value": "http://www.openwall.com/lists/oss-security/2022/03/18/2 Mailing List, Third Party Advisory",
},
],
}
if data:
cve_changes.update(data)
return cve_changes
def get_source_data(
data: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
sources = {
"name": "MITRE",
"contact_email": "cve@mitre.org",
"source_identifiers": [
"cve@mitre.org",
"8254265b-2729-46b6-b9e3-3dfca2d5bfca",
],
"last_modified": "2019-09-09T16:18:45.930",
"created": "2019-09-09T16:18:45.930",
"v3_acceptance_level": {
"description": "Contributor",
"last_modified": "2025-01-30T00:00:20.107",
},
"cwe_acceptance_level": {
"description": "Reference",
"last_modified": "2025-01-24T00:00:00.043",
},
}
if data:
sources.update(data)
return sources
pontos-25.3.2/tests/nvd/cpe/ 0000775 0000000 0000000 00000000000 14762555663 0015650 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/nvd/cpe/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0017755 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/nvd/cpe/test_api.py 0000664 0000000 0000000 00000033656 14762555663 0020047 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long, arguments-differ, redefined-builtin
# ruff: noqa: E501
from datetime import datetime, timezone
from itertools import repeat
from typing import Any, Optional
from unittest.mock import MagicMock, patch
from uuid import UUID, uuid4
from httpx import AsyncClient, Response
from pontos.errors import PontosError
from pontos.nvd.api import now
from pontos.nvd.cpe.api import MAX_CPES_PER_PAGE, CPEApi
from tests import AsyncMock, IsolatedAsyncioTestCase, aiter, anext
from tests.nvd import get_cpe_data
def uuid_replace_str(uuid: UUID, iteration: int, number: int) -> str:
id_str = str(uuid).rsplit("-", 2)
nn = "".join([str(j) for j in repeat(number, 4)])
ii = "".join([str(j) for j in repeat(iteration, 12)])
return f"{id_str[0]}-{nn}-{ii}"
def uuid_replace(uuid: UUID, iteration: int, number: int) -> UUID:
return UUID(uuid_replace_str(uuid, iteration, number))
def create_cpe_response(
cpe_name_id: UUID,
*,
update: Optional[dict[str, Any]] = None,
results: int = 1,
iteration: int = 1,
) -> MagicMock:
products = [
{
"cpe": get_cpe_data(
{
"cpe_name_id": f"{uuid_replace_str(cpe_name_id, iteration, i)}"
}
)
}
for i in range(1, results + 1)
]
data = {
"products": products,
"results_per_page": results,
}
if update:
data.update(update)
response = MagicMock(spec=Response)
response.json.return_value = data
return response
def create_cpes_responses(
cpe_name_id: UUID, responses: int = 2, results_per_response: int = 1
) -> list[MagicMock]:
return [
create_cpe_response(
cpe_name_id=cpe_name_id,
update={"total_results": responses * results_per_response},
results=results_per_response,
iteration=i,
)
for i in range(1, responses + 1)
]
class CPEApiTestCase(IsolatedAsyncioTestCase):
@patch("pontos.nvd.api.time.monotonic", autospec=True)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
def setUp(self, async_client: MagicMock, monotonic_mock: MagicMock) -> None:
self.http_client = AsyncMock()
async_client.return_value = self.http_client
monotonic_mock.return_value = 0
self.api = CPEApi()
async def test_no_cpe_name_id(self):
with self.assertRaises(PontosError):
await self.api.cpe(None)
async def test_no_cpe(self):
data = {
"products": [],
"results_per_page": 1,
}
response = MagicMock(spec=Response)
response.json.return_value = data
self.http_client.get.return_value = response
with self.assertRaises(PontosError):
await self.api.cpe("CPE-1")
async def test_cpe(self):
uuid = uuid4()
self.http_client.get.return_value = create_cpe_response(uuid)
cpe = await self.api.cpe(uuid)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={"cpeNameId": str(uuid)},
)
self.assertEqual(
cpe.cpe_name,
"cpe:2.3:o:microsoft:windows_10_22h2:-:*:*:*:*:*:arm64:*",
)
self.assertEqual(cpe.cpe_name_id, uuid_replace(uuid, 1, 1))
self.assertFalse(cpe.deprecated)
self.assertEqual(
cpe.last_modified,
datetime(2022, 12, 9, 18, 15, 16, 973000, tzinfo=timezone.utc),
)
self.assertEqual(
cpe.created,
datetime(2022, 12, 9, 16, 20, 6, 943000, tzinfo=timezone.utc),
)
self.assertEqual(cpe.refs, [])
self.assertEqual(cpe.titles, [])
self.assertEqual(cpe.deprecated_by, [])
@patch("pontos.nvd.api.time.monotonic", autospec=True)
@patch("pontos.nvd.api.asyncio.sleep", autospec=True)
async def test_rate_limit(
self,
sleep_mock: MagicMock,
monotonic_mock: MagicMock,
):
uuid = uuid4()
self.http_client.get.side_effect = create_cpes_responses(uuid, 8)
monotonic_mock.side_effect = [10, 11]
it = aiter(self.api.cpes())
await anext(it)
await anext(it)
await anext(it)
await anext(it)
await anext(it)
sleep_mock.assert_not_called()
await anext(it)
sleep_mock.assert_called_once_with(20.0)
@patch("pontos.nvd.cpe.api.now", spec=now)
async def test_cves_last_modified_start_date(self, now_mock: MagicMock):
uuid = uuid4()
now_mock.return_value = datetime(2022, 12, 31)
self.http_client.get.side_effect = create_cpes_responses(uuid)
it = aiter(
self.api.cpes(last_modified_start_date=datetime(2022, 12, 1))
)
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 1, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 0,
"lastModStartDate": "2022-12-01T00:00:00",
"lastModEndDate": "2022-12-31T00:00:00",
"resultsPerPage": MAX_CPES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 2, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 1,
"lastModStartDate": "2022-12-01T00:00:00",
"lastModEndDate": "2022-12-31T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_last_modified_end_date(self):
uuid = uuid4()
self.http_client.get.side_effect = create_cpes_responses(uuid)
it = aiter(
self.api.cpes(
last_modified_start_date=datetime(2022, 12, 1),
last_modified_end_date=datetime(2022, 12, 31),
)
)
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 1, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 0,
"lastModStartDate": "2022-12-01T00:00:00",
"lastModEndDate": "2022-12-31T00:00:00",
"resultsPerPage": MAX_CPES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 2, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 1,
"lastModStartDate": "2022-12-01T00:00:00",
"lastModEndDate": "2022-12-31T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cpes_keywords(self):
uuid = uuid4()
self.http_client.get.side_effect = create_cpes_responses(uuid)
it = aiter(self.api.cpes(keywords=["Mac OS X", "kernel"]))
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 1, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 0,
"keywordSearch": "Mac OS X kernel",
"keywordExactMatch": "",
"resultsPerPage": MAX_CPES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 2, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 1,
"resultsPerPage": 1,
"keywordSearch": "Mac OS X kernel",
"keywordExactMatch": "",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cpes_keyword(self):
uuid = uuid4()
self.http_client.get.side_effect = create_cpes_responses(uuid)
it = aiter(self.api.cpes(keywords="macOS"))
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 1, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 0,
"keywordSearch": "macOS",
"resultsPerPage": MAX_CPES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 2, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 1,
"resultsPerPage": 1,
"keywordSearch": "macOS",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cpes_cpe_match_string(self):
uuid = uuid4()
self.http_client.get.side_effect = create_cpes_responses(uuid)
it = aiter(
self.api.cpes(
cpe_match_string="cpe:2.3:o:microsoft:windows_10:20h2:*:*:*:*:*:*:*"
)
)
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 1, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 0,
"resultsPerPage": MAX_CPES_PER_PAGE,
"cpeMatchString": "cpe:2.3:o:microsoft:windows_10:20h2:*:*:*:*:*:*:*",
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 2, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 1,
"resultsPerPage": 1,
"cpeMatchString": "cpe:2.3:o:microsoft:windows_10:20h2:*:*:*:*:*:*:*",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cpes_match_criteria_id(self):
uuid = uuid4()
self.http_client.get.side_effect = create_cpes_responses(uuid)
it = aiter(
self.api.cpes(
match_criteria_id="36FBCF0F-8CEE-474C-8A04-5075AF53FAF4"
)
)
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 1, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 0,
"matchCriteriaId": "36FBCF0F-8CEE-474C-8A04-5075AF53FAF4",
"resultsPerPage": MAX_CPES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 2, 1))
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 1,
"resultsPerPage": 1,
"matchCriteriaId": "36FBCF0F-8CEE-474C-8A04-5075AF53FAF4",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cpes_request_results(self):
uuid = uuid4()
self.http_client.get.side_effect = create_cpes_responses(
uuid, results_per_response=2
)
it = aiter(self.api.cpes(request_results=10))
cve = await anext(it)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 0,
"resultsPerPage": 10,
},
)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 1, 1))
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 1, 2))
self.http_client.get.assert_not_called()
self.http_client.get.reset_mock()
cve = await anext(it)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpes/2.0",
headers={},
params={
"startIndex": 2,
"resultsPerPage": 2,
},
)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 2, 1))
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.cpe_name_id, uuid_replace(uuid, 2, 2))
self.http_client.get.assert_not_called()
self.http_client.get.reset_mock()
with self.assertRaises(Exception):
cve = await anext(it)
async def test_context_manager(self):
async with self.api:
pass
self.http_client.__aenter__.assert_awaited_once()
self.http_client.__aexit__.assert_awaited_once()
pontos-25.3.2/tests/nvd/cpe_match/ 0000775 0000000 0000000 00000000000 14762555663 0017024 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/nvd/cpe_match/__init__.py 0000664 0000000 0000000 00000000134 14762555663 0021133 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/nvd/cpe_match/test_api.py 0000664 0000000 0000000 00000043343 14762555663 0021215 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long, arguments-differ, redefined-builtin
# ruff: noqa: E501
from datetime import datetime
from typing import Any, Optional
from unittest.mock import MagicMock, patch
from uuid import UUID, uuid4
from httpx import AsyncClient, Response
from pontos.errors import PontosError
from pontos.nvd.api import now
from pontos.nvd.cpe_match.api import MAX_CPE_MATCHES_PER_PAGE, CPEMatchApi
from tests import AsyncMock, IsolatedAsyncioTestCase, aiter, anext
from tests.nvd import get_cpe_match_data
def uuid_replace_str(uuid: UUID, iteration: int, number: int) -> str:
id_str = str(uuid).rsplit("-", 2)
return f"{id_str[0]}-{iteration:04}-{number:012}"
def uuid_replace(uuid: UUID, iteration: int, number: int) -> UUID:
return UUID(uuid_replace_str(uuid, iteration, number))
def generate_cpe_name(iteration: int, number: int) -> str:
return f"cpe:2.3:a:acme:test-app:1.{iteration-1}.{number-1}:*:*:*:*:*:*:*"
def create_cpe_match_response(
match_criteria_id: UUID,
cpe_name_id: UUID,
*,
update: Optional[dict[str, Any]] = None,
results: int = 1,
iteration: int = 1,
) -> MagicMock:
match_strings = [
{
"match_string": get_cpe_match_data(
{
"match_criteria_id": f"{uuid_replace_str(match_criteria_id, iteration, i)}",
"criteria": generate_cpe_name(iteration, i),
"matches": [
{
"cpe_name": generate_cpe_name(iteration, i),
"cpe_name_id": f"{uuid_replace_str(cpe_name_id, iteration, i)}",
}
],
}
)
}
for i in range(1, results + 1)
]
data = {
"match_strings": match_strings,
"results_per_page": results,
}
if update:
data.update(update)
response = MagicMock(spec=Response)
response.json.return_value = data
return response
def create_cpe_match_responses(
match_criteria_id: UUID,
cpe_name_id: UUID,
responses: int = 2,
results_per_response: int = 1,
) -> list[MagicMock]:
return [
create_cpe_match_response(
match_criteria_id=match_criteria_id,
cpe_name_id=cpe_name_id,
update={"total_results": responses * results_per_response},
results=results_per_response,
iteration=i,
)
for i in range(1, responses + 1)
]
class CPEMatchApiTestCase(IsolatedAsyncioTestCase):
@patch("pontos.nvd.api.time.monotonic", autospec=True)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
def setUp(self, async_client: MagicMock, monotonic_mock: MagicMock) -> None:
self.http_client = AsyncMock()
async_client.return_value = self.http_client
monotonic_mock.return_value = 0
self.api = CPEMatchApi()
async def test_no_match_criteria_id(self):
with self.assertRaises(PontosError):
await self.api.cpe_match(None)
async def test_no_match_strings(self):
data = {
"match_strings": [],
"results_per_page": 1,
}
response = MagicMock(spec=Response)
response.json.return_value = data
self.http_client.get.return_value = response
with self.assertRaises(PontosError):
await self.api.cpe_match("DOES-NOT-EXIST")
async def test_cpe_match(self):
match_criteria_id = uuid_replace(uuid4(), 1, 1)
cpe_name_id = uuid_replace(uuid4(), 1, 1)
self.http_client.get.return_value = create_cpe_match_response(
match_criteria_id, cpe_name_id
)
cpe_match_string = await self.api.cpe_match(match_criteria_id)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={"matchCriteriaId": str(match_criteria_id)},
)
self.assertEqual(
match_criteria_id,
cpe_match_string.match_criteria_id,
)
self.assertEqual(
generate_cpe_name(1, 1),
cpe_match_string.criteria,
)
self.assertEqual(
cpe_name_id,
cpe_match_string.matches[0].cpe_name_id,
)
self.assertEqual(
generate_cpe_name(1, 1),
cpe_match_string.matches[0].cpe_name,
)
@patch("pontos.nvd.cpe_match.api.now", spec=now)
async def test_cpe_matches_last_modified_start_date(
self, now_mock: MagicMock
):
match_criteria_id = uuid4()
cpe_name_id = uuid4()
now_mock.return_value = datetime(2019, 8, 30)
self.http_client.get.side_effect = create_cpe_match_responses(
match_criteria_id, cpe_name_id
)
it = aiter(
self.api.cpe_matches(last_modified_start_date=datetime(2019, 6, 1))
)
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 1, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 0,
"lastModStartDate": "2019-06-01T00:00:00",
"lastModEndDate": "2019-08-30T00:00:00",
"resultsPerPage": MAX_CPE_MATCHES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 2, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 1,
"lastModStartDate": "2019-06-01T00:00:00",
"lastModEndDate": "2019-08-30T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cpe_match = await anext(it)
@patch("pontos.nvd.cpe_match.api.now", spec=now)
async def test_cpe_matches_last_modified_end_date(
self, now_mock: MagicMock
):
match_criteria_id = uuid4()
cpe_name_id = uuid4()
now_mock.return_value = datetime(2019, 8, 30)
self.http_client.get.side_effect = create_cpe_match_responses(
match_criteria_id, cpe_name_id
)
it = aiter(
self.api.cpe_matches(last_modified_end_date=datetime(2019, 8, 1))
)
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 1, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 0,
"lastModEndDate": "2019-08-01T00:00:00",
"resultsPerPage": MAX_CPE_MATCHES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 2, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 1,
"lastModEndDate": "2019-08-01T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cpe_match = await anext(it)
async def test_cpe_matches_cve_id(self):
match_criteria_id = uuid4()
cpe_name_id = uuid4()
self.http_client.get.side_effect = create_cpe_match_responses(
match_criteria_id, cpe_name_id
)
it = aiter(self.api.cpe_matches(cve_id="CVE-2010-3574"))
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 1, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 0,
"cveId": "CVE-2010-3574",
"resultsPerPage": MAX_CPE_MATCHES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 2, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 1,
"cveId": "CVE-2010-3574",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cpe_match = await anext(it)
async def test_cpe_matches_match_string_search(self):
match_criteria_id = uuid4()
cpe_name_id = uuid4()
self.http_client.get.side_effect = create_cpe_match_responses(
match_criteria_id, cpe_name_id
)
it = aiter(
self.api.cpe_matches(
match_string_search="cpe:2.3:a:sun:jre:*:*:*:*:*:*:*:*"
)
)
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 1, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 0,
"matchStringSearch": "cpe:2.3:a:sun:jre:*:*:*:*:*:*:*:*",
"resultsPerPage": MAX_CPE_MATCHES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 2, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 1,
"matchStringSearch": "cpe:2.3:a:sun:jre:*:*:*:*:*:*:*:*",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cpe_match = await anext(it)
async def test_cpe_matches_request_results(self):
match_criteria_id = uuid4()
cpe_name_id = uuid4()
self.http_client.get.side_effect = create_cpe_match_responses(
match_criteria_id=match_criteria_id,
cpe_name_id=cpe_name_id,
results_per_response=2,
)
it = aiter(self.api.cpe_matches(request_results=10))
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 1, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 0,
"resultsPerPage": 10,
},
)
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 1, 2), cpe_match.match_criteria_id
)
self.http_client.get.assert_not_called()
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 2, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={},
params={
"startIndex": 2,
"resultsPerPage": 2,
},
)
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 2, 2), cpe_match.match_criteria_id
)
self.http_client.get.assert_not_called()
with self.assertRaises(Exception):
cpe_match = await anext(it)
async def test_cpe_match_caching(self):
match_criteria_id = uuid4()
cpe_name_id = uuid4()
responses = create_cpe_match_responses(
match_criteria_id=match_criteria_id,
cpe_name_id=cpe_name_id,
results_per_response=3,
)
self.http_client.get.side_effect = responses
response_matches = [
[
match_string["match_string"]["matches"]
for match_string in response.json.return_value["match_strings"]
]
for response in responses
]
# Make matches of first match_string identical in each response
response_matches[1][0][0]["cpe_name"] = response_matches[0][0][0][
"cpe_name"
]
response_matches[1][0][0]["cpe_name_id"] = response_matches[0][0][0][
"cpe_name_id"
]
# Make matches of second match_string only have the same cpe_name_id
response_matches[1][1][0]["cpe_name_id"] = response_matches[0][1][0][
"cpe_name_id"
]
# Leave matches of third match_string different from each other
it = aiter(self.api.cpe_matches(request_results=10))
received = [item async for item in it]
# First matches in each response of three items must be identical objects
self.assertIs(received[0].matches[0], received[3].matches[0])
# Second matches in each response of three items must only have same cpe_name_id
self.assertIsNot(received[1].matches[0], received[4].matches[0])
self.assertEqual(
received[1].matches[0].cpe_name_id,
received[4].matches[0].cpe_name_id,
)
self.assertNotEqual(
received[1].matches[0].cpe_name, received[4].matches[0].cpe_name
)
# Third matches in each response of three items must be different
self.assertIsNot(received[2].matches[0], received[5].matches[0])
self.assertNotEqual(
received[2].matches[0].cpe_name_id,
received[5].matches[0].cpe_name_id,
)
self.assertNotEqual(
received[2].matches[0].cpe_name, received[5].matches[0].cpe_name
)
async def test_context_manager(self):
async with self.api:
pass
self.http_client.__aenter__.assert_awaited_once()
self.http_client.__aexit__.assert_awaited_once()
class CPEMatchApiWithTokenTestCase(IsolatedAsyncioTestCase):
@patch("pontos.nvd.api.time.monotonic", autospec=True)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
def setUp(self, async_client: MagicMock, monotonic_mock: MagicMock) -> None:
self.http_client = AsyncMock()
async_client.return_value = self.http_client
monotonic_mock.return_value = 0
self.api = CPEMatchApi(token="token123")
async def test_cpe_matches_request_results_with_token(self):
match_criteria_id = uuid4()
cpe_name_id = uuid4()
self.http_client.get.side_effect = create_cpe_match_responses(
match_criteria_id=match_criteria_id,
cpe_name_id=cpe_name_id,
results_per_response=2,
)
it = aiter(self.api.cpe_matches(request_results=10))
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 1, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={"apiKey": "token123"},
params={
"startIndex": 0,
"resultsPerPage": 10,
},
)
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 1, 2), cpe_match.match_criteria_id
)
self.http_client.get.assert_not_called()
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 2, 1), cpe_match.match_criteria_id
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cpematch/2.0",
headers={"apiKey": "token123"},
params={
"startIndex": 2,
"resultsPerPage": 2,
},
)
self.http_client.get.reset_mock()
cpe_match = await anext(it)
self.assertEqual(
uuid_replace(match_criteria_id, 2, 2), cpe_match.match_criteria_id
)
self.http_client.get.assert_not_called()
with self.assertRaises(Exception):
cpe_match = await anext(it)
@patch("pontos.nvd.api.time.monotonic", autospec=True)
@patch("pontos.nvd.api.asyncio.sleep", autospec=True)
async def test_rate_limit_with_token(
self,
sleep_mock: MagicMock,
monotonic_mock: MagicMock,
):
match_criteria_id = uuid4()
cpe_name_id = uuid4()
self.http_client.get.side_effect = create_cpe_match_responses(
match_criteria_id, cpe_name_id, 8
)
monotonic_mock.side_effect = [10, 11]
it = aiter(self.api.cpe_matches())
await anext(it)
await anext(it)
await anext(it)
await anext(it)
await anext(it)
sleep_mock.assert_not_called()
await anext(it)
sleep_mock.assert_not_called()
pontos-25.3.2/tests/nvd/cve/ 0000775 0000000 0000000 00000000000 14762555663 0015656 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/nvd/cve/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0017763 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/nvd/cve/test_api.py 0000664 0000000 0000000 00000071576 14762555663 0020060 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long, arguments-differ, redefined-builtin
from datetime import datetime, timezone
from typing import Any, Dict, List, Optional
from unittest.mock import MagicMock, patch
from httpx import AsyncClient, Response
from pontos.errors import PontosError
from pontos.nvd.api import now
from pontos.nvd.cve.api import MAX_CVES_PER_PAGE, CVEApi
from pontos.nvd.models import cvss_v2, cvss_v3
from tests import AsyncMock, IsolatedAsyncioTestCase, aiter, anext
from tests.nvd import get_cve_data
def create_cve_response(
cve_id: str,
*,
update: Optional[Dict[str, Any]] = None,
results: int = 1,
) -> MagicMock:
data = {
"vulnerabilities": [
{"cve": get_cve_data({"id": f"{cve_id}-{i}"})}
for i in range(1, results + 1)
],
"results_per_page": results,
}
if update:
data.update(update)
response = MagicMock(spec=Response)
response.json.return_value = data
return response
def create_cves_responses(
requests: int = 2, results_per_response: int = 1
) -> List[MagicMock]:
return [
create_cve_response(
f"CVE-{i}",
update={"total_results": requests * results_per_response},
results=results_per_response,
)
for i in range(1, requests + 1)
]
class CVEApiTestCase(IsolatedAsyncioTestCase):
@patch("pontos.nvd.api.time.monotonic", autospec=True)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
def setUp(
self,
async_client: MagicMock,
monotonic_mock: MagicMock,
) -> None:
self.http_client = AsyncMock()
async_client.return_value = self.http_client
monotonic_mock.return_value = 0
self.api = CVEApi(token="token")
async def test_no_cve_id(self):
with self.assertRaises(PontosError):
await self.api.cve(None)
async def test_no_cve(self):
data = {
"vulnerabilities": [],
"results_per_page": 1,
}
response = MagicMock(spec=Response)
response.json.return_value = data
self.http_client.get.return_value = response
with self.assertRaises(PontosError):
await self.api.cve("CVE-1")
async def test_cve(self):
data = {"vulnerabilities": [{"cve": get_cve_data()}]}
response = MagicMock(spec=Response)
response.json.return_value = data
self.http_client.get.return_value = response
cve = await self.api.cve("FOO-BAR")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={"cveId": "FOO-BAR"},
)
self.assertEqual(cve.id, "CVE-2022-45536")
self.assertEqual(cve.source_identifier, "cve@mitre.org")
self.assertEqual(
cve.published,
datetime(2022, 11, 22, 21, 15, 11, 103000, tzinfo=timezone.utc),
)
self.assertEqual(
cve.last_modified,
datetime(2022, 11, 23, 16, 2, 7, 367000, tzinfo=timezone.utc),
)
self.assertEqual(len(cve.descriptions), 1)
self.assertEqual(len(cve.references), 2)
self.assertEqual(len(cve.weaknesses), 0)
self.assertEqual(len(cve.configurations), 0)
self.assertEqual(len(cve.vendor_comments), 0)
self.assertIsNone(cve.metrics)
self.assertIsNone(cve.evaluator_comment)
self.assertIsNone(cve.evaluator_solution)
self.assertIsNone(cve.evaluator_impact)
self.assertIsNone(cve.cisa_exploit_add)
self.assertIsNone(cve.cisa_action_due)
self.assertIsNone(cve.cisa_required_action)
self.assertIsNone(cve.cisa_vulnerability_name)
async def test_cves(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves())
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={"startIndex": 1, "resultsPerPage": 1},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
@patch("pontos.nvd.cve.api.now", spec=now)
async def test_cves_last_modified_start_date(self, now_mock: MagicMock):
now_mock.return_value = datetime(2022, 12, 31)
self.http_client.get.side_effect = create_cves_responses()
it = aiter(
self.api.cves(last_modified_start_date=datetime(2022, 12, 1))
)
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"lastModStartDate": "2022-12-01T00:00:00",
"lastModEndDate": "2022-12-31T00:00:00",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"lastModStartDate": "2022-12-01T00:00:00",
"lastModEndDate": "2022-12-31T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_last_modified_end_date(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(
self.api.cves(
last_modified_start_date=datetime(2022, 12, 1),
last_modified_end_date=datetime(2022, 12, 31),
)
)
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"lastModStartDate": "2022-12-01T00:00:00",
"lastModEndDate": "2022-12-31T00:00:00",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"lastModStartDate": "2022-12-01T00:00:00",
"lastModEndDate": "2022-12-31T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
@patch("pontos.nvd.cve.api.now", spec=now)
async def test_cves_published_start_date(self, now_mock: MagicMock):
now_mock.return_value = datetime(2022, 12, 31)
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(published_start_date=datetime(2022, 12, 1)))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"pubStartDate": "2022-12-01T00:00:00",
"pubEndDate": "2022-12-31T00:00:00",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"pubStartDate": "2022-12-01T00:00:00",
"pubEndDate": "2022-12-31T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_published_end_date(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(
self.api.cves(
published_start_date=datetime(2022, 12, 1),
published_end_date=datetime(2022, 12, 31),
)
)
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"pubStartDate": "2022-12-01T00:00:00",
"pubEndDate": "2022-12-31T00:00:00",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"pubStartDate": "2022-12-01T00:00:00",
"pubEndDate": "2022-12-31T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_cpe_name(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(cpe_name="foo-bar"))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"cpeName": "foo-bar",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"cpeName": "foo-bar",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_is_vulnerable(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(cpe_name="foo-bar", is_vulnerable=True))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"cpeName": "foo-bar",
"isVulnerable": "",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"cpeName": "foo-bar",
"isVulnerable": "",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_cvss_v2_vector(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(cvss_v2_vector="AV:N/AC:M/Au:N/C:N/I:P/A:N"))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"cvssV2Metrics": "AV:N/AC:M/Au:N/C:N/I:P/A:N",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"resultsPerPage": 1,
"cvssV2Metrics": "AV:N/AC:M/Au:N/C:N/I:P/A:N",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_cvss_v3_vector(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(
self.api.cves(
cvss_v3_vector="CVSS:3.1/AV:N/AC:L/PR:H/UI:N/S:U/C:H/I:N/A:N"
)
)
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"cvssV3Metrics": "CVSS:3.1/AV:N/AC:L/PR:H/UI:N/S:U/C:H/I:N/A:N",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"resultsPerPage": 1,
"cvssV3Metrics": "CVSS:3.1/AV:N/AC:L/PR:H/UI:N/S:U/C:H/I:N/A:N",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_cvss_v2_severity(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(cvss_v2_severity=cvss_v2.Severity.HIGH))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"cvssV2Severity": "HIGH",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"resultsPerPage": 1,
"cvssV2Severity": "HIGH",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_cvss_v3_severity(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(cvss_v3_severity=cvss_v3.Severity.HIGH))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"cvssV3Severity": "HIGH",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"resultsPerPage": 1,
"cvssV3Severity": "HIGH",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_keywords(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(keywords=["Mac OS X", "kernel"]))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"keywordSearch": "Mac OS X kernel",
"keywordExactMatch": "",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"resultsPerPage": 1,
"keywordSearch": "Mac OS X kernel",
"keywordExactMatch": "",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_keyword(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(keywords="Windows"))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"keywordSearch": "Windows",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"resultsPerPage": 1,
"keywordSearch": "Windows",
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_cwe(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(cwe_id="CWE-1"))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"cweId": "CWE-1",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={"startIndex": 1, "resultsPerPage": 1, "cweId": "CWE-1"},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_source_identifier(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(source_identifier="nvd@nist.gov"))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"sourceIdentifier": "nvd@nist.gov",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"sourceIdentifier": "nvd@nist.gov",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_virtual_match_string(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(virtual_match_string="foo-bar"))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"virtualMatchString": "foo-bar",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"virtualMatchString": "foo-bar",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_has_cert_alerts(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(has_cert_alerts=True))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"hasCertAlerts": "",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"hasCertAlerts": "",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_has_cert_notes(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(has_cert_notes=True))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"hasCertNotes": "",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"hasCertNotes": "",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_has_kev(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(has_kev=True))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"hasKev": "",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"hasKev": "",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_has_oval(self):
self.http_client.get.side_effect = create_cves_responses()
it = aiter(self.api.cves(has_oval=True))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"hasOval": "",
"resultsPerPage": MAX_CVES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"hasOval": "",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve = await anext(it)
async def test_cves_request_results(self):
self.http_client.get.side_effect = create_cves_responses(
results_per_response=2
)
it = aiter(self.api.cves(request_results=10))
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"resultsPerPage": 10,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-1-2")
self.http_client.get.assert_not_called()
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cves/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 2,
"resultsPerPage": 2,
},
)
self.http_client.get.reset_mock()
cve = await anext(it)
self.assertEqual(cve.id, "CVE-2-2")
self.http_client.get.assert_not_called()
with self.assertRaises(Exception):
cve = await anext(it)
async def test_context_manager(self):
async with self.api:
pass
self.http_client.__aenter__.assert_awaited_once()
self.http_client.__aexit__.assert_awaited_once()
@patch("pontos.nvd.api.time.monotonic", autospec=True)
@patch("pontos.nvd.api.asyncio.sleep", autospec=True)
async def test_rate_limit(
self,
sleep_mock: MagicMock,
monotonic_mock: MagicMock,
):
self.http_client.get.side_effect = create_cves_responses(6)
self.api._rate_limit = 5 # pylint: disable=protected-access
monotonic_mock.side_effect = [10.0, 11.0]
it = aiter(self.api.cves())
await anext(it)
await anext(it)
await anext(it)
await anext(it)
await anext(it)
sleep_mock.assert_not_called()
await anext(it)
sleep_mock.assert_called_once_with(20.0)
pontos-25.3.2/tests/nvd/cve_changes/ 0000775 0000000 0000000 00000000000 14762555663 0017346 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/nvd/cve_changes/__init__.py 0000664 0000000 0000000 00000000132 14762555663 0021453 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
pontos-25.3.2/tests/nvd/cve_changes/test_api.py 0000664 0000000 0000000 00000025440 14762555663 0021535 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
from datetime import datetime, timezone
from typing import Any, Optional
from unittest.mock import MagicMock, patch
from uuid import UUID
from httpx import AsyncClient, Response
from pontos.errors import PontosError
from pontos.nvd.api import now
from pontos.nvd.cve_changes.api import MAX_CVE_CHANGES_PER_PAGE, CVEChangesApi
from pontos.nvd.models.cve_change import Detail, EventName
from tests import AsyncMock, IsolatedAsyncioTestCase, aiter, anext
from tests.nvd import get_cve_change_data
def create_cve_changes_response(
cve_id: str, update: Optional[dict[str, Any]] = None
) -> MagicMock:
data = {
"cve_changes": [{"change": get_cve_change_data({"cve_id": cve_id})}],
"results_per_page": 1,
}
if update:
data.update(update)
response = MagicMock(spec=Response)
response.json.return_value = data
return response
def create_cve_changes_responses(count: int = 2) -> list[MagicMock]:
return [
create_cve_changes_response(f"CVE-{i}", {"total_results": count})
for i in range(1, count + 1)
]
class CVEChangesApiTestCase(IsolatedAsyncioTestCase):
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
def setUp(self, async_client: MagicMock) -> None:
self.http_client = AsyncMock()
async_client.return_value = self.http_client
self.api = CVEChangesApi(token="token")
async def test_cve_changes(self):
self.http_client.get.side_effect = create_cve_changes_responses()
it = aiter(self.api.changes())
cve_change = await anext(it)
self.assertEqual(cve_change.cve_id, "CVE-1")
self.assertEqual(cve_change.event_name, EventName.INITIAL_ANALYSIS)
self.assertEqual(
cve_change.cve_change_id,
UUID("5160FDEB-0FF0-457B-AA36-0AEDCAB2522E"),
)
self.assertEqual(cve_change.source_identifier, "nvd@nist.gov")
self.assertEqual(
cve_change.created,
datetime(2022, 3, 18, 20, 13, 8, 123000, tzinfo=timezone.utc),
)
self.assertEqual(
cve_change.details,
[
Detail(
action="Added",
type="CVSS V2",
new_value="NIST (AV:L/AC:L/Au:N/C:P/I:N/A:N)",
),
Detail(
action="Added",
type="CVSS V3.1",
new_value="NIST AV:L/AC:L/PR:L/UI:N/S:C/C:H/I:N/A:N",
),
Detail(
action="Changed",
type="Reference Type",
old_value="http://www.openwall.com/lists/oss-security/2022/03/18/2 No Types Assigned",
new_value="http://www.openwall.com/lists/oss-security/2022/03/18/2 Mailing List, Third Party Advisory",
),
],
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"resultsPerPage": MAX_CVE_CHANGES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve_change = await anext(it)
self.assertEqual(cve_change.cve_id, "CVE-2")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={"startIndex": 1, "resultsPerPage": 1},
)
with self.assertRaises(StopAsyncIteration):
cve_change = await anext(it)
async def test_cve_changes_change_dates(self):
self.http_client.get.side_effect = create_cve_changes_responses()
it = aiter(
self.api.changes(
change_start_date=datetime(2022, 12, 1),
change_end_date=datetime(2022, 12, 31),
)
)
cve_changes = await anext(it)
self.assertEqual(cve_changes.cve_id, "CVE-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"changeStartDate": "2022-12-01T00:00:00",
"changeEndDate": "2022-12-31T00:00:00",
"resultsPerPage": MAX_CVE_CHANGES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve_changes = await anext(it)
self.assertEqual(cve_changes.cve_id, "CVE-2")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"changeStartDate": "2022-12-01T00:00:00",
"changeEndDate": "2022-12-31T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve_changes = await anext(it)
async def test_cve_changes_cve_id(self):
self.http_client.get.side_effect = create_cve_changes_responses()
it = aiter(self.api.changes(cve_id="CVE-1"))
cve_changes = await anext(it)
self.assertEqual(cve_changes.cve_id, "CVE-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"cveId": "CVE-1",
"resultsPerPage": MAX_CVE_CHANGES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve_changes = await anext(it)
self.assertEqual(cve_changes.cve_id, "CVE-2")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"cveId": "CVE-1",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
cve_changes = await anext(it)
async def test_cve_changes_event_name(self):
self.http_client.get.side_effect = create_cve_changes_responses()
it = aiter(self.api.changes(event_name=EventName.INITIAL_ANALYSIS))
cve_changes = await anext(it)
self.assertEqual(cve_changes.cve_id, "CVE-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"eventName": "Initial Analysis",
"resultsPerPage": MAX_CVE_CHANGES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
cve_changes = await anext(it)
self.assertEqual(cve_changes.cve_id, "CVE-2")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"eventName": "Initial Analysis",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
await anext(it)
@patch("pontos.nvd.cve_changes.api.now", spec=now)
async def test_cve_changes_calculate_end_date(self, now_mock: MagicMock):
now_mock.return_value = datetime(2023, 1, 2, tzinfo=timezone.utc)
self.http_client.get.side_effect = create_cve_changes_responses()
it = aiter(
self.api.changes(
change_start_date=datetime(2023, 1, 1, tzinfo=timezone.utc)
)
)
await anext(it)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"changeStartDate": "2023-01-01T00:00:00+00:00",
"changeEndDate": "2023-01-02T00:00:00+00:00",
"resultsPerPage": MAX_CVE_CHANGES_PER_PAGE,
},
)
@patch("pontos.nvd.cve_changes.api.now", spec=now)
async def test_cve_changes_calculate_end_date_with_limit(
self, now_mock: MagicMock
):
now_mock.return_value = datetime(2023, 5, 2, tzinfo=timezone.utc)
self.http_client.get.side_effect = create_cve_changes_responses()
it = aiter(
self.api.changes(
change_start_date=datetime(2023, 1, 1, tzinfo=timezone.utc)
)
)
await anext(it)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"changeStartDate": "2023-01-01T00:00:00+00:00",
"changeEndDate": "2023-05-01T00:00:00+00:00",
"resultsPerPage": MAX_CVE_CHANGES_PER_PAGE,
},
)
async def test_cve_changes_calculate_start_date(self):
self.http_client.get.side_effect = create_cve_changes_responses()
it = aiter(
self.api.changes(
change_end_date=datetime(2023, 5, 1, tzinfo=timezone.utc)
)
)
await anext(it)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"changeStartDate": "2023-01-01T00:00:00+00:00",
"changeEndDate": "2023-05-01T00:00:00+00:00",
"resultsPerPage": MAX_CVE_CHANGES_PER_PAGE,
},
)
async def test_cve_changes_range_too_long(self):
with self.assertRaises(PontosError):
self.api.changes(
change_start_date=datetime(2023, 1, 1),
change_end_date=datetime(2023, 5, 2),
)
async def test_cve_changes_request_results(self):
self.http_client.get.side_effect = create_cve_changes_responses()
it = aiter(self.api.changes(request_results=10))
await anext(it)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/cvehistory/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"resultsPerPage": 10,
},
)
async def test_context_manager(self):
async with self.api:
pass
self.http_client.__aenter__.assert_awaited_once()
self.http_client.__aexit__.assert_awaited_once()
pontos-25.3.2/tests/nvd/models/ 0000775 0000000 0000000 00000000000 14762555663 0016364 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/nvd/models/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0020471 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/nvd/models/test_cpe.py 0000664 0000000 0000000 00000006322 14762555663 0020547 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# pylint: disable=line-too-long
# ruff: noqa: E501
import unittest
from datetime import datetime, timezone
from uuid import UUID
from pontos.nvd.models.cpe import CPE, ReferenceType
from tests.nvd import get_cpe_data
class CPETestCase(unittest.TestCase):
def test_required_only(self):
cpe = CPE.from_dict(get_cpe_data())
self.assertEqual(
cpe.cpe_name,
"cpe:2.3:o:microsoft:windows_10_22h2:-:*:*:*:*:*:arm64:*",
)
self.assertEqual(
cpe.cpe_name_id, UUID("9BAECDB2-614D-4E9C-9936-190C30246F03")
)
self.assertFalse(cpe.deprecated)
self.assertEqual(
cpe.last_modified,
datetime(2022, 12, 9, 18, 15, 16, 973000, tzinfo=timezone.utc),
)
self.assertEqual(
cpe.created,
datetime(2022, 12, 9, 16, 20, 6, 943000, tzinfo=timezone.utc),
)
self.assertEqual(cpe.titles, [])
self.assertEqual(cpe.refs, [])
self.assertEqual(cpe.deprecated_by, [])
def test_titles(self):
cpe = CPE.from_dict(
get_cpe_data(
{
"titles": [
{
"title": "Microsoft Windows 10 22h2 on ARM64",
"lang": "en",
}
],
}
)
)
self.assertEqual(len(cpe.titles), 1)
title = cpe.titles[0]
self.assertEqual(title.title, "Microsoft Windows 10 22h2 on ARM64")
self.assertEqual(title.lang, "en")
def test_refs(self):
cpe = CPE.from_dict(
get_cpe_data(
{
"refs": [
{
"ref": "https://learn.microsoft.com/en-us/windows/release-health/release-information",
"type": "Version",
}
],
}
)
)
self.assertEqual(len(cpe.refs), 1)
reference = cpe.refs[0]
self.assertEqual(
reference.ref,
"https://learn.microsoft.com/en-us/windows/release-health/release-information",
)
self.assertEqual(reference.type, ReferenceType.VERSION)
def test_deprecated(self):
cpe = CPE.from_dict(
get_cpe_data(
{
"deprecated": True,
"deprecated_by": [
{
"cpe_name": "cpe:2.3:o:microsoft:windows_10_22h2:-:*:*:*:*:*:x64:*",
"cpe_name_id": "A09335E2-B42F-4820-B487-57A4BF0CEE98",
}
],
}
)
)
self.assertTrue(cpe.deprecated)
self.assertEqual(len(cpe.deprecated_by), 1)
deprecated_by = cpe.deprecated_by[0]
self.assertEqual(
deprecated_by.cpe_name,
"cpe:2.3:o:microsoft:windows_10_22h2:-:*:*:*:*:*:x64:*",
)
self.assertEqual(
deprecated_by.cpe_name_id,
UUID("A09335E2-B42F-4820-B487-57A4BF0CEE98"),
)
pontos-25.3.2/tests/nvd/models/test_cpe_match.py 0000664 0000000 0000000 00000007704 14762555663 0021730 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# pylint: disable=line-too-long
# ruff: noqa: E501
import unittest
from datetime import datetime, timezone
from uuid import UUID
from pontos.nvd.models.cpe_match_string import CPEMatch, CPEMatchString
from tests.nvd import get_cpe_match_data
class CPEMatchTestCase(unittest.TestCase):
def test_required_only(self):
"""
Test the required attributes of a CPEMatchString
"""
data = get_cpe_match_data()
data.__delitem__("matches")
data.__delitem__("version_end_including")
data.__delitem__("cpe_last_modified")
cpe_match_string = CPEMatchString.from_dict(data)
self.assertEqual(
UUID("EAB2C9C2-F685-450B-9980-553966FC3B63"),
cpe_match_string.match_criteria_id,
)
self.assertEqual(
"cpe:2.3:a:sun:jre:*:update3:*:*:*:*:*:*",
cpe_match_string.criteria,
)
self.assertEqual(
"Active",
cpe_match_string.status,
)
self.assertEqual(
datetime(2019, 6, 17, 9, 16, 33, 960000, tzinfo=timezone.utc),
cpe_match_string.created,
)
self.assertEqual(
datetime(2019, 6, 17, 9, 16, 44, 0, tzinfo=timezone.utc),
cpe_match_string.last_modified,
)
self.assertEqual([], cpe_match_string.matches)
self.assertIsNone(cpe_match_string.cpe_last_modified)
self.assertIsNone(cpe_match_string.version_start_excluding)
self.assertIsNone(cpe_match_string.version_end_excluding)
self.assertIsNone(cpe_match_string.version_start_including)
self.assertIsNone(cpe_match_string.version_end_including)
def test_cpe_last_modified(self):
data = get_cpe_match_data()
cpe_match_string = CPEMatchString.from_dict(data)
self.assertEqual(
datetime(2019, 7, 22, 16, 37, 38, 133000, tzinfo=timezone.utc),
cpe_match_string.cpe_last_modified,
)
def test_matches(self):
"""
Test the matches list of a CPEMatchString
"""
cpe_match_string = CPEMatchString.from_dict(get_cpe_match_data())
self.assertEqual(5, len(cpe_match_string.matches))
self.assertEqual(
CPEMatch(
"cpe:2.3:a:sun:jre:1.3.0:update3:*:*:*:*:*:*",
UUID("2d284534-da21-43d5-9d89-07f19ae400ea"),
),
cpe_match_string.matches[0],
)
self.assertEqual(
CPEMatch(
"cpe:2.3:a:sun:jre:1.6.0:update3:*:*:*:*:*:*",
UUID("c518a954-369e-453e-8e17-2af639150115"),
),
cpe_match_string.matches[-1],
)
def test_including_version_limits(self):
"""
Test the including version limits of a CPEMatchString
"""
data = get_cpe_match_data({"version_start_including": "1.3.0"})
cpe_match_string = CPEMatchString.from_dict(data)
self.assertEqual("1.3.0", cpe_match_string.version_start_including)
self.assertEqual("1.6.0", cpe_match_string.version_end_including)
self.assertIsNone(cpe_match_string.version_start_excluding)
self.assertIsNone(cpe_match_string.version_end_excluding)
def test_excluding_version_limits(self):
"""
Test the excluding version limits of a CPEMatchString
"""
data = get_cpe_match_data(
{
"version_start_excluding": "1.2.0",
"version_end_excluding": "1.7.0",
}
)
data.__delitem__("version_end_including")
cpe_match_string = CPEMatchString.from_dict(data)
self.assertEqual("1.2.0", cpe_match_string.version_start_excluding)
self.assertEqual("1.7.0", cpe_match_string.version_end_excluding)
self.assertIsNone(cpe_match_string.version_start_including)
self.assertIsNone(cpe_match_string.version_end_including)
pontos-25.3.2/tests/nvd/models/test_cve.py 0000664 0000000 0000000 00000061530 14762555663 0020557 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=line-too-long
# ruff: noqa: E501
import unittest
from datetime import date, datetime, timezone
from pontos.nvd.models import cvss_v2, cvss_v3
from pontos.nvd.models.cve import CVE, CVSSType, Operator
from tests.nvd import get_cve_data
class CVETestCase(unittest.TestCase):
def test_required_only(self):
cve = CVE.from_dict(get_cve_data())
self.assertEqual(cve.id, "CVE-2022-45536")
self.assertEqual(cve.source_identifier, "cve@mitre.org")
self.assertEqual(
cve.published,
datetime(2022, 11, 22, 21, 15, 11, 103000, tzinfo=timezone.utc),
)
self.assertEqual(
cve.last_modified,
datetime(2022, 11, 23, 16, 2, 7, 367000, tzinfo=timezone.utc),
)
self.assertEqual(len(cve.descriptions), 1)
self.assertEqual(len(cve.references), 2)
self.assertEqual(len(cve.weaknesses), 0)
self.assertEqual(len(cve.configurations), 0)
self.assertEqual(len(cve.vendor_comments), 0)
self.assertIsNone(cve.metrics)
self.assertIsNone(cve.evaluator_comment)
self.assertIsNone(cve.evaluator_solution)
self.assertIsNone(cve.evaluator_impact)
self.assertIsNone(cve.cisa_exploit_add)
self.assertIsNone(cve.cisa_action_due)
self.assertIsNone(cve.cisa_required_action)
self.assertIsNone(cve.cisa_vulnerability_name)
def test_descriptions(self):
cve = CVE.from_dict(get_cve_data())
description = cve.descriptions[0]
self.assertEqual(description.lang, "en")
self.assertEqual(
description.value,
"AeroCMS v0.0.1 was discovered to contain a SQL "
"Injection vulnerability via the id parameter at "
"\\admin\\post_comments.php. This vulnerability allows "
"attackers to access database information.",
)
def test_references(self):
cve = CVE.from_dict(get_cve_data())
reference = cve.references[0]
self.assertEqual(
reference.url,
"https://github.com/rdyx0/CVE/blob/master/AeroCMS/AeroCMS-v0.0.1-SQLi/post_comments_sql_injection/post_comments_sql_injection.md",
)
self.assertEqual(reference.source, "cve@mitre.org")
self.assertEqual(reference.tags, ["Exploit", "Third Party Advisory"])
reference = cve.references[1]
self.assertEqual(
reference.url,
"https://rdyx0.github.io/2018/09/07/AeroCMS-v0.0.1-SQLi%20post_comments_sql_injection/",
)
self.assertEqual(reference.source, "cve@mitre.org")
self.assertEqual(reference.tags, ["Exploit", "Third Party Advisory"])
def test_weaknesses(self):
cve = CVE.from_dict(
get_cve_data(
{
"weaknesses": [
{
"source": "nvd@nist.gov",
"type": "Primary",
"description": [{"lang": "en", "value": "CWE-89"}],
}
],
}
)
)
self.assertEqual(len(cve.weaknesses), 1)
weakness = cve.weaknesses[0]
self.assertEqual(weakness.source, "nvd@nist.gov")
self.assertEqual(weakness.type, "Primary")
self.assertEqual(len(weakness.description), 1)
description = weakness.description[0]
self.assertEqual(description.lang, "en")
self.assertEqual(description.value, "CWE-89")
def test_configuration(self):
cve = CVE.from_dict(
get_cve_data(
{
"configurations": [
{
"nodes": [
{
"operator": "OR",
"negate": False,
"cpe_match": [
{
"vulnerable": True,
"criteria": "cpe:2.3:a:aerocms_project:aerocms:0.0.1:*:*:*:*:*:*:*",
"match_criteria_id": "52639E84-244D-4DA3-B1AE-6D8BA1C38863",
}
],
}
]
}
],
}
)
)
self.assertEqual(len(cve.configurations), 1)
configuration = cve.configurations[0]
self.assertIsNone(configuration.operator)
self.assertIsNone(configuration.negate)
self.assertEqual(len(configuration.nodes), 1)
node = configuration.nodes[0]
self.assertFalse(node.negate)
self.assertEqual(node.operator, Operator.OR)
self.assertEqual(len(node.cpe_match), 1)
cpe_match = node.cpe_match[0]
self.assertTrue(cpe_match.vulnerable)
self.assertEqual(
cpe_match.criteria,
"cpe:2.3:a:aerocms_project:aerocms:0.0.1:*:*:*:*:*:*:*",
)
self.assertEqual(
cpe_match.match_criteria_id, "52639E84-244D-4DA3-B1AE-6D8BA1C38863"
)
self.assertIsNone(cpe_match.version_start_including)
self.assertIsNone(cpe_match.version_start_excluding)
self.assertIsNone(cpe_match.version_end_including)
self.assertIsNone(cpe_match.version_end_excluding)
def test_metrics_v2(self):
cve = CVE.from_dict(
get_cve_data(
{
"metrics": {
"cvss_metric_v2": [
{
"source": "nvd@nist.gov",
"type": "Primary",
"cvss_data": {
"version": "2.0",
"vector_string": "AV:N/AC:M/Au:N/C:N/I:P/A:N",
"access_vector": "NETWORK",
"access_complexity": "MEDIUM",
"authentication": "NONE",
"confidentiality_impact": "NONE",
"integrity_impact": "PARTIAL",
"availability_impact": "NONE",
"base_score": 4.3,
"base_severity": "MEDIUM",
},
"exploitability_score": 8.6,
"impact_score": 2.9,
"ac_insuf_info": False,
"obtain_all_privilege": False,
"obtain_user_privilege": False,
"obtain_other_privilege": False,
"user_interaction_required": True,
}
]
}
}
)
)
self.assertEqual(len(cve.metrics.cvss_metric_v2), 1)
self.assertEqual(len(cve.metrics.cvss_metric_v30), 0)
self.assertEqual(len(cve.metrics.cvss_metric_v31), 0)
cvss_metric = cve.metrics.cvss_metric_v2[0]
self.assertEqual(cvss_metric.source, "nvd@nist.gov")
self.assertEqual(cvss_metric.type, CVSSType.PRIMARY)
self.assertEqual(cvss_metric.exploitability_score, 8.6)
self.assertEqual(cvss_metric.impact_score, 2.9)
self.assertFalse(cvss_metric.ac_insuf_info)
self.assertFalse(cvss_metric.obtain_all_privilege)
self.assertFalse(cvss_metric.obtain_user_privilege)
self.assertFalse(cvss_metric.obtain_other_privilege)
self.assertTrue(cvss_metric.user_interaction_required)
cvss_data = cvss_metric.cvss_data
self.assertEqual(cvss_data.version, "2.0")
self.assertEqual(cvss_data.vector_string, "AV:N/AC:M/Au:N/C:N/I:P/A:N")
self.assertEqual(cvss_data.base_score, 4.3)
self.assertEqual(cvss_data.access_vector, cvss_v2.AccessVector.NETWORK)
self.assertEqual(
cvss_data.access_complexity, cvss_v2.AccessComplexity.MEDIUM
)
self.assertEqual(cvss_data.authentication, cvss_v2.Authentication.NONE)
self.assertEqual(cvss_data.confidentiality_impact, cvss_v2.Impact.NONE)
self.assertEqual(cvss_data.integrity_impact, cvss_v2.Impact.PARTIAL)
self.assertEqual(cvss_data.availability_impact, cvss_v2.Impact.NONE)
self.assertIsNone(cvss_data.exploitability)
self.assertIsNone(cvss_data.remediation_level)
self.assertIsNone(cvss_data.report_confidence)
self.assertIsNone(cvss_data.temporal_score)
self.assertIsNone(cvss_data.collateral_damage_potential)
self.assertIsNone(cvss_data.target_distribution)
self.assertIsNone(cvss_data.confidentiality_requirement)
self.assertIsNone(cvss_data.integrity_requirement)
self.assertIsNone(cvss_data.availability_requirement)
self.assertIsNone(cvss_data.environmental_score)
def test_metrics_v30(self):
cve = CVE.from_dict(
get_cve_data(
{
"metrics": {
"cvss_metric_v30": [
{
"source": "nvd@nist.gov",
"type": "Primary",
"cvss_data": {
"version": "3.0",
"vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:R/S:C/C:L/I:L/A:N",
"attack_vector": "NETWORK",
"attack_complexity": "LOW",
"privileges_required": "NONE",
"user_interaction": "REQUIRED",
"scope": "CHANGED",
"confidentiality_impact": "LOW",
"integrity_impact": "LOW",
"availability_impact": "NONE",
"base_score": 6.1,
"base_severity": "MEDIUM",
},
"exploitability_score": 2.8,
"impact_score": 2.7,
}
],
}
}
)
)
self.assertEqual(len(cve.metrics.cvss_metric_v2), 0)
self.assertEqual(len(cve.metrics.cvss_metric_v30), 1)
self.assertEqual(len(cve.metrics.cvss_metric_v31), 0)
cvss_metric = cve.metrics.cvss_metric_v30[0]
self.assertEqual(cvss_metric.source, "nvd@nist.gov")
self.assertEqual(cvss_metric.type, CVSSType.PRIMARY)
self.assertEqual(cvss_metric.exploitability_score, 2.8)
self.assertEqual(cvss_metric.impact_score, 2.7)
cvss_data = cvss_metric.cvss_data
self.assertEqual(cvss_data.version, "3.0")
self.assertEqual(
cvss_data.vector_string,
"CVSS:3.0/AV:N/AC:L/PR:N/UI:R/S:C/C:L/I:L/A:N",
)
self.assertEqual(cvss_data.base_score, 6.1)
self.assertEqual(cvss_data.base_severity, cvss_v3.Severity.MEDIUM)
self.assertEqual(cvss_data.attack_vector, cvss_v3.AttackVector.NETWORK)
self.assertEqual(
cvss_data.attack_complexity, cvss_v3.AttackComplexity.LOW
)
self.assertEqual(
cvss_data.privileges_required, cvss_v3.PrivilegesRequired.NONE
)
self.assertEqual(
cvss_data.user_interaction, cvss_v3.UserInteraction.REQUIRED
)
self.assertEqual(cvss_data.scope, cvss_v3.Scope.CHANGED)
self.assertEqual(cvss_data.confidentiality_impact, cvss_v3.Impact.LOW)
self.assertEqual(cvss_data.integrity_impact, cvss_v3.Impact.LOW)
self.assertEqual(cvss_data.availability_impact, cvss_v3.Impact.NONE)
self.assertIsNone(cvss_data.exploit_code_maturity)
self.assertIsNone(cvss_data.remediation_level)
self.assertIsNone(cvss_data.report_confidence)
self.assertIsNone(cvss_data.temporal_score)
self.assertIsNone(cvss_data.temporal_severity)
self.assertIsNone(cvss_data.confidentiality_requirement)
self.assertIsNone(cvss_data.integrity_requirement)
self.assertIsNone(cvss_data.availability_requirement)
self.assertIsNone(cvss_data.modified_attack_vector)
self.assertIsNone(cvss_data.modified_attack_complexity)
self.assertIsNone(cvss_data.modified_privileges_required)
self.assertIsNone(cvss_data.modified_user_interaction)
self.assertIsNone(cvss_data.modified_scope)
self.assertIsNone(cvss_data.modified_confidentiality_impact)
self.assertIsNone(cvss_data.modified_integrity_impact)
self.assertIsNone(cvss_data.modified_availability_impact)
self.assertIsNone(cvss_data.environmental_score)
self.assertIsNone(cvss_data.environmental_severity)
def test_metrics_v31(self):
cve = CVE.from_dict(
get_cve_data(
{
"metrics": {
"cvss_metric_v31": [
{
"source": "nvd@nist.gov",
"type": "Primary",
"cvss_data": {
"version": "3.1",
"vector_string": "CVSS:3.1/AV:N/AC:L/PR:H/UI:N/S:U/C:H/I:N/A:N",
"attack_vector": "NETWORK",
"attack_complexity": "LOW",
"privileges_required": "HIGH",
"user_interaction": "NONE",
"scope": "UNCHANGED",
"confidentiality_impact": "HIGH",
"integrity_impact": "NONE",
"availability_impact": "NONE",
"base_score": 4.9,
"base_severity": "MEDIUM",
},
"exploitability_score": 1.2,
"impact_score": 3.6,
}
]
},
}
)
)
self.assertEqual(len(cve.metrics.cvss_metric_v2), 0)
self.assertEqual(len(cve.metrics.cvss_metric_v30), 0)
self.assertEqual(len(cve.metrics.cvss_metric_v31), 1)
cvss_metric = cve.metrics.cvss_metric_v31[0]
self.assertEqual(cvss_metric.source, "nvd@nist.gov")
self.assertEqual(cvss_metric.type, CVSSType.PRIMARY)
self.assertEqual(cvss_metric.exploitability_score, 1.2)
self.assertEqual(cvss_metric.impact_score, 3.6)
cvss_data = cvss_metric.cvss_data
self.assertEqual(cvss_data.version, "3.1")
self.assertEqual(
cvss_data.vector_string,
"CVSS:3.1/AV:N/AC:L/PR:H/UI:N/S:U/C:H/I:N/A:N",
)
self.assertEqual(cvss_data.base_score, 4.9)
self.assertEqual(cvss_data.base_severity, cvss_v3.Severity.MEDIUM)
self.assertEqual(cvss_data.attack_vector, cvss_v3.AttackVector.NETWORK)
self.assertEqual(
cvss_data.attack_complexity, cvss_v3.AttackComplexity.LOW
)
self.assertEqual(
cvss_data.privileges_required, cvss_v3.PrivilegesRequired.HIGH
)
self.assertEqual(
cvss_data.user_interaction, cvss_v3.UserInteraction.NONE
)
self.assertEqual(cvss_data.scope, cvss_v3.Scope.UNCHANGED)
self.assertEqual(cvss_data.confidentiality_impact, cvss_v3.Impact.HIGH)
self.assertEqual(cvss_data.integrity_impact, cvss_v3.Impact.NONE)
self.assertEqual(cvss_data.availability_impact, cvss_v3.Impact.NONE)
self.assertIsNone(cvss_data.exploit_code_maturity)
self.assertIsNone(cvss_data.remediation_level)
self.assertIsNone(cvss_data.report_confidence)
self.assertIsNone(cvss_data.temporal_score)
self.assertIsNone(cvss_data.temporal_severity)
self.assertIsNone(cvss_data.confidentiality_requirement)
self.assertIsNone(cvss_data.integrity_requirement)
self.assertIsNone(cvss_data.availability_requirement)
self.assertIsNone(cvss_data.modified_attack_vector)
self.assertIsNone(cvss_data.modified_attack_complexity)
self.assertIsNone(cvss_data.modified_privileges_required)
self.assertIsNone(cvss_data.modified_user_interaction)
self.assertIsNone(cvss_data.modified_scope)
self.assertIsNone(cvss_data.modified_confidentiality_impact)
self.assertIsNone(cvss_data.modified_integrity_impact)
self.assertIsNone(cvss_data.modified_availability_impact)
self.assertIsNone(cvss_data.environmental_score)
self.assertIsNone(cvss_data.environmental_severity)
def test_metrics_v31_severity_none(self):
cve = CVE.from_dict(
get_cve_data(
{
"metrics": {
"cvss_metric_v31": [
{
"source": "nvd@nist.gov",
"type": "Secondary",
"cvss_data": {
"version": "3.1",
"vector_string": "CVSS:3.1/AV:N/AC:L/PR:H/UI:R/S:U/C:N/I:N/A:N",
"attack_vector": "NETWORK",
"attack_complexity": "LOW",
"privileges_required": "NONE",
"user_interaction": "REQUIRED",
"scope": "UNCHANGED",
"confidentiality_impact": "NONE",
"integrity_impact": "NONE",
"availability_impact": "NONE",
"base_score": 0.0,
"base_severity": "NONE",
},
"exploitability_score": 2.8,
"impact_score": 0.0,
}
]
},
}
)
)
self.assertEqual(len(cve.metrics.cvss_metric_v2), 0)
self.assertEqual(len(cve.metrics.cvss_metric_v30), 0)
self.assertEqual(len(cve.metrics.cvss_metric_v31), 1)
cvss_metric = cve.metrics.cvss_metric_v31[0]
self.assertEqual(cvss_metric.source, "nvd@nist.gov")
self.assertEqual(cvss_metric.type, CVSSType.SECONDARY)
self.assertEqual(cvss_metric.exploitability_score, 2.8)
self.assertEqual(cvss_metric.impact_score, 0.0)
cvss_data = cvss_metric.cvss_data
self.assertEqual(cvss_data.version, "3.1")
self.assertEqual(
cvss_data.vector_string,
"CVSS:3.1/AV:N/AC:L/PR:H/UI:R/S:U/C:N/I:N/A:N",
)
self.assertEqual(cvss_data.base_score, 0.0)
self.assertEqual(cvss_data.base_severity, cvss_v3.Severity.NONE)
self.assertEqual(cvss_data.attack_vector, cvss_v3.AttackVector.NETWORK)
self.assertEqual(
cvss_data.attack_complexity, cvss_v3.AttackComplexity.LOW
)
self.assertEqual(
cvss_data.privileges_required, cvss_v3.PrivilegesRequired.NONE
)
self.assertEqual(
cvss_data.user_interaction, cvss_v3.UserInteraction.REQUIRED
)
self.assertEqual(cvss_data.scope, cvss_v3.Scope.UNCHANGED)
self.assertEqual(cvss_data.confidentiality_impact, cvss_v3.Impact.NONE)
self.assertEqual(cvss_data.integrity_impact, cvss_v3.Impact.NONE)
self.assertEqual(cvss_data.availability_impact, cvss_v3.Impact.NONE)
self.assertIsNone(cvss_data.exploit_code_maturity)
self.assertIsNone(cvss_data.remediation_level)
self.assertIsNone(cvss_data.report_confidence)
self.assertIsNone(cvss_data.temporal_score)
self.assertIsNone(cvss_data.temporal_severity)
self.assertIsNone(cvss_data.confidentiality_requirement)
self.assertIsNone(cvss_data.integrity_requirement)
self.assertIsNone(cvss_data.availability_requirement)
self.assertIsNone(cvss_data.modified_attack_vector)
self.assertIsNone(cvss_data.modified_attack_complexity)
self.assertIsNone(cvss_data.modified_privileges_required)
self.assertIsNone(cvss_data.modified_user_interaction)
self.assertIsNone(cvss_data.modified_scope)
self.assertIsNone(cvss_data.modified_confidentiality_impact)
self.assertIsNone(cvss_data.modified_integrity_impact)
self.assertIsNone(cvss_data.modified_availability_impact)
self.assertIsNone(cvss_data.environmental_score)
self.assertIsNone(cvss_data.environmental_severity)
def test_vendor_comments(self):
cve = CVE.from_dict(
get_cve_data(
{
"vendor_comments": [
{
"organization": "Apache",
"comment": "Fixed in Apache HTTP Server 1.3.12:\nhttp://httpd.apache.org/security/vulnerabilities_13.html",
"last_modified": "2008-07-02T00:00:00",
}
],
}
)
)
self.assertEqual(len(cve.vendor_comments), 1)
comment = cve.vendor_comments[0]
self.assertEqual(comment.organization, "Apache")
self.assertEqual(
comment.comment,
"Fixed in Apache HTTP Server 1.3.12:\nhttp://httpd.apache.org/security/vulnerabilities_13.html",
)
self.assertEqual(
comment.last_modified, datetime(2008, 7, 2, tzinfo=timezone.utc)
)
def test_evaluator_comment(self):
cve = CVE.from_dict(
get_cve_data(
{
"evaluator_comment": "Please see the following link for more information:\r\n\r\nhttp://seclists.org/bugtraq/1999/Jan/0215.html"
}
)
)
self.assertEqual(
cve.evaluator_comment,
"Please see the following link for more information:\r\n\r\nhttp://seclists.org/bugtraq/1999/Jan/0215.html",
)
def test_evaluator_solution(self):
cve = CVE.from_dict(
get_cve_data(
{
"evaluator_solution": "This problem was fixed in Linux kernel 2.2.4 and later releases."
}
)
)
self.assertEqual(
cve.evaluator_solution,
"This problem was fixed in Linux kernel 2.2.4 and later releases.",
)
def test_evaluator_impact(self):
cve = CVE.from_dict(
get_cve_data(
{
"evaluator_impact": "This Common Vulnerabilities and Exposures (CVE) entry is a configuration issue and not a software flaw. As such, it doesn’t fit in the CVE software flaw list. The Common Vulnerability Scoring System (CVSS) base score for this CVE entry has been set to 0 because this CVE entry has no impact as a software flaw according to CVSS. This does not mean that the configuration issue is not important and there may be security implications relative to computers having this configuration."
}
)
)
self.assertEqual(
cve.evaluator_impact,
"This Common Vulnerabilities and Exposures (CVE) entry is a configuration issue and not a software flaw. As such, it doesn’t fit in the CVE software flaw list. The Common Vulnerability Scoring System (CVSS) base score for this CVE entry has been set to 0 because this CVE entry has no impact as a software flaw according to CVSS. This does not mean that the configuration issue is not important and there may be security implications relative to computers having this configuration.",
)
def test_cisa(self):
cve = CVE.from_dict(
get_cve_data(
{
"cisa_exploit_add": "2022-03-03",
"cisa_action_due": "2022-03-24",
"cisa_required_action": "Apply updates per vendor instructions.",
"cisa_vulnerability_name": "Microsoft Windows Privilege Escalation Vulnerability",
}
)
)
self.assertEqual(cve.cisa_action_due, date(2022, 3, 24))
self.assertEqual(cve.cisa_exploit_add, date(2022, 3, 3))
self.assertEqual(
cve.cisa_required_action, "Apply updates per vendor instructions."
)
self.assertEqual(
cve.cisa_vulnerability_name,
"Microsoft Windows Privilege Escalation Vulnerability",
)
pontos-25.3.2/tests/nvd/models/test_cve_change.py 0000664 0000000 0000000 00000004016 14762555663 0022060 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
# pylint: disable=line-too-long
# ruff: noqa: E501
import unittest
from datetime import datetime, timezone
from uuid import UUID
from pontos.nvd.models.cve_change import CVEChange, Detail, EventName
from tests.nvd import get_cve_change_data
class CVEChangeTestCase(unittest.TestCase):
def test_required_only(self):
cve_change = CVEChange.from_dict(get_cve_change_data())
self.assertEqual(cve_change.cve_id, "CVE-2022-0001")
self.assertEqual(cve_change.event_name, "Initial Analysis")
self.assertEqual(
cve_change.cve_change_id,
UUID("5160FDEB-0FF0-457B-AA36-0AEDCAB2522E"),
)
self.assertEqual(cve_change.source_identifier, "nvd@nist.gov")
self.assertEqual(
cve_change.created,
datetime(2022, 3, 18, 20, 13, 8, 123000, tzinfo=timezone.utc),
)
self.assertEqual(
cve_change.details,
[
Detail(
action="Added",
type="CVSS V2",
new_value="NIST (AV:L/AC:L/Au:N/C:P/I:N/A:N)",
),
Detail(
action="Added",
type="CVSS V3.1",
new_value="NIST AV:L/AC:L/PR:L/UI:N/S:C/C:H/I:N/A:N",
),
Detail(
action="Changed",
type="Reference Type",
old_value="http://www.openwall.com/lists/oss-security/2022/03/18/2 No Types Assigned",
new_value="http://www.openwall.com/lists/oss-security/2022/03/18/2 Mailing List, Third Party Advisory",
),
],
)
class EventNameTestCase(unittest.TestCase):
def test_init(self):
self.assertEqual(
EventName("Initial Analysis"), EventName.INITIAL_ANALYSIS
)
def test__str__(self):
self.assertEqual(str(EventName.INITIAL_ANALYSIS), "Initial Analysis")
pontos-25.3.2/tests/nvd/source/ 0000775 0000000 0000000 00000000000 14762555663 0016401 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/nvd/source/__init__.py 0000664 0000000 0000000 00000000132 14762555663 0020506 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
pontos-25.3.2/tests/nvd/source/test_api.py 0000664 0000000 0000000 00000014016 14762555663 0020565 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
from datetime import datetime, timezone
from typing import Any, Optional
from unittest.mock import MagicMock, patch
from httpx import AsyncClient, Response
from pontos.nvd.models.source import AcceptanceLevel
from pontos.nvd.source.api import MAX_SOURCES_PER_PAGE, SourceApi
from tests import AsyncMock, IsolatedAsyncioTestCase, aiter, anext
from tests.nvd import get_source_data
def create_source_response(
name: str, update: Optional[dict[str, Any]] = None
) -> MagicMock:
data = {
"sources": [get_source_data({"name": name})],
"results_per_page": 1,
}
if update:
data.update(update)
response = MagicMock(spec=Response)
response.json.return_value = data
return response
def create_source_responses(count: int = 2) -> list[MagicMock]:
return [
create_source_response(f"MITRE-{i}", {"total_results": count})
for i in range(1, count + 1)
]
class SourceAPITestCase(IsolatedAsyncioTestCase):
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
def setUp(self, async_client: MagicMock) -> None:
self.http_client = AsyncMock()
async_client.return_value = self.http_client
self.api = SourceApi(token="token")
async def test_sources(self):
self.http_client.get.side_effect = create_source_responses()
it = aiter(self.api.sources())
source = await anext(it)
self.assertEqual(source.name, "MITRE-1")
self.assertEqual(
source.contact_email,
"cve@mitre.org",
)
self.assertEqual(
source.source_identifiers,
[
"cve@mitre.org",
"8254265b-2729-46b6-b9e3-3dfca2d5bfca",
],
)
self.assertEqual(
source.last_modified,
datetime(2019, 9, 9, 16, 18, 45, 930000, tzinfo=timezone.utc),
)
self.assertEqual(
source.created,
datetime(2019, 9, 9, 16, 18, 45, 930000, tzinfo=timezone.utc),
)
self.assertIsNone(source.v2_acceptance_level)
self.assertEqual(
source.v3_acceptance_level,
AcceptanceLevel(
"Contributor",
datetime(2025, 1, 30, 0, 0, 20, 107000, tzinfo=timezone.utc),
),
)
self.assertEqual(
source.cwe_acceptance_level,
AcceptanceLevel(
"Reference",
datetime(2025, 1, 24, 0, 0, 0, 43000, tzinfo=timezone.utc),
),
)
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/source/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"resultsPerPage": MAX_SOURCES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
source = await anext(it)
self.assertEqual(source.name, "MITRE-2")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/source/2.0",
headers={"apiKey": "token"},
params={"startIndex": 1, "resultsPerPage": 1},
)
with self.assertRaises(StopAsyncIteration):
await anext(it)
async def test_sources_change_dates(self):
self.http_client.get.side_effect = create_source_responses()
it = aiter(
self.api.sources(
last_modified_start_date=datetime(2025, 1, 1),
last_modified_end_date=datetime(2025, 1, 31),
)
)
source = await anext(it)
self.assertEqual(source.name, "MITRE-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/source/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"lastModStartDate": "2025-01-01T00:00:00",
"lastModEndDate": "2025-01-31T00:00:00",
"resultsPerPage": MAX_SOURCES_PER_PAGE,
},
)
self.http_client.get.reset_mock()
source = await anext(it)
self.assertEqual(source.name, "MITRE-2")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/source/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"lastModStartDate": "2025-01-01T00:00:00",
"lastModEndDate": "2025-01-31T00:00:00",
"resultsPerPage": 1,
},
)
with self.assertRaises(StopAsyncIteration):
source = await anext(it)
async def test_sources_source_identifier(self):
self.http_client.get.side_effect = create_source_responses()
it = aiter(self.api.sources(source_identifier="cve@mitre.org"))
source = await anext(it)
self.assertEqual(source.name, "MITRE-1")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/source/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 0,
"resultsPerPage": MAX_SOURCES_PER_PAGE,
"sourceIdentifier": "cve@mitre.org",
},
)
self.http_client.get.reset_mock()
source = await anext(it)
self.assertEqual(source.name, "MITRE-2")
self.http_client.get.assert_awaited_once_with(
"https://services.nvd.nist.gov/rest/json/source/2.0",
headers={"apiKey": "token"},
params={
"startIndex": 1,
"resultsPerPage": 1,
"sourceIdentifier": "cve@mitre.org",
},
)
with self.assertRaises(StopAsyncIteration):
await anext(it)
async def test_context_manager(self):
async with self.api:
pass
self.http_client.__aenter__.assert_awaited_once()
self.http_client.__aexit__.assert_awaited_once()
pontos-25.3.2/tests/nvd/test_api.py 0000664 0000000 0000000 00000042563 14762555663 0017275 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=protected-access
import unittest
from datetime import datetime
from typing import Any, Iterator
from unittest.mock import AsyncMock, MagicMock, call, patch
from httpx import AsyncClient, Response
from pontos.nvd.api import (
JSON,
InvalidState,
NoMoreResults,
NVDApi,
NVDResults,
convert_camel_case,
format_date,
)
from tests import IsolatedAsyncioTestCase, aiter, anext
class ConvertCamelCaseTestCase(unittest.TestCase):
def test_convert(self):
data = {
"someValue": 123,
"otherValue": "bar",
}
converted = convert_camel_case(data)
self.assertEqual(converted["some_value"], 123)
self.assertEqual(converted["other_value"], "bar")
class FormatDateTestCase(unittest.TestCase):
def test_format_date(self):
dt = datetime(2022, 12, 10, 10, 0, 12, 123)
fd = format_date(dt)
self.assertEqual(fd, "2022-12-10T10:00:12")
class NVDApiTestCase(IsolatedAsyncioTestCase):
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
async def test_context_manager(self, async_client: MagicMock):
http_client = AsyncMock()
async_client.return_value = http_client
api = NVDApi("https://foo.bar/baz", token="token")
async with api:
pass
http_client.__aenter__.assert_awaited_once()
http_client.__aexit__.assert_awaited_once()
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
async def test_get_without_token(self, async_client: MagicMock):
http_client = AsyncMock()
async_client.return_value = http_client
api = NVDApi("https://foo.bar/baz")
await api._get()
http_client.get.assert_awaited_once_with(
"https://foo.bar/baz", headers={}, params=None
)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
async def test_get_with_token(self, async_client: MagicMock):
http_client = AsyncMock()
async_client.return_value = http_client
api = NVDApi("https://foo.bar/baz", token="token")
await api._get()
http_client.get.assert_awaited_once_with(
"https://foo.bar/baz", headers={"apiKey": "token"}, params=None
)
@patch("pontos.nvd.api.time.monotonic", autospec=True)
@patch("pontos.nvd.api.asyncio.sleep", autospec=True)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
async def test_rate_limit(
self,
async_client: MagicMock,
sleep_mock: MagicMock,
monotonic_mock: MagicMock,
):
http_client = AsyncMock()
async_client.return_value = http_client
monotonic_mock.side_effect = [0.0, 10.0, 11.0]
api = NVDApi("https://foo.bar/baz")
await api._get()
await api._get()
await api._get()
await api._get()
await api._get()
sleep_mock.assert_not_called()
await api._get()
sleep_mock.assert_called_once_with(20.0)
@patch("pontos.nvd.api.asyncio.sleep", autospec=True)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
async def test_no_rate_limit(
self, async_client: MagicMock, sleep_mock: MagicMock
):
http_client = AsyncMock()
async_client.return_value = http_client
api = NVDApi("https://foo.bar/baz", rate_limit=False)
await api._get()
await api._get()
await api._get()
await api._get()
await api._get()
sleep_mock.assert_not_called()
await api._get()
sleep_mock.assert_not_called()
@patch("pontos.nvd.api.asyncio.sleep", autospec=True)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
async def test_retry(
self,
async_client: MagicMock,
sleep_mock: MagicMock,
):
response_mocks = [
MagicMock(spec=Response, is_server_error=True),
MagicMock(spec=Response, is_server_error=True),
MagicMock(spec=Response, is_server_error=True),
MagicMock(spec=Response, is_server_error=False),
]
http_client = AsyncMock()
http_client.get.side_effect = response_mocks
async_client.return_value = http_client
api = NVDApi("https://foo.bar/baz", request_attempts=4)
result = await api._get()
calls = [call(2.0), call(4.0), call(8.0)]
sleep_mock.assert_has_calls(calls)
self.assertFalse(result.is_server_error)
@patch("pontos.nvd.api.asyncio.sleep", autospec=True)
@patch("pontos.nvd.api.AsyncClient", spec=AsyncClient)
async def test_no_retry(
self,
async_client: MagicMock,
sleep_mock: MagicMock,
):
response_mock = MagicMock(spec=Response)
response_mock.is_server_error = False
http_client = AsyncMock()
http_client.get.return_value = response_mock
async_client.return_value = http_client
api = NVDApi("https://foo.bar/baz")
result = await api._get()
sleep_mock.assert_not_called()
self.assertFalse(result.is_server_error)
class Result:
def __init__(self, value: int) -> None:
self.value = value
def result_func(data: JSON) -> Iterator[Result]:
return (Result(d) for d in data["values"]) # type: ignore
class NVDResultsTestCase(IsolatedAsyncioTestCase):
async def test_items(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3],
"total_results": 6,
"results_per_page": 3,
},
{
"values": [4, 5, 6],
"total_results": 6,
"results_per_page": 3,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
it = aiter(results.items())
result = await anext(it)
self.assertEqual(result.value, 1)
result = await anext(it)
self.assertEqual(result.value, 2)
result = await anext(it)
self.assertEqual(result.value, 3)
result = await anext(it)
self.assertEqual(result.value, 4)
result = await anext(it)
self.assertEqual(result.value, 5)
result = await anext(it)
self.assertEqual(result.value, 6)
with self.assertRaises(StopAsyncIteration):
await anext(it)
async def test_items_no_results(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [],
"total_results": 0,
"results_per_page": 0,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
it = aiter(results.items())
with self.assertRaises(StopAsyncIteration):
await anext(it)
async def test_aiter(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3],
"total_results": 6,
"results_per_page": 3,
},
{
"values": [4, 5, 6],
"total_results": 6,
"results_per_page": 3,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
it = aiter(results)
result = await anext(it)
self.assertEqual(result.value, 1)
result = await anext(it)
self.assertEqual(result.value, 2)
result = await anext(it)
self.assertEqual(result.value, 3)
result = await anext(it)
self.assertEqual(result.value, 4)
result = await anext(it)
self.assertEqual(result.value, 5)
result = await anext(it)
self.assertEqual(result.value, 6)
with self.assertRaises(StopAsyncIteration):
await anext(it)
async def test_len(self):
response_mock = MagicMock(spec=Response)
response_mock.json.return_value = {
"values": [1, 2, 3],
"total_results": 3,
"results_per_page": 3,
}
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
with self.assertRaisesRegex(
InvalidState, "NVDResults has not been awaited yet"
):
len(results)
await results
self.assertEqual(len(results), 3)
async def test_chunks(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3],
"total_results": 6,
"results_per_page": 3,
},
{
"values": [4, 5, 6],
"total_results": 6,
"results_per_page": 3,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
nvd_results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
it = aiter(nvd_results.chunks())
results = await anext(it)
self.assertEqual([result.value for result in results], [1, 2, 3])
results = await anext(it)
self.assertEqual([result.value for result in results], [4, 5, 6])
with self.assertRaises(StopAsyncIteration):
await anext(it)
async def test_json(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3],
"total_results": 6,
"results_per_page": 3,
},
{
"values": [4, 5, 6],
"total_results": 6,
"results_per_page": 3,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
nvd_results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
json: dict[str, Any] = await nvd_results.json() # type: ignore
self.assertEqual(json["values"], [1, 2, 3])
self.assertEqual(json["total_results"], 6)
self.assertEqual(json["results_per_page"], 3)
json: dict[str, Any] = await nvd_results.json() # type: ignore
self.assertEqual(json["values"], [4, 5, 6])
self.assertEqual(json["total_results"], 6)
self.assertEqual(json["results_per_page"], 3)
self.assertIsNone(await nvd_results.json())
async def test_await(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3],
"total_results": 6,
"results_per_page": 3,
},
{
"values": [4, 5, 6],
"total_results": 6,
"results_per_page": 3,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
nvd_results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
await nvd_results
self.assertEqual(len(nvd_results), 6)
json: dict[str, Any] = await nvd_results.json() # type: ignore
self.assertEqual(json["values"], [1, 2, 3])
self.assertEqual(json["total_results"], 6)
self.assertEqual(json["results_per_page"], 3)
await nvd_results
json: dict[str, Any] = await nvd_results.json() # type: ignore
self.assertEqual(json["values"], [4, 5, 6])
self.assertEqual(json["total_results"], 6)
self.assertEqual(json["results_per_page"], 3)
with self.assertRaises(NoMoreResults):
await nvd_results
async def test_mix_and_match(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3],
"total_results": 6,
"results_per_page": 3,
},
{
"values": [4, 5, 6],
"total_results": 6,
"results_per_page": 3,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
nvd_results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
await nvd_results
self.assertEqual(len(nvd_results), 6)
json: dict[str, Any] = await nvd_results.json() # type: ignore
self.assertEqual(json["values"], [1, 2, 3])
self.assertEqual(json["total_results"], 6)
self.assertEqual(json["results_per_page"], 3)
self.assertEqual(
[result.value async for result in nvd_results], [1, 2, 3, 4, 5, 6]
)
json: dict[str, Any] = await nvd_results.json() # type: ignore
self.assertEqual(json["values"], [4, 5, 6])
self.assertEqual(json["total_results"], 6)
self.assertEqual(json["results_per_page"], 3)
async def test_response_error(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3],
"total_results": 6,
"results_per_page": 3,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
nvd_results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
json = await nvd_results.json()
self.assertEqual(json["values"], [1, 2, 3]) # type: ignore
api_mock._get.assert_called_once_with(params={"startIndex": 0})
response_mock.raise_for_status.side_effect = Exception("Server Error")
api_mock.reset_mock()
with self.assertRaises(Exception):
json = await nvd_results.json()
api_mock._get.assert_called_once_with(
params={
"startIndex": 3,
"resultsPerPage": 3,
}
)
response_mock.reset_mock(return_value=True, side_effect=True)
api_mock.reset_mock()
response_mock.json.side_effect = [
{
"values": [4, 5, 6],
"total_results": 6,
"results_per_page": 3,
},
]
json = await nvd_results.json()
self.assertEqual(json["values"], [4, 5, 6]) # type: ignore
api_mock._get.assert_called_once_with(
params={
"startIndex": 3,
"resultsPerPage": 3,
}
)
async def test_request_results_limit(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3, 4],
"total_results": 5,
"results_per_page": 4,
},
{
"values": [5],
"total_results": 5,
"results_per_page": 1,
},
]
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
nvd_results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
request_results=5,
)
json: dict[str, Any] = await nvd_results.json() # type: ignore
self.assertEqual(json["values"], [1, 2, 3, 4])
self.assertEqual(json["total_results"], 5)
self.assertEqual(json["results_per_page"], 4)
api_mock._get.assert_called_once_with(params={"startIndex": 0})
api_mock.reset_mock()
json: dict[str, Any] = await nvd_results.json() # type: ignore
self.assertEqual(json["values"], [5])
self.assertEqual(json["total_results"], 5)
self.assertEqual(json["results_per_page"], 1)
api_mock._get.assert_called_once_with(
params={"startIndex": 4, "resultsPerPage": 1}
)
async def test_repr(self):
response_mock = MagicMock(spec=Response)
response_mock.json.side_effect = [
{
"values": [1, 2, 3, 4],
"total_results": 5,
"results_per_page": 4,
},
{
"values": [5],
"total_results": 5,
"results_per_page": 1,
},
]
response_mock.url = "https://some.url&startIndex=0"
api_mock = AsyncMock(spec=NVDApi)
api_mock._get.return_value = response_mock
nvd_results: NVDResults[Result] = NVDResults(
api_mock,
{},
result_func,
)
await nvd_results
self.assertEqual(
repr(nvd_results),
'",
)
pontos-25.3.2/tests/release/ 0000775 0000000 0000000 00000000000 14762555663 0015732 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/release/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0020037 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/release/test_create.py 0000664 0000000 0000000 00000263401 14762555663 0020614 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=too-many-lines, line-too-long, invalid-name
import unittest
from contextlib import contextmanager
from dataclasses import dataclass
from datetime import datetime
from pathlib import Path
from typing import Iterable, Iterator, Optional, Union
from unittest.mock import AsyncMock, MagicMock, call, patch
from httpx import HTTPStatusError, Request, Response
from pontos.git import ConfigScope, Git, ResetMode, StatusEntry
from pontos.github.actions.errors import GitHubActionsError
from pontos.release.create import (
CreateReleaseCommand,
CreateReleaseReturnValue,
ReleaseInformation,
create_release,
)
from pontos.release.helper import ReleaseType
from pontos.release.main import parse_args
from pontos.terminal import Terminal
from pontos.testing import temp_directory, temp_git_repository
from pontos.version import VersionError, VersionUpdate
from pontos.version.commands import GoVersionCommand
from pontos.version.schemes._pep440 import PEP440Version, PEP440VersioningScheme
TOKEN = "foo"
REPOSITORY = "greenbone/foo"
GIT_SIGNING_KEY = "1234"
CHANGELOG = "A Changelog"
def mock_terminal() -> MagicMock:
return MagicMock(spec=Terminal)
def str_or_list(values: Union[str, Iterable[str]]) -> Iterable[str]:
if values and isinstance(values, str):
return [values]
return values
@contextmanager
def setup_go_project(
*, current_version: str, tags: Union[str, Iterable[str], None] = None
) -> Iterator[Path]:
with temp_git_repository() as tmp_git:
git = Git(tmp_git)
git.config("commit.gpgSign", "false", scope=ConfigScope.LOCAL)
git.config("tag.gpgSign", "false", scope=ConfigScope.LOCAL)
git.config("tag.sort", "refname", scope=ConfigScope.LOCAL)
git.add_remote("origin", "http://foo/bar.git")
go = GoVersionCommand(PEP440VersioningScheme)
go.project_file_path.touch()
update = go.update_version(new_version=PEP440Version(current_version))
git.add(update.changed_files)
git.add(go.project_file_path)
git.commit("Create initial release")
if tags:
for tag in str_or_list(tags):
git.tag(f"v{tag}")
yield tmp_git
class ReleaseInformationTestCase(unittest.TestCase):
def test_release_info(self):
release_info = ReleaseInformation(
last_release_version=PEP440Version.from_string("1.2.3"),
release_version=PEP440Version.from_string("2.0.0"),
git_release_tag="v2.0.0",
next_version=PEP440Version.from_string("2.0.1.dev1"),
)
self.assertEqual(
release_info.last_release_version,
PEP440Version.from_string("1.2.3"),
)
self.assertEqual(
release_info.release_version, PEP440Version.from_string("2.0.0")
)
self.assertEqual(release_info.git_release_tag, "v2.0.0")
self.assertEqual(
release_info.next_version, PEP440Version.from_string("2.0.1.dev1")
)
@patch.dict("os.environ", {}, clear=True)
def test_no_github_output(self):
release_info = ReleaseInformation(
last_release_version=PEP440Version.from_string("1.2.3"),
release_version=PEP440Version.from_string("2.0.0"),
git_release_tag="v2.0.0",
next_version=PEP440Version.from_string("2.0.1.dev1"),
)
with self.assertRaisesRegex(
GitHubActionsError,
"GITHUB_OUTPUT environment variable not set. Can't write "
"action output.",
):
release_info.write_github_output()
def test_github_output(self):
expected = """last-release-version=1.2.3
release-version=2.0.0
git-release-tag=v2.0.0
next-version=2.0.1.dev1
"""
with temp_directory() as temp_dir:
out_file = temp_dir / "out.txt"
with patch.dict(
"os.environ", {"GITHUB_OUTPUT": str(out_file.absolute())}
):
release_info = ReleaseInformation(
last_release_version=PEP440Version.from_string("1.2.3"),
release_version=PEP440Version.from_string("2.0.0"),
git_release_tag="v2.0.0",
next_version=PEP440Version.from_string("2.0.1.dev1"),
)
release_info.write_github_output()
self.assertTrue(out_file.exists())
actual = out_file.read_text(encoding="utf8")
self.assertEqual(actual, expected)
class CreateReleaseCommandTestCase(unittest.TestCase):
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_version(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2")
next_version = PEP440Version("1.0.0.dev1")
git_mock = MagicMock(spec=Git)
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
last_release_version=current_version,
next_version=PEP440Version("1.0.0.dev1"),
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
]
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 1.0.0.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_with_repository(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2")
next_version = PEP440Version("1.0.0.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository="foo/bar",
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
last_release_version=current_version,
next_version=next_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
]
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 1.0.0.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch("pontos.release.create.get_last_release_version", autospec=True)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_initial_release_version(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
get_last_release_version_mock: MagicMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("1.0.0")
next_version = PEP440Version("1.0.1.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
get_last_release_version_mock.return_value = None
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
]
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 1.0.0",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 1.0.1.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v1.0.0", gpg_key_id="1234", message="Automatic release to 1.0.0"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_patch(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2")
next_version = PEP440Version("0.0.3.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.PATCH,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.3.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_calendar(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
today = datetime.today()
current_version = PEP440Version("0.0.1")
release_version = PEP440Version(f"{today.year % 100}.{today.month}.0")
next_version = PEP440Version(f"{today.year % 100}.{today.month}.1.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.CALENDAR,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
]
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
f"Automatic release to {release_version}",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
f"* Update to version {next_version}\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
f"v{release_version}",
gpg_key_id="1234",
message=f"Automatic release to {release_version}",
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_minor(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.1.0")
next_version = PEP440Version("0.1.1.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MINOR,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.1.0",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.1.1.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.1.0", gpg_key_id="1234", message="Automatic release to 0.1.0"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_major(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("1.0.0")
next_version = PEP440Version("1.0.1.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MAJOR,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 1.0.0",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 1.0.1.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v1.0.0", gpg_key_id="1234", message="Automatic release to 1.0.0"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_alpha(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2a1")
next_version = PEP440Version("0.0.2a2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.ALPHA,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2a1",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.2a2.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.0.2a1",
gpg_key_id="1234",
message="Automatic release to 0.0.2a1",
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_beta(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2b1")
next_version = PEP440Version("0.0.2b2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.BETA,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2b1",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.2b2.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.0.2b1",
gpg_key_id="1234",
message="Automatic release to 0.0.2b1",
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_release_candidate(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2rc1")
next_version = PEP440Version("0.0.2rc2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.RELEASE_CANDIDATE,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2rc1",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.2rc2.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.0.2rc1",
gpg_key_id="1234",
message="Automatic release to 0.0.2rc1",
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
def test_invalid_repository(
self,
):
git_mock = MagicMock(spec=Git)
cmd = CreateReleaseCommand(
git=git_mock,
)
released = cmd.run(
token=TOKEN,
repository="foo/bar/baz",
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MAJOR,
)
self.assertEqual(released, CreateReleaseReturnValue.INVALID_REPOSITORY)
released = cmd.run(
token=TOKEN,
repository="foo_bar_baz",
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MAJOR,
)
self.assertEqual(released, CreateReleaseReturnValue.INVALID_REPOSITORY)
def test_no_project_settings(
self,
):
git_mock = MagicMock(spec=Git)
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=PEP440Version("0.0.1"),
last_release_version=PEP440Version("0.0.1"),
)
self.assertEqual(
released, CreateReleaseReturnValue.PROJECT_SETTINGS_NOT_FOUND
)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project", autospec=True)
def test_no_update_project(
self,
project_mock: MagicMock,
create_release_mock: AsyncMock,
):
release_version = PEP440Version("0.0.2")
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = []
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=PEP440Version("0.0.2"),
last_release_version=PEP440Version("0.0.1"),
next_version=PEP440Version("1.0.0.dev1"),
update_project=False,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_not_called()
git_mock.commit.assert_not_called()
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
project_mock.assert_not_called()
@patch("pontos.release.create.get_last_release_version", autospec=True)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_gather_last_release(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
get_last_release_version_mock: MagicMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("1.0.0")
next_version = PEP440Version("1.0.1.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
get_last_release_version_mock.return_value = current_version
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MAJOR,
next_version=PEP440VersioningScheme.parse_version("1.0.1.dev1"),
changelog=CHANGELOG,
)
get_last_release_version_mock.assert_called_once_with(
git=git_mock,
parse_version=PEP440VersioningScheme.parse_version,
git_tag_prefix="v",
tag_name=None,
ignore_pre_releases=True,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 1.0.0",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 1.0.1.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v1.0.0", gpg_key_id="1234", message="Automatic release to 1.0.0"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
def test_last_release_version_error(self):
git_mock = MagicMock(spec=Git)
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MAJOR,
)
self.assertEqual(
released, CreateReleaseReturnValue.NO_LAST_RELEASE_VERSION
)
@patch("pontos.release.create.get_last_release_version", autospec=True)
def test_no_last_release_version(
self,
get_last_release_version_mock: MagicMock,
):
get_last_release_version_mock.return_value = None
git_mock = MagicMock(spec=Git)
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MINOR,
)
self.assertEqual(
released, CreateReleaseReturnValue.NO_LAST_RELEASE_VERSION
)
@patch(
"pontos.release.create.get_next_release_version",
autospec=True,
)
def test_no_release_error(
self,
get_next_release_version_mock: MagicMock,
):
get_next_release_version_mock.side_effect = VersionError("An error")
git_mock = MagicMock(spec=Git)
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.PATCH,
last_release_version=PEP440Version("0.0.1"),
)
self.assertEqual(released, CreateReleaseReturnValue.NO_RELEASE_VERSION)
def test_has_tag(
self,
):
tags = ["v1.0.0", "v1.0.1"]
git_mock = MagicMock(spec=Git)
git_mock.list_tags.return_value = tags
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=PEP440Version("1.0.1"),
)
self.assertEqual(released, CreateReleaseReturnValue.ALREADY_TAKEN)
self.assertEqual(git_mock.list_tags.call_count, 2)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_update_version_error(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = VersionError("An error")
git_mock = MagicMock(spec=Git)
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=PEP440Version("0.0.1"),
next_version=PEP440Version("0.0.2.dev1"),
last_release_version=PEP440Version("0.0.1rc1"),
)
git_mock.return_value.push.assert_not_called()
command_mock.update_version.assert_called_once_with(
PEP440Version("0.0.1"), force=False
)
create_release_mock.assert_not_awaited()
git_mock.return_value.add.assert_not_called()
git_mock.return_value.commit.assert_not_called()
git_mock.return_value.tag.assert_not_called()
self.assertEqual(
released, CreateReleaseReturnValue.UPDATE_VERSION_ERROR
)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_github_create_release_failure(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.0")
release_version = PEP440Version("0.0.1")
next_version = PEP440Version("0.0.2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
create_release_mock.side_effect = HTTPStatusError(
"Error during a request",
request=MagicMock(spec=Request),
response=MagicMock(spec=Response),
)
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
gather_commands_mock.return_value = [command_mock]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
changelog=CHANGELOG,
)
self.assertEqual(
released, CreateReleaseReturnValue.CREATE_RELEASE_ERROR
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call("v0.0.1", delete=True, remote=None),
call(force=True, remote=None),
]
)
git_mock.reset.assert_called_once_with("HEAD^", mode=ResetMode.HARD)
git_mock.delete_tag.assert_called_once_with("v0.0.1")
git_mock.add.assert_called_once_with(Path("MyProject.conf"))
git_mock.commit.assert_called_once_with(
"Automatic release to 0.0.1", verify=False, gpg_signing_key="1234"
)
git_mock.tag.assert_called_once_with(
"v0.0.1", gpg_key_id="1234", message="Automatic release to 0.0.1"
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_update_version_after_release_error(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.0")
release_version = PEP440Version("0.0.1")
next_version = PEP440Version("0.0.2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionError("An error"),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_called_once_with(follow_tags=True, remote=None)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
]
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_called_once_with(Path("MyProject.conf"))
git_mock.commit.assert_called_once_with(
"Automatic release to 0.0.1", verify=False, gpg_signing_key="1234"
)
git_mock.tag.assert_called_once_with(
"v0.0.1", gpg_key_id="1234", message="Automatic release to 0.0.1"
)
self.assertEqual(
released,
CreateReleaseReturnValue.UPDATE_VERSION_AFTER_RELEASE_ERROR,
)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_to_specific_git_remote(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.0")
release_version = PEP440Version("0.0.1")
next_version = PEP440Version("0.0.2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
git_remote_name="upstream",
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote="upstream"),
call(follow_tags=True, remote="upstream"),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
git_mock.add.assert_called_with(Path("MyProject.conf"))
git_mock.commit.assert_called_with(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.2.dev1\n",
verify=False,
gpg_signing_key="1234",
)
git_mock.tag.assert_called_once_with(
"v0.0.1", gpg_key_id="1234", message="Automatic release to 0.0.1"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_without_git_prefix(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.0")
release_version = PEP440Version("0.0.1")
next_version = PEP440Version("0.0.2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
git_tag_prefix="",
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
git_mock.add.assert_called_with(Path("MyProject.conf"))
git_mock.commit.assert_called_with(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.2.dev1\n",
verify=False,
gpg_signing_key="1234",
)
git_mock.tag.assert_called_once_with(
"0.0.1", gpg_key_id="1234", message="Automatic release to 0.0.1"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch("pontos.release.create.GitHubAsyncRESTApi", autospec=True)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_github_api(
self,
gather_commands_mock: MagicMock,
github_api_mock: AsyncMock,
):
current_version = PEP440Version("0.0.0")
release_version = PEP440Version("0.0.1")
next_version = PEP440Version("0.0.2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
create_api_mock = AsyncMock()
github_api_mock.return_value.releases.create = create_api_mock
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository="bar/foo",
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
git_remote_name="upstream",
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote="upstream"),
call(follow_tags=True, remote="upstream"),
],
)
create_api_mock.assert_awaited_once_with(
"bar/foo",
"v0.0.1",
name="foo 0.0.1",
body="A Changelog",
prerelease=False,
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
git_mock.add.assert_called_with(Path("MyProject.conf"))
git_mock.commit.assert_called_with(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.2.dev1\n",
verify=False,
gpg_signing_key="1234",
)
git_mock.tag.assert_called_once_with(
"v0.0.1", gpg_key_id="1234", message="Automatic release to 0.0.1"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch("pontos.release.create.GitHubAsyncRESTApi", autospec=True)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_github_api_pre_release(
self,
gather_commands_mock: MagicMock,
github_api_mock: AsyncMock,
):
current_version = PEP440Version("0.0.0")
release_version = PEP440Version("0.0.1a1")
next_version = PEP440Version("0.0.1a1+dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
create_api_mock = AsyncMock()
github_api_mock.return_value.releases.create = create_api_mock
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository="bar/foo",
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
git_remote_name="upstream",
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote="upstream"),
call(follow_tags=True, remote="upstream"),
],
)
create_api_mock.assert_awaited_once_with(
"bar/foo",
"v0.0.1a1",
name="foo 0.0.1a1",
body="A Changelog",
prerelease=True,
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
git_mock.add.assert_called_with(Path("MyProject.conf"))
git_mock.commit.assert_called_with(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.1a1+dev1\n",
verify=False,
gpg_signing_key="1234",
)
git_mock.tag.assert_called_once_with(
"v0.0.1a1",
gpg_key_id="1234",
message="Automatic release to 0.0.1a1",
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
def test_release_with_go_project(
self,
create_release_mock: AsyncMock,
):
release_version = PEP440Version("0.0.2")
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [
StatusEntry(f"M {GoVersionCommand.version_file_path}")
]
git_mock.list_tags.return_value = ["v0.0.1"]
with setup_go_project(current_version="0.0.1", tags=["0.0.1"]):
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository="foo/bar",
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.PATCH,
changelog=CHANGELOG,
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
git_mock.push.assert_called_with(follow_tags=True, remote=None)
git_mock.add.assert_called_with(GoVersionCommand.version_file_path)
git_mock.commit.assert_called_with(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.3.dev1\n",
verify=False,
gpg_signing_key="1234",
)
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_with_gathered_changelog(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
cc_git_mock: MagicMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2")
next_version = PEP440Version("1.0.0.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("project.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("project.conf"), Path("version.lang")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M project.conf")]
cc_git_mock.return_value.log.return_value = [
"1234567 Add: foo bar",
"8abcdef Add: bar baz",
"8abcd3f Add bar baz",
"8abcd3d Adding bar baz",
"1337abc Change: bar to baz",
"42a42a4 Remove: foo bar again",
"fedcba8 Test: bar baz testing",
"dead901 Refactor: bar baz ref",
"fedcba8 Fix: bar baz fixing",
"d0c4d0c Doc: bar baz documenting",
]
today = datetime.today().strftime("%Y-%m-%d")
expected_changelog = f"""## [0.0.2] - {today}
## Added
* foo bar [1234567](https://github.com/greenbone/foo/commit/1234567)
* bar baz [8abcdef](https://github.com/greenbone/foo/commit/8abcdef)
## Removed
* foo bar again [42a42a4](https://github.com/greenbone/foo/commit/42a42a4)
## Changed
* bar to baz [1337abc](https://github.com/greenbone/foo/commit/1337abc)
## Bug Fixes
* bar baz fixing [fedcba8](https://github.com/greenbone/foo/commit/fedcba8)
[0.0.2]: https://github.com/greenbone/foo/compare/v0.0.1...v0.0.2"""
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
)
git_mock.list_tags.assert_called_once_with()
cc_git_mock.return_value.log.assert_called_once_with(
"v0.0.1..HEAD", oneline=True
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
]
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
]
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", expected_changelog, False),
)
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
git_mock.add.assert_has_calls(
[
call(Path("project.conf")),
call(Path("project.conf")),
call(Path("version.lang")),
]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 1.0.0.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch("pontos.changelog.conventional_commits.Git", autospec=True)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_with_changelog(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
cc_git_mock: MagicMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2")
next_version = PEP440Version("1.0.0.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("project.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("project.conf"), Path("version.lang")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M project.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
changelog="A changelog",
)
git_mock.list_tags.assert_called_once_with()
cc_git_mock.return_value.log.assert_not_called()
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
]
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
]
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A changelog", False),
)
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
git_mock.add.assert_has_calls(
[
call(Path("project.conf")),
call(Path("project.conf")),
call(Path("version.lang")),
]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 1.0.0.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_local(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.0")
release_version = PEP440Version("0.0.1")
next_version = PEP440Version("0.0.2.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=release_version,
next_version=next_version,
last_release_version=current_version,
local=True,
changelog=CHANGELOG,
)
git_mock.push.assert_not_called()
create_release_mock.assert_not_awaited()
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
]
)
git_mock.add.assert_called_with(Path("MyProject.conf"))
git_mock.commit.assert_called_with(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 0.0.2.dev1\n",
verify=False,
gpg_signing_key="1234",
)
git_mock.tag.assert_called_once_with(
"v0.0.1", gpg_key_id="1234", message="Automatic release to 0.0.1"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_enforce_github_release(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2")
next_version = PEP440Version("1.0.0.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.PATCH,
next_version=next_version,
last_release_version=current_version,
github_pre_release=True,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
call(next_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", True),
)
git_mock.add.assert_has_calls(
[call(Path("MyProject.conf")), call(Path("MyProject.conf"))]
)
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2",
verify=False,
gpg_signing_key="1234",
),
call(
"Automatic adjustments after release [skip ci]\n\n"
"* Update to version 1.0.0.dev1\n",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
@patch(
"pontos.release.create.CreateReleaseCommand._create_release",
autospec=True,
)
@patch("pontos.release.create.Project._gather_commands", autospec=True)
def test_release_no_next_release(
self,
gather_commands_mock: MagicMock,
create_release_mock: AsyncMock,
):
current_version = PEP440Version("0.0.1")
release_version = PEP440Version("0.0.2")
next_version = PEP440Version("1.0.0.dev1")
command_mock = MagicMock(spec=GoVersionCommand)
gather_commands_mock.return_value = [command_mock]
command_mock.update_version.side_effect = [
VersionUpdate(
previous=current_version,
new=release_version,
changed_files=[Path("MyProject.conf")],
),
VersionUpdate(
previous=release_version,
new=next_version,
changed_files=[Path("MyProject.conf")],
),
]
git_mock = MagicMock(spec=Git)
git_mock.status.return_value = [StatusEntry("M MyProject.conf")]
with temp_git_repository():
released = CreateReleaseCommand(
git=git_mock,
).run(
token=TOKEN,
repository=REPOSITORY,
git_signing_key=GIT_SIGNING_KEY,
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.PATCH,
next_version=False,
last_release_version=current_version,
changelog=CHANGELOG,
)
git_mock.push.assert_has_calls(
[
call(follow_tags=True, remote=None),
],
)
command_mock.update_version.assert_has_calls(
[
call(release_version, force=False),
],
)
self.assertEqual(
create_release_mock.await_args.args[1:], # type: ignore[union-attr]
(release_version, "foo", "A Changelog", False),
)
git_mock.add.assert_has_calls([call(Path("MyProject.conf"))])
git_mock.commit.assert_has_calls(
[
call(
"Automatic release to 0.0.2",
verify=False,
gpg_signing_key="1234",
),
]
)
git_mock.tag.assert_called_once_with(
"v0.0.2", gpg_key_id="1234", message="Automatic release to 0.0.2"
)
self.assertEqual(released, CreateReleaseReturnValue.SUCCESS)
class CreateReleaseTestCase(unittest.TestCase):
def test_no_token(self):
_, _, args = parse_args(
[
"release",
"--repository",
"greenbone/foo",
"--release-version",
"0.0.1",
]
)
released = create_release(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=None,
)
self.assertEqual(released, CreateReleaseReturnValue.TOKEN_MISSING)
@dataclass
class Release:
release_type: str
current_version: str
expected_release_version: str
tags: Union[str, list[str]]
expected_last_release_version: Optional[str] = None
release_series: Optional[str] = None
@patch.dict(
"os.environ",
{"GITHUB_TOKEN": "foo", "GITHUB_USER": "user", "GPG_SIGNING_KEY": ""},
)
class ReleaseGoProjectTestCase(unittest.TestCase):
@patch("pontos.release.create.Git.push", autospec=True)
@patch(
"pontos.release.create.GitHubAsyncRESTApi",
autospec=True,
)
def test_release(
self, github_api_mock: AsyncMock, _git_push_mock: MagicMock
):
create_api_mock = AsyncMock()
github_api_mock.return_value.releases.create = create_api_mock
releases = [
Release(
release_type="major",
current_version="1.0.0",
expected_release_version="2.0.0",
tags="1.0.0",
),
Release(
release_type="minor",
current_version="1.0.0",
expected_release_version="1.1.0",
tags="1.0.0",
),
Release(
release_type="patch",
current_version="1.0.0",
expected_release_version="1.0.1",
tags="1.0.0",
),
Release(
release_type="patch",
current_version="1.0.5",
expected_release_version="1.0.6",
tags="1.0.5",
),
Release(
release_type="alpha",
current_version="1.0.0",
expected_release_version="1.0.1a1",
tags="1.0.0",
),
Release(
release_type="alpha",
current_version="1.0.0a3",
expected_release_version="1.0.0a4",
tags="1.0.0a3",
),
Release(
release_type="beta",
current_version="1.0.0",
expected_release_version="1.0.1b1",
tags="1.0.0",
),
Release(
release_type="beta",
current_version="1.0.0b2",
expected_release_version="1.0.0b3",
tags="1.0.0b2",
),
Release(
release_type="release-candidate",
current_version="1.0.0",
expected_release_version="1.0.1rc1",
tags="1.0.0",
),
Release(
release_type="release-candidate",
current_version="1.0.0rc1",
expected_release_version="1.0.0rc2",
tags="1.0.0rc1",
),
]
for r in releases:
with setup_go_project(
current_version=r.current_version, tags=r.tags
):
_, token, args = parse_args(
[
"release",
"--repository",
"foo/bar",
"--release-type",
r.release_type,
]
)
released = create_release(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token, # type: ignore[arg-type]
)
self.assertEqual(
released,
CreateReleaseReturnValue.SUCCESS,
f"v{r.expected_release_version}",
)
self.assertEqual(
create_api_mock.call_args.args[1],
f"v{r.expected_release_version}",
)
create_api_mock.reset_mock()
@patch(
"pontos.release.create.CreateReleaseCommand._create_changelog",
autospec=True,
)
@patch("pontos.release.create.Git.push", autospec=True)
@patch(
"pontos.release.create.GitHubAsyncRESTApi",
autospec=True,
)
def test_release_series(
self,
github_api_mock: AsyncMock,
_git_push_mock: MagicMock,
create_changelog_mock: MagicMock,
):
create_api_mock = AsyncMock()
github_api_mock.return_value.releases.create = create_api_mock
create_changelog_mock.return_value = "A Changelog"
releases = [
Release(
release_type="major",
current_version="1.0.0",
expected_release_version="2.0.0",
expected_last_release_version="1.0.0",
tags=["1.0.0", "3.0.0"],
release_series="1",
),
Release(
release_type="major",
current_version="1.0.0rc1",
expected_release_version="1.0.0",
expected_last_release_version="0.9.0",
tags=["0.9.0", "0.8.1", "0.5.0"],
),
Release(
release_type="minor",
current_version="1.0.0",
expected_release_version="2.1.0",
expected_last_release_version="2.0.0",
tags=["1.0.0", "2.0.0"],
),
Release(
release_type="minor",
current_version="1.0.0",
expected_release_version="1.1.0",
expected_last_release_version="1.0.0",
tags=["1.0.0", "2.0.0"],
release_series="1",
),
Release(
release_type="minor",
current_version="1.1.0",
expected_release_version="1.2.0",
expected_last_release_version="1.1.0",
tags=["1.0.0", "1.1.0", "2.0.0"],
release_series="1.1",
),
Release(
release_type="patch",
current_version="1.0.0",
expected_release_version="1.0.1",
expected_last_release_version="1.0.0",
tags=["1.0.0", "1.1.0", "2.0.0"],
release_series="1.0",
),
Release(
release_type="patch",
current_version="1.0.5",
expected_release_version="1.0.6",
expected_last_release_version="1.0.5",
tags=["1.0.5", "1.1.0", "2.0.0"],
release_series="1.0",
),
Release(
release_type="patch",
current_version="1.0.5",
expected_release_version="1.1.1",
expected_last_release_version="1.1.0",
tags=["1.0.5", "1.1.0", "2.0.0"],
release_series="1.1",
),
Release(
release_type="patch",
current_version="1.1.0rc1",
expected_release_version="1.1.0",
expected_last_release_version="1.1.0b1",
tags=["1.0.0", "1.1.0b1", "1.2.0", "2.0.0"],
release_series="1.1",
),
Release(
release_type="alpha",
current_version="1.0.0",
expected_release_version="1.0.1a1",
expected_last_release_version="1.0.0",
tags=["1.0.0", "2.0.0", "1.1.0"],
release_series="1.0",
),
Release(
release_type="alpha",
current_version="1.0.0a3",
expected_release_version="1.0.0a4",
expected_last_release_version="1.0.0a3",
tags=["1.0.0a3", "2.0.0", "1.1.0"],
release_series="1.0",
),
Release(
release_type="beta",
current_version="1.0.0",
expected_release_version="1.0.1b1",
expected_last_release_version="1.0.0",
tags=["1.0.0", "2.0.0", "1.1.0"],
release_series="1.0",
),
Release(
release_type="beta",
current_version="1.0.0b2",
expected_release_version="1.0.0b3",
expected_last_release_version="1.0.0b2",
tags=["1.0.0b2", "2.0.0", "1.1.0"],
release_series="1.0",
),
Release(
release_type="release-candidate",
current_version="1.0.0",
expected_release_version="1.0.1rc1",
expected_last_release_version="1.0.0",
tags=["1.0.0", "2.0.0", "1.1.0"],
release_series="1.0",
),
Release(
release_type="release-candidate",
current_version="1.0.0rc1",
expected_release_version="1.0.0rc2",
expected_last_release_version="1.0.0rc1",
tags=["1.0.0rc1", "2.0.0", "1.1.0"],
release_series="1.0",
),
]
for r in releases:
with setup_go_project(
current_version=r.current_version, tags=r.tags
):
input_args = [
"release",
"--repository",
"foo/bar",
"--release-type",
r.release_type,
]
if r.release_series:
input_args.extend(["--release-series", r.release_series])
_, token, args = parse_args(input_args)
released = create_release(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token, # type: ignore[arg-type]
)
self.assertEqual(
released,
CreateReleaseReturnValue.SUCCESS,
f"Invalid return value for {r}",
)
self.assertEqual(
create_api_mock.call_args.args[1],
f"v{r.expected_release_version}",
f"Unexpected current release version {r}",
)
self.assertEqual(
create_changelog_mock.call_args.args[1],
PEP440Version.from_string(r.expected_release_version),
f"Unexpected current release version {r}",
)
if r.expected_last_release_version is None:
self.assertIsNone(create_changelog_mock.call_args.args[2])
else:
self.assertEqual(
create_changelog_mock.call_args.args[2],
PEP440Version.from_string(r.expected_last_release_version),
f"Unexpected last release version for {r}",
)
create_api_mock.reset_mock()
create_changelog_mock.reset_mock()
pontos-25.3.2/tests/release/test_helper.py 0000664 0000000 0000000 00000025243 14762555663 0020630 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import contextlib
import os
import subprocess
import unittest
from pathlib import Path
from typing import Generator
from unittest.mock import MagicMock, patch
from pontos.git import ConfigScope, Git, GitError
from pontos.release.helper import (
ReleaseType,
find_signing_key,
get_git_repository_name,
get_next_release_version,
repository_split,
)
from pontos.testing import temp_git_repository
from pontos.version import VersionError
from pontos.version.schemes import SemanticVersioningScheme
@contextlib.contextmanager
def init_test_git_repo() -> Generator[Path, None, None]:
with temp_git_repository() as repo_path:
git = Git()
git.add_remote("foo", "https://foo.bar/bla.git")
git.add_remote("origin", "https://foo.bar/testrepo.git")
yield repo_path
class GetGitRepositoryNameTestCase(unittest.TestCase):
def test_get_project_name(self):
with init_test_git_repo():
project = get_git_repository_name(remote="foo")
self.assertEqual(project, "bla")
project = get_git_repository_name()
self.assertEqual(project, "testrepo")
class FindSigningKeyTestCase(unittest.TestCase):
def test_find_signing_key(self):
terminal = MagicMock()
with temp_git_repository():
git = Git()
git.config(
"user.signingkey",
"1234567890ABCEDEF1234567890ABCEDEF123456",
scope=ConfigScope.LOCAL,
)
signing_key = find_signing_key(terminal)
self.assertEqual(
signing_key, "1234567890ABCEDEF1234567890ABCEDEF123456"
)
@unittest.skipUnless(os.environ.get("CI"), "only run on CI")
def test_find_no_signing_key(self):
terminal = MagicMock()
saved_key = None
git = Git()
try:
# save possibly set git signing key from user temporarily
try:
saved_key = git.config(
"user.signingkey", scope=ConfigScope.GLOBAL
)
except GitError:
saved_key = None
try:
git.config("user.signingkey", "", scope=ConfigScope.GLOBAL)
except subprocess.CalledProcessError as e:
self.assertEqual(e.returncode, 5)
with temp_git_repository():
signing_key = find_signing_key(terminal)
self.assertEqual(signing_key, "")
finally:
# reset the previously saved signing key ...
if saved_key is not None:
git.config(
"user.signingkey", saved_key, scope=ConfigScope.GLOBAL
)
class GetNextReleaseVersionTestCase(unittest.TestCase):
def test_next_major_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=ReleaseType.MAJOR,
release_version=None,
)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("2.0.0")
)
def test_next_minor_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=ReleaseType.MINOR,
release_version=None,
)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("1.1.0")
)
def test_next_patch_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=ReleaseType.PATCH,
release_version=None,
)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("1.0.1")
)
def test_next_calendar_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
with patch.object(
calculator,
"next_calendar_version",
return_value=SemanticVersioningScheme.parse_version("23.7.0"),
):
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=ReleaseType.CALENDAR,
release_version=None,
)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("23.7.0")
)
def test_next_alpha_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=ReleaseType.ALPHA,
release_version=None,
)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("1.0.1-alpha1")
)
def test_next_beta_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=ReleaseType.BETA,
release_version=None,
)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("1.0.1-beta1")
)
def test_next_release_candidate_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=ReleaseType.RELEASE_CANDIDATE,
release_version=None,
)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("1.0.1-rc1")
)
def test_no_release_type(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
next_version = SemanticVersioningScheme.parse_version("1.2.3")
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=None,
release_version=next_version,
)
self.assertEqual(version, next_version)
def test_release_type_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
next_version = SemanticVersioningScheme.parse_version("1.2.3")
version = get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=ReleaseType.VERSION,
release_version=next_version,
)
self.assertEqual(version, next_version)
def test_no_release_type_and_release_version(self):
calculator = SemanticVersioningScheme.calculator()
last_version = SemanticVersioningScheme.parse_version("1.0.0")
with self.assertRaisesRegex(
VersionError,
"No release version provided. Either use a different release "
"type or provide a release version.",
):
get_next_release_version(
calculator=calculator,
last_release_version=last_version,
release_type=None,
release_version=None,
)
def test_no_release_type_and_no_last_release_version(self):
calculator = SemanticVersioningScheme.calculator()
release_version = SemanticVersioningScheme.parse_version("1.0.0")
version = get_next_release_version(
calculator=calculator,
last_release_version=None,
release_type=None,
release_version=release_version,
)
self.assertEqual(version, release_version)
def test_release_type_version_and_no_last_release_version(self):
calculator = SemanticVersioningScheme.calculator()
release_version = SemanticVersioningScheme.parse_version("1.0.0")
version = get_next_release_version(
calculator=calculator,
last_release_version=None,
release_type=ReleaseType.VERSION,
release_version=release_version,
)
self.assertEqual(version, release_version)
def test_no_last_release_version(self):
calculator = SemanticVersioningScheme.calculator()
with self.assertRaisesRegex(
VersionError,
"No last release version found for release type alpha. Either "
"check the project setup or set a release version explicitly.",
):
get_next_release_version(
calculator=calculator,
last_release_version=None,
release_type=ReleaseType.ALPHA,
release_version=None,
)
def test_release_version_with_invalid_release_type(self):
calculator = SemanticVersioningScheme.calculator()
release_version = SemanticVersioningScheme.parse_version("1.0.0")
with self.assertRaisesRegex(
VersionError,
"Invalid release type alpha when setting release version "
"explicitly. Use release type version instead.",
):
get_next_release_version(
calculator=calculator,
last_release_version=None,
release_type=ReleaseType.ALPHA,
release_version=release_version,
)
class RepositorySplitTestCase(unittest.TestCase):
def test_invalid_repository(self):
with self.assertRaisesRegex(
ValueError,
r"Invalid repository foo/bar/baz. Format must be owner/name.",
):
repository_split("foo/bar/baz")
with self.assertRaisesRegex(
ValueError,
r"Invalid repository foo_bar_baz. Format must be owner/name.",
):
repository_split("foo_bar_baz")
def test_repository(self):
space, project = repository_split("foo/bar")
self.assertEqual(space, "foo")
self.assertEqual(project, "bar")
pontos-25.3.2/tests/release/test_parser.py 0000664 0000000 0000000 00000035623 14762555663 0020650 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from contextlib import redirect_stderr
from io import StringIO
from pathlib import Path
from unittest.mock import patch
from pontos.release._parser import DEFAULT_SIGNING_KEY, parse_args
from pontos.release.create import create_release
from pontos.release.helper import ReleaseType
from pontos.release.show import OutputFormat, show
from pontos.release.sign import sign
from pontos.version.schemes._pep440 import PEP440Version, PEP440VersioningScheme
class ParseArgsTestCase(unittest.TestCase):
def test_quiet(self):
_, _, args = parse_args(["-q", "sign"])
self.assertTrue(args.quiet)
_, _, args = parse_args(["sign"])
self.assertFalse(args.quiet)
@patch.dict("os.environ", {"GITHUB_USER": "foo"})
def test_user(self):
user, _, _ = parse_args(["sign"])
self.assertEqual(user, "foo")
@patch.dict("os.environ", {"GITHUB_TOKEN": "foo"})
def test_token(self):
_, token, _ = parse_args(["sign"])
self.assertEqual(token, "foo")
class CreateParseArgsTestCase(unittest.TestCase):
def test_create_func(self):
_, _, args = parse_args(["create", "--release-type", "patch"])
self.assertEqual(args.func, create_release)
def test_release_alias(self):
_, _, args = parse_args(["release", "--release-type", "patch"])
self.assertEqual(args.func, create_release)
def test_default(self):
_, _, args = parse_args(["create", "--release-type", "patch"])
self.assertEqual(args.git_tag_prefix, "v")
self.assertFalse(args.local)
self.assertFalse(args.github_pre_release)
def test_git_remote_name(self):
_, _, args = parse_args(
["create", "--git-remote-name", "foo", "--release-type", "patch"]
)
self.assertEqual(args.git_remote_name, "foo")
def test_git_signing_key(self):
_, _, args = parse_args(
["create", "--git-signing-key", "123", "--release-type", "patch"]
)
self.assertEqual(args.git_signing_key, "123")
def test_git_tag_prefix(self):
_, _, args = parse_args(
["create", "--git-tag-prefix", "a", "--release-type", "patch"]
)
self.assertEqual(args.git_tag_prefix, "a")
_, _, args = parse_args(
["create", "--git-tag-prefix", "", "--release-type", "patch"]
)
self.assertEqual(args.git_tag_prefix, "")
_, _, args = parse_args(
["create", "--git-tag-prefix", "--release-type", "patch"]
)
self.assertEqual(args.git_tag_prefix, "")
def test_repository(self):
_, _, args = parse_args(
["create", "--repository", "foo/bar", "--release-type", "patch"]
)
self.assertEqual(args.repository, "foo/bar")
def test_invalid_repository(self):
with redirect_stderr(StringIO()), self.assertRaises(SystemExit):
parse_args(
["create", "--repository", "foo_bar", "--release-type", "patch"]
)
with redirect_stderr(StringIO()), self.assertRaises(SystemExit):
parse_args(
[
"sign",
"--repository",
"foo/bar/baz",
"--release-type",
"patch",
]
)
def test_next_version(self):
_, _, args = parse_args(
["create", "--next-version", "1.2.3", "--release-type", "patch"]
)
self.assertEqual(args.next_version, PEP440Version("1.2.3"))
def test_no_next_version(self):
_, _, args = parse_args(
["create", "--no-next-version", "--release-type", "patch"]
)
self.assertFalse(args.next_version)
def test_next_version_conflict(self):
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(
[
"create",
"--release-type",
"patch",
"--no-next-version",
"--next-version",
"1.2.3",
]
)
def test_last_release_version(self):
_, _, args = parse_args(
[
"create",
"--release-type",
"patch",
"--last-release-version",
"1.2.3",
]
)
self.assertEqual(args.func, create_release)
self.assertEqual(args.last_release_version, PEP440Version("1.2.3"))
def test_release_type(self):
_, _, args = parse_args(["create", "--release-type", "patch"])
self.assertEqual(args.release_type, ReleaseType.PATCH)
_, _, args = parse_args(["create", "--release-type", "calendar"])
self.assertEqual(args.release_type, ReleaseType.CALENDAR)
_, _, args = parse_args(["create", "--release-type", "minor"])
self.assertEqual(args.release_type, ReleaseType.MINOR)
_, _, args = parse_args(["create", "--release-type", "major"])
self.assertEqual(args.release_type, ReleaseType.MAJOR)
_, _, args = parse_args(["create", "--release-type", "alpha"])
self.assertEqual(args.release_type, ReleaseType.ALPHA)
_, _, args = parse_args(["create", "--release-type", "beta"])
self.assertEqual(args.release_type, ReleaseType.BETA)
_, _, args = parse_args(
["create", "--release-type", "release-candidate"]
)
self.assertEqual(args.release_type, ReleaseType.RELEASE_CANDIDATE)
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(["create", "--release-type", "foo"])
def test_release_type_version_without_release_version(self):
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(["create", "--release-type", "version"])
_, _, args = parse_args(
[
"create",
"--release-type",
"version",
"--release-version",
"1.2.3",
]
)
self.assertEqual(args.release_type, ReleaseType.VERSION)
self.assertEqual(args.release_version, PEP440Version("1.2.3"))
def test_release_version(self):
_, _, args = parse_args(["create", "--release-version", "1.2.3"])
self.assertEqual(args.release_version, PEP440Version("1.2.3"))
self.assertEqual(args.release_type, ReleaseType.VERSION)
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(["create", "--release-version", "1.2.3", "--patch"])
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(["create", "--release-version", "1.2.3", "--calendar"])
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(
[
"create",
"--release-version",
"1.2.3",
"--release-type",
"patch",
]
)
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(
[
"create",
"--release-version",
"1.2.3",
"--release-type",
"calendar",
]
)
def test_local(self):
_, _, args = parse_args(
["create", "--local", "--release-type", "patch"]
)
self.assertTrue(args.local)
def test_conventional_commits_config(self):
_, _, args = parse_args(
[
"create",
"--conventional-commits-config",
"foo.toml",
"--release-type",
"patch",
]
)
self.assertEqual(args.cc_config, Path("foo.toml"))
def test_changelog_conflict(self):
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(
[
"create",
"--release-type",
"patch",
"--changelog",
"foo.md",
"--conventional-commits-config",
"bar.toml",
]
)
def test_changelog(self):
_, _, args = parse_args(
[
"create",
"--changelog",
"foo.md",
"--release-type",
"patch",
]
)
self.assertEqual(args.changelog, Path("foo.md"))
def test_release_series(self):
_, _, args = parse_args(
["create", "--release-type", "patch", "--release-series", "22.4"]
)
self.assertEqual(args.release_series, "22.4")
def test_update_project(self):
_, _, args = parse_args(["create", "--release-type", "patch"])
self.assertTrue(args.update_project)
_, _, args = parse_args(
["create", "--release-type", "patch", "--update-project"]
)
self.assertTrue(args.update_project)
_, _, args = parse_args(
["create", "--release-type", "patch", "--no-update-project"]
)
self.assertFalse(args.update_project)
def test_github_pre_release(self):
_, _, args = parse_args(
["create", "--release-type", "patch", "--github-pre-release"]
)
self.assertTrue(args.github_pre_release)
class SignParseArgsTestCase(unittest.TestCase):
def test_sign_func(self):
_, _, args = parse_args(["sign"])
self.assertEqual(args.func, sign)
def test_default(self):
_, _, args = parse_args(["sign"])
self.assertEqual(args.git_tag_prefix, "v")
self.assertEqual(args.signing_key, DEFAULT_SIGNING_KEY)
def test_repository(self):
_, _, args = parse_args(["sign", "--repository", "foo/bar"])
self.assertEqual(args.repository, "foo/bar")
def test_invalid_repository(self):
with redirect_stderr(StringIO()), self.assertRaises(SystemExit):
parse_args(["sign", "--repository", "foo_bar"])
with redirect_stderr(StringIO()), self.assertRaises(SystemExit):
parse_args(["sign", "--repository", "foo/bar/baz"])
def test_release_version(self):
_, _, args = parse_args(["sign", "--release-version", "1.2.3"])
self.assertEqual(args.release_version, PEP440Version("1.2.3"))
def test_dry_run(self):
_, _, args = parse_args(["sign", "--dry-run"])
self.assertTrue(args.dry_run)
def test_signing_key(self):
_, _, args = parse_args(["sign", "--signing-key", "123"])
self.assertEqual(args.signing_key, "123")
def test_passphrase(self):
_, _, args = parse_args(["sign", "--passphrase", "123"])
self.assertEqual(args.passphrase, "123")
def test_release_series(self):
_, _, args = parse_args(["sign", "--release-series", "22.4"])
self.assertEqual(args.release_series, "22.4")
class ShowParseArgsTestCase(unittest.TestCase):
def test_show_func(self):
_, _, args = parse_args(["show", "--release-type", "patch"])
self.assertEqual(args.func, show)
def test_defaults(self):
_, _, args = parse_args(["show", "--release-type", "patch"])
self.assertEqual(args.git_tag_prefix, "v")
self.assertEqual(args.versioning_scheme, PEP440VersioningScheme)
def test_release_series(self):
_, _, args = parse_args(
["show", "--release-type", "patch", "--release-series", "1.2"]
)
self.assertEqual(args.release_series, "1.2")
def test_release_type(self):
_, _, args = parse_args(["show", "--release-type", "patch"])
self.assertEqual(args.release_type, ReleaseType.PATCH)
_, _, args = parse_args(["show", "--release-type", "calendar"])
self.assertEqual(args.release_type, ReleaseType.CALENDAR)
_, _, args = parse_args(["show", "--release-type", "minor"])
self.assertEqual(args.release_type, ReleaseType.MINOR)
_, _, args = parse_args(["show", "--release-type", "major"])
self.assertEqual(args.release_type, ReleaseType.MAJOR)
_, _, args = parse_args(["show", "--release-type", "alpha"])
self.assertEqual(args.release_type, ReleaseType.ALPHA)
_, _, args = parse_args(["show", "--release-type", "beta"])
self.assertEqual(args.release_type, ReleaseType.BETA)
_, _, args = parse_args(["show", "--release-type", "release-candidate"])
self.assertEqual(args.release_type, ReleaseType.RELEASE_CANDIDATE)
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(["show", "--release-type", "foo"])
def test_git_tag_prefix(self):
_, _, args = parse_args(
["show", "--git-tag-prefix", "a", "--release-type", "patch"]
)
self.assertEqual(args.git_tag_prefix, "a")
_, _, args = parse_args(
["show", "--git-tag-prefix", "", "--release-type", "patch"]
)
self.assertEqual(args.git_tag_prefix, "")
_, _, args = parse_args(
["show", "--git-tag-prefix", "--release-type", "patch"]
)
self.assertEqual(args.git_tag_prefix, "")
def test_release_version(self):
_, _, args = parse_args(["show", "--release-version", "1.2.3"])
self.assertEqual(args.release_version, PEP440Version("1.2.3"))
self.assertEqual(args.release_type, ReleaseType.VERSION)
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(
[
"show",
"--release-version",
"1.2.3",
"--release-type",
"patch",
]
)
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
parse_args(
[
"show",
"--release-version",
"1.2.3",
"--release-type",
"calendar",
]
)
def test_output_format(self):
_, _, args = parse_args(
["show", "--release-type", "patch", "--output-format", "env"]
)
self.assertEqual(args.output_format, OutputFormat.ENV)
_, _, args = parse_args(
["show", "--release-type", "patch", "--output-format", "json"]
)
self.assertEqual(args.output_format, OutputFormat.JSON)
_, _, args = parse_args(
[
"show",
"--release-type",
"patch",
"--output-format",
"github-action",
]
)
with patch.dict(
"os.environ", {"GITHUB_OUTPUT": "/tmp/output"}, clear=True
):
self.assertEqual(args.output_format, OutputFormat.GITHUB_ACTION)
pontos-25.3.2/tests/release/test_show.py 0000664 0000000 0000000 00000027436 14762555663 0020337 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import unittest
from pathlib import Path
from unittest.mock import MagicMock, call, patch
from pontos.git import Git
from pontos.release.helper import ReleaseType
from pontos.release.show import (
OutputFormat,
ShowReleaseCommand,
ShowReleaseReturnValue,
)
from pontos.testing import temp_file, temp_git_repository
from pontos.version.schemes import PEP440VersioningScheme
def setup_git_repo(temp_git: Path) -> None:
some_file = temp_git / "some-file.txt"
some_file.touch()
git = Git()
git.add(some_file)
git.commit("Add some file", gpg_sign=False, verify=False)
git.tag("v1.0.0", sign=False)
class ShowTestCase(unittest.TestCase):
def test_env_output(self):
terminal = MagicMock()
with temp_git_repository() as temp_git:
setup_git_repo(temp_git)
show_cmd = ShowReleaseCommand(
terminal=terminal, error_terminal=MagicMock()
)
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.PATCH,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.ENV,
)
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
terminal.print.assert_has_calls(
[
call("LAST_RELEASE_VERSION=1.0.0"),
call("LAST_RELEASE_VERSION_MAJOR=1"),
call("LAST_RELEASE_VERSION_MINOR=0"),
call("LAST_RELEASE_VERSION_PATCH=0"),
call("RELEASE_VERSION=1.0.1"),
call("RELEASE_VERSION_MAJOR=1"),
call("RELEASE_VERSION_MINOR=0"),
call("RELEASE_VERSION_PATCH=1"),
]
)
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MINOR,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.ENV,
)
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
terminal.print.assert_has_calls(
[
call("LAST_RELEASE_VERSION=1.0.0"),
call("LAST_RELEASE_VERSION_MAJOR=1"),
call("LAST_RELEASE_VERSION_MINOR=0"),
call("LAST_RELEASE_VERSION_PATCH=0"),
call("RELEASE_VERSION=1.1.0"),
call("RELEASE_VERSION_MAJOR=1"),
call("RELEASE_VERSION_MINOR=1"),
call("RELEASE_VERSION_PATCH=0"),
]
)
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MAJOR,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.ENV,
)
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
terminal.print.assert_has_calls(
[
call("LAST_RELEASE_VERSION=1.0.0"),
call("LAST_RELEASE_VERSION_MAJOR=1"),
call("LAST_RELEASE_VERSION_MINOR=0"),
call("LAST_RELEASE_VERSION_PATCH=0"),
call("RELEASE_VERSION=2.0.0"),
call("RELEASE_VERSION_MAJOR=2"),
call("RELEASE_VERSION_MINOR=0"),
call("RELEASE_VERSION_PATCH=0"),
]
)
def test_json_output(self):
terminal = MagicMock()
with temp_git_repository() as temp_git:
setup_git_repo(temp_git)
show_cmd = ShowReleaseCommand(
terminal=terminal, error_terminal=MagicMock()
)
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.PATCH,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.JSON,
)
expected = """{
"release_version": "1.0.1",
"release_version_major": 1,
"release_version_minor": 0,
"release_version_patch": 1,
"last_release_version": "1.0.0",
"last_release_version_major": 1,
"last_release_version_minor": 0,
"last_release_version_patch": 0
}"""
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
terminal.print.assert_called_once_with(expected)
terminal.reset_mock()
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MINOR,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.JSON,
)
expected = """{
"release_version": "1.1.0",
"release_version_major": 1,
"release_version_minor": 1,
"release_version_patch": 0,
"last_release_version": "1.0.0",
"last_release_version_major": 1,
"last_release_version_minor": 0,
"last_release_version_patch": 0
}"""
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
terminal.print.assert_called_once_with(expected)
terminal.reset_mock()
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MAJOR,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.JSON,
)
expected = """{
"release_version": "2.0.0",
"release_version_major": 2,
"release_version_minor": 0,
"release_version_patch": 0,
"last_release_version": "1.0.0",
"last_release_version_major": 1,
"last_release_version_minor": 0,
"last_release_version_patch": 0
}"""
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
terminal.print.assert_called_once_with(expected)
def test_github_action_output(self):
terminal = MagicMock()
with temp_git_repository() as temp_git:
setup_git_repo(temp_git)
show_cmd = ShowReleaseCommand(
terminal=terminal, error_terminal=MagicMock()
)
output_file = temp_git.absolute() / "output"
with patch.dict(
"os.environ", {"GITHUB_OUTPUT": f"{output_file}"}, clear=True
):
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.PATCH,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.GITHUB_ACTION,
)
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
expected = """last_release_version=1.0.0
last_release_version_major=1
last_release_version_minor=0
last_release_version_patch=0
release_version_major=1
release_version_minor=0
release_version_patch=1
release_version=1.0.1
"""
actual = output_file.read_text(encoding="utf8")
self.assertEqual(expected, actual)
output_file.unlink()
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MINOR,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.GITHUB_ACTION,
)
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
expected = """last_release_version=1.0.0
last_release_version_major=1
last_release_version_minor=0
last_release_version_patch=0
release_version_major=1
release_version_minor=1
release_version_patch=0
release_version=1.1.0
"""
actual = output_file.read_text(encoding="utf8")
self.assertEqual(expected, actual)
output_file.unlink()
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.MAJOR,
release_version=None,
git_tag_prefix="v",
output_format=OutputFormat.GITHUB_ACTION,
)
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
expected = """last_release_version=1.0.0
last_release_version_major=1
last_release_version_minor=0
last_release_version_patch=0
release_version_major=2
release_version_minor=0
release_version_patch=0
release_version=2.0.0
"""
actual = output_file.read_text(encoding="utf8")
self.assertEqual(expected, actual)
output_file.unlink()
def test_initial_release(self):
terminal = MagicMock()
with temp_git_repository():
show_cmd = ShowReleaseCommand(
terminal=terminal, error_terminal=MagicMock()
)
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=PEP440VersioningScheme.parse_version("1.0.0"),
git_tag_prefix="v",
output_format=OutputFormat.ENV,
)
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
terminal.print.assert_has_calls(
[
call("LAST_RELEASE_VERSION="),
call("LAST_RELEASE_VERSION_MAJOR="),
call("LAST_RELEASE_VERSION_MINOR="),
call("LAST_RELEASE_VERSION_PATCH="),
call("RELEASE_VERSION=1.0.0"),
call("RELEASE_VERSION_MAJOR=1"),
call("RELEASE_VERSION_MINOR=0"),
call("RELEASE_VERSION_PATCH=0"),
]
)
terminal.reset_mock()
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=PEP440VersioningScheme.parse_version("1.0.0"),
git_tag_prefix="v",
output_format=OutputFormat.JSON,
)
expected = """{
"release_version": "1.0.0",
"release_version_major": 1,
"release_version_minor": 0,
"release_version_patch": 0,
"last_release_version": "",
"last_release_version_major": "",
"last_release_version_minor": "",
"last_release_version_patch": ""
}"""
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
terminal.print.assert_called_once_with(expected)
with (
temp_file(name="output") as output_file,
patch.dict(
"os.environ",
{"GITHUB_OUTPUT": f"{output_file}"},
clear=True,
),
):
return_val = show_cmd.run(
versioning_scheme=PEP440VersioningScheme,
release_type=ReleaseType.VERSION,
release_version=PEP440VersioningScheme.parse_version(
"1.0.0"
),
git_tag_prefix="v",
output_format=OutputFormat.GITHUB_ACTION,
)
self.assertEqual(return_val, ShowReleaseReturnValue.SUCCESS)
expected = """last_release_version=
last_release_version_major=
last_release_version_minor=
last_release_version_patch=
release_version_major=1
release_version_minor=0
release_version_patch=0
release_version=1.0.0
"""
actual = output_file.read_text(encoding="utf8")
self.assertEqual(expected, actual)
pontos-25.3.2/tests/release/test_sign.py 0000664 0000000 0000000 00000061726 14762555663 0020317 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=C0413,W0108
import unittest
from asyncio.subprocess import Process
from pathlib import Path
from unittest.mock import AsyncMock, MagicMock, call, patch
import httpx
from pontos.release.main import parse_args
from pontos.release.sign import SignReturnValue, sign
from pontos.terminal.rich import RichTerminal
from pontos.testing import AsyncIteratorMock, temp_directory
def mock_terminal() -> MagicMock:
return MagicMock(spec=RichTerminal)
@patch.dict("os.environ", {"GITHUB_TOKEN": "foo"})
class SignTestCase(unittest.TestCase):
@patch.dict("os.environ", {"GITHUB_TOKEN": ""})
def test_no_token(self):
_, token, args = parse_args(
[
"sign",
"--repository",
"greenbone/foo",
"--release-version",
"0.0.1",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.TOKEN_MISSING)
def test_no_release_error(self):
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"greenbone/foo",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.NO_RELEASE_VERSION)
def test_invalid_repository(self):
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"foo/bar",
]
)
setattr(args, "repository", "foo_bar")
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.INVALID_REPOSITORY)
@patch("pontos.release.sign.get_last_release_version", autospec=True)
def test_no_release_version(self, get_last_release_version_mock: MagicMock):
get_last_release_version_mock.return_value = None
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"foo/bar",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.NO_RELEASE_VERSION)
@patch("pontos.release.sign.GitHubAsyncRESTApi.releases", autospec=True)
def test_release_does_not_exist(self, github_mock: AsyncMock):
github_mock.exists = AsyncMock(return_value=False)
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"foo/bar",
"--release-version",
"1.2.3",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.NO_RELEASE)
@patch("pontos.release.sign.cmd_runner", autospec=True)
@patch("pontos.release.sign.SignCommand.download_asset", autospec=True)
@patch("pontos.release.sign.SignCommand.download_tar", autospec=True)
@patch("pontos.release.sign.SignCommand.download_zip", autospec=True)
@patch("pontos.release.sign.GitHubAsyncRESTApi.releases", autospec=True)
def test_sign_success(
self,
github_releases_mock: AsyncMock,
download_zip_mock: AsyncMock,
download_tar_mock: AsyncMock,
download_asset_mock: AsyncMock,
cmd_runner_mock: AsyncMock,
):
tar_file = Path("file.tar")
zip_file = Path("file.zip")
some_asset = Path("file1")
other_asset = Path("file2")
download_tar_mock.return_value = tar_file
download_zip_mock.return_value = zip_file
download_asset_mock.side_effect = [some_asset, other_asset]
github_releases_mock.exists = AsyncMock(return_value=True)
github_releases_mock.download_release_assets.return_value = (
AsyncIteratorMock(
[
(
"foo",
MagicMock(),
),
("bar", MagicMock()),
]
)
)
process = AsyncMock(spec=Process, returncode=0)
process.communicate.return_value = ("", "")
cmd_runner_mock.return_value = process
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"greenbone/foo",
"--release-version",
"1.2.3",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.SUCCESS)
cmd_runner_mock.assert_has_calls(
[
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
zip_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
tar_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
some_asset,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
other_asset,
),
]
)
github_releases_mock.upload_release_assets.assert_called_once_with(
"greenbone/foo",
"v1.2.3",
[
(Path("file.zip.asc"), "application/pgp-signature"),
(Path("file.tar.asc"), "application/pgp-signature"),
(Path("file1.asc"), "application/pgp-signature"),
(Path("file2.asc"), "application/pgp-signature"),
],
)
@patch("pontos.version.helper.Git", autospec=True)
@patch("pontos.release.sign.cmd_runner", autospec=True)
@patch("pontos.release.sign.SignCommand.download_asset", autospec=True)
@patch("pontos.release.sign.SignCommand.download_tar", autospec=True)
@patch("pontos.release.sign.SignCommand.download_zip", autospec=True)
@patch("pontos.release.sign.GitHubAsyncRESTApi.releases", autospec=True)
def test_sign_success_determine_release_version(
self,
github_releases_mock: AsyncMock,
download_zip_mock: AsyncMock,
download_tar_mock: AsyncMock,
download_asset_mock: AsyncMock,
cmd_runner_mock: AsyncMock,
git_mock: MagicMock,
):
tar_file = Path("file.tar")
zip_file = Path("file.zip")
some_asset = Path("file1")
other_asset = Path("file2")
download_tar_mock.return_value = tar_file
download_zip_mock.return_value = zip_file
download_asset_mock.side_effect = [some_asset, other_asset]
github_releases_mock.exists = AsyncMock(return_value=True)
github_releases_mock.download_release_assets.return_value = (
AsyncIteratorMock(
[
(
"foo",
MagicMock(),
),
("bar", MagicMock()),
]
)
)
process = AsyncMock(spec=Process, returncode=0)
process.communicate.return_value = ("", "")
cmd_runner_mock.return_value = process
git_mock.return_value.list_tags.return_value = ["v1.0.0", "v1.2.3"]
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"greenbone/foo",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.SUCCESS)
cmd_runner_mock.assert_has_calls(
[
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
zip_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
tar_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
some_asset,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
other_asset,
),
]
)
github_releases_mock.upload_release_assets.assert_called_once_with(
"greenbone/foo",
"v1.2.3",
[
(Path("file.zip.asc"), "application/pgp-signature"),
(Path("file.tar.asc"), "application/pgp-signature"),
(Path("file1.asc"), "application/pgp-signature"),
(Path("file2.asc"), "application/pgp-signature"),
],
)
@patch("pontos.version.helper.Git", autospec=True)
@patch("pontos.release.sign.cmd_runner", autospec=True)
@patch("pontos.release.sign.SignCommand.download_asset", autospec=True)
@patch("pontos.release.sign.SignCommand.download_tar", autospec=True)
@patch("pontos.release.sign.SignCommand.download_zip", autospec=True)
@patch("pontos.release.sign.GitHubAsyncRESTApi.releases", autospec=True)
def test_sign_success_determine_release_version_with_release_series(
self,
github_releases_mock: AsyncMock,
download_zip_mock: AsyncMock,
download_tar_mock: AsyncMock,
download_asset_mock: AsyncMock,
cmd_runner_mock: AsyncMock,
git_mock: MagicMock,
):
tar_file = Path("file.tar")
zip_file = Path("file.zip")
some_asset = Path("file1")
other_asset = Path("file2")
download_tar_mock.return_value = tar_file
download_zip_mock.return_value = zip_file
download_asset_mock.side_effect = [some_asset, other_asset]
github_releases_mock.exists = AsyncMock(return_value=True)
github_releases_mock.download_release_assets.return_value = (
AsyncIteratorMock(
[
(
"foo",
MagicMock(),
),
("bar", MagicMock()),
]
)
)
process = AsyncMock(spec=Process, returncode=0)
process.communicate.return_value = ("", "")
cmd_runner_mock.return_value = process
git_mock.return_value.list_tags.return_value = [
"v2.0.1",
]
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"greenbone/foo",
"--release-series",
"2",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.SUCCESS)
cmd_runner_mock.assert_has_calls(
[
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
zip_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
tar_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
some_asset,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
other_asset,
),
]
)
github_releases_mock.upload_release_assets.assert_called_once_with(
"greenbone/foo",
"v2.0.1",
[
(Path("file.zip.asc"), "application/pgp-signature"),
(Path("file.tar.asc"), "application/pgp-signature"),
(Path("file1.asc"), "application/pgp-signature"),
(Path("file2.asc"), "application/pgp-signature"),
],
)
@patch("pontos.release.sign.cmd_runner", autospec=True)
@patch("pontos.release.sign.SignCommand.download_asset", autospec=True)
@patch("pontos.release.sign.SignCommand.download_tar", autospec=True)
@patch("pontos.release.sign.SignCommand.download_zip", autospec=True)
@patch("pontos.release.sign.GitHubAsyncRESTApi.releases", autospec=True)
def test_sign_success_dry_run(
self,
github_releases_mock: AsyncMock,
download_zip_mock: AsyncMock,
download_tar_mock: AsyncMock,
download_asset_mock: AsyncMock,
cmd_runner_mock: MagicMock,
):
tar_file = Path("file.tar")
zip_file = Path("file.zip")
some_asset = Path("file1")
other_asset = Path("file2")
download_tar_mock.return_value = tar_file
download_zip_mock.return_value = zip_file
download_asset_mock.side_effect = [some_asset, other_asset]
github_releases_mock.exists = AsyncMock(return_value=True)
github_releases_mock.download_release_assets.return_value = (
AsyncIteratorMock(
[
(
"foo",
MagicMock(),
),
("bar", MagicMock()),
]
)
)
process = AsyncMock(spec=Process, returncode=0)
process.communicate.return_value = ("", "")
cmd_runner_mock.return_value = process
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"greenbone/foo",
"--release-version",
"1.2.3",
"--dry-run",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.SUCCESS)
cmd_runner_mock.assert_has_calls(
[
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
zip_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
tar_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
some_asset,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
other_asset,
),
]
)
github_releases_mock.upload_release_assets.assert_not_called()
@patch("pontos.release.sign.cmd_runner", autospec=True)
@patch("pontos.release.sign.SignCommand.download_asset", autospec=True)
@patch("pontos.release.sign.SignCommand.download_tar", autospec=True)
@patch("pontos.release.sign.SignCommand.download_zip", autospec=True)
@patch("pontos.release.sign.GitHubAsyncRESTApi.releases", autospec=True)
def test_sign_signature_failure(
self,
github_releases_mock: AsyncMock,
download_zip_mock: AsyncMock,
download_tar_mock: AsyncMock,
download_asset_mock: AsyncMock,
cmd_runner_mock: MagicMock,
):
tar_file = Path("file.tar")
zip_file = Path("file.zip")
some_asset = Path("file1")
other_asset = Path("file2")
download_tar_mock.return_value = tar_file
download_zip_mock.return_value = zip_file
download_asset_mock.side_effect = [some_asset, other_asset]
github_releases_mock.exists = AsyncMock(return_value=True)
github_releases_mock.download_release_assets.return_value = (
AsyncIteratorMock(
[
(
"foo",
MagicMock(),
),
("bar", MagicMock()),
]
)
)
process = AsyncMock(spec=Process, returncode=2)
process.communicate.return_value = ("", b"An Error")
cmd_runner_mock.return_value = process
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"greenbone/foo",
"--release-version",
"1.2.3",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(
result, SignReturnValue.SIGNATURE_GENERATION_FAILED
)
cmd_runner_mock.assert_has_calls(
[
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
zip_file,
),
]
)
github_releases_mock.upload_release_assets.assert_not_called()
@patch("pontos.release.sign.cmd_runner", autospec=True)
@patch("pontos.release.sign.SignCommand.download_asset", autospec=True)
@patch("pontos.release.sign.SignCommand.download_tar", autospec=True)
@patch("pontos.release.sign.SignCommand.download_zip", autospec=True)
@patch("pontos.release.sign.GitHubAsyncRESTApi.releases", autospec=True)
def test_sign_upload_failure(
self,
github_releases_mock: AsyncMock,
download_zip_mock: AsyncMock,
download_tar_mock: AsyncMock,
download_asset_mock: AsyncMock,
cmd_runner_mock: MagicMock,
):
tar_file = Path("file.tar")
zip_file = Path("file.zip")
some_asset = Path("file1")
other_asset = Path("file2")
download_tar_mock.return_value = tar_file
download_zip_mock.return_value = zip_file
download_asset_mock.side_effect = [some_asset, other_asset]
github_releases_mock.exists = AsyncMock(return_value=True)
github_releases_mock.download_release_assets.return_value = (
AsyncIteratorMock(
[
(
"foo",
MagicMock(),
),
("bar", MagicMock()),
]
)
)
github_releases_mock.upload_release_assets.side_effect = (
httpx.HTTPStatusError(
"An error",
request=MagicMock(spec=httpx.Request),
response=MagicMock(spec=httpx.Response),
)
)
process = AsyncMock(spec=Process, returncode=0)
process.communicate.return_value = ("", "")
cmd_runner_mock.return_value = process
with temp_directory(change_into=True):
_, token, args = parse_args(
[
"sign",
"--repository",
"greenbone/foo",
"--release-version",
"1.2.3",
]
)
result = sign(
terminal=mock_terminal(),
error_terminal=mock_terminal(),
args=args,
token=token,
)
self.assertEqual(result, SignReturnValue.UPLOAD_ASSET_ERROR)
cmd_runner_mock.assert_has_calls(
[
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
zip_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
tar_file,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
some_asset,
),
call(
"gpg",
"--default-key",
"0ED1E580",
"--yes",
"--detach-sign",
"--armor",
other_asset,
),
]
)
github_releases_mock.upload_release_assets.assert_called_once_with(
"greenbone/foo",
"v1.2.3",
[
(Path("file.zip.asc"), "application/pgp-signature"),
(Path("file.tar.asc"), "application/pgp-signature"),
(Path("file1.asc"), "application/pgp-signature"),
(Path("file2.asc"), "application/pgp-signature"),
],
)
pontos-25.3.2/tests/release/v1.2.3.md 0000664 0000000 0000000 00000000531 14762555663 0017102 0 ustar 00root root 0000000 0000000 # Changelog
All notable changes to this project will be documented in this file.
## [21.8.1] - 2021-08-23
## Added
* Need for commits. [1234567](https://github.com/foo/bar/commit/1234567)
## Changed
* fooooo. [1234568](https://github.com/foo/bar/commit/1234568)
[21.8.1]: https://github.com/y0urself/test_workflows/compare/21.8.0...21.8.1 pontos-25.3.2/tests/terminal/ 0000775 0000000 0000000 00000000000 14762555663 0016125 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/terminal/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0020232 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/terminal/test_terminal.py 0000664 0000000 0000000 00000013615 14762555663 0021357 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2019-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=invalid-name, protected-access
import unittest
from io import StringIO
from unittest.mock import MagicMock, patch
import colorful as cf
from pontos.terminal.terminal import ConsoleTerminal as Terminal
from pontos.terminal.terminal import Signs
class TerminalTestCase(unittest.TestCase):
def setUp(self):
self.maxDiff = 180
# getting the bash-color-codes from the colorful module
self.red = cf.red
self.green = cf.green
self.yellow = cf.yellow
self.cyan = cf.cyan
self.white = cf.white
self.reset = cf.reset
self.bold = cf.bold
# every colors second value is the reset value ...
self.term = Terminal()
self.term.get_width = MagicMock(return_value=80)
@patch("sys.stdout", new_callable=StringIO)
def test_error(self, mock_stdout):
status = f"{self.red(Signs.ERROR)} "
msg = "foo bar"
expected_msg = self.reset(f"{status}{msg}").styled_string + "\n"
expected_len = len(expected_msg)
self.term.error(msg)
ret = mock_stdout.getvalue()
self.assertEqual(ret, expected_msg)
self.assertEqual(len(ret), expected_len)
@patch("sys.stdout", new_callable=StringIO)
def test_fail(self, mock_stdout):
status = f"{self.red(Signs.FAIL)} "
msg = "foo bar baz"
expected_msg = self.reset(f"{status}{msg}").styled_string + "\n"
expected_len = len(expected_msg)
self.term.fail(msg)
ret = mock_stdout.getvalue()
self.assertEqual(ret, expected_msg)
self.assertEqual(len(ret), expected_len)
@patch("sys.stdout", new_callable=StringIO)
def test_info(self, mock_stdout):
status = f"{self.cyan(Signs.INFO)} "
msg = "foo bar"
expected_msg = self.reset(f"{status}{msg}").styled_string + "\n"
expected_len = len(expected_msg)
self.term.info(msg)
ret = mock_stdout.getvalue()
self.assertEqual(ret, expected_msg)
self.assertEqual(len(ret), expected_len)
@patch("sys.stdout", new_callable=StringIO)
def test_info_with_newline(self, mock_stdout):
status = f"{self.cyan(Signs.INFO)} "
msg = "foo bar\nbaz"
repl_msg = msg.replace("\n", "\n ")
expected_msg = self.reset(f"{status}{repl_msg}").styled_string + "\n"
expected_len = len(expected_msg)
self.term.info(msg)
ret = mock_stdout.getvalue()
self.assertEqual(ret, expected_msg)
self.assertEqual(len(ret), expected_len)
@patch("sys.stdout", new_callable=StringIO)
def test_bold_info(self, mock_stdout):
status = f"{self.cyan(Signs.INFO)} "
msg = "bold foo bar"
expected_msg = self.bold(f"{status}{msg}").styled_string + "\n"
expected_len = len(expected_msg)
self.term.bold_info(msg)
ret = mock_stdout.getvalue()
self.assertEqual(ret, expected_msg)
self.assertEqual(len(ret), expected_len)
@patch("sys.stdout", new_callable=StringIO)
def test_ok(self, mock_stdout):
status = f"{self.green(Signs.OK)} "
msg = "foo bar"
expected_msg = self.reset(f"{status}{msg}").styled_string + "\n"
expected_len = len(expected_msg)
self.term.ok(msg)
ret = mock_stdout.getvalue()
self.assertEqual(ret, expected_msg)
self.assertEqual(len(ret), expected_len)
@patch("sys.stdout", new_callable=StringIO)
def test_warning(self, mock_stdout):
msg = "foo bar"
status = f"{self.yellow(Signs.WARNING)} "
expected_msg = self.reset(f"{status}{msg}").styled_string + "\n"
expected_len = len(expected_msg)
self.term.warning(msg)
ret = mock_stdout.getvalue()
self.assertEqual(ret, expected_msg)
self.assertEqual(len(ret), expected_len)
@patch("sys.stdout", new_callable=StringIO)
def test_print(self, mock_stdout):
expected_msg = (
self.reset(f'{self.white(" ")} foo bar').styled_string + "\n"
)
self.term.print("foo bar")
ret = mock_stdout.getvalue()
self.assertEqual(len(ret), len(expected_msg))
self.assertEqual(ret, expected_msg)
@patch("sys.stdout", new_callable=StringIO)
def test_with_indent(self, mock_stdout):
expected_msg = (
self.reset(f'{self.white(" ")} foo').styled_string + "\n"
)
with self.term.indent(2):
self.term.print("foo")
ret = mock_stdout.getvalue()
self.assertEqual(len(ret), len(expected_msg))
self.assertEqual(ret, expected_msg)
# clear the buffer
mock_stdout.truncate(0)
mock_stdout.seek(0)
expected_msg = self.reset(f'{self.white(" ")} bar').styled_string + "\n"
self.term.print("bar")
ret = mock_stdout.getvalue()
self.assertEqual(len(ret), len(expected_msg))
self.assertEqual(ret, expected_msg)
@patch("sys.stdout", new_callable=StringIO)
def test_long_msg(self, mock_stdout):
long_msg = (
"Lorem ipsum dolor sit amet, consetetur sadipscing elitr, "
"sed diam nonumy eirmod tempor invidunt ut labore et dolore magna"
" aliquyam erat, sed diam voluptua."
)
expected_msg = (
self.reset(
f'{self.white(" ")} Lorem ipsum dolor sit amet, consetetur '
"sadipscing elitr, sed diam nonumy eirmo\n d tempor invidunt "
"ut labore et dolore magna aliquyam erat, sed diam voluptua."
).styled_string
+ "\n"
)
expected_len = len(expected_msg)
self.term.print(long_msg)
ret = mock_stdout.getvalue()
self.assertEqual(ret, expected_msg)
self.assertEqual(len(ret), expected_len)
if __name__ == "__main__":
unittest.main()
pontos-25.3.2/tests/test-typing/ 0000775 0000000 0000000 00000000000 14762555663 0016601 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/test-typing/__init__.py 0000664 0000000 0000000 00000000122 14762555663 0020705 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/test-typing/test_typing.py 0000664 0000000 0000000 00000000746 14762555663 0021533 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pontos.typing import SupportsStr
class SupportsStrTestCase(unittest.TestCase):
def test_str(self):
self.assertIsInstance("", SupportsStr)
self.assertIsInstance(None, SupportsStr)
def test_some_class(self):
class Foo:
def __str__(self) -> str:
pass
foo = Foo()
self.assertIsInstance(foo, SupportsStr)
pontos-25.3.2/tests/test_enum.py 0000664 0000000 0000000 00000001634 14762555663 0016673 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import unittest
from argparse import ArgumentTypeError
from pontos.enum import StrEnum, enum_type
class EnumTypeTestCase(unittest.TestCase):
def test_enum_type(self):
class FooEnum(StrEnum):
ALL = "all"
NONE = "none"
func = enum_type(FooEnum)
self.assertEqual(func("all"), FooEnum.ALL)
self.assertEqual(func("none"), FooEnum.NONE)
self.assertEqual(func(FooEnum.ALL), FooEnum.ALL)
self.assertEqual(func(FooEnum.NONE), FooEnum.NONE)
def test_enum_type_error(self):
class FooEnum(StrEnum):
ALL = "all"
NONE = "none"
func = enum_type(FooEnum)
with self.assertRaisesRegex(
ArgumentTypeError,
r"invalid value foo. Expected one of all, none",
):
func("foo")
pontos-25.3.2/tests/test_helper.py 0000664 0000000 0000000 00000047007 14762555663 0017212 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=redefined-builtin,disallowed-name
# ruff: noqa: E501
import unittest
from enum import Enum
from pathlib import Path
from unittest.mock import MagicMock, call, patch
import httpx
from pontos.errors import PontosError
from pontos.helper import (
DEFAULT_TIMEOUT,
AsyncDownloadProgressIterable,
DownloadProgressIterable,
add_sys_path,
deprecated,
download,
download_async,
ensure_unload_module,
enum_or_value,
parse_timedelta,
snake_case,
unload_module,
)
from pontos.testing import temp_file, temp_python_module
from tests import (
AsyncIteratorMock,
AsyncMock,
IsolatedAsyncioTestCase,
aiter,
anext,
)
from tests.github.api import create_response
class AsyncDownloadProgressIterableTestCase(IsolatedAsyncioTestCase):
def test_properties(self):
content_iterator = AsyncIteratorMock(["1", "2"])
download_iterable = AsyncDownloadProgressIterable(
content_iterator=content_iterator, length=2, url="https://foo.bar"
)
self.assertEqual(download_iterable.length, 2)
self.assertEqual(download_iterable.url, "https://foo.bar")
async def test_download_progress(self):
content_iterator = AsyncIteratorMock(["1", "2"])
download_iterable = AsyncDownloadProgressIterable(
content_iterator=content_iterator, length=2, url="https://foo.bar"
)
it = aiter(download_iterable)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
async def test_download_progress_without_length(self):
content_iterator = AsyncIteratorMock(["1", "2"])
download_iterable = AsyncDownloadProgressIterable(
content_iterator=content_iterator,
length=None,
url="https://foo.bar",
)
it = aiter(download_iterable)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertIsNone(progress)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertIsNone(progress)
class DownloadAsyncTestCase(IsolatedAsyncioTestCase):
async def test_download_async(self):
response = create_response(url="http://some.url")
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
stream = AsyncMock()
stream.__aenter__.return_value = response
async with download_async(
stream, content_length=2
) as download_iterable:
self.assertEqual(download_iterable.url, "http://some.url")
it = aiter(download_iterable)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
async def test_download_async_content_length(self):
response = create_response(headers=MagicMock(), url="http://some.url")
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
response.headers.get.return_value = 2
stream = AsyncMock()
stream.__aenter__.return_value = response
async with download_async(stream) as download_iterable:
self.assertEqual(download_iterable.url, "http://some.url")
it = aiter(download_iterable)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
async def test_download_async_url(self):
response = create_response(url="http://some.url")
response.aiter_bytes.return_value = AsyncIteratorMock(["1", "2"])
stream = AsyncMock()
stream.__aenter__.return_value = response
async with download_async(
stream,
url="http://foo.bar",
content_length=2,
) as download_iterable:
self.assertEqual(download_iterable.url, "http://foo.bar")
it = aiter(download_iterable)
content, progress = await anext(it)
self.assertEqual(content, "1")
self.assertEqual(progress, 50)
content, progress = await anext(it)
self.assertEqual(content, "2")
self.assertEqual(progress, 100)
async def test_download_async_failure(self):
response = create_response()
response.raise_for_status.side_effect = httpx.HTTPStatusError(
"404", request=MagicMock(), response=response
)
stream = AsyncMock()
stream.__aenter__.return_value = response
with self.assertRaises(httpx.HTTPStatusError):
async with download_async(stream, content_length=2):
pass
class DownloadProgressIterableTestCase(unittest.TestCase):
def test_properties(self):
content = ["foo", "bar", "baz"]
destination = Path("foo")
length = 123
url = "bar"
download_progress = DownloadProgressIterable(
content_iterator=content,
destination=destination,
length=length,
url=url,
)
self.assertEqual(download_progress.url, url)
self.assertEqual(download_progress.length, length)
self.assertEqual(download_progress.destination, destination)
def test_progress_without_length(self):
content = ["foo", "bar", "baz"]
destination = MagicMock()
writer = MagicMock()
context_manager = MagicMock()
context_manager.__enter__.return_value = writer
destination.open.return_value = context_manager
download_progress = DownloadProgressIterable(
content_iterator=content,
destination=destination,
length=None,
url="foo",
)
self.assertEqual(download_progress.url, "foo")
it = iter(download_progress)
progress = next(it)
writer.write.assert_called_with("foo")
self.assertIsNone(progress)
progress = next(it)
writer.write.assert_called_with("bar")
self.assertIsNone(progress)
progress = next(it)
writer.write.assert_called_with("baz")
self.assertIsNone(progress)
with self.assertRaises(StopIteration):
next(it)
def test_progress(self):
content = ["foo", "bar", "baz"]
destination = MagicMock()
writer = MagicMock()
context_manager = MagicMock()
context_manager.__enter__.return_value = writer
destination.open.return_value = context_manager
download_progress = DownloadProgressIterable(
content_iterator=content,
destination=destination,
length=9,
url="foo",
)
it = iter(download_progress)
progress = next(it)
writer.write.assert_called_with("foo")
self.assertEqual(progress, 1 / 3.0)
progress = next(it)
writer.write.assert_called_with("bar")
self.assertEqual(progress, 2 / 3.0)
progress = next(it)
writer.write.assert_called_with("baz")
self.assertEqual(progress, 1)
with self.assertRaises(StopIteration):
next(it)
def test_run(self):
content = ["foo", "bar", "baz"]
destination = MagicMock()
writer = MagicMock()
context_manager = MagicMock()
context_manager.__enter__.return_value = writer
destination.open.return_value = context_manager
download_progress = DownloadProgressIterable(
content_iterator=content,
destination=destination,
length=9,
url="foo",
)
download_progress.run()
destination.open.assert_called_once()
writer.write.assert_has_calls((call("foo"), call("bar"), call("baz")))
class DownloadTestCase(unittest.TestCase):
@patch("pontos.github.api.api.httpx.stream")
def test_download_without_destination(
self,
requests_mock: MagicMock,
):
response = MagicMock()
response.iter_bytes.return_value = [b"foo", b"bar", b"baz"]
response_headers = MagicMock()
response.headers = response_headers
response_headers.get.return_value = None
response_stream = MagicMock()
response_stream.__enter__.return_value = response
requests_mock.return_value = response_stream
with download(
"https://github.com/greenbone/pontos/archive/refs/tags/v21.11.0.tar.gz" # pylint: disable=line-too-long
) as download_progress:
requests_mock.assert_called_once_with(
"GET",
"https://github.com/greenbone/pontos/archive/refs/tags/v21.11.0.tar.gz", # pylint: disable=line-too-long
follow_redirects=True,
timeout=DEFAULT_TIMEOUT,
headers=None,
params=None,
)
response_headers.get.assert_called_once_with("content-length")
self.assertIsNone(download_progress.length)
self.assertEqual(
download_progress.destination, Path("v21.11.0.tar.gz")
)
it = iter(download_progress)
progress = next(it)
self.assertIsNone(progress)
progress = next(it)
self.assertIsNone(progress)
progress = next(it)
self.assertIsNone(progress)
with self.assertRaises(StopIteration):
next(it)
download_progress.destination.unlink()
@patch("pontos.helper.Path")
@patch("pontos.github.api.api.httpx.stream")
def test_download_with_content_length(
self, requests_mock: MagicMock, path_mock: MagicMock
):
response = MagicMock()
response.iter_bytes.return_value = [b"foo", b"bar", b"baz"]
response_headers = MagicMock()
response.headers = response_headers
response_headers.get.return_value = "9"
response_stream = MagicMock()
response_stream.__enter__.return_value = response
requests_mock.return_value = response_stream
download_file = path_mock()
file_mock = MagicMock()
file_mock.__enter__.return_value = file_mock
download_file.open.return_value = file_mock
with download(
"https://github.com/greenbone/pontos/archive/refs/tags/v21.11.0.tar.gz", # pylint: disable=line-too-long
download_file,
) as download_progress:
requests_mock.assert_called_once_with(
"GET",
"https://github.com/greenbone/pontos/archive/refs/tags/v21.11.0.tar.gz", # pylint: disable=line-too-long
timeout=DEFAULT_TIMEOUT,
follow_redirects=True,
headers=None,
params=None,
)
response_headers.get.assert_called_once_with("content-length")
self.assertEqual(download_progress.length, 9)
it = iter(download_progress)
progress = next(it)
self.assertEqual(progress, 1 / 3)
file_mock.write.assert_called_with(b"foo")
progress = next(it)
self.assertEqual(progress, 2 / 3)
file_mock.write.assert_called_with(b"bar")
progress = next(it)
self.assertEqual(progress, 1)
file_mock.write.assert_called_with(b"baz")
with self.assertRaises(StopIteration):
next(it)
class DeprecatedTestCase(unittest.TestCase):
def test_function(self):
@deprecated
def foo():
pass
with self.assertWarnsRegex(DeprecationWarning, "foo is deprecated"):
foo()
@deprecated()
def foo2():
pass
with self.assertWarnsRegex(DeprecationWarning, "foo2 is deprecated"):
foo2()
def test_function_with_since(self):
@deprecated(since="1.2.3")
def foo():
pass
with self.assertWarnsRegex(
DeprecationWarning, "deprecated since version 1.2.3"
):
foo()
def test_function_with_reason(self):
@deprecated("Because it is obsolete.")
def foo():
pass
with self.assertWarnsRegex(
DeprecationWarning, "Because it is obsolete"
):
foo()
@deprecated(reason="Because it is obsolete.")
def foo2():
pass
with self.assertWarnsRegex(
DeprecationWarning, "Because it is obsolete"
):
foo2()
def test_class(self):
@deprecated
class Foo:
pass
with self.assertWarnsRegex(DeprecationWarning, "Foo is deprecated"):
Foo()
@deprecated()
class Foo2:
pass
with self.assertWarnsRegex(DeprecationWarning, "Foo2 is deprecated"):
Foo2()
def test_class_with_since(self):
@deprecated(since="1.2.3")
class Foo:
pass
with self.assertWarnsRegex(
DeprecationWarning, "deprecated since version 1.2.3"
):
Foo()
def test_class_with_reason(self):
@deprecated("Because it is obsolete.")
class Foo:
pass
with self.assertWarnsRegex(
DeprecationWarning, "Because it is obsolete"
):
Foo()
@deprecated(reason="Because it is obsolete.")
class Foo2:
pass
with self.assertWarnsRegex(
DeprecationWarning, "Because it is obsolete"
):
Foo2()
def test_method(self):
class Foo:
@deprecated
def bar(self):
pass
with self.assertWarnsRegex(DeprecationWarning, "bar is deprecated"):
Foo().bar()
class Foo2:
@deprecated
def bar(self):
pass
with self.assertWarnsRegex(DeprecationWarning, "bar is deprecated"):
Foo2().bar()
def test_method_with_since(self):
class Foo:
@deprecated(since="1.2.3")
def bar(self):
pass
with self.assertWarnsRegex(
DeprecationWarning, "deprecated since version 1.2.3"
):
Foo().bar()
def test_method_with_reason(self):
class Foo:
@deprecated("Because it is obsolete.")
def bar(self):
pass
with self.assertWarnsRegex(
DeprecationWarning, "Because it is obsolete"
):
Foo().bar()
class Foo2:
@deprecated(reason="Because it is obsolete.")
def bar(self):
pass
with self.assertWarnsRegex(
DeprecationWarning, "Because it is obsolete"
):
Foo2().bar()
class AddSysPathTestCase(unittest.TestCase):
def test_add_sys_path(self):
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule # noqa: F811,F401
with (
temp_file("", name="mymodule.py") as module_path,
add_sys_path(module_path.parent),
):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule # noqa: F811,F401
unload_module("mymodule")
class EnsureUnloadModuleTestCase(unittest.TestCase):
def test_ensure_unload_module(self):
with (
temp_python_module("def foo():\n pass", name="bar"),
ensure_unload_module("bar"),
):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import bar # noqa: F401,F811
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import bar # noqa: F401,F811
def test_ensure_unload_module_exception(self):
with self.assertRaisesRegex(ValueError, "Ipsum"):
with (
temp_python_module(
"def func():\n raise ValueError('Ipsum')", name="bar"
),
ensure_unload_module("bar"),
):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import bar
bar.func()
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import bar
def test_add_sys_path_exception(self):
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule # noqa: F811,F401
try:
with (
temp_file("", name="mymodule.py") as module_path,
add_sys_path(module_path.parent),
):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule # noqa: F811,F401
raise ValueError()
except ValueError:
pass
finally:
unload_module("mymodule")
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule # noqa: F401,F811
class SnakeCaseTestCase(unittest.TestCase):
def test_snake_case(self):
self.assertEqual(snake_case("CamelCase"), "camel_case")
self.assertEqual(snake_case("camelCase"), "camel_case")
self.assertEqual(snake_case("snakecase"), "snakecase")
self.assertEqual(snake_case("snake_case"), "snake_case")
class EnumOrValueTestCase(unittest.TestCase):
def test_value(self):
self.assertEqual(enum_or_value(None), None)
self.assertEqual(enum_or_value("foo"), "foo")
self.assertEqual(enum_or_value(123), 123)
def test_enum(self):
class Foo(Enum):
BAR = "bar"
BAZ = "baz"
self.assertEqual(enum_or_value(Foo.BAR), "bar")
self.assertEqual(enum_or_value(Foo.BAZ), "baz")
class ParseTimedeltaTestCase(unittest.TestCase):
def test_parse_complex(self):
delta = parse_timedelta("1w2d4h5m6s")
self.assertEqual(delta.days, 9)
self.assertEqual(delta.seconds, 14706)
def test_parse_weeks(self):
delta = parse_timedelta("1w")
self.assertEqual(delta.days, 7)
self.assertEqual(delta.seconds, 0)
delta = parse_timedelta("1.5w")
self.assertEqual(delta.days, 10)
self.assertEqual(delta.seconds, 43200)
def test_parse_days(self):
delta = parse_timedelta("1d")
self.assertEqual(delta.days, 1)
self.assertEqual(delta.seconds, 0)
delta = parse_timedelta("1.5d")
self.assertEqual(delta.days, 1)
self.assertEqual(delta.seconds, 43200)
def test_parse_hours(self):
delta = parse_timedelta("1h")
self.assertEqual(delta.days, 0)
self.assertEqual(delta.seconds, 3600)
delta = parse_timedelta("1.5h")
self.assertEqual(delta.days, 0)
self.assertEqual(delta.seconds, 5400)
def test_parse_error(self):
with self.assertRaises(PontosError):
parse_timedelta("foo")
with self.assertRaises(PontosError):
parse_timedelta("1d2x")
with self.assertRaises(PontosError):
parse_timedelta("1,2d")
pontos-25.3.2/tests/test_pontos.py 0000664 0000000 0000000 00000002022 14762555663 0017241 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from unittest.mock import patch
from pontos import main
from pontos.version import __version__
class TestPontos(unittest.TestCase):
@patch("pontos.pontos.RichTerminal")
def test_pontos(self, terminal_mock):
main()
terminal_mock.return_value.print.assert_called()
terminal_mock.return_value.indent.assert_called()
terminal_mock.return_value.bold_info.assert_called()
terminal_mock.return_value.info.assert_called()
terminal_mock.return_value.warning.assert_called_once_with(
'Use the listed commands "help" for more information '
"and arguments description."
)
@patch("pontos.pontos.RichTerminal")
@patch("sys.argv", ["pontos", "--version"])
def test_pontos_version(self, terminal_mock):
main()
terminal_mock.return_value.print.assert_called_once_with(
f"pontos version {__version__}"
)
pontos-25.3.2/tests/testing/ 0000775 0000000 0000000 00000000000 14762555663 0015767 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/testing/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0020074 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/testing/test_testing.py 0000664 0000000 0000000 00000017005 14762555663 0021060 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import struct
import unittest
from pathlib import Path
from pontos.git import Git
from pontos.helper import unload_module
from pontos.testing import (
temp_directory,
temp_file,
temp_git_repository,
temp_python_module,
)
class TempDirectoryTestCase(unittest.TestCase):
def test_temp_directory(self):
with temp_directory() as tmp_dir:
tmp_file = tmp_dir / "test.txt"
tmp_file.write_text("Lorem Ipsum", encoding="utf8")
self.assertTrue(tmp_dir.exists())
self.assertTrue(tmp_file.exists())
self.assertFalse(tmp_dir.exists())
self.assertFalse(tmp_file.exists())
def test_temp_directory_exception(self):
try:
with temp_directory() as tmp_dir:
tmp_file = tmp_dir / "test.txt"
tmp_file.write_text("Lorem Ipsum", encoding="utf8")
self.assertTrue(tmp_dir.exists())
self.assertTrue(tmp_file.exists())
raise ValueError()
except ValueError:
pass
finally:
self.assertFalse(tmp_dir.exists())
self.assertFalse(tmp_file.exists())
def test_temp_directory_change_into(self):
old_cwd = Path.cwd()
with temp_directory(change_into=True) as tmp_dir:
new_cwd = Path.cwd()
self.assertEqual(new_cwd, tmp_dir.resolve())
self.assertNotEqual(old_cwd, new_cwd)
def test_temp_directory_add_to_sys_path(self):
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule2 # noqa: F401,F811
with temp_directory(add_to_sys_path=True) as module_path:
mymodule_file = module_path / "mymodule2.py"
mymodule_file.touch()
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule2 # noqa: F401,F811
unload_module("mymodule")
class TempGitRepositoryTestCase(unittest.TestCase):
def test_temp_git_repository(self):
with temp_git_repository(branch="foo") as git_directory:
test_file = git_directory / "test.txt"
test_file.write_text("Lorem Ipsum", encoding="utf8")
self.assertTrue(git_directory.exists())
self.assertTrue(test_file.exists())
git = Git(git_directory)
git.add(test_file)
self.assertFalse(git_directory.exists())
self.assertFalse(test_file.exists())
def test_temp_git_repository_exception(self):
try:
with temp_git_repository(branch="foo") as git_directory:
test_file = git_directory / "test.txt"
test_file.write_text("Lorem Ipsum", encoding="utf8")
self.assertTrue(git_directory.exists())
self.assertTrue(test_file.exists())
git = Git(git_directory)
git.add(test_file)
raise ValueError()
except ValueError:
pass
finally:
self.assertFalse(git_directory.exists())
self.assertFalse(test_file.exists())
class TempFileTestCase(unittest.TestCase):
def test_temp_file(self):
with temp_file("my content") as test_file:
self.assertTrue(test_file.exists())
self.assertEqual("my content", test_file.read_text(encoding="utf8"))
self.assertFalse(test_file.exists())
def test_temp_binary_file(self):
data = struct.pack(">if", 42, 2.71828182846)
with temp_file(data) as test_file:
self.assertTrue(test_file.exists())
self.assertEqual(data, test_file.read_bytes())
self.assertFalse(test_file.exists())
def test_temp_file_without_content(self):
with temp_file(name="foo.bar") as test_file:
self.assertTrue(test_file.exists())
self.assertTrue(test_file.is_file())
self.assertEqual("", test_file.read_text(encoding="utf8"))
self.assertFalse(test_file.exists())
def test_temp_file_exception(self):
try:
with temp_file("my content") as test_file:
self.assertTrue(test_file.exists())
self.assertEqual(
"my content", test_file.read_text(encoding="utf8")
)
raise ValueError()
except ValueError:
pass
finally:
self.assertFalse(test_file.exists())
def test_temp_file_name(self):
with temp_file("my content", name="foo.txt") as test_file:
self.assertTrue(test_file.exists())
self.assertEqual(test_file.name, "foo.txt")
self.assertEqual("my content", test_file.read_text(encoding="utf8"))
self.assertFalse(test_file.exists())
def test_temp_file_change_into(self):
old_cwd = Path.cwd()
with temp_file("my content", change_into=True) as test_file:
new_cwd = Path.cwd()
self.assertTrue(test_file.exists())
self.assertEqual("my content", test_file.read_text(encoding="utf8"))
self.assertEqual(new_cwd, test_file.parent.resolve())
self.assertNotEqual(old_cwd, new_cwd)
self.assertFalse(test_file.exists())
class TempPythonModuleTestCase(unittest.TestCase):
def test_temp_python_module(self):
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import foo # noqa: F401,F811
with temp_python_module("def foo():\n pass") as module_path:
self.assertTrue(module_path.exists())
# pylint: disable=import-error,import-outside-toplevel,unused-import
import foo # noqa: F401,F811
self.assertFalse(module_path.exists())
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import foo # noqa: F401,F811
def test_temp_python_module_exception(self):
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import foo # noqa: F401,F811
try:
with temp_python_module("def foo():\n pass") as module_path:
self.assertTrue(module_path.exists())
# pylint: disable=import-error,import-outside-toplevel,unused-import # noqa: E501
import foo # noqa: F401,F811
raise ValueError()
except ValueError:
pass
finally:
self.assertFalse(module_path.exists())
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import foo # noqa: F401,F811
def test_temp_python_module_name(self):
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule3 # noqa: F401,F811
with temp_python_module(
"def foo():\n pass", name="mymodule3"
) as module_path:
self.assertTrue(module_path.exists())
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule3 # noqa: F401,F811
self.assertFalse(module_path.exists())
with self.assertRaises(ImportError):
# pylint: disable=import-error,import-outside-toplevel,unused-import
import mymodule3 # noqa: F401,F811
pontos-25.3.2/tests/updateheader/ 0000775 0000000 0000000 00000000000 14762555663 0016745 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/updateheader/__init__.py 0000664 0000000 0000000 00000000141 14762555663 0021052 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/updateheader/test_header.py 0000664 0000000 0000000 00000052207 14762555663 0021614 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import datetime
import struct
from argparse import Namespace
from contextlib import redirect_stdout
from io import StringIO
from pathlib import Path
from unittest import TestCase
from unittest.mock import MagicMock, patch
from pontos.errors import PontosError
from pontos.testing import temp_directory, temp_file
from pontos.updateheader.updateheader import _add_header as add_header
from pontos.updateheader.updateheader import (
_compile_copyright_regex,
main,
parse_args,
update_file,
)
from pontos.updateheader.updateheader import (
_compile_outdated_regex as compile_outdated_regex,
)
from pontos.updateheader.updateheader import _find_copyright as find_copyright
from pontos.updateheader.updateheader import (
_get_exclude_list as get_exclude_list,
)
from pontos.updateheader.updateheader import (
_get_modified_year as get_modified_year,
)
from pontos.updateheader.updateheader import (
_remove_outdated_lines as remove_outdated_lines,
)
HEADER = """# SPDX-FileCopyrightText: {date} Greenbone AG
#
# SPDX-License-Identifier: AGPL-3.0-or-later"""
class GetModifiedYearTestCase(TestCase):
@patch("pontos.updateheader.updateheader.Git")
def test_get_modified_year(self, git_mock):
with temp_file(name="test.py", change_into=True) as test_file:
git_instance_mock = MagicMock()
git_instance_mock.log.return_value = ["2020"]
git_mock.return_value = git_instance_mock
year = get_modified_year(f=test_file)
self.assertEqual(year, "2020")
def test_get_modified_year_error(self):
with (
temp_directory(change_into=True) as temp_dir,
self.assertRaises(PontosError),
):
test_file = temp_dir / "test.py"
get_modified_year(f=test_file)
class FindCopyRightTestCase(TestCase):
def setUp(self) -> None:
self.company = "Greenbone AG"
self.regex = _compile_copyright_regex()
def test_find_copyright(self):
test_line = "# Copyright (C) 1995-2021 Greenbone AG"
test2_line = "# Copyright (C) 1995 Greenbone AG"
invalid_line = (
"# This program is free software: "
"you can redistribute it and/or modify"
)
# Full match
found, match = find_copyright(
copyright_regex=self.regex, line=test_line
)
self.assertTrue(found)
self.assertIsNotNone(match)
self.assertEqual(match.creation_year, "1995")
self.assertEqual(match.modification_year, "2021")
self.assertEqual(match.company, self.company)
# No modification Date
found, match = find_copyright(
copyright_regex=self.regex, line=test2_line
)
self.assertTrue(found)
self.assertIsNotNone(match)
self.assertEqual(match.creation_year, "1995")
self.assertIsNone(match.modification_year)
self.assertEqual(match.company, self.company)
# No match
found, match = find_copyright(
copyright_regex=self.regex, line=invalid_line
)
self.assertFalse(found)
self.assertIsNone(match)
def test_find_spdx_copyright(self):
test_line = "# SPDX-FileCopyrightText: 1995-2021 Greenbone AG"
test2_line = "# SPDX-FileCopyrightText: 1995 Greenbone AG"
invalid_line = (
"# This program is free software: "
"you can redistribute it and/or modify"
)
# Full match
found, match = find_copyright(
copyright_regex=self.regex, line=test_line
)
self.assertTrue(found)
self.assertIsNotNone(match)
self.assertEqual(match.creation_year, "1995")
self.assertEqual(match.modification_year, "2021")
self.assertEqual(match.company, self.company)
# No modification Date
found, match = find_copyright(
copyright_regex=self.regex, line=test2_line
)
self.assertTrue(found)
self.assertIsNotNone(match)
self.assertEqual(match.creation_year, "1995")
self.assertIsNone(match.modification_year)
self.assertEqual(match.company, self.company)
# No match
found, match = find_copyright(
copyright_regex=self.regex, line=invalid_line
)
self.assertFalse(found)
self.assertIsNone(match)
class AddHeaderTestCase(TestCase):
def setUp(self):
self.company = "Greenbone AG"
def test_add_header(self):
expected_header = HEADER.format(date="2021") + "\n"
header = add_header(
suffix=".py",
license_id="AGPL-3.0-or-later",
company=self.company,
year="2021",
)
self.assertEqual(header, expected_header)
def test_add_header_wrong_file_suffix(self):
with self.assertRaises(ValueError):
add_header(
suffix=".prr",
license_id="AGPL-3.0-or-later",
company=self.company,
year="2021",
)
def test_add_header_license_not_found(self):
with self.assertRaises(FileNotFoundError):
add_header(
suffix=".py",
license_id="AAAGPL-3.0-or-later",
company=self.company,
year="2021",
)
class UpdateFileTestCase(TestCase):
maxDiff = None
def setUp(self):
self.company = "Greenbone AG"
self.path = Path(__file__).parent
@patch("sys.stdout", new_callable=StringIO)
def test_update_file_not_existing(self, mock_stdout):
year = "2020"
license_id = "AGPL-3.0-or-later"
with temp_directory(change_into=True) as temp_dir:
test_file = temp_dir / "test.py"
with self.assertRaises(FileNotFoundError):
update_file(
test_file,
year,
license_id,
self.company,
)
ret = mock_stdout.getvalue()
self.assertEqual(
ret,
f"{test_file}: File is not existing.\n",
)
@patch("sys.stdout", new_callable=StringIO)
def test_update_file_wrong_license(self, mock_stdout):
year = "2020"
license_id = "AAAGPL-3.0-or-later"
with temp_file(name="test.py", change_into=True) as test_file:
update_file(
test_file,
year,
license_id,
self.company,
)
ret = mock_stdout.getvalue()
self.assertEqual(
ret,
f"{test_file}: License file for "
"AAAGPL-3.0-or-later is not existing.\n",
)
@patch("sys.stdout", new_callable=StringIO)
def test_update_file_suffix_invalid(self, mock_stdout):
year = "2020"
license_id = "AGPL-3.0-or-later"
with temp_file(name="test.pppy", change_into=True) as test_file:
update_file(
test_file,
year,
license_id,
self.company,
)
ret = mock_stdout.getvalue()
self.assertEqual(
ret,
f"{test_file}: No license header for the format .pppy found.\n",
)
@patch("sys.stdout", new_callable=StringIO)
def test_update_file_binary_file(self, mock_stdout):
year = "2020"
license_id = "AGPL-3.0-or-later"
# create a Binary file ...
# https://stackoverflow.com/a/30148554
data = struct.pack(">if", 42, 2.71828182846)
with (
temp_file(name="test.py", content=data) as test_file,
self.assertRaises(UnicodeDecodeError),
):
update_file(
test_file,
year,
license_id,
self.company,
)
ret = mock_stdout.getvalue()
self.assertEqual(
ret,
f"{test_file}: Ignoring binary file.\n",
)
@patch("sys.stdout", new_callable=StringIO)
def test_update_create_header(self, mock_stdout):
year = "1995"
license_id = "AGPL-3.0-or-later"
expected_header = HEADER.format(date="1995") + "\n\n"
with temp_file(name="test.py", change_into=True) as test_file:
update_file(
test_file,
year,
license_id,
self.company,
)
ret = mock_stdout.getvalue()
self.assertEqual(
f"{test_file}: Added license header.\n",
ret,
)
self.assertEqual(
expected_header, test_file.read_text(encoding="utf-8")
)
@patch("sys.stdout", new_callable=StringIO)
def test_update_create_header_single_year(self, mock_stdout):
year = "1995"
license_id = "AGPL-3.0-or-later"
expected_header = HEADER.format(date="1995") + "\n\n"
with temp_file(name="test.py", change_into=True) as test_file:
update_file(
test_file, year, license_id, self.company, single_year=True
)
ret = mock_stdout.getvalue()
self.assertEqual(
f"{test_file}: Added license header.\n",
ret,
)
self.assertEqual(
expected_header, test_file.read_text(encoding="utf-8")
)
@patch("sys.stdout", new_callable=StringIO)
def test_update_header_in_file(self, mock_stdout):
year = "2021"
license_id = "AGPL-3.0-or-later"
header = HEADER.format(date="2020")
with temp_file(
content=header, name="test.py", change_into=True
) as test_file:
update_file(
test_file,
year,
license_id,
self.company,
)
ret = mock_stdout.getvalue()
self.assertEqual(
ret,
f"{test_file}: Changed License Header "
"Copyright Year None -> 2021\n",
)
self.assertIn(
"# SPDX-FileCopyrightText: 2020-2021 Greenbone AG",
test_file.read_text(encoding="utf-8"),
)
@patch("sys.stdout", new_callable=StringIO)
def test_update_header_in_file_single_year(self, mock_stdout):
year = "2021"
license_id = "AGPL-3.0-or-later"
header = HEADER.format(date="2020-2021")
with temp_file(
content=header, name="test.py", change_into=True
) as test_file:
update_file(
test_file,
year,
license_id,
self.company,
single_year=True,
)
ret = mock_stdout.getvalue()
self.assertEqual(
ret,
f"{test_file}: Changed License Header Copyright Year format to single year "
"2020-2021 -> 2020\n",
)
self.assertIn(
"# SPDX-FileCopyrightText: 2020 Greenbone AG",
test_file.read_text(encoding="utf-8"),
)
@patch("sys.stdout", new_callable=StringIO)
def test_update_header_ok_in_file(self, mock_stdout):
year = "2021"
license_id = "AGPL-3.0-or-later"
header = HEADER.format(date="2021")
with temp_file(
content=header, name="test.py", change_into=True
) as test_file:
update_file(
test_file,
year,
license_id,
self.company,
)
ret = mock_stdout.getvalue()
self.assertEqual(
ret,
f"{test_file}: License Header is ok.\n",
)
self.assertIn(
"# SPDX-FileCopyrightText: 2021 Greenbone AG",
test_file.read_text(encoding="utf-8"),
)
def test_cleanup_file(self):
test_content = """# Copyright (C) 2021-2022 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
import foo
import bar
foo.baz(bar.boing)
""" # noqa: E501
expected_content = f"""# SPDX-FileCopyrightText: 2021-{str(datetime.datetime.now().year)} Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import foo
import bar
foo.baz(bar.boing)
""" # noqa: E501
company = "Greenbone AG"
year = str(datetime.datetime.now().year)
license_id = "GPL-3.0-or-later"
with temp_file(content=test_content, name="foo.py") as tmp:
update_file(
tmp,
year,
license_id,
company,
cleanup=True,
)
new_content = tmp.read_text(encoding="utf-8")
self.assertEqual(expected_content, new_content)
def test_cleanup_file_spdx_header(self):
test_content = """
# SPDX-FileCopyrightText: 2021 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import foo
import bar
foo.baz(bar.boing)
""" # noqa: E501
expected_content = f"""
# SPDX-FileCopyrightText: 2021-{str(datetime.datetime.now().year)} Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import foo
import bar
foo.baz(bar.boing)
""" # noqa: E501
company = "Greenbone AG"
year = str(datetime.datetime.now().year)
license_id = "GPL-3.0-or-later"
with temp_file(content=test_content, name="foo.py") as tmp:
update_file(
tmp,
year,
license_id,
company,
cleanup=True,
)
new_content = tmp.read_text(encoding="utf-8")
self.assertEqual(expected_content, new_content)
def test_cleanup_file_changed_company(self):
test_content = """
# SPDX-FileCopyrightText: 2021 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import foo
import bar
foo.baz(bar.boing)
""" # noqa: E501
expected_content = f"""
# SPDX-FileCopyrightText: 2021-{str(datetime.datetime.now().year)} ACME Inc.
#
# SPDX-License-Identifier: GPL-3.0-or-later
import foo
import bar
foo.baz(bar.boing)
""" # noqa: E501
company = "ACME Inc."
year = str(datetime.datetime.now().year)
license_id = "GPL-3.0-or-later"
with temp_file(content=test_content, name="foo.py") as tmp:
update_file(
tmp,
year,
license_id,
company,
cleanup=True,
)
new_content = tmp.read_text(encoding="utf-8")
self.assertEqual(expected_content, new_content)
class ParseArgsTestCase(TestCase):
def test_argparser_files(self):
args = ["-f", "test.py", "-y", "2021", "-l", "AGPL-3.0-or-later"]
args = parse_args(args)
self.assertEqual(args.company, "Greenbone AG")
self.assertEqual(args.files, ["test.py"])
self.assertEqual(args.year, "2021")
self.assertEqual(args.license_id, "AGPL-3.0-or-later")
def test_argparser_dir(self):
args = ["-d", ".", "-c", "-l", "AGPL-3.0-or-later"]
args = parse_args(args)
self.assertEqual(args.directories, ["."])
self.assertEqual(args.company, "Greenbone AG")
self.assertTrue(args.changed)
self.assertEqual(args.year, str(datetime.datetime.now().year))
self.assertEqual(args.license_id, "AGPL-3.0-or-later")
def test_defaults(self):
args = ["-f", "foo.txt"]
args = parse_args(args)
self.assertFalse(args.quiet)
self.assertIsNone(args.log_file)
self.assertFalse(args.changed)
self.assertEqual(args.year, str(datetime.date.today().year))
self.assertEqual(args.license_id, "GPL-3.0-or-later")
self.assertEqual(args.company, "Greenbone AG")
self.assertEqual(args.files, ["foo.txt"])
self.assertIsNone(args.directories)
self.assertIsNone(args.exclude_file)
self.assertFalse(args.single_year)
self.assertFalse(args.cleanup)
def test_files_and_directories_mutual_exclusive(self):
args = ["--files", "foo", "--directories", "bar"]
with self.assertRaises(SystemExit) as cm:
args = parse_args(args)
self.assertIn(
"argument -d/--directories: not allowed with argument -f/--file",
cm.msg,
)
class GetExcludeListTestCase(TestCase):
def test_get_exclude_list(self):
# Try to find the current file from two directories up...
test_dirname = Path(__file__).parent.parent.parent
# with a relative glob
test_ignore_file = Path("ignore.file")
test_ignore_file.write_text("*.py\n", encoding="utf-8")
exclude_list = get_exclude_list(
test_ignore_file, [test_dirname.resolve()]
)
self.assertIn(Path(__file__), exclude_list)
test_ignore_file.unlink()
class MainTestCase(TestCase):
def setUp(self) -> None:
self.args = Namespace()
self.args.company = "Greenbone AG"
def test_main(self):
args = [
"--year",
"2021",
"--license",
"AGPL-3.0-or-later",
"--files",
"test.py",
]
with redirect_stdout(StringIO()):
main(args)
@patch("sys.stdout", new_callable=StringIO)
@patch("pontos.updateheader.updateheader.parse_args")
def test_main_never_happen(self, argparser_mock, mock_stdout):
self.args.year = "2021"
self.args.changed = False
self.args.license_id = "AGPL-3.0-or-later"
self.args.files = None
self.args.directories = None
self.args.verbose = 0
self.args.log_file = None
self.args.quiet = False
self.args.cleanup = False
self.args.single_year = False
argparser_mock.return_value = self.args
# I have no idea how or why test main ...
with self.assertRaises(SystemExit):
main()
ret = mock_stdout.getvalue()
self.assertIn(
"Specify files to update!",
ret,
)
def test_update_file_changed_no_git(self):
args = [
"--changed",
"--year",
"1999",
"--files",
]
with (
redirect_stdout(StringIO()) as out,
temp_directory(change_into=True) as temp_dir,
):
test_file = temp_dir / "test.py"
args.append(str(test_file))
main(args)
ret = out.getvalue()
self.assertIn(
"Could not get date of last modification via git, "
f"using 1999 instead.{test_file}: File is not existing.",
ret.replace("\n", ""),
)
class RemoveOutdatedLinesTestCase(TestCase):
def setUp(self) -> None:
self.compiled_regexes = compile_outdated_regex()
def test_remove_outdated_lines(self):
test_content = """* This program is free software: you can redistribute it and/or modify
*it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
//License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of
# modify it under the terms of the GNU General Public License
# This program is free software; you can redistribute it and/or
# version 2 as published by the Free Software Foundation.
This program is free software: you can redistribute it and/or modify""" # noqa: E501
new_content = remove_outdated_lines(
content=test_content, cleanup_regexes=self.compiled_regexes
)
self.assertEqual(new_content, "\n")
def test_remove_outdated_lines2(self):
test_content = """the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
* GNU General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
# -*- coding: utf-8 -*-
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.""" # noqa: E501
new_content = remove_outdated_lines(
content=test_content, cleanup_regexes=self.compiled_regexes
)
self.assertEqual(new_content, "\n")
pontos-25.3.2/tests/version/ 0000775 0000000 0000000 00000000000 14762555663 0015777 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/version/__init__.py 0000664 0000000 0000000 00000000627 14762555663 0020115 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import os
from contextlib import contextmanager
from pathlib import Path
@contextmanager
def use_cwd(path: Path) -> None:
"""
Context Manager to change the current working directory temporaryly
"""
current_cwd = Path.cwd()
os.chdir(str(path))
yield
os.chdir(str(current_cwd))
pontos-25.3.2/tests/version/commands/ 0000775 0000000 0000000 00000000000 14762555663 0017600 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/version/commands/__init__.py 0000664 0000000 0000000 00000000135 14762555663 0021710 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/version/commands/test_cargo.py 0000664 0000000 0000000 00000007540 14762555663 0022312 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
import unittest
from contextlib import contextmanager
from pathlib import Path
from typing import Iterator
import tomlkit
from pontos.testing import temp_directory, temp_file
from pontos.version import VersionError
from pontos.version.commands._cargo import CargoVersionCommand
from pontos.version.schemes import PEP440VersioningScheme
VERSION_EXAMPLE = """
[package]
name = "nasl-syntax"
version = "0.1.0"
edition = "2021"
license = "GPL-2.0-or-later"
"""
WORKSPACE_EXAMPLE = """
[workspace]
members = [
"nasl-syntax",
"nasl-interpreter",
"nasl-cli",
"storage",
"redis-storage",
"json-storage",
"feed",
"feed-verifier",
]
"""
class VerifyCargoUpdateCommandTestCase(unittest.TestCase):
@contextmanager
def __create_cargo_layout(self) -> Iterator[Path]:
with temp_directory(change_into=True) as temporary_dir:
workspace = temporary_dir / "Cargo.toml"
workspace.write_text(WORKSPACE_EXAMPLE)
members = tomlkit.parse(WORKSPACE_EXAMPLE)["workspace"]["members"]
for cargo_workspace_member in members:
npath = temporary_dir / f"{cargo_workspace_member}"
npath.mkdir()
pf = npath / "Cargo.toml"
pf.write_text(
VERSION_EXAMPLE.replace(
"nasl-syntax", cargo_workspace_member
)
)
yield temporary_dir
return None
def test_update(self):
def expected_changed_files(temporary_dir_with_cargo_toml):
members = tomlkit.parse(WORKSPACE_EXAMPLE)["workspace"]["members"]
return [
(temporary_dir_with_cargo_toml / m / "Cargo.toml").resolve()
for m in members
]
with self.__create_cargo_layout() as temporary_dir_with_cargo_toml:
cargo = CargoVersionCommand(PEP440VersioningScheme)
previous = PEP440VersioningScheme.parse_version("0.1.0")
new_version = PEP440VersioningScheme.parse_version("23.4.1")
updated = cargo.update_version(new_version)
self.assertEqual(updated.previous, previous)
self.assertEqual(updated.new, new_version)
self.assertEqual(
updated.changed_files,
expected_changed_files(temporary_dir_with_cargo_toml),
)
def test_update_fail(self):
with self.__create_cargo_layout():
cargo = CargoVersionCommand(PEP440VersioningScheme)
previous = PEP440VersioningScheme.parse_version("0.1.0")
new_version = PEP440VersioningScheme.parse_version("0.1.0")
updated = cargo.update_version(new_version)
self.assertEqual(updated.previous, previous)
self.assertEqual(updated.new, new_version)
self.assertEqual(
updated.changed_files,
[],
)
class VerifyCargoVersionCommandTestCase(unittest.TestCase):
def test_verify_failure(self):
with temp_file(
VERSION_EXAMPLE,
name="Cargo.toml",
change_into=True,
):
version = PEP440VersioningScheme.parse_version("2.3.4")
cargo = CargoVersionCommand(PEP440VersioningScheme)
with self.assertRaisesRegex(
VersionError,
"Provided version 2.3.4 does not match the "
"current version 0.1.0.",
):
cargo.verify_version(version)
def test_success(self):
with temp_file(
VERSION_EXAMPLE,
name="Cargo.toml",
change_into=True,
):
version = PEP440VersioningScheme.parse_version("0.1.0")
cargo = CargoVersionCommand(PEP440VersioningScheme)
cargo.verify_version(version)
pontos-25.3.2/tests/version/commands/test_cmake.py 0000664 0000000 0000000 00000024662 14762555663 0022303 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable=protected-access
import unittest
from unittest.mock import MagicMock, patch
from pontos.testing import temp_directory, temp_file
from pontos.version import VersionError
from pontos.version.commands._cmake import (
CMakeVersionCommand,
CMakeVersionParser,
)
from pontos.version.schemes import PEP440VersioningScheme
class VerifyCMakeVersionCommandTestCase(unittest.TestCase):
def test_verify_failure(self):
with temp_file(
"project(VERSION 1.2.3)\nset(PROJECT_DEV_VERSION 0)",
name="CMakeLists.txt",
change_into=True,
):
cmake = CMakeVersionCommand(PEP440VersioningScheme)
version = PEP440VersioningScheme.parse_version("2.3.4")
with self.assertRaisesRegex(
VersionError,
"Provided version 2.3.4 does not match the "
"current version 1.2.3.",
):
cmake.verify_version(version)
def test_verify_current(self):
with temp_directory(
change_into=True,
):
cmake = CMakeVersionCommand(PEP440VersioningScheme)
with self.assertRaisesRegex(
VersionError, "^.*CMakeLists.txt not found."
):
cmake.verify_version("current")
with self.assertRaisesRegex(
VersionError, "^.*CMakeLists.txt not found."
):
cmake.verify_version(version=None)
class GetCurrentCMakeVersionCommandTestCase(unittest.TestCase):
# pylint: disable=line-too-long
@patch(
"pontos.version.commands._cmake.CMakeVersionCommand.get_current_version",
MagicMock(return_value=PEP440VersioningScheme.parse_version("21.4")),
)
def test_return_0_correct_version_on_verify(self):
with temp_file(
"",
name="CMakeLists.txt",
change_into=True,
):
cmake = CMakeVersionCommand(PEP440VersioningScheme)
version = PEP440VersioningScheme.parse_version("21.4")
cmake.verify_version(version)
def test_should_call_print_current_version_without_raising_exception(self):
with temp_file(
"project(VERSION 21)",
name="CMakeLists.txt",
change_into=True,
):
cmake = CMakeVersionCommand(PEP440VersioningScheme)
version = PEP440VersioningScheme.parse_version("21")
self.assertEqual(cmake.get_current_version(), version)
class UpdateCMakeVersionCommandTestCase(unittest.TestCase):
def test_update_version(self):
with temp_file(
"project(VERSION 21)\nset(PROJECT_DEV_VERSION 0)",
name="CMakeLists.txt",
change_into=True,
) as temp:
cmake = CMakeVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22")
previous_version = PEP440VersioningScheme.parse_version("21")
updated = cmake.update_version(new_version)
self.assertEqual(
"project(VERSION 22)\nset(PROJECT_DEV_VERSION 0)",
temp.read_text(encoding="utf8"),
)
self.assertEqual(updated.previous, previous_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.changed_files, [temp.resolve()])
def test_update_dev_version(self):
with temp_file(
"project(VERSION 21)\nset(PROJECT_DEV_VERSION 0)",
name="CMakeLists.txt",
change_into=True,
) as temp:
cmake = CMakeVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22.dev1")
previous_version = PEP440VersioningScheme.parse_version("21")
updated = cmake.update_version(new_version)
self.assertEqual(
"project(VERSION 22.0.0)\nset(PROJECT_DEV_VERSION 1)",
temp.read_text(encoding="utf8"),
)
self.assertEqual(updated.previous, previous_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.changed_files, [temp.resolve()])
def test_no_update(self):
with temp_file(
"project(VERSION 22)\nset(PROJECT_DEV_VERSION 0)",
name="CMakeLists.txt",
change_into=True,
) as temp:
cmake = CMakeVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22")
previous_version = PEP440VersioningScheme.parse_version("22")
updated = cmake.update_version(new_version)
self.assertEqual(
"project(VERSION 22)\nset(PROJECT_DEV_VERSION 0)",
temp.read_text(encoding="utf8"),
)
self.assertEqual(updated.previous, previous_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.changed_files, [])
def test_forced_update(self):
with temp_file(
"project(VERSION 22)\nset(PROJECT_DEV_VERSION 0)",
name="CMakeLists.txt",
change_into=True,
) as temp:
cmake = CMakeVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22")
previous_version = PEP440VersioningScheme.parse_version("22")
updated = cmake.update_version(new_version, force=True)
self.assertEqual(
"project(VERSION 22)\nset(PROJECT_DEV_VERSION 0)",
temp.read_text(encoding="utf8"),
)
self.assertEqual(updated.previous, previous_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.changed_files, [temp.resolve()])
class ProjectFileCMakeVersionCommandTestCase(unittest.TestCase):
def test_project_file_not_found(self):
with temp_directory(change_into=True):
cmd = CMakeVersionCommand(PEP440VersioningScheme)
self.assertFalse(cmd.project_found())
def test_project_file_found(self):
with temp_file(name="CMakeLists.txt", change_into=True):
cmd = CMakeVersionCommand(PEP440VersioningScheme)
self.assertTrue(cmd.project_found())
class CMakeVersionParserTestCase(unittest.TestCase):
def test_get_current_version_single_line_project(self):
under_test = CMakeVersionParser("project(VERSION 2.3.4)")
version = PEP440VersioningScheme.parse_version("2.3.4")
self.assertEqual(under_test.get_current_version(), version)
def test_update_version_project(self):
under_test = CMakeVersionParser("project(VERSION 2.3.4)")
version = PEP440VersioningScheme.parse_version("2.3.5")
self.assertEqual(
under_test.update_version(version),
"project(VERSION 2.3.5)",
)
def test_not_confuse_version_outside_project(self):
under_test = CMakeVersionParser(
"non_project(VERSION 2.3.5)\nproject(VERSION 2.3.4)"
)
version = PEP440VersioningScheme.parse_version("2.3.4")
self.assertEqual(under_test.get_current_version(), version)
def test_get_current_version_multiline_project(self):
under_test = CMakeVersionParser("project\n(\nVERSION\n\t 2.3.4)")
version = PEP440VersioningScheme.parse_version("2.3.4")
self.assertEqual(under_test.get_current_version(), version)
def test_find_project_dev_version(self):
test_cmake_lists = """
project(
DESCRIPTION something
VERSION 41.41.41
LANGUAGES c
)
set(
PROJECT_DEV_VERSION 1
)
"""
under_test = CMakeVersionParser(test_cmake_lists)
self.assertEqual(under_test._project_dev_version_line_number, 7)
self.assertEqual(under_test._project_dev_version, "1")
def test_update_project_dev_version(self):
test_cmake_lists = """
project(
DESCRIPTION something
VERSION 41.41.41
LANGUAGES c
)
set(
PROJECT_DEV_VERSION 1
)
"""
under_test = CMakeVersionParser(test_cmake_lists)
version = PEP440VersioningScheme.parse_version("41.41.41")
self.assertEqual(under_test._project_dev_version_line_number, 7)
self.assertEqual(under_test._project_dev_version, "1")
result = under_test.update_version(version)
self.assertEqual(under_test._project_dev_version, "0")
self.assertEqual(
result,
test_cmake_lists.replace(
"PROJECT_DEV_VERSION 1", "PROJECT_DEV_VERSION 0"
),
)
def test_update_project_dev_version_when_succeeded_by_another_set(self):
test_cmake_lists = """
cmake_minimum_required(VERSION 3.1)
project(hello_world VERSION 41.41.41)
set(PROJECT_DEV_VERSION 1)
add_executable(app main.c)
"""
under_test = CMakeVersionParser(test_cmake_lists)
version = PEP440VersioningScheme.parse_version("41.41.41")
self.assertEqual(under_test._project_dev_version_line_number, 4)
self.assertEqual(under_test._project_dev_version, "1")
result = under_test.update_version(version)
self.assertEqual(under_test._project_dev_version, "0")
self.assertEqual(
result,
test_cmake_lists.replace(
"PROJECT_DEV_VERSION 1", "PROJECT_DEV_VERSION 0"
),
)
def test_get_current_version_multiline_project_combined_token(self):
under_test = CMakeVersionParser(
"project\n(\nDESCRIPTION something VERSION 2.3.4 LANGUAGES c\n)"
)
version = PEP440VersioningScheme.parse_version("2.3.4")
self.assertEqual(under_test.get_current_version(), version)
def test_raise_exception_project_no_version(self):
with self.assertRaises(ValueError) as context:
CMakeVersionParser("project(DESCRIPTION something LANGUAGES c)")
self.assertEqual(
str(context.exception), "unable to find cmake version in project."
)
def test_raise_exception_no_project(self):
with self.assertRaises(ValueError) as context:
CMakeVersionParser(
"non_project(VERSION 2.3.5)",
)
self.assertEqual(
str(context.exception), "unable to find cmake version."
)
pontos-25.3.2/tests/version/commands/test_go.py 0000664 0000000 0000000 00000024114 14762555663 0021620 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2021-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from dataclasses import dataclass
from pathlib import Path
from unittest.mock import MagicMock, patch
from pontos.testing import temp_directory, temp_file
from pontos.version import VersionError
from pontos.version.commands._go import GoVersionCommand
from pontos.version.schemes import SemanticVersioningScheme
@dataclass
class StdOutput:
stdout: bytes
VERSION_FILE_PATH = "version.go"
TEMPLATE = """package {}
// THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
var version = "{}"
\n"""
class GetCurrentGoVersionCommandTestCase(unittest.TestCase):
def test_getting_version(self):
with temp_file(
name="go.mod",
change_into=True,
):
version = "0.0.1"
version_file_path = Path(VERSION_FILE_PATH)
version_file_path.write_text(
TEMPLATE.format("main", version), encoding="utf-8"
)
result_version = GoVersionCommand(
SemanticVersioningScheme
).get_current_version()
self.assertEqual(
result_version, SemanticVersioningScheme.parse_version(version)
)
version_file_path.unlink()
def test_no_version_found(self):
exp_err_msg = "No version found in the version.go file."
with (
temp_file(
name="go.mod",
change_into=True,
),
self.assertRaisesRegex(
VersionError,
exp_err_msg,
),
):
version_file_path = Path(VERSION_FILE_PATH)
version_file_path.touch()
GoVersionCommand(SemanticVersioningScheme).get_current_version()
def test_no_version_file(self):
exp_err_msg = (
"No version.go file found. This file is required for pontos"
)
with (
temp_file(
name="go.mod",
change_into=True,
),
self.assertRaisesRegex(
VersionError,
exp_err_msg,
),
):
GoVersionCommand(SemanticVersioningScheme).get_current_version()
def test_invalid_version(self):
with (
temp_file(
name="go.mod",
change_into=True,
),
self.assertRaisesRegex(
VersionError, "abc is not valid SemVer string"
),
):
version_file_path = Path(VERSION_FILE_PATH)
version_file_path.write_text(
TEMPLATE.format("main", "abc"), encoding="utf-8"
)
GoVersionCommand(SemanticVersioningScheme).get_current_version()
class VerifyGoVersionCommandTestCase(unittest.TestCase):
def test_verify_version(self):
with (
temp_file(
name="go.mod",
change_into=True,
),
patch.object(
GoVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version(
"21.0.1"
)
),
),
):
cmd = GoVersionCommand(SemanticVersioningScheme)
cmd.verify_version(SemanticVersioningScheme.parse_version("21.0.1"))
def test_verify_branch_not_equal(self):
with (
temp_file(
name="go.mod",
change_into=True,
),
patch.object(
GoVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version(
"21.0.1"
)
),
),
self.assertRaisesRegex(
VersionError,
"Provided version 21.2.0 does not match the current version "
"21.0.1.",
),
):
cmd = GoVersionCommand(SemanticVersioningScheme)
cmd.verify_version(SemanticVersioningScheme.parse_version("21.2.0"))
def test_verify_current(self):
with (
temp_file(
name="go.mod",
change_into=True,
),
patch.object(
GoVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version(
"21.0.1"
)
),
),
):
cmd = GoVersionCommand(SemanticVersioningScheme)
cmd.verify_version("current")
cmd.verify_version(version=None)
def test_verify_current_failure(self):
with temp_file(
name="go.mod",
change_into=True,
):
cmd = GoVersionCommand(SemanticVersioningScheme)
with self.assertRaisesRegex(
VersionError,
"^No version.go file found. This file is required for pontos",
):
cmd.verify_version("current")
with self.assertRaisesRegex(
VersionError,
"^No version.go file found. This file is required for pontos",
):
cmd.verify_version(version=None)
class UpdateGoVersionCommandTestCase(unittest.TestCase):
def test_no_file_update_version(self):
with temp_directory(change_into=True) as temp:
go_mod = temp / "go.mod"
go_mod.touch()
version = SemanticVersioningScheme.parse_version("22.2.2")
updated_version_obj = GoVersionCommand(
SemanticVersioningScheme
).update_version(version)
version_file_path = Path(VERSION_FILE_PATH)
content = version_file_path.read_text(encoding="utf-8")
self.assertIn(str(version), content)
self.assertIsNone(updated_version_obj.previous)
self.assertEqual(updated_version_obj.new, version)
self.assertEqual(
updated_version_obj.changed_files, [version_file_path]
)
def test_update_version(self):
with temp_file(name="go.mod", change_into=True):
cmd = GoVersionCommand(SemanticVersioningScheme)
version = SemanticVersioningScheme.parse_version("22.2.2")
version_file_path = Path(VERSION_FILE_PATH)
version_file_path.write_text(
TEMPLATE.format("foo", "0.0.1"), encoding="utf-8"
)
updated = cmd.update_version(version)
content = version_file_path.read_text(encoding="utf-8")
self.assertIn(str(version), content)
self.assertIn("foo", content)
version_file_path.unlink()
self.assertEqual(updated.new, version)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("0.0.1"),
)
self.assertEqual(updated.changed_files, [version_file_path])
def test_create_file_update_version(self):
with temp_file(name="go.mod", change_into=True):
with patch.object(
GoVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version(
"21.0.1"
)
),
):
version = SemanticVersioningScheme.parse_version("22.2.2")
cmd = GoVersionCommand(SemanticVersioningScheme)
updated = cmd.update_version(version)
version_file_path = Path(VERSION_FILE_PATH)
content = version_file_path.read_text(encoding="utf-8")
self.assertIn(str(version), content)
version_file_path.unlink()
self.assertEqual(updated.new, version)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("21.0.1"),
)
self.assertEqual(updated.changed_files, [version_file_path])
def test_no_update(self):
with temp_file(name="go.mod", change_into=True):
cmd = GoVersionCommand(SemanticVersioningScheme)
version = SemanticVersioningScheme.parse_version("22.2.2")
version_file_path = Path(VERSION_FILE_PATH)
version_file_path.write_text(
TEMPLATE.format("main", "22.2.2"), encoding="utf-8"
)
updated = cmd.update_version(version)
content = version_file_path.read_text(encoding="utf-8")
self.assertIn(str(version), content)
self.assertEqual(updated.new, version)
self.assertEqual(updated.previous, version)
self.assertEqual(updated.changed_files, [])
def test_forced_update(self):
with temp_file(name="go.mod", change_into=True):
cmd = GoVersionCommand(SemanticVersioningScheme)
version = SemanticVersioningScheme.parse_version("22.2.2")
version_file_path = Path(VERSION_FILE_PATH)
version_file_path.write_text(
TEMPLATE.format("main", "22.2.2"), encoding="utf-8"
)
updated = cmd.update_version(version, force=True)
content = version_file_path.read_text(encoding="utf-8")
self.assertIn(str(version), content)
self.assertEqual(updated.new, version)
self.assertEqual(updated.previous, version)
self.assertEqual(updated.changed_files, [version_file_path])
class ProjectFileGoVersionCommandTestCase(unittest.TestCase):
def test_project_file_not_found(self):
with temp_directory(change_into=True):
cmd = GoVersionCommand(SemanticVersioningScheme)
self.assertFalse(cmd.project_found())
def test_project_file_found(self):
with temp_file(name="go.mod", change_into=True):
cmd = GoVersionCommand(SemanticVersioningScheme)
self.assertTrue(cmd.project_found())
pontos-25.3.2/tests/version/commands/test_java.py 0000664 0000000 0000000 00000030330 14762555663 0022131 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pathlib import Path
from string import Template
from pontos.testing import temp_directory, temp_file
from pontos.version import VersionError
from pontos.version.commands import JavaVersionCommand
from pontos.version.schemes import SemanticVersioningScheme
TEMPLATE_UPGRADE_VERSION_SINGLE_JSON = """{
"files": [
{
"path": "README.md",
"line": 3
}
]
}
"""
TEMPLATE_UPGRADE_VERSION_MULTI_JSON = """{
"files": [
{
"path": "README.md",
"line": 3
},
{
"path": "application.properties",
"line": 2
}
]
}
"""
TEMPLATE_UPGRADE_VERSION_WITH_LINE_JSON = Template(
"""{
"files": [
{
"path": "README.md",
"line": ${LINE_NO}
}
]
}
"""
)
TEMPLATE_UPGRADE_VERSION_MARKDOWN = """# Task service
**task service**: Version {}
## starting the local
"""
TEMPLATE_UPGRADE_VERSION_WITH_VERSION_PROPERTIES = """# application
sentry.release={}
server.port=8080
"""
class VerifyJavaVersionParsingTestCase(unittest.TestCase):
def test_version_parsing(self):
versions = {
"2023.12.10",
"2023.1.1",
"2023.10.1",
"2023.1.99",
"0.0.1",
"1.2.3-a1",
"1.2.3-alpha1",
"1.2.3-alpha1-dev1",
"1.2.3-b1",
"1.2.3-beta1",
"1.2.3-beta1-dev1",
"1.2.3-rc1",
"1.2.3-rc1-dev1",
"1.2.3-dev1",
"22.4.1",
"22.4.1-dev1",
"0.5.0.dev1",
"1.0.0-dev1",
"1.0.0-alpha1",
"1.0.0-alpha1-dev1",
"1.0.0-beta1",
"1.0.0-beta1-dev1",
"1.0.0-rc1",
"1.0.0-rc1-dev1",
}
for version in versions:
with self.subTest(version=version):
matches = JavaVersionCommand(
SemanticVersioningScheme
).parse_line(f"pre{version}post")
self.assertEqual(matches.group("pre"), "pre")
self.assertEqual(matches.group("version"), version)
self.assertEqual(matches.group("post"), "post")
class GetCurrentJavaVersionCommandTestCase(unittest.TestCase):
def test_getting_version(self):
with temp_directory(change_into=True):
version_file_path = Path("upgradeVersion.json")
version_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_SINGLE_JSON,
encoding="utf-8",
)
version = "2023.9.3"
readme_file_path = Path("README.md")
readme_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
encoding="utf-8",
)
result_version = JavaVersionCommand(
SemanticVersioningScheme
).get_current_version()
self.assertEqual(
result_version, SemanticVersioningScheme.parse_version(version)
)
version_file_path.unlink()
readme_file_path.unlink()
def test_getting_version_no_files_configured(self):
exp_err_msg = "no version found"
with (
temp_directory(change_into=True),
self.assertRaisesRegex(
VersionError,
exp_err_msg,
),
):
version_file_path = Path("upgradeVersion.json")
version_file_path.write_text(
"""{"files": []}""",
encoding="utf-8",
)
JavaVersionCommand(SemanticVersioningScheme).get_current_version()
version_file_path.unlink()
def test_getting_version_without_version_config(self):
exp_err_msg = (
r"No /tmp/.*/upgradeVersion\.json config file found\. "
r"This file is required for pontos"
)
with (
temp_directory(change_into=True),
self.assertRaisesRegex(
VersionError,
exp_err_msg,
),
):
JavaVersionCommand(SemanticVersioningScheme).get_current_version()
class VerifyJavaVersionCommandTestCase(unittest.TestCase):
def test_verify_version(self):
with temp_directory(change_into=True):
version_file_path = Path("upgradeVersion.json")
version_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_MULTI_JSON, encoding="utf-8"
)
version = "2023.9.3"
readme_file_path = Path("README.md")
readme_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
encoding="utf-8",
)
properties_file_path = Path("application.properties")
properties_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_WITH_VERSION_PROPERTIES.format(
version
),
encoding="latin-1",
)
JavaVersionCommand(SemanticVersioningScheme).verify_version(
SemanticVersioningScheme.parse_version(version)
)
version_file_path.unlink()
readme_file_path.unlink()
properties_file_path.unlink()
def test_verify_version_does_not_match(self):
exp_err_msg = (
r"Provided version 2023\.9\.4 does not match the "
+ r"current version 2023\.9\.3 "
+ r"in '/tmp/.*/upgradeVersion\.json'"
)
with (
temp_directory(change_into=True),
self.assertRaisesRegex(
VersionError,
exp_err_msg,
),
):
version_file_path = Path("upgradeVersion.json")
version_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_SINGLE_JSON, encoding="utf-8"
)
version = "2023.9.3"
new_version = "2023.9.4"
readme_file_path = Path("README.md")
readme_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
encoding="utf-8",
)
JavaVersionCommand(SemanticVersioningScheme).verify_version(
SemanticVersioningScheme.parse_version(new_version)
)
version_file_path.unlink()
readme_file_path.unlink()
class UpdateJavaVersionCommandTestCase(unittest.TestCase):
def test_update_version(self):
with temp_directory(change_into=True):
version_file_path = Path("upgradeVersion.json")
version_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_SINGLE_JSON, encoding="utf-8"
)
version = "2023.9.3"
readme_file_path = Path("README.md")
readme_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
encoding="utf-8",
)
new_version = "2023.9.4"
updated_version_obj = JavaVersionCommand(
SemanticVersioningScheme
).update_version(
SemanticVersioningScheme.parse_version(new_version)
)
self.assertEqual(
updated_version_obj.previous,
SemanticVersioningScheme.parse_version(version),
)
self.assertEqual(
updated_version_obj.new,
SemanticVersioningScheme.parse_version(new_version),
)
self.assertEqual(
updated_version_obj.changed_files, [Path("README.md")]
)
content = readme_file_path.read_text(encoding="UTF-8")
self.assertEqual(
content,
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(new_version),
)
version_file_path.unlink()
readme_file_path.unlink()
def test_no_update_version(self):
with temp_directory(change_into=True):
version_file_path = Path("upgradeVersion.json")
version_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_SINGLE_JSON,
encoding="utf-8",
)
version = "2023.9.3"
readme_file_path = Path("README.md")
readme_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
encoding="utf-8",
)
updated_version_obj = JavaVersionCommand(
SemanticVersioningScheme
).update_version(SemanticVersioningScheme.parse_version(version))
self.assertEqual(
updated_version_obj.previous,
SemanticVersioningScheme.parse_version(version),
)
self.assertEqual(
updated_version_obj.new,
SemanticVersioningScheme.parse_version(version),
)
self.assertEqual(
updated_version_obj.changed_files,
[],
)
content = readme_file_path.read_text(encoding="UTF-8")
self.assertEqual(
content,
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
)
version_file_path.unlink()
readme_file_path.unlink()
def test_forced_update_version(self):
with temp_directory(change_into=True):
version_file_path = Path("upgradeVersion.json")
version_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_SINGLE_JSON,
encoding="utf-8",
)
version = "2023.9.3"
readme_file_path = Path("README.md")
readme_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
encoding="utf-8",
)
updated_version_obj = JavaVersionCommand(
SemanticVersioningScheme
).update_version(
SemanticVersioningScheme.parse_version(version), force=True
)
self.assertEqual(
updated_version_obj.previous,
SemanticVersioningScheme.parse_version(version),
)
self.assertEqual(
updated_version_obj.new,
SemanticVersioningScheme.parse_version(version),
)
self.assertEqual(
updated_version_obj.changed_files,
[Path("README.md")],
)
content = readme_file_path.read_text(encoding="UTF-8")
self.assertEqual(
content,
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
)
version_file_path.unlink()
readme_file_path.unlink()
def test_update_version_upgrade_config_with_wrong_line_number(self):
exp_err_msg = (
"Line has no version, "
"file:'README.md' "
"lineNo:4 "
"content:'\n'"
)
with (
temp_directory(change_into=True),
self.assertRaisesRegex(
VersionError,
exp_err_msg,
),
):
version_file_path = Path("upgradeVersion.json")
version_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_WITH_LINE_JSON.substitute(LINE_NO="4"),
encoding="utf-8",
)
version = "2023.9.3"
readme_file_path = Path("README.md")
readme_file_path.write_text(
TEMPLATE_UPGRADE_VERSION_MARKDOWN.format(version),
encoding="utf-8",
)
new_version = "2023.9.4"
JavaVersionCommand(SemanticVersioningScheme).update_version(
SemanticVersioningScheme.parse_version(new_version)
)
version_file_path.unlink()
readme_file_path.unlink()
class ProjectFileJavaVersionCommandTestCase(unittest.TestCase):
def test_project_file_not_found(self):
with temp_directory(change_into=True):
cmd = JavaVersionCommand(SemanticVersioningScheme)
self.assertFalse(cmd.project_found())
def test_project_file_found(self):
with temp_file(name="upgradeVersion.json", change_into=True):
cmd = JavaVersionCommand(SemanticVersioningScheme)
self.assertTrue(cmd.project_found())
pontos-25.3.2/tests/version/commands/test_javascript.py 0000664 0000000 0000000 00000041114 14762555663 0023360 0 ustar 00root root 0000000 0000000 # Copyright (C) 2022-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import json
import unittest
from unittest.mock import MagicMock, patch
from pontos.testing import temp_directory, temp_file
from pontos.version import VersionError
from pontos.version.commands import JavaScriptVersionCommand
from pontos.version.schemes import SemanticVersioningScheme
class GetCurrentJavaScriptVersionCommandTestCase(unittest.TestCase):
def test_get_current_version(self):
content = '{"name": "foo", "version": "1.2.3"}'
with temp_file(content, name="package.json", change_into=True):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
version = cmd.get_current_version()
self.assertEqual(
version, SemanticVersioningScheme.parse_version("1.2.3")
)
def test_no_project_file(self):
with (
temp_directory(change_into=True),
self.assertRaisesRegex(VersionError, ".* file not found."),
):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.get_current_version()
def test_no_package_version(self):
content = '{"name": "foo"}'
with (
temp_file(content, name="package.json", change_into=True),
self.assertRaisesRegex(VersionError, "Version field missing in"),
):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.get_current_version()
def test_no_valid_json_in_package_version(self):
content = "{"
with (
temp_file(content, name="package.json", change_into=True),
self.assertRaisesRegex(VersionError, "No valid JSON found."),
):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.get_current_version()
class UpdateJavaScriptVersionCommandTestCase(unittest.TestCase):
def test_update_version_file(self):
content = '{"name":"foo", "version":"1.2.3"}'
with temp_file(content, name="package.json", change_into=True) as temp:
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.get_current_version()
updated = cmd.update_version(
SemanticVersioningScheme.parse_version("22.4.0")
)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("1.2.3"),
)
self.assertEqual(
updated.new, SemanticVersioningScheme.parse_version("22.4.0")
)
self.assertEqual(updated.changed_files, [temp.resolve()])
with temp.open(mode="r", encoding="utf-8") as fp:
fake_package = json.load(fp)
self.assertEqual(fake_package["version"], "22.4.0")
def test_update_js_version_file(self):
content = '{"name":"foo", "version":"1.2.3"}'
js_content = """const foo = "bar";
const VERSION = "1.2.3";
const func = () => ();
"""
with temp_directory(change_into=True) as temp_dir:
package_json = temp_dir / "package.json"
package_json.write_text(content, encoding="utf8")
js_version_file = (
temp_dir / JavaScriptVersionCommand.version_file_paths[0]
)
js_version_file.parent.mkdir()
js_version_file.write_text(js_content, encoding="utf8")
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
updated = cmd.update_version(
SemanticVersioningScheme.parse_version("22.4.0")
)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("1.2.3"),
)
self.assertEqual(
updated.new, SemanticVersioningScheme.parse_version("22.4.0")
)
self.assertEqual(
updated.changed_files,
[
package_json.resolve(),
JavaScriptVersionCommand.version_file_paths[0],
],
)
with package_json.open(mode="r", encoding="utf-8") as fp:
fake_package = json.load(fp)
self.assertEqual(fake_package["version"], "22.4.0")
self.assertEqual(
js_version_file.read_text(encoding="utf8"),
'const foo = "bar";\nconst VERSION = "22.4.0";\n'
"const func = () => ();\n",
)
def test_update_js_version_file_with_single_quotes(self):
content = '{"name":"foo", "version":"1.2.3"}'
js_content = """const foo = "bar";
const VERSION = '1.2.3';
const func = () => ();
"""
with temp_directory(change_into=True) as temp_dir:
package_json = temp_dir / "package.json"
package_json.write_text(content, encoding="utf8")
js_version_file = (
temp_dir / JavaScriptVersionCommand.version_file_paths[0]
)
js_version_file.parent.mkdir()
js_version_file.write_text(js_content, encoding="utf8")
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
updated = cmd.update_version(
SemanticVersioningScheme.parse_version("22.4.0")
)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("1.2.3"),
)
self.assertEqual(
updated.new, SemanticVersioningScheme.parse_version("22.4.0")
)
self.assertEqual(
updated.changed_files,
[
package_json.resolve(),
JavaScriptVersionCommand.version_file_paths[0],
],
)
with package_json.open(mode="r", encoding="utf-8") as fp:
fake_package = json.load(fp)
self.assertEqual(fake_package["version"], "22.4.0")
self.assertEqual(
js_version_file.read_text(encoding="utf8"),
"const foo = \"bar\";\nconst VERSION = '22.4.0';\n"
"const func = () => ();\n",
)
def test_update_version_files(self):
content = '{"name":"foo", "version":"1.2.3"}'
file_content = """const foo = "bar";
const VERSION = "1.2.3";
const func = () => ();
"""
with temp_directory(change_into=True) as temp_dir:
package_json = temp_dir / "package.json"
package_json.write_text(content, encoding="utf8")
js_version_file = (
temp_dir / JavaScriptVersionCommand.version_file_paths[0]
)
js_version_file.parent.mkdir()
js_version_file.write_text(file_content, encoding="utf8")
ts_version_file = (
temp_dir / JavaScriptVersionCommand.version_file_paths[1]
)
ts_version_file.write_text(file_content, encoding="utf8")
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
updated = cmd.update_version(
SemanticVersioningScheme.parse_version("22.4.0")
)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("1.2.3"),
)
self.assertEqual(
updated.new, SemanticVersioningScheme.parse_version("22.4.0")
)
self.assertEqual(
updated.changed_files,
[
package_json.resolve(),
JavaScriptVersionCommand.version_file_paths[0],
JavaScriptVersionCommand.version_file_paths[1],
],
)
with package_json.open(mode="r", encoding="utf-8") as fp:
fake_package = json.load(fp)
self.assertEqual(fake_package["version"], "22.4.0")
self.assertEqual(
js_version_file.read_text(encoding="utf8"),
'const foo = "bar";\nconst VERSION = "22.4.0";\n'
"const func = () => ();\n",
)
def test_update_version_develop(self):
content = '{"name":"foo", "version":"1.2.3"}'
with temp_file(content, name="package.json", change_into=True) as temp:
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
new_version = SemanticVersioningScheme.parse_version("22.4.0-dev1")
updated = cmd.update_version(new_version)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("1.2.3"),
)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.changed_files, [temp.resolve()])
with temp.open(mode="r", encoding="utf-8") as fp:
fake_package = json.load(fp)
self.assertEqual(fake_package["version"], "22.4.0-dev1")
def test_no_update(self):
content = '{"name":"foo", "version":"1.2.3"}'
with temp_file(content, name="package.json", change_into=True) as temp:
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
updated = cmd.update_version(
SemanticVersioningScheme.parse_version("1.2.3")
)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("1.2.3"),
)
self.assertEqual(
updated.new, SemanticVersioningScheme.parse_version("1.2.3")
)
self.assertEqual(updated.changed_files, [])
with temp.open(mode="r", encoding="utf-8") as fp:
fake_package = json.load(fp)
self.assertEqual(fake_package["version"], "1.2.3")
def test_forced_update(self):
content = '{"name":"foo", "version":"1.2.3"}'
with temp_file(content, name="package.json", change_into=True) as temp:
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
updated = cmd.update_version(
SemanticVersioningScheme.parse_version("1.2.3"), force=True
)
self.assertEqual(
updated.previous,
SemanticVersioningScheme.parse_version("1.2.3"),
)
self.assertEqual(
updated.new, SemanticVersioningScheme.parse_version("1.2.3")
)
self.assertEqual(updated.changed_files, [temp.resolve()])
with temp.open(mode="r", encoding="utf-8") as fp:
fake_package = json.load(fp)
self.assertEqual(fake_package["version"], "1.2.3")
class VerifyJavaScriptVersionCommandTestCase(unittest.TestCase):
def test_versions_not_equal(self):
with (
patch.object(
JavaScriptVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version("1.2.3")
),
),
self.assertRaisesRegex(
VersionError,
"Provided version .* does not match the current version .*",
),
):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.verify_version(SemanticVersioningScheme.parse_version("22.4.0"))
def test_verify_success(self):
with patch.object(
JavaScriptVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version("22.4.0")
),
):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.verify_version(SemanticVersioningScheme.parse_version("22.4.0"))
def test_verify_js_mismatch(self):
with (
patch.object(
JavaScriptVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version(
"22.4.0"
)
),
),
patch.object(
JavaScriptVersionCommand,
"_get_current_file_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version(
"22.5.0"
)
),
),
self.assertRaisesRegex(
VersionError,
"Provided version 22.4.0 does not match the current version 22.5.0 "
"in src/version.js.",
),
):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.verify_version(SemanticVersioningScheme.parse_version("22.4.0"))
def test_verify_ts_mismatch(self):
with (
patch.object(
JavaScriptVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version(
"22.4.0"
)
),
),
patch.object(
JavaScriptVersionCommand,
"_get_current_file_version",
MagicMock(
side_effect=[
SemanticVersioningScheme.parse_version("22.4.0"),
SemanticVersioningScheme.parse_version("22.5.0"),
]
),
),
self.assertRaisesRegex(
VersionError,
"Provided version 22.4.0 does not match the current version 22.5.0 "
"in src/version.ts.",
),
):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.verify_version(SemanticVersioningScheme.parse_version("22.4.0"))
def test_verify_current(self):
with patch.object(
JavaScriptVersionCommand,
"get_current_version",
MagicMock(
return_value=SemanticVersioningScheme.parse_version("22.4.0")
),
):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.verify_version("current")
cmd.verify_version(None)
def test_verify_current_failure(self):
with temp_directory(change_into=True):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
with self.assertRaisesRegex(
VersionError, "^.*package.json file not found"
):
cmd.verify_version("current")
with self.assertRaisesRegex(
VersionError, "^.*package.json file not found"
):
cmd.verify_version(None)
def test_verify_current_js_version_matches(self):
content = '{"name":"foo", "version":"1.2.3"}'
js_content = 'const VERSION = "1.2.3";'
with temp_directory(change_into=True) as temp_dir:
package_json = temp_dir / "package.json"
package_json.write_text(content, encoding="utf8")
js_version_file = (
temp_dir / JavaScriptVersionCommand.version_file_paths[0]
)
js_version_file.parent.mkdir()
js_version_file.write_text(js_content, encoding="utf8")
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.verify_version("current")
cmd.verify_version(None)
def test_verify_current_js_mismatch(self):
content = '{"name":"foo", "version":"1.2.3"}'
js_content = 'const VERSION = "1.2.4";'
with (
temp_directory(change_into=True) as temp_dir,
self.assertRaisesRegex(
VersionError,
"The version 1.2.4 in src/version.js doesn't match the current "
"version 1.2.3.",
),
):
package_json = temp_dir / "package.json"
package_json.write_text(content, encoding="utf8")
js_version_file = (
temp_dir / JavaScriptVersionCommand.version_file_paths[0]
)
js_version_file.parent.mkdir()
js_version_file.write_text(js_content, encoding="utf8")
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
cmd.verify_version("current")
cmd.verify_version(None)
class ProjectFileJavaScriptVersionCommandTestCase(unittest.TestCase):
def test_project_file_not_found(self):
with temp_directory(change_into=True):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
self.assertFalse(cmd.project_found())
def test_project_file_found(self):
with temp_file(name="package.json", change_into=True):
cmd = JavaScriptVersionCommand(SemanticVersioningScheme)
self.assertTrue(cmd.project_found())
pontos-25.3.2/tests/version/commands/test_python.py 0000664 0000000 0000000 00000040534 14762555663 0022540 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# pylint: disable = protected-access
import unittest
from pathlib import Path
from unittest.mock import MagicMock, PropertyMock, patch
import tomlkit
from pontos.testing import temp_directory, temp_file, temp_python_module
from pontos.version import VersionError
from pontos.version.commands._python import PythonVersionCommand
from pontos.version.schemes import (
PEP440VersioningScheme,
SemanticVersioningScheme,
)
class GetCurrentPythonVersionCommandTestCase(unittest.TestCase):
def test_missing_tool_pontos_version_section(self):
with (
temp_file("[tool.pontos]", name="pyproject.toml", change_into=True),
self.assertRaisesRegex(
VersionError,
r"^\[tool\.pontos\.version\] section missing in .*\.$",
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
cmd.get_current_version()
def test_missing_version_module_file_key(self):
with (
temp_file(
'[tool.pontos.version]\nname="foo"',
name="pyproject.toml",
change_into=True,
),
self.assertRaisesRegex(
VersionError,
r"^version-module-file key not set in \[tool\.pontos\.version\] "
r"section .*\.$",
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
cmd.get_current_version()
def test_version_file_path(self):
with temp_file(
'[tool.pontos.version]\nversion-module-file="foo/__version__.py"',
name="pyproject.toml",
change_into=True,
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
self.assertEqual(
cmd.version_file_path, Path("foo") / "__version__.py"
)
def test_pyproject_toml_file_not_exists(self):
with (
temp_directory(change_into=True),
self.assertRaisesRegex(
VersionError, "pyproject.toml file not found."
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
cmd.get_current_version()
def test_no_version_module(self):
with (
temp_file(
'[tool.pontos.version]\nversion-module-file = "foo.py"',
name="pyproject.toml",
change_into=True,
),
self.assertRaisesRegex(
VersionError,
r"Could not load version from 'foo'\. .* not found.",
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
cmd.get_current_version()
def test_get_current_version(self):
with temp_python_module(
"__version__ = '1.2.3'", name="foo", change_into=True
) as tmp_module:
tmp_file = tmp_module.parent / "pyproject.toml"
tmp_file.write_text(
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
cmd = PythonVersionCommand(PEP440VersioningScheme)
version = cmd.get_current_version()
self.assertEqual(
version, PEP440VersioningScheme.parse_version("1.2.3")
)
def test_get_current_semantic_version(self):
with temp_python_module(
"__version__ = '1.2.3a1'", name="foo", change_into=True
) as tmp_module:
tmp_file = tmp_module.parent / "pyproject.toml"
tmp_file.write_text(
'[tool.poetry]\nversion = "1.2.3a1"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
cmd = PythonVersionCommand(SemanticVersioningScheme)
version = cmd.get_current_version()
self.assertEqual(
version, PEP440VersioningScheme.parse_version("1.2.3a1")
)
self.assertIsInstance(version, PEP440VersioningScheme.version_cls)
class UpdatePythonVersionTestCase(unittest.TestCase):
def test_update_version_file(self):
content = "__version__ = '21.1'"
with temp_python_module(content, name="foo", change_into=True) as temp:
tmp_file = temp.parent / "pyproject.toml"
tmp_file.write_text(
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
cmd = PythonVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22.2")
previous_version = PEP440VersioningScheme.parse_version("21.1")
updated = cmd.update_version(new_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.previous, previous_version)
self.assertEqual(
updated.changed_files, [Path("foo.py"), tmp_file.resolve()]
)
text = temp.read_text(encoding="utf8")
*_, version_line, _last_line = text.split("\n")
self.assertEqual(version_line, '__version__ = "22.2"')
def test_empty_pyproject_toml(self):
with (
temp_file("", name="pyproject.toml", change_into=True),
self.assertRaisesRegex(
VersionError,
r"\[tool.pontos.version\] section missing in .*pyproject\.toml\.",
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22.1.2")
cmd.update_version(new_version)
def test_empty_tool_section(self):
with (
temp_file("[tool]", name="pyproject.toml", change_into=True),
self.assertRaisesRegex(
VersionError,
r"\[tool.pontos.version\] section missing in .*pyproject\.toml\.",
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22.1.2")
cmd.update_version(new_version)
def test_empty_tool_poetry_section(self):
content = "__version__ = '22.1'"
with temp_python_module(content, name="foo", change_into=True) as temp:
tmp_file = temp.parent / "pyproject.toml"
tmp_file.write_text(
"[tool.poetry]\n"
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
cmd = PythonVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22.2")
previous_version = PEP440VersioningScheme.parse_version("22.1")
updated = cmd.update_version(new_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.previous, previous_version)
self.assertEqual(
updated.changed_files, [Path("foo.py"), tmp_file.resolve()]
)
text = tmp_file.read_text(encoding="utf8")
toml = tomlkit.parse(text)
self.assertEqual(toml["tool"]["poetry"]["version"], "22.2")
def test_override_existing_version(self):
content = "__version__ = '1.2.3'"
with temp_python_module(content, name="foo", change_into=True) as temp:
tmp_file = temp.parent / "pyproject.toml"
tmp_file.write_text(
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
cmd = PythonVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22.2")
previous_version = PEP440VersioningScheme.parse_version("1.2.3")
updated = cmd.update_version(new_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.previous, previous_version)
self.assertEqual(
updated.changed_files, [Path("foo.py"), tmp_file.resolve()]
)
text = tmp_file.read_text(encoding="utf8")
toml = tomlkit.parse(text)
self.assertEqual(toml["tool"]["poetry"]["version"], "22.2")
def test_development_version(self):
content = "__version__ = '1.2.3'"
with temp_python_module(content, name="foo", change_into=True) as temp:
tmp_file = temp.parent / "pyproject.toml"
tmp_file.write_text(
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
cmd = PythonVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("22.2.dev1")
previous_version = PEP440VersioningScheme.parse_version("1.2.3")
updated = cmd.update_version(new_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.previous, previous_version)
self.assertEqual(
updated.changed_files, [Path("foo.py"), tmp_file.resolve()]
)
text = tmp_file.read_text(encoding="utf8")
toml = tomlkit.parse(text)
self.assertEqual(toml["tool"]["poetry"]["version"], "22.2.dev1")
def test_no_update(self):
content = "__version__ = '1.2.3'"
with temp_python_module(content, name="foo", change_into=True) as temp:
tmp_file = temp.parent / "pyproject.toml"
tmp_file.write_text(
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
cmd = PythonVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("1.2.3")
updated = cmd.update_version(new_version)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.previous, new_version)
self.assertEqual(updated.changed_files, [])
def test_forced_updated(self):
content = "__version__ = '1.2.3'"
with temp_python_module(content, name="foo", change_into=True) as temp:
tmp_file = temp.parent / "pyproject.toml"
tmp_file.write_text(
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
cmd = PythonVersionCommand(PEP440VersioningScheme)
new_version = PEP440VersioningScheme.parse_version("1.2.3")
updated = cmd.update_version(new_version, force=True)
self.assertEqual(updated.new, new_version)
self.assertEqual(updated.previous, new_version)
self.assertEqual(
updated.changed_files, [Path("foo.py"), tmp_file.resolve()]
)
text = tmp_file.read_text(encoding="utf8")
toml = tomlkit.parse(text)
self.assertEqual(toml["tool"]["poetry"]["version"], "1.2.3")
class VerifyVersionTestCase(unittest.TestCase):
def test_current_version_not_equal_pyproject_toml_version(self):
fake_version_py = Path("foo.py")
with (
patch.object(
PythonVersionCommand,
"get_current_version",
MagicMock(
return_value=PEP440VersioningScheme.parse_version("1.2.3")
),
),
patch.object(
PythonVersionCommand,
"version_file_path",
new=PropertyMock(return_value=fake_version_py),
),
self.assertRaisesRegex(
VersionError,
"The version .* in .* doesn't match the current version .*.",
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
version = PEP440VersioningScheme.parse_version("1.2.3")
cmd.verify_version(version)
def test_current_version(self):
fake_version_py = Path("foo.py")
content = (
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"'
)
with (
temp_file(content, name="pyproject.toml", change_into=True),
patch.object(
PythonVersionCommand,
"get_current_version",
MagicMock(
return_value=PEP440VersioningScheme.parse_version("1.2.3")
),
),
patch.object(
PythonVersionCommand,
"version_file_path",
new=PropertyMock(return_value=fake_version_py),
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
cmd.verify_version("current")
def test_current_failure(self):
fake_version_py = Path("foo.py")
content = (
'[tool.poetry]\nversion = "1.2.4"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"'
)
with (
temp_file(content, name="pyproject.toml", change_into=True),
patch.object(
PythonVersionCommand,
"get_current_version",
MagicMock(
return_value=PEP440VersioningScheme.parse_version("1.2.3")
),
),
patch.object(
PythonVersionCommand,
"version_file_path",
new=PropertyMock(return_value=fake_version_py),
),
self.assertRaisesRegex(
VersionError,
"The version .* in .* doesn't match the current version .*.",
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
cmd.verify_version("current")
def test_provided_version_mismatch(self):
fake_version_py = Path("foo.py")
content = (
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"'
)
with (
temp_file(content, name="pyproject.toml", change_into=True),
patch.object(
PythonVersionCommand,
"get_current_version",
MagicMock(
return_value=PEP440VersioningScheme.parse_version("1.2.3")
),
),
patch.object(
PythonVersionCommand,
"version_file_path",
new=PropertyMock(return_value=fake_version_py),
),
):
with self.assertRaisesRegex(
VersionError,
"Provided version .* does not match the current version .*.",
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
version = PEP440VersioningScheme.parse_version("1.2.4")
cmd.verify_version(version)
def test_verify_success(self):
fake_version_py = Path("foo.py")
content = (
'[tool.poetry]\nversion = "1.2.3"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"'
)
with (
temp_file(content, name="pyproject.toml", change_into=True),
patch.object(
PythonVersionCommand,
"get_current_version",
MagicMock(
return_value=PEP440VersioningScheme.parse_version("1.2.3")
),
),
patch.object(
PythonVersionCommand,
"version_file_path",
new=PropertyMock(return_value=fake_version_py),
),
):
cmd = PythonVersionCommand(PEP440VersioningScheme)
version = PEP440VersioningScheme.parse_version("1.2.3")
cmd.verify_version(version)
class ProjectFilePythonVersionCommandTestCase(unittest.TestCase):
def test_project_file_not_found(self):
with temp_directory(change_into=True):
cmd = PythonVersionCommand(PEP440VersioningScheme)
self.assertFalse(cmd.project_found())
def test_project_file_found(self):
with temp_file(name="pyproject.toml", change_into=True):
cmd = PythonVersionCommand(PEP440VersioningScheme)
self.assertTrue(cmd.project_found())
pontos-25.3.2/tests/version/schemes/ 0000775 0000000 0000000 00000000000 14762555663 0017426 5 ustar 00root root 0000000 0000000 pontos-25.3.2/tests/version/schemes/__init__.py 0000664 0000000 0000000 00000000135 14762555663 0021536 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
pontos-25.3.2/tests/version/schemes/test_pep440.py 0000664 0000000 0000000 00000106175 14762555663 0022065 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from datetime import datetime
from pontos.version._errors import VersionError
from pontos.version.schemes._pep440 import PEP440Version as Version
from pontos.version.schemes._pep440 import (
PEP440VersionCalculator as VersionCalculator,
)
from pontos.version.schemes._semantic import SemanticVersion
class PEP440VersionTestCase(unittest.TestCase):
def test_parse_version(self):
versions = [
"0.0.1",
"1.2.3",
"1.2.3.post1",
"1.2.3a1",
"1.2.3b1",
"1.2.3rc1",
"1.2.3a1+dev1",
"1.2.3a1.dev1",
"22.4.1",
"22.4.1.dev1",
"22.4.1.dev3",
"2022.4.1.dev3",
"2022.4.1",
]
for version in versions:
self.assertEqual(Version.from_string(version), Version(version))
def test_parse_version_from_semver(self):
versions = [
"0.0.1",
"1.2.3",
"1.2.3-post1.dev1",
"1.2.3-a1",
"1.2.3-b1",
"1.2.3-rc1",
"1.2.3-a1+dev1",
"1.2.3-a1-dev1",
"1.4.1",
"2.4.1-dev1",
"2.4.1-dev3",
]
for version in versions:
self.assertEqual(Version.from_string(version), Version(version))
def test_parsed_version(self):
versions = [
"0.0.1",
"1.2.3",
"1.2.3-post1.dev1",
"1.2.3-a1",
"1.2.3-b1",
"1.2.3-rc1",
"1.2.3-a1+dev1",
"1.2.3-a1-dev1",
"1.4.1",
"2.4.1-dev1",
"2.4.1-dev3",
"1.2.3.post1",
"1.2.3a1",
"1.2.3b1",
"1.2.3rc1",
"1.2.3a1+dev1",
"1.2.3a1.dev1",
"22.4.1.dev1",
"22.4.1.dev3",
"2022.4.1.dev3",
]
for version in versions:
self.assertEqual(
Version.from_string(version).parsed_version, version
)
semver_version = SemanticVersion.from_string("22.4.1-dev1")
pep440_version = Version.from_version(semver_version)
self.assertEqual(str(pep440_version), "22.4.1.dev1")
self.assertEqual(pep440_version.parsed_version, "22.4.1-dev1")
def test_parse_error(self):
versions = [
"abc",
"1.2.3d",
]
for version in versions:
with self.assertRaisesRegex(
VersionError, "^Invalid version: '.*'$"
):
Version.from_string(version)
def test_equal(self):
versions = [
("1.0.0", "1.0.0"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0.dev1", "1.0.0.dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0a1", "1.0.0-alpha1"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev1"),
("1.0.0a1.dev1", "1.0.0-alpha1-dev1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0b1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0rc1", "1.0.0-rc1"),
]
for version1, version2 in versions:
self.assertTrue(
Version.from_string(version1) == Version.from_string(version2),
f"{version1} does not equal {version2}",
)
versions = [
("1.0.0", "1.0.1"),
("1.0.0", "1.0.0+dev1"),
("1.0.0", "1.0.0.dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0.dev1", "1.0.0.dev2"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev2"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev2"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version1, version2 in versions:
self.assertFalse(
Version.from_string(version1) == Version.from_string(version2),
f"{version1} equals {version2}",
)
versions = [
("1.0.0", "abc"),
("1.0.0", None),
]
for version1, version2 in versions:
self.assertFalse(Version.from_string(version1) == version2)
versions = [
("1.0.0", object()),
("1.0.0", 1),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) == version2)
def test_equal_with_semantic_version(self):
versions = [
("1.0.0", "1.0.0"),
("1.0.0.dev1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-a1", "1.0.0-alpha1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1-dev1"),
("1.0.0a1.dev1", "1.0.0-alpha1-dev1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-b1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0a1", "1.0.0-alpha1"),
("1.0.0b1", "1.0.0-beta1"),
("1.0.0rc1", "1.0.0-rc1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0a1+dev1", "1.0.0-alpha1+dev1"),
("1.0.0b1+dev1", "1.0.0-beta1+dev1"),
("1.0.0rc1+dev1", "1.0.0-rc1+dev1"),
]
for version1, version2 in versions:
pep440 = Version.from_string(version1)
semver = SemanticVersion.from_string(version2)
self.assertTrue(
pep440 == semver,
f"{pep440!r} {version1} does not equal {semver!r} {version2}",
)
versions = []
for version1, version2 in versions:
pep440 = Version.from_string(version1)
semver = SemanticVersion.from_string(version2)
self.assertFalse(
pep440 == semver,
f"{pep440!r} {version1} equals {semver!r} {version2}",
)
def test_not_equal(self):
versions = [
("1.0.0", "1.0.0"),
("1.0.0.dev1", "1.0.0.dev1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev1"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1"),
]
for version1, version2 in versions:
self.assertFalse(
Version.from_string(version1) != Version.from_string(version2),
f"{version1} does not equal {version2}",
)
versions = [
("1.0.0", "1.0.1"),
("1.0.0", "1.0.0+dev1"),
("1.0.0", "1.0.0.dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0.dev1", "1.0.0.dev2"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1", "1.0.0-alpha1.dev1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1", "1.0.0-beta1.dev1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev2"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1", "1.0.0-rc1.dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev2"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version1, version2 in versions:
self.assertTrue(
Version.from_string(version1) != Version.from_string(version2),
f"{version1} equals {version2}",
)
versions = [
("1.0.0", "abc"),
("1.0.0", None),
]
for version1, version2 in versions:
self.assertTrue(Version.from_string(version1) != version2)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) != version2)
def test_greater_then(self):
versions = [
("1.0.0", "0.9.9999"),
("1.0.1", "1.0.0"),
("1.0.0", "1.0.0.dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1.dev1"),
("1.0.0-alpha2", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-dev1"),
("1.0.0-beta1", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-beta1.dev1"),
("1.0.0-beta2", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-dev1"),
("1.0.0-rc1", "1.0.0-alpha1"),
("1.0.0-rc1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1.dev1"),
("1.0.0-rc2", "1.0.0-rc1"),
]
for version1, version2 in versions:
self.assertTrue(
Version.from_string(version1) > Version.from_string(version2),
f"{version1} should be greater then {version2}",
)
versions = [
("1.0.0", "1.0.0"),
("1.0.0", "1.0.0+dev1"),
("1.0.0.dev1", "1.0.0.dev1"),
("1.0.0.dev1", "1.0.0.dev2"),
("1.0.0", "1.0.1"),
("1.0.0-dev1", "1.0.0"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev2"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev2"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version1, version2 in versions:
self.assertFalse(
Version.from_string(version1) > Version.from_string(version2),
f"{version1} should not be greater then {version2}",
)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) > version2)
def test_greater_or_equal_then(self):
versions = [
("1.0.0", "0.9.9999"),
("1.0.1", "1.0.0"),
("1.0.0", "1.0.0"),
("1.0.0", "1.0.0.dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0", "1.0.0-rc1"),
("1.0.0.dev1", "1.0.0.dev1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0-alpha1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1.dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha2", "1.0.0-alpha1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev1"),
("1.0.0-beta1", "1.0.0-dev1"),
("1.0.0-beta1", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1", "1.0.0-beta1.dev1"),
("1.0.0-beta2", "1.0.0-beta1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev1"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1", "1.0.0-dev1"),
("1.0.0-rc1", "1.0.0-alpha1"),
("1.0.0-rc1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1.dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev1"),
("1.0.0-rc2", "1.0.0-rc1"),
]
for version1, version2 in versions:
self.assertTrue(
Version.from_string(version1) >= Version.from_string(version2),
f"{version1} should be greater or equal then {version2}",
)
versions = [
("1.0.0", "1.0.0+dev1"),
("1.0.0.dev1", "1.0.0.dev2"),
("1.0.0", "1.0.1"),
("1.0.0-dev1", "1.0.0"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev2"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev2"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version1, version2 in versions:
self.assertFalse(
Version.from_string(version1) >= Version.from_string(version2),
f"{version1} should not be greater or equal then {version2}",
)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) >= version2)
def test_less_then(self):
versions = [
("1.0.0", "0.9.9999"),
("1.0.1", "1.0.0"),
("1.0.0", "1.0.0.dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1.dev1"),
("1.0.0-alpha2", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-dev1"),
("1.0.0-beta1", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-beta1.dev1"),
("1.0.0-beta2", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-dev1"),
("1.0.0-rc1", "1.0.0-alpha1"),
("1.0.0-rc1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1.dev1"),
("1.0.0-rc2", "1.0.0-rc1"),
]
for version2, version1 in versions:
self.assertTrue(
Version.from_string(version1) < Version.from_string(version2),
f"{version1} should be less then {version2}",
)
versions = [
("1.0.0", "1.0.0"),
("1.0.0", "1.0.0+dev1"),
("1.0.0.dev1", "1.0.0.dev1"),
("1.0.0.dev1", "1.0.0.dev2"),
("1.0.0", "1.0.1"),
("1.0.0-dev1", "1.0.0"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev2"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev2"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version2, version1 in versions:
self.assertFalse(
Version.from_string(version1) < Version.from_string(version2),
f"{version1} should not be less then {version2}",
)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) < version2)
def test_less_or_equal_then(self):
versions = [
("1.0.0", "0.9.9999"),
("1.0.1", "1.0.0"),
("1.0.0", "1.0.0"),
("1.0.0", "1.0.0.dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0", "1.0.0-rc1"),
("1.0.0.dev1", "1.0.0.dev1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0-alpha1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1.dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha2", "1.0.0-alpha1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev1"),
("1.0.0-beta1", "1.0.0-dev1"),
("1.0.0-beta1", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1", "1.0.0-beta1.dev1"),
("1.0.0-beta2", "1.0.0-beta1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev1"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1", "1.0.0-dev1"),
("1.0.0-rc1", "1.0.0-alpha1"),
("1.0.0-rc1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1.dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev1"),
("1.0.0-rc2", "1.0.0-rc1"),
]
for version2, version1 in versions:
self.assertTrue(
Version.from_string(version1) <= Version.from_string(version2),
f"{version1} should be less or equal then {version2}",
)
versions = [
("1.0.0", "1.0.0+dev1"),
("1.0.0.dev1", "1.0.0.dev2"),
("1.0.0", "1.0.1"),
("1.0.0-dev1", "1.0.0"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1.dev1", "1.0.0-alpha1.dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1.dev1", "1.0.0-beta1.dev2"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1.dev1", "1.0.0-rc1.dev2"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version2, version1 in versions:
self.assertFalse(
Version.from_string(version1) <= Version.from_string(version2),
f"{version1} should not be less or equal then {version2}",
)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) <= version2)
def test_is_dev_release(self):
versions = [
"1.0.0.dev1",
"1.0.0dev1",
"1.0.0-alpha1.dev1",
"1.0.0-beta1.dev1",
"1.0.0-rc1.dev1",
]
for version in versions:
self.assertTrue(
Version.from_string(version).is_dev_release,
f"{version} is not a dev release",
)
versions = [
"1.0.0",
"1.0.0+dev1",
"1.0.0a1",
"1.0.0b1",
"1.0.0rc1",
"1.0.0-alpha1",
"1.0.0-beta1",
"1.0.0-rc1",
"1.0.0a1+dev1",
"1.0.0b1+dev1",
"1.0.0rc1+dev1",
]
for version in versions:
self.assertFalse(
Version.from_string(version).is_dev_release,
f"{version} is a dev release",
)
def test_is_alpha_release(self):
versions = [
"1.0.0-alpha1",
"1.0.0-a1",
"1.0.0a1",
"1.0.0a1+foo",
"1.0.0a1.dev1",
]
for version in versions:
self.assertTrue(
Version.from_string(version).is_alpha_release,
f"{version} is not an alpha release",
)
versions = [
"1.0.0",
"1.0.0.dev1",
"1.0.0b1",
"1.0.0rc1",
]
for version in versions:
self.assertFalse(
Version.from_string(version).is_alpha_release,
f"{version} is an alpha release",
)
def test_is_beta_release(self):
versions = [
"1.0.0-beta1",
"1.0.0-b1",
"1.0.0b1",
"1.0.0b1+foo",
"1.0.0b1.dev1",
]
for version in versions:
self.assertTrue(
Version.from_string(version).is_beta_release,
f"{version} is not a beta release",
)
versions = [
"1.0.0",
"1.0.0.dev1",
"1.0.0a1",
"1.0.0rc1",
]
for version in versions:
self.assertFalse(
Version.from_string(version).is_beta_release,
f"{version} is a beta release",
)
def test_is_release_candidate(self):
versions = [
"1.0.0-rc1",
"1.0.0rc1",
"1.0.0rc1+foo",
"1.0.0rc1.dev1",
]
for version in versions:
self.assertTrue(
Version.from_string(version).is_release_candidate,
f"{version} is not a release candidate",
)
versions = [
"1.0.0",
"1.0.0.dev1",
"1.0.0a1",
"1.0.0b1",
]
for version in versions:
self.assertFalse(
Version.from_string(version).is_release_candidate,
f"{version} is a release candidate",
)
def test_pre(self):
versions = [
("1.0.0", None),
("1.0.0.dev1", None),
("1.0.0-dev1", None),
("1.0.0a1", ("alpha", 1)),
("1.0.0-alpha1", ("alpha", 1)),
("1.0.0b1", ("beta", 1)),
("1.0.0-beta1", ("beta", 1)),
("1.0.0rc1", ("rc", 1)),
("1.0.0-rc1", ("rc", 1)),
("1.0.0rc1+foo1", ("rc", 1)),
("1.0.0a1.dev1", ("alpha", 1)),
("1.0.0a1.dev1", ("alpha", 1)),
("1.0.0b1.dev1", ("beta", 1)),
("1.0.0rc1.dev1", ("rc", 1)),
]
for version, expected in versions:
self.assertEqual(Version.from_string(version).pre, expected)
def test_local(self):
versions = [
("1.0.0", None),
("1.0.0+dev1", ("dev", 1)),
("1.0.0-dev1", None),
("1.0.0.dev1", None),
("1.0.0a1", None),
("1.0.0-alpha1", None),
("1.0.0b1", None),
("1.0.0-beta1", None),
("1.0.0rc1", None),
("1.0.0-rc1", None),
("1.0.0rc1+foo1", ("foo", 1)),
("1.0.0rc1+dev1", ("dev", 1)),
("1.0.01.dev1", None),
("1.0.0b1.dev1", None),
("1.0.0rc1.dev1", None),
]
for version, expected in versions:
version_local = Version.from_string(version).local
self.assertEqual(
version_local,
expected,
f"{version_local} does not match {expected} for version "
f"{version}",
)
class PEP440VersionCalculatorTestCase(unittest.TestCase):
def test_next_patch_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2"),
("1.2.3", "1.2.4"),
("1.2.3.post1", "1.2.4"),
("1.2.3a1", "1.2.3"),
("1.2.3b1", "1.2.3"),
("1.2.3rc1", "1.2.3"),
("1.2.3a1.dev1", "1.2.3"),
("1.2.3b1.dev1", "1.2.3"),
("1.2.3rc1.dev1", "1.2.3"),
("22.4.1", "22.4.2"),
("22.4.1.dev1", "22.4.1"),
("22.4.1.dev3", "22.4.1"),
("2022.4.1.dev3", "2022.4.1"),
]
for current_version, assert_version in versions:
release_version = calculator.next_patch_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next patch version "
f"{assert_version} for {current_version}",
)
def test_next_calendar_versions(self):
calculator = VersionCalculator()
today = datetime.today()
year_short = today.year % 100
current_versions = [
"21.4.1.dev3",
f"19.{today.month}.1.dev3",
f"{year_short}.{today.month}.1.dev3",
f"{year_short}.{today.month}.1",
"2022.4.1",
"2023.5.1",
f"{today.year}.{today.month}.1.dev2",
f"{today.year}.{today.month}.1",
]
assert_versions = [
f"{year_short}.{today.month}.0",
f"{year_short}.{today.month}.0",
f"{year_short}.{today.month}.1",
f"{year_short}.{today.month}.2",
f"{today.year}.{today.month}.0",
f"{today.year}.{today.month}.0",
f"{today.year}.{today.month}.1",
f"{today.year}.{today.month}.2",
]
for current_version, assert_version in zip(
current_versions, assert_versions
):
release_version = calculator.next_calendar_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version, Version.from_string(assert_version)
)
def test_next_calendar_version_error(self):
calculator = VersionCalculator()
today = datetime.today()
year_short = today.year % 100
with self.assertRaisesRegex(VersionError, "'.+' is higher than '.+'."):
calculator.next_calendar_version(
Version.from_string(f"{year_short + 1}.1.0")
)
with self.assertRaisesRegex(VersionError, "'.+' is higher than '.+'."):
calculator.next_calendar_version(
Version.from_string(f"{year_short}.{today.month + 1}.0")
)
with self.assertRaisesRegex(VersionError, "'.+' is higher than '.+'."):
calculator.next_calendar_version(
Version.from_string(f"{today.year + 1}.{today.month + 1}.0")
)
def test_next_minor_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.1.0"),
("1.2.3", "1.3.0"),
("1.2.3.post1", "1.3.0"),
("1.2.3a1", "1.3.0"),
("1.2.3b1", "1.3.0"),
("1.2.3rc1", "1.3.0"),
("1.2.3a1.dev1", "1.3.0"),
("1.2.3b1.dev1", "1.3.0"),
("1.2.3rc1.dev1", "1.3.0"),
("22.4.1", "22.5.0"),
("22.4.1.dev1", "22.5.0"),
("22.4.1.dev3", "22.5.0"),
("1.0.0a1", "1.0.0"),
("1.1.0a1", "1.1.0"),
("1.0.0.dev1", "1.0.0"),
("1.1.0.dev1", "1.1.0"),
("2022.1.0.dev1", "2022.1.0"),
]
for current_version, assert_version in versions:
release_version = calculator.next_minor_version(
Version.from_string(current_version),
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next minor version "
f"{assert_version} for {current_version}",
)
def test_next_major_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "1.0.0"),
("1.2.3", "2.0.0"),
("1.2.3.post1", "2.0.0"),
("1.2.3a1", "2.0.0"),
("1.2.3b1", "2.0.0"),
("1.2.3rc1", "2.0.0"),
("1.2.3a1.dev1", "2.0.0"),
("1.2.3b1.dev1", "2.0.0"),
("1.2.3rc1.dev1", "2.0.0"),
("22.4.1", "23.0.0"),
("22.4.1.dev1", "23.0.0"),
("22.4.1.dev3", "23.0.0"),
("1.0.0a1", "1.0.0"),
("1.1.0a1", "2.0.0"),
("1.0.0.dev1", "1.0.0"),
("1.1.0.dev1", "2.0.0"),
]
for current_version, assert_version in versions:
release_version = calculator.next_major_version(
Version.from_string(current_version),
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next major version "
f"{assert_version} for {current_version}",
)
def test_next_alpha_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2a1"),
("1.2.3", "1.2.4a1"),
("1.2.3.post1", "1.2.4a1"),
("1.2.3a1", "1.2.3a2"),
("1.2.3b1", "1.2.4a1"),
("1.2.3rc1", "1.2.4a1"),
("1.2.3a1.dev1", "1.2.3a1"),
("1.2.3b1.dev1", "1.2.4a1"),
("1.2.3rc1.dev1", "1.2.4a1"),
("22.4.1", "22.4.2a1"),
("22.4.1.dev1", "22.4.1a1"),
("22.4.1.dev3", "22.4.1a1"),
("1.0.0a1", "1.0.0a2"),
("1.1.0a1", "1.1.0a2"),
("1.0.0.dev1", "1.0.0a1"),
("1.1.0.dev1", "1.1.0a1"),
]
for current_version, assert_version in versions:
release_version = calculator.next_alpha_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next alpha version "
f"{assert_version} for {current_version}",
)
def test_next_beta_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2b1"),
("1.2.3", "1.2.4b1"),
("1.2.3.post1", "1.2.4b1"),
("1.2.3a1", "1.2.3b1"),
("1.2.3b1", "1.2.3b2"),
("1.2.3rc1", "1.2.4b1"),
("1.2.3a1.dev1", "1.2.3b1"),
("1.2.3b1.dev1", "1.2.3b1"),
("1.2.3rc1.dev1", "1.2.4b1"),
("22.4.1", "22.4.2b1"),
("22.4.1.dev1", "22.4.1b1"),
("22.4.1.dev3", "22.4.1b1"),
("1.0.0a1", "1.0.0b1"),
("1.1.0a1", "1.1.0b1"),
("1.0.0.dev1", "1.0.0b1"),
("1.1.0.dev1", "1.1.0b1"),
]
for current_version, assert_version in versions:
release_version = calculator.next_beta_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next beta version "
f"{assert_version} for {current_version}",
)
def test_next_release_candidate_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2rc1"),
("1.2.3", "1.2.4rc1"),
("1.2.3.post1", "1.2.4rc1"),
("1.2.3a1", "1.2.3rc1"),
("1.2.3b1", "1.2.3rc1"),
("1.2.3rc1", "1.2.3rc2"),
("1.2.3a1.dev1", "1.2.3rc1"),
("1.2.3b1.dev1", "1.2.3rc1"),
("1.2.3rc1.dev1", "1.2.3rc1"),
("22.4.1", "22.4.2rc1"),
("22.4.1.dev1", "22.4.1rc1"),
("22.4.1.dev3", "22.4.1rc1"),
("1.0.0a1", "1.0.0rc1"),
("1.1.0a1", "1.1.0rc1"),
("1.0.0.dev1", "1.0.0rc1"),
("1.1.0.dev1", "1.1.0rc1"),
]
for current_version, assert_version in versions:
release_version = calculator.next_release_candidate_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next rc version "
f"{assert_version} for {current_version}",
)
def test_next_dev_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2.dev1"),
("1.2.3", "1.2.4.dev1"),
("1.2.3.dev1", "1.2.3.dev2"),
("1.2.3.post1", "1.2.4.dev1"),
("1.2.3a1", "1.2.3a2.dev1"),
("1.2.3b1", "1.2.3b2.dev1"),
("1.2.3rc1", "1.2.3rc2.dev1"),
("1.2.3a1.dev1", "1.2.3a1.dev2"),
("1.2.3b1.dev1", "1.2.3b1.dev2"),
("1.2.3rc1.dev1", "1.2.3rc1.dev2"),
("22.4.1", "22.4.2.dev1"),
("22.4.1.dev1", "22.4.1.dev2"),
("22.4.1.dev3", "22.4.1.dev4"),
("1.0.0a1", "1.0.0a2.dev1"),
("1.1.0a1", "1.1.0a2.dev1"),
("1.0.0.dev1", "1.0.0.dev2"),
("1.1.0.dev1", "1.1.0.dev2"),
]
for current_version, assert_version in versions:
release_version = calculator.next_dev_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the next expected dev version "
f"{assert_version} for {current_version}",
)
pontos-25.3.2/tests/version/schemes/test_semantic.py 0000664 0000000 0000000 00000111333 14762555663 0022644 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from datetime import datetime
from pontos.version._errors import VersionError
from pontos.version.schemes._pep440 import PEP440Version
from pontos.version.schemes._semantic import SemanticVersion as Version
from pontos.version.schemes._semantic import (
SemanticVersionCalculator as VersionCalculator,
)
class SemanticVersionTestCase(unittest.TestCase):
def test_parse_version(self):
versions = [
"0.0.1",
"1.2.3",
"1.2.3-foo1",
"1.2.3-a1",
"1.2.3-alpha1",
"1.2.3-alpha1-dev1",
"1.2.3-b1",
"1.2.3-beta1",
"1.2.3-beta1-dev1",
"1.2.3-rc1",
"1.2.3-rc1-dev1",
"1.2.3-dev1",
"1.2.3+foo1",
"22.4.1",
"22.4.1-dev1",
"22.4.1-dev3",
]
for version in versions:
self.assertEqual(Version.from_string(version), Version(version))
def test_parsed_version(self):
versions = [
"0.0.1",
"1.2.3",
"1.2.3-foo1",
"1.2.3-a1",
"1.2.3-alpha1",
"1.2.3-alpha1-dev1",
"1.2.3-b1",
"1.2.3-beta1",
"1.2.3-beta1-dev1",
"1.2.3-rc1",
"1.2.3-rc1-dev1",
"1.2.3-dev1",
"1.2.3+foo1",
"22.4.1",
"22.4.1-dev1",
"22.4.1-dev3",
]
for version in versions:
self.assertEqual(
Version.from_string(version).parsed_version, version
)
pep440_version = PEP440Version.from_string("22.4.1.dev1")
semver_version = Version.from_version(pep440_version)
self.assertEqual(str(semver_version), "22.4.1-dev1")
self.assertEqual(semver_version.parsed_version, "22.4.1.dev1")
def test_parse_error(self):
versions = [
"abc",
"1.2.3d",
"1.2.3.post1",
"1.2.3a1",
"1.2.3b1",
"1.2.3rc1",
"1.2.3a1+dev1",
"22.4.1.dev1",
"22.4.1.dev3",
]
for version in versions:
with self.assertRaisesRegex(
VersionError, "^.* is not valid SemVer string$"
):
Version.from_string(version)
def test_parse_prerelease_error(self):
versions = [
"1.2.3-pos1t1",
"1.2.3-dev1-dev1",
]
for version in versions:
with self.assertRaisesRegex(
VersionError, f"^Invalid prerelease .* in {version}"
):
Version.from_string(version)
def test_equal(self):
versions = [
("1.0.0", "1.0.0"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0-dev1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev1"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev1"),
]
for version1, version2 in versions:
self.assertTrue(
Version.from_string(version1) == Version.from_string(version2),
f"{version1} does not equal {version2}",
)
versions = [
("1.0.0", "1.0.1"),
("1.0.0", "1.0.0+dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0+dev1", "1.0.0-dev1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version1, version2 in versions:
self.assertFalse(
Version.from_string(version1) == Version.from_string(version2),
f"{version1} equals {version2}",
)
other = None
self.assertFalse(Version.from_string("1.0.0") == other)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) == version2)
def test_equal_pep440_version(self):
versions = [
("1.0.0", "1.0.0"),
("1.0.0-dev1", "1.0.0-dev1"),
("1.0.0-dev1", "1.0.0.dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1", "1.0.0a1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha1-dev1", "1.0.0a1.dev1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1", "1.0.0b1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev1"),
("1.0.0-beta1-dev1", "1.0.0b1.dev1"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1-dev1", "1.0.0-rc1.dev1"),
("1.0.0-rc1-dev1", "1.0.0rc1.dev1"),
]
for version1, version2 in versions:
semver = Version.from_string(version1)
pep440 = PEP440Version.from_string(version2)
self.assertTrue(
semver == pep440,
f"{semver!r} {version1} does not equal {pep440!r} {version2}",
)
def test_not_equal(self):
versions = [
("1.0.0", "1.0.0"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1"),
]
for version1, version2 in versions:
self.assertFalse(
Version.from_string(version1) != Version.from_string(version2),
f"{version1} does not equal {version2}",
)
versions = [
("1.0.0", "1.0.1"),
("1.0.0", "1.0.0+dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version1, version2 in versions:
self.assertTrue(
Version.from_string(version1) != Version.from_string(version2),
f"{version1} equals {version2}",
)
versions = [
("1.0.0", "abc"),
("1.0.0", None),
]
for version1, version2 in versions:
self.assertTrue(Version.from_string(version1) != version2)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) != version2)
def test_greater_then(self):
versions = [
("1.0.0", "0.9.9999"),
("1.0.1", "1.0.0"),
("1.0.0", "1.0.0-dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha2", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-dev1"),
("1.0.0-beta1", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-beta1-dev1"),
("1.0.0-beta2", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-dev1"),
("1.0.0-rc1", "1.0.0-alpha1"),
("1.0.0-rc1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1-dev1"),
("1.0.0-rc2", "1.0.0-rc1"),
]
for version1, version2 in versions:
self.assertTrue(
Version.from_string(version1) > Version.from_string(version2),
f"{version1} should be greater then {version2}",
)
versions = [
("1.0.0", "1.0.0"),
("1.0.0", "1.0.0+dev1"),
("1.0.0-dev1", "1.0.0-dev1"),
("1.0.0-dev1", "1.0.0-dev2"),
("1.0.0", "1.0.1"),
("1.0.0-dev1", "1.0.0"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev2"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev2"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version1, version2 in versions:
self.assertFalse(
Version.from_string(version1) > Version.from_string(version2),
f"{version1} should not be greater then {version2}",
)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) > version2)
def test_greater_or_equal_then(self):
versions = [
("1.0.0", "0.9.9999"),
("1.0.0", "1.0.0"),
("1.0.1", "1.0.0"),
("1.0.0", "1.0.0-dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0", "1.0.0-rc1"),
("1.0.0-dev1", "1.0.0-dev1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0-alpha1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha2", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-dev1"),
("1.0.0-beta1", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1", "1.0.0-beta1-dev1"),
("1.0.0-beta2", "1.0.0-beta1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev1"),
("1.0.0-rc1", "1.0.0-dev1"),
("1.0.0-rc1", "1.0.0-alpha1"),
("1.0.0-rc1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1", "1.0.0-rc1-dev1"),
("1.0.0-rc2", "1.0.0-rc1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev1"),
]
for version1, version2 in versions:
self.assertTrue(
Version.from_string(version1) >= Version.from_string(version2),
f"{version1} should be greater or equal then {version2}",
)
versions = [
("1.0.0", "1.0.0+dev1"),
("1.0.0-dev1", "1.0.0-dev2"),
("1.0.0", "1.0.1"),
("1.0.0-dev1", "1.0.0"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev2"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev2"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version1, version2 in versions:
self.assertFalse(
Version.from_string(version1) >= Version.from_string(version2),
f"{version1} should not be greater or equal then {version2}",
)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) >= version2)
def test_less_then(self):
versions = [
("1.0.0", "0.9.9999"),
("1.0.1", "1.0.0"),
("1.0.0", "1.0.0-dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha2", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-dev1"),
("1.0.0-beta1", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-beta1-dev1"),
("1.0.0-beta2", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-dev1"),
("1.0.0-rc1", "1.0.0-alpha1"),
("1.0.0-rc1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1-dev1"),
("1.0.0-rc2", "1.0.0-rc1"),
# the following ones are strange with current semver implementation
# because they are both less then and greater then at the same time
("1.0.0", "1.0.0+dev1"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version2, version1 in versions:
self.assertTrue(
Version.from_string(version1) < Version.from_string(version2),
f"{version1} should be less then {version2}",
)
versions = [
("1.0.0", "1.0.0"),
("1.0.0-dev1", "1.0.0-dev1"),
("1.0.0-dev1", "1.0.0-dev2"),
("1.0.0", "1.0.1"),
("1.0.0-dev1", "1.0.0"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-rc1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev2"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev2"),
("1.0.0-rc1", "1.0.0"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev2"),
]
for version2, version1 in versions:
self.assertFalse(
Version.from_string(version1) < Version.from_string(version2),
f"{version1} should not be less then {version2}",
)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) < version2)
def test_less_or_equal_then(self):
versions = [
("1.0.0", "0.9.9999"),
("1.0.0", "1.0.0"),
("1.0.1", "1.0.0"),
("1.0.0", "1.0.0-dev1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-alpha1"),
("1.0.0", "1.0.0-beta1"),
("1.0.0", "1.0.0-rc1"),
("1.0.0-dev1", "1.0.0-dev1"),
("1.0.0+dev1", "1.0.0+dev1"),
("1.0.0-alpha1", "1.0.0-dev1"),
("1.0.0-alpha1", "1.0.0-alpha1"),
("1.0.0-alpha1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev1"),
("1.0.0-alpha2", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-dev1"),
("1.0.0-beta1", "1.0.0-alpha1"),
("1.0.0-beta1", "1.0.0-beta1"),
("1.0.0-beta1", "1.0.0-beta1-dev1"),
("1.0.0-beta2", "1.0.0-beta1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev1"),
("1.0.0-rc1", "1.0.0-dev1"),
("1.0.0-rc1", "1.0.0-alpha1"),
("1.0.0-rc1", "1.0.0-beta1"),
("1.0.0-rc1", "1.0.0-rc1"),
("1.0.0-rc1", "1.0.0-rc1-dev1"),
("1.0.0-rc2", "1.0.0-rc1"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev1"),
# the strange ones
("1.0.0", "1.0.0+dev1"),
("1.0.0+dev1", "1.0.0+dev2"),
("1.0.0-alpha1", "1.0.0-alpha1+dev1"),
("1.0.0-alpha1+dev1", "1.0.0-alpha1+dev2"),
("1.0.0-beta1", "1.0.0-beta1+dev1"),
("1.0.0-beta1+dev1", "1.0.0-beta1+dev2"),
("1.0.0-rc1", "1.0.0-rc1+dev1"),
("1.0.0-rc1+dev1", "1.0.0-rc1+dev2"),
]
for version2, version1 in versions:
self.assertTrue(
Version.from_string(version1) <= Version.from_string(version2),
f"{version1} should be greater or equal then {version2}",
)
versions = [
("1.0.0-dev1", "1.0.0-dev2"),
("1.0.0", "1.0.1"),
("1.0.0-dev1", "1.0.0"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.0.0-alpha1", "1.0.0-beta1"),
("1.0.0-alpha1", "1.0.0-rc1"),
("1.0.0-alpha1-dev1", "1.0.0-alpha1-dev2"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.0.0-beta1-dev1", "1.0.0-beta1-dev2"),
("1.0.0-rc1", "1.0.0"),
("1.0.0-rc1-dev1", "1.0.0-rc1-dev2"),
]
for version2, version1 in versions:
self.assertFalse(
Version.from_string(version1) <= Version.from_string(version2),
f"{version1} should not be greater or equal then {version2}",
)
versions = [
("1.0.0", object()),
("1.0.0", 1),
("1.0.0", True),
]
for version1, version2 in versions:
with self.assertRaisesRegex(ValueError, "Can't compare"):
self.assertFalse(Version.from_string(version1) <= version2)
def test_is_dev_release(self):
versions = [
"1.0.0-dev1",
"1.0.0-alpha1-dev1",
"1.0.0-beta1-dev1",
"1.0.0-rc1-dev1",
]
for version in versions:
self.assertTrue(
Version.from_string(version).is_dev_release,
f"{version} is not a dev release",
)
versions = [
"1.0.0",
"1.0.0+foo1",
"1.0.0+dev1",
"1.0.0-alpha1",
"1.0.0-beta1",
"1.0.0-rc1",
"1.0.0-alpha1+dev1",
"1.0.0-beta1+dev1",
"1.0.0-rc1+dev1",
]
for version in versions:
self.assertFalse(
Version.from_string(version).is_dev_release,
f"{version} is a dev release",
)
def test_is_alpha_release(self):
versions = [
"1.0.0-alpha1",
"1.0.0-alpha1+foo1",
"1.0.0-alpha1-foo1",
"1.0.0-alpha1+dev1",
"1.0.0-alpha1-dev1",
]
for version in versions:
self.assertTrue(
Version.from_string(version).is_alpha_release,
f"{version} is not an alpha release",
)
versions = [
"1.0.0",
"1.0.0+dev1",
"1.0.0-dev1",
"1.0.0-a1",
"1.0.0-b1",
"1.0.0-rc1",
]
for version in versions:
self.assertFalse(
Version.from_string(version).is_alpha_release,
f"{version} is an alpha release",
)
def test_is_beta_release(self):
versions = [
"1.0.0-beta1",
"1.0.0-beta1+foo1",
"1.0.0-beta1-foo1",
"1.0.0-beta1+dev1",
"1.0.0-beta1-dev1",
]
for version in versions:
self.assertTrue(
Version.from_string(version).is_beta_release,
f"{version} is not a beta release",
)
versions = [
"1.0.0",
"1.0.0-dev1",
"1.0.0+dev1",
"1.0.0-alpha1",
"1.0.0-b1",
"1.0.0-rc1",
]
for version in versions:
self.assertFalse(
Version.from_string(version).is_beta_release,
f"{version} is a beta release",
)
def test_is_release_candidate(self):
versions = [
"1.0.0-rc1",
"1.0.0-rc1+foo1",
"1.0.0-rc1-foo1",
"1.0.0-rc1+dev1",
"1.0.0-rc1-dev1",
]
for version in versions:
self.assertTrue(
Version.from_string(version).is_release_candidate,
f"{version} is not a release candidate",
)
versions = [
"1.0.0",
"1.0.0+dev1",
"1.0.0-dev1",
"1.0.0-alpha1",
"1.0.0-beta1",
]
for version in versions:
self.assertFalse(
Version.from_string(version).is_release_candidate,
f"{version} is a release candidate",
)
def test_pre(self):
versions = [
("1.0.0", None),
("1.0.0+dev1", None),
("1.0.0-dev1", None),
("1.0.0-alpha1", ("alpha", 1)),
("1.0.0-beta1", ("beta", 1)),
("1.0.0-rc1", ("rc", 1)),
("1.0.0-rc1+foo1", ("rc", 1)),
("1.0.0-alpha1+dev1", ("alpha", 1)),
("1.0.0-beta1+dev1", ("beta", 1)),
("1.0.0-rc1+dev1", ("rc", 1)),
("1.0.0-alpha1-dev1", ("alpha", 1)),
("1.0.0-beta1-dev1", ("beta", 1)),
("1.0.0-rc1-dev1", ("rc", 1)),
]
for version, expected in versions:
self.assertEqual(Version.from_string(version).pre, expected)
def test_local(self):
versions = [
("1.0.0", None),
("1.0.0+foo1", ("foo", 1)),
("1.0.0+dev1", ("dev", 1)),
("1.0.0-dev1", None),
("1.0.0-alpha1", None),
("1.0.0-beta1", None),
("1.0.0-rc1", None),
("1.0.0-rc1+foo1", ("foo", 1)),
("1.0.0-alpha1+dev1", ("dev", 1)),
("1.0.0-beta1+dev1", ("dev", 1)),
("1.0.0-rc1+dev1", ("dev", 1)),
("1.0.0-alpha1-dev1", None),
("1.0.0-beta1-dev1", None),
("1.0.0-rc1-dev1", None),
]
for version, expected in versions:
local = Version.from_string(version).local
self.assertEqual(
local,
expected,
f"{version} has not the expected local {expected}. Instead it "
f"is {local}",
)
class SemanticVersionCalculatorTestCase(unittest.TestCase):
def test_next_patch_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2"),
("1.2.3", "1.2.4"),
("1.2.3+dev1", "1.2.4"),
("1.2.3-dev1", "1.2.3"),
("1.2.3-foo1", "1.2.3"),
("1.2.3-alpha1", "1.2.3"),
("1.2.3-beta1", "1.2.3"),
("1.2.3-rc1", "1.2.3"),
("1.2.3-alpha1+dev1", "1.2.3"),
("1.2.3-beta1+dev1", "1.2.3"),
("1.2.3-rc1+dev1", "1.2.3"),
("1.2.3-alpha1-dev1", "1.2.3"),
("1.2.3-beta1-dev1", "1.2.3"),
("1.2.3-rc1-dev1", "1.2.3"),
("22.4.1", "22.4.2"),
("22.4.1+dev3", "22.4.2"),
("22.4.1-dev1", "22.4.1"),
("22.4.1-dev3", "22.4.1"),
("1.0.0-a1", "1.0.0"),
("1.1.0-alpha1", "1.1.0"),
("1.0.0+dev1", "1.0.1"),
("1.1.0+dev1", "1.1.1"),
("1.0.0-dev1", "1.0.0"),
("1.1.0-dev1", "1.1.0"),
]
for current_version, assert_version in versions:
release_version = calculator.next_patch_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next patch version "
f"{assert_version} for {current_version}",
)
def test_next_calendar_versions(self):
calculator = VersionCalculator()
today = datetime.today()
year_short = today.year % 100
current_versions = [
"21.4.1-dev3",
f"19.{today.month}.1-dev3",
f"{year_short}.{today.month}.1-dev3",
f"{year_short}.{today.month}.1",
]
assert_versions = [
f"{year_short}.{today.month}.0",
f"{year_short}.{today.month}.0",
f"{year_short}.{today.month}.1",
f"{year_short}.{today.month}.2",
]
for current_version, assert_version in zip(
current_versions, assert_versions
):
release_version = calculator.next_calendar_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version, Version.from_string(assert_version)
)
def test_next_calendar_version_error(self):
calculator = VersionCalculator()
today = datetime.today()
year_short = today.year % 100
with self.assertRaisesRegex(VersionError, "'.+' is higher than '.+'."):
calculator.next_calendar_version(
Version.from_string(f"{year_short + 1}.1.0")
)
with self.assertRaisesRegex(VersionError, "'.+' is higher than '.+'."):
calculator.next_calendar_version(
Version.from_string(f"{year_short}.{today.month + 1}.0")
)
def test_next_minor_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.1.0"),
("1.2.3", "1.3.0"),
("1.2.3+dev1", "1.3.0"),
("1.2.3-dev1", "1.3.0"),
("1.2.3-foo1", "1.3.0"),
("1.2.3-alpha1", "1.3.0"),
("1.2.3-beta1", "1.3.0"),
("1.2.3-rc1", "1.3.0"),
("1.2.3-alpha1+dev1", "1.3.0"),
("1.2.3-beta1+dev1", "1.3.0"),
("1.2.3-rc1+dev1", "1.3.0"),
("22.4.1", "22.5.0"),
("22.4.1+dev3", "22.5.0"),
("22.4.1-dev1", "22.5.0"),
("22.4.1-dev3", "22.5.0"),
("1.0.0-a1", "1.0.0"),
("1.1.0-alpha1", "1.1.0"),
("1.0.0+dev1", "1.1.0"),
("1.1.0+dev1", "1.2.0"),
("1.0.0-dev1", "1.0.0"),
("1.1.0-dev1", "1.1.0"),
]
for current_version, assert_version in versions:
release_version = calculator.next_minor_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next minor version "
f"{assert_version} for {current_version}",
)
def test_next_major_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "1.0.0"),
("1.2.3", "2.0.0"),
("1.2.3+dev1", "2.0.0"),
("1.2.3-dev1", "2.0.0"),
("1.2.3-foo1", "2.0.0"),
("1.2.3-alpha1", "2.0.0"),
("1.2.3-beta1", "2.0.0"),
("1.2.3-rc1", "2.0.0"),
("1.2.3-alpha1+dev1", "2.0.0"),
("1.2.3-beta1+dev1", "2.0.0"),
("1.2.3-rc1+dev1", "2.0.0"),
("1.2.3-alpha1-dev1", "2.0.0"),
("1.2.3-beta1-dev1", "2.0.0"),
("1.2.3-rc1-dev1", "2.0.0"),
("22.4.1", "23.0.0"),
("22.4.1+dev3", "23.0.0"),
("22.4.1-dev1", "23.0.0"),
("22.4.1-dev3", "23.0.0"),
("1.0.0-a1", "1.0.0"),
("1.0.0-beta1", "1.0.0"),
("1.1.0-alpha1", "2.0.0"),
("1.0.0+dev1", "2.0.0"),
("1.1.0+dev1", "2.0.0"),
("1.0.0-dev1", "1.0.0"),
("1.1.0-dev1", "2.0.0"),
]
for current_version, assert_version in versions:
release_version = calculator.next_major_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next major version "
f"{assert_version} for {current_version}",
)
def test_next_alpha_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2-alpha1"),
("1.2.3", "1.2.4-alpha1"),
("1.2.3+dev1", "1.2.4-alpha1"),
("1.2.3-dev1", "1.2.3-alpha1"),
("1.2.3-post1", "1.2.4-alpha1"),
("1.2.3-alpha1", "1.2.3-alpha2"),
("1.2.3-beta1", "1.2.4-alpha1"),
("1.2.3-rc1", "1.2.4-alpha1"),
("1.2.3-alpha1+dev1", "1.2.3-alpha2"),
("1.2.3-beta1+dev1", "1.2.4-alpha1"),
("1.2.3-rc1+dev1", "1.2.4-alpha1"),
("1.2.3-alpha1-dev1", "1.2.3-alpha1"),
("1.2.3-beta1-dev1", "1.2.4-alpha1"),
("1.2.3-beta1-dev1", "1.2.4-alpha1"),
("22.4.1", "22.4.2-alpha1"),
("22.4.1+dev3", "22.4.2-alpha1"),
("22.4.1-dev1", "22.4.1-alpha1"),
("22.4.1-dev3", "22.4.1-alpha1"),
("1.0.0-a1", "1.0.1-alpha1"),
("1.0.0-beta1", "1.0.1-alpha1"),
("1.1.0-alpha1", "1.1.0-alpha2"),
("1.0.0+dev1", "1.0.1-alpha1"),
("1.1.0+dev1", "1.1.1-alpha1"),
("1.0.0-dev1", "1.0.0-alpha1"),
("1.1.0-dev1", "1.1.0-alpha1"),
]
for current_version, assert_version in versions:
release_version = calculator.next_alpha_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next alpha version "
f"{assert_version} for {current_version}",
)
def test_next_beta_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2-beta1"),
("1.2.3", "1.2.4-beta1"),
("1.2.3+dev1", "1.2.4-beta1"),
("1.2.3-dev1", "1.2.3-beta1"),
("1.2.3-foo1", "1.2.4-beta1"),
("1.2.3-alpha1", "1.2.3-beta1"),
("1.2.3-beta1", "1.2.3-beta2"),
("1.2.3-rc1", "1.2.4-beta1"),
("1.2.3-alpha1+dev1", "1.2.3-beta1"),
("1.2.3-beta1+dev1", "1.2.3-beta2"),
("1.2.3-rc1+dev1", "1.2.4-beta1"),
("1.2.3-alpha1-dev1", "1.2.3-beta1"),
("1.2.3-beta1-dev1", "1.2.3-beta1"),
("1.2.3-rc1-dev1", "1.2.4-beta1"),
("22.4.1", "22.4.2-beta1"),
("22.4.1+dev3", "22.4.2-beta1"),
("22.4.1-dev1", "22.4.1-beta1"),
("22.4.1-dev3", "22.4.1-beta1"),
# actually 1.0.0-beta1 would also be ok, but it would require to
# to add extra code for not used versioning
("1.0.0-a1", "1.0.1-beta1"),
("1.0.0-beta1", "1.0.0-beta2"),
("1.1.0-alpha1", "1.1.0-beta1"),
("1.0.0+dev1", "1.0.1-beta1"),
("1.1.0+dev1", "1.1.1-beta1"),
("1.0.0-dev1", "1.0.0-beta1"),
("1.1.0-dev1", "1.1.0-beta1"),
]
for current_version, assert_version in versions:
release_version = calculator.next_beta_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next beta version "
f"{assert_version} for {current_version}",
)
def test_next_release_candidate_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2-rc1"),
("1.2.3", "1.2.4-rc1"),
("1.2.3+dev1", "1.2.4-rc1"),
("1.2.3-dev1", "1.2.3-rc1"),
("1.2.3-foo1", "1.2.4-rc1"),
("1.2.3-alpha1", "1.2.3-rc1"),
("1.2.3-beta1", "1.2.3-rc1"),
("1.2.3-rc1", "1.2.3-rc2"),
("1.2.3-alpha1+dev1", "1.2.3-rc1"),
("1.2.3-beta1+dev1", "1.2.3-rc1"),
("1.2.3-rc1+dev1", "1.2.3-rc2"),
("1.2.3-alpha1-dev1", "1.2.3-rc1"),
("1.2.3-beta1-dev1", "1.2.3-rc1"),
("1.2.3-rc1-dev1", "1.2.3-rc1"),
("22.4.1", "22.4.2-rc1"),
("22.4.1+dev3", "22.4.2-rc1"),
("22.4.1-dev1", "22.4.1-rc1"),
("22.4.1-dev3", "22.4.1-rc1"),
("1.0.0-a1", "1.0.1-rc1"),
("1.0.0-beta1", "1.0.0-rc1"),
("1.1.0-alpha1", "1.1.0-rc1"),
("1.0.0+dev1", "1.0.1-rc1"),
("1.1.0+dev1", "1.1.1-rc1"),
("1.0.0-dev1", "1.0.0-rc1"),
("1.1.0-dev1", "1.1.0-rc1"),
]
for current_version, assert_version in versions:
release_version = calculator.next_release_candidate_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next rc version "
f"{assert_version} for {current_version}",
)
def test_next_dev_version(self):
calculator = VersionCalculator()
versions = [
("0.0.1", "0.0.2-dev1"),
("1.2.3", "1.2.4-dev1"),
("1.2.3+dev1", "1.2.4-dev1"),
("1.2.3-dev1", "1.2.3-dev2"),
("1.2.3-foo1", "1.2.3-foo2-dev1"),
("1.2.3-alpha1", "1.2.3-alpha2-dev1"),
("1.2.3-beta1", "1.2.3-beta2-dev1"),
("1.2.3-rc1", "1.2.3-rc2-dev1"),
("1.2.3-alpha1+dev1", "1.2.3-alpha2-dev1"),
("1.2.3-beta1+dev1", "1.2.3-beta2-dev1"),
("1.2.3-rc1+dev1", "1.2.3-rc2-dev1"),
("1.2.3-alpha1-dev1", "1.2.3-alpha1-dev2"),
("1.2.3-beta1-dev1", "1.2.3-beta1-dev2"),
("1.2.3-rc1-dev1", "1.2.3-rc1-dev2"),
("22.4.1", "22.4.2-dev1"),
("22.4.1+dev3", "22.4.2-dev1"),
("22.4.1-dev1", "22.4.1-dev2"),
("22.4.1-dev3", "22.4.1-dev4"),
("1.0.0-a1", "1.0.0-a2-dev1"),
("1.0.0-beta1", "1.0.0-beta2-dev1"),
("1.1.0-alpha1", "1.1.0-alpha2-dev1"),
("1.0.0+dev1", "1.0.1-dev1"),
("1.1.0+dev1", "1.1.1-dev1"),
("1.0.0-dev1", "1.0.0-dev2"),
("1.1.0-dev1", "1.1.0-dev2"),
]
for current_version, assert_version in versions:
release_version = calculator.next_dev_version(
Version.from_string(current_version)
)
self.assertEqual(
release_version,
Version.from_string(assert_version),
f"{release_version} is not the expected next development "
f"version {assert_version} for {current_version}",
)
pontos-25.3.2/tests/version/test_commands.py 0000664 0000000 0000000 00000000435 14762555663 0021213 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pontos.version.commands import get_commands
class GetCommandsTestCase(unittest.TestCase):
def test_available_commands(self):
self.assertEqual(len(get_commands()), 6)
pontos-25.3.2/tests/version/test_errors.py 0000664 0000000 0000000 00000000707 14762555663 0020730 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pontos.version import VersionError
class VersionErrorTestCase(unittest.TestCase):
def test_should_print_message(self):
err = VersionError("foo bar")
self.assertEqual(str(err), "foo bar")
def test_should_raise(self):
with self.assertRaisesRegex(VersionError, "^foo bar$"):
raise VersionError("foo bar")
pontos-25.3.2/tests/version/test_helper.py 0000664 0000000 0000000 00000015730 14762555663 0020675 0 ustar 00root root 0000000 0000000 # SPDX-FileCopyrightText: 2020-2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from unittest.mock import patch
from pontos.git import Git
from pontos.version.helper import (
get_last_release_version,
get_last_release_versions,
)
from pontos.version.schemes import (
PEP440VersioningScheme,
SemanticVersioningScheme,
)
parse_version = PEP440VersioningScheme.parse_version
Version = PEP440VersioningScheme.version_cls
class GetLastReleaseVersionsTestCase(unittest.TestCase):
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_versions(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = ["1", "2", "3.55"]
it = get_last_release_versions(parse_version)
version = next(it)
self.assertEqual(version, Version("3.55"))
version = next(it)
self.assertEqual(version, Version("2"))
version = next(it)
self.assertEqual(version, Version("1"))
with self.assertRaises(StopIteration):
next(it)
@patch("pontos.version.helper.Git", spec=Git)
def test_get_no_release_versions(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = []
it = get_last_release_versions(parse_version)
with self.assertRaises(StopIteration):
next(it)
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_versions_with_git_prefix(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = ["v1", "v2", "v3.55"]
it = get_last_release_versions(parse_version, git_tag_prefix="v")
version = next(it)
self.assertEqual(version, Version("3.55"))
version = next(it)
self.assertEqual(version, Version("2"))
version = next(it)
self.assertEqual(version, Version("1"))
with self.assertRaises(StopIteration):
next(it)
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_versions_ignore_pre_releases(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = [
"1",
"2",
"3.55a1",
"3.56.dev1",
"4.0.0rc1",
"4.0.1b1",
]
it = get_last_release_versions(parse_version, ignore_pre_releases=True)
version = next(it)
self.assertEqual(version, Version("2"))
version = next(it)
self.assertEqual(version, Version("1"))
with self.assertRaises(StopIteration):
next(it)
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_versions_no_non_pre_release(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = [
"3.55a1",
"3.56.dev1",
"4.0.0rc1",
"4.0.1b1",
]
it = get_last_release_versions(parse_version, ignore_pre_releases=True)
with self.assertRaises(StopIteration):
next(it)
@patch("pontos.version.helper.Git", spec=Git)
def test_invalid_version(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = [
"1.0.0",
"3.55a1",
"2.0.0",
]
it = get_last_release_versions(SemanticVersioningScheme.parse_version)
version = next(it)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("2.0.0")
)
version = next(it)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("1.0.0")
)
with self.assertRaises(StopIteration):
next(it)
class GetLastReleaseVersionTestCase(unittest.TestCase):
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_version(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = ["1", "2", "3.55"]
self.assertEqual(
get_last_release_version(parse_version), Version("3.55")
)
@patch("pontos.version.helper.Git", spec=Git)
def test_get_no_release_version(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = []
self.assertIsNone(get_last_release_version(parse_version))
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_version_with_git_prefix(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = ["v1", "v2", "v3.55"]
self.assertEqual(
get_last_release_version(parse_version, git_tag_prefix="v"),
Version("3.55"),
)
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_version_ignore_pre_releases(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = [
"1",
"2",
"3.55a1",
"3.56.dev1",
"4.0.0rc1",
"4.0.1b1",
]
self.assertEqual(
get_last_release_version(parse_version, ignore_pre_releases=True),
Version("2"),
)
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_version_no_non_pre_release(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = [
"3.55a1",
"3.56.dev1",
"4.0.0rc1",
"4.0.1b1",
]
self.assertIsNone(
get_last_release_version(parse_version, ignore_pre_releases=True)
)
@patch("pontos.version.helper.Git", spec=Git)
def test_get_last_release_version_tag_name(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = [
"4.0.0rc1",
"4.0.1b1",
]
self.assertEqual(
get_last_release_version(parse_version, tag_name="4.0.*"),
Version("4.0.1b1"),
)
@patch("pontos.version.helper.Git", spec=Git)
def test_invalid_version(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = ["1.0.0", "2.0.0", "3.55a1"]
self.assertEqual(
get_last_release_version(SemanticVersioningScheme.parse_version),
SemanticVersioningScheme.parse_version("2.0.0"),
)
@patch("pontos.version.helper.Git", spec=Git)
def test_success_with_invalid_version(self, git_mock):
git_interface = git_mock.return_value
git_interface.list_tags.return_value = [
"1.0.0",
"2.0.0",
"3.55a1",
"4.0.0",
]
version = get_last_release_version(
SemanticVersioningScheme.parse_version
)
self.assertEqual(
version, SemanticVersioningScheme.parse_version("4.0.0")
)
pontos-25.3.2/tests/version/test_main.py 0000664 0000000 0000000 00000024761 14762555663 0020346 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from contextlib import redirect_stderr, redirect_stdout
from datetime import datetime
from io import StringIO
from pontos.testing import temp_directory
from pontos.version._main import VersionExitCode, main
class MainTestCase(unittest.TestCase):
def test_no_command(self):
with self.assertRaises(SystemExit), redirect_stderr(StringIO()):
main([])
def test_no_project(self):
with (
temp_directory(change_into=True),
self.assertRaises(SystemExit) as cm,
redirect_stderr(StringIO()),
):
main(["show"])
self.assertEqual(cm.exception.code, VersionExitCode.NO_PROJECT)
def test_update_success(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["update", "2.0.0"])
self.assertEqual(
out.getvalue(), "Updated version from 1.2.3 to 2.0.0.\n"
)
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
def test_update_failure(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stderr(StringIO()),
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
"{}",
encoding="utf8",
)
main(["update", "2.0.0"])
self.assertEqual(cm.exception.code, VersionExitCode.UPDATE_ERROR)
def test_update_already_up_to_date(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["update", "1.2.3"])
self.assertEqual(out.getvalue(), "Version is already up-to-date.\n")
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
def test_show(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["show"])
self.assertEqual(out.getvalue(), "1.2.3\n")
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
def test_show_error(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stderr(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "abc"}',
encoding="utf8",
)
main(["show"])
self.assertEqual(out.getvalue(), "Invalid version: 'abc'\n")
self.assertEqual(
cm.exception.code, VersionExitCode.CURRENT_VERSION_ERROR
)
def test_verify_failure(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stderr(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["verify", "1.2.4"])
self.assertEqual(
out.getvalue(),
"Provided version 1.2.4 does not match the current version "
f"1.2.3 in {version_file.resolve()}.\n",
)
self.assertEqual(cm.exception.code, VersionExitCode.VERIFY_ERROR)
def test_verify_success(self):
with (
temp_directory(change_into=True) as temp_dir,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["verify", "1.2.3"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
def test_verify_current(self):
with (
temp_directory(change_into=True) as temp_dir,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["verify", "current"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
def test_next_invalid_current(self):
with (
redirect_stderr(StringIO()),
temp_directory(change_into=True) as temp_dir,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.tt"}',
encoding="utf8",
)
main(["next", "dev", "--versioning-scheme", "pep440"])
self.assertEqual(
cm.exception.code, VersionExitCode.CURRENT_VERSION_ERROR
)
def test_next_dev(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["next", "dev", "--versioning-scheme", "pep440"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
self.assertEqual(out.getvalue(), "1.2.4.dev1\n")
def test_next_patch(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["next", "patch", "--versioning-scheme", "pep440"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
self.assertEqual(out.getvalue(), "1.2.4\n")
def test_next_minor(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["next", "minor", "--versioning-scheme", "pep440"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
self.assertEqual(out.getvalue(), "1.3.0\n")
def test_next_major(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["next", "major", "--versioning-scheme", "pep440"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
self.assertEqual(out.getvalue(), "2.0.0\n")
def test_next_alpha(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["next", "alpha", "--versioning-scheme", "semver"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
self.assertEqual(out.getvalue(), "1.2.4-alpha1\n")
def test_next_beta(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["next", "beta", "--versioning-scheme", "semver"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
self.assertEqual(out.getvalue(), "1.2.4-beta1\n")
def test_next_rc(self):
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["next", "rc", "--versioning-scheme", "semver"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
self.assertEqual(out.getvalue(), "1.2.4-rc1\n")
def test_next_calendar(self):
today = datetime.today()
with (
temp_directory(change_into=True) as temp_dir,
redirect_stdout(StringIO()) as out,
self.assertRaises(SystemExit) as cm,
):
version_file = temp_dir / "package.json"
version_file.write_text(
'{"name": "foo", "version": "1.2.3"}',
encoding="utf8",
)
main(["next", "calendar", "--versioning-scheme", "pep440"])
self.assertEqual(cm.exception.code, VersionExitCode.SUCCESS)
self.assertEqual(
out.getvalue(), f"{today.year % 100}.{today.month}.0\n"
)
pontos-25.3.2/tests/version/test_parser.py 0000664 0000000 0000000 00000000762 14762555663 0020711 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from contextlib import redirect_stderr
from io import StringIO
from pontos.version._parser import parse_args
class ParserTestCase(unittest.TestCase):
def test_error_while_parsing(self):
with redirect_stderr(StringIO()), self.assertRaises(SystemExit) as cm:
parse_args(["update", "foo"])
# exception code in argparse
self.assertEqual(cm.exception.code, 2)
pontos-25.3.2/tests/version/test_project.py 0000664 0000000 0000000 00000012675 14762555663 0021071 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pontos.testing import temp_directory, temp_python_module
from pontos.version.project import Project, ProjectError
from pontos.version.schemes import PEP440VersioningScheme
class ProjectTestCase(unittest.TestCase):
def test_no_project_found(self):
with (
temp_directory(change_into=True),
self.assertRaisesRegex(
ProjectError, "No project settings file found"
),
):
Project(PEP440VersioningScheme)
def test_python_project(self):
current_version = PEP440VersioningScheme.parse_version("1.2.3")
new_version = PEP440VersioningScheme.parse_version("1.2.4")
content = f"__version__ = '{current_version}'"
with temp_python_module(
content, name="foo", change_into=True
) as temp_module:
pyproject_toml = temp_module.parent / "pyproject.toml"
pyproject_toml.write_text(
f'[tool.poetry]\nversion = "{current_version}"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
project = Project(PEP440VersioningScheme)
self.assertEqual(project.get_current_version(), current_version)
update = project.update_version(new_version)
self.assertEqual(update.previous, current_version)
self.assertEqual(update.new, new_version)
self.assertEqual(len(update.changed_files), 2)
def test_go_project(self):
current_version = PEP440VersioningScheme.parse_version("1.2.3")
new_version = PEP440VersioningScheme.parse_version("1.2.4")
with temp_directory(change_into=True) as temp_dir:
project_file = temp_dir / "go.mod"
project_file.touch()
version_file = temp_dir / "version.go"
version_file.write_text(f'var version = "{current_version}"')
project = Project(PEP440VersioningScheme)
self.assertEqual(project.get_current_version(), current_version)
update = project.update_version(new_version)
self.assertEqual(update.previous, current_version)
self.assertEqual(update.new, new_version)
self.assertEqual(len(update.changed_files), 1)
def test_javascript_project(self):
current_version = PEP440VersioningScheme.parse_version("1.2.3")
new_version = PEP440VersioningScheme.parse_version("1.2.4")
with temp_directory(change_into=True) as temp_dir:
version_file = temp_dir / "package.json"
version_file.write_text(
f'{{"name": "foo", "version": "{current_version}"}}',
encoding="utf8",
)
project = Project(PEP440VersioningScheme)
self.assertEqual(project.get_current_version(), current_version)
update = project.update_version(new_version)
self.assertEqual(update.previous, current_version)
self.assertEqual(update.new, new_version)
self.assertEqual(len(update.changed_files), 1)
def test_cmake_project_version(self):
current_version = PEP440VersioningScheme.parse_version("1.2.3")
new_version = PEP440VersioningScheme.parse_version("1.2.4")
with temp_directory(change_into=True) as temp_dir:
version_file = temp_dir / "CMakeLists.txt"
version_file.write_text("project(VERSION 1.2.3)", encoding="utf8")
project = Project(PEP440VersioningScheme)
self.assertEqual(project.get_current_version(), current_version)
update = project.update_version(new_version)
self.assertEqual(update.previous, current_version)
self.assertEqual(update.new, new_version)
self.assertEqual(len(update.changed_files), 1)
def test_all(self):
current_version = PEP440VersioningScheme.parse_version("1.2.3")
new_version = PEP440VersioningScheme.parse_version("1.2.4")
content = f"__version__ = '{current_version}'"
with temp_python_module(
content, name="foo", change_into=True
) as temp_module:
temp_dir = temp_module.parent
pyproject_toml = temp_dir / "pyproject.toml"
pyproject_toml.write_text(
f'[tool.poetry]\nversion = "{current_version}"\n'
'[tool.pontos.version]\nversion-module-file = "foo.py"',
encoding="utf8",
)
go_mod_file = temp_dir / "go.mod"
go_mod_file.touch()
go_version_file = temp_dir / "version.go"
go_version_file.write_text(f'var version = "{current_version}"')
package_json = temp_dir / "package.json"
package_json.write_text(
f'{{"name": "foo", "version": "{current_version}"}}',
encoding="utf8",
)
cmake_lists_txt = temp_dir / "CMakeLists.txt"
cmake_lists_txt.write_text(
"project(VERSION 1.2.3)", encoding="utf8"
)
project = Project(PEP440VersioningScheme)
self.assertEqual(project.get_current_version(), current_version)
update = project.update_version(new_version)
self.assertEqual(update.previous, current_version)
self.assertEqual(update.new, new_version)
self.assertEqual(len(update.changed_files), 5)
pontos-25.3.2/tests/version/test_version.py 0000664 0000000 0000000 00000002205 14762555663 0021074 0 ustar 00root root 0000000 0000000 # Copyright (C) 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import unittest
from pontos.version.schemes._pep440 import PEP440Version
from pontos.version.schemes._semantic import SemanticVersion
class VersionTestCase(unittest.TestCase):
def test_equal(self):
self.assertEqual(PEP440Version("22.2.2"), PEP440Version("22.2.2"))
self.assertNotEqual(PEP440Version("22.2.1"), PEP440Version("22.2.2"))
self.assertNotEqual(SemanticVersion("22.2.2"), "22.2.2")
self.assertNotEqual(
SemanticVersion("22.2.1"), SemanticVersion("22.2.2")
)
self.assertNotEqual(PEP440Version("22.2.2"), "22.2.2")
def test_equal_other(self):
self.assertEqual(PEP440Version("22.2.2"), SemanticVersion("22.2.2"))
def test_equal_other_other_way_around(self):
self.assertEqual(SemanticVersion("22.2.2"), PEP440Version("22.2.2"))
def test_equal_raises(self):
with self.assertRaises(ValueError):
self.assertNotEqual(SemanticVersion("22.2.2"), 22)
with self.assertRaises(ValueError):
self.assertNotEqual(PEP440Version("22.2.2"), 22)