fixed self test parameter mismatch and included basic test

Author: vnktshr21

generated/nirfsg/nirfsg/_library_interpreter.py

@@ -625,13 +625,13 @@ def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_
         errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
         return
 
-    def self_test(self, self_test_message):  # noqa: N802
+    def self_test(self):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110
         self_test_result_ctype = _visatype.ViInt16()  # case S220
-        self_test_message_ctype = ctypes.create_string_buffer(self_test_message.encode(self._encoding))  # case C020
+        self_test_message_ctype = (_visatype.ViChar * 256)()  # case C070
         error_code = self._library.niRFSG_SelfTest(vi_ctype, None if self_test_result_ctype is None else (ctypes.pointer(self_test_result_ctype)), self_test_message_ctype)
         errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
-        return int(self_test_result_ctype.value)
+        return int(self_test_result_ctype.value), self_test_message_ctype.value.decode(self._encoding)
 
     def send_software_edge_trigger(self, trigger, trigger_identifier):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110

generated/nirfsg/nirfsg/session.py

@@ -7088,7 +7088,7 @@ def self_calibrate_range(self, steps_to_omit, min_frequency, max_frequency, min_
         self._interpreter.self_calibrate_range(steps_to_omit, min_frequency, max_frequency, min_power_level, max_power_level)
 
     @ivi_synchronized
-    def _self_test(self, self_test_message):
+    def _self_test(self):
         r'''_self_test
 
         Performs a self-test on the NI-RFSG device and returns the test results.
@@ -7103,12 +7103,6 @@ def _self_test(self, self_test_message):
 
         `Device Warm-Up <https://www.ni.com/docs/en-US/bundle/rfsg/page/rfsg/warmup.html>`_
 
-        Args:
-            self_test_message (str): Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this method.
-
-                You must pass a ViChar array with at least 256 bytes.
-
-
         Returns:
             self_test_result (int): This parameter contains the value returned from the NI-RFSG device self test.
 
@@ -7120,9 +7114,13 @@ def _self_test(self, self_test_message):
                 | 1              | Self test failed |
                 +----------------+------------------+
 
+            self_test_message (str): Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this method.
+
+                You must pass a ViChar array with at least 256 bytes.
+
         '''
-        self_test_result = self._interpreter.self_test(self_test_message)
-        return self_test_result
+        self_test_result, self_test_message = self._interpreter.self_test()
+        return self_test_result, self_test_message
 
     @ivi_synchronized
     def set_arb_waveform_next_write_position(self, waveform_name, relative_to, offset):

generated/nirfsg/nirfsg/unit_tests/_mock_helper.py

@@ -187,6 +187,7 @@ def __init__(self):
         self._defaults['SelfTest'] = {}
         self._defaults['SelfTest']['return'] = 0
         self._defaults['SelfTest']['selfTestResult'] = None
+        self._defaults['SelfTest']['selfTestMessage'] = None
         self._defaults['SendSoftwareEdgeTrigger'] = {}
         self._defaults['SendSoftwareEdgeTrigger']['return'] = 0
         self._defaults['SetArbWaveformNextWritePosition'] = {}
@@ -805,6 +806,15 @@ def niRFSG_SelfTest(self, vi, self_test_result, self_test_message):  # noqa: N80
             raise MockFunctionCallError("niRFSG_SelfTest", param='selfTestResult')
         if self_test_result is not None:
             self_test_result.contents.value = self._defaults['SelfTest']['selfTestResult']
+        # self_test_message
+        if self._defaults['SelfTest']['selfTestMessage'] is None:
+            raise MockFunctionCallError("niRFSG_SelfTest", param='selfTestMessage')
+        test_value = self._defaults['SelfTest']['selfTestMessage']
+        if type(test_value) is str:
+            test_value = test_value.encode('ascii')
+        assert len(self_test_message) >= len(test_value)
+        for i in range(len(test_value)):
+            self_test_message[i] = test_value[i]
         return self._defaults['SelfTest']['return']
 
     def niRFSG_SendSoftwareEdgeTrigger(self, vi, trigger, trigger_identifier):  # noqa: N802

src/nirfsg/metadata/functions.py

@@ -3740,7 +3740,7 @@
                 'type': 'ViInt16'
             },
             {
-                'direction': 'in',
+                'direction': 'out',
                 'documentation': {
                     'description': 'Returns the self-test response string from the NI-RFSG device. For an explanation of the string contents, refer to the **status** parameter of this function.\n\nYou must pass a ViChar array with at least 256 bytes.'
                 },

src/nirfsg/system_tests/test_system_nirfsg.py

@@ -118,6 +118,10 @@ def test_reset_with_options(self, rfsg_device_session):
         waveform_exists = rfsg_device_session.check_if_waveform_exists('mywaveform')
         assert waveform_exists is False
 
+    def test_self_test(self, rfsg_device_session):
+        # We should not get an assert if self_test passes
+        rfsg_device_session.self_test()
+
     @pytest.mark.skipif(use_simulated_session is False, reason="Takes long time in real device")
     def test_self_cal(self, rfsg_device_session):
         rfsg_device_session.self_cal()