redirect_appendstdouttofilename.go

// scriptish is a library to help you port bash scripts to Golang
//
// inspired by:
//
// - http://labix.org/pipe
// - https://github.com/bitfield/script
//
// Copyright 2019-present Ganbaro Digital Ltd
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
//   * Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//
//   * Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//
//   * Neither the names of the copyright holders nor the names of his
//     contributors may be used to endorse or promote products derived
//     from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

package scriptish

import "os"

// AppendStdoutToFilename redirects the pipe's stdout to the given
// filename.
//
// Anything written to the pipe's stdout is appended to the
// named file.
//
// If the file does not exist, it is created.
//
// It is an emulation of UNIX shell scripting's `>> <filename>`.
func AppendStdoutToFilename(filename string) *StepOption {
	var fh *os.File
	var err error

	return NewStepOption(
		func(p *Pipe) (int, error) {
			// debugging support
			Tracef("AppendStdoutToFilename(%#v)", filename)

			// expand our input
			expFilename := p.Env.Expand(filename)

			// now we show what the filename expanded to
			Tracef("=> AppendStdoutToFilename(%#v)", expFilename)

			// open / create the file
			fh, err = os.OpenFile(expFilename, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
			if err != nil {
				return StatusNotOkay, err
			}

			// make sure the pipe's stdout points at our open file
			p.PushStdout(NewTextFile(fh))

			// all done
			return StatusOkay, nil
		},
		func(p *Pipe) (int, error) {
			// robustness!
			if fh != nil {
				fh.Close()
			}

			// go back to the pipe's previous Stdout
			p.PopStdout()

			// all done
			return StatusOkay, nil
		},
	)
}