task.go

package pulp_client

import (
	"context"
	"fmt"
	"net/http"
	"regexp"
	"time"

	zest "github.com/content-services/zest/release/v2024"
	"github.com/rs/zerolog"
	"github.com/rs/zerolog/log"
	"golang.org/x/exp/slices"
)

const (
	COMPLETED string = "completed"
	WAITING   string = "waiting"
	RUNNING   string = "running"
	SKIPPED   string = "skipped"
	CANCELED  string = "canceled"
	CANCELING string = "canceling"
	FAILED    string = "failed"
)

// GetTask Fetch a pulp task
func (r pulpDaoImpl) GetTask(ctx context.Context, taskHref string) (zest.TaskResponse, error) {
	ctx, client := getZestClient(ctx)
	task, httpResp, err := client.TasksAPI.TasksRead(ctx, taskHref).Execute()
	if httpResp != nil {
		defer httpResp.Body.Close()
	}
	if err != nil {
		return zest.TaskResponse{}, errorWithResponseBody("error reading task", httpResp, err)
	}

	return *task, nil
}

func (r pulpDaoImpl) CancelTask(ctx context.Context, taskHref string) (zest.TaskResponse, error) {
	ctx, client := getZestClient(ctx)
	canceled := string(zest.STATESENUM_CANCELED)
	task, httpResp, err := client.TasksAPI.
		TasksCancel(ctx, taskHref).
		PatchedTaskCancel(zest.PatchedTaskCancel{State: &canceled}).
		Execute()
	if httpResp != nil {
		defer httpResp.Body.Close()
	}
	if err != nil {
		if httpResp != nil && httpResp.StatusCode == http.StatusConflict {
			log.Logger.Debug().Msg("CancelTask: Status Conflict")
			return zest.TaskResponse{}, nil
		}
		return zest.TaskResponse{}, errorWithResponseBody("error canceling task", httpResp, err)
	}

	return *task, nil
}

// PollTask Poll a task and return the final task object
func (r pulpDaoImpl) PollTask(ctx context.Context, taskHref string) (*zest.TaskResponse, error) {
	var task zest.TaskResponse
	var err error
	inProgress := true
	pollCount := 1
	logger := zerolog.Ctx(ctx)
	for inProgress {
		task, err = r.GetTask(ctx, taskHref)
		if err != nil {
			return nil, err
		}
		taskState := *task.State
		switch {
		case slices.Contains([]string{WAITING, RUNNING, CANCELING}, taskState):
			logger.Debug().Str("task_href", *task.PulpHref).Str("type", task.GetName()).Str("state", taskState).Msg("Running pulp task")
		case slices.Contains([]string{COMPLETED, SKIPPED, CANCELED}, taskState):
			logger.Debug().Str("task_href", *task.PulpHref).Str("type", task.GetName()).Str("state", taskState).Msg("Stopped pulp task")
			inProgress = false
		case taskState == FAILED:
			errorStr := TaskErrorString(task)
			logger.Warn().Str("Pulp error:", errorStr).Str("domain", r.domainName).Str("type", task.GetName()).Msg("Failed Pulp task")
			return &task, fmt.Errorf("domain %v had Pulp Task error '%v'", r.domainName, errorStr)
		default:
			logger.Error().Str("task_href", *task.PulpHref).Str("type", task.GetName()).Str("state", taskState).Msg("Pulp task with unexpected state")
			inProgress = false
		}

		if inProgress {
			SleepWithBackoff(pollCount)
			pollCount += 1
		}
	}
	return &task, nil
}

func SleepWithBackoff(iteration int) {
	var secs int
	if iteration <= 5 {
		secs = 1
	} else if iteration > 5 && iteration <= 10 {
		secs = 5
	} else if iteration > 10 && iteration <= 20 {
		secs = 10
	} else {
		secs = 30
	}
	time.Sleep(time.Duration(secs) * time.Second)
}

func TaskErrorString(task zest.TaskResponse) string {
	str := ""
	if task.Error != nil {
		for key, element := range *task.Error {
			str = str + fmt.Sprintf("%v: %v.  ", key, element)
		}
	}
	return str
}

func SelectVersionHref(task *zest.TaskResponse) *string {
	return SelectCreatedVersionHref(task, "/pulp/.*/api/v3/repositories/rpm/rpm/.*/versions/[0-9]*/")
}

func SelectPublicationHref(task *zest.TaskResponse) *string {
	return SelectCreatedVersionHref(task, "/pulp/.*/api/v3/publications/rpm/rpm/.*/")
}

func SelectRpmDistributionHref(task *zest.TaskResponse) *string {
	return SelectCreatedVersionHref(task, "/pulp/.*/api/v3/distributions/rpm/rpm/.*/")
}

// SelectCreatedVersionHref scans a tasks CreatedResources and looks for a match to a regular expression
func SelectCreatedVersionHref(task *zest.TaskResponse, regex string) *string {
	if task != nil {
		for i := 0; i < len(task.CreatedResources); i++ {
			match, err := regexp.MatchString(regex, task.CreatedResources[i])
			if err == nil && match {
				return &task.CreatedResources[i]
			}
		}
	}
	return nil
}