|
| 1 | +"""Task Stage models for python-tfe. |
| 2 | +
|
| 3 | +This module contains models related to task stages in Terraform Cloud/Enterprise. |
| 4 | +""" |
| 5 | + |
| 6 | +from __future__ import annotations |
| 7 | + |
| 8 | +from datetime import datetime |
| 9 | +from enum import Enum |
| 10 | +from typing import TYPE_CHECKING |
| 11 | + |
| 12 | +from pydantic import BaseModel, ConfigDict, Field |
| 13 | + |
| 14 | +if TYPE_CHECKING: |
| 15 | + from .policy_evaluation import PolicyEvaluation |
| 16 | + from .run import Run |
| 17 | + from .task_result import TaskResult |
| 18 | + |
| 19 | + |
| 20 | +class Stage(str, Enum): |
| 21 | + """Enum representing possible run stages for run tasks.""" |
| 22 | + |
| 23 | + PRE_PLAN = "pre-plan" |
| 24 | + POST_PLAN = "post-plan" |
| 25 | + PRE_APPLY = "pre-apply" |
| 26 | + POST_APPLY = "post-apply" |
| 27 | + |
| 28 | + |
| 29 | +class TaskStageStatus(str, Enum): |
| 30 | + """Enum representing all possible statuses for a task stage.""" |
| 31 | + |
| 32 | + PENDING = "pending" |
| 33 | + RUNNING = "running" |
| 34 | + PASSED = "passed" |
| 35 | + FAILED = "failed" |
| 36 | + AWAITING_OVERRIDE = "awaiting_override" |
| 37 | + CANCELED = "canceled" |
| 38 | + ERRORED = "errored" |
| 39 | + UNREACHABLE = "unreachable" |
| 40 | + |
| 41 | + |
| 42 | +class Permissions(BaseModel): |
| 43 | + """Permission types for overriding a task stage.""" |
| 44 | + |
| 45 | + can_override_policy: bool | None = Field(default=None, alias="can-override-policy") |
| 46 | + can_override_tasks: bool | None = Field(default=None, alias="can-override-tasks") |
| 47 | + can_override: bool | None = Field(default=None, alias="can-override") |
| 48 | + |
| 49 | + model_config = ConfigDict(populate_by_name=True) |
| 50 | + |
| 51 | + |
| 52 | +class Actions(BaseModel): |
| 53 | + """Task stage actions.""" |
| 54 | + |
| 55 | + is_overridable: bool | None = Field(default=None, alias="is-overridable") |
| 56 | + |
| 57 | + model_config = ConfigDict(populate_by_name=True) |
| 58 | + |
| 59 | + |
| 60 | +class TaskStageStatusTimestamps(BaseModel): |
| 61 | + """Timestamps recorded for a task stage.""" |
| 62 | + |
| 63 | + errored_at: datetime | None = Field(default=None, alias="errored-at") |
| 64 | + running_at: datetime | None = Field(default=None, alias="running-at") |
| 65 | + canceled_at: datetime | None = Field(default=None, alias="canceled-at") |
| 66 | + failed_at: datetime | None = Field(default=None, alias="failed-at") |
| 67 | + passed_at: datetime | None = Field(default=None, alias="passed-at") |
| 68 | + |
| 69 | + model_config = ConfigDict(populate_by_name=True) |
| 70 | + |
| 71 | + |
| 72 | +class TaskStage(BaseModel): |
| 73 | + """Represents a HCP Terraform or Terraform Enterprise run's task stage. |
| 74 | + |
| 75 | + Task stages are where run tasks can occur during a run lifecycle. |
| 76 | + |
| 77 | + API Documentation: |
| 78 | + https://developer.hashicorp.com/terraform/cloud-docs/api-docs/task-stages |
| 79 | + """ |
| 80 | + |
| 81 | + id: str |
| 82 | + stage: Stage |
| 83 | + status: TaskStageStatus |
| 84 | + status_timestamps: TaskStageStatusTimestamps = Field(alias="status-timestamps") |
| 85 | + created_at: datetime = Field(alias="created-at") |
| 86 | + updated_at: datetime = Field(alias="updated-at") |
| 87 | + permissions: Permissions | None = None |
| 88 | + actions: Actions | None = None |
| 89 | + |
| 90 | + # Relationships |
| 91 | + run: Run | None = None |
| 92 | + task_results: list[TaskResult] = Field(default_factory=list, alias="task-results") |
| 93 | + policy_evaluations: list[PolicyEvaluation] = Field( |
| 94 | + default_factory=list, |
| 95 | + alias="policy-evaluations" |
| 96 | + ) |
| 97 | + |
| 98 | + model_config = ConfigDict(populate_by_name=True) |
| 99 | + |
| 100 | + |
| 101 | +class TaskStageOverrideOptions(BaseModel): |
| 102 | + """Options for overriding a task stage.""" |
| 103 | + |
| 104 | + comment: str | None = None |
| 105 | + |
| 106 | + |
| 107 | +class TaskStageReadOptions(BaseModel): |
| 108 | + """Options for reading a task stage.""" |
| 109 | + |
| 110 | + include: list[str] | None = None |
| 111 | + |
| 112 | + |
| 113 | +class TaskStageListOptions(BaseModel): |
| 114 | + """Options for listing task stages.""" |
| 115 | + |
| 116 | + page_number: int | None = Field(default=None, alias="page[number]") |
| 117 | + page_size: int | None = Field(default=None, alias="page[size]") |
| 118 | + |
| 119 | + model_config = ConfigDict(populate_by_name=True) |
0 commit comments