From 13cffabdb24895def8e1942a8892f78a26daa256 Mon Sep 17 00:00:00 2001
From: Orion Poplawski <orion@nwra.com>
Date: Wed, 3 Jan 2024 17:37:06 -0700
Subject: [PATCH] [pfsense_openvpn_server] Add test for `generate`

---
 .../modules/test_pfsense_openvpn_server.py    | 29 +++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/tests/unit/plugins/modules/test_pfsense_openvpn_server.py b/tests/unit/plugins/modules/test_pfsense_openvpn_server.py
index 7f9431b9..4c92060e 100644
--- a/tests/unit/plugins/modules/test_pfsense_openvpn_server.py
+++ b/tests/unit/plugins/modules/test_pfsense_openvpn_server.py
@@ -4,6 +4,7 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
+import base64
 import pytest
 import sys
 
@@ -12,6 +13,7 @@
 
 from ansible_collections.pfsensible.core.plugins.modules import pfsense_openvpn_server
 from .pfsense_module import TestPFSenseModule
+from ansible_collections.community.internal_test_tools.tests.unit.compat.mock import patch
 
 CERTIFICATE = (
     "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tDQpNSUlFQ0RDQ0F2Q2dBd0lCQWdJSUZqRk9oczFuTXpRd0RRWUpLb1pJaHZjTkFRRUxCUUF3WERFVE1CRUdBMVVFDQpBeE1LYjNCbGJuWndiaTFqWVRF"
@@ -47,6 +49,21 @@ def __init__(self, *args, **kwargs):
         self.config_file = 'pfsense_openvpn_config.xml'
         self.pfmodule = pfsense_openvpn_server.PFSenseOpenVPNServerModule
 
+    def setUp(self):
+        """ mocking up """
+
+        super(TestPFSenseOpenVPNServerModule, self).setUp()
+
+        self.mock_run_command = patch('ansible.module_utils.basic.AnsibleModule.run_command')
+        self.run_command = self.mock_run_command.start()
+        self.run_command.return_value = (0, base64.b64decode(TLSKEY.encode()).decode(), '')
+
+    def tearDown(self):
+        """ mocking down """
+        super(TestPFSenseOpenVPNServerModule, self).tearDown()
+
+        self.run_command.stop()
+
     @staticmethod
     def runTest():
         """ dummy function needed to instantiate this test module from another in python 2.7 """
@@ -87,6 +104,12 @@ def certref(descr):
     def check_target_elt(self, obj, target_elt):
         """ check XML definition of target elt """
 
+        # Use "generated" key
+        if 'shared_key' in obj and obj['shared_key'] == 'generate':
+            obj['shared_key'] = TLSKEY
+        if 'tls' in obj and obj['tls'] == 'generate':
+            obj['tls'] = TLSKEY
+
         self.check_param_equal(obj, target_elt, 'name', xml_field='description')
         self.check_param_equal(obj, target_elt, 'custom_options')
         self.check_param_equal(obj, target_elt, 'mode', default='ptp_tls')
@@ -100,6 +123,7 @@ def check_target_elt(self, obj, target_elt):
         self.check_param_equal(obj, target_elt, 'local_port', default=1194)
         self.check_param_equal(obj, target_elt, 'protocol', default='UDP4')
         if 'tls' in obj['mode']:
+            self.check_param_equal(obj, target_elt, 'tls')
             self.check_param_equal(obj, target_elt, 'tls')
             self.check_param_equal(obj, target_elt, 'tls_type')
             self.assert_xml_elt_equal(target_elt, 'caref', self.caref(obj['ca']))
@@ -141,6 +165,11 @@ def test_openvpn_server_create(self):
         obj = dict(name='ovpns3', mode='p2p_tls', ca='OpenVPN CA', local_port=1196)
         self.do_module_test(obj, command="create openvpn_server 'ovpns3', description='ovpns3'")
 
+    def test_openvpn_server_create_generate(self):
+        """ test creation of a new OpenVPN server """
+        obj = dict(name='ovpns3', mode='p2p_tls', ca='OpenVPN CA', local_port=1196, tls='generate')
+        self.do_module_test(obj, command="create openvpn_server 'ovpns3', description='ovpns3'")
+
     def test_openvpn_server_delete(self):
         """ test deletion of a OpenVPN server """
         obj = dict(name='ovpns2')