misc.go

/*
Copyright 2021 Gravitational, Inc.

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 mage

import (
	"context"
	"fmt"
	"os"
	"path/filepath"

	"github.com/gravitational/trace"

	"github.com/magefile/mage/target"
)

// Shutdown runs any shutdown hooks.
// TODO(dima): currently implemented (and visible) as a build target
// but ideally should be hidden from the build pipeline
func Shutdown() {
	root.Shutdown()
}

// Clean cleans up the build directory.
func Clean() (err error) {
	m := root.Target("build:clean")
	defer func() { m.Complete(err) }()

	return trace.Wrap(os.RemoveAll(root.buildDir))
}

// IsUpToDate returns true iff all of the (source, sources...) are older or the same
// age as dst.
func IsUpToDate(dst string, source string, sources ...string) (uptodate bool) {
	var files []string
	for _, source := range append(sources, source) {
		filepath.Walk(source, func(path string, fi os.FileInfo, err error) error {
			if err != nil {
				if os.IsNotExist(err) {
					return nil
				}
				return err
			}
			if fi.Mode().IsRegular() {
				files = append(files, path)
			}
			return nil
		})
	}
	newer, err := target.Path(dst, files...)
	return err == nil && !newer
}

// MkDir returns a mage target that ensures the given directory exists
func Mkdir(dir string) Mkdirer {
	return Mkdirer(dir)
}

// Name returns the name of the target
func (r Mkdirer) Name() string {
	return fmt.Sprint("Mkdir(", string(r), ")")
}

// ID uniquely identifies the target to mage
func (r Mkdirer) ID() string {
	return string(r)
}

// Run ensures the underlying directory exists
func (r Mkdirer) Run(context.Context) error {
	if err := os.MkdirAll(string(r), 0755); err != nil {
		return trace.ConvertSystemError(err)
	}
	return nil
}

// Mkdirer is a mage target to ensure a directory exists
type Mkdirer string