command

Documentation

Overview

Package command is used to manage the container management instructions required to carry out tasks desired by the user, such as "create"

Copyright © 2022 Joel D. Elkins <joel@elkins.co>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type Command
  • func NewConditional(name string, ifPart func() bool, thenPart Command, elsePart Command) Command
  • func NewDebug(msg string) Command
  • func NewFunc(name string, f func() error) Command
  • func NewIndirect(c Command) Command
  • func NewNop() Command
  • func NewSet(cs Set) Command
  • func NewShell(cmd string) Command
  • func (c Command) Execute(output io.Writer, fake bool, commandSetID string) error
• type Commands
• type Set
  • func (cmds Set) Execute(output io.Writer, fake bool) error

Types

type Command

type Command struct {
	Type    cType
	Command interface{}
}

Command combines a Type with an `interface{}`, representing a task (or a set of tasks, in the case of CtSet) to be executed. Create a Command with one of the `NewXxxCommand` functions.

func NewConditional

func NewConditional(name string, ifPart func() bool, thenPart Command, elsePart Command) Command

NewConditional takes a function and two commands as arguments. When evaluated, the function, having signature `func() bool`, is executed. If the result is true, then the first command is executed, and if false the second one.

func NewDebug

func NewDebug(msg string) Command

NewDebug returns a command that prints a debug message upon execution, but does no other action

func NewFunc

func NewFunc(name string, f func() error) Command

NewFunc creates a command consisting of go function of type `func() error`

func NewIndirect

func NewIndirect(c Command) Command

NewIndirect creates a reference to another command. When executed, the underlying command is executed.

func NewNop

func NewNop() Command

NewNop returns a placeholder command. When executed, nothing is done other than to note that it was encountered in the output.

func NewSet

func NewSet(cs Set) Command

NewSet creates a single command containing an ordered list of commands. These commands will be executed in order with this set-type command is executed.

func NewShell

func NewShell(cmd string) Command

NewShell creates a new shell-type command from a string. Upon execution, the string will be fed to `/bin/sh -c`

func (Command) Execute

func (c Command) Execute(output io.Writer, fake bool, commandSetID string) error

Execute the Command with the privileges of the user running the process. Warning: in the case of a shell command, this could do anything.

type Commands

type Commands []Command

Commands reflects an ordered grouping of `Command`s

type Set

type Set struct {
	ID string
	Commands
}

Set bundes a `Commands` object with an arbitrary ID for verbose output

func (Set) Execute

func (cmds Set) Execute(output io.Writer, fake bool) error

Execute the Set with the privileges of the user running the process. Warning: in the case of a shell command, this could do anything.