8 Commits

Author SHA1 Message Date
Lourenço Vales
8b30f7bd3d everything is implemented, now on to testing 2025-10-03 15:00:35 +02:00
Lourenço Vales
d304dafeea added partial cloudflare api integration 2025-10-03 09:29:32 +02:00
Lourenço Vales
9271906435 added cmp function 2025-10-03 09:29:32 +02:00
Lourenço Vales
7146139ae8 added CheckApply function; made some changes to structure 2025-10-03 09:29:32 +02:00
Lourenço Vales
ef74ede862 engine: resources: Add Cloudflare DNS resource 2025-10-03 09:29:32 +02:00
James Shubin
56e55dfad7 engine: resources: Sysctl was missing the errors 2025-10-03 01:34:26 -04:00
James Shubin
303e80dee7 engine, lang, lib, pgraph: Plumb through more ctx 2025-10-02 23:28:51 -04:00
James Shubin
6c6c9df75e engine: resources: Add a nif command and make it clearer
Let's have the opposite, and have an example so you don't forget which
is which.
2025-10-02 20:48:36 -04:00
14 changed files with 338 additions and 70 deletions

View File

@@ -38,6 +38,8 @@ import (
"github.com/purpleidea/mgmt/util/errwrap" "github.com/purpleidea/mgmt/util/errwrap"
"github.com/cloudflare/cloudflare-go/v6" "github.com/cloudflare/cloudflare-go/v6"
"github.com/cloudflare/cloudflare-go/v6/dns"
"github.com/cloudflare/cloudflare-go/v6/option"
"github.com/cloudflare/cloudflare-go/v6/zones" "github.com/cloudflare/cloudflare-go/v6/zones"
) )
@@ -48,6 +50,7 @@ func init() {
// TODO: description of cloudflare_dns resource // TODO: description of cloudflare_dns resource
type CloudflareDNSRes struct { type CloudflareDNSRes struct {
traits.Base traits.Base
traits.GraphQueryable
init *engine.Init init *engine.Init
APIToken string `lang:"apitoken"` APIToken string `lang:"apitoken"`
@@ -62,7 +65,7 @@ type CloudflareDNSRes struct {
// using a *bool here to help with disambiguating nil values // using a *bool here to help with disambiguating nil values
Proxied *bool `lang:"proxied"` Proxied *bool `lang:"proxied"`
Purged bool `lang:"purged"` Purge bool `lang:"purge"`
RecordName string `lang:"record_name"` RecordName string `lang:"record_name"`
@@ -129,20 +132,20 @@ func (obj *CloudflareDNSRes) Init(init *engine.Init) error {
) )
//TODO: does it make more sense to check it here or in CheckApply()? //TODO: does it make more sense to check it here or in CheckApply()?
//zoneListParams := zones.ZoneListParams{ zoneListParams := zones.ZoneListParams{
// name: cloudflare.F(obj.Zone), Name: cloudflare.F(obj.Zone),
//} }
//zoneList, err := obj.client.Zones.List(context.Background(), zoneListParams) zoneList, err := obj.client.Zones.List(context.Background(), zoneListParams)
//if err != nil { if err != nil {
// return errwrap.Wrapf(err, "failed to list zones") return errwrap.Wrapf(err, "failed to list zones")
//} }
//if len(zoneList.Result) == 0 { if len(zoneList.Result) == 0 {
// return fmt.Errorf("zone %s not found", obj.Zone) return fmt.Errorf("zone %s not found", obj.Zone)
//} }
obj.zoneID = zoneList.Results[0].ID obj.zoneID = zoneList.Result[0].ID
return nil return nil
} }
@@ -162,10 +165,10 @@ func (obj *CloudflareDNSRes) Watch(context.Context) error {
func (obj *CloudflareDNSRes) CheckApply(ctx context.Context, apply bool) (bool, error) { func (obj *CloudflareDNSRes) CheckApply(ctx context.Context, apply bool) (bool, error) {
zone, err := obj.client.Zones.List(ctx, zones.ZoneListParams{ zone, err := obj.client.Zones.List(ctx, zones.ZoneListParams{
RecordName: cloudflare.F(obj.Zone), Name: cloudflare.F(obj.Zone),
}) })
if err != nil { if err != nil {
return false, fmt.Errorf(err) return false, err
} }
if len(zone.Result) == 0 { if len(zone.Result) == 0 {
@@ -190,7 +193,9 @@ func (obj *CloudflareDNSRes) CheckApply(ctx context.Context, apply bool) (bool,
// List existing records // List existing records
listParams := dns.RecordListParams{ listParams := dns.RecordListParams{
ZoneID: cloudflare.F(obj.zoneID), ZoneID: cloudflare.F(obj.zoneID),
Name: cloudflare.F(obj.RecordName), Name: cloudflare.F(dns.RecordListParamsName{
Exact: cloudflare.F(obj.RecordName), // this matches the exact name
}),
Type: cloudflare.F(dns.RecordListParamsType(obj.Type)), Type: cloudflare.F(dns.RecordListParamsType(obj.Type)),
} }
@@ -199,8 +204,8 @@ func (obj *CloudflareDNSRes) CheckApply(ctx context.Context, apply bool) (bool,
return false, errwrap.Wrapf(err, "failed to list DNS records") return false, errwrap.Wrapf(err, "failed to list DNS records")
} }
recordExists := len(records.Result) > 0 recordExists := len(recordList.Result) > 0
var record dns.Record var record dns.RecordResponse
if recordExists { if recordExists {
record = recordList.Result[0] record = recordList.Result[0]
} }
@@ -240,7 +245,7 @@ func (obj *CloudflareDNSRes) CheckApply(ctx context.Context, apply bool) (bool,
ZoneID: cloudflare.F(obj.zoneID), ZoneID: cloudflare.F(obj.zoneID),
} }
_, err := obj.client.DNS.Reords.Delete(ctx, record.ID, deleteParams) _, err := obj.client.DNS.Records.Delete(ctx, record.ID, deleteParams)
if err != nil { if err != nil {
return false, errwrap.Wrapf(err, "failed to delete DNS record") return false, errwrap.Wrapf(err, "failed to delete DNS record")
} }
@@ -278,7 +283,7 @@ func (obj *CloudflareDNSRes) Cmp(r engine.Res) error {
return fmt.Errorf("record name differs") return fmt.Errorf("record name differs")
} }
if obj.Purged != res.Purged { if obj.Purge != res.Purge {
return fmt.Errorf("purge value differs") return fmt.Errorf("purge value differs")
} }
@@ -314,7 +319,8 @@ func (obj *CloudflareDNSRes) Cmp(r engine.Res) error {
return nil return nil
} }
func (obj *CloudflareDNSRes) buildRecordParam() dns.RecordNewParamsBodyUnion { // TODO: double check the fields for each record, might have missed some
func (obj *CloudflareDNSRes) buildRecordParam() (any, error) {
ttl := dns.TTL(obj.TTL) ttl := dns.TTL(obj.TTL)
switch obj.Type { switch obj.Type {
@@ -331,7 +337,7 @@ func (obj *CloudflareDNSRes) buildRecordParam() dns.RecordNewParamsBodyUnion {
if obj.Comment != "" { if obj.Comment != "" {
param.Comment = cloudflare.F(obj.Comment) param.Comment = cloudflare.F(obj.Comment)
} }
return param return param, nil
case "AAAA": case "AAAA":
param := dns.AAAARecordParam{ param := dns.AAAARecordParam{
@@ -346,7 +352,7 @@ func (obj *CloudflareDNSRes) buildRecordParam() dns.RecordNewParamsBodyUnion {
if obj.Comment != "" { if obj.Comment != "" {
param.Comment = cloudflare.F(obj.Comment) param.Comment = cloudflare.F(obj.Comment)
} }
return param return param, nil
case "CNAME": case "CNAME":
param := dns.CNAMERecordParam{ param := dns.CNAMERecordParam{
@@ -361,7 +367,7 @@ func (obj *CloudflareDNSRes) buildRecordParam() dns.RecordNewParamsBodyUnion {
if obj.Comment != "" { if obj.Comment != "" {
param.Comment = cloudflare.F(obj.Comment) param.Comment = cloudflare.F(obj.Comment)
} }
return param return param, nil
case "MX": case "MX":
param := dns.MXRecordParam{ param := dns.MXRecordParam{
@@ -374,12 +380,12 @@ func (obj *CloudflareDNSRes) buildRecordParam() dns.RecordNewParamsBodyUnion {
param.Proxied = cloudflare.F(*obj.Proxied) param.Proxied = cloudflare.F(*obj.Proxied)
} }
if obj.Priority != nil { // required for MX record if obj.Priority != nil { // required for MX record
param.Priority = cloudflare.F(*obj.Priority) param.Priority = cloudflare.F(float64(*obj.Priority))
} }
if obj.Comment != "" { if obj.Comment != "" {
param.Comment = cloudflare.F(obj.Comment) param.Comment = cloudflare.F(obj.Comment)
} }
return param return param, nil
case "TXT": case "TXT":
param := dns.TXTRecordParam{ param := dns.TXTRecordParam{
@@ -394,7 +400,7 @@ func (obj *CloudflareDNSRes) buildRecordParam() dns.RecordNewParamsBodyUnion {
if obj.Comment != "" { if obj.Comment != "" {
param.Comment = cloudflare.F(obj.Comment) param.Comment = cloudflare.F(obj.Comment)
} }
return param return param, nil
case "NS": case "NS":
param := dns.NSRecordParam{ param := dns.NSRecordParam{
@@ -409,25 +415,21 @@ func (obj *CloudflareDNSRes) buildRecordParam() dns.RecordNewParamsBodyUnion {
if obj.Comment != "" { if obj.Comment != "" {
param.Comment = cloudflare.F(obj.Comment) param.Comment = cloudflare.F(obj.Comment)
} }
return param return param, nil
case "SRV": case "SRV":
param := dns.SRVRecordParam{ param := dns.SRVRecordParam{
Name: cloudflare.F(obj.RecordName), Name: cloudflare.F(obj.RecordName),
Type: cloudflare.F(dns.SRVRecordTypeSRV), Type: cloudflare.F(dns.SRVRecordTypeSRV),
Content: cloudflare.F(obj.Content),
TTL: cloudflare.F(ttl), TTL: cloudflare.F(ttl),
} }
if obj.Proxied != nil { if obj.Proxied != nil {
param.Proxied = cloudflare.F(*obj.Proxied) param.Proxied = cloudflare.F(*obj.Proxied)
} }
if obj.Priority != nil {
param.Priority = cloudflare.F(*obj.Priority)
}
if obj.Comment != "" { if obj.Comment != "" {
param.Comment = cloudflare.F(obj.Comment) param.Comment = cloudflare.F(obj.Comment)
} }
return param return param, nil
case "PTR": case "PTR":
param := dns.PTRRecordParam{ param := dns.PTRRecordParam{
@@ -442,22 +444,46 @@ func (obj *CloudflareDNSRes) buildRecordParam() dns.RecordNewParamsBodyUnion {
if obj.Comment != "" { if obj.Comment != "" {
param.Comment = cloudflare.F(obj.Comment) param.Comment = cloudflare.F(obj.Comment)
} }
return param return param, nil
default: // we should return something else here, need to investigate default:
return nil, fmt.Errorf("record type %s is not supported", obj.Type)
} }
} }
// buildNewRecordParam creates the appropriate record parameter for creating
// records.
func (obj *CloudflareDNSRes) buildNewRecordParam() (dns.RecordNewParamsBodyUnion, error) {
result, err := obj.buildRecordParam()
if err != nil {
return nil, err
}
return result.(dns.RecordNewParamsBodyUnion), nil
}
// buildEditRecordParam creates the appropriate record parameter for editing
// records.
func (obj *CloudflareDNSRes) buildEditRecordParam() (dns.RecordEditParamsBodyUnion, error) {
result, err := obj.buildRecordParam()
if err != nil {
return nil, err
}
return result.(dns.RecordEditParamsBodyUnion), nil
}
func (obj *CloudflareDNSRes) createRecord(ctx context.Context) error { func (obj *CloudflareDNSRes) createRecord(ctx context.Context) error {
recordParams := obj.buildRecordParam() recordParams, err := obj.buildNewRecordParam()
if err != nil {
return err
}
createParams := dns.RecordNewParams{ createParams := dns.RecordNewParams{
ZoneID: cloudflare.F(obj.zoneID), ZoneID: cloudflare.F(obj.zoneID),
Body: recordParams, Body: recordParams,
} }
_, err := obj.client.DNS.Records.New(ctx, createParams) _, err = obj.client.DNS.Records.New(ctx, createParams)
if err != nil { if err != nil {
return errwrap.Wrapf(err, "failed to create dns record") return errwrap.Wrapf(err, "failed to create dns record")
} }
@@ -466,14 +492,17 @@ func (obj *CloudflareDNSRes) createRecord(ctx context.Context) error {
} }
func (obj *CloudflareDNSRes) updateRecord(ctx context.Context, recordID string) error { func (obj *CloudflareDNSRes) updateRecord(ctx context.Context, recordID string) error {
recordParams := obj.buildRecordParam() recordParams, err := obj.buildEditRecordParam()
if err != nil {
return err
}
editParams := dns.RecordEditParams{ editParams := dns.RecordEditParams{
ZoneID: cloudflare.F(obj.zoneID), ZoneID: cloudflare.F(obj.zoneID),
Body: recordParams, Body: recordParams,
} }
_, err := obj.client.DNS.Records.Edit(ctx, recordID, editParams) _, err = obj.client.DNS.Records.Edit(ctx, recordID, editParams)
if err != nil { if err != nil {
return errwrap.Wrapf(err, "failed to update dns record") return errwrap.Wrapf(err, "failed to update dns record")
} }
@@ -481,7 +510,7 @@ func (obj *CloudflareDNSRes) updateRecord(ctx context.Context, recordID string)
return nil return nil
} }
func (obj *CloudflareDNSRes) needsUpdate(record dns.Record) bool { func (obj *CloudflareDNSRes) needsUpdate(record dns.RecordResponse) bool {
if obj.Content != record.Content { if obj.Content != record.Content {
return true return true
} }
@@ -490,14 +519,14 @@ func (obj *CloudflareDNSRes) needsUpdate(record dns.Record) bool {
return true return true
} }
if obj.Proxied != nil && record.Proxied != nil { if obj.Proxied != nil {
if *obj.Proxied != *record.Proxied { if *obj.Proxied != record.Proxied {
return true return true
} }
} }
if obj.Priority != nil && record.Priority != nil { if obj.Priority != nil {
if *obj.Priority != *record.Priority { if float64(*obj.Priority) != record.Priority {
return true return true
} }
} }
@@ -509,4 +538,87 @@ func (obj *CloudflareDNSRes) needsUpdate(record dns.Record) bool {
// TODO add more checks? // TODO add more checks?
return false return false
}
func (obj *CloudflareDNSRes) purgeCheckApply(ctx context.Context, apply bool) (bool, error) {
listParams := dns.RecordListParams{
ZoneID: cloudflare.F(obj.zoneID),
}
iter := obj.client.DNS.Records.ListAutoPaging(ctx, listParams)
allRecords := []dns.RecordResponse{}
for iter.Next() {
allRecords = append(allRecords, iter.Current())
}
if err := iter.Err(); err != nil {
return false, errwrap.Wrapf(err, "failed to list dns records for purge")
}
excludes := make(map[string]bool)
graph, err := obj.init.FilteredGraph()
if err != nil {
return false, errwrap.Wrapf(err, "can't read the filtered graph")
}
for _, vertex := range graph.Vertices() {
res, ok := vertex.(engine.Res)
if !ok {
return false, fmt.Errorf("not a resource")
}
if res.Kind() != "cloudflare:dns" {
continue // we only want cloudflare dns resources
}
if res.Name() == obj.Name() {
continue // skip self
}
cfRes, ok := res.(*CloudflareDNSRes)
if !ok {
return false, fmt.Errorf("wrong resource type")
}
if cfRes.Zone == obj.Zone {
recordKey := fmt.Sprintf("%s:%s", cfRes.RecordName, cfRes.Type)
excludes[recordKey] = true
}
}
checkOK := true
for _, record := range allRecords {
recordKey := fmt.Sprintf("%s:%s", record.Name, record.Type)
if excludes[recordKey] {
continue
}
if apply {
deleteParams := dns.RecordDeleteParams{
ZoneID: cloudflare.F(obj.zoneID),
}
_, err := obj.client.DNS.Records.Delete(ctx, record.ID, deleteParams)
if err != nil {
return false, errwrap.Wrapf(err, "failed to purge %s", recordKey)
}
} else {
checkOK = false
}
}
return checkOK, nil
}
// GraphQueryAllowed returns nil if you're allowed to query the graph. This
// function accepts information about the requesting resource so we can
// determine the access with some form of fine-grained control.
func (obj *CloudflareDNSRes) GraphQueryAllowed(opts ...engine.GraphQueryableOption) error {
options := &engine.GraphQueryableOptions{} // default options
options.Apply(opts...) // apply the options
if options.Kind != "cloudflare:dns" {
return fmt.Errorf("only other cloudflare dns resources can access this info")
}
return nil
} }

View File

@@ -127,9 +127,9 @@ type ExecRes struct {
WatchShell string `lang:"watchshell" yaml:"watchshell"` WatchShell string `lang:"watchshell" yaml:"watchshell"`
// IfCmd is the command that runs to guard against running the Cmd. If // IfCmd is the command that runs to guard against running the Cmd. If
// this command succeeds, then Cmd *will* be run. If this command // this command succeeds, then Cmd *will not* be blocked from running.
// returns a non-zero result, then the Cmd will not be run. Any error // If this command returns a non-zero result, then the Cmd will not be
// scenario or timeout will cause the resource to error. // run. Any error scenario or timeout will cause the resource to error.
IfCmd string `lang:"ifcmd" yaml:"ifcmd"` IfCmd string `lang:"ifcmd" yaml:"ifcmd"`
// IfCwd is the Cwd for the IfCmd. See the docs for Cwd. // IfCwd is the Cwd for the IfCmd. See the docs for Cwd.
@@ -145,6 +145,19 @@ type ExecRes struct {
// does!) // does!)
IfEquals *string `lang:"ifequals" yaml:"ifequals"` IfEquals *string `lang:"ifequals" yaml:"ifequals"`
// NIfCmd is the command that runs to guard against running the Cmd. If
// this command succeeds, then Cmd *will* be blocked from running. If
// this command returns a non-zero result, then the Cmd will be allowed
// to run if not blocked by anything else. This is the opposite of the
// IfCmd.
NIfCmd string `lang:"nifcmd" yaml:"nifcmd"`
// NIfCwd is the Cwd for the NIfCmd. See the docs for Cwd.
NIfCwd string `lang:"nifcwd" yaml:"nifcwd"`
// NIfShell is the Shell for the NIfCmd. See the docs for Shell.
NIfShell string `lang:"nifshell" yaml:"nifshell"`
// Creates is the absolute file path to check for before running the // Creates is the absolute file path to check for before running the
// main cmd. If this path exists, then the cmd will not run. More // main cmd. If this path exists, then the cmd will not run. More
// precisely we attempt to `stat` the file, so it must succeed for a // precisely we attempt to `stat` the file, so it must succeed for a
@@ -469,7 +482,7 @@ func (obj *ExecRes) CheckApply(ctx context.Context, apply bool) (bool, error) {
cmdName = obj.IfShell // usually bash, or sh cmdName = obj.IfShell // usually bash, or sh
cmdArgs = []string{"-c", obj.IfCmd} cmdArgs = []string{"-c", obj.IfCmd}
} }
cmd := exec.Command(cmdName, cmdArgs...) cmd := exec.CommandContext(ctx, cmdName, cmdArgs...)
cmd.Dir = obj.IfCwd // run program in pwd if "" cmd.Dir = obj.IfCwd // run program in pwd if ""
// ignore signals sent to parent process (we're in our own group) // ignore signals sent to parent process (we're in our own group)
cmd.SysProcAttr = &syscall.SysProcAttr{ cmd.SysProcAttr = &syscall.SysProcAttr{
@@ -535,6 +548,93 @@ func (obj *ExecRes) CheckApply(ctx context.Context, apply bool) (bool, error) {
} }
} }
if obj.NIfCmd != "" { // opposite of the ifcmd check
var cmdName string
var cmdArgs []string
if obj.NIfShell == "" {
// call without a shell
// FIXME: are there still whitespace splitting issues?
split := strings.Fields(obj.NIfCmd)
cmdName = split[0]
//d, _ := os.Getwd() // TODO: how does this ever error ?
//cmdName = path.Join(d, cmdName)
cmdArgs = split[1:]
} else {
cmdName = obj.NIfShell // usually bash, or sh
cmdArgs = []string{"-c", obj.NIfCmd}
}
cmd := exec.CommandContext(ctx, cmdName, cmdArgs...)
cmd.Dir = obj.NIfCwd // run program in pwd if ""
// ignore signals sent to parent process (we're in our own group)
cmd.SysProcAttr = &syscall.SysProcAttr{
Setpgid: true,
Pgid: 0,
}
// if we have an user and group, use them
var err error
if cmd.SysProcAttr.Credential, err = obj.getCredential(); err != nil {
return false, errwrap.Wrapf(err, "error while setting credential")
}
var out splitWriter
out.Init()
cmd.Stdout = out.Stdout
cmd.Stderr = out.Stderr
err = cmd.Run()
if err == nil {
obj.init.Logf("nifcmd: %s", strings.Join(cmd.Args, " "))
obj.init.Logf("nifcmd exited with: %d, skipping cmd", 0)
s := out.String()
if s == "" {
obj.init.Logf("nifcmd out empty!")
} else {
obj.init.Logf("nifcmd out:")
obj.init.Logf("%s", s)
}
//if err := obj.checkApplyWriteCache(); err != nil {
// return false, err
//}
obj.safety()
if err := obj.send(); err != nil {
return false, err
}
return true, nil // don't run
}
exitErr, ok := err.(*exec.ExitError) // embeds an os.ProcessState
if !ok {
// command failed in some bad way
return false, errwrap.Wrapf(err, "nifcmd failed in some bad way")
}
pStateSys := exitErr.Sys() // (*os.ProcessState) Sys
wStatus, ok := pStateSys.(syscall.WaitStatus)
if !ok {
return false, errwrap.Wrapf(err, "could not get exit status of nifcmd")
}
exitStatus := wStatus.ExitStatus()
if exitStatus == 0 {
// i'm not sure if this could happen
return false, errwrap.Wrapf(err, "unexpected nifcmd exit status of zero")
}
obj.init.Logf("nifcmd: %s", strings.Join(cmd.Args, " "))
obj.init.Logf("nifcmd exited with: %d, not skipping cmd", exitStatus)
if s := out.String(); s == "" {
obj.init.Logf("nifcmd out empty!")
} else {
obj.init.Logf("nifcmd out:")
obj.init.Logf("%s", s)
}
//if obj.NIfEquals != nil && *obj.NIfEquals == s {
// obj.init.Logf("nifequals matched")
// return true, nil // don't run
//}
}
if obj.Creates != "" { // gate the extra syscall if obj.Creates != "" { // gate the extra syscall
if _, err := os.Stat(obj.Creates); err == nil { if _, err := os.Stat(obj.Creates); err == nil {
obj.init.Logf("creates file exists, skipping cmd") obj.init.Logf("creates file exists, skipping cmd")
@@ -717,7 +817,7 @@ func (obj *ExecRes) CheckApply(ctx context.Context, apply bool) (bool, error) {
cmdName = obj.DoneShell // usually bash, or sh cmdName = obj.DoneShell // usually bash, or sh
cmdArgs = []string{"-c", obj.DoneCmd} cmdArgs = []string{"-c", obj.DoneCmd}
} }
cmd := exec.Command(cmdName, cmdArgs...) cmd := exec.CommandContext(ctx, cmdName, cmdArgs...)
cmd.Dir = obj.DoneCwd // run program in pwd if "" cmd.Dir = obj.DoneCwd // run program in pwd if ""
// ignore signals sent to parent process (we're in our own group) // ignore signals sent to parent process (we're in our own group)
cmd.SysProcAttr = &syscall.SysProcAttr{ cmd.SysProcAttr = &syscall.SysProcAttr{
@@ -910,6 +1010,16 @@ func (obj *ExecRes) Cmp(r engine.Res) error {
return errwrap.Wrapf(err, "the IfEquals differs") return errwrap.Wrapf(err, "the IfEquals differs")
} }
if obj.NIfCmd != res.NIfCmd {
return fmt.Errorf("the NIfCmd differs")
}
if obj.NIfCwd != res.NIfCwd {
return fmt.Errorf("the NIfCwd differs")
}
if obj.NIfShell != res.NIfShell {
return fmt.Errorf("the NIfShell differs")
}
if obj.Creates != res.Creates { if obj.Creates != res.Creates {
return fmt.Errorf("the Creates differs") return fmt.Errorf("the Creates differs")
} }
@@ -956,6 +1066,7 @@ type ExecUID struct {
Cmd string Cmd string
WatchCmd string WatchCmd string
IfCmd string IfCmd string
NIfCmd string
DoneCmd string DoneCmd string
// TODO: add more elements here // TODO: add more elements here
} }
@@ -1046,6 +1157,7 @@ func (obj *ExecRes) UIDs() []engine.ResUID {
Cmd: obj.getCmd(), Cmd: obj.getCmd(),
WatchCmd: obj.WatchCmd, WatchCmd: obj.WatchCmd,
IfCmd: obj.IfCmd, IfCmd: obj.IfCmd,
NIfCmd: obj.NIfCmd,
DoneCmd: obj.DoneCmd, DoneCmd: obj.DoneCmd,
// TODO: add more params here // TODO: add more params here
} }
@@ -1140,6 +1252,11 @@ func (obj *ExecRes) cmdFiles() []string {
} else if sp := strings.Fields(obj.IfCmd); len(sp) > 0 { } else if sp := strings.Fields(obj.IfCmd); len(sp) > 0 {
paths = append(paths, sp[0]) paths = append(paths, sp[0])
} }
if obj.NIfShell != "" {
paths = append(paths, obj.NIfShell)
} else if sp := strings.Fields(obj.NIfCmd); len(sp) > 0 {
paths = append(paths, sp[0])
}
if obj.DoneShell != "" { if obj.DoneShell != "" {
paths = append(paths, obj.DoneShell) paths = append(paths, obj.DoneShell)
} else if sp := strings.Fields(obj.DoneCmd); len(sp) > 0 { } else if sp := strings.Fields(obj.DoneCmd); len(sp) > 0 {

View File

@@ -197,7 +197,7 @@ func (obj *GroupRes) CheckApply(ctx context.Context, apply bool) (bool, error) {
cmdName = "groupdel" cmdName = "groupdel"
} }
cmd := exec.Command(cmdName, args...) cmd := exec.CommandContext(ctx, cmdName, args...)
cmd.SysProcAttr = &syscall.SysProcAttr{ cmd.SysProcAttr = &syscall.SysProcAttr{
Setpgid: true, Setpgid: true,
Pgid: 0, Pgid: 0,

View File

@@ -661,7 +661,7 @@ func TestResources1(t *testing.T) {
} }
t.Logf("test #%d: running CheckApply", index) t.Logf("test #%d: running CheckApply", index)
checkOK, err := res.CheckApply(doneCtx, true) // no noop! checkOK, err := res.CheckApply(context.TODO(), true) // no noop!
if err != nil { if err != nil {
t.Errorf("test #%d: FAIL", index) t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: CheckApply failed: %s", index, err.Error()) t.Errorf("test #%d: CheckApply failed: %s", index, err.Error())

View File

@@ -287,7 +287,7 @@ func (obj *SysctlRes) runtimeCheckApply(ctx context.Context, apply bool) (bool,
b, err := os.ReadFile(obj.toPath()) b, err := os.ReadFile(obj.toPath())
if err != nil && !os.IsNotExist(err) { if err != nil && !os.IsNotExist(err) {
// system or permissions error? // system or permissions error?
return false, nil return false, err
} }
if err == nil && bytes.Equal(expected, b) { if err == nil && bytes.Equal(expected, b) {
return true, nil // we match! return true, nil // we match!
@@ -323,7 +323,7 @@ func (obj *SysctlRes) persistCheckApply(ctx context.Context, apply bool) (bool,
b, err := os.ReadFile(obj.getFilename()) b, err := os.ReadFile(obj.getFilename())
if err != nil && !os.IsNotExist(err) { if err != nil && !os.IsNotExist(err) {
// system or permissions error? // system or permissions error?
return false, nil return false, err
} }
if err == nil && bytes.Equal(expected, b) { if err == nil && bytes.Equal(expected, b) {
return true, nil // we match! return true, nil // we match!

20
examples/lang/exec-if.mcl Normal file
View File

@@ -0,0 +1,20 @@
exec "i will run 1" {
cmd => "/usr/bin/echo i WILL run",
ifcmd => "/usr/bin/true",
}
exec "i will not run 2" {
cmd => "/usr/bin/echo i will NOT run",
ifcmd => "/usr/bin/false",
}
# nifcmd exited with: 0, skipping cmd
exec "i will not run 1" {
cmd => "/usr/bin/echo i will NOT run",
nifcmd => "/usr/bin/true",
}
exec "i will run 2" {
cmd => "/usr/bin/echo i WILL run",
nifcmd => "/usr/bin/false",
}

5
go.mod
View File

@@ -70,6 +70,7 @@ require (
github.com/cespare/xxhash/v2 v2.3.0 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/chappjc/logrus-prefix v0.0.0-20180227015900-3a1d64819adb // indirect github.com/chappjc/logrus-prefix v0.0.0-20180227015900-3a1d64819adb // indirect
github.com/cloudflare/circl v1.5.0 // indirect github.com/cloudflare/circl v1.5.0 // indirect
github.com/cloudflare/cloudflare-go/v6 v6.1.0 // indirect
github.com/cloudwego/base64x v0.1.5 // indirect github.com/cloudwego/base64x v0.1.5 // indirect
github.com/containerd/log v0.1.0 // indirect github.com/containerd/log v0.1.0 // indirect
github.com/coreos/go-semver v0.3.1 // indirect github.com/coreos/go-semver v0.3.1 // indirect
@@ -156,6 +157,10 @@ require (
github.com/spf13/cobra v1.8.1 // indirect github.com/spf13/cobra v1.8.1 // indirect
github.com/spf13/pflag v1.0.6-0.20250109003754-5ca813443bd2 // indirect github.com/spf13/pflag v1.0.6-0.20250109003754-5ca813443bd2 // indirect
github.com/stmcginnis/gofish v0.20.0 // indirect github.com/stmcginnis/gofish v0.20.0 // indirect
github.com/tidwall/gjson v1.14.4 // indirect
github.com/tidwall/match v1.1.1 // indirect
github.com/tidwall/pretty v1.2.1 // indirect
github.com/tidwall/sjson v1.2.5 // indirect
github.com/tmc/grpc-websocket-proxy v0.0.0-20220101234140-673ab2c3ae75 // indirect github.com/tmc/grpc-websocket-proxy v0.0.0-20220101234140-673ab2c3ae75 // indirect
github.com/twitchyliquid64/golang-asm v0.15.1 // indirect github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
github.com/u-root/uio v0.0.0-20240224005618-d2acac8f3701 // indirect github.com/u-root/uio v0.0.0-20240224005618-d2acac8f3701 // indirect

12
go.sum
View File

@@ -68,6 +68,8 @@ github.com/circonus-labs/circonusllhist v0.1.3/go.mod h1:kMXHVDlOchFAehlya5ePtbp
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
github.com/cloudflare/circl v1.5.0 h1:hxIWksrX6XN5a1L2TI/h53AGPhNHoUBo+TD1ms9+pys= github.com/cloudflare/circl v1.5.0 h1:hxIWksrX6XN5a1L2TI/h53AGPhNHoUBo+TD1ms9+pys=
github.com/cloudflare/circl v1.5.0/go.mod h1:uddAzsPgqdMAYatqJ0lsjX1oECcQLIlRpzZh3pJrofs= github.com/cloudflare/circl v1.5.0/go.mod h1:uddAzsPgqdMAYatqJ0lsjX1oECcQLIlRpzZh3pJrofs=
github.com/cloudflare/cloudflare-go/v6 v6.1.0 h1:208leV/QEyIZuxFKNk3ztiOh4PeNW/qvLHvzafcbpjI=
github.com/cloudflare/cloudflare-go/v6 v6.1.0/go.mod h1:Lj3MUqjvKctXRpdRhLQxZYRrNZHuRs0XYuH8JtQGyoI=
github.com/cloudwego/base64x v0.1.5 h1:XPciSp1xaq2VCSt6lF0phncD4koWyULpl5bUxbfCyP4= github.com/cloudwego/base64x v0.1.5 h1:XPciSp1xaq2VCSt6lF0phncD4koWyULpl5bUxbfCyP4=
github.com/cloudwego/base64x v0.1.5/go.mod h1:0zlkT4Wn5C6NdauXdJRhSKRlJvmclQ1hhJgA0rcu/8w= github.com/cloudwego/base64x v0.1.5/go.mod h1:0zlkT4Wn5C6NdauXdJRhSKRlJvmclQ1hhJgA0rcu/8w=
github.com/cloudwego/iasm v0.2.0/go.mod h1:8rXZaNYT2n95jn+zTI1sDr+IgcD2GVs0nlbbQPiEFhY= github.com/cloudwego/iasm v0.2.0/go.mod h1:8rXZaNYT2n95jn+zTI1sDr+IgcD2GVs0nlbbQPiEFhY=
@@ -496,6 +498,16 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/gjson v1.14.4 h1:uo0p8EbA09J7RQaflQ1aBRffTR7xedD2bcIVSYxLnkM=
github.com/tidwall/gjson v1.14.4/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4=
github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY=
github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28=
github.com/tmc/grpc-websocket-proxy v0.0.0-20220101234140-673ab2c3ae75 h1:6fotK7otjonDflCTK0BCfls4SPy3NcCVb5dqqmbRknE= github.com/tmc/grpc-websocket-proxy v0.0.0-20220101234140-673ab2c3ae75 h1:6fotK7otjonDflCTK0BCfls4SPy3NcCVb5dqqmbRknE=
github.com/tmc/grpc-websocket-proxy v0.0.0-20220101234140-673ab2c3ae75/go.mod h1:KO6IkyS8Y3j8OdNO85qEYBsRPuteD+YciPomcXdrMnk= github.com/tmc/grpc-websocket-proxy v0.0.0-20220101234140-673ab2c3ae75/go.mod h1:KO6IkyS8Y3j8OdNO85qEYBsRPuteD+YciPomcXdrMnk=
github.com/tredoe/osutil v1.5.0 h1:UGVxbbHRoZi8xXVmbNZ2vgG6XoJ15ndE4LniiQ3rJKg= github.com/tredoe/osutil v1.5.0 h1:UGVxbbHRoZi8xXVmbNZ2vgG6XoJ15ndE4LniiQ3rJKg=

View File

@@ -5624,7 +5624,7 @@ func (obj *StmtProg) SetScope(scope *interfaces.Scope) error {
// debugging visualizations // debugging visualizations
if obj.data.Debug && orderingGraphSingleton { if obj.data.Debug && orderingGraphSingleton {
obj.data.Logf("running graphviz for ordering graph...") obj.data.Logf("running graphviz for ordering graph...")
if err := orderingGraph.ExecGraphviz("/tmp/graphviz-ordering.dot"); err != nil { if err := orderingGraph.ExecGraphviz(context.TODO(), "/tmp/graphviz-ordering.dot"); err != nil {
obj.data.Logf("graphviz: errored: %+v", err) obj.data.Logf("graphviz: errored: %+v", err)
} }
//if err := orderingGraphFiltered.ExecGraphviz("/tmp/graphviz-ordering-filtered.dot"); err != nil { //if err := orderingGraphFiltered.ExecGraphviz("/tmp/graphviz-ordering-filtered.dot"); err != nil {

View File

@@ -961,7 +961,7 @@ func (obj *Engine) Graph() *pgraph.Graph {
// ExecGraphviz writes out the diagram of a graph to be used for visualization // ExecGraphviz writes out the diagram of a graph to be used for visualization
// and debugging. You must not modify the graph (eg: during Lock) when calling // and debugging. You must not modify the graph (eg: during Lock) when calling
// this method. // this method.
func (obj *Engine) ExecGraphviz(dir string) error { func (obj *Engine) ExecGraphviz(ctx context.Context, dir string) error {
// No mutex needed here since this func runs in a non-concurrent Txn. // No mutex needed here since this func runs in a non-concurrent Txn.
// No mutex is needed at this time because we only run this in txn's and // No mutex is needed at this time because we only run this in txn's and
@@ -1019,7 +1019,7 @@ func (obj *Engine) ExecGraphviz(dir string) error {
}, },
} }
if err := gv.Exec(); err != nil { if err := gv.Exec(ctx); err != nil {
return err return err
} }
return nil return nil

View File

@@ -567,7 +567,7 @@ func TestAstFunc1(t *testing.T) {
} }
if runGraphviz { if runGraphviz {
t.Logf("test #%d: Running graphviz...", index) t.Logf("test #%d: Running graphviz...", index)
if err := fgraph.ExecGraphviz("/tmp/graphviz.dot"); err != nil { if err := fgraph.ExecGraphviz(context.TODO(), "/tmp/graphviz.dot"); err != nil {
t.Errorf("test #%d: FAIL", index) t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: writing graph failed: %+v", index, err) t.Errorf("test #%d: writing graph failed: %+v", index, err)
return return
@@ -1120,7 +1120,7 @@ func TestAstFunc2(t *testing.T) {
} }
ast.ScopeGraph(graph) ast.ScopeGraph(graph)
if err := graph.ExecGraphviz("/tmp/set-scope.dot"); err != nil { if err := graph.ExecGraphviz(context.TODO(), "/tmp/set-scope.dot"); err != nil {
t.Errorf("test #%d: FAIL", index) t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: writing graph failed: %+v", index, err) t.Errorf("test #%d: writing graph failed: %+v", index, err)
return return
@@ -1233,7 +1233,7 @@ func TestAstFunc2(t *testing.T) {
if runGraphviz { if runGraphviz {
t.Logf("test #%d: Running graphviz...", index) t.Logf("test #%d: Running graphviz...", index)
if err := fgraph.ExecGraphviz("/tmp/graphviz.dot"); err != nil { if err := fgraph.ExecGraphviz(context.TODO(), "/tmp/graphviz.dot"); err != nil {
t.Errorf("test #%d: FAIL", index) t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: writing graph failed: %+v", index, err) t.Errorf("test #%d: writing graph failed: %+v", index, err)
return return
@@ -1996,7 +1996,7 @@ func TestAstFunc3(t *testing.T) {
} }
ast.ScopeGraph(graph) ast.ScopeGraph(graph)
if err := graph.ExecGraphviz("/tmp/set-scope.dot"); err != nil { if err := graph.ExecGraphviz(context.TODO(), "/tmp/set-scope.dot"); err != nil {
t.Errorf("test #%d: FAIL", index) t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: writing graph failed: %+v", index, err) t.Errorf("test #%d: writing graph failed: %+v", index, err)
return return
@@ -2088,7 +2088,7 @@ func TestAstFunc3(t *testing.T) {
if runGraphviz { if runGraphviz {
t.Logf("test #%d: Running graphviz...", index) t.Logf("test #%d: Running graphviz...", index)
if err := fgraph.ExecGraphviz("/tmp/graphviz.dot"); err != nil { if err := fgraph.ExecGraphviz(context.TODO(), "/tmp/graphviz.dot"); err != nil {
t.Errorf("test #%d: FAIL", index) t.Errorf("test #%d: FAIL", index)
t.Errorf("test #%d: writing graph failed: %+v", index, err) t.Errorf("test #%d: writing graph failed: %+v", index, err)
return return

View File

@@ -1049,7 +1049,8 @@ func (obj *Main) Run() error {
obj.ge.Graph(): nil, obj.ge.Graph(): nil,
}, },
} }
if err := gv.Exec(); err != nil { // FIXME: is this the right ctx?
if err := gv.Exec(exitCtx); err != nil {
Logf("graphviz: %+v", err) Logf("graphviz: %+v", err)
} else { } else {
Logf("graphviz: successfully generated graph!") Logf("graphviz: successfully generated graph!")

View File

@@ -30,6 +30,7 @@
package pgraph // TODO: this should be a subpackage package pgraph // TODO: this should be a subpackage
import ( import (
"context"
"fmt" "fmt"
"html" "html"
"os" "os"
@@ -153,7 +154,7 @@ func (obj *Graphviz) Text() string {
// Exec writes out the graphviz data and runs the correct graphviz filter // Exec writes out the graphviz data and runs the correct graphviz filter
// command. // command.
func (obj *Graphviz) Exec() error { func (obj *Graphviz) Exec(ctx context.Context) error {
filter := "" filter := ""
switch obj.Filter { switch obj.Filter {
case "": case "":
@@ -195,7 +196,7 @@ func (obj *Graphviz) Exec() error {
} }
out := fmt.Sprintf("%s.png", filename) out := fmt.Sprintf("%s.png", filename)
cmd := exec.Command(path, "-Tpng", fmt.Sprintf("-o%s", out), filename) cmd := exec.CommandContext(ctx, path, "-Tpng", fmt.Sprintf("-o%s", out), filename)
if err1 == nil && err2 == nil { if err1 == nil && err2 == nil {
cmd.SysProcAttr = &syscall.SysProcAttr{} cmd.SysProcAttr = &syscall.SysProcAttr{}
@@ -286,7 +287,7 @@ func (obj *Graph) Graphviz() string {
// ExecGraphviz writes out the graphviz data and runs the correct graphviz // ExecGraphviz writes out the graphviz data and runs the correct graphviz
// filter command. // filter command.
func (obj *Graph) ExecGraphviz(filename string) error { func (obj *Graph) ExecGraphviz(ctx context.Context, filename string) error {
gv := &Graphviz{ gv := &Graphviz{
Graphs: map[*Graph]*GraphvizOpts{ Graphs: map[*Graph]*GraphvizOpts{
obj: nil, obj: nil,
@@ -296,5 +297,5 @@ func (obj *Graph) ExecGraphviz(filename string) error {
Filename: filename, Filename: filename,
//Hostname: hostname, //Hostname: hostname,
} }
return gv.Exec() return gv.Exec(ctx)
} }

View File

@@ -485,7 +485,7 @@ func TestTopoSort3(t *testing.T) {
G.AddEdge(v5, v6, e5) G.AddEdge(v5, v6, e5)
G.AddEdge(v4, v2, e6) // cycle G.AddEdge(v4, v2, e6) // cycle
G.ExecGraphviz("/tmp/g.dot") //G.ExecGraphviz(context.TODO(), "/tmp/g.dot")
_, err := G.TopologicalSort() _, err := G.TopologicalSort()
if err == nil { if err == nil {