utils

Documentation

Overview

Package utils provides utility fns for UDS-CLI

Package utils provides utility fns for UDS-CLI

Index

• func CheckYAMLSourcePath(source string) error
• func ConfigureLogs(cmd *cobra.Command) error
• func ExtractJSON(j any) func(context.Context, av4.File) error
• func HandleSBOM(extractSBOM bool, SBOMArtifactPathMap map[string]string, ...) ([]string, error)
• func IncludeComponent(componentToCheck string, filteredComponents []v1alpha1.ZarfComponent) bool
• func IsRegistryURL(s string) bool
• func IsRemotePkg(pkg types.Package) bool
• func IsValidTarballPath(path string) bool
• func JSONValue(value any) (string, error)
• func ReadYAMLStrict(path string, destConfig any) error
• func SBOMExtractor(dst string, SBOMArtifactPathMap map[string]string) func(_ context.Context, f archiver.File) error
• func ToLocalFile(t any, filePath string) error

Functions

func CheckYAMLSourcePath

func CheckYAMLSourcePath(source string) error

CheckYAMLSourcePath checks if the provided YAML source path is valid

func ConfigureLogs

func ConfigureLogs(cmd *cobra.Command) error

ConfigureLogs sets up the log file, log cache and output for the CLI

func ExtractJSON

func ExtractJSON(j any) func(context.Context, av4.File) error

ExtractJSON extracts and unmarshals a tarballed JSON file into a type

func HandleSBOM

func HandleSBOM(extractSBOM bool, SBOMArtifactPathMap map[string]string, bundleName, dstPath string) ([]string, error)

HandleSBOM handles the extraction and creation of bundle SBOMs after populating SBOMArtifactPathMap

func IncludeComponent

func IncludeComponent(componentToCheck string, filteredComponents []v1alpha1.ZarfComponent) bool

IncludeComponent checks if a component has been specified in a a list of components (used for filtering optional components)

func IsRegistryURL

func IsRegistryURL(s string) bool

IsRegistryURL checks if a string is a URL

func IsRemotePkg

func IsRemotePkg(pkg types.Package) bool

IsRemotePkg returns true if the Zarf package is remote

func IsValidTarballPath

func IsValidTarballPath(path string) bool

IsValidTarballPath returns true if the path is a valid tarball path to a bundle tarball

func JSONValue

func JSONValue(value any) (string, error)

JSONValue prints any value as JSON.

func ReadYAMLStrict

func ReadYAMLStrict(path string, destConfig any) error

ReadYAMLStrict reads a YAML file into a struct, with strict parsing

func SBOMExtractor

func SBOMExtractor(dst string, SBOMArtifactPathMap map[string]string) func(_ context.Context, f archiver.File) error

SBOMExtractor is the extraction fn for extracting HTML and JSON files from an sboms.tar archive

func ToLocalFile

func ToLocalFile(t any, filePath string) error

ToLocalFile takes an arbitrary type, typically a struct, marshals it into JSON and stores it as a local file