tasks.go

/*
 * Copyright 2019 Armory, Inc.
 *
 * 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 plank

import (
	"errors"
	"time"
)

type Task struct {
	Application string        `json:"application"`
	Description string        `json:"description"`
	Job         []interface{} `json:"job,omitempty"`
}

type TaskRefResponse struct {
	Ref string `json:"ref"`
}

type ExecutionStatusResponse struct {
	ID      string `json:"id"`
	Status  string `json:"status"`
	EndTime int    `json:"endTime"`
}

func (c *Client) GetTask(refURL, traceparent string) (*ExecutionStatusResponse, error) {
	var body ExecutionStatusResponse
	err := c.Get(c.URLs["orca"]+refURL, traceparent, &body)
	return &body, err
}

func (c *Client) PollTaskStatus(refURL, traceparent string) (*ExecutionStatusResponse, error) {
	if refURL == "" {
		return nil, errors.New("no taskRef provided to follow")
	}
	timer := time.NewTimer(4 * time.Minute)
	t := time.NewTicker(1 * time.Second)
	defer t.Stop()

	for range t.C {
		var body ExecutionStatusResponse
		if c.UseGate {
			c.Get(c.URLs["gate"]+"/plank/"+refURL, "", &body)
		} else {
			c.Get(c.URLs["orca"]+refURL, "", &body)
		}
		if body.EndTime > 0 {
			return &body, nil
		}
		select {
		case <-timer.C:
			return nil, errors.New("timed out waiting for task to complete")
		default:
		}
	}
	return nil, errors.New("exited poll loop before completion")
}

// Create task puts the payload into the Task wrapper.
func (c *Client) CreateTask(app, desc, traceparent string, payload interface{}) (*TaskRefResponse, error) {
	task := Task{Application: app, Description: desc, Job: []interface{}{payload}}
	var ref TaskRefResponse
	if c.UseGate {
		if err := c.Post(c.URLs["gate"]+"/plank/ops", traceparent, ApplicationContextJson, task, &ref); err != nil {
			return nil, err
		}
	} else {
		if err := c.Post(c.URLs["orca"]+"/ops", traceparent, ApplicationContextJson, task, &ref); err != nil {
			return nil, err
		}
	}
	return &ref, nil
}