Views

Quality/Compliance tools

From MeeGo wiki

Revision as of 21:17, 7 February 2011 by Archebyte (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

1 Introduction
2 Installation
3 Features
- 3.1 dist-compliance-tool
- 3.2 app-compliance-tool
4 Usage
5 Result Format
6 Bug Report
7 TODO

Introduction

Compliance tools are used to check MeeGo compliance for MeeGo Distributions or MeeGo Applications. The compliance reference input is the MeeGo core package/file list and a minimal MeeGo reference image created by MIC2, which will contain all the required core packages, as well as src rpms.

For MeeGo distribution compliance checking, the input needs to include the OS image and the src.rpms for all the packages. And for MeeGo Application compliance checking, the input is the application rpm file.

The tools will generate report files (in HTML currently) to show the result.

Installation

Compliance tools can be installed using released rpm and deb packages, or installed by source code.

Packages and Repos

The package in the MeeGo OBS server for this project is devel:tools:building/meego-compliance-tools. And all the rpm and deb packages for release can be generated by the MeeGo OBS server. The following Linux distributions are supported:

Debian 5.0
xUbuntu 9.10, 10.04, 10.10
Fedora 11, 12, 13
openSUSE 11.1, 11.2, 11.3
MeeGo 1.0, Trunk (1.2)

All the corresponding package repos can be used to install the tools conveniently,and will be published in http://repo.meego.com.

For rpm packaging ditros, there are three packages available:

meego-compliance-tools (common data, will be installed automatically as the dependency of the two packages below)
meego-dist-compliance-tools (for MeeGo distro compliance checking)
meego-app-compliance-tools. (for MeeGo application compliance checking)

Source Code

The tools can also be installed by source code. After fetching the code, under the code directory, run:

 $ [sudo] make install

The source code is hosted at:

 meego-compliance-tools@gitorious.org

MIC2

To prepare the images used in compliance tools, you need MIC2 with new features (version 0.22.0 or later).

Features

dist-compliance-tool

It executes compliance checking for MeeGo distributions. The following features are supported:

Binary pkg comparison:
- Exist in target image?
- Version matches the requirement?
  - flexible version checking: support rules with comparison operators like ">=" in core pkg list
Content in source rpm comparison:
- This step will be skipped if binary rpm checking fails
- Spec filename
- Spec content
- Sources and md5sum
- Patches and the content

app-compliance-tool

For compliance checking for MeeGo applications, the following features are supported:

check if all dependent packages exist in core package list
check if the target package can be installed in the minimal image
verify the installation location of the application
verify the minimal requirement of the desktop file and icon for the application

Usage

Image Preparation

Before using the tools, the reference image needs to be created by using MIC2 (version 0.22.0 or later):

 $ [sudo] mic-image-creator --run-mode=0 --cache=mycachedir --format=fs  --config=<ks file> --package=tar.bz2 --include-source

The sample ks file can be downloaded at:

 media:Meego-minimal-compliance-1.0.99.1.ks

The sample core list file can be downloaded at:

 media:Core-list-1.0.99.1‎

And the ks file and core list should be synced with and conform to the latest MeeGo compliance spec.

To use the dist compliance check tool (dist_compliance), the needed target image can also be generated by mic2 using the above options. But the target images will not be limited to this specific format(fs in tar.bz2). If the exist target image is in other formats, please unpack it to a directory manually using format specific instructions and use this directory as the command line input.

Devices Compliance Check

The command "dist_compliance" is for checking compliance of MeeGo devices, or distributions.

   Usage: [sudo] dist_compliance [options]
   Options:
     --version             show program's version number and exit
     -h, --help            show this help message and exit
     -c CORELIST, --corelist=CORELIST
                           File to store core list of MeeGo
     -r REF, --reference=REF
                           Path of reference image or unpacked directory
     -t TGT, --target=TGT  Path of target image or unpacked directory
     -o OUTDIR, --outdir=OUTDIR
                           Output directory of report
     -d, --debug           Save intermedia log data for debugging

Apps Compliance Check

The command "app_compliance" is for applications compliance checking.

   Usage: [sudo] app_compliance [options] <app-rpm>
   Options:
     --version             show program's version number and exit
     -h, --help            show this help message and exit
     -r REFIMAGE, --refimage=REFIMAGE
                           Filepath of reference image
     -c CORELIST, --corelist=CORELIST
                           File to store core list of MeeGo
     -m MEEGO_API_PKGLIST, --meego_api_pkglist=MEEGO_API_PKGLIST
                           File to store MeeGo API package list of MeeGo
     -o OUTDIR, --outdir=OUTDIR
                           Output directory of report
     -d, --debug           Save intermedia log data for debugging

The sample MeeGo API package list file can be downloaded at:

   media:MeeGo-API-pkglist.txt

Result Format

Currently, the output of checking tools will be store in HTML files. Screen capture of sample distribution report:

Bug Report

If problems were found in compliance tools, please file bugs in bugs.meego.com. The corresponding section is: "Development Tools/Tools".