gitcaddy-runner/internal/app/cmd/cmd.go

// Copyright 2022 The Gitea Authors and MarketAlly. All rights reserved.
// SPDX-License-Identifier: MIT

// Package cmd provides the CLI commands for gitcaddy-runner.
package cmd

import (
	"context"
	"fmt"
	"os"

	"github.com/spf13/cobra"

	"git.marketally.com/gitcaddy/gitcaddy-runner/internal/pkg/cleanup"
	"git.marketally.com/gitcaddy/gitcaddy-runner/internal/pkg/config"
	"git.marketally.com/gitcaddy/gitcaddy-runner/internal/pkg/ver"
)

// Execute runs the root command for gitcaddy-runner CLI.
func Execute(ctx context.Context) {
	// ./gitcaddy-runner
	rootCmd := &cobra.Command{
		Use:          "gitcaddy-runner [event name to run]\nIf no event name passed, will default to \"on: push\"",
		Short:        "Run GitHub actions locally by specifying the event name (e.g. `push`) or an action name directly.",
		Args:         cobra.MaximumNArgs(1),
		Version:      ver.Version(),
		SilenceUsage: true,
	}
	configFile := ""
	rootCmd.PersistentFlags().StringVarP(&configFile, "config", "c", "", "Config file path")

	// ./gitcaddy-runner register
	var regArgs registerArgs
	registerCmd := &cobra.Command{
		Use:   "register",
		Short: "Register a runner to the server",
		Args:  cobra.MaximumNArgs(0),
		RunE:  runRegister(ctx, &regArgs, &configFile), // must use a pointer to regArgs
	}
	registerCmd.Flags().BoolVar(&regArgs.NoInteractive, "no-interactive", false, "Disable interactive mode")
	registerCmd.Flags().StringVar(&regArgs.InstanceAddr, "instance", "", "GitCaddy instance address")
	registerCmd.Flags().StringVar(&regArgs.Token, "token", "", "Runner token")
	registerCmd.Flags().StringVar(&regArgs.RunnerName, "name", "", "Runner name")
	registerCmd.Flags().StringVar(&regArgs.Labels, "labels", "", "Runner tags, comma separated")
	registerCmd.Flags().BoolVar(&regArgs.Ephemeral, "ephemeral", false, "Configure the runner to be ephemeral and only ever be able to pick a single job (stricter than --once)")
	rootCmd.AddCommand(registerCmd)

	// ./gitcaddy-runner daemon
	var daemArgs daemonArgs
	daemonCmd := &cobra.Command{
		Use:   "daemon",
		Short: "Run as a runner daemon",
		Args:  cobra.MaximumNArgs(0),
		RunE:  runDaemon(ctx, &daemArgs, &configFile),
	}
	daemonCmd.Flags().BoolVar(&daemArgs.Once, "once", false, "Run one job then exit")
	rootCmd.AddCommand(daemonCmd)

	// ./gitcaddy-runner exec
	rootCmd.AddCommand(loadExecCmd(ctx))

	// ./gitcaddy-runner config
	rootCmd.AddCommand(&cobra.Command{
		Use:   "generate-config",
		Short: "Generate an example config file",
		Args:  cobra.MaximumNArgs(0),
		Run: func(_ *cobra.Command, _ []string) {
			fmt.Printf("%s", config.Example)
		},
	})

	// ./gitcaddy-runner cache-server
	var cacheArgs cacheServerArgs
	cacheCmd := &cobra.Command{
		Use:   "cache-server",
		Short: "Start a cache server for the cache action",
		Args:  cobra.MaximumNArgs(0),
		RunE:  runCacheServer(ctx, &configFile, &cacheArgs),
	}
	cacheCmd.Flags().StringVarP(&cacheArgs.Dir, "dir", "d", "", "Cache directory")
	cacheCmd.Flags().StringVarP(&cacheArgs.Host, "host", "s", "", "Host of the cache server")
	cacheCmd.Flags().Uint16VarP(&cacheArgs.Port, "port", "p", 0, "Port of the cache server")
	rootCmd.AddCommand(cacheCmd)

	// ./gitcaddy-runner cleanup
	cleanupCmd := &cobra.Command{
		Use:   "cleanup",
		Short: "Manually trigger cleanup to free disk space",
		Args:  cobra.MaximumNArgs(0),
		RunE: func(_ *cobra.Command, _ []string) error {
			cfg, err := config.LoadDefault(configFile)
			if err != nil {
				return fmt.Errorf("failed to load config: %w", err)
			}
			result, err := cleanup.RunCleanup(ctx, cfg)
			if err != nil {
				return fmt.Errorf("cleanup failed: %w", err)
			}
			fmt.Printf("Cleanup completed: freed %d bytes, deleted %d files in %s\n", result.BytesFreed, result.FilesDeleted, result.Duration)
			if len(result.Errors) > 0 {
				fmt.Printf("Warnings: %d errors occurred\n", len(result.Errors))
				for _, e := range result.Errors {
					fmt.Printf("  - %s\n", e)
				}
			}
			return nil
		},
	}
	rootCmd.AddCommand(cleanupCmd)
	// hide completion command
	rootCmd.CompletionOptions.HiddenDefaultCmd = true

	if err := rootCmd.Execute(); err != nil {
		os.Exit(1)
	}
}