Patchtest - Revision history

Simonew at 13:45, 20 February 2024

2024-02-20T13:45:12Z

@@ Line 11: / Line 11: @@
 The patchtest feedback email is designed to provide concise instructions when one or more of the tests has failed, but additional information on specific failures is provided below:
-==== LIC_FILES_CHKSUM changed without "License-Update:" tag and description in commit message ====
+{| class="wikitable" style="margin:auto"
 ==== Tests failed for the patch, but the results log could not be processed due to excessive result line length. ====

Simonew: Patchtest Architecture Notes: Add test_cve_check_ignore

2024-01-14T11:05:33Z

Patchtest Architecture Notes: Add test_cve_check_ignore

← Older revision		Revision as of 11:05, 14 January 2024
Line 85:		Line 85:
	\|-		\|-
	\| test_summary_presence \|\| TestMetadata \|\| Yes \|\|		\| test_summary_presence \|\| TestMetadata \|\| Yes \|\|
			\|-
			\| test_cve_check_ignore \|\| TestMetadata \|\| Yes \|\|
	\|}		\|}

Tgamblin at 17:45, 6 November 2023

2023-11-06T17:45:12Z

← Older revision		Revision as of 17:45, 6 November 2023
Line 80:		Line 80:
	\| test_lic_files_chksum_modified_not_mentioned \|\| TestMetadata \|\| No \|\|		\| test_lic_files_chksum_modified_not_mentioned \|\| TestMetadata \|\| No \|\|
	\|-		\|-
	\| test_max_line_length \|\| TestMetadata \|\| ~~Example~~ \|\|		\| test_max_line_length \|\| TestMetadata \|\| No \|\|
	\|-		\|-
	\| test_src_uri_left_files \|\| TestMetadata \|\| Yes \|\| Has a linked pretest: pretest_src_uri_left_files		\| test_src_uri_left_files \|\| TestMetadata \|\| Yes \|\| Has a linked pretest: pretest_src_uri_left_files

Tgamblin at 17:44, 6 November 2023

2023-11-06T17:44:25Z

Tgamblin at 17:43, 6 November 2023

2023-11-06T17:43:36Z

← Older revision		Revision as of 17:43, 6 November 2023
Line 41:		Line 41:
	=== Patchtest Architecture Notes ===		=== Patchtest Architecture Notes ===

	{\| class="wikitable" style="margin:~~auto~~"		{\| class="wikitable" style="margin:align-left"
	\|+ Test Details		\|+ Test Details
	\|-		\|-

Tgamblin at 17:42, 6 November 2023

2023-11-06T17:42:36Z

@@ Line 42: / Line 42: @@
 {| class="wikitable" style="margin:auto"
-|+ Caption text
+|+ Test Details
 |-
-! Header text !! Header text !! Header text
+! Test Name !! Category !! Uses Tinfoil !! Notes
 |-
-| Example || Example || Example
+| test_upstream_status_presence_format || TestPatch || No ||
 |-
-| Example || Example || Example
+| test_signed_off_by_presence || TestPatch || No ||
 |-
-| Example || Example || Example
+| test_cve_tag_format || TestPatch || No ||
 |}

Tgamblin at 17:28, 6 November 2023

2023-11-06T17:28:08Z

← Older revision		Revision as of 17:28, 6 November 2023
Line 38:		Line 38:

	If you suspect there is an issue with the patchtest feedback emails, the service itself, or any of the documentation, please submit an issue on the Yocto Project Bugzilla [https://bugzilla.yoctoproject.org/ Bugzilla] under the "Yocto Project Subprojects" -> "Patchtest" category.		If you suspect there is an issue with the patchtest feedback emails, the service itself, or any of the documentation, please submit an issue on the Yocto Project Bugzilla [https://bugzilla.yoctoproject.org/ Bugzilla] under the "Yocto Project Subprojects" -> "Patchtest" category.

			=== Patchtest Architecture Notes ===

			{\| class="wikitable" style="margin:auto"
			\|+ Caption text
			\|-
			! Header text !! Header text !! Header text
			\|-
			\| Example \|\| Example \|\| Example
			\|-
			\| Example \|\| Example \|\| Example
			\|-
			\| Example \|\| Example \|\| Example
			\|}

Tgamblin at 15:18, 30 October 2023

2023-10-30T15:18:57Z

← Older revision		Revision as of 15:18, 30 October 2023
Line 17:		Line 17:
	==== A CVE tag should be provided in the commit message with format: "CVE: CVE-YYYY-XXXX" ====		==== A CVE tag should be provided in the commit message with format: "CVE: CVE-YYYY-XXXX" ====

	Whenever a submission adds a CVE patch, patchtest will check both the patch '''and the parent mbox's commit message''' for a "CVE: CVE-YYYY-XXXX" tag. While this has historically not been required, including the tag in both locations ~~improves~~ review and maintenance.		Whenever a submission adds a CVE patch, patchtest will check both the patch '''and the parent mbox's commit message''' for a "CVE: CVE-YYYY-XXXX" tag. While this has historically not been required, including the tag in both locations aids review and maintenance.

	==== Please include a commit message on your patch explaining the change ====		==== Please include a commit message on your patch explaining the change ====

Tgamblin at 15:17, 30 October 2023

2023-10-30T15:17:45Z

← Older revision		Revision as of 15:17, 30 October 2023
Line 33:		Line 33:
	==== Tests failed for the patch, but the results log could not be processed due to excessive result line length. ====		==== Tests failed for the patch, but the results log could not be processed due to excessive result line length. ====

	The patchtest-send-results script checks the test results' maximum line length to help ensure that no unintended and/or malicious code is sent to the mailing list with the results. If this message is present, the user should re-test their patch(es) locally using the '''patchtest''' script in openembedded-core/scripts before further escalation. If the issue persists after re-testing and re-submission it should be reported ~~as a~~ [https://bugzilla.yoctoproject.org/~~enter_bug.cgi?product=Patchwork%2FPatchtest patchtest bug~~] with a "Major" priority (include the patch file as an attachment).		The patchtest-send-results script checks the test results' maximum line length to help ensure that no unintended and/or malicious code is sent to the mailing list with the results. If this message is present, the user should re-test their patch(es) locally using the '''patchtest''' script in openembedded-core/scripts before further escalation. If the issue persists after re-testing and re-submission it should be reported on the Yocto Project [https://bugzilla.yoctoproject.org/ Bugzilla] under the "Yocto Project Subprojects" -> "Patchtest" category with a "Major" priority (include the patch file as an attachment).

	=== Submitting Bug Reports ===		=== Submitting Bug Reports ===

	If you suspect there is an issue with the patchtest feedback emails, the service itself, or any of the documentation, please submit an issue on Bugzilla ~~using the~~ [https://bugzilla.yoctoproject.org/~~enter_bug.cgi?product=Patchwork%2FPatchtest patchtest~~] ~~categories~~.		If you suspect there is an issue with the patchtest feedback emails, the service itself, or any of the documentation, please submit an issue on the Yocto Project Bugzilla [https://bugzilla.yoctoproject.org/ Bugzilla] under the "Yocto Project Subprojects" -> "Patchtest" category.

Tgamblin at 15:13, 30 October 2023

2023-10-30T15:13:59Z

← Older revision		Revision as of 15:13, 30 October 2023
Line 3:		Line 3:
	Patchtest is a tool designed for improving the quality of Yocto Project and OpenEmbedded contributors' patch submissions, while simultaneously reducing the level of review effort required from project maintainers. It does this by providing a set of scripts that users can test their patches with prior to submission ("host" mode), and which can be used as part of an automated service that provides periodic feedback for patches received by Patchwork ("guest" mode).		Patchtest is a tool designed for improving the quality of Yocto Project and OpenEmbedded contributors' patch submissions, while simultaneously reducing the level of review effort required from project maintainers. It does this by providing a set of scripts that users can test their patches with prior to submission ("host" mode), and which can be used as part of an automated service that provides periodic feedback for patches received by Patchwork ("guest" mode).

	=== Using Patchtest===		=== Using Patchtest ===

	See the [https://git.yoctoproject.org/poky/tree/scripts/patchtest.README patchtest README] for instructions on how to use patchtest in your local workspace, and the [https://git.yoctoproject.org/meta-patchtest/tree/README.md meta-patchtest README] for details on automated/guest mode setup.		See the [https://git.yoctoproject.org/poky/tree/scripts/patchtest.README patchtest README] for instructions on how to use patchtest in your local workspace, and the [https://git.yoctoproject.org/meta-patchtest/tree/README.md meta-patchtest README] for details on automated/guest mode setup.
Line 34:		Line 34:

	The patchtest-send-results script checks the test results' maximum line length to help ensure that no unintended and/or malicious code is sent to the mailing list with the results. If this message is present, the user should re-test their patch(es) locally using the '''patchtest''' script in openembedded-core/scripts before further escalation. If the issue persists after re-testing and re-submission it should be reported as a [https://bugzilla.yoctoproject.org/enter_bug.cgi?product=Patchwork%2FPatchtest patchtest bug] with a "Major" priority (include the patch file as an attachment).		The patchtest-send-results script checks the test results' maximum line length to help ensure that no unintended and/or malicious code is sent to the mailing list with the results. If this message is present, the user should re-test their patch(es) locally using the '''patchtest''' script in openembedded-core/scripts before further escalation. If the issue persists after re-testing and re-submission it should be reported as a [https://bugzilla.yoctoproject.org/enter_bug.cgi?product=Patchwork%2FPatchtest patchtest bug] with a "Major" priority (include the patch file as an attachment).

			=== Submitting Bug Reports ===

			If you suspect there is an issue with the patchtest feedback emails, the service itself, or any of the documentation, please submit an issue on Bugzilla using the [https://bugzilla.yoctoproject.org/enter_bug.cgi?product=Patchwork%2FPatchtest patchtest] categories.

← Older revision		Revision as of 17:44, 6 November 2023
Line 42:		Line 42:

	{\| class="wikitable" style="margin:align-left"		{\| class="wikitable" style="margin:align-left"
	\|+ Test Details		\|+ Test Suite Details
	\|-		\|-
	! Test Name !! Category !! Uses Tinfoil !! Notes		! Test Name !! Category !! Uses Tinfoil !! Notes
Line 48:		Line 48:
	\| test_upstream_status_presence_format \|\| TestPatch \|\| No \|\|		\| test_upstream_status_presence_format \|\| TestPatch \|\| No \|\|
	\|-		\|-
	\| test_signed_off_by_presence \|\| TestPatch \|\| No \|\|		\| test_signed_off_by_presence \|\| TestPatch \|\| No \|\| Same test name as similar test in TestMbox
	\|-		\|-
	\| test_cve_tag_format \|\| TestPatch \|\| No \|\|		\| test_cve_tag_format \|\| TestPatch \|\| No \|\|
	\|-		\|-
	\| test_signed_off_by_presence \|\| TestMbox \|\| No \|\|		\| test_signed_off_by_presence \|\| TestMbox \|\| No \|\| Same test name as similar test in TestPatch
	\|-		\|-
	\| test_shortlog_format \|\| TestMbox \|\| No \|\|		\| test_shortlog_format \|\| TestMbox \|\| No \|\|
Line 58:		Line 58:
	\| test_shortlog_length \|\| TestMbox \|\| No \|\|		\| test_shortlog_length \|\| TestMbox \|\| No \|\|
	\|-		\|-
	\| test_series_merge_on_head \|\| TestMbox \|\| No \|\|		\| test_series_merge_on_head \|\| TestMbox \|\| No \|\| Temporarily disabled
	\|-		\|-
	\| test_target_mailing_list \|\| TestMbox \|\| No \|\|		\| test_target_mailing_list \|\| TestMbox \|\| No \|\|