Skip to content

funfedi_results.allure

AllureResults dataclass

Class to manage allure results

Parameters:

Name Type Description Default
path Path
PosixPath('allure-results')
Source code in funfedi_results/allure/__init__.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
@dataclass
class AllureResults:
    """Class to manage allure results"""

    path: Path = Path("allure-results")

    def clean(self):
        """Removes all files from the allure-results directory"""
        if self.path.exists():
            for child in self.path.iterdir():
                child.unlink()

        self.path.mkdir(exist_ok=True)

    @property
    def files_in_allure_dir(self):
        return glob(f"{self.path}/*.json")

    def create_zip(self, zipfilename: Path):
        """Zips all files in the allure-results directory into a file. Files
        are checked to have the naming convention `{app_name}_{app_version}.zip`"""
        name, version = name_and_version(zipfilename.name)
        if not (name and version):
            raise Exception(f"Invalid filename {zipfilename}")

        with zipfile.ZipFile(zipfilename, "w") as f:
            for name in self.files_in_allure_dir:
                new_name = name.split("/")[-1]
                f.write(name, new_name)

    def extract(self, file_directory: Path):
        """Takes all zip files from directory and extracts the latest
        version for each app into the allure-results directory"""
        self.clean()

        files = [x.name for x in file_directory.glob("*.zip")]
        latest = names_to_latest_dict(files)

        for name, version in latest.items():
            with zipfile.ZipFile(file_directory / f"{name}_{version}.zip") as f:
                f.extractall(self.path)

clean 

clean()

Removes all files from the allure-results directory

Source code in funfedi_results/allure/__init__.py 
15
16
17
18
19
20
21
def clean(self):
    """Removes all files from the allure-results directory"""
    if self.path.exists():
        for child in self.path.iterdir():
            child.unlink()

    self.path.mkdir(exist_ok=True)

create_zip 

create_zip(zipfilename: Path)

Zips all files in the allure-results directory into a file. Files are checked to have the naming convention {app_name}_{app_version}.zip

Source code in funfedi_results/allure/__init__.py 
27
28
29
30
31
32
33
34
35
36
37
def create_zip(self, zipfilename: Path):
    """Zips all files in the allure-results directory into a file. Files
    are checked to have the naming convention `{app_name}_{app_version}.zip`"""
    name, version = name_and_version(zipfilename.name)
    if not (name and version):
        raise Exception(f"Invalid filename {zipfilename}")

    with zipfile.ZipFile(zipfilename, "w") as f:
        for name in self.files_in_allure_dir:
            new_name = name.split("/")[-1]
            f.write(name, new_name)

extract 

extract(file_directory: Path)

Takes all zip files from directory and extracts the latest version for each app into the allure-results directory

Source code in funfedi_results/allure/__init__.py 
39
40
41
42
43
44
45
46
47
48
49
def extract(self, file_directory: Path):
    """Takes all zip files from directory and extracts the latest
    version for each app into the allure-results directory"""
    self.clean()

    files = [x.name for x in file_directory.glob("*.zip")]
    latest = names_to_latest_dict(files)

    for name, version in latest.items():
        with zipfile.ZipFile(file_directory / f"{name}_{version}.zip") as f:
            f.extractall(self.path)