def test_parse_extension_status01(self):
"""
Parse a status report for a failed execution of an extension.
The extension returned a bad status/status of failed.
The agent should handle this gracefully, and convert all unknown
status/status values into an error.
"""
s = '''[{
"status": {
"status": "failed",
"formattedMessage": {
"lang": "en-US",
"message": "Enable failed: Failed with error: commandToExecute is empty or invalid ..."
},
"operation": "Enable",
"code": "0",
"name": "Microsoft.OSTCExtensions.CustomScriptForLinux"
},
"version": "1.0",
"timestampUTC": "2018-04-20T20:50:22Z"
}]'''
ext_status = ExtensionStatus(seq_no=0)
parse_ext_status(ext_status, json.loads(s))
self.assertEqual('0', ext_status.code)
self.assertEqual(None, ext_status.configurationAppliedTime)
self.assertEqual(
'Enable failed: Failed with error: commandToExecute is empty or invalid ...',
ext_status.message)
self.assertEqual('Enable', ext_status.operation)
self.assertEqual('error', ext_status.status)
self.assertEqual(0, ext_status.sequenceNumber)
self.assertEqual(0, len(ext_status.substatusList))
def test_parse_ext_status_should_parse_missing_substatus_as_empty(self):
status = '''[{
"status": {
"status": "success",
"formattedMessage": {
"lang": "en-US",
"message": "Command is finished."
},
"operation": "Enable",
"code": "0",
"name": "Microsoft.OSTCExtensions.CustomScriptForLinux"
},
"version": "1.0",
"timestampUTC": "2018-04-20T21:20:24Z"
}
]'''
extension_status = ExtensionStatus(seq_no=0)
parse_ext_status(extension_status, json.loads(status))
self.assertTrue(isinstance(extension_status.substatusList, list),
'substatus was not parsed correctly')
self.assertEqual(0, len(extension_status.substatusList))
def test_parse_extension_status00(self):
"""
Parse a status report for a successful execution of an extension.
"""
s = '''[{
"status": {
"status": "success",
"formattedMessage": {
"lang": "en-US",
"message": "Command is finished."
},
"operation": "Daemon",
"code": "0",
"name": "Microsoft.OSTCExtensions.CustomScriptForLinux"
},
"version": "1.0",
"timestampUTC": "2018-04-20T21:20:24Z"
}
]'''
ext_status = ExtensionStatus(seq_no=0)
parse_ext_status(ext_status, json.loads(s))
self.assertEqual('0', ext_status.code)
self.assertEqual(None, ext_status.configurationAppliedTime)
self.assertEqual('Command is finished.', ext_status.message)
self.assertEqual('Daemon', ext_status.operation)
self.assertEqual('success', ext_status.status)
self.assertEqual(0, ext_status.sequenceNumber)
self.assertEqual(0, len(ext_status.substatusList))
def test_parse_extension_status01(self):
"""
Parse a status report for a failed execution of an extension.
The extension returned a bad status/status of failed.
The agent should handle this gracefully, and convert all unknown
status/status values into an error.
"""
s = '''[{
"status": {
"status": "failed",
"formattedMessage": {
"lang": "en-US",
"message": "Enable failed: Failed with error: commandToExecute is empty or invalid ..."
},
"operation": "Enable",
"code": "0",
"name": "Microsoft.OSTCExtensions.CustomScriptForLinux"
},
"version": "1.0",
"timestampUTC": "2018-04-20T20:50:22Z"
}]'''
ext_status = ExtensionStatus(seq_no=0)
parse_ext_status(ext_status, json.loads(s))
self.assertEqual('0', ext_status.code)
self.assertEqual(None, ext_status.configurationAppliedTime)
self.assertEqual('Enable failed: Failed with error: commandToExecute is empty or invalid ...', ext_status.message)
self.assertEqual('Enable', ext_status.operation)
self.assertEqual('error', ext_status.status)
self.assertEqual(0, ext_status.sequenceNumber)
self.assertEqual(0, len(ext_status.substatusList))
def test_parse_extension_status00(self):
"""
Parse a status report for a successful execution of an extension.
"""
s = '''[{
"status": {
"status": "success",
"formattedMessage": {
"lang": "en-US",
"message": "Command is finished."
},
"operation": "Daemon",
"code": "0",
"name": "Microsoft.OSTCExtensions.CustomScriptForLinux"
},
"version": "1.0",
"timestampUTC": "2018-04-20T21:20:24Z"
}
]'''
ext_status = ExtensionStatus(seq_no=0)
parse_ext_status(ext_status, json.loads(s))
self.assertEqual('0', ext_status.code)
self.assertEqual(None, ext_status.configurationAppliedTime)
self.assertEqual('Command is finished.', ext_status.message)
self.assertEqual('Daemon', ext_status.operation)
self.assertEqual('success', ext_status.status)
self.assertEqual(0, ext_status.sequenceNumber)
self.assertEqual(0, len(ext_status.substatusList))
def test_parse_ext_status_should_parse_null_substatus_as_empty(self):
status = '''[{
"status": {
"status": "success",
"formattedMessage": {
"lang": "en-US",
"message": "Command is finished."
},
"operation": "Enable",
"code": "0",
"name": "Microsoft.OSTCExtensions.CustomScriptForLinux",
"substatus": null
},
"version": "1.0",
"timestampUTC": "2018-04-20T21:20:24Z"
}
]'''
extension_status = ExtensionStatus(seq_no=0)
parse_ext_status(extension_status, json.loads(status))
self.assertTrue(isinstance(extension_status.substatusList, list), 'substatus was not parsed correctly')
self.assertEqual(0, len(extension_status.substatusList))
def test_parse_extension_status_with_empty_status(self):
"""
Parse a status report for a successful execution of an extension.
"""
# Validating empty status case
s = '''[]'''
ext_status = ExtensionStatus(seq_no=0)
parse_ext_status(ext_status, json.loads(s))
self.assertEqual(None, ext_status.code)
self.assertEqual(None, ext_status.configurationAppliedTime)
self.assertEqual(None, ext_status.message)
self.assertEqual(None, ext_status.operation)
self.assertEqual(None, ext_status.status)
self.assertEqual(0, ext_status.sequenceNumber)
self.assertEqual(0, len(ext_status.substatusList))
# Validating None case
ext_status = ExtensionStatus(seq_no=0)
parse_ext_status(ext_status, None)
self.assertEqual(None, ext_status.code)
self.assertEqual(None, ext_status.configurationAppliedTime)
self.assertEqual(None, ext_status.message)
self.assertEqual(None, ext_status.operation)
self.assertEqual(None, ext_status.status)
self.assertEqual(0, ext_status.sequenceNumber)
self.assertEqual(0, len(ext_status.substatusList))
def test_parse_ext_status_should_raise_on_non_array(self):
status = json.loads('''
{{
"status": {{
"status": "transitioning",
"operation": "Enabling Handler",
"code": 0,
"name": "Microsoft.Azure.RecoveryServices.SiteRecovery.Linux"
}},
"version": 1.0,
"timestampUTC": "2020-01-14T15:04:43Z",
"longText": "{0}"
}}'''.format("*" * 5 * 1024))
with self.assertRaises(ExtensionStatusError) as context_manager:
parse_ext_status(ExtensionStatus(seq_no=0), status)
error_message = str(context_manager.exception)
self.assertIn("The extension status must be an array", error_message)
self.assertTrue(0 < len(error_message) - 64 < 4096, "The error message should not be much longer than 4K characters: [{0}]".format(error_message))
