style: run prettier on changed files

Author: jaredhendrickson13

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APIModelsOpenVPNClientExportTestCase.inc

@@ -12,8 +12,7 @@ use RESTAPI\Models\OpenVPNClientExportConfig;
 use RESTAPI\Models\OpenVPNServer;
 use RESTAPI\Models\User;
 
-class APIModelsOpenVPNClientExportTestCase extends TestCase
-{
+class APIModelsOpenVPNClientExportTestCase extends TestCase {
     private CertificateAuthority $server_ca;
     private CertificateGenerate $server_cert;
     private CertificateGenerate $user_cert;
@@ -27,8 +26,7 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
     /**
      * Setup the test environment before starting tests.
      */
-    public function setup(): void
-    {
+    public function setup(): void {
         # Create a CA we can test with
         $this->server_ca = new CertificateAuthority(
             descr: 'test_ca',
@@ -62,7 +60,7 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
         $this->user_cert->create();
 
         # Create a user we can use for testing
-        $this->user = new User(name: "ovpntest", password: "ovpntest", cert: [$this->user_cert->refid->value]);
+        $this->user = new User(name: 'ovpntest', password: 'ovpntest', cert: [$this->user_cert->refid->value]);
         $this->user->create();
 
         # Create a remote auth server to use for testing
@@ -108,8 +106,7 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
     /**
      * Remove the CA and cert used for testing after tests complete.
      */
-    public function teardown(): void
-    {
+    public function teardown(): void {
         $this->user->delete();
         $this->authserver->delete();
         $this->ovpns->delete(apply: true);
@@ -121,58 +118,55 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
     /**
      * Ensure the 'certref' field is required for OpenVPNServers using the 'server_tls' mode
      */
-    public function test_certref_required_for_server_tls(): void
-    {
+    public function test_certref_required_for_server_tls(): void {
         # Ensure the server_tls server mode requires a certref for export
         $this->assert_throws_response(
-            response_id: "OPENVPN_CLIENT_EXPORT_CERTREF_REQUIRED",
+            response_id: 'OPENVPN_CLIENT_EXPORT_CERTREF_REQUIRED',
             code: 400,
             callable: function () {
                 # Update the OpenVPNServer mode
-                $this->ovpns->mode->value = "server_tls";
+                $this->ovpns->mode->value = 'server_tls';
                 $this->ovpns->update();
 
                 # Ensure the validate_server method throws an error for no certref
                 $export = new OpenVPNClientExport(id: $this->ovpnce->id);
                 $export->certref->value = null;
                 $export->validate_server($this->ovpns->vpnid->value);
-            }
+            },
         );
     }
 
     /**
      * Ensure the 'certref' field is required for OpenVPNServers using the 'server_tls_user' mode
      */
-    public function test_certref_required_for_server_tls_user(): void
-    {
+    public function test_certref_required_for_server_tls_user(): void {
         # Ensure the server_tls_user server mode requires a certref for export
         $this->assert_throws_response(
-            response_id: "OPENVPN_CLIENT_EXPORT_CERTREF_REQUIRED",
+            response_id: 'OPENVPN_CLIENT_EXPORT_CERTREF_REQUIRED',
             code: 400,
             callable: function () {
                 # Update the OpenVPNServer mode
-                $this->ovpns->mode->value = "server_tls_user";
+                $this->ovpns->mode->value = 'server_tls_user';
                 $this->ovpns->authmode->value = $this->ovpns->authmode->default;
                 $this->ovpns->update();
 
                 # Ensure the validate_server method throws an error for no certref
                 $export = new OpenVPNClientExport(id: $this->ovpnce->id);
                 $export->certref->value = null;
                 $export->validate_server($this->ovpns->vpnid->value);
-            }
+            },
         );
     }
 
     /**
      * Ensure the 'certref' field is not required for OpenVPNServers using the 'server_user' mode
      */
-    public function test_certref_not_required_for_server_user(): void
-    {
+    public function test_certref_not_required_for_server_user(): void {
         # Ensure the server_user server mode does not require a certref for export
         $this->assert_does_not_throw(
             callable: function () {
                 # Update the OpenVPNServer mode
-                $this->ovpns->mode->value = "server_user";
+                $this->ovpns->mode->value = 'server_user';
                 $this->ovpns->authmode->value = $this->ovpns->authmode->default;
                 $this->ovpns->update();
 
@@ -181,163 +175,149 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
                 $export->certref->value = null;
                 $export->username->value = $this->user->name->value; # username is required for server_user mode
                 $export->validate_server($this->ovpns->vpnid->value);
-            }
+            },
         );
     }
 
     /**
      * Ensure the username field is required for OpenVPN servers using the 'Local Database' authmode
      */
-    public function test_username_required_for_local_database_authmode(): void
-    {
+    public function test_username_required_for_local_database_authmode(): void {
         # Ensure a username is required when using the local database authmode
         $this->assert_throws_response(
-            response_id: "OPENVPN_CLIENT_EXPORT_USERNAME_REQUIRED",
+            response_id: 'OPENVPN_CLIENT_EXPORT_USERNAME_REQUIRED',
             code: 400,
             callable: function () {
                 # Update the OpenVPNServer mode
-                $this->ovpns->mode->value = "server_tls_user";
+                $this->ovpns->mode->value = 'server_tls_user';
                 $this->ovpns->authmode->value = $this->ovpns->authmode->default;
                 $this->ovpns->update();
 
                 # Ensure the validate_server method throws an error for no certref
                 $export = new OpenVPNClientExport(id: $this->ovpnce->id, certref: $this->user_cert->refid->value);
                 $export->username->value = null;
                 $export->validate_server($this->ovpns->vpnid->value);
-            }
+            },
         );
     }
 
     /**
      * Ensure the username field is not required for OpenVPN servers using a remote authmode
      */
-    public function test_username_not_required_for_remote_authmode(): void
-    {
+    public function test_username_not_required_for_remote_authmode(): void {
         # Ensure a username is not required when using a remote authmode
         $this->assert_does_not_throw(
             callable: function () {
                 # Update the OpenVPNServer mode
-                $this->ovpns->mode->value = "server_tls_user";
+                $this->ovpns->mode->value = 'server_tls_user';
                 $this->ovpns->authmode->value = [$this->authserver->name->value];
                 $this->ovpns->update();
 
                 # Ensure the validate_server method does not throw an error for no username
                 $export = new OpenVPNClientExport(id: $this->ovpnce->id, certref: $this->user_cert->refid->value);
                 $export->username->value = null;
                 $export->validate_server($this->ovpns->vpnid->value);
-            }
+            },
         );
     }
 
     /**
      * Ensure an error is thrown when 'usetoken' is enabled with a forbidden export 'type'
      */
-    public function test_usetoken_forbidden_types(): void
-    {
+    public function test_usetoken_forbidden_types(): void {
         foreach (OpenVPNClientExport::USETOKEN_FORBIDDEN_TYPES as $forbidden_type) {
             $this->assert_throws_response(
-                response_id: "OPENVPN_CLIENT_EXPORT_TYPE_USETOKEN_NOT_ALLOWED",
+                response_id: 'OPENVPN_CLIENT_EXPORT_TYPE_USETOKEN_NOT_ALLOWED',
                 code: 409,
                 callable: function () use ($forbidden_type) {
                     # Create a new OpenVPNClientExport with 'usetoken' enabled and a forbidden export 'type'
                     $export = new OpenVPNClientExport(usetoken: true);
                     $export->validate_type($forbidden_type);
-                }
+                },
             );
         }
     }
 
     /**
      * Ensure no error is thrown when 'usetoken' is disabled, and a usetoken forbidden type is used.
      */
-    public function test_usetoken_forbidden_types_disabled(): void
-    {
+    public function test_usetoken_forbidden_types_disabled(): void {
         foreach (OpenVPNClientExport::USETOKEN_FORBIDDEN_TYPES as $forbidden_type) {
             $this->assert_does_not_throw(
                 callable: function () use ($forbidden_type) {
                     # Create a new OpenVPNClientExport with 'usetoken' disabled and a forbidden export 'type'
                     $export = new OpenVPNClientExport(usetoken: false);
                     $export->validate_type($forbidden_type);
-                }
+                },
             );
         }
     }
 
     /**
      * Ensure no error is thrown when 'usetoken' is enabled, and a non usetoken forbidden type is used.
      */
-    public function test_usetoken_non_forbidden_types(): void
-    {
+    public function test_usetoken_non_forbidden_types(): void {
         $this->assert_does_not_throw(
             callable: function () {
                 # Create a new OpenVPNClientExport with 'usetoken' enabled and a non forbidden export 'type'
                 $export = new OpenVPNClientExport(usetoken: true);
-                $export->validate_type("inst-Win10");
-            }
+                $export->validate_type('inst-Win10');
+            },
         );
     }
 
     /**
      * Ensure the certref validation for user certs is skipped if there is no username specified.
      */
-    public function test_certref_validation_skipped_for_user_certs_without_username(): void
-    {
+    public function test_certref_validation_skipped_for_user_certs_without_username(): void {
         # Create a new OpenVPNClientExport with a user cert and no username
         $export = new OpenVPNClientExport();
         $export->username->value = null;
-        $this->assert_equals($export->validate_certref("anything"), "anything");
-        $this->assert_equals(
-            $export->validate_certref($this->user_cert->refid->value),
-            $this->user_cert->refid->value
-        );
+        $this->assert_equals($export->validate_certref('anything'), 'anything');
+        $this->assert_equals($export->validate_certref($this->user_cert->refid->value), $this->user_cert->refid->value);
     }
 
     /**
      * Ensure an error is thrown if the provided certref is not assigned to the provided user.
      */
-    public function test_certref_validation_user_cert_not_assigned_to_user(): void
-    {
+    public function test_certref_validation_user_cert_not_assigned_to_user(): void {
         # Ensure an error is thrown if the certref is not assigned to the user
         $this->assert_throws_response(
-            response_id: "OPENVPN_CLIENT_EXPORT_USER_CERT_NOT_FOUND",
+            response_id: 'OPENVPN_CLIENT_EXPORT_USER_CERT_NOT_FOUND',
             code: 404,
             callable: function () {
                 # Create a new OpenVPNClientExport with a user cert and a username
                 $export = new OpenVPNClientExport(username: $this->user->name->value);
 
                 # Try to use the server cert (which isn't assigned to the user), this should throw an error
                 $export->validate_certref($this->server_cert->refid->value);
-            }
+            },
         );
     }
 
     /**
      * Ensure an error is thrown if the requested user cert does not have a private key
      * and usepkcs11 or usetoken is not used
      */
-    public function test_certref_validation_user_cert_no_private_key(): void
-    {
+    public function test_certref_validation_user_cert_no_private_key(): void {
         # Temporarily unset the prv value for the user cert
-        Certificate::set_config(
-            "{$this->user_cert->get_config_path()}/prv",
-            null
-        );
+        Certificate::set_config("{$this->user_cert->get_config_path()}/prv", null);
 
         # Ensure an error is thrown if the user cert does not have a private key
         $this->assert_throws_response(
-            response_id: "OPENVPN_CLIENT_EXPORT_CERT_NO_PRIVATE_KEY",
+            response_id: 'OPENVPN_CLIENT_EXPORT_CERT_NO_PRIVATE_KEY',
             code: 400,
             callable: function () {
                 # Create a new OpenVPNClientExport with a user cert and a username
                 $export = new OpenVPNClientExport(
                     username: $this->user->name->value,
                     usepkcs11: false,
-                    usetoken: false
+                    usetoken: false,
                 );
 
                 # Ensure the validate_certref method throws an error for no private key
                 $export->validate_certref($this->user_cert->refid->value);
-            }
+            },
         );
     }
 
@@ -347,9 +327,9 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
     public function test_export_config_inline(): void {
         $exporter = new OpenVPNClientExport(
             id: $this->ovpnce->id,
-            type: "confinline",
+            type: 'confinline',
             username: $this->user->name->value,
-            certref: $this->user_cert->refid->value
+            certref: $this->user_cert->refid->value,
         );
 
         $config = $exporter->export_config();
@@ -366,9 +346,9 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
     public function test_export_config_zip(): void {
         $exporter = new OpenVPNClientExport(
             id: $this->ovpnce->id,
-            type: "confzip",
+            type: 'confzip',
             username: $this->user->name->value,
-            certref: $this->user_cert->refid->value
+            certref: $this->user_cert->refid->value,
         );
         $filepath = $exporter->export_config();
 
@@ -384,9 +364,9 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
     public function test_export_installer(): void {
         $exporter = new OpenVPNClientExport(
             id: $this->ovpnce->id,
-            type: "inst-Win10",
+            type: 'inst-Win10',
             username: $this->user->name->value,
-            certref: $this->user_cert->refid->value
+            certref: $this->user_cert->refid->value,
         );
         $filepath = $exporter->export_installer();
 
@@ -402,9 +382,9 @@ class APIModelsOpenVPNClientExportTestCase extends TestCase
     public function test_export_viscosity(): void {
         $exporter = new OpenVPNClientExport(
             id: $this->ovpnce->id,
-            type: "visc",
+            type: 'visc',
             username: $this->user->name->value,
-            certref: $this->user_cert->refid->value
+            certref: $this->user_cert->refid->value,
         );
         $filepath = $exporter->export_installer();