From f72b8db576e76e1774fdd002e8ca864c0d027410 Mon Sep 17 00:00:00 2001
From: Christopher Allford <christopher.allford@automattic.com>
Date: Wed, 15 Jul 2020 14:29:13 -0700
Subject: [PATCH] Added some exceptions to the PHPCS standards for unit tests

The file comments and @throws tags are unnecessary in unit tests.
---
 phpcs.xml                                           | 10 +++++++++-
 .../includes/admin/helper/class-wc-helper-api.php   | 13 -------------
 .../includes/admin/helper/class-wc-helper-test.php  |  5 -----
 ...lass-wc-product-csv-importer-controller-test.php |  8 ++------
 tests/php/includes/class-wc-install-test.php        |  5 -----
 5 files changed, 11 insertions(+), 30 deletions(-)

diff --git a/phpcs.xml b/phpcs.xml
index 8075b9d8ccc..c2ac57afd5a 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -25,7 +25,7 @@
 	<arg name="parallel" value="8" />
 
 	<!-- Configs -->
-	<config name="minimum_supported_wp_version" value="5.0" />
+	<config name="minimum_supported_wp_version" value="5.2" />
 	<config name="testVersion" value="7.0-" />
 
 	<!-- Rules -->
@@ -61,4 +61,12 @@
 		<exclude-pattern>tests/php</exclude-pattern>
 		<exclude-pattern>tests/Tools/</exclude-pattern>
 	</rule>
+
+	<rule ref="Squiz.Commenting.FunctionCommentThrowTag.Missing">
+		<exclude-pattern>tests/php/</exclude-pattern>
+	</rule>
+
+	<rule ref="Squiz.Commenting.FileComment.Missing">
+		<exclude-pattern>tests/php/</exclude-pattern>
+	</rule>
 </ruleset>
diff --git a/tests/php/includes/admin/helper/class-wc-helper-api.php b/tests/php/includes/admin/helper/class-wc-helper-api.php
index d59711770a2..3b30727df22 100644
--- a/tests/php/includes/admin/helper/class-wc-helper-api.php
+++ b/tests/php/includes/admin/helper/class-wc-helper-api.php
@@ -1,9 +1,4 @@
 <?php
-/**
- * Class WC_Helper_API unit tests.
- *
- * @package WooCommerce\Tests\Importer
- */
 
 /**
  * Test class for WC_Helper_API.
@@ -22,8 +17,6 @@ class WC_Tests_Helper_API extends WC_Unit_Test_Case {
 
 	/**
 	 * Test that the url method returns the correct WooCommerce.com path.
-	 *
-	 * @return void
 	 */
 	public function test_api_url() {
 		$url = WC_Helper_API::url( '/test-path' );
@@ -32,8 +25,6 @@ class WC_Tests_Helper_API extends WC_Unit_Test_Case {
 
 	/**
 	 * Test a GET request through the WC_Helper_API.
-	 *
-	 * @return void
 	 */
 	public function test_get_request() {
 		$request = WC_Helper_API::get(
@@ -45,8 +36,6 @@ class WC_Tests_Helper_API extends WC_Unit_Test_Case {
 
 	/**
 	 * Test a POST request through the WC_Helper_API.
-	 *
-	 * @return void
 	 */
 	public function test_post_request() {
 		$request = WC_Helper_API::post(
@@ -58,8 +47,6 @@ class WC_Tests_Helper_API extends WC_Unit_Test_Case {
 
 	/**
 	 * Test a PUT request through the WC_Helper_API.
-	 *
-	 * @return void
 	 */
 	public function test_put_request() {
 		$request = WC_Helper_API::put(
diff --git a/tests/php/includes/admin/helper/class-wc-helper-test.php b/tests/php/includes/admin/helper/class-wc-helper-test.php
index e181f1e365e..7d591a49e60 100644
--- a/tests/php/includes/admin/helper/class-wc-helper-test.php
+++ b/tests/php/includes/admin/helper/class-wc-helper-test.php
@@ -1,9 +1,4 @@
 <?php
-/**
- * Class WC_Tests_WC_Helper file.
- *
- * @package WooCommerce|Tests|WC_Helper.
- */
 
 /**
  * Class WC_Tests_WC_Helper.
diff --git a/tests/php/includes/admin/importers/class-wc-product-csv-importer-controller-test.php b/tests/php/includes/admin/importers/class-wc-product-csv-importer-controller-test.php
index af046f38931..e59ef1b1196 100644
--- a/tests/php/includes/admin/importers/class-wc-product-csv-importer-controller-test.php
+++ b/tests/php/includes/admin/importers/class-wc-product-csv-importer-controller-test.php
@@ -1,13 +1,9 @@
 <?php
-/**
- * Class WC_Product_CSV_Importer_Controller_Test
- * @package WooCommerce\Tests\Admin
- *
- * Tests to ensure that the CSV product importer works as expected.
- */
 
 /**
  * Class WC_Product_CSV_Importer_Controller_Test
+ *
+ * Tests to ensure that the CSV product importer works as expected.
  */
 class WC_Product_CSV_Importer_Controller_Test extends WC_Unit_Test_Case {
 
diff --git a/tests/php/includes/class-wc-install-test.php b/tests/php/includes/class-wc-install-test.php
index 5c96de68d1f..a2ec3899ec6 100644
--- a/tests/php/includes/class-wc-install-test.php
+++ b/tests/php/includes/class-wc-install-test.php
@@ -1,9 +1,4 @@
 <?php
-/**
- * Class WCInstallTest file.
- *
- * @package WooCommerce|Tests|WCInstallTest.
- */
 
 /**
  * Class WC_Install_Test.