github.com/bigzoro/my_simplechain@v0.0.0-20240315012955-8ad0a2a29bb9/internal/build/util.go (about)

     1  // Copyright 2016 The go-simplechain Authors
     2  // This file is part of the go-simplechain library.
     3  //
     4  // The go-simplechain 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 go-simplechain 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 go-simplechain 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  var warnedAboutGit bool
    64  
    65  // RunGit runs a git subcommand and returns its output.
    66  // The command must complete successfully.
    67  func RunGit(args ...string) string {
    68  	cmd := exec.Command("git", args...)
    69  	var stdout, stderr bytes.Buffer
    70  	cmd.Stdout, cmd.Stderr = &stdout, &stderr
    71  	if err := cmd.Run(); err != nil {
    72  		if e, ok := err.(*exec.Error); ok && e.Err == exec.ErrNotFound {
    73  			if !warnedAboutGit {
    74  				log.Println("Warning: can't find 'git' in PATH")
    75  				warnedAboutGit = true
    76  			}
    77  			return ""
    78  		}
    79  		log.Fatal(strings.Join(cmd.Args, " "), ": ", err, "\n", stderr.String())
    80  	}
    81  	return strings.TrimSpace(stdout.String())
    82  }
    83  
    84  // readGitFile returns content of file in .git directory.
    85  func readGitFile(file string) string {
    86  	content, err := ioutil.ReadFile(path.Join(".git", file))
    87  	if err != nil {
    88  		return ""
    89  	}
    90  	return strings.TrimSpace(string(content))
    91  }
    92  
    93  // Render renders the given template file into outputFile.
    94  func Render(templateFile, outputFile string, outputPerm os.FileMode, x interface{}) {
    95  	tpl := template.Must(template.ParseFiles(templateFile))
    96  	render(tpl, outputFile, outputPerm, x)
    97  }
    98  
    99  // RenderString renders the given template string into outputFile.
   100  func RenderString(templateContent, outputFile string, outputPerm os.FileMode, x interface{}) {
   101  	tpl := template.Must(template.New("").Parse(templateContent))
   102  	render(tpl, outputFile, outputPerm, x)
   103  }
   104  
   105  func render(tpl *template.Template, outputFile string, outputPerm os.FileMode, x interface{}) {
   106  	if err := os.MkdirAll(filepath.Dir(outputFile), 0755); err != nil {
   107  		log.Fatal(err)
   108  	}
   109  	out, err := os.OpenFile(outputFile, os.O_CREATE|os.O_WRONLY|os.O_EXCL, outputPerm)
   110  	if err != nil {
   111  		log.Fatal(err)
   112  	}
   113  	if err := tpl.Execute(out, x); err != nil {
   114  		log.Fatal(err)
   115  	}
   116  	if err := out.Close(); err != nil {
   117  		log.Fatal(err)
   118  	}
   119  }
   120  
   121  // GoTool returns the command that runs a go tool. This uses go from GOROOT instead of PATH
   122  // so that go commands executed by build use the same version of Go as the 'host' that runs
   123  // build code. e.g.
   124  //
   125  //     /usr/lib/go-1.12.1/bin/go run build/ci.go ...
   126  //
   127  // runs using go 1.12.1 and invokes go 1.12.1 tools from the same GOROOT. This is also important
   128  // because runtime.Version checks on the host should match the tools that are run.
   129  func GoTool(tool string, args ...string) *exec.Cmd {
   130  	args = append([]string{tool}, args...)
   131  	return exec.Command(filepath.Join(runtime.GOROOT(), "bin", "go"), args...)
   132  }
   133  
   134  // UploadSFTP uploads files to a remote host using the sftp command line tool.
   135  // The destination host may be specified either as [user@]host[: or as a URI in
   136  // the form sftp://[user@]host[:port].
   137  func UploadSFTP(identityFile, host, dir string, files []string) error {
   138  	sftp := exec.Command("sftp")
   139  	sftp.Stdout = nil
   140  	sftp.Stderr = os.Stderr
   141  	if identityFile != "" {
   142  		sftp.Args = append(sftp.Args, "-i", identityFile)
   143  	}
   144  	sftp.Args = append(sftp.Args, host)
   145  	fmt.Println(">>>", strings.Join(sftp.Args, " "))
   146  	if *DryRunFlag {
   147  		return nil
   148  	}
   149  
   150  	stdin, err := sftp.StdinPipe()
   151  	if err != nil {
   152  		return fmt.Errorf("can't create stdin pipe for sftp: %v", err)
   153  	}
   154  	if err := sftp.Start(); err != nil {
   155  		return err
   156  	}
   157  	in := io.MultiWriter(stdin, os.Stdout)
   158  	for _, f := range files {
   159  		fmt.Fprintln(in, "put", f, path.Join(dir, filepath.Base(f)))
   160  	}
   161  	stdin.Close()
   162  	return sftp.Wait()
   163  }