[PCAPI] Fix DescribeClusterResponse by replacing the field 'failureReason' with 'failures' and importing CloudFormationResourceStatus in modules init.

Signed-off-by: Giacomo Marciani <mgiacomo@amazon.com>

Author: gmarciani

CHANGELOG.md

@@ -17,6 +17,7 @@ CHANGELOG
 - Allow ParallelCluster Custom Resource to suppress validators using `PclusterCluster/SuppressValidators`.
 - Removing `/etc/profile.d/pcluster.sh` so that it's not executed at every user login and
   `cfn_bootstrap_virtualenv` is not added in PATH environment variable.
+- Fix ParallelCluster API spec by replacing in `DescribeCluster` response the field `failureReason` with `failures`.
 
 **CHANGES**
 - CentOS 7 is no longer supported.

cli/src/pcluster/api/models/__init__.py

@@ -20,6 +20,7 @@
 from pcluster.api.models.build_image_request_content import BuildImageRequestContent
 from pcluster.api.models.build_image_response_content import BuildImageResponseContent
 from pcluster.api.models.change import Change
+from pcluster.api.models.cloud_formation_resource_status import CloudFormationResourceStatus
 from pcluster.api.models.cloud_formation_stack_status import CloudFormationStackStatus
 from pcluster.api.models.cluster_configuration_structure import ClusterConfigurationStructure
 from pcluster.api.models.cluster_info_summary import ClusterInfoSummary

cli/src/pcluster/api/models/describe_cluster_response_content.py

@@ -80,6 +80,7 @@ def __init__(
         :type scheduler: Scheduler
         :param login_nodes: The login_nodes of this DescribeClusterResponseContent.  # noqa: E501
         :type login_nodes: LoginNodesPool
+        :param failures: The failures of this DescribeClusterResponseContent.  # noqa: E501
         :type failures: List[Failure]
         """
         self.openapi_types = {
@@ -487,7 +488,7 @@ def login_nodes(self, login_nodes):
     def failures(self):
         """Gets the failures of this DescribeClusterResponseContent.
 
-        Failures reason and code when the stack is in CREATE_FAILED status.  # noqa: E501
+        Failures array containing failures reason and code when the stack is in CREATE_FAILED status.  # noqa: E501
 
         :return: The failures of this DescribeClusterResponseContent.
         :rtype: List[Failure]
@@ -498,7 +499,7 @@ def failures(self):
     def failures(self, failures):
         """Sets the failures of this DescribeClusterResponseContent.
 
-        Failures reason and code when the stack is in CREATE_FAILED status.  # noqa: E501
+        Failures array containing failures reason and code when the stack is in CREATE_FAILED status.  # noqa: E501
 
         :param failures: The failures of this DescribeClusterResponseContent.
         :type failures: List[Failure]

cli/src/pcluster/api/models/failure.py

@@ -45,7 +45,7 @@ def from_dict(cls, dikt) -> "Failure":
     def failure_code(self):
         """Gets the failure_code of this Failure.
 
-        Failure code  # noqa: E501
+        Failure code when the cluster stack is in CREATE_FAILED status.  # noqa: E501
 
         :return: The failure_code of this Failure.
         :rtype: str
@@ -56,7 +56,7 @@ def failure_code(self):
     def failure_code(self, failure_code):
         """Sets the failure_code of this Failure.
 
-        Failure code  # noqa: E501
+        Failure code when the cluster stack is in CREATE_FAILED status.  # noqa: E501
 
         :param failure_code: The failure_code of this Failure.
         :type failure_code: str
@@ -68,7 +68,7 @@ def failure_code(self, failure_code):
     def failure_reason(self):
         """Gets the failure_reason of this Failure.
 
-        Failure reason  # noqa: E501
+        Failure reason when the cluster stack is in CREATE_FAILED status.  # noqa: E501
 
         :return: The failure_reason of this Failure.
         :rtype: str
@@ -79,7 +79,7 @@ def failure_reason(self):
     def failure_reason(self, failure_reason):
         """Sets the failure_reason of this Failure.
 
-        Failure reason  # noqa: E501
+        Failure reason when the cluster stack is in CREATE_FAILED status.  # noqa: E501
 
         :param failure_reason: The failure_reason of this Failure.
         :type failure_reason: str

cli/src/pcluster/api/openapi/openapi.yaml

@@ -2348,6 +2348,11 @@ components:
       type: object
     DescribeClusterResponseContent:
       example:
+        failures:
+        - failureCode: failureCode
+          failureReason: failureReason
+        - failureCode: failureCode
+          failureReason: failureReason
         creationTime: 2000-01-23T04:56:07.000+00:00
         loginNodes:
           unhealthyNodes: 6
@@ -2431,11 +2436,13 @@ components:
           $ref: '#/components/schemas/EC2Instance'
         loginNodes:
           $ref: '#/components/schemas/LoginNodesPool'
-        failureReason:
-          description: "Reason of the failure when the stack is in CREATE_FAILED,\
-            \ UPDATE_FAILED or DELETE_FAILED status."
-          title: failureReason
-          type: string
+        failures:
+          description: Failures array containing failures reason and code when the
+            stack is in CREATE_FAILED status.
+          items:
+            $ref: '#/components/schemas/Failure'
+          title: failures
+          type: array
       required:
       - cloudFormationStackStatus
       - cloudformationStackArn
@@ -2682,6 +2689,21 @@ components:
       - ERROR
       title: Ec2AmiState
       type: string
+    Failure:
+      example:
+        failureCode: failureCode
+        failureReason: failureReason
+      properties:
+        failureCode:
+          description: Failure code when the cluster stack is in CREATE_FAILED status.
+          title: failureCode
+          type: string
+        failureReason:
+          description: Failure reason when the cluster stack is in CREATE_FAILED status.
+          title: failureReason
+          type: string
+      title: Failure
+      type: object
     GetClusterLogEventsResponseContent:
       example:
         nextToken: nextToken