Submission JSON Schema

Checkbox submissions contain reports of the tests and in-depth information that helps analysing the test results.

This document describes the schema of the submission.json files as part of the submission. To get the latest JSON schema file, go to the Checkbox GitHub repository.

Important

The schema described in this document is work-in-progress and being reviewed. If you need assistance in validating the schema, please contact the Checkbox team.

https://certification.canonical.com/checkbox-submission.json

Output format for the Checkbox test framework (see more info at https://checkbox.readthedocs.io)

Submission

Submission

type

object

properties

  • title

type

string

  • testplan_id

type

string

  • custom_joblist

type

boolean

  • description

type

string

  • packages

type

array

items

Package

  • snap-packages

type

array

items

SnapPackage

  • distribution

Distribution

  • results

type

array

items

Result

  • resource-results

type

array

items

Result

  • attachment-results

type

array

items

Result

  • rejected-jobs

type

array

items

RejectedJob

  • category_map

type

object

additionalProperties

type

string

  • processor

Processor

  • kernel-cmdline

type

string

  • dkms_info

DkmsInfo

  • devices

type

array

items

Device

  • raw-devices-dmi

type

array

items

type

object

additionalProperties

type

string

  • modprobe-info

type

array

items

ModprobeInfo

  • pci_subsystem_id

anyOf

type

null

type

string

  • kernel

type

string

  • architecture

#/definitions/SubmissionArchitecture

  • memory

Memory

  • buildstamp

type

string

additionalProperties

False

Result

type

object

properties

  • id

type

string

  • full_id

type

string

  • name

type

string

  • certification_status

CertificationStatus

  • category

type

string

  • category_id

type

string

  • status

Outcome

  • outcome

Outcome

  • comments

anyOf

type

null

type

string

  • io_log

type

string

  • duration

type

number

  • type

AttachmentResultType

  • project

Project

  • plugin

Plugin

  • template_id

If the job is instantiated from a template, this field points to its origin template.

anyOf

type

null

type

string

additionalProperties

False

Device

type

object

properties

  • bus

Bus

  • category

Category

  • driver

type

string

  • path

type

string

  • product

type

string

  • product_id

type

integer

  • product_slug

type

string

  • vendor

type

string

  • vendor_slug

type

string

  • subproduct_id

type

integer

  • subvendor_id

type

integer

  • vendor_id

type

integer

  • interface

type

string

  • mac

type

string

  • name

type

string

additionalProperties

False

Distribution

type

object

properties

  • codename

Codename

  • description

Description

  • distributor_id

DistributorID

  • release

type

string

additionalProperties

False

DkmsInfo

Each key in this object is the name of a module, and stored against this key is information about the module

type

object

additionalProperties

Dkms

DkmsStatus

type

string

enum

dkms, non-dkms

DkmsInstallMods

type

object

additionalProperties

True

Dkms

type

object

properties

  • arch

Platform

  • dkms-status

DkmsStatus

  • dkms_name

type

string

  • dkms_ver

type

string

  • install_mods

PackageList

  • kernel_ver

type

string

  • mods

type

array

items

type

string

  • pkg

DkmsPkg

  • pkg_name

#/definitions/DkmsName

additionalProperties

False

DkmsPkg

type

object

properties

  • architecture

OSArchitecture

  • depends

type

string

  • description

type

string

  • homepage

type

string

format

uri

  • installed-size

type

string

format

integer

  • maintainer

type

string

  • package

#/definitions/DkmsName

  • priority

Priority

  • recommends

type

string

  • section

Section

  • source

SourceEnum

  • status

#/definitions/AmaroThirdPartyToolsStatus

  • version

type

string

additionalProperties

False

Memory

type

object

properties

  • swap

type

integer

  • total

type

integer

additionalProperties

False

ModprobeInfo

type

object

properties

  • module

Module

  • options

type

string

additionalProperties

False

Package

type

object

properties

  • name

type

string

  • version

type

string

additionalProperties

False

Processor

type

object

properties

  • bogomips

type

string

format

integer

  • cache

type

string

format

integer

  • count

type

string

format

integer

  • governors

Governors

  • model

type

string

  • model_number

ModelNumber

  • model_revision

type

string

  • model_version

type

string

  • other

type

string

  • platform

Platform

  • scaling

Scaling

  • speed

type

string

format

integer

  • type

ProcessorType

  • cpu_lpi_file

CPULPIFile

  • sys_lpi_file

SysLPIFile

additionalProperties

False

RejectedJob

type

object

properties

  • id

type

string

  • full_id

type

string

  • name

type

string

  • plugin

Plugin

  • certification_status

CertificationStatus

  • category

type

string

  • category_id

type

string

  • template_id

If the job is instantiated from a template, this field points to its origin template.

anyOf

type

null

type

string

additionalProperties

False

SnapPackage

type

object

properties

  • name

type

string

  • confinement

Confinement

  • developer

Developer

  • devmode

Devmode

  • install-date

type

string

format

date-time

  • revision

Revision

  • status

SnapPackageStatus

  • type

SnapPackageType

  • version

type

string

  • channel

Channel

additionalProperties

False

ModelNumber

Model number (in either decimal or hexadecimal format)

type

string

Revision

Snap package revision

type

string

OSArchitecture

type

string

enum

amd64, i386, s390x, armhf, ppc64el, arm64, riscv64

CertificationStatus

type

string

enum

non-blocker, blocker

Outcome

type

string

enum

pass, fail, not-supported, crash, skip, undecided

Plugin

type

string

enum

shell, user-interact-verify, user-interact, manual, attachment, resource

Project

type

string

enum

certification

AttachmentResultType

type

string

enum

test

Bus

type

string

enum

input, pnp, pci, scsi, usb, hid, power_supply, hidraw, sound, video4linux, tty, nvme, platform, net, mmc, watchdog, block, i2c, vchiq, infiniband, bluetooth, drm, mmc_rpmb, rc, sdio, serial, dmi, ccw, mtd, apex, nd, spi

Category

type

string

enum

OTHER, NETWORK, SCSI, DISK, USB, KEYBOARD, MOUSE, VIDEO, IDE, CDROM, HIDRAW, AUDIO, CAPTURE, BLUETOOTH, CARDREADER, WIRELESS, TOUCHPAD, RAID, TOUCHSCREEN, WATCHDOG, WWAN, ACCELEROMETER, MMAL, FIREWIRE, CANBUS, SOCKETCAN, BMC_NETWORK, TPU, INFINIBAND

Codename

OS release codename (the value matching lsb_release -r)

type

string

Description

OS release description (the value matching lsb_release -d)

type

string

DistributorID

OS release distributor ID (the value matching lsb_release -i)

type

string

PackageList

List of packages

type

string

MultiArch

type

string

enum

foreign

OriginalMaintainer

Original maintainer in the ‘Given Family <email@address.com>’ form

type

string

enum

Jim Zhang <jim.zhang@fingerprints.com>, Boger.Wang <boger@goodix.com>, Evgeni Golov <evgeni@debian.org>

Priority

type

string

enum

optional, extra

Section

type

string

enum

misc, kernel, admin, libs, non-free/libs, devel, metapackages, net

Suggests

type

string

enum

nvidia-settings, nvidia-prime (>= 0.8), nvidia-driver-440

Support

type

string

enum

Legacy, LTSB, NFB, PB

UbuntuOEMKernelFlavour

type

string

enum

default, oem

Platform

type

string

enum

x86_64, i386, s390x, armv7l, PowerNV, aarch64, riscv64

Breaks

type

string

enum

nvidia-kernel-source-470 (<< 390.25-0ubuntu2~), nvidia-kernel-source-515 (<< 390.25-0ubuntu2~), nvidia-kernel-source-525 (<< 390.25-0ubuntu2~), nvidia-kernel-source-535 (<< 390.25-0ubuntu2~)

SourceEnum

type

string

enum

fwts, iser, isert, kernel-mft, mlnx-ofed-kernel, nvidia-graphics-drivers-470, nvidia-peer-memory, oem-fix-cam-intel-mipi-ipu6, srp, mlnx-nfsrdma

Source

type

string

enum

knem, ipu6-camera-hal, libfprint-2-tod1-goodix, mlnx-nfsrdma, nvidia-graphics-drivers-390, nvidia-graphics-drivers-495, nvidia-graphics-drivers-510, nvidia-graphics-drivers-515, nvidia-graphics-drivers-525, nvidia-graphics-drivers-530, nvidia-graphics-drivers-535, nvidia-graphics-drivers-470, nvidia-graphics-drivers-470-server, rtl8821ce, tp-smapi

Maintainer

type

string

enum

Ubuntu Core Developers <ubuntu-devel-discuss@lists.ubuntu.com>

PkgName

Package name

type

string

Module

Module name

type

string

CPULPIFile

type

string

enum

package_cstate_show, low_power_idle_cpu_residency_us

Governors

List of CPU governors as a whitespace separated list

type

string

Scaling

type

string

enum

supported, non-supported

SysLPIFile

Low Power Idle table filename for the system (see https://www.kernel.org/doc/html/latest/firmware-guide/acpi/lpit.html for more information about LPI, an Intel specific property)

type

string

enum

slp_s0_residency_usec, low_power_idle_system_residency_us

ProcessorType

Type of the processor

type

string

Channel

type

string

Confinement

type

string

enum

strict, classic, devmode

Developer

type

string

Devmode

type

string

enum

False, True

SnapPackageStatus

type

string

enum

active, installed

SnapPackageType

type

string

enum

base, app, snapd, os, gadget, kernel