Errors management

Steps

---

The management of errors on StartLeft is handled on four separated steps:

1. Provider selection.
2. Source file processing.
3. Mapping file processing.
4. OTM generation.

Error types

---

Step 1:

• Provider error: Provider resolver could not find a provider for the given type.
  • ProviderNotFoundError.

Step 2:

• Validation error: The file is not valid due to wrong mime type, maxsize, etc.

  • IacNotValidFileError.
  • DiagramNotValidFileError.
  • SourceFileNotValidError.

• Loading error: We are unable to load the file due to the wrong type being specified or any error inside the file that does not permit loading its content.

  • LoadingIacFileError.
  • LoadingDiagramFileError.
  • LoadingSourceFileError.

Step 3:

• Validation error: The file is not valid due to wrong mime type, maxsize, etc.
  • MappingFileNotValidError.
• Loading error: We are unable to load the file due to the wrong type being specified or any error inside the file that does not permit loading its content.
  • LoadingMappingFileError.

Step 4:

• OTM generation related errors:
  • OTMBuildingError. We are unable to generate the OTM with the given files.
  • OTMResultError. We are able to generate the OTM but the OTM is invalid (e.g: inconsistent IDs).
  • OTMGenerationError. There was any unexpected error.

HTTP statuses and exit codes

---

Error code	HTTP Status	CLI exit code
LoadingIacFileError	400	1
IacFileNotValidError	400	2
LoadingDiagramFileError	400	11
DiagramNotValidFileError	400	12
LoadingSourceFileError	400	51
SourceFileNotValidError	400	52
LoadingMappingFileError	400	21
MappingFileNotValidError	400	22
OTMBuildingError	400	41
OTMResultError	400	42
OTMGenerationError	500	45
ProviderNotFoundError	400	60

HTTP response body

---

The response body on any of this cases will be a JSON with this structure:

{
    "status": "the numeric http status code",
    "error_type": "<The error type>",
    "title": "<The error on human readable form>",
    "detail": "<The detail of the error>",
    "errors": [
        {
            "errorMessage": "<The reason of the error>"
        }
    ]
}

When calling StartLeft through IriusRisk, the most important field here is error_type because it is the code that the IriusRisk core is going to read to match the error type, manage the StartLeft error response and send its own response on the core API.