Merge pull request #141 from woocommerce/24-03/hide-deprecated-options

Hide deprecated options (except on CI)
woocommerce · Mar 12, 2024 · de69fc8 · de69fc8
2 parents 3dd40fd + 4a4067e
commit de69fc8
Show file tree

Hide file tree

Showing 14 changed files with 100 additions and 42 deletions.
diff --git a/qit b/qit
diff --git a/src/src/Commands/CreateMassTestCommands.php b/src/src/Commands/CreateMassTestCommands.php
@@ -42,14 +42,20 @@ public function execute( InputInterface $input, OutputInterface $output ) {
 						->with_method( 'POST' )
 						->with_post_body( $options )
 						->request();
+
+					$json = json_decode( $json, true );
+					if ( is_array( $json ) && isset( $json['data'] ) ) {
+						$output->writeln( sprintf( '<info>Mass test enqueued on QIT Servers!</info>' ) );
+						$output->writeln( $json['data'] );
+					} else {
+						$output->writeln( sprintf( '<error>Could not enqueue mass test on QIT Servers.</error>' ) );
+					}
 				} catch ( \Exception $e ) {
 					$output->writeln( "<error>{$e->getMessage()}</error>" );
 
 					return Command::FAILURE;
 				}
 
-				$output->writeln( sprintf( '<info>Mass test enqueued on QIT Servers!</info>' ) );
-
 				return Command::SUCCESS;
 			}
 		};

diff --git a/src/src/Commands/DynamicCommandCreator.php b/src/src/Commands/DynamicCommandCreator.php
@@ -24,6 +24,12 @@ protected function add_schema_to_command( DynamicCommand $command, array $schema
 			foreach ( $schema['properties'] as $property_name => $property_schema ) {
 				$ignore = [ 'client', 'event', 'woo_id', 'is_product_update', 'upload_id' ];
 
+				// Keep these on CI to avoid breaking workflows, but remove from Desktop.
+				if ( ! getenv( 'CI' ) ) {
+					$ignore[] = 'additional_woo_plugins';
+					$ignore[] = 'additional_wordpress_plugins';
+				}
+
 				if ( in_array( $property_name, $ignore, true ) ) {
 					continue;
 				}

diff --git a/src/tests/RunTestsTest.php b/src/tests/RunTestsTest.php
@@ -1,6 +1,5 @@
 <?php
 
-
 use QIT_CLI\App;
 use QIT_CLI\Commands\CreateRunCommands;
 use Spatie\Snapshots\MatchesSnapshots;
@@ -20,7 +19,7 @@ public function setUp(): void {
 		} );
 	}
 
-	public function test_run_with_additional_woo_plugins() {
+	public function test_run_with_additional_plugins() {
 		App::setVar( sprintf( 'mock_%s', get_manager_url() . '/wp-json/cd/v1/enqueue-e2e' ), json_encode( [
 			'test_run_id'              => 123456,
 			'test_results_manager_url' => ''
@@ -29,7 +28,7 @@ public function test_run_with_additional_woo_plugins() {
 		$this->application_tester->run( [
 			'command'                  => 'run:e2e',
 			'woo_extension'            => 'foo-extension', // Using slug.
-			'--additional_woo_plugins' => '456,789', // Using IDs.
+			'--additional_plugins' => '456,789', // Using IDs.
 		], [ 'capture_stderr_separately' => true ] );
 
 		$this->assertCommandIsSuccessful( $this->application_tester );
@@ -38,7 +37,7 @@ public function test_run_with_additional_woo_plugins() {
 		$this->application_tester->run( [
 			'command'                  => 'run:e2e',
 			'woo_extension'            => '123', // Using ID.
-			'--additional_woo_plugins' => 'bar-extension,baz-extension', // Using Slugs.
+			'--additional_plugins' => 'bar-extension,baz-extension', // Using Slugs.
 		], [ 'capture_stderr_separately' => true ] );
 
 		$this->assertCommandIsSuccessful( $this->application_tester );
@@ -47,7 +46,7 @@ public function test_run_with_additional_woo_plugins() {
 		$this->application_tester->run( [
 			'command'                  => 'run:e2e',
 			'woo_extension'            => 'foo-extension', // Using ID.
-			'--additional_woo_plugins' => '456,baz-extension', // Using mixed.
+			'--additional_plugins' => '456,baz-extension', // Using mixed.
 		], [ 'capture_stderr_separately' => true ] );
 
 		$this->assertCommandIsSuccessful( $this->application_tester );
@@ -56,13 +55,13 @@ public function test_run_with_additional_woo_plugins() {
 		$this->application_tester->run( [
 			'command'                  => 'run:e2e',
 			'woo_extension'            => 'foo-extension',
-			'--additional_woo_plugins' => '1234567890', // If the user passes an invalid ID, the Manager should flag that.
+			'--additional_plugins' => '1234567890', // If the user passes an invalid ID, the Manager should flag that.
 		], [ 'capture_stderr_separately' => true ] );
 
 		$this->assertCommandIsSuccessful( $this->application_tester );
 	}
 
-	public function test_run_with_additional_woo_plugins_invalid() {
+	public function test_run_with_additional_plugins_invalid() {
 		App::setVar( sprintf( 'mock_%s', get_manager_url() . '/wp-json/cd/v1/enqueue-e2e' ), 'NULL_RESPONSE' );
 
 		$this->application_tester->run( [
@@ -71,21 +70,5 @@ public function test_run_with_additional_woo_plugins_invalid() {
 		], [ 'capture_stderr_separately' => true ] );
 
 		$this->assertStringContainsString('Could not find Woo Extension with slug non-existing-extension.', $this->application_tester->getErrorOutput() );
-
-		$this->application_tester->run( [
-			'command'                  => 'run:e2e',
-			'woo_extension'            => 'foo-extension',
-			'--additional_woo_plugins' => 'non-existing-dependency',
-		], [ 'capture_stderr_separately' => true ] );
-
-		$this->assertStringContainsString('Could not find Woo Extension with slug non-existing-dependency.', $this->application_tester->getErrorOutput() );
-
-		$this->application_tester->run( [
-			'command'                  => 'run:e2e',
-			'woo_extension'            => 'foo-extension',
-			'--additional_woo_plugins' => '1234567890, non-existing-dependency',
-		], [ 'capture_stderr_separately' => true ] );
-
-		$this->assertStringContainsString('Could not find Woo Extension with slug non-existing-dependency.', $this->application_tester->getErrorOutput() );
 	}
 }
diff --git a/src/tests/__snapshots__/PartnerManagementTest__test_add_partner__1.json b/src/tests/__snapshots__/PartnerManagementTest__test_add_partner__1.json
@@ -83,8 +83,17 @@
                             "description": "What event originated this request.",
                             "type": "string"
                         },
+                        "additional_plugins": {
+                            "description": "A comma-separated list of additional plugin to activate in the environment. Accepts: WordPress.org plugin slugs, Woo.com Product Slugs or Woo.com Product IDs.",
+                            "type": "array",
+                            "uniqueItems": true,
+                            "items": {
+                                "type": "integer",
+                                "minimum": 1
+                            }
+                        },
                         "additional_woo_plugins": {
-                            "description": "A comma-separated list of Additional WooCommerce Extension IDs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WooCommerce Extension IDs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {
@@ -93,7 +102,7 @@
                             }
                         },
                         "additional_wordpress_plugins": {
-                            "description": "A comma-separated list of Additional WordPress plugin slugs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WordPress plugin slugs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {

diff --git a/src/tests/__snapshots__/PartnerManagementTest__test_add_partner_email__1.json b/src/tests/__snapshots__/PartnerManagementTest__test_add_partner_email__1.json
@@ -83,8 +83,17 @@
                             "description": "What event originated this request.",
                             "type": "string"
                         },
+                        "additional_plugins": {
+                            "description": "A comma-separated list of additional plugin to activate in the environment. Accepts: WordPress.org plugin slugs, Woo.com Product Slugs or Woo.com Product IDs.",
+                            "type": "array",
+                            "uniqueItems": true,
+                            "items": {
+                                "type": "integer",
+                                "minimum": 1
+                            }
+                        },
                         "additional_woo_plugins": {
-                            "description": "A comma-separated list of Additional WooCommerce Extension IDs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WooCommerce Extension IDs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {
@@ -93,7 +102,7 @@
                             }
                         },
                         "additional_wordpress_plugins": {
-                            "description": "A comma-separated list of Additional WordPress plugin slugs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WordPress plugin slugs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {

diff --git a/src/tests/__snapshots__/PartnerManagementTest__test_switch_partner__1.json b/src/tests/__snapshots__/PartnerManagementTest__test_switch_partner__1.json
@@ -83,8 +83,17 @@
                             "description": "What event originated this request.",
                             "type": "string"
                         },
+                        "additional_plugins": {
+                            "description": "A comma-separated list of additional plugin to activate in the environment. Accepts: WordPress.org plugin slugs, Woo.com Product Slugs or Woo.com Product IDs.",
+                            "type": "array",
+                            "uniqueItems": true,
+                            "items": {
+                                "type": "integer",
+                                "minimum": 1
+                            }
+                        },
                         "additional_woo_plugins": {
-                            "description": "A comma-separated list of Additional WooCommerce Extension IDs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WooCommerce Extension IDs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {
@@ -93,7 +102,7 @@
                             }
                         },
                         "additional_wordpress_plugins": {
-                            "description": "A comma-separated list of Additional WordPress plugin slugs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WordPress plugin slugs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {

diff --git a/src/tests/__snapshots__/PartnerManagementTest__test_switch_partner__2.json b/src/tests/__snapshots__/PartnerManagementTest__test_switch_partner__2.json
@@ -83,8 +83,17 @@
                             "description": "What event originated this request.",
                             "type": "string"
                         },
+                        "additional_plugins": {
+                            "description": "A comma-separated list of additional plugin to activate in the environment. Accepts: WordPress.org plugin slugs, Woo.com Product Slugs or Woo.com Product IDs.",
+                            "type": "array",
+                            "uniqueItems": true,
+                            "items": {
+                                "type": "integer",
+                                "minimum": 1
+                            }
+                        },
                         "additional_woo_plugins": {
-                            "description": "A comma-separated list of Additional WooCommerce Extension IDs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WooCommerce Extension IDs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {
@@ -93,7 +102,7 @@
                             }
                         },
                         "additional_wordpress_plugins": {
-                            "description": "A comma-separated list of Additional WordPress plugin slugs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WordPress plugin slugs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {

diff --git a/..._snapshots__/PartnerManagementTest__test_switch_partner_on_different_environments__1.json b/..._snapshots__/PartnerManagementTest__test_switch_partner_on_different_environments__1.json
@@ -83,8 +83,17 @@
                             "description": "What event originated this request.",
                             "type": "string"
                         },
+                        "additional_plugins": {
+                            "description": "A comma-separated list of additional plugin to activate in the environment. Accepts: WordPress.org plugin slugs, Woo.com Product Slugs or Woo.com Product IDs.",
+                            "type": "array",
+                            "uniqueItems": true,
+                            "items": {
+                                "type": "integer",
+                                "minimum": 1
+                            }
+                        },
                         "additional_woo_plugins": {
-                            "description": "A comma-separated list of Additional WooCommerce Extension IDs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WooCommerce Extension IDs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {
@@ -93,7 +102,7 @@
                             }
                         },
                         "additional_wordpress_plugins": {
-                            "description": "A comma-separated list of Additional WordPress plugin slugs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WordPress plugin slugs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {

diff --git a/..._snapshots__/PartnerManagementTest__test_switch_partner_on_different_environments__2.json b/..._snapshots__/PartnerManagementTest__test_switch_partner_on_different_environments__2.json
@@ -83,8 +83,17 @@
                             "description": "What event originated this request.",
                             "type": "string"
                         },
+                        "additional_plugins": {
+                            "description": "A comma-separated list of additional plugin to activate in the environment. Accepts: WordPress.org plugin slugs, Woo.com Product Slugs or Woo.com Product IDs.",
+                            "type": "array",
+                            "uniqueItems": true,
+                            "items": {
+                                "type": "integer",
+                                "minimum": 1
+                            }
+                        },
                         "additional_woo_plugins": {
-                            "description": "A comma-separated list of Additional WooCommerce Extension IDs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WooCommerce Extension IDs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {
@@ -93,7 +102,7 @@
                             }
                         },
                         "additional_wordpress_plugins": {
-                            "description": "A comma-separated list of Additional WordPress plugin slugs.",
+                            "description": "[Deprecated] A comma-separated list of Additional WordPress plugin slugs.",
                             "type": "array",
                             "uniqueItems": true,
                             "items": {

diff --git a/...t_run_with_additional_woo_plugins__1.json → ..._test_run_with_additional_plugins__1.json b/...t_run_with_additional_woo_plugins__1.json → ..._test_run_with_additional_plugins__1.json
@@ -2,7 +2,7 @@
     "url": "https:\/\/qit.woo.com\/wp-json\/cd\/v1\/enqueue-e2e",
     "method": "POST",
     "post_body": {
-        "additional_woo_plugins": "456,789",
+        "additional_plugins": "456,789",
         "woo_id": 123,
         "event": "cli_published_extension_test"
     },

diff --git a/...t_run_with_additional_woo_plugins__2.json → ..._test_run_with_additional_plugins__2.json b/...t_run_with_additional_woo_plugins__2.json → ..._test_run_with_additional_plugins__2.json
@@ -2,7 +2,7 @@
     "url": "https:\/\/qit.woo.com\/wp-json\/cd\/v1\/enqueue-e2e",
     "method": "POST",
     "post_body": {
-        "additional_woo_plugins": "456,789",
+        "additional_plugins": "bar-extension,baz-extension",
         "woo_id": "123",
         "event": "cli_published_extension_test"
     },

diff --git a/...t_run_with_additional_woo_plugins__3.json → ..._test_run_with_additional_plugins__3.json b/...t_run_with_additional_woo_plugins__3.json → ..._test_run_with_additional_plugins__3.json
@@ -2,7 +2,7 @@
     "url": "https:\/\/qit.woo.com\/wp-json\/cd\/v1\/enqueue-e2e",
     "method": "POST",
     "post_body": {
-        "additional_woo_plugins": "456,789",
+        "additional_plugins": "456,baz-extension",
         "woo_id": 123,
         "event": "cli_published_extension_test"
     },

diff --git a/src/tests/data/sync.json b/src/tests/data/sync.json
@@ -68,8 +68,17 @@
           "description": "What event originated this request.",
           "type": "string"
         },
+        "additional_plugins": {
+          "description": "A comma-separated list of additional plugin to activate in the environment. Accepts: WordPress.org plugin slugs, Woo.com Product Slugs or Woo.com Product IDs.",
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "type": "integer",
+            "minimum": 1
+          }
+        },
         "additional_woo_plugins": {
-          "description": "A comma-separated list of Additional WooCommerce Extension IDs.",
+          "description": "[Deprecated] A comma-separated list of Additional WooCommerce Extension IDs.",
           "type": "array",
           "uniqueItems": true,
           "items": {
@@ -78,7 +87,7 @@
           }
         },
         "additional_wordpress_plugins": {
-          "description": "A comma-separated list of Additional WordPress plugin slugs.",
+          "description": "[Deprecated] A comma-separated list of Additional WordPress plugin slugs.",
           "type": "array",
           "uniqueItems": true,
           "items": {