// Copyright (c) 2026 Tigera, Inc. All rights reserved.

// 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 steps

import (
	"fmt"
	"path/filepath"

	"github.com/sirupsen/logrus"

	"github.com/projectcalico/calico/release/internal/command"
)

const (
	// One retry: pushes fail on network flakes often enough to save a run.
	MaxRetries = 1

	// Limit the concurrency of step executions.
	MaxConcurrency = 4
)

// Step holds what every release step needs. Embedding keeps these unexported,
// so a zero-value config still runs real commands.
type Step struct {
	runner command.CommandRunner

	// dir is where commands run. Empty runs them in the current directory.
	dir string

	name string

	// logsDir is where per-invocation logs are written. Empty captures the
	// output in memory instead.
	logsDir string
}

type Option func(*Step)

func WithRunner(r command.CommandRunner) Option {
	return func(s *Step) { s.runner = r }
}

func WithDir(dir string) Option {
	return func(s *Step) { s.dir = dir }
}

func WithName(name string) Option {
	return func(s *Step) { s.name = name }
}

func WithLogsDir(dir string) Option {
	return func(s *Step) { s.logsDir = dir }
}

func (s *Step) Apply(opts []Option) {
	for _, opt := range opts {
		opt(s)
	}
}

// Runner defaults to running real commands.
func (s Step) Runner() command.CommandRunner {
	if s.runner == nil {
		return &command.RealCommandRunner{}
	}
	return s.runner
}

// Run sends output to logPath when there is one, else captures it in memory.
func (s Step) Run(name string, args, env []string, logPath string) (string, error) {
	if logPath == "" {
		return s.Runner().RunInDir(s.dir, name, args, env)
	}
	return s.Runner().RunInDirToFile(s.dir, name, args, env, logPath)
}

// Logger tags every line with the step, so a release running several steps
// produces output a reader can tell apart.
func (s Step) Logger() *logrus.Entry {
	return logrus.WithField("step", s.name)
}

func (s Step) Errorf(format string, args ...any) error {
	return fmt.Errorf("%s: %w", s.name, fmt.Errorf(format, args...))
}

// LogPath names one invocation's output by slug: steps sharing a name write to
// the same directory, so the slug is what keeps them apart. An empty logs dir
// captures the output in memory instead.
func (s Step) LogPath(slug string) string {
	if s.logsDir == "" {
		return ""
	}
	return filepath.Join(s.logsDir, s.name, slug+".log")
}