Skip to main content

Generate single HTML file from allure report.

Project description

Allure single html file builder

Tool to build allure generated folder into a single html file

What it's doing?

After run by console command, or by call from python code, it:

  1. Reads contents of allure-generated folder
  2. Creates server.js file, which has all the data files inside and code to start fake XHR server
  3. Patches index.html file, so it's using server.js and sinon-9.2.4.js (Taken from here), and could be run in any browser without --allow-file-access-from-files parameter of chrome browser
  4. Creates file complete.html with all files built-in in a single file

Requirements

  • Python 3.6+
  • You need to have your allure report folder generated (allure generate './some/path/to/allure/generated/folder')

Installation

Install with pip

pip install allure-combine

or:

Install manually

  1. Clone repo
git clone git@github.com:MihanEntalpo/allure-single-html-file.git
cd allure-single-html-file
  1. Install requirements (actually there are only BeautifulSoup)
pip install -r ./requirements.txt
python setup.py install

Run as console script

If you have cloned repo, not installed module via pip, replace allure-combine with python ./allure_combine/combine.py in following commands:

  1. Create complete.html file inside the allure folder itself
allure-combine ./some/path/to/allure/generated/folder
  1. Create complete.html file inside specified folder:
allure-combine ./some/path/to/allure/generated/folder --dest /tmp
  1. Ensure that specified dest folder exists (create if not)
allure-combine ./some/path/to/allure/generated/folder --dest /tmp/allure-2022-05-05_12-20-01/result --auto-create-folders
  1. Remove sinon.js and server.js from allure folder after complete.html is generated:
allure-combine ./some/path/to/allure/generated/folder --remove-temp-files
  1. If html/json files what should be utf-8 is has broken encoding, ignore errors:
allure-combine ./some/path/to/allure/generated/folder --ignore-utf8-errors

Import and use in python code

pip install allure-combine
from allure_combine import combine_allure

# 1) Create complete.html in allure-generated folder
combine_allure("./some/path/to/allure/generated/folder")

# 2) Create complete.html in specified folder
combine_allure("./some/path/to/allure/generated/folder", dest_folder="/tmp")

# 3) Make sure that dest folder exists, create if not
combine_allure(
    "./some/path/to/allure/generated/folder",
    dest_folder="/tmp/allure-2022-05-05_12-20-01/result",
    auto_create_folders=True
)

# 4) Remove sinon.js and server.js from allure folder after complete.html is generated:
combine_allure(
    "./some/path/to/allure/generated/folder",
    remove_temp_files=True
)

# 5) If html/json files what should be utf-8 is has broken encoding, ignore errors:
combine_allure(
    "./some/path/to/allure/generated/folder",
    ignore_utf8_errors=True
)

TODO

  • Functionality to open image or video in new browser tab doesn't work yet.
  • Need functionality to return combined file as a string, not saving it to a file directly
  • Functionality to not change source files at all, work in a read-only filesystem

Ports to other languages:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

allure_combine-1.0.11.tar.gz (667.2 kB view details)

Uploaded Source

Built Distributions

allure_combine-1.0.11-py3.9.egg (673.2 kB view details)

Uploaded Source

allure_combine-1.0.11-py3-none-any.whl (669.3 kB view details)

Uploaded Python 3

File details

Details for the file allure_combine-1.0.11.tar.gz.

File metadata

  • Download URL: allure_combine-1.0.11.tar.gz
  • Upload date:
  • Size: 667.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.10

File hashes

Hashes for allure_combine-1.0.11.tar.gz
Algorithm Hash digest
SHA256 7a5134ff5407101373f1e782e1da59ae14091146f7b5862205d57df15f4fb903
MD5 0246166301d6caf56bcdee470a474773
BLAKE2b-256 c93806ebd56515397613d930a066a04fee460d4a3d546701b8ea20c2ffaec215

See more details on using hashes here.

File details

Details for the file allure_combine-1.0.11-py3.9.egg.

File metadata

  • Download URL: allure_combine-1.0.11-py3.9.egg
  • Upload date:
  • Size: 673.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.10

File hashes

Hashes for allure_combine-1.0.11-py3.9.egg
Algorithm Hash digest
SHA256 4cec7791e6eac36a9da5575cef85d0df9763efaeb15a31e4d8f53c2dd6f9dbe0
MD5 f862c3fdb62022b36afd443d1b760a6a
BLAKE2b-256 8e4e8e5a0cb1b77e72bbbc6e06a1c0316b115067ae19ff02fde8d065a88602a6

See more details on using hashes here.

File details

Details for the file allure_combine-1.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for allure_combine-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 cb4038ce405aab86339c4ab05b021e195fe53c06ff22130f54da2e8d3ccc9ddb
MD5 3302f6a8b07c823bfe45df2e4d9f6804
BLAKE2b-256 e2de4d8e3b63c1eaa66c0d6d8ca1fa18dd727fe03b1f688464138fbaebdcab40

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page