github.com/aerth/aquachain@v1.4.1/internal/build/util.go (about)

     1  // Copyright 2016 The aquachain Authors
     2  // This file is part of the aquachain library.
     3  //
     4  // The aquachain library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The aquachain library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the aquachain library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package build
    18  
    19  import (
    20  	"bytes"
    21  	"flag"
    22  	"fmt"
    23  	"io"
    24  	"io/ioutil"
    25  	"log"
    26  	"os"
    27  	"os/exec"
    28  	"path"
    29  	"path/filepath"
    30  	"runtime"
    31  	"strings"
    32  	"text/template"
    33  )
    34  
    35  var DryRunFlag = flag.Bool("n", false, "dry run, don't execute commands")
    36  
    37  // MustRun executes the given command and exits the host process for
    38  // any error.
    39  func MustRun(cmd *exec.Cmd) {
    40  	fmt.Println(">>>", strings.Join(cmd.Args, " "))
    41  	if !*DryRunFlag {
    42  		cmd.Stderr = os.Stderr
    43  		cmd.Stdout = os.Stdout
    44  		if err := cmd.Run(); err != nil {
    45  			log.Fatal(err)
    46  		}
    47  	}
    48  }
    49  
    50  func MustRunCommand(cmd string, args ...string) {
    51  	MustRun(exec.Command(cmd, args...))
    52  }
    53  
    54  // GOPATH returns the value that the GOPATH environment
    55  // variable should be set to.
    56  func GOPATH() string {
    57  	if os.Getenv("GOPATH") == "" {
    58  		log.Fatal("GOPATH is not set")
    59  	}
    60  	return os.Getenv("GOPATH")
    61  }
    62  
    63  // VERSION returns the content of the VERSION file.
    64  func VERSION() string {
    65  	version, err := ioutil.ReadFile("VERSION")
    66  	if err != nil {
    67  		log.Fatal(err)
    68  	}
    69  	return string(bytes.TrimSpace(version))
    70  }
    71  
    72  var warnedAboutGit bool
    73  
    74  // RunGit runs a git subcommand and returns its output.
    75  // The command must complete successfully.
    76  func RunGit(args ...string) string {
    77  	cmd := exec.Command("git", args...)
    78  	var stdout, stderr bytes.Buffer
    79  	cmd.Stdout, cmd.Stderr = &stdout, &stderr
    80  	if err := cmd.Run(); err == exec.ErrNotFound {
    81  		if !warnedAboutGit {
    82  			log.Println("Warning: can't find 'git' in PATH")
    83  			warnedAboutGit = true
    84  		}
    85  		return ""
    86  	} else if err != nil {
    87  		log.Fatal(strings.Join(cmd.Args, " "), ": ", err, "\n", stderr.String())
    88  	}
    89  	return strings.TrimSpace(stdout.String())
    90  }
    91  
    92  // readGitFile returns content of file in .git directory.
    93  func readGitFile(file string) string {
    94  	content, err := ioutil.ReadFile(path.Join(".git", file))
    95  	if err != nil {
    96  		return ""
    97  	}
    98  	return strings.TrimSpace(string(content))
    99  }
   100  
   101  // Render renders the given template file into outputFile.
   102  func Render(templateFile, outputFile string, outputPerm os.FileMode, x interface{}) {
   103  	tpl := template.Must(template.ParseFiles(templateFile))
   104  	render(tpl, outputFile, outputPerm, x)
   105  }
   106  
   107  // RenderString renders the given template string into outputFile.
   108  func RenderString(templateContent, outputFile string, outputPerm os.FileMode, x interface{}) {
   109  	tpl := template.Must(template.New("").Parse(templateContent))
   110  	render(tpl, outputFile, outputPerm, x)
   111  }
   112  
   113  func render(tpl *template.Template, outputFile string, outputPerm os.FileMode, x interface{}) {
   114  	if err := os.MkdirAll(filepath.Dir(outputFile), 0755); err != nil {
   115  		log.Fatal(err)
   116  	}
   117  	out, err := os.OpenFile(outputFile, os.O_CREATE|os.O_WRONLY|os.O_EXCL, outputPerm)
   118  	if err != nil {
   119  		log.Fatal(err)
   120  	}
   121  	if err := tpl.Execute(out, x); err != nil {
   122  		log.Fatal(err)
   123  	}
   124  	if err := out.Close(); err != nil {
   125  		log.Fatal(err)
   126  	}
   127  }
   128  
   129  // CopyFile copies a file.
   130  func CopyFile(dst, src string, mode os.FileMode) {
   131  	if err := os.MkdirAll(filepath.Dir(dst), 0755); err != nil {
   132  		log.Fatal(err)
   133  	}
   134  	destFile, err := os.OpenFile(dst, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, mode)
   135  	if err != nil {
   136  		log.Fatal(err)
   137  	}
   138  	defer destFile.Close()
   139  
   140  	srcFile, err := os.Open(src)
   141  	if err != nil {
   142  		log.Fatal(err)
   143  	}
   144  	defer srcFile.Close()
   145  
   146  	if _, err := io.Copy(destFile, srcFile); err != nil {
   147  		log.Fatal(err)
   148  	}
   149  }
   150  
   151  // GoTool returns the command that runs a go tool. This uses go from GOROOT instead of PATH
   152  // so that go commands executed by build use the same version of Go as the 'host' that runs
   153  // build code. e.g.
   154  //
   155  //     /usr/lib/go-1.8/bin/go run build/ci.go ...
   156  //
   157  // runs using go 1.8 and invokes go 1.8 tools from the same GOROOT. This is also important
   158  // because runtime.Version checks on the host should match the tools that are run.
   159  func GoTool(tool string, args ...string) *exec.Cmd {
   160  	args = append([]string{tool}, args...)
   161  	return exec.Command(filepath.Join(runtime.GOROOT(), "bin", "go"), args...)
   162  }
   163  
   164  // ExpandPackagesNoVendor expands a cmd/go import path pattern, skipping
   165  // vendored packages.
   166  func ExpandPackagesNoVendor(patterns []string) []string {
   167  	expand := false
   168  	for _, pkg := range patterns {
   169  		if strings.Contains(pkg, "...") {
   170  			expand = true
   171  		}
   172  	}
   173  	if expand {
   174  		cmd := GoTool("list", patterns...)
   175  		out, err := cmd.CombinedOutput()
   176  		if err != nil {
   177  			log.Fatalf("package listing failed: %v\n%s", err, string(out))
   178  		}
   179  		var packages []string
   180  		for _, line := range strings.Split(string(out), "\n") {
   181  			if !strings.Contains(line, "/vendor/") {
   182  				packages = append(packages, strings.TrimSpace(line))
   183  			}
   184  		}
   185  		return packages
   186  	}
   187  	return patterns
   188  }