woodpecker-go-plugin-template/step.go

// Copyright 2023 Woodpecker 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 plugin

import (
	"time"

	"github.com/urfave/cli/v3"
)

// Step defines runtime metadata for a step.
type Step struct {
	Name     string    `json:"name,omitempty"`
	Type     StepType  `json:"type,omitempty"`
	Number   int       `json:"number,omitempty"`
	Started  time.Time `json:"started,omitempty"`
	Finished time.Time `json:"finished,omitempty"`
}

// StepType identifies the type of step.
type StepType string

const (
	StepTypeClone    StepType = "clone"
	StepTypeService  StepType = "service"
	StepTypePlugin   StepType = "plugin"
	StepTypeCommands StepType = "commands"
	StepTypeCache    StepType = "cache"
)

func stepFlags() []cli.Flag {
	return []cli.Flag{
		&cli.StringFlag{
			Name:  "step.name",
			Usage: "step name",
			Sources: cli.EnvVars(
				"CI_STEP_NAME",
			),
		},
		&cli.StringFlag{
			Name:  "step.type",
			Usage: "step type",
			Sources: cli.EnvVars(
				"CI_STEP_TYPE",
			),
		},
		&cli.IntFlag{
			Name:  "step.number",
			Usage: "step number",
			Sources: cli.EnvVars(
				"CI_STEP_NUMBER",
				"DRONE_STEP_NUMBER",
			),
		},
		&cli.Int64Flag{
			Name:  "step.started",
			Usage: "step start time",
			Sources: cli.EnvVars(
				"CI_STEP_STARTED",
			),
		},
		&cli.Int64Flag{
			Name:  "step.finished",
			Usage: "step finish time",
			Sources: cli.EnvVars(
				"CI_STEP_FINISHED",
			),
		},
	}
}

func stepFromContext(c *cli.Command) Step {
	return Step{
		Name:     c.String("step.name"),
		Type:     StepType(c.String("step.type")),
		Number:   c.Int("step.number"),
		Started:  time.Unix(c.Int64("step.started"), 0),
		Finished: time.Unix(c.Int64("step.finished"), 0),
	}
}