gapi: Bring back puppet and langpuppet
This reverts commit e767655ede.
In addition, it applies required changes to function with the new CLI backend.
This commit is contained in:
Felix Frank
committed by
James Shubin
James Shubin
parent
22873b3c3f
commit
29ec867ac7
347
puppet/gapi.go
Normal file
347
puppet/gapi.go
Normal file
@@ -0,0 +1,347 @@
|
||||
// Mgmt
|
||||
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
||||
// Written by James Shubin <james@shubin.ca> and the project contributors
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
//
|
||||
// Additional permission under GNU GPL version 3 section 7
|
||||
//
|
||||
// If you modify this program, or any covered work, by linking or combining it
|
||||
// with embedded mcl code and modules (and that the embedded mcl code and
|
||||
// modules which link with this program, contain a copy of their source code in
|
||||
// the authoritative form) containing parts covered by the terms of any other
|
||||
// license, the licensors of this program grant you additional permission to
|
||||
// convey the resulting work. Furthermore, the licensors of this program grant
|
||||
// the original author, James Shubin, additional permission to update this
|
||||
// additional permission if he deems it necessary to achieve the goals of this
|
||||
// additional permission.
|
||||
|
||||
package puppet
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
cliUtil "github.com/purpleidea/mgmt/cli/util"
|
||||
"github.com/purpleidea/mgmt/engine"
|
||||
"github.com/purpleidea/mgmt/gapi"
|
||||
"github.com/purpleidea/mgmt/pgraph"
|
||||
"github.com/purpleidea/mgmt/util"
|
||||
"github.com/purpleidea/mgmt/util/errwrap"
|
||||
)
|
||||
|
||||
const (
|
||||
// Name is the name of this frontend.
|
||||
Name = "puppet"
|
||||
|
||||
// PuppetFile is the entry point filename that we use. It is arbitrary.
|
||||
PuppetFile = "/file.pp"
|
||||
|
||||
// PuppetConf is the entry point config filename that we use.
|
||||
PuppetConf = "/puppet.conf"
|
||||
|
||||
// PuppetSite is the entry point folder that we use. It is arbitrary.
|
||||
PuppetSite = "/puppet/"
|
||||
)
|
||||
|
||||
func init() {
|
||||
gapi.Register(Name, func() gapi.GAPI { return &GAPI{} }) // register
|
||||
}
|
||||
|
||||
// GAPI implements the main puppet GAPI interface.
|
||||
type GAPI struct {
|
||||
InputURI string
|
||||
|
||||
// Mode of operation can be: agent, file, string, dir.
|
||||
Mode string
|
||||
|
||||
puppetFile string
|
||||
puppetString string
|
||||
puppetDir string
|
||||
// The path to a dedicated puppet.conf file for mgmt.
|
||||
puppetConf string
|
||||
data *gapi.Data
|
||||
initialized bool
|
||||
closeChan chan struct{}
|
||||
wg sync.WaitGroup
|
||||
}
|
||||
|
||||
// Cli takes an *Info struct, and returns our deploy if activated, and if there
|
||||
// are any validation problems, you should return an error. If there is no
|
||||
// deploy, then you should return a nil deploy and a nil error.
|
||||
func (obj *GAPI) Cli(info *gapi.Info) (*gapi.Deploy, error) {
|
||||
args, ok := info.Args.(*cliUtil.PuppetArgs)
|
||||
if !ok {
|
||||
// programming error
|
||||
return nil, fmt.Errorf("could not convert to our struct")
|
||||
}
|
||||
|
||||
fs := info.Fs
|
||||
writeableFS, ok := fs.(engine.WriteableFS)
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("the FS was not writeable")
|
||||
}
|
||||
|
||||
isDir := func(p string) (bool, error) {
|
||||
if !strings.HasPrefix(p, "/") {
|
||||
return false, nil
|
||||
}
|
||||
if !strings.HasSuffix(p, "/") {
|
||||
return false, nil
|
||||
}
|
||||
fi, err := os.Stat(p)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return fi.IsDir(), nil
|
||||
}
|
||||
|
||||
var mode string
|
||||
if args.Input == "agent" {
|
||||
mode = "agent"
|
||||
|
||||
} else if strings.HasSuffix(args.Input, ".pp") {
|
||||
mode = "file"
|
||||
if err := gapi.CopyFileToFs(writeableFS, args.Input, PuppetFile); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "can't copy code from `%s` to `%s`", args.Input, PuppetFile)
|
||||
}
|
||||
|
||||
} else if exists, err := isDir(args.Input); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "can't read dir `%s`", args.Input)
|
||||
|
||||
} else if err == nil && exists { // from the isDir result...
|
||||
// we have a whole directory of files to run
|
||||
mode = "dir"
|
||||
// TODO: this code path is untested! test and then rm this notice
|
||||
if err := gapi.CopyDirToFs(fs, args.Input, PuppetSite); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "can't copy code to `%s`", PuppetSite)
|
||||
}
|
||||
|
||||
} else {
|
||||
mode = "string"
|
||||
if err := gapi.CopyStringToFs(writeableFS, args.Input, PuppetFile); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "can't copy code to `%s`", PuppetFile)
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: do we want to include this if we have mode == "dir" ?
|
||||
if args.PuppetConf != "" {
|
||||
if err := gapi.CopyFileToFs(writeableFS, args.PuppetConf, PuppetConf); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "can't copy puppet conf from `%s` to '%s'", args.PuppetConf, PuppetConf)
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
return &gapi.Deploy{
|
||||
Name: Name,
|
||||
Noop: info.Flags.Noop,
|
||||
Sema: info.Flags.Sema,
|
||||
GAPI: &GAPI{
|
||||
InputURI: fs.URI(),
|
||||
Mode: mode,
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
||||
// Init initializes the puppet GAPI struct.
|
||||
func (obj *GAPI) Init(data *gapi.Data) error {
|
||||
if obj.initialized {
|
||||
return fmt.Errorf("already initialized")
|
||||
}
|
||||
if obj.InputURI == "" {
|
||||
return fmt.Errorf("the InputURI param must be specified")
|
||||
}
|
||||
switch obj.Mode {
|
||||
case "agent", "file", "string", "dir":
|
||||
// pass
|
||||
default:
|
||||
return fmt.Errorf("the Mode param is invalid")
|
||||
}
|
||||
obj.data = data // store for later
|
||||
|
||||
fs, err := obj.data.World.Fs(obj.InputURI) // open the remote file system
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(err, "can't load data from file system `%s`", obj.InputURI)
|
||||
}
|
||||
|
||||
if obj.Mode == "file" {
|
||||
b, err := fs.ReadFile(PuppetFile) // read the single file out of it
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(err, "can't read code from file `%s`", PuppetFile)
|
||||
}
|
||||
|
||||
// store the puppet file on disk for other binaries to see and use
|
||||
prefix := fmt.Sprintf("%s-%s-%s", data.Program, data.Hostname, strings.Replace(PuppetFile, "/", "", -1))
|
||||
tmpfile, err := os.CreateTemp("", prefix)
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(err, "can't create temp file")
|
||||
}
|
||||
obj.puppetFile = tmpfile.Name() // path to temp file
|
||||
defer tmpfile.Close()
|
||||
if _, err := tmpfile.Write(b); err != nil {
|
||||
return errwrap.Wrapf(err, "can't write file")
|
||||
}
|
||||
|
||||
} else if obj.Mode == "string" {
|
||||
b, err := fs.ReadFile(PuppetFile) // read the single code string out of it
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(err, "can't read code from file `%s`", PuppetFile)
|
||||
}
|
||||
obj.puppetString = string(b)
|
||||
|
||||
} else if obj.Mode == "dir" {
|
||||
// store the puppet files on disk for other binaries to see and use
|
||||
prefix := fmt.Sprintf("%s-%s-%s", data.Program, data.Hostname, strings.Replace(PuppetSite, "/", "", -1))
|
||||
tmpdirName, err := os.MkdirTemp("", prefix)
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(err, "can't create temp dir")
|
||||
}
|
||||
if tmpdirName == "" || tmpdirName == "/" {
|
||||
return fmt.Errorf("bad tmpdir created")
|
||||
}
|
||||
obj.puppetDir = tmpdirName // path to temp dir
|
||||
// TODO: this code path is untested! test and then rm this notice
|
||||
if err := util.CopyFsToDisk(fs, PuppetSite, tmpdirName, false); err != nil {
|
||||
return errwrap.Wrapf(err, "can't copy dir")
|
||||
}
|
||||
}
|
||||
|
||||
if fi, err := fs.Stat(PuppetConf); err == nil && !fi.IsDir() { // if exists?
|
||||
b, err := fs.ReadFile(PuppetConf) // read the single file out of it
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(err, "can't read config from file `%s`", PuppetConf)
|
||||
}
|
||||
|
||||
// store the puppet conf on disk for other binaries to see and use
|
||||
prefix := fmt.Sprintf("%s-%s-%s", data.Program, data.Hostname, strings.Replace(PuppetConf, "/", "", -1))
|
||||
tmpfile, err := os.CreateTemp("", prefix)
|
||||
if err != nil {
|
||||
return errwrap.Wrapf(err, "can't create temp file")
|
||||
}
|
||||
obj.puppetConf = tmpfile.Name() // path to temp file
|
||||
defer tmpfile.Close()
|
||||
if _, err := tmpfile.Write(b); err != nil {
|
||||
return errwrap.Wrapf(err, "can't write file")
|
||||
}
|
||||
}
|
||||
|
||||
obj.closeChan = make(chan struct{})
|
||||
obj.initialized = true
|
||||
return nil
|
||||
}
|
||||
|
||||
// Graph returns a current Graph.
|
||||
func (obj *GAPI) Graph() (*pgraph.Graph, error) {
|
||||
if !obj.initialized {
|
||||
return nil, fmt.Errorf("%s: GAPI is not initialized", Name)
|
||||
}
|
||||
config, err := obj.ParseConfigFromPuppet()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if config == nil {
|
||||
return nil, fmt.Errorf("function ParseConfigFromPuppet returned nil")
|
||||
}
|
||||
g, err := config.NewGraphFromConfig(obj.data.Hostname, obj.data.World, obj.data.Noop)
|
||||
return g, err
|
||||
}
|
||||
|
||||
// Next returns nil errors every time there could be a new graph.
|
||||
func (obj *GAPI) Next() chan gapi.Next {
|
||||
puppetChan := func() <-chan time.Time { // helper function
|
||||
return time.Tick(time.Duration(obj.refreshInterval()) * time.Second)
|
||||
}
|
||||
ch := make(chan gapi.Next)
|
||||
obj.wg.Add(1)
|
||||
go func() {
|
||||
defer obj.wg.Done()
|
||||
defer close(ch) // this will run before the obj.wg.Done()
|
||||
if !obj.initialized {
|
||||
next := gapi.Next{
|
||||
Err: fmt.Errorf("%s: GAPI is not initialized", Name),
|
||||
Exit: true, // exit, b/c programming error?
|
||||
}
|
||||
ch <- next
|
||||
return
|
||||
}
|
||||
startChan := make(chan struct{}) // start signal
|
||||
close(startChan) // kick it off!
|
||||
|
||||
var pChan <-chan time.Time
|
||||
if obj.data.NoStreamWatch {
|
||||
pChan = nil
|
||||
} else {
|
||||
pChan = puppetChan()
|
||||
}
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-startChan: // kick the loop once at start
|
||||
startChan = nil // disable
|
||||
// pass
|
||||
case _, ok := <-pChan:
|
||||
if !ok { // the channel closed!
|
||||
return
|
||||
}
|
||||
case <-obj.closeChan:
|
||||
return
|
||||
}
|
||||
|
||||
obj.data.Logf("generating new graph...")
|
||||
if obj.data.NoStreamWatch {
|
||||
pChan = nil
|
||||
} else {
|
||||
pChan = puppetChan() // TODO: okay to update interval in case it changed?
|
||||
}
|
||||
next := gapi.Next{
|
||||
//Exit: true, // TODO: for permanent shutdown!
|
||||
Err: nil,
|
||||
}
|
||||
select {
|
||||
case ch <- next: // trigger a run (send a msg)
|
||||
// unblock if we exit while waiting to send!
|
||||
case <-obj.closeChan:
|
||||
return
|
||||
}
|
||||
}
|
||||
}()
|
||||
return ch
|
||||
}
|
||||
|
||||
// Close shuts down the Puppet GAPI.
|
||||
func (obj *GAPI) Close() error {
|
||||
if !obj.initialized {
|
||||
return fmt.Errorf("%s: GAPI is not initialized", Name)
|
||||
}
|
||||
|
||||
if obj.puppetFile != "" {
|
||||
os.Remove(obj.puppetFile) // clean up, don't bother with error
|
||||
}
|
||||
// make this as safe as possible, check we're removing a tempdir too!
|
||||
if obj.puppetDir != "" && obj.puppetDir != "/" && strings.HasPrefix(obj.puppetDir, os.TempDir()) {
|
||||
os.RemoveAll(obj.puppetDir)
|
||||
}
|
||||
obj.puppetString = "" // free!
|
||||
if obj.puppetConf != "" {
|
||||
os.Remove(obj.puppetConf)
|
||||
}
|
||||
|
||||
close(obj.closeChan)
|
||||
obj.wg.Wait()
|
||||
obj.initialized = false // closed = true
|
||||
return nil
|
||||
}
|
||||
328
puppet/langpuppet/gapi.go
Normal file
328
puppet/langpuppet/gapi.go
Normal file
@@ -0,0 +1,328 @@
|
||||
// Mgmt
|
||||
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
||||
// Written by James Shubin <james@shubin.ca> and the project contributors
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
//
|
||||
// Additional permission under GNU GPL version 3 section 7
|
||||
//
|
||||
// If you modify this program, or any covered work, by linking or combining it
|
||||
// with embedded mcl code and modules (and that the embedded mcl code and
|
||||
// modules which link with this program, contain a copy of their source code in
|
||||
// the authoritative form) containing parts covered by the terms of any other
|
||||
// license, the licensors of this program grant you additional permission to
|
||||
// convey the resulting work. Furthermore, the licensors of this program grant
|
||||
// the original author, James Shubin, additional permission to update this
|
||||
// additional permission if he deems it necessary to achieve the goals of this
|
||||
// additional permission.
|
||||
|
||||
package langpuppet
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"sync"
|
||||
|
||||
cliUtil "github.com/purpleidea/mgmt/cli/util"
|
||||
"github.com/purpleidea/mgmt/gapi"
|
||||
lang "github.com/purpleidea/mgmt/lang/gapi"
|
||||
"github.com/purpleidea/mgmt/pgraph"
|
||||
"github.com/purpleidea/mgmt/puppet"
|
||||
"github.com/purpleidea/mgmt/util/errwrap"
|
||||
)
|
||||
|
||||
const (
|
||||
// Name is the name of this frontend.
|
||||
Name = "langpuppet"
|
||||
)
|
||||
|
||||
func init() {
|
||||
gapi.Register(Name, func() gapi.GAPI { return &GAPI{} }) // register
|
||||
}
|
||||
|
||||
// GAPI implements the main langpuppet GAPI interface. It wraps the Puppet and
|
||||
// Lang GAPIs and receives graphs from both. It then runs a merging algorithm
|
||||
// that mainly just makes a union of both the sets of vertices and edges. Some
|
||||
// vertices are merged using a naming convention. Details can be found in the
|
||||
// langpuppet.mergeGraphs function.
|
||||
type GAPI struct {
|
||||
// the wrapped lang entrypoint
|
||||
langGAPI gapi.GAPI
|
||||
// the wrapped puppet entrypoint
|
||||
puppetGAPI gapi.GAPI
|
||||
|
||||
// the most recent graph received from lang
|
||||
currentLangGraph *pgraph.Graph
|
||||
// the most recent graph received from puppet
|
||||
currentPuppetGraph *pgraph.Graph
|
||||
|
||||
// flag to indicate that a new graph from lang is ready
|
||||
langGraphReady bool
|
||||
// flag to indicate that a new graph from puppet is ready
|
||||
puppetGraphReady bool
|
||||
graphFlagMutex *sync.Mutex
|
||||
|
||||
data *gapi.Data
|
||||
initialized bool
|
||||
closeChan chan struct{}
|
||||
wg sync.WaitGroup // sync group for tunnel go routines
|
||||
}
|
||||
|
||||
// Cli takes an *Info struct, and returns our deploy if activated, and if there
|
||||
// are any validation problems, you should return an error. If there is no
|
||||
// deploy, then you should return a nil deploy and a nil error.
|
||||
func (obj *GAPI) Cli(info *gapi.Info) (*gapi.Deploy, error) {
|
||||
args, ok := info.Args.(*cliUtil.LangPuppetArgs)
|
||||
if !ok {
|
||||
// programming error
|
||||
return nil, fmt.Errorf("could not convert to our struct")
|
||||
}
|
||||
flags := info.Flags
|
||||
fs := info.Fs
|
||||
debug := info.Debug
|
||||
logf := info.Logf
|
||||
|
||||
langInfo := &gapi.Info{
|
||||
Args: &cliUtil.LangArgs{
|
||||
Input: args.LangInput,
|
||||
Download: args.Download,
|
||||
OnlyDownload: args.OnlyDownload,
|
||||
Update: args.Update,
|
||||
OnlyUnify: args.OnlyUnify,
|
||||
SkipUnify: args.SkipUnify,
|
||||
Depth: args.Depth,
|
||||
Retry: args.Retry,
|
||||
ModulePath: args.ModulePath,
|
||||
},
|
||||
Flags: flags,
|
||||
Fs: fs,
|
||||
Debug: debug,
|
||||
Logf: logf, // TODO: wrap logf?
|
||||
}
|
||||
puppetInfo := &gapi.Info{
|
||||
Args: &cliUtil.PuppetArgs{
|
||||
Input: args.PuppetInput,
|
||||
PuppetConf: args.PuppetConf,
|
||||
},
|
||||
Flags: flags,
|
||||
Fs: fs,
|
||||
Debug: debug,
|
||||
Logf: logf, // TODO: wrap logf?
|
||||
}
|
||||
|
||||
var langDeploy *gapi.Deploy
|
||||
var puppetDeploy *gapi.Deploy
|
||||
var err error
|
||||
|
||||
if langDeploy, err = (&lang.GAPI{}).Cli(langInfo); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if puppetDeploy, err = (&puppet.GAPI{}).Cli(puppetInfo); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &gapi.Deploy{
|
||||
Name: Name,
|
||||
Noop: info.Flags.Noop,
|
||||
Sema: info.Flags.Sema,
|
||||
GAPI: &GAPI{
|
||||
langGAPI: langDeploy.GAPI,
|
||||
puppetGAPI: puppetDeploy.GAPI,
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
||||
// Init initializes the langpuppet GAPI struct.
|
||||
func (obj *GAPI) Init(data *gapi.Data) error {
|
||||
if obj.initialized {
|
||||
return fmt.Errorf("already initialized")
|
||||
}
|
||||
obj.data = data // store for later
|
||||
obj.graphFlagMutex = &sync.Mutex{}
|
||||
|
||||
dataLang := &gapi.Data{
|
||||
Program: obj.data.Program,
|
||||
Version: obj.data.Version,
|
||||
Hostname: obj.data.Hostname,
|
||||
World: obj.data.World,
|
||||
Noop: obj.data.Noop,
|
||||
NoStreamWatch: obj.data.NoStreamWatch,
|
||||
Debug: obj.data.Debug,
|
||||
Logf: func(format string, v ...interface{}) {
|
||||
obj.data.Logf(lang.Name+": "+format, v...)
|
||||
},
|
||||
}
|
||||
dataPuppet := &gapi.Data{
|
||||
Program: obj.data.Program,
|
||||
Version: obj.data.Version,
|
||||
Hostname: obj.data.Hostname,
|
||||
World: obj.data.World,
|
||||
Noop: obj.data.Noop,
|
||||
NoStreamWatch: obj.data.NoStreamWatch,
|
||||
Debug: obj.data.Debug,
|
||||
Logf: func(format string, v ...interface{}) {
|
||||
obj.data.Logf(puppet.Name+": "+format, v...)
|
||||
},
|
||||
}
|
||||
|
||||
if err := obj.langGAPI.Init(dataLang); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := obj.puppetGAPI.Init(dataPuppet); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
obj.closeChan = make(chan struct{})
|
||||
obj.initialized = true
|
||||
return nil
|
||||
}
|
||||
|
||||
// Graph returns a current Graph.
|
||||
func (obj *GAPI) Graph() (*pgraph.Graph, error) {
|
||||
if !obj.initialized {
|
||||
return nil, fmt.Errorf("%s: GAPI is not initialized", Name)
|
||||
}
|
||||
|
||||
var err error
|
||||
obj.graphFlagMutex.Lock()
|
||||
if obj.langGraphReady {
|
||||
obj.langGraphReady = false
|
||||
obj.graphFlagMutex.Unlock()
|
||||
obj.currentLangGraph, err = obj.langGAPI.Graph()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
} else {
|
||||
obj.graphFlagMutex.Unlock()
|
||||
}
|
||||
|
||||
obj.graphFlagMutex.Lock()
|
||||
if obj.puppetGraphReady {
|
||||
obj.puppetGraphReady = false
|
||||
obj.graphFlagMutex.Unlock()
|
||||
obj.currentPuppetGraph, err = obj.puppetGAPI.Graph()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
} else {
|
||||
obj.graphFlagMutex.Unlock()
|
||||
}
|
||||
|
||||
g, err := mergeGraphs(obj.currentLangGraph, obj.currentPuppetGraph)
|
||||
|
||||
if obj.data.Debug {
|
||||
obj.currentLangGraph.Logf(func(format string, v ...interface{}) {
|
||||
obj.data.Logf("graph: "+lang.Name+": "+format, v...)
|
||||
})
|
||||
obj.currentPuppetGraph.Logf(func(format string, v ...interface{}) {
|
||||
obj.data.Logf("graph: "+puppet.Name+": "+format, v...)
|
||||
})
|
||||
if err == nil {
|
||||
g.Logf(func(format string, v ...interface{}) {
|
||||
obj.data.Logf("graph: "+Name+": "+format, v...)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
return g, err
|
||||
}
|
||||
|
||||
// Next returns nil errors every time there could be a new graph.
|
||||
func (obj *GAPI) Next() chan gapi.Next {
|
||||
ch := make(chan gapi.Next)
|
||||
obj.wg.Add(1)
|
||||
go func() {
|
||||
defer obj.wg.Done()
|
||||
defer close(ch) // this will run before the obj.wg.Done()
|
||||
if !obj.initialized {
|
||||
next := gapi.Next{
|
||||
Err: fmt.Errorf("%s: GAPI is not initialized", Name),
|
||||
Exit: true, // exit, b/c programming error?
|
||||
}
|
||||
ch <- next
|
||||
return
|
||||
}
|
||||
nextLang := obj.langGAPI.Next()
|
||||
nextPuppet := obj.puppetGAPI.Next()
|
||||
|
||||
firstLang := false
|
||||
firstPuppet := false
|
||||
|
||||
for {
|
||||
var err error
|
||||
exit := false
|
||||
select {
|
||||
case nextChild := <-nextLang:
|
||||
if nextChild.Err != nil {
|
||||
err = nextChild.Err
|
||||
exit = nextChild.Exit
|
||||
} else {
|
||||
obj.graphFlagMutex.Lock()
|
||||
obj.langGraphReady = true
|
||||
obj.graphFlagMutex.Unlock()
|
||||
firstLang = true
|
||||
}
|
||||
case nextChild := <-nextPuppet:
|
||||
if nextChild.Err != nil {
|
||||
err = nextChild.Err
|
||||
exit = nextChild.Exit
|
||||
} else {
|
||||
obj.graphFlagMutex.Lock()
|
||||
obj.puppetGraphReady = true
|
||||
obj.graphFlagMutex.Unlock()
|
||||
firstPuppet = true
|
||||
}
|
||||
case <-obj.closeChan:
|
||||
return
|
||||
}
|
||||
|
||||
if (!firstLang || !firstPuppet) && err == nil {
|
||||
continue
|
||||
}
|
||||
|
||||
if err == nil {
|
||||
obj.data.Logf("generating new composite graph...")
|
||||
}
|
||||
next := gapi.Next{
|
||||
Exit: exit,
|
||||
Err: err,
|
||||
}
|
||||
|
||||
select {
|
||||
case ch <- next: // trigger a run (send a msg)
|
||||
// unblock if we exit while waiting to send!
|
||||
case <-obj.closeChan:
|
||||
return
|
||||
}
|
||||
}
|
||||
}()
|
||||
return ch
|
||||
}
|
||||
|
||||
// Close shuts down the Puppet GAPI.
|
||||
func (obj *GAPI) Close() error {
|
||||
if !obj.initialized {
|
||||
return fmt.Errorf("%s: GAPI is not initialized", Name)
|
||||
}
|
||||
|
||||
var err error
|
||||
e1 := obj.langGAPI.Close()
|
||||
err = errwrap.Append(err, errwrap.Wrapf(e1, "closing lang GAPI failed"))
|
||||
|
||||
e2 := obj.puppetGAPI.Close()
|
||||
err = errwrap.Append(err, errwrap.Wrapf(e2, "closing Puppet GAPI failed"))
|
||||
|
||||
close(obj.closeChan)
|
||||
obj.initialized = false // closed = true
|
||||
return err
|
||||
}
|
||||
180
puppet/langpuppet/merge.go
Normal file
180
puppet/langpuppet/merge.go
Normal file
@@ -0,0 +1,180 @@
|
||||
// Mgmt
|
||||
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
||||
// Written by James Shubin <james@shubin.ca> and the project contributors
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
//
|
||||
// Additional permission under GNU GPL version 3 section 7
|
||||
//
|
||||
// If you modify this program, or any covered work, by linking or combining it
|
||||
// with embedded mcl code and modules (and that the embedded mcl code and
|
||||
// modules which link with this program, contain a copy of their source code in
|
||||
// the authoritative form) containing parts covered by the terms of any other
|
||||
// license, the licensors of this program grant you additional permission to
|
||||
// convey the resulting work. Furthermore, the licensors of this program grant
|
||||
// the original author, James Shubin, additional permission to update this
|
||||
// additional permission if he deems it necessary to achieve the goals of this
|
||||
// additional permission.
|
||||
|
||||
// Package langpuppet implements an integration entrypoint that combines lang
|
||||
// and Puppet.
|
||||
package langpuppet
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/purpleidea/mgmt/engine"
|
||||
"github.com/purpleidea/mgmt/pgraph"
|
||||
)
|
||||
|
||||
const (
|
||||
// MergePrefixLang is how a mergeable vertex name starts in mcl code.
|
||||
MergePrefixLang = "puppet_"
|
||||
// MergePrefixPuppet is how a mergeable Puppet class name starts.
|
||||
MergePrefixPuppet = "mgmt_"
|
||||
)
|
||||
|
||||
// mergeGraph returns the merged graph containing all vertices and edges found
|
||||
// in the graphs produced by the lang and Puppet GAPIs associated with the
|
||||
// wrapping GAPI. Vertices are merged if they adhere to the following rules (for
|
||||
// any given value of POSTFIX): (1) The graph from lang contains a noop vertex
|
||||
// named puppet_POSTFIX. (2) The graph from Puppet contains an empty class
|
||||
// mgmt_POSTFIX. (3) The resulting graph will contain one noop vertex named
|
||||
// POSTFIX that replaces all nodes mentioned in (1) and (2). All edges
|
||||
// connecting to any of the vertices merged this way will be present in the
|
||||
// merged graph.
|
||||
func mergeGraphs(graphFromLang, graphFromPuppet *pgraph.Graph) (*pgraph.Graph, error) {
|
||||
if graphFromLang == nil || graphFromPuppet == nil {
|
||||
return nil, fmt.Errorf("cannot merge graphs until both child graphs are loaded")
|
||||
}
|
||||
|
||||
result, err := pgraph.NewGraph(graphFromLang.Name + "+" + graphFromPuppet.Name)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
mergeTargets := make(map[string]pgraph.Vertex)
|
||||
|
||||
// first add all vertices from the lang graph
|
||||
for _, vertex := range graphFromLang.Vertices() {
|
||||
if strings.Index(vertex.String(), "noop["+MergePrefixLang) == 0 {
|
||||
resource, ok := vertex.(engine.Res)
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("vertex %s is not a named resource", vertex.String())
|
||||
}
|
||||
basename := strings.TrimPrefix(resource.Name(), MergePrefixLang)
|
||||
resource.SetName(basename)
|
||||
mergeTargets[basename] = vertex
|
||||
}
|
||||
result.AddVertex(vertex)
|
||||
for _, neighbor := range graphFromLang.OutgoingGraphVertices(vertex) {
|
||||
result.AddVertex(neighbor)
|
||||
result.AddEdge(vertex, neighbor, graphFromLang.FindEdge(vertex, neighbor))
|
||||
}
|
||||
}
|
||||
|
||||
var anchor pgraph.Vertex
|
||||
mergePairs := make(map[pgraph.Vertex]pgraph.Vertex)
|
||||
|
||||
// do a scan through the Puppet graph, and mark all vertices that will be
|
||||
// subject to a merge, so it will be easier do generate the new edges
|
||||
// in the final pass
|
||||
for _, vertex := range graphFromPuppet.Vertices() {
|
||||
if vertex.String() == "noop[admissible_Stage[main]]" {
|
||||
// we can start a depth first search here
|
||||
anchor = vertex
|
||||
continue
|
||||
}
|
||||
// at this stage we don't distinguis between class start and end
|
||||
if strings.Index(vertex.String(), "noop[admissible_Class["+strings.Title(MergePrefixPuppet)) != 0 &&
|
||||
strings.Index(vertex.String(), "noop[completed_Class["+strings.Title(MergePrefixPuppet)) != 0 {
|
||||
continue
|
||||
}
|
||||
|
||||
resource, ok := vertex.(engine.Res)
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("vertex %s is not a named resource", vertex.String())
|
||||
}
|
||||
// strip either prefix (plus the closing bracket)
|
||||
basename := strings.TrimSuffix(
|
||||
strings.TrimPrefix(
|
||||
strings.TrimPrefix(resource.Name(),
|
||||
"admissible_Class["+strings.Title(MergePrefixPuppet)),
|
||||
"completed_Class["+strings.Title(MergePrefixPuppet)),
|
||||
"]")
|
||||
|
||||
if _, found := mergeTargets[basename]; !found {
|
||||
// FIXME: should be a warning not an error?
|
||||
return nil, fmt.Errorf("puppet graph has unmatched class %s%s", MergePrefixPuppet, basename)
|
||||
}
|
||||
|
||||
mergePairs[vertex] = mergeTargets[basename]
|
||||
|
||||
if strings.Index(resource.Name(), "admissible_Class["+strings.Title(MergePrefixPuppet)) != 0 {
|
||||
continue
|
||||
}
|
||||
|
||||
// is there more than one edge outgoing from the class start?
|
||||
if graphFromPuppet.OutDegree()[vertex] > 1 {
|
||||
return nil, fmt.Errorf("class %s is not empty", basename)
|
||||
}
|
||||
|
||||
// does this edge not lead to the class end?
|
||||
next := graphFromPuppet.OutgoingGraphVertices(vertex)[0]
|
||||
if next.String() != "noop[completed_Class["+strings.Title(MergePrefixPuppet)+basename+"]]" {
|
||||
return nil, fmt.Errorf("class %s%s is not empty, start is followed by %s", MergePrefixPuppet, basename, next.String())
|
||||
}
|
||||
}
|
||||
|
||||
merged := make(map[pgraph.Vertex]bool)
|
||||
result.AddVertex(anchor)
|
||||
// traverse the puppet graph, add all vertices and perform merges
|
||||
// using DFS so we can be sure the "admissible" is visited before the "completed" vertex
|
||||
for _, vertex := range graphFromPuppet.DFS(anchor) {
|
||||
source := vertex
|
||||
|
||||
// when adding edges, the source might be a different vertex
|
||||
// than the current one, if this is a merged vertex
|
||||
if _, found := mergePairs[vertex]; found {
|
||||
source = mergePairs[vertex]
|
||||
}
|
||||
|
||||
// the current vertex has been added by previous iterations,
|
||||
// we only add neighbors here
|
||||
for _, neighbor := range graphFromPuppet.OutgoingGraphVertices(vertex) {
|
||||
if strings.Index(neighbor.String(), "noop[admissible_Class["+strings.Title(MergePrefixPuppet)) == 0 {
|
||||
result.AddEdge(source, mergePairs[neighbor], graphFromPuppet.FindEdge(vertex, neighbor))
|
||||
continue
|
||||
}
|
||||
if strings.Index(neighbor.String(), "noop[completed_Class["+strings.Title(MergePrefixPuppet)) == 0 {
|
||||
// mark target vertex as merged
|
||||
merged[mergePairs[neighbor]] = true
|
||||
continue
|
||||
}
|
||||
// if we reach here, this neighbor is a regular vertex
|
||||
result.AddVertex(neighbor)
|
||||
result.AddEdge(source, neighbor, graphFromPuppet.FindEdge(vertex, neighbor))
|
||||
}
|
||||
}
|
||||
|
||||
for _, vertex := range mergeTargets {
|
||||
if !merged[vertex] {
|
||||
// FIXME: should be a warning not an error?
|
||||
return nil, fmt.Errorf("lang graph has unmatched %s", vertex.String())
|
||||
}
|
||||
}
|
||||
|
||||
return result, nil
|
||||
}
|
||||
160
puppet/puppet.go
Normal file
160
puppet/puppet.go
Normal file
@@ -0,0 +1,160 @@
|
||||
// Mgmt
|
||||
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
||||
// Written by James Shubin <james@shubin.ca> and the project contributors
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
//
|
||||
// Additional permission under GNU GPL version 3 section 7
|
||||
//
|
||||
// If you modify this program, or any covered work, by linking or combining it
|
||||
// with embedded mcl code and modules (and that the embedded mcl code and
|
||||
// modules which link with this program, contain a copy of their source code in
|
||||
// the authoritative form) containing parts covered by the terms of any other
|
||||
// license, the licensors of this program grant you additional permission to
|
||||
// convey the resulting work. Furthermore, the licensors of this program grant
|
||||
// the original author, James Shubin, additional permission to update this
|
||||
// additional permission if he deems it necessary to achieve the goals of this
|
||||
// additional permission.
|
||||
|
||||
// Package puppet provides the integration entrypoint for the puppet language.
|
||||
package puppet
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"io"
|
||||
"os/exec"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/purpleidea/mgmt/util/errwrap"
|
||||
"github.com/purpleidea/mgmt/yamlgraph"
|
||||
)
|
||||
|
||||
const (
|
||||
// PuppetYAMLBufferSize is the maximum buffer size for the yaml input data
|
||||
PuppetYAMLBufferSize = 65535
|
||||
)
|
||||
|
||||
func (obj *GAPI) runPuppetCommand(cmd *exec.Cmd) ([]byte, error) {
|
||||
if obj.data.Debug {
|
||||
obj.data.Logf("running command: %v", cmd)
|
||||
}
|
||||
|
||||
stdout, err := cmd.StdoutPipe()
|
||||
if err != nil {
|
||||
return nil, errwrap.Wrapf(err, "error opening pipe to puppet command")
|
||||
}
|
||||
stderr, err := cmd.StderrPipe()
|
||||
if err != nil {
|
||||
return nil, errwrap.Wrapf(err, "error opening error pipe to puppet command")
|
||||
}
|
||||
|
||||
if err := cmd.Start(); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "error starting puppet command")
|
||||
}
|
||||
|
||||
// XXX: the current implementation is likely prone to fail
|
||||
// as soon as the YAML data overflows the buffer.
|
||||
data := make([]byte, PuppetYAMLBufferSize)
|
||||
var result []byte
|
||||
for err == nil {
|
||||
var count int
|
||||
count, err = stdout.Read(data)
|
||||
if err != nil && err != io.EOF {
|
||||
obj.data.Logf("error reading YAML data from puppet: %v", err)
|
||||
return nil, err
|
||||
}
|
||||
// Slicing down to the number of actual bytes is important, the YAML parser
|
||||
// will choke on an oversized slice. http://stackoverflow.com/a/33726617/3356612
|
||||
result = append(result, data[0:count]...)
|
||||
}
|
||||
if obj.data.Debug {
|
||||
obj.data.Logf("read %d bytes of data from puppet", len(result))
|
||||
}
|
||||
for scanner := bufio.NewScanner(stderr); scanner.Scan(); {
|
||||
obj.data.Logf("(output) %v", scanner.Text())
|
||||
}
|
||||
if err := cmd.Wait(); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "error waiting for puppet command to complete")
|
||||
}
|
||||
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// ParseConfigFromPuppet returns the graph configuration structure from the mode
|
||||
// and input values, including possibly some file and directory paths.
|
||||
func (obj *GAPI) ParseConfigFromPuppet() (*yamlgraph.GraphConfig, error) {
|
||||
var args []string
|
||||
switch obj.Mode {
|
||||
case "agent":
|
||||
args = []string{"mgmtgraph", "print"}
|
||||
case "file":
|
||||
args = []string{"mgmtgraph", "print", "--manifest", obj.puppetFile}
|
||||
case "string":
|
||||
args = []string{"mgmtgraph", "print", "--code", obj.puppetString}
|
||||
case "dir":
|
||||
// TODO: run the code from the obj.puppetDir directory path
|
||||
return nil, fmt.Errorf("not implemented") // XXX: not implemented
|
||||
default:
|
||||
panic(fmt.Sprintf("%s: unhandled case: %s", Name, obj.Mode))
|
||||
}
|
||||
|
||||
if obj.puppetConf != "" {
|
||||
args = append(args, "--config="+obj.puppetConf)
|
||||
}
|
||||
|
||||
cmd := exec.Command("puppet", args...)
|
||||
|
||||
obj.data.Logf("launching translator")
|
||||
|
||||
var config yamlgraph.GraphConfig
|
||||
if data, err := obj.runPuppetCommand(cmd); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "could not run puppet command")
|
||||
} else if err := config.Parse(data); err != nil {
|
||||
return nil, errwrap.Wrapf(err, "could not parse YAML output")
|
||||
}
|
||||
|
||||
return &config, nil
|
||||
}
|
||||
|
||||
// refreshInterval returns the graph refresh interval from the puppet
|
||||
// configuration.
|
||||
func (obj *GAPI) refreshInterval() int {
|
||||
if obj.data.Debug {
|
||||
obj.data.Logf("determining graph refresh interval")
|
||||
}
|
||||
var cmd *exec.Cmd
|
||||
if obj.puppetConf != "" {
|
||||
cmd = exec.Command("puppet", "config", "print", "runinterval", "--config", obj.puppetConf)
|
||||
} else {
|
||||
cmd = exec.Command("puppet", "config", "print", "runinterval")
|
||||
}
|
||||
|
||||
obj.data.Logf("inspecting runinterval configuration")
|
||||
|
||||
interval := 1800
|
||||
data, err := obj.runPuppetCommand(cmd)
|
||||
if err != nil {
|
||||
obj.data.Logf("could not determine configured run interval (%v), using default of %v", err, interval)
|
||||
return interval
|
||||
}
|
||||
result, err := strconv.ParseInt(strings.TrimSpace(string(data)), 10, 0)
|
||||
if err != nil {
|
||||
obj.data.Logf("error reading numeric runinterval value (%v), using default of %v", err, interval)
|
||||
return interval
|
||||
}
|
||||
|
||||
return int(result)
|
||||
}
|
||||
Reference in New Issue
Block a user