Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 3.2 KB

README.rst

File metadata and controls

96 lines (68 loc) · 3.2 KB
Raw
https://img.shields.io/github/v/release/ibutsu/ibutsu-utils

Ibutsu Utilities

Some command line utilities for Ibutsu. There are currently two tools:

Installation

These utilities are available on PyPI and can be installed with pip:

$ pip install ibutsu-utils

Download Tool

The ibutsu-download command line tool downloads an artifact from Ibutsu.

$ ibutsu-download -h
usage: ibutsu-download [-h] -H HOST [-t API_TOKEN] [-o OUTPUT] artifact_id

A tool to download an artifact from an Ibutsu server

positional arguments:
  artifact_id           The ID of the artifact to download

options:
  -h, --help            show this help message and exit
  -H HOST, --host HOST  The Ibutsu instance for uploading, e.g. https://my.ibutsu.com/api
  -t API_TOKEN, --api-token API_TOKEN
                        An API token for authentication
  -o OUTPUT, --output OUTPUT
                        The destination to save the file. If omitted will use the current directory and the artifact file name

Upload Tool

The ibutsu-upload command line tool uploads JUnit XML or Ibutsu archives to Ibutsu.

$ ibutsu-upload --help
usage: ibutsu-upload [-h] -H HOST -p PROJECT [-t API_TOKEN] [-s SOURCE] [-m METADATA] [-w] input [input ...]

A tool to upload a jUnit XML or Ibutsu archive to Ibutsu

positional arguments:
  input                 The file(s) to upload

options:
  -h, --help            show this help message and exit
  -H HOST, --host HOST  The Ibutsu instance for uploading, e.g. https://my.ibutsu.com/api
  -p PROJECT, --project PROJECT
                        The project for the upload
  -t API_TOKEN, --api-token API_TOKEN
                        An API token for authentication
  -s SOURCE, --source SOURCE
                        The source used in the test results
  -m METADATA, --metadata METADATA
                        Additional metadata to set when uploading, in the format of dotted.key.path=value
  -w, --wait            Wait for the upload to complete (by default this command does not wait)

Combine Tool

Some test runners output multiple JUnit XML files for a single test run. The ibutsu-xmerge utility will combine multiple XML files into a single file.

$ ibutsu-xmerge --help
usage: ibutsu-xmerge [-h] [-o OUTPUT] input [input ...]

positional arguments:
  input                 Input files

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        Output to a file. Defaults to stdout without this.