From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812896; cv=none; d=zohomail.com; s=zohoarc; b=M4K6LrDIjp7uZ/bgXrxQK1AOa96Q49ylR9AbYRTUSd9lF8r+dnH9gCKVnFLb9fcfqoLg0I5mKCMHj6HNde8B8nKhDB8SkMw7i1dW9mzZNLAw12L/NxHoU7HPBKk2W0f9kpy4H3FvONHd/CR28v/sK5d2Bk0G0CY9DOC7gp4ZlSA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812896; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=sqsmx8RPc7LdZGV7Y8xXWIS1mUEW6L1GMEELkWide/U=; b=eWghvhGQTG7IoXTBY2HGwNPTXX79VbxjnSghkN3fpsfWREutGH10XWzqO6kAaQqUf0awAIOWvwG13msYI9+LGmCWG2/yPnGBuGlVWIGxCLUNgKjoYO3l5dj++PdF2Bp+TR8dH5At0SqS7IlVuJvc3Rha2DbXUmJHMiG6pRC8yBk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1657812896833473.3604441545773; Thu, 14 Jul 2022 08:34:56 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-102-N1ERDOZ9NF6gRGmM-_C2yg-1; Thu, 14 Jul 2022 11:34:42 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 4FC2F85828B; Thu, 14 Jul 2022 15:34:39 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 366BA40E80E1; Thu, 14 Jul 2022 15:34:39 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 647841947B84; Thu, 14 Jul 2022 15:34:38 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C2F11194706C for ; Thu, 14 Jul 2022 15:34:37 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 9F19240E80E1; Thu, 14 Jul 2022 15:34:37 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0593B40E80E0; Thu, 14 Jul 2022 15:34:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812895; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=sqsmx8RPc7LdZGV7Y8xXWIS1mUEW6L1GMEELkWide/U=; b=F86CFTkLhUgRlnmmTZjEY+RgblozWtOLK3lZ3O0QFQBxFtpkiC4NNHzQMAV2NDtZk38EBC PW+m/Dz1HnQOJkF4ks5NqSf7l8YDe7xWpvWSdKyDStWz9RNMC8v0cZi3iRNgtdkvu9uJu4 IMzH1v7QoO/FnxfLQUnuPNNNSAQ/lpc= X-MC-Unique: N1ERDOZ9NF6gRGmM-_C2yg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 01/10] docs: Move the CI dashboard to its own RST module Date: Thu, 14 Jul 2022 17:34:26 +0200 Message-Id: <983cf8c03bfbcff4a8898b5003f780b1e4964354.1657812867.git.eskultet@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812899041100001 The dashboard itself simply takes away focus from everything else that makes sense to have in the CI article, so move it to it's own article and link it from the main CI article. Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/ci-dashboard.rst | 216 ++++++++++++++++++++++++++++++++++++++++++ docs/ci.rst | 192 +------------------------------------ docs/meson.build | 1 + 3 files changed, 219 insertions(+), 190 deletions(-) create mode 100644 docs/ci-dashboard.rst diff --git a/docs/ci-dashboard.rst b/docs/ci-dashboard.rst new file mode 100644 index 0000000000..a7f4e71f96 --- /dev/null +++ b/docs/ci-dashboard.rst @@ -0,0 +1,216 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +GitLab CI Dashboard +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The dashboard below shows the current status of the GitLab CI jobs for each +repository: + +Core project +------------ + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt + - .. image:: https://gitlab.com/libvirt/libvirt/badges/master/pipelin= e.svg + :target: https://gitlab.com/libvirt/libvirt/pipelines + :alt: libvirt pipeline status + + +Language bindings +----------------- + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-csharp + - .. image:: https://gitlab.com/libvirt/libvirt-csharp/badges/master/= pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-csharp/pipelines + :alt: libvirt-csharp pipeline status + + * - libvirt-go-module + - .. image:: https://gitlab.com/libvirt/libvirt-go-module/badges/mast= er/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-go-module/pipelines + :alt: libvirt-go-module pipeline status + + * - libvirt-java + - .. image:: https://gitlab.com/libvirt/libvirt-java/badges/master/pi= peline.svg + :target: https://gitlab.com/libvirt/libvirt-java/pipelines + :alt: libvirt-java pipeline status + + * - libvirt-ocaml + - .. image:: https://gitlab.com/libvirt/libvirt-ocaml/badges/master/p= ipeline.svg + :target: https://gitlab.com/libvirt/libvirt-ocaml/pipelines + :alt: libvirt-ocaml pipeline status + + * - libvirt-perl + - .. image:: https://gitlab.com/libvirt/libvirt-perl/badges/master/pi= peline.svg + :target: https://gitlab.com/libvirt/libvirt-perl/pipelines + :alt: libvirt-perl pipeline status + + * - libvirt-php + - .. image:: https://gitlab.com/libvirt/libvirt-php/badges/master/pip= eline.svg + :target: https://gitlab.com/libvirt/libvirt-php/pipelines + :alt: libvirt-php pipeline status + + * - libvirt-python + - .. image:: https://gitlab.com/libvirt/libvirt-python/badges/master/= pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-python/pipelines + :alt: libvirt-python pipeline status + + * - libvirt-ruby + - .. image:: https://gitlab.com/libvirt/libvirt-ruby/badges/master/pi= peline.svg + :target: https://gitlab.com/libvirt/libvirt-ruby/pipelines + :alt: libvirt-ruby pipeline status + + * - libvirt-rust + - .. image:: https://gitlab.com/libvirt/libvirt-rust/badges/master/pi= peline.svg + :target: https://gitlab.com/libvirt/libvirt-rust/pipelines + :alt: libvirt-rust pipeline status + + +Object mappings +--------------- + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-cim + - .. image:: https://gitlab.com/libvirt/libvirt-cim/badges/master/pip= eline.svg + :target: https://gitlab.com/libvirt/libvirt-cim/pipelines + :alt: libvirt-cim pipeline status + + * - libvirt-dbus + - .. image:: https://gitlab.com/libvirt/libvirt-dbus/badges/master/pi= peline.svg + :target: https://gitlab.com/libvirt/libvirt-dbus/pipelines + :alt: libvirt-dbus pipeline status + + * - libvirt-glib + - .. image:: https://gitlab.com/libvirt/libvirt-glib/badges/master/pi= peline.svg + :target: https://gitlab.com/libvirt/libvirt-glib/pipelines + :alt: libvirt-glib pipeline status + + * - libvirt-go-xml-module + - .. image:: https://gitlab.com/libvirt/libvirt-go-xml-module/badges/= master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-go-xml-module/pipeli= nes + :alt: libvirt-go-xml-module pipeline status + + * - libvirt-snmp + - .. image:: https://gitlab.com/libvirt/libvirt-snmp/badges/master/pi= peline.svg + :target: https://gitlab.com/libvirt/libvirt-snmp/pipelines + :alt: libvirt-snmp pipeline status + + +Testing +------- + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-ci + - .. image:: https://gitlab.com/libvirt/libvirt-ci/badges/master/pipe= line.svg + :target: https://gitlab.com/libvirt/libvirt-ci/pipelines + :alt: libvirt-ci pipeline status + + * - libvirt-test-API + - .. image:: https://gitlab.com/libvirt/libvirt-test-API/badges/maste= r/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-test-API/pipelines + :alt: libvirt-test-API pipeline status + + * - libvirt-tck + - .. image:: https://gitlab.com/libvirt/libvirt-tck/badges/master/pip= eline.svg + :target: https://gitlab.com/libvirt/libvirt-tck/pipelines + :alt: libvirt-tck pipeline status + + +Documentation / websites +------------------------ + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-publican + - .. image:: https://gitlab.com/libvirt/libvirt-publican/badges/maste= r/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-publican/pipelines + :alt: libvirt-publican pipeline status + + * - libvirt-appdev-guide-python + - .. image:: https://gitlab.com/libvirt/libvirt-appdev-guide-python/b= adges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-appdev-guide-python/= pipelines + :alt: libvirt-appdev-guide-python pipeline status + + * - libvirt-wiki + - .. image:: https://gitlab.com/libvirt/libvirt-wiki/badges/master/pi= peline.svg + :target: https://gitlab.com/libvirt/libvirt-wiki/pipelines + :alt: libvirt-wiki pipeline status + + * - virttools-planet + - .. image:: https://gitlab.com/libvirt/virttools-planet/badges/maste= r/pipeline.svg + :target: https://gitlab.com/libvirt/virttools-planet/pipelines + :alt: virttools-planet pipeline status + + * - virttools-web + - .. image:: https://gitlab.com/libvirt/virttools-web/badges/master/p= ipeline.svg + :target: https://gitlab.com/libvirt/virttools-web/pipelines + :alt: virttools-web pipeline status + + +Miscellaneous +------------- + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-console-proxy + - .. image:: https://gitlab.com/libvirt/libvirt-console-proxy/badges/= master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-console-proxy/pipeli= nes + :alt: libvirt-console-proxy pipeline status + + * - libvirt-designer + - .. image:: https://gitlab.com/libvirt/libvirt-designer/badges/maste= r/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-designer/pipelines + :alt: libvirt-designer pipeline status + + * - libvirt-devaddr + - .. image:: https://gitlab.com/libvirt/libvirt-devaddr/badges/master= /pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-devaddr/pipelines + :alt: libvirt-devaddr pipeline status + + * - libvirt-sandbox + - .. image:: https://gitlab.com/libvirt/libvirt-sandbox/badges/master= /pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-sandbox/pipelines + :alt: libvirt-sandbox pipeline status + + * - libvirt-sandbox-image + - .. image:: https://gitlab.com/libvirt/libvirt-sandbox-image/badges/= master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-sandbox-image/pipeli= nes + :alt: libvirt-sandbox-image pipeline status + + * - libvirt-security-notice + - .. image:: https://gitlab.com/libvirt/libvirt-security-notice/badge= s/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-security-notice/pipe= lines + :alt: libvirt-security-notice pipeline status diff --git a/docs/ci.rst b/docs/ci.rst index 71418d74bf..d5282c4d25 100644 --- a/docs/ci.rst +++ b/docs/ci.rst @@ -5,6 +5,8 @@ Libvirt Continuous Integration .. contents:: =20 The libvirt project uses GitLab CI for automated testing. +`Here's `__ our CI dashboard which shows the current st= atus +of our pipelines. =20 Linux builds and cross-compiled Windows builds happen on GitLab CI's shared runners, while FreeBSD and macOS coverage is achieved by triggering `Cirru= s CI @@ -13,217 +15,27 @@ runners, while FreeBSD and macOS coverage is achieved = by triggering `Cirrus CI Most of the tooling used to build CI pipelines is maintained as part of the `libvirt-ci `_ subproject. =20 -GitLab CI Dashboard -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -The dashboard below shows the current status of the GitLab CI jobs for each -repository: =20 -Core project ------------- =20 -.. list-table:: - :widths: 80 20 - :header-rows: 1 =20 - * - Project - - Pipeline =20 - * - libvirt - - .. image:: https://gitlab.com/libvirt/libvirt/badges/master/pipelin= e.svg - :target: https://gitlab.com/libvirt/libvirt/pipelines - :alt: libvirt pipeline status =20 =20 -Language bindings ------------------ =20 -.. list-table:: - :widths: 80 20 - :header-rows: 1 =20 - * - Project - - Pipeline =20 - * - libvirt-csharp - - .. image:: https://gitlab.com/libvirt/libvirt-csharp/badges/master/= pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-csharp/pipelines - :alt: libvirt-csharp pipeline status =20 - * - libvirt-go-module - - .. image:: https://gitlab.com/libvirt/libvirt-go-module/badges/mast= er/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-go-module/pipelines - :alt: libvirt-go-module pipeline status =20 - * - libvirt-java - - .. image:: https://gitlab.com/libvirt/libvirt-java/badges/master/pi= peline.svg - :target: https://gitlab.com/libvirt/libvirt-java/pipelines - :alt: libvirt-java pipeline status =20 - * - libvirt-ocaml - - .. image:: https://gitlab.com/libvirt/libvirt-ocaml/badges/master/p= ipeline.svg - :target: https://gitlab.com/libvirt/libvirt-ocaml/pipelines - :alt: libvirt-ocaml pipeline status =20 - * - libvirt-perl - - .. image:: https://gitlab.com/libvirt/libvirt-perl/badges/master/pi= peline.svg - :target: https://gitlab.com/libvirt/libvirt-perl/pipelines - :alt: libvirt-perl pipeline status =20 - * - libvirt-php - - .. image:: https://gitlab.com/libvirt/libvirt-php/badges/master/pip= eline.svg - :target: https://gitlab.com/libvirt/libvirt-php/pipelines - :alt: libvirt-php pipeline status =20 - * - libvirt-python - - .. image:: https://gitlab.com/libvirt/libvirt-python/badges/master/= pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-python/pipelines - :alt: libvirt-python pipeline status =20 - * - libvirt-ruby - - .. image:: https://gitlab.com/libvirt/libvirt-ruby/badges/master/pi= peline.svg - :target: https://gitlab.com/libvirt/libvirt-ruby/pipelines - :alt: libvirt-ruby pipeline status - - * - libvirt-rust - - .. image:: https://gitlab.com/libvirt/libvirt-rust/badges/master/pi= peline.svg - :target: https://gitlab.com/libvirt/libvirt-rust/pipelines - :alt: libvirt-rust pipeline status =20 =20 -Object mappings ---------------- =20 -.. list-table:: - :widths: 80 20 - :header-rows: 1 =20 - * - Project - - Pipeline =20 - * - libvirt-cim - - .. image:: https://gitlab.com/libvirt/libvirt-cim/badges/master/pip= eline.svg - :target: https://gitlab.com/libvirt/libvirt-cim/pipelines - :alt: libvirt-cim pipeline status =20 - * - libvirt-dbus - - .. image:: https://gitlab.com/libvirt/libvirt-dbus/badges/master/pi= peline.svg - :target: https://gitlab.com/libvirt/libvirt-dbus/pipelines - :alt: libvirt-dbus pipeline status =20 - * - libvirt-glib - - .. image:: https://gitlab.com/libvirt/libvirt-glib/badges/master/pi= peline.svg - :target: https://gitlab.com/libvirt/libvirt-glib/pipelines - :alt: libvirt-glib pipeline status - - * - libvirt-go-xml-module - - .. image:: https://gitlab.com/libvirt/libvirt-go-xml-module/badges/= master/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-go-xml-module/pipeli= nes - :alt: libvirt-go-xml-module pipeline status - - * - libvirt-snmp - - .. image:: https://gitlab.com/libvirt/libvirt-snmp/badges/master/pi= peline.svg - :target: https://gitlab.com/libvirt/libvirt-snmp/pipelines - :alt: libvirt-snmp pipeline status - - -Testing -------- - -.. list-table:: - :widths: 80 20 - :header-rows: 1 - - * - Project - - Pipeline - - * - libvirt-ci - - .. image:: https://gitlab.com/libvirt/libvirt-ci/badges/master/pipe= line.svg - :target: https://gitlab.com/libvirt/libvirt-ci/pipelines - :alt: libvirt-ci pipeline status - - * - libvirt-test-API - - .. image:: https://gitlab.com/libvirt/libvirt-test-API/badges/maste= r/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-test-API/pipelines - :alt: libvirt-test-API pipeline status - - * - libvirt-tck - - .. image:: https://gitlab.com/libvirt/libvirt-tck/badges/master/pip= eline.svg - :target: https://gitlab.com/libvirt/libvirt-tck/pipelines - :alt: libvirt-tck pipeline status - - -Documentation / websites ------------------------- - -.. list-table:: - :widths: 80 20 - :header-rows: 1 - - * - Project - - Pipeline - * - libvirt-publican - - .. image:: https://gitlab.com/libvirt/libvirt-publican/badges/maste= r/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-publican/pipelines - :alt: libvirt-publican pipeline status - - * - libvirt-appdev-guide-python - - .. image:: https://gitlab.com/libvirt/libvirt-appdev-guide-python/b= adges/master/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-appdev-guide-python/= pipelines - :alt: libvirt-appdev-guide-python pipeline status - - * - libvirt-wiki - - .. image:: https://gitlab.com/libvirt/libvirt-wiki/badges/master/pi= peline.svg - :target: https://gitlab.com/libvirt/libvirt-wiki/pipelines - :alt: libvirt-wiki pipeline status - - * - virttools-planet - - .. image:: https://gitlab.com/libvirt/virttools-planet/badges/maste= r/pipeline.svg - :target: https://gitlab.com/libvirt/virttools-planet/pipelines - :alt: virttools-planet pipeline status - - * - virttools-web - - .. image:: https://gitlab.com/libvirt/virttools-web/badges/master/p= ipeline.svg - :target: https://gitlab.com/libvirt/virttools-web/pipelines - :alt: virttools-web pipeline status - - -Miscellaneous -------------- - -.. list-table:: - :widths: 80 20 - :header-rows: 1 - - * - Project - - Pipeline - - * - libvirt-console-proxy - - .. image:: https://gitlab.com/libvirt/libvirt-console-proxy/badges/= master/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-console-proxy/pipeli= nes - :alt: libvirt-console-proxy pipeline status - - * - libvirt-designer - - .. image:: https://gitlab.com/libvirt/libvirt-designer/badges/maste= r/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-designer/pipelines - :alt: libvirt-designer pipeline status - - * - libvirt-devaddr - - .. image:: https://gitlab.com/libvirt/libvirt-devaddr/badges/master= /pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-devaddr/pipelines - :alt: libvirt-devaddr pipeline status - - * - libvirt-sandbox - - .. image:: https://gitlab.com/libvirt/libvirt-sandbox/badges/master= /pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-sandbox/pipelines - :alt: libvirt-sandbox pipeline status - - * - libvirt-sandbox-image - - .. image:: https://gitlab.com/libvirt/libvirt-sandbox-image/badges/= master/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-sandbox-image/pipeli= nes - :alt: libvirt-sandbox-image pipeline status - - * - libvirt-security-notice - - .. image:: https://gitlab.com/libvirt/libvirt-security-notice/badge= s/master/pipeline.svg - :target: https://gitlab.com/libvirt/libvirt-security-notice/pipe= lines - :alt: libvirt-security-notice pipeline status diff --git a/docs/meson.build b/docs/meson.build index cb70ef6084..fd9df047cb 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -34,6 +34,7 @@ docs_rst_files =3D [ 'bugs', 'cgroups', 'ci', + 'ci-dashboard', 'coding-style', 'committer-guidelines', 'compiling', --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812907; cv=none; d=zohomail.com; s=zohoarc; b=SIieIaDyngNMEJniiUiEG82csaqdufxgbfzl0mqgc5ovb3q7nrRvwBwYXm2dVayroBW+HjO1oOGuHUXVXVxGRiWxSXaovOrHL2z9JMCgGFuLEFay2DIzZHyq+bg+O7KBNY480L2mdiR7pM4afSqIcN73OhCw83qz77ChJM/ZUjo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812907; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=BBbsctCcW2ZxGY4yuCbacu5XC54m7CLq7K0K8w3T9pI=; b=P7frrpHd8xt2tbx3L7RUL9vHTL64Lj6qulaXQMmARGAx2QL+zpb2qOjoY6mOFCteYumIqOPigZqhyr0ZXho8wJnZPqCT7QB7T8EmbH+nWcKf9f3RBD80uuPX90yEYw/ViJO0+L8y7+loR1PMyIWCy1IaO4vvta9WqtT6Zz5hVB0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1657812907942121.72806094202554; Thu, 14 Jul 2022 08:35:07 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-42-JaILXIHGPamOhY0TCMs0Iw-1; Thu, 14 Jul 2022 11:34:59 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 5CCC885A58B; Thu, 14 Jul 2022 15:34:56 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 48AFC40CF8EE; Thu, 14 Jul 2022 15:34:56 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 59FEF1947079; Thu, 14 Jul 2022 15:34:55 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id A467B194706D for ; Thu, 14 Jul 2022 15:34:38 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 6D9B440E80E5; Thu, 14 Jul 2022 15:34:38 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id DCB8440E80E0; Thu, 14 Jul 2022 15:34:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812906; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=BBbsctCcW2ZxGY4yuCbacu5XC54m7CLq7K0K8w3T9pI=; b=BBqytBYRzyHoOMf47pymWxDepEab2VhSK96tnNKnhaqolbNez/PRgsUS/ZKMKonIGYP5LT Diw7Blqm7otINVQx2lM7etWAh71oy8Br1DY2FXwmeqHsurHoY2E/mScuZPL1S2BL+Zwt3d M4GFo6ycsZIHLdlW2wGQRYorETRZpUE= X-MC-Unique: JaILXIHGPamOhY0TCMs0Iw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 02/10] docs: Provide more information about the TCK test suite Date: Thu, 14 Jul 2022 17:34:27 +0200 Message-Id: <0be5de986a63ce8a6f829d0a429bd4fae07c048f.1657812867.git.eskultet@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812909053100001 Most importantly, how to get it, how install dependencies and how to run it. Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/testtck.rst | 99 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 88 insertions(+), 11 deletions(-) diff --git a/docs/testtck.rst b/docs/testtck.rst index 51de095657..6264b40de7 100644 --- a/docs/testtck.rst +++ b/docs/testtck.rst @@ -2,6 +2,8 @@ libvirt TCK : Technology Compatibility Kit =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 +.. contents:: + The libvirt TCK provides a framework for performing testing of the integra= tion between libvirt drivers, the underlying virt hypervisor technology, related operating system services and system configuration. The idea (and name) is @@ -23,15 +25,90 @@ determine the level of compatibility of their platform,= and evaluate whether it will meet their needs, and get awareness of any regressions that may have occurred since a previous test run. =20 -For more details you can look at: - -- The initial `mail from Daniel - Berrange `__ - presenting the project. -- The `page describing - VirtTCK `__ the inclus= ion of - libvirt-TCK as a Fedora Feature. - Libvirt-TCK is maintained using `a GIT -repository `__, and comment, patch= es and -reviews are carried on the `libvir-list `__ development list. +repository `__. GitLab is also the= place +where the whole TCK development workflow (issues, merge requests, comments) +happens. + +Using TCK +--------- + +TCK can be used independently of the enviroment, i.e. both on your local h= ost +or in a VM. We strongly recommend using a VM for the tests as TCK might af= fect +your current host setup, see `Running TCK`_. + +Installing dependencies +~~~~~~~~~~~~~~~~~~~~~~~ + +Since TCK is based on libvirt Perl bindings, you'll need to have the proper +version of the bindings installed for the version of libvirt you wish to t= est +in order to be able execute the TCK test suite successfully. Additionally,= a +number of Perl dependencies will need to be installed as well, some will be +available through the system package manager and some will likely need to = be +installed from CPAN (Perl's equivalent of Python's PyPI). Here's where +`libvirt-ci's `__ lcitool can h= elp +with preparing a test environment in a fresh VM, taking care of the +dependencies along the way: + +:: + + $ lcitool install --target fedora-36 tck-fedora36 --wait + +would get you a new Fedora 36 VM named ``tck-fedora36``. Then + +:: + + $ lcitool update tck-fedora36 libvirt,libvirt-perl,libvirt-tck+runtime + +will install all the necessary dependencies to build libvirt, the correspo= nding +Perl bindings and all TCK runtime dependencies to be able to execute the t= ests. +We also recommend executing TCK using the Avocado framework as the test ha= rness +engine which means that you'll have to install Avocado in the test environ= ment +as well. You can get it either from +`PyPI `__ (recommended), or if +you're on Fedora you can make use of the Avocado `module `__. +Using Avocado is not mandatory for the time being and you can skip it, but +in the future we plan on making the TCK internal coupling with Avocado tig= hter. + +Running TCK +~~~~~~~~~~~ + +Once you have all the dependencies installed, you can then proceed with ru= nning +as root the test suite as root (when running with Avocado): + +:: + + # avocado --config avocado.config run --tap - ./scripts/ + +from the TCK's git root. + + +If you don't want to install Avocado you can execute tests using the +``libvirt-tck`` binary directly (again, from the git root). You'll need to= pass +a few options that Avocado takes care of: + +:: + + # PERL5LIB=3D./lib perl bin/libvirt-tck -c --force ./= scripts + +Running with the ``--force`` argument is not necessary and you can safely = omit +it, but it becomes useful if you need to interrupt a test run for some +reason. In such case using ``--force`` ensures the first thing TCK does be= fore +running any tests is that it will clean up all resources from the previous= test +run which may have been left behind if you had interrupted the previous TC= K's +execution. + +Note that running with root privileges is necessary since some tests need +access to system resources or configs. This, along with the fact that some +tests might affect the host system are good reasons to consider using a te= st VM +as described above. + +Contributing a test +------------------- + +We'd appreciate if you provided a functional test case whenever you're add= ing a +new feature or fixing a bug in libvirt with the only complication being th= at +in case you're adding a new public API then a Perl binding will have to be +introduced first. After that, the best way to start is looking at some exi= sting +tests, copy-pasting one that fits your scenario the best and tweak the +remaining bits. --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812933; cv=none; d=zohomail.com; s=zohoarc; b=VoBb2f1+DCqjBH4mxPicJWQIiVlbxTjk2o4+xUlqELnjYp5g1igsoPrB3ygg9OThIzraN32/guwit9b6wYRuUwP5odrfsH8BdUVWpT056ZFnW5hUnWo68ptQiwGexgrjkS6CuTt2r/l5MWuuq7rlp88+PYQtCZxWQTk6Mu8cwtU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812933; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=h5eyJdAQ0gVMVsgBjK93bXnuB9r36Y4Y0sHpAnYY++M=; b=C9yqMdiQNjkIvFQU+/B04mVtt4Y5KIbtvcldLVTbUhwGwQMXMSdmrpekFaEmZHY6v8kJExoBtyrpGbZAIX3Au1lfKdRFl5XU5X2dBIoUinmw5/mDnr6M5Q8o+ui+Kr5d444em81Wq71vJVh4akQlN50x8XhEaks6Hy2a2hs9js4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1657812933422998.2392601633395; Thu, 14 Jul 2022 08:35:33 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-175-GA9B-5OKNjGOJlxgmdSw9A-1; Thu, 14 Jul 2022 11:35:30 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 7099D280048F; Thu, 14 Jul 2022 15:35:27 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 582292026D07; Thu, 14 Jul 2022 15:35:27 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id EB17D194706C; Thu, 14 Jul 2022 15:35:26 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 5A73E1947079 for ; Thu, 14 Jul 2022 15:34:39 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 319EA40E80F3; Thu, 14 Jul 2022 15:34:39 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id A93D140E80E0; Thu, 14 Jul 2022 15:34:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812932; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=h5eyJdAQ0gVMVsgBjK93bXnuB9r36Y4Y0sHpAnYY++M=; b=Pqmx/klvJv/9AsvDrzo7S7hOzWka+aNAeOQ0jzVoYRPxIQQbU1WT9ieirxT+UJ3bBmmxIN B82RubZrXtqcPBHU2KZyjqq2ETqeM7s1l5v0/tw9NU+IXjPvuzSCjpkg0rOrPsrd3O8pJY zjtIL2zy/iOYRXGVtD4yxHvL99yatgQ= X-MC-Unique: GA9B-5OKNjGOJlxgmdSw9A-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 03/10] docs: Provide an article on how to add a custom runner to the project Date: Thu, 14 Jul 2022 17:34:28 +0200 Message-Id: <1dc037ec179ea292768a00b39c2ebf132af16250.1657812867.git.eskultet@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812935212100001 Since running our functional test suite in GitLab cannot make use of the shared resources it makes sense to document the process of adding own HW to run the custom libvirt executor that powers the integration suite. This article will likely make even more sense in the future with GitLab severely cutting down on shared CI resources. Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/ci-runners.rst | 86 +++++++++++++++++++++++++++++++++++++++++++++ docs/meson.build | 1 + 2 files changed, 87 insertions(+) create mode 100644 docs/ci-runners.rst diff --git a/docs/ci-runners.rst b/docs/ci-runners.rst new file mode 100644 index 0000000000..fd5fdd121a --- /dev/null +++ b/docs/ci-runners.rst @@ -0,0 +1,86 @@ +GitLab CI Custom (Specific) Runners +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. contents:: + +GitLab's CI allows additional machines to be added to the project's or gro= up's +pool of runners (a runner is a machine running the GitLab's +`gitlab-runner `__ agent ser= vice). +Upon registering the runner the runner will then be ready accepting CI jobs +depending on the pipeline configuration. Unlike the shared runners provided +directly by GitLab's hosted SaaS specific runners are only used within the +project/group which they were registered to, so you don't need to worry ab= out +forks burning CPU cycles on your precious HW resources. + +Understandably, we respect your decision to keep your runners only visible= to +your fork, but for the sake of the community we'd appreciate if you decide= d to +register your runner with the upstream libvirt project instead. As we're o= nly +interested in running upstream test workloads (which you can even help +defining) maintenance and security of the HW is your own responsibility an= d so +we can promise to never ask for physical or remote access to the machine. + +Machine Setup Howto +------------------- + +The following sections will guide you through the necessary setup of your +specific GitLab runners. + +gitlab-runner setup and registration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The gitlab-runner agent needs to be installed on each machine that is supp= osed +to run jobs. The association between a machine and a GitLab project +happens with a registration token. To find the registration token for +your repository/project, navigate on GitLab's web UI to: + + * Settings (the gears-like icon at the bottom of the left hand side + vertical toolbar), then + * CI/CD, then + * Runners, and click on the *Expand* button, then + * Under *Set up a specific Runner manually*, look for the value under + *And this registration token:* + +Note that in order to register a runner with the upstream libvirt project +you'll need to work with the project maintainers to successfully register = your +machine. + +Following the `registration `__ +process, it's necessary to configure the runner tags, and optionally other +configurations on the GitLab UI. Navigate to: + + * Settings (the gears like icon), then + * CI/CD, then + * Runners, and click on the *Expand* button, then + * *Runners activated for this project*, then + * Click on the *Edit* icon (next to the *Lock* Icon) + +Don't forget to add a tag to your runner as these are used to route specif= ic +jobs to specific runners, e.g. if a job in ``ci/integration.yml`` looked l= ike +this :: + + centos-stream-9-tests: + ... + variables: + # needed by libvirt-gitlab-executor + DISTRO: centos-stream-9 + # can be overridden in forks to set a different runner tag + LIBVIRT_CI_INTEGRATION_RUNNER_TAG: my-vm-host + tags: + - $LIBVIRT_CI_INTEGRATION_RUNNER_TAG + +it would mean that the CentOS Stream 9 job would only be scheduled on runn= ers +bearing the 'my-vm-host' tag. + +Running integration tests +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Libvirt's integration tests run in a nested virtualization environment. So= , if +you wish to run integration tests on your bare-metal machine, you'll have = to +make use of GitLab's +`custom executor `__ +feature which allows you to provision any kind of environment for a worklo= ad to +run - in libvirt's case - a virtual machine. If you need any help with cre= ating +VM template images ready to run libvirt's integration test suite, have a l= ook +at the `libvirt-gitlab-executor `__ +project which encapsulates provisioning, execution, and teardown of the +virtualized environments in a single tool. diff --git a/docs/meson.build b/docs/meson.build index fd9df047cb..0c7c54a75f 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -35,6 +35,7 @@ docs_rst_files =3D [ 'cgroups', 'ci', 'ci-dashboard', + 'ci-runners', 'coding-style', 'committer-guidelines', 'compiling', --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812889; cv=none; d=zohomail.com; s=zohoarc; b=dXOZbW4xB+MComHLDhI8gv5JIEfMj/UgM7F/n3zmgE5L+D/+hOGQluDnxxnKtBi3VVp24v92+WVyTru3ztPdD1YKuHOOy3D9fvoKPZlPTKfiDLlFQGTeZi1s0eqXA+C81MuN9ddOU+EPOiVImPjFNKtfNzTMsaIY8cN0cgME4gk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812889; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=6/4PXGBfPy6L7kE1AWjZfLGQrD1sVTLjxfOHrWYeGdw=; b=ecYAXeObPifksId8DF2NCmexqkTuHJoLse62uEPXRcReDy8VseQmWOxjuCU84YTs0+EVJFQdZdkLwF6Az2NHJl7LLmNTmdjsml1W0+EP/n4PJHamz6oEyeqS0nEUWcVfPn2+dhyZkTewy8JQD+6M5M3LVAmF0vAo/ymWK863n70= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1657812889354385.1785855002822; Thu, 14 Jul 2022 08:34:49 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-359-A2X7_lJ9OtGVDtewhfb3cA-1; Thu, 14 Jul 2022 11:34:44 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id A0A582800482; Thu, 14 Jul 2022 15:34:41 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8DDFA2166B2A; Thu, 14 Jul 2022 15:34:41 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 5B47C194706D; Thu, 14 Jul 2022 15:34:41 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 3051C194706C for ; Thu, 14 Jul 2022 15:34:40 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id EB8FF40E80E0; Thu, 14 Jul 2022 15:34:39 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6D59240E80E1; Thu, 14 Jul 2022 15:34:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812888; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=6/4PXGBfPy6L7kE1AWjZfLGQrD1sVTLjxfOHrWYeGdw=; b=aK0nuoZyfmHNeeUuaBohPKOXQkZSg6sLBjg8JKsZDaO7fHylzicxkpr0Zo/VNH2yC2+cZr +vFpACtxPZt6ZR0IGmbNWz0VlEtV7ZENmDvubsT1OI7uXYr01KtXGASOU8OASHyMgsNxcv XCcurspuEmLatq/xrcxELANdKpZlcTw= X-MC-Unique: A2X7_lJ9OtGVDtewhfb3cA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 04/10] docs: Provide an article on testing Date: Thu, 14 Jul 2022 17:34:29 +0200 Message-Id: <23505d4b886d005972649dea44eb1d162e262c03.1657812867.git.eskultet@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812890984100002 Content-Type: text/plain; charset="utf-8"; x-default="true" Currently we don't have much information on how testing is done in libvirt and the little we have is scattered among multiple files. This patch creates a common landing page containing all important bits about testing in libvirt, providing links to respective sections which deserve their own articles. Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/meson.build | 1 + docs/testing.rst | 172 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 173 insertions(+) create mode 100644 docs/testing.rst diff --git a/docs/meson.build b/docs/meson.build index 0c7c54a75f..6d61e18385 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -105,6 +105,7 @@ docs_rst_files =3D [ 'submitting-patches', 'support', 'testapi', + 'testing', 'testsuites', 'testtck', 'uri', diff --git a/docs/testing.rst b/docs/testing.rst new file mode 100644 index 0000000000..21abf42080 --- /dev/null +++ b/docs/testing.rst @@ -0,0 +1,172 @@ +=3D=3D=3D=3D=3D=3D=3D +Testing +=3D=3D=3D=3D=3D=3D=3D + +.. contents:: + +Different types of tests are available to libvirt developers for testing a +given libvirt release. + +Unit tests +---------- + +The unit test suite present in the source code is mainly used to test our +XML parser/formatter, QEMU command line generator, QEMU capabilities probi= ng, +etc. It is run by developers before submitting patches upstream and is +mandatory to pass for any contribution to be accepted upstream. One can run +the test suite in the source tree with the following:: + + $ ninja test + + +Container builds +---------------- + +Technically speaking these are not tests in the common sense. However, usa= ge of +public container images to build libvirt in predefined and widely accessib= le +environments makes it possible to expand our coverage across distros, +architectures, toolchain flavors and library versions and as such is a very +valuable marker when accepting upstream contributions. Therefore, it is +recommended to run libvirt builds against your changes in various containe= rs to +either locally or by using GitLab's shared CI runners to make sure everyth= ing +runs cleanly before submitting your patches. The images themselves come fr= om +libvirt's GitLab container registry, but this can be overriden if needed, = see +below. + +Registry +~~~~~~~~ + +Libvirt project has its container registry hosted by GitLab at +``registry.gitlab.com/libvirt/libvirt`` which will automatically be +used to pull in pre-built layers. This avoids the need to build all the +containers locally using the Dockerfile recipes found in ``ci/containers/`= `. + + +Running container builds with GitLab CI +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +As long as your GitLab account has CI minutes available, pipelines will run +automatically on every branch push to your fork. + +Running container builds locally +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In order to run container builds locally, we have a ``helper`` script insi= de +the ``ci`` directory that can pull, build, and test (if applicable) change= s on +your current local branch. It supports both the Docker and Podman runtimes +with an automatic selection of whichever runtime is configured on your sys= tem. +In case neither has been enabled/configured, please go through the followi= ng +prerequisites. We recommend using podman because of its daemonless archite= cture +and security implications (i.e. rootless container execution by default) o= ver +Docker. + +Podman Prerequisites +~~~~~~~~~~~~~~~~~~~~ + +Install "podman" with the system package manager. + +.. code:: + + $ sudo dnf install -y podman + $ podman ps + +The last command should print an empty table, to verify the system is read= y. + +Docker Prerequisites +~~~~~~~~~~~~~~~~~~~~ + +Install "docker" with the system package manager and start the Docker serv= ice +on your development machine, then make sure you have the privilege to run +Docker commands. Typically it means setting up passwordless ``sudo docker`` +command or login as root. For example: + +.. code:: + + $ sudo dnf install -y docker + $ # or `apt-get install docker` for Ubuntu, etc. + $ sudo systemctl start docker + $ sudo docker ps + +The last command should print an empty table, to verify the system is read= y. + +An alternative method to set up permissions is by adding the current user = to +"docker" group and making the docker daemon socket file (by default +``/var/run/docker.sock``) accessible to the group: + +.. code:: + + $ sudo groupadd docker + $ sudo usermod $USER -a -G docker + $ sudo chown :docker /var/run/docker.sock + +Note that any one of above configurations makes it possible for the user to +exploit the whole host with Docker bind mounting or other privileged +operations. So only do it on development machines. + +Examples of executing local container builds +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +All of the following examples will utilize ``helper`` script mentioned ear= lier +sections. Let's start with the basics - listing available container images= in +the default libvirt registry: + +:: + + $ cd /ci + $ ./helper --help + $ ./helper list-images + Available x86 container images: + + ... + alpine-edge + fedora-rawhide + ... + + Available cross-compiler container images: + + ... + debian-sid-cross-s390x + fedora-rawhide-cross-mingw32 + fedora-rawhide-cross-mingw64 + ... + +Now let's say one would want to build their local libvirt changes on Alpine +Edge using their own GitLab's registry container. They'd then proceed with + +:: + + $ ci/helper build --image-prefix registry.gitlab.com//libvirt/ci= - alpine-edge + +Finally, it would be nice if one could get an interactive shell inside the +test environment to debug potential build issues. This can be achieved wit= h the +following: + +:: + + $ ci/helper shell alpine-edge + + +Integration tests +----------------- + +There are a few frameworks for writing and running functional tests in lib= virt +with TCK being the one that runs in our upstream CI. + +- the `TCK test suite `__ is a functional test suite implem= ented + using the `Perl bindings `__ of + libvirt. This is the recommended framework to use for writing upstream + functional tests at the moment. You can start by cloning the + `TCK git repo `__. + +- the `Avocado VT `__ te= st + suite with the libvirt plugin is another framework implementing functio= nal + testing utilizing the Avocado test framework underneath. Although writt= en in + Python, the vast majority of the tests are exercising libvirt through t= he + command line client ``virsh``. + +- the `libvirt-test-API `__ is also a functional test suite= , but + implemented using the `Python bindings `__ of libvirt. + Unfortunately this framework is the least recommended one as it's large= ly + unmaintained and may be completely deprecated in the future in favour o= f TCK. + You can get it by cloning the + `git repo `__. --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812966; cv=none; d=zohomail.com; s=zohoarc; b=NUo+SPuGxqbkubsg4YmOmlJ5LlR9lW1i8xPNOTrndXelT+PkF0Hh4/ypvClwoU7yJ7wob5M8dMbGMfr1YfcYxLYOBTed8Vvz8zFzQxJzQBilEIfQXfbgHKUGTkIVJ/psfnwx0pn+r1UKUUvGATYNFkhf/09b+xYNfrbIOXjLX0M= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812966; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=Lt2Pb95gtuTATwfQ2GpthFdRLDtWG5CgMGk1A8cl0bQ=; b=EAXVwuYZ7QUosP6BggTRMMH+3QEmKDP+ka/nhdGjVGUAyE2lp3ZBdBdFHCGT3UsBIdWSH8JBh8S6Ieur/J8iBepk532odt/+BAqi9JFbbHlz7FK784dt+pkImiTGmDS+Yo8l/scGPgy6JUxdTpar/Qx9BpKzbphdIrlyuttQAOc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1657812966675612.7267954630908; Thu, 14 Jul 2022 08:36:06 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-272-5WsN9DmNMb6SOPWqjXofyw-1; Thu, 14 Jul 2022 11:34:58 -0400 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 24A2E85A588; Thu, 14 Jul 2022 15:34:56 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0C980492C3B; Thu, 14 Jul 2022 15:34:56 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 7560B19452D8; Thu, 14 Jul 2022 15:34:55 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id D5C801947042 for ; Thu, 14 Jul 2022 15:34:40 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id AF6B040E80E5; Thu, 14 Jul 2022 15:34:40 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3386140E80E1; Thu, 14 Jul 2022 15:34:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812965; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=Lt2Pb95gtuTATwfQ2GpthFdRLDtWG5CgMGk1A8cl0bQ=; b=fhI2939p+fw6WcMxWowxMEitTzrv+lM1IdAfdFg0nvO1nSZvcZMfZ9fogxEGmg5OqwWC7i 9kOLXOh71/W1HDZln8/XCmj3YGAkO16JeNo2gbP3UdXQEdKE9FZqKMWLL20wT6KFXK50cl DgOJIirOr5ZgQk72J0ztPQLlNE8kKH8= X-MC-Unique: 5WsN9DmNMb6SOPWqjXofyw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 05/10] docs: Replace testsuites article with the new 'testing' article Date: Thu, 14 Jul 2022 17:34:30 +0200 Message-Id: <6ef66b3fea398fe0a5669af42afcd6c83e623b8a.1657812867.git.eskultet@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.10 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812968178100001 The new article provides more in-depth information on testing options in libvirt. Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/docs.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/docs.rst b/docs/docs.rst index 9fd8b7c37e..b17d73743a 100644 --- a/docs/docs.rst +++ b/docs/docs.rst @@ -154,10 +154,8 @@ Project development `API extensions `__ Adding new public libvirt APIs =20 -`Functional testing `__ - Testing libvirt with - `TCK test suite `__ and - `Libvirt-test-API `__ +`Testing `__ + Details various types of testing available for libvirt =20 `New repo setup `__ Procedure for configuring new git repositories for libvirt --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812904; cv=none; d=zohomail.com; s=zohoarc; b=iIqC6Ucyvj+/Gv3z+PFvVaEoC79PU0vSFK2ZS3vBu/J5xCa4Kd9KEt59SRRGBaETAHEMqh0fMVk1qhlF7OjzMzPX9ek9M27i9KoKtLa3dnLbqFpUcBOisUysb175v3LCHr1XqDetWF1+vIvOnW8bFidEv/b4MT0yrD1scErvSQY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812904; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=IQ8oPeAPo6wDfhm0FIl0sRQI/4SOw9mIHJquFpGe6L0=; b=Jpgn+/UbFEeJiM0iYeC3vAkgeNBhptJVuHO47CN7e4y6iq8yLFlfBGRT/fxSvdqFF6+Rz209oM4Eq/osoQZmPrxFRp5J8P7yGcrZa6cpizr1BxnpUMeBtP8RHlqieK7nlIrEo7CNwvI4R9jSk9wWQI6Kw2SU0xjbJ6Borc9wtLw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1657812904369590.148123920139; Thu, 14 Jul 2022 08:35:04 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-126-QiUFjjE1Mwqr4ORMqBe6Eg-1; Thu, 14 Jul 2022 11:34:46 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 2AF0B2800487; Thu, 14 Jul 2022 15:34:44 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1516240CFD05; Thu, 14 Jul 2022 15:34:44 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id E43C41947073; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 8893019452D2 for ; Thu, 14 Jul 2022 15:34:41 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 7376640E80E2; Thu, 14 Jul 2022 15:34:41 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id EB7C140E80E0; Thu, 14 Jul 2022 15:34:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812903; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=IQ8oPeAPo6wDfhm0FIl0sRQI/4SOw9mIHJquFpGe6L0=; b=WMBRqm6W1Bdt52uQyebjK+vRX91UTVvUL4Ak0KAGDQRmT6psXcbV4G1aa3IEZ8w8FX/W3R x4+mdFOQPSKWsuxDMtMwja3WnsrVmTIl0bhQeF1CwWV3/2wpRl90RKgDcTNhFJF4suQUJL eEcSL7SX1fT9JunUWqJCchVVn8Fvkko= X-MC-Unique: QiUFjjE1Mwqr4ORMqBe6Eg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 06/10] docs: Drop the testsuites article Date: Thu, 14 Jul 2022 17:34:31 +0200 Message-Id: <258a81eedc2df5558f3b031be4c7c9f533aee69f.1657812867.git.eskultet@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812905030100001 The article was replaced with a new one in previous commit, so we don't need this one anymore. Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/meson.build | 1 - docs/testsuites.rst | 37 ------------------------------------- 2 files changed, 38 deletions(-) delete mode 100644 docs/testsuites.rst diff --git a/docs/meson.build b/docs/meson.build index 6d61e18385..0b16d64488 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -106,7 +106,6 @@ docs_rst_files =3D [ 'support', 'testapi', 'testing', - 'testsuites', 'testtck', 'uri', 'windows', diff --git a/docs/testsuites.rst b/docs/testsuites.rst deleted file mode 100644 index 4fc733e615..0000000000 --- a/docs/testsuites.rst +++ /dev/null @@ -1,37 +0,0 @@ -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D -Test suites -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -There is a few test suites available to developers for testing a given ver= sion -of libvirt: - -- the internal test suite: present in the source code, it is run by devel= opers - before submitting patches upstream, it is also suggested to have it run= and - pass as part of the packaging process for distributions. It is run by - launching: - - :: - - make check (libvirt 6.6.0 and older) - - :: - - ninja test (libvirt 6.7.0 and newer) - - in a source tree after compilation has finished. It doesn't really make - functional testing but checks that large portions of the code not inter= acting - directly with virtualization functions properly. - -- the `TCK test suite `__ is a functional test suite implem= ented - using the `Perl bindings `__ of - libvirt. It is available separately as a - `download `__, as a - `package `__ - in Fedora distributions, but best is probably to get the `version from - GIT `__. - -- the `libvirt-test-API `__ is also a functional test suite= , but - implemented using the `Python bindings `__ of libvirt. It = is - available separately as a - `download `__, or directly= get - the `version from GIT `__. --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812890; cv=none; d=zohomail.com; s=zohoarc; b=dA1ob9U+u2bQBWu4t6lrghuTeseFFIdbab8+pgYy2GiGDHkEIBRJrezzPtT0Hy3HpL8pWuBq6afvuS4wzOrFy3yA5nlF38S703uSjg7nkhn9fhtHaxBiyTBteGRsS+GHvR8niqBJRIm0MWtEpJRglUJLlb3wS46PzTcMSA8/e/g= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812890; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=Yioaki1qCFFgSLt+Jsc/zAyh513Vmn+JI5cuwiOwLls=; b=Hyl3aMvjVJRFMwCcGQ7i/7ByUP5YNeykDdtOB70X+pWTtbbBsuq2SsDJi559d/eW7dgLSlicx6mtj0pgHrjB21cfQMUhQkpmUbH6FcUCPZ5Z+KZFJonxUf0Mtc+u4orWYL55hM6h31SpD7MzXG6d8wiCq01ceY8zSZeckAmNMo0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 165781289036078.56432770810375; Thu, 14 Jul 2022 08:34:50 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-634-mLuBXS58NICJqxgoQkK4ZA-1; Thu, 14 Jul 2022 11:34:46 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 752DB1C05141; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 5C1D0400DFDF; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 1EF48194706D; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 4662C1947071 for ; Thu, 14 Jul 2022 15:34:42 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 37DDA40E80E2; Thu, 14 Jul 2022 15:34:42 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id B04D040E80E1; Thu, 14 Jul 2022 15:34:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812889; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=Yioaki1qCFFgSLt+Jsc/zAyh513Vmn+JI5cuwiOwLls=; b=ZUZkJBFSRGZkvD77HhnP2WlKPgv6lO3LDrylsUWFXOh+2ZPRLw8Qaga6AV4v+FLI5e2ETW 56QXsMbASwb6Fii0Z80FxMBQsxQVM6DlKNuNi+Z7cYmYDncSQeui16n4krAZak4jyxLkIU 7r9/oVVgthQY7TbFx2z+6CEyaO50F4o= X-MC-Unique: mLuBXS58NICJqxgoQkK4ZA-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 07/10] docs: Change the CI headline from "CI Testing" to "CI" Date: Thu, 14 Jul 2022 17:34:32 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812890926100001 Content-Type: text/plain; charset="utf-8"; x-default="true" It's not just strategy the master CI article talks (or will talk in the future) about. Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/docs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs.rst b/docs/docs.rst index b17d73743a..8ca0afdc1a 100644 --- a/docs/docs.rst +++ b/docs/docs.rst @@ -136,8 +136,8 @@ Project development `Project strategy `__ Sets a vision for future direction & technical choices =20 -`CI Testing `__ - Details of the Continuous Integration testing strategy +`CI `__ + Details on our Continuous Integration =20 `Bug reports `__ How and where to report bugs and request features --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812909; cv=none; d=zohomail.com; s=zohoarc; b=cQ2M6zsBITK1M5tDpNPspi+QkR2B68gqAUrSk4FaaMf+Sov/P9TqIo1gNqgH0epPamgC2vrYMu4rYZ6CGbnEE9Hf/DPxuuRuKRz3FOqlsMbbRlA6I1RHU13UUMN/JGqXx22Z0qXLvr/34/e162DyqMdLRGBpmD0VQtOeEjLRoQw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812909; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=7zXbu+i0c1ur464ptmq/WEJVU75gmq8ECVD37PSHC0o=; b=PcJ3IWCYw0wi/3qbwfTrUm7UvqKyE3DZBusD6bzbvjrOtmxNpEQuUUTyJ786G/wyakqHqvwYf/LwSvtmf9jT1ihhocK5xCcV0ImsUw8Yk01AtsGmKJoIx9mzIURDwwcTHVwnRP/CdN5vZZXqyj84/I7DcQYYkyzAGNJu6GQIcpc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1657812909483548.3610936308783; Thu, 14 Jul 2022 08:35:09 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-32-uZVJJ_R_PmWd6Cpuw7Y-rw-1; Thu, 14 Jul 2022 11:35:01 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 85B2D85A58A; Thu, 14 Jul 2022 15:34:58 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 6E16A18EB5; Thu, 14 Jul 2022 15:34:58 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 25830194706C; Thu, 14 Jul 2022 15:34:58 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 171841947042 for ; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id EF6F240E80E5; Thu, 14 Jul 2022 15:34:42 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id 749BD40E80E0; Thu, 14 Jul 2022 15:34:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812908; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=7zXbu+i0c1ur464ptmq/WEJVU75gmq8ECVD37PSHC0o=; b=Kr4OuK/QwKGn8sYpYvd6E7cc0SVfRFQKTSjX2F8AmSfpWRC3CAAkH8n1Au1nF75tcLHHqa X7B0ZlckQjkd0tlTFVRr4jFGYtxoiBgZPfRxbsNaNo4uTFiL8UQV+JFc98J5WWSvxK7HR6 HZqGGyEYNaohDa9GfhgYkS7nIR7fBRY= X-MC-Unique: uZVJJ_R_PmWd6Cpuw7Y-rw-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 08/10] docs: ci: Add info about the two major types of jobs our CI runs Date: Thu, 14 Jul 2022 17:34:33 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812911051100003 Content-Type: text/plain; charset="utf-8"; x-default="true" Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/ci.rst | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/ci.rst b/docs/ci.rst index d5282c4d25..566bc42db7 100644 --- a/docs/ci.rst +++ b/docs/ci.rst @@ -8,6 +8,9 @@ The libvirt project uses GitLab CI for automated testing. `Here's `__ our CI dashboard which shows the current st= atus of our pipelines. =20 +Builds and unit tests +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + Linux builds and cross-compiled Windows builds happen on GitLab CI's shared runners, while FreeBSD and macOS coverage is achieved by triggering `Cirru= s CI `_ jobs behind the scenes. @@ -15,27 +18,25 @@ runners, while FreeBSD and macOS coverage is achieved b= y triggering `Cirrus CI Most of the tooling used to build CI pipelines is maintained as part of the `libvirt-ci `_ subproject. =20 +Integration tests +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 +Integration tests in our CI pipelines require dedicated HW which is not +available to forks, see `GitLab CI Custom Runners `__. +Therefore, in order to execute the integration tests as part of your libvi= rt +fork's GitLab CI you'll need to provide your own runner. You'll also need = to +set a few CI variables to run the integration tests as part of the CI pipe= line, +see below. =20 +GitLab CI variables +------------------- =20 +* ``LIBVIRT_CI_INTEGRATION`` - enables integration test runs manually or i= n forks +* ``LIBVIRT_CI_INTEGRATION_RUNNER_TAG`` - overrides the upstream runner ta= g on the =20 +Retrieving test logs +-------------------- =20 - - - - - - - - - - - - - - - - - - - +In case the integration test suite fails in our CI pipelines, a job artifa= ct is +generated containing Avocado logs, libvirt debug logs, and the latest trac= eback +(if one was produced during a daemon's execution). --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812971; cv=none; d=zohomail.com; s=zohoarc; b=DpZBRRBOH3vd18qm5gbuxNXNzf1uBbaDcJBj6wsNXLsyWP83q2sduKYzZXWlqRjE10NcJgdinuXrE2PR8b/4Rgyl+m4Lmcjhrd6Myx3g79EIUtnORrVn9sSa3+2s2Agu0qhmy8ZMik6u4YT9EeEQFl+eXTyMvN8gcw1uCLeg7Q4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812971; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=udX+3e//GIhgBVWoENrbiMXbSrV2ZBdJ/JhYJZFOwQE=; b=Kz7U3cBVoQsUpySfF5sSinTTvQMSUE9n0RynqXtUIA2Cx7igfWyf5UQI6x34qM1Gk+CtZorOq70JeyW3LsX/NUYYOyTeB4pAngxUm1dakKD4RFBzuB5sdq96jOei9S8dIk8aXF6ZUdyP7LtE9B9WlP73Uy5D7iBuwiAOyfiJW9A= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1657812971508963.416397751967; Thu, 14 Jul 2022 08:36:11 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-641-5fuN5RS5N7GkwJOTYSvjZQ-1; Thu, 14 Jul 2022 11:34:47 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id CE0E885A584; Thu, 14 Jul 2022 15:34:44 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id B88D518ECB; Thu, 14 Jul 2022 15:34:44 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 9A38A1947071; Thu, 14 Jul 2022 15:34:44 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id CBBB61947071 for ; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B610740E80E2; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id 38ACA40E80E0; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812970; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=udX+3e//GIhgBVWoENrbiMXbSrV2ZBdJ/JhYJZFOwQE=; b=UeLTw2w/L9gxQAC1AAZi1jevUgXgrAplIRbtCCjOY9ag6EizYi+NKU7rrrFjT8cZ3pHE4b ayTGaDoR9pgxKvbcwhFt3L5Farh9ud2T0OpzbDKN+EugNXeqYjrUETMQpAdqgewyALF+NP wL+VgVqcRc2v5tzY5DZVF3p+WLxVe8U= X-MC-Unique: 5fuN5RS5N7GkwJOTYSvjZQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 09/10] docs: ci: Add a section on how to add a new platform to libvirt CI Date: Thu, 14 Jul 2022 17:34:34 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812972210100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/ci.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/ci.rst b/docs/ci.rst index 566bc42db7..efb1ea295e 100644 --- a/docs/ci.rst +++ b/docs/ci.rst @@ -40,3 +40,12 @@ Retrieving test logs In case the integration test suite fails in our CI pipelines, a job artifa= ct is generated containing Avocado logs, libvirt debug logs, and the latest trac= eback (if one was produced during a daemon's execution). + +Adding new OS platforms OR build pre-requisites +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Since all of the Dockerfiles libvirt uses for CI have been generated by ``= lcitool`` +provided by the `libvirt-ci `__= project, +most relevant changes will need to be introduced to ``lcitool`` first. Ple= ase +follow the instructions outlined +`here `__ --=20 2.36.1 From nobody Tue May 14 17:14:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1657812968; cv=none; d=zohomail.com; s=zohoarc; b=EC1QdMiO60dDRFNtx/TJk6rzfW/VrtSRCMtbOfm2fBZeZRhyeW0MHDjJvOCeRlq/qY6YleiilQPeSo+45o2WbvVBdGB0qiWz+YqYOs/WUSgVwTXaVFnz9rfbXONAtxV3Oz16Dshb77DPu+cuULnCkvBVxuPqJsrscWSQCeS2RI4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1657812968; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=OsotPiBGPBBTvMXTMHljfQ/TOSPHmlydkq85FTq7z60=; b=LZ7tX81DheODznTGYU7sULItglv+qrF5myJx8zjGcPfjIka/0gVfVYB9L6iZpe8kuQ4p+9tH2d1+7665Li+nOCLsu8E/URcZTiXz3tcL4tMDZxS/uyu3dvtPoIfVGgfL2osznEWPkLvT7drvvple/Ndq8XiX95hmBsR+rBFhFwM= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1657812968440993.5397328909526; Thu, 14 Jul 2022 08:36:08 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-556-zYw9w0pyP3-gfW9oyBJsCg-1; Thu, 14 Jul 2022 11:34:49 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 01F251035342; Thu, 14 Jul 2022 15:34:47 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id E038118ECB; Thu, 14 Jul 2022 15:34:46 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 88F161947042; Thu, 14 Jul 2022 15:34:46 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 87F201947042 for ; Thu, 14 Jul 2022 15:34:44 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 7807040E80E5; Thu, 14 Jul 2022 15:34:44 +0000 (UTC) Received: from nautilus.home.lan (unknown [10.40.192.119]) by smtp.corp.redhat.com (Postfix) with ESMTP id F0F2C40E80E1; Thu, 14 Jul 2022 15:34:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1657812967; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=OsotPiBGPBBTvMXTMHljfQ/TOSPHmlydkq85FTq7z60=; b=emn4Nj27TwzdXfdnwpBKLa5wtyuA6r+C+JJCYYXjXCYPisw9ZwPcG5iw2aHsZy3MkBGlnj JveNEpmr5XPEGxn0jDttNJIW+dipLbAGNZ7zN7ybXJ54/3BIJ5i3fXDVmKwF3Rj4IfX65C vksF61IL+jFYy6LPwiZHSknau5xaqjI= X-MC-Unique: zYw9w0pyP3-gfW9oyBJsCg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Erik Skultety To: libvir-list@redhat.com Subject: [libvirt PATCH v2 10/10] docs: ci: Add a brief section on how to run the CI workload locally Date: Thu, 14 Jul 2022 17:34:35 +0200 Message-Id: <56da5905db133f7f85687d584e2098b13c07309c.1657812867.git.eskultet@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.11.54.2 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: eskultet@redhat.com Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1657812970118100003 This is just a glue to the testing article introduced in previous commits. Signed-off-by: Erik Skultety Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/ci.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/ci.rst b/docs/ci.rst index efb1ea295e..ee85018c49 100644 --- a/docs/ci.rst +++ b/docs/ci.rst @@ -49,3 +49,10 @@ provided by the `libvirt-ci `__ proje most relevant changes will need to be introduced to ``lcitool`` first. Ple= ase follow the instructions outlined `here `__ + + +Running CI workloads locally +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D + +If you're interested in running the CI test workloads locally, please read +our `testing `__ guide. --=20 2.36.1