Files
mgmt/lang/core/os/family_func.go
James Shubin d24149518c util: distro: Refactor family and distro code
I hate writing abstraction code like this, but I'm hoping it will be
useful.
2024-10-15 20:36:50 -04:00

116 lines
3.7 KiB
Go

// 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 coreos
import (
"context"
"github.com/purpleidea/mgmt/lang/funcs/simple"
"github.com/purpleidea/mgmt/lang/funcs/vars"
"github.com/purpleidea/mgmt/lang/types"
distroUtil "github.com/purpleidea/mgmt/util/distro"
)
func init() {
simple.ModuleRegister(ModuleName, "family", &simple.Scaffold{
T: types.NewType("func() str"),
F: Family,
})
vars.ModuleRegister(ModuleName, "family_redhat", func() vars.Value {
return &types.StrValue{
V: distroUtil.FamilyRedHat,
}
})
vars.ModuleRegister(ModuleName, "family_debian", func() vars.Value {
return &types.StrValue{
V: distroUtil.FamilyDebian,
}
})
vars.ModuleRegister(ModuleName, "family_archlinux", func() vars.Value {
return &types.StrValue{
V: distroUtil.FamilyArchLinux,
}
})
// TODO: Create a family method that will return a giant struct.
simple.ModuleRegister(ModuleName, "is_family_redhat", &simple.Scaffold{
T: types.NewType("func() bool"),
F: IsFamilyRedHat,
})
simple.ModuleRegister(ModuleName, "is_family_debian", &simple.Scaffold{
T: types.NewType("func() bool"),
F: IsFamilyDebian,
})
simple.ModuleRegister(ModuleName, "is_family_archlinux", &simple.Scaffold{
T: types.NewType("func() bool"),
F: IsFamilyArchLinux,
})
}
// Family returns the distro family.
// TODO: Detect OS changes.
func Family(ctx context.Context, input []types.Value) (types.Value, error) {
s, err := distroUtil.Family(ctx)
if err != nil {
return nil, err
}
return &types.StrValue{
V: s, // empty if unknown
}, nil
}
// IsFamilyRedHat detects if the os family is redhat.
// TODO: Detect OS changes.
func IsFamilyRedHat(ctx context.Context, input []types.Value) (types.Value, error) {
b, err := distroUtil.IsFamilyRedHat(ctx)
return &types.BoolValue{
V: b,
}, err
}
// IsFamilyDebian detects if the os family is debian.
// TODO: Detect OS changes.
func IsFamilyDebian(ctx context.Context, input []types.Value) (types.Value, error) {
b, err := distroUtil.IsFamilyDebian(ctx)
return &types.BoolValue{
V: b,
}, err
}
// IsFamilyArchLinux detects if the os family is archlinux.
// TODO: Detect OS changes.
func IsFamilyArchLinux(ctx context.Context, input []types.Value) (types.Value, error) {
b, err := distroUtil.IsFamilyArchLinux(ctx)
return &types.BoolValue{
V: b,
}, err
}