pkg/ansible - update status to include failure message on the status. #639
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| // Copyright 2018 The Operator-SDK Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package status | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "github.com/operator-framework/operator-sdk/pkg/ansible/runner/eventapi" | ||
| "github.com/sirupsen/logrus" | ||
| "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| const ( | ||
| host = "localhost" | ||
| ) | ||
|
|
||
| // AnsibleResult - encapsulation of the ansible result. | ||
| type AnsibleResult struct { | ||
| Ok int `json:"ok"` | ||
| Changed int `json:"changed"` | ||
| Skipped int `json:"skipped"` | ||
| Failures int `json:"failures"` | ||
| TimeOfCompletion eventapi.EventTime `json:"completion"` | ||
| } | ||
|
|
||
| // NewAnsibleResultFromStatusJobEvent - creates a Ansible status from job event. | ||
| func NewAnsibleResultFromStatusJobEvent(je eventapi.StatusJobEvent) *AnsibleResult { | ||
| // ok events. | ||
| a := &AnsibleResult{TimeOfCompletion: je.Created} | ||
| if v, ok := je.EventData.Changed[host]; ok { | ||
| a.Changed = v | ||
| } | ||
| if v, ok := je.EventData.Ok[host]; ok { | ||
| a.Ok = v | ||
| } | ||
| if v, ok := je.EventData.Skipped[host]; ok { | ||
| a.Skipped = v | ||
| } | ||
| if v, ok := je.EventData.Failures[host]; ok { | ||
| a.Failures = v | ||
| } | ||
| return a | ||
| } | ||
|
|
||
| // NewAnsibleResultFromMap - creates a Ansible status from a job event. | ||
| func NewAnsibleResultFromMap(sm map[string]interface{}) *AnsibleResult { | ||
| //Create Old top level status | ||
| // ok events. | ||
| a := &AnsibleResult{} | ||
| if v, ok := sm["changed"]; ok { | ||
| a.Changed = int(v.(int64)) | ||
| } | ||
| if v, ok := sm["ok"]; ok { | ||
| a.Ok = int(v.(int64)) | ||
| } | ||
| if v, ok := sm["skipped"]; ok { | ||
| a.Skipped = int(v.(int64)) | ||
| } | ||
| if v, ok := sm["failures"]; ok { | ||
| a.Failures = int(v.(int64)) | ||
| } | ||
| if v, ok := sm["completion"]; ok { | ||
| s := v.(string) | ||
| a.TimeOfCompletion.UnmarshalJSON([]byte(s)) | ||
| } | ||
| return a | ||
| } | ||
|
|
||
| // ConditionType - type of condition | ||
| type ConditionType string | ||
|
|
||
| const ( | ||
| // RunningConditionType - condition type of running. | ||
| RunningConditionType ConditionType = "Running" | ||
| // FailureConditionType - condition type of failure. | ||
| FailureConditionType ConditionType = "Failure" | ||
| ) | ||
|
|
||
| // Condition - the condition for the ansible operator. | ||
| type Condition struct { | ||
| Type ConditionType `json:"type"` | ||
| Status v1.ConditionStatus `json:"status"` | ||
| LastTransitionTime metav1.Time `json:"lastTransitionTime"` | ||
| AnsibleResult *AnsibleResult `json:"ansibleResult,omitempty"` | ||
| Reason string `json:"reason"` | ||
| Message string `json:"message"` | ||
| } | ||
|
|
||
| func createConditionFromMap(cm map[string]interface{}) Condition { | ||
| ct, ok := cm["type"].(string) | ||
| if !ok { | ||
| //If we do not find the string we are defaulting | ||
| // to make sure we can at least update the status. | ||
| ct = string(RunningConditionType) | ||
| } | ||
| status, ok := cm["status"].(string) | ||
| if !ok { | ||
| status = string(v1.ConditionTrue) | ||
| } | ||
| reason, ok := cm["reason"].(string) | ||
| if !ok { | ||
| reason = RunningReason | ||
| } | ||
| message, ok := cm["message"].(string) | ||
| if !ok { | ||
| message = RunningMessage | ||
| } | ||
| asm, ok := cm["ansibleStatus"].(map[string]interface{}) | ||
| var ansibleResult *AnsibleResult | ||
| if ok { | ||
| ansibleResult = NewAnsibleResultFromMap(asm) | ||
| } | ||
| ltts, ok := cm["lastTransitionTime"].(string) | ||
| ltt := metav1.Now() | ||
| if ok { | ||
| t, err := time.Parse("2006-01-02T15:04:05Z", ltts) | ||
| if err != nil { | ||
| logrus.Warningf("unable to parse time for status condition: %v", ltts) | ||
| } else { | ||
| ltt = metav1.NewTime(t) | ||
| } | ||
| } | ||
| return Condition{ | ||
| Type: ConditionType(ct), | ||
| Status: v1.ConditionStatus(status), | ||
| LastTransitionTime: ltt, | ||
| Reason: reason, | ||
| Message: message, | ||
| AnsibleResult: ansibleResult, | ||
| } | ||
| } | ||
|
|
||
| // Status - The status for custom resources managed by the operator-sdk. | ||
| type Status struct { | ||
| Conditions []Condition `json:"conditions"` | ||
| } | ||
|
|
||
| // CreateFromMap - create a status from the map | ||
| func CreateFromMap(statusMap map[string]interface{}) Status { | ||
| conditionsInterface, ok := statusMap["conditions"].([]interface{}) | ||
| if !ok { | ||
| return Status{Conditions: []Condition{}} | ||
| } | ||
| conditions := []Condition{} | ||
| for _, ci := range conditionsInterface { | ||
| cm, ok := ci.(map[string]interface{}) | ||
| if !ok { | ||
| logrus.Warningf("unknown condition, removing condition: %v", ci) | ||
| continue | ||
| } | ||
| conditions = append(conditions, createConditionFromMap(cm)) | ||
| } | ||
| return Status{Conditions: conditions} | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This name is not super great but status seems to be overused.