// Package artifact provides the core artifact storage for goreleaser. package artifact // nolint: gosec import ( "crypto/md5" "crypto/sha1" "crypto/sha256" "crypto/sha512" "encoding/hex" "fmt" "hash" "hash/crc32" "io" "os" "sync" "github.com/apex/log" ) // Type defines the type of an artifact. type Type int const ( // UploadableArchive a tar.gz/zip archive to be uploaded. UploadableArchive Type = iota // UploadableBinary is a binary file to be uploaded. UploadableBinary // UploadableFile is any file that can be uploaded. UploadableFile // Binary is a binary (output of a gobuild). Binary // UniversalBinary is a binary that contains multiple binaries within. UniversalBinary // LinuxPackage is a linux package generated by nfpm. LinuxPackage // PublishableSnapcraft is a snap package yet to be published. PublishableSnapcraft // Snapcraft is a published snap package. Snapcraft // PublishableDockerImage is a Docker image yet to be published. PublishableDockerImage // DockerImage is a published Docker image. DockerImage // DockerManifest is a published Docker manifest. DockerManifest // Checksum is a checksums file. Checksum // Signature is a signature file. Signature // UploadableSourceArchive is the archive with the current commit source code. UploadableSourceArchive // BrewTap is an uploadable homebrew tap recipe file. BrewTap // GoFishRig is an uploadable Rigs rig food file. GoFishRig // ScoopManifest is an uploadable scoop manifest file. ScoopManifest ) func (t Type) String() string { switch t { case UploadableArchive: return "Archive" case UploadableFile: return "File" case UploadableBinary, Binary, UniversalBinary: return "Binary" case LinuxPackage: return "Linux Package" case PublishableDockerImage, DockerImage: return "Docker Image" case DockerManifest: return "Docker Manifest" case PublishableSnapcraft, Snapcraft: return "Snap" case Checksum: return "Checksum" case Signature: return "Signature" case UploadableSourceArchive: return "Source" case BrewTap: return "Brew Tap" case GoFishRig: return "GoFish Rig" case ScoopManifest: return "Scoop Manifest" default: return "unknown" } } const ( ExtraID = "ID" ExtraBinary = "Binary" ExtraExt = "Ext" ExtraBuilds = "Builds" ExtraFormat = "Format" ExtraWrappedIn = "WrappedIn" ExtraBinaries = "Binaries" ) // Artifact represents an artifact and its relevant info. type Artifact struct { Name string Path string Goos string Goarch string Goarm string Gomips string Type Type Extra map[string]interface{} } // ExtraOr returns the Extra field with the given key or the or value specified // if it is nil. func (a Artifact) ExtraOr(key string, or interface{}) interface{} { if a.Extra[key] == nil { return or } return a.Extra[key] } // Checksum calculates the checksum of the artifact. // nolint: gosec func (a Artifact) Checksum(algorithm string) (string, error) { log.Debugf("calculating checksum for %s", a.Path) file, err := os.Open(a.Path) if err != nil { return "", fmt.Errorf("failed to checksum: %w", err) } defer file.Close() var h hash.Hash switch algorithm { case "crc32": h = crc32.NewIEEE() case "md5": h = md5.New() case "sha224": h = sha256.New224() case "sha384": h = sha512.New384() case "sha256": h = sha256.New() case "sha1": h = sha1.New() case "sha512": h = sha512.New() default: return "", fmt.Errorf("invalid algorithm: %s", algorithm) } if _, err := io.Copy(h, file); err != nil { return "", fmt.Errorf("failed to checksum: %w", err) } return hex.EncodeToString(h.Sum(nil)), nil } // ID returns the artifact ID if it exists, empty otherwise. func (a Artifact) ID() string { return a.ExtraOr(ExtraID, "").(string) } // Format returns the artifact Format if it exists, empty otherwise. func (a Artifact) Format() string { return a.ExtraOr(ExtraFormat, "").(string) } // Artifacts is a list of artifacts. type Artifacts struct { items []*Artifact lock *sync.Mutex } // New return a new list of artifacts. func New() Artifacts { return Artifacts{ items: []*Artifact{}, lock: &sync.Mutex{}, } } // List return the actual list of artifacts. func (artifacts Artifacts) List() []*Artifact { return artifacts.items } // GroupByPlatform groups the artifacts by their platform. func (artifacts Artifacts) GroupByPlatform() map[string][]*Artifact { result := map[string][]*Artifact{} for _, a := range artifacts.items { plat := a.Goos + a.Goarch + a.Goarm + a.Gomips result[plat] = append(result[plat], a) } return result } // Add safely adds a new artifact to an artifact list. func (artifacts *Artifacts) Add(a *Artifact) { artifacts.lock.Lock() defer artifacts.lock.Unlock() log.WithFields(log.Fields{ "name": a.Name, "path": a.Path, "type": a.Type, }).Debug("added new artifact") artifacts.items = append(artifacts.items, a) } // Remove removes artifacts that match the given filter from the original artifact list. func (artifacts *Artifacts) Remove(filter Filter) error { if filter == nil { return nil } artifacts.lock.Lock() defer artifacts.lock.Unlock() result := New() for _, a := range artifacts.items { if filter(a) { log.WithFields(log.Fields{ "name": a.Name, "path": a.Path, "type": a.Type, }).Debug("removing") } else { result.items = append(result.items, a) } } artifacts.items = result.items return nil } // Filter defines an artifact filter which can be used within the Filter // function. type Filter func(a *Artifact) bool // ByGoos is a predefined filter that filters by the given goos. func ByGoos(s string) Filter { return func(a *Artifact) bool { return a.Goos == s } } // ByGoarch is a predefined filter that filters by the given goarch. func ByGoarch(s string) Filter { return func(a *Artifact) bool { return a.Goarch == s } } // ByGoarm is a predefined filter that filters by the given goarm. func ByGoarm(s string) Filter { return func(a *Artifact) bool { return a.Goarm == s } } // ByType is a predefined filter that filters by the given type. func ByType(t Type) Filter { return func(a *Artifact) bool { return a.Type == t } } // ByFormats filters artifacts by a `Format` extra field. func ByFormats(formats ...string) Filter { filters := make([]Filter, 0, len(formats)) for _, format := range formats { format := format filters = append(filters, func(a *Artifact) bool { return a.Format() == format }) } return Or(filters...) } // ByIDs filter artifacts by an `ID` extra field. func ByIDs(ids ...string) Filter { filters := make([]Filter, 0, len(ids)) for _, id := range ids { id := id filters = append(filters, func(a *Artifact) bool { // checksum and source archive are always for all artifacts, so return always true. return a.Type == Checksum || a.Type == UploadableSourceArchive || a.ID() == id }) } return Or(filters...) } // Or performs an OR between all given filters. func Or(filters ...Filter) Filter { return func(a *Artifact) bool { for _, f := range filters { if f(a) { return true } } return false } } // And performs an AND between all given filters. func And(filters ...Filter) Filter { return func(a *Artifact) bool { for _, f := range filters { if !f(a) { return false } } return true } } // Filter filters the artifact list, returning a new instance. // There are some pre-defined filters but anything of the Type Filter // is accepted. // You can compose filters by using the And and Or filters. func (artifacts *Artifacts) Filter(filter Filter) Artifacts { if filter == nil { return *artifacts } result := New() for _, a := range artifacts.items { if filter(a) { result.items = append(result.items, a) } } return result } // Paths returns the artifact.Path of the current artifact list. func (artifacts Artifacts) Paths() []string { var result []string for _, artifact := range artifacts.List() { result = append(result, artifact.Path) } return result }