From ef50b3677b67d5394ce8a8f79ad9651143e73391 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Mon, 1 Jul 2024 18:44:42 -0400 Subject: [PATCH 01/13] feat: add go to .editorignore Signed-off-by: Jason C. Nucciarone --- .editorconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index 9ec0526..015c696 100644 --- a/.editorconfig +++ b/.editorconfig @@ -6,7 +6,7 @@ insert_final_newline = true trim_trailing_whitespace = true charset = utf-8 -[Makefile] +[{Makefile,go.mod,go.sum,*.go}] indent_style = tab indent_size = 4 From ba869731ad2c572b52f12fe0a1da8d36d5e5c9bd Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 09:58:07 -0400 Subject: [PATCH 02/13] refactor: mothball slurmhelpers into src delete top-level slurmhelpers and move into src Signed-off-by: Jason C. Nucciarone --- pyproject.toml | 1 + {slurmhelpers => src/slurmhelpers}/__init__.py | 0 {slurmhelpers => src/slurmhelpers}/hooks.py | 0 {slurmhelpers => src/slurmhelpers}/log.py | 0 {slurmhelpers => src/slurmhelpers}/models.py | 0 5 files changed, 1 insertion(+) rename {slurmhelpers => src/slurmhelpers}/__init__.py (100%) rename {slurmhelpers => src/slurmhelpers}/hooks.py (100%) rename {slurmhelpers => src/slurmhelpers}/log.py (100%) rename {slurmhelpers => src/slurmhelpers}/models.py (100%) diff --git a/pyproject.toml b/pyproject.toml index eba334c..f4b5dd4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,6 +17,7 @@ name = "slurm-helpers" version = "0.1.0" [tool.setuptools.packages.find] +where = ["src"] include = ["slurmhelpers"] # Hook configuration for snaphelpers utility. diff --git a/slurmhelpers/__init__.py b/src/slurmhelpers/__init__.py similarity index 100% rename from slurmhelpers/__init__.py rename to src/slurmhelpers/__init__.py diff --git a/slurmhelpers/hooks.py b/src/slurmhelpers/hooks.py similarity index 100% rename from slurmhelpers/hooks.py rename to src/slurmhelpers/hooks.py diff --git a/slurmhelpers/log.py b/src/slurmhelpers/log.py similarity index 100% rename from slurmhelpers/log.py rename to src/slurmhelpers/log.py diff --git a/slurmhelpers/models.py b/src/slurmhelpers/models.py similarity index 100% rename from slurmhelpers/models.py rename to src/slurmhelpers/models.py From adcc12ae13c8e936152869cd9626cb544acd2178 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 18:07:49 -0400 Subject: [PATCH 03/13] refactor: update tox to point to slurmhelpers under src/ Also, needed to update ruff since it now uses the check subcommand before performing formatting/lints. Signed-off-by: Jason C. Nucciarone --- tox.ini | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tox.ini b/tox.ini index 305efdf..7fefa6b 100644 --- a/tox.ini +++ b/tox.ini @@ -18,7 +18,7 @@ skip_missing_interpreters = True envlist = fmt, lint [vars] -src_path = {toxinidir}/slurmhelpers +src_path = {toxinidir}/src tst_path = {toxinidir}/tests snap_path = {toxinidir}/snap all_path = {[vars]src_path} {[vars]tst_path} @@ -36,7 +36,7 @@ deps = ruff commands = black --target-version py310 {[vars]all_path} - ruff --fix {[vars]all_path} + ruff check --fix {[vars]all_path} [testenv:lint] description = Check code against coding style standards. @@ -47,7 +47,7 @@ deps = yamllint commands = codespell {[vars]all_path} - ruff {[vars]all_path} + ruff check {[vars]all_path} black --check --diff --target-version py310 {[vars]all_path} yamllint --strict {[vars]snap_path} From 8ea8bc1422a0b24b9f32a1a4adddec99090a639a Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 18:10:09 -0400 Subject: [PATCH 04/13] feat: add mungectl for managing the munge key Signed-off-by: Jason C. Nucciarone --- src/mungectl/cmd/mungectl/cmd/generate.go | 51 +++++++++++++ src/mungectl/cmd/mungectl/cmd/get.go | 51 +++++++++++++ src/mungectl/cmd/mungectl/cmd/root.go | 39 ++++++++++ src/mungectl/cmd/mungectl/cmd/set.go | 59 ++++++++++++++ src/mungectl/cmd/mungectl/main.go | 22 ++++++ src/mungectl/go.mod | 16 ++++ src/mungectl/go.sum | 18 +++++ src/mungectl/internal/key/key.go | 88 +++++++++++++++++++++ src/mungectl/internal/key/key_test.go | 93 +++++++++++++++++++++++ 9 files changed, 437 insertions(+) create mode 100644 src/mungectl/cmd/mungectl/cmd/generate.go create mode 100644 src/mungectl/cmd/mungectl/cmd/get.go create mode 100644 src/mungectl/cmd/mungectl/cmd/root.go create mode 100644 src/mungectl/cmd/mungectl/cmd/set.go create mode 100644 src/mungectl/cmd/mungectl/main.go create mode 100644 src/mungectl/go.mod create mode 100644 src/mungectl/go.sum create mode 100644 src/mungectl/internal/key/key.go create mode 100644 src/mungectl/internal/key/key_test.go diff --git a/src/mungectl/cmd/mungectl/cmd/generate.go b/src/mungectl/cmd/mungectl/cmd/generate.go new file mode 100644 index 0000000..2d0da98 --- /dev/null +++ b/src/mungectl/cmd/mungectl/cmd/generate.go @@ -0,0 +1,51 @@ +// Copyright 2024 Canonical Ltd. +// +// 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 . + +package cmd + +import ( + "fmt" + "os" + "path" + + "github.com/spf13/cobra" + + key "mungectl/internal/key" +) + +const generateHelp = "generate a new munge key" +const generateExample = `mungectl generate + Generate a new munge key and write to key file location +` + +var generateCmd = &cobra.Command{ + Use: "generate", + Short: generateHelp, + Example: generateExample, + Run: generateExecute, +} + +func generateExecute(cmd *cobra.Command, args []string) { + content, err := key.Generate() + if err != nil { + fmt.Fprintln(os.Stderr, "failed to generate new munge key") + os.Exit(1) + } + + file := path.Join(os.Getenv("SNAP_COMMON"), "etc", "munge", "munge.key") + if err := key.Write(file, content); err != nil { + fmt.Fprintf(os.Stderr, "failed to write generated munge key file %s\n", file) + } +} diff --git a/src/mungectl/cmd/mungectl/cmd/get.go b/src/mungectl/cmd/mungectl/cmd/get.go new file mode 100644 index 0000000..7304299 --- /dev/null +++ b/src/mungectl/cmd/mungectl/cmd/get.go @@ -0,0 +1,51 @@ +// Copyright 2024 Canonical Ltd. +// +// 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 . + +package cmd + +import ( + "fmt" + "os" + "path" + + "github.com/spf13/cobra" + + key "mungectl/internal/key" +) + +const getHelp = "get current munge key" +const getExample = ` +mungectl get > key.out + + Get current munge key, encode into a base64 string, and write to key.out. +` + +var getCmd = &cobra.Command{ + Use: "get", + Short: getHelp, + Example: getExample, + Run: getExecute, +} + +func getExecute(cmd *cobra.Command, args []string) { + file := path.Join(os.Getenv("SNAP_COMMON"), "etc", "munge", "munge.key") + content, err := key.Read(file) + if err != nil { + fmt.Fprintf(os.Stderr, "failed to read current munge key file %s\n", file) + os.Exit(1) + } + + fmt.Fprintln(os.Stdout, key.Encode(content)) +} diff --git a/src/mungectl/cmd/mungectl/cmd/root.go b/src/mungectl/cmd/mungectl/cmd/root.go new file mode 100644 index 0000000..6b0050f --- /dev/null +++ b/src/mungectl/cmd/mungectl/cmd/root.go @@ -0,0 +1,39 @@ +// Copyright 2024 Canonical Ltd. +// +// 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 . + +package cmd + +import ( + "fmt" + "os" + + "github.com/spf13/cobra" +) + +var rootCmd = &cobra.Command{ + Use: "mungectl", +} + +func init() { + rootCmd.CompletionOptions.DisableDefaultCmd = true + rootCmd.AddCommand(generateCmd, getCmd, setCmd) +} + +func Execute() { + if err := rootCmd.Execute(); err != nil { + fmt.Fprintln(os.Stderr, err.Error()) + os.Exit(1) + } +} diff --git a/src/mungectl/cmd/mungectl/cmd/set.go b/src/mungectl/cmd/mungectl/cmd/set.go new file mode 100644 index 0000000..d458fc2 --- /dev/null +++ b/src/mungectl/cmd/mungectl/cmd/set.go @@ -0,0 +1,59 @@ +// Copyright 2024 Canonical Ltd. +// +// 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 . + +package cmd + +import ( + "fmt" + "os" + "path" + + "github.com/spf13/cobra" + + key "mungectl/internal/key" +) + +const setHelp = "set a new munge key" +const setExample = ` +mungectl set < secret.key + + Replace old munge key with one read from stdin +` + +var setCmd = &cobra.Command{ + Use: "set", + Short: setHelp, + Example: setExample, + Run: setExecute, +} + +func setExecute(cmd *cobra.Command, args []string) { + content, err := key.Scan() + if err != nil { + fmt.Fprintln(os.Stderr, "failed to read munge key from stdin") + os.Exit(2) + } + + file := path.Join(os.Getenv("SNAP_COMMON"), "etc", "munge", "munge.key") + decoded, err := key.Decode(content) + if err != nil { + fmt.Fprintln(os.Stderr, "failed to decode new munge key") + os.Exit(1) + } + if err := key.Write(file, decoded); err != nil { + fmt.Fprintf(os.Stderr, "failed to write new munge key to %s\n", file) + os.Exit(1) + } +} diff --git a/src/mungectl/cmd/mungectl/main.go b/src/mungectl/cmd/mungectl/main.go new file mode 100644 index 0000000..7842d89 --- /dev/null +++ b/src/mungectl/cmd/mungectl/main.go @@ -0,0 +1,22 @@ +// Copyright 2024 Canonical Ltd. +// +// 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 . + +package main + +import "mungectl/cmd/mungectl/cmd" + +func main() { + cmd.Execute() +} diff --git a/src/mungectl/go.mod b/src/mungectl/go.mod new file mode 100644 index 0000000..2fae1b3 --- /dev/null +++ b/src/mungectl/go.mod @@ -0,0 +1,16 @@ +module mungectl + +go 1.22.4 + +require ( + github.com/spf13/cobra v1.8.0 + github.com/stretchr/testify v1.9.0 +) + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/spf13/pflag v1.0.5 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/src/mungectl/go.sum b/src/mungectl/go.sum new file mode 100644 index 0000000..50cc2e6 --- /dev/null +++ b/src/mungectl/go.sum @@ -0,0 +1,18 @@ +github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= +github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= +github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/src/mungectl/internal/key/key.go b/src/mungectl/internal/key/key.go new file mode 100644 index 0000000..569135e --- /dev/null +++ b/src/mungectl/internal/key/key.go @@ -0,0 +1,88 @@ +// Copyright 2024 Canonical Ltd. +// +// 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 . + +package key + +import ( + "bufio" + "crypto/rand" + "encoding/base64" + "errors" + "os" + "strings" +) + +// Scan new munge key from stdin. Returns an error if +// no base64-encoded munge key is provided on stdin. +func Scan() (string, error) { + stat, _ := os.Stdin.Stat() + if (stat.Mode() & os.ModeCharDevice) == 0 { + key := strings.Builder{} + scanner := bufio.NewScanner(os.Stdin) + + for scanner.Scan() { + key.WriteString(scanner.Text()) + } + if err := scanner.Err(); err != nil { + return "", err + } + + return strings.TrimSpace(key.String()), nil + } + + return "", errors.New("no munge key provided on stdin") +} + +// Generate a new munge key. Returns an error if a failure +// is encountered when generating new bytes for key. +func Generate() ([]byte, error) { + b := make([]byte, 1024) + if _, err := rand.Read(b); err != nil { + return nil, err + } + return b, nil +} + +// Read munge key file. Returns an error if the munge key file +// does not exist or a failure occurs when reading the file. +func Read(path string) ([]byte, error) { + key, err := os.ReadFile(path) + if err != nil { + return nil, err + } + return key, nil +} + +// Write munge key file. Returns an error if a failure +// occurs when writing the new key. +func Write(path string, key []byte) error { + return os.WriteFile(path, key, 0600) +} + +// Encode munge key into a base64 string. +func Encode(key []byte) string { + return base64.StdEncoding.EncodeToString(key) +} + +// Decode munge key from a base64 string. Returns an error +// if a failure occurs when decoding the base64 string. +func Decode(key string) ([]byte, error) { + key = strings.TrimSpace(key) + decoded, err := base64.StdEncoding.DecodeString(key) + if err != nil { + return nil, err + } + return decoded, nil +} diff --git a/src/mungectl/internal/key/key_test.go b/src/mungectl/internal/key/key_test.go new file mode 100644 index 0000000..3384c84 --- /dev/null +++ b/src/mungectl/internal/key/key_test.go @@ -0,0 +1,93 @@ +// Copyright 2024 Canonical Ltd. +// +// 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 . + +package key + +import ( + "os" + "testing" + + "github.com/stretchr/testify/assert" +) + +const secret = "we be testing" +const secretBase64 = "d2UgYmUgdGVzdGluZw==" + +func TestKeyScan(t *testing.T) { + // send mock input into stdin + r, w, err := os.Pipe() + if err != nil { + t.Error(err) + } + if _, err := w.Write([]byte(secretBase64)); err != nil { + t.Error(err) + } + w.Close() + + // restore stdin after test + defer func(f *os.File) { os.Stdin = f }(os.Stdin) + os.Stdin = r + + content, err := Scan() + if assert.NoError(t, err) { + assert.Equal(t, secretBase64, content) + } +} + +func TestKeyGenerate(t *testing.T) { + content, err := Generate() + if assert.NoError(t, err) { + assert.NotNil(t, content) + } +} + +func TestKeyWrite(t *testing.T) { + f, err := os.CreateTemp("", "munge") + if err != nil { + t.Error(err) + } + defer f.Close() + defer os.Remove(f.Name()) + assert.NoError(t, Write(f.Name(), []byte(secret))) +} + +func TestKeyRead(t *testing.T) { + f, err := os.CreateTemp("", "munge") + if err != nil { + t.Error(err) + } + defer os.Remove(f.Name()) + if _, err := f.Write([]byte(secret)); err != nil { + t.Error(err) + } + f.Close() + + content, err := Read(f.Name()) + if assert.NoError(t, err) { + assert.Equal(t, secret, string(content)) + } +} + +func TestKeyEncode(t *testing.T) { + content := Encode([]byte(secret)) + assert.Equal(t, secretBase64, content) +} + +func TestKeyDecode(t *testing.T) { + content, err := Decode(secretBase64) + if assert.NoError(t, err) { + assert.Equal(t, secret, string(content)) + } +} From 335964c3ccd04638eb1abb87271df859823543e7 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 18:11:44 -0400 Subject: [PATCH 05/13] feat: include mungectl for key management Signed-off-by: Jason C. Nucciarone --- snap/snapcraft.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml index c0d71d7..3089cf7 100644 --- a/snap/snapcraft.yaml +++ b/snap/snapcraft.yaml @@ -57,6 +57,8 @@ apps: command: bin/remunge --socket $SNAP_COMMON/run/munge/munged.socket.2 mungekey: command: sbin/mungekey + mungectl: + command: bin/mungectl slurmctld: command: sbin/slurmctld.wrapper @@ -189,6 +191,12 @@ parts: - --with-munge-socket=/var/snap/${SNAPCRAFT_PROJECT_NAME}/common/run/munge/munged.socket.2 - --with-crypto-lib=openssl + mungectl: + source: src/mungectl + plugin: go + build-snaps: + - go/1.22/stable + slurm: plugin: nil after: [munge, patch] From 9475b93ccb7fee11455d07a27e7b1c32e621db1f Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 18:12:15 -0400 Subject: [PATCH 06/13] tests: update integration tests to test mungectl Signed-off-by: Jason C. Nucciarone --- tests/integration/configless-slurm/configless-slurm.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/tests/integration/configless-slurm/configless-slurm.yaml b/tests/integration/configless-slurm/configless-slurm.yaml index a2e58bb..0d1e9a3 100644 --- a/tests/integration/configless-slurm/configless-slurm.yaml +++ b/tests/integration/configless-slurm/configless-slurm.yaml @@ -75,7 +75,7 @@ acts: path: sssd.conf output: - key: munge - path: /var/snap/slurm/common/etc/munge/munge.key + path: key.out scenes: - name: "Install Slurm (slurmctld + munge)" run: | @@ -99,6 +99,7 @@ acts: envsubst < slurm.conf > /var/snap/slurm/common/etc/slurm/slurm.conf snap start slurm.slurmctld snap restart slurm.munged + slurm.mungectl get | tee key.out compute: name: "Provision workload scheduler (compute)" @@ -108,7 +109,7 @@ acts: - host-path: testdata/slurm.snap path: slurm.snap - key: munge - path: munge.key + path: key.out - host-path: testdata/sssd.conf path: sssd.conf scenes: @@ -130,7 +131,7 @@ acts: mount -t nfs nfs-server:/home /home - name: "Start compute service" run: | - mv munge.key /var/snap/slurm/common/etc/munge/munge.key + cat key.out | slurm.mungectl set snap set slurm slurmd.config-server=controller:6817 snap restart slurm.munged snap start slurm.slurmd From 9568ad8e46febf9f63583610af4ac546d33e4ab7 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 18:12:41 -0400 Subject: [PATCH 07/13] feat: add Makefile + LICENSE for mungectl Signed-off-by: Jason C. Nucciarone --- src/mungectl/LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++ src/mungectl/Makefile | 47 +++ 2 files changed, 721 insertions(+) create mode 100644 src/mungectl/LICENSE create mode 100644 src/mungectl/Makefile diff --git a/src/mungectl/LICENSE b/src/mungectl/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/src/mungectl/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/src/mungectl/Makefile b/src/mungectl/Makefile new file mode 100644 index 0000000..d6369c6 --- /dev/null +++ b/src/mungectl/Makefile @@ -0,0 +1,47 @@ +# Copyright 2024 Canonical Ltd. +# +# 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 . + +FORMAT_BOLD = \033[1m +FORMAT_YELLOW = \033[0;33m +FORMAT_BLUE = \033[0;34m +FORMAT_END = \033[0m + +##@ Lint + +.PHONY: fmt +fmt: ## Format `mungectl` source code + @go fmt -x ./... + @golangci-lint run --fix + +.PHONY: lint +lint: ## Lint `mungectl` source code + @golangci-lint run + +##@ Test + +.PHONY: unit +unit: ## Run `mungectl` unit tests + @go test -v ./... + + +.PHONY: help +help: + @awk 'BEGIN {\ + FS = ":.*##"; \ + printf "Usage: ${FORMAT_BLUE}OPTION${FORMAT_END}= make ${FORMAT_YELLOW}${FORMAT_END}\n"\ + } \ + /^[a-zA-Z0-9_-]+:.*?##/ { printf " ${FORMAT_BLUE}%-46s${FORMAT_END} %s\n", $$1, $$2 } \ + /^.?.?##~/ { printf " %-46s${FORMAT_YELLOW}%-46s${FORMAT_END}\n", "", substr($$1, 6) } \ + /^##@/ { printf "\n${FORMAT_BOLD}%s${FORMAT_END}\n", substr($$0, 5) } ' $(MAKEFILE_LIST) From 60f0c13ad903692467812421657514c408bb272a Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 18:15:08 -0400 Subject: [PATCH 08/13] refactor: use `mungectl generate` rather than generating own bytes Signed-off-by: Jason C. Nucciarone --- src/slurmhelpers/models.py | 10 ++++++---- tests/unit/conftest.py | 3 +-- tests/unit/test_hooks.py | 1 + tests/unit/test_models.py | 32 +++++++++++++++++--------------- 4 files changed, 25 insertions(+), 21 deletions(-) diff --git a/src/slurmhelpers/models.py b/src/slurmhelpers/models.py index 91f99da..4be2a68 100644 --- a/src/slurmhelpers/models.py +++ b/src/slurmhelpers/models.py @@ -16,7 +16,7 @@ import base64 import logging -import os +import subprocess from abc import ABC, abstractmethod from typing import Any, Dict, List, Optional @@ -165,10 +165,12 @@ def generate_key(self) -> None: Replicates the daemon autostart feature from the munge Debian package. """ logging.info("Generating new secret file for service `munged`.") - if not self.secret_file.exists(): - self.secret_file.touch(0o600) + try: + subprocess.check_output(["mungectl", "generate"]) + except subprocess.CalledProcessError: + logging.fatal("Failed to generate a new munge key") + raise - self.secret_file.write_bytes(os.urandom(1024)) self._needs_restart(["munged"]) def update_config(self, config: Dict[str, str]) -> None: diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py index 0d3cc3f..41c4a06 100644 --- a/tests/unit/conftest.py +++ b/tests/unit/conftest.py @@ -18,11 +18,10 @@ from unittest.mock import MagicMock, PropertyMock import pytest +from slurmhelpers.models import Munge, Slurm, Slurmd, Slurmdbd, Slurmrestd from snaphelpers import Snap, SnapConfig, SnapConfigOptions, SnapServices from snaphelpers._ctl import ServiceInfo -from slurmhelpers.models import Munge, Slurm, Slurmd, Slurmdbd, Slurmrestd - @pytest.fixture def env(): diff --git a/tests/unit/test_hooks.py b/tests/unit/test_hooks.py index 0802bb7..6409adc 100644 --- a/tests/unit/test_hooks.py +++ b/tests/unit/test_hooks.py @@ -80,6 +80,7 @@ class TestHooks: def test_install_hook(self, mocker, snap) -> None: """Test `install` hook.""" + mocker.patch("subprocess.check_output") mocker.patch("pathlib.Path.chmod") mocker.patch("pathlib.Path.mkdir") mocker.patch("pathlib.Path.touch") diff --git a/tests/unit/test_models.py b/tests/unit/test_models.py index 4d49ea1..aa39863 100644 --- a/tests/unit/test_models.py +++ b/tests/unit/test_models.py @@ -15,7 +15,16 @@ """Test models that wrap the configuration for the bundled daemons.""" +import subprocess + import pytest +from slurmhelpers.models import ( + _process_down_nodes, + _process_frontend_nodes, + _process_node_sets, + _process_nodes, + _process_partitions, +) from slurmutils.models import ( DownNodes, DownNodesList, @@ -31,14 +40,6 @@ SlurmdbdConfig, ) -from slurmhelpers.models import ( - _process_down_nodes, - _process_frontend_nodes, - _process_node_sets, - _process_nodes, - _process_partitions, -) - class TestBaseModel: """Test the `_BaseModel` parent class for data models.""" @@ -114,15 +115,16 @@ def test_max_thread_count(self, mocker, munge) -> None: def test_generate_key(self, mocker, munge) -> None: """Test `generate_key` method.""" # Generate key when `munge.key` file does not yet exist. - mocker.patch("pathlib.Path.exists", return_value=False) - mocker.patch("pathlib.Path.touch") - mocker.patch("pathlib.Path.write_bytes") + mocker.patch("subprocess.check_output") munge.generate_key() - # Generate key when `munge.key` file exists. - mocker.patch("pathlib.Path.exists", return_value=True) - mocker.patch("pathlib.Path.write_bytes") - munge.generate_key() + # Fail to generate new `munge.key`. + mocker.patch( + "subprocess.check_output", + side_effect=subprocess.CalledProcessError(0, ["mungectl", "generate"]), + ) + with pytest.raises(subprocess.CalledProcessError): + munge.generate_key() def test_update_config(self, mocker, munge) -> None: """Test `update_config` method.""" From 07f94fb3f83ebf8148658844072710d138aedd8e Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 18:17:02 -0400 Subject: [PATCH 09/13] refactor: centralise testing CI operations into top-level Makefile Signed-off-by: Jason C. Nucciarone --- .github/workflows/ci.yaml | 4 ++-- Makefile | 38 ++++++++++++++++++++++++++++++++------ 2 files changed, 34 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 671e7f4..a825390 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -38,7 +38,7 @@ jobs: - name: Install dependencies run: python3 -m pip install tox - name: Run linters - run: tox run -e lint + run: make lint unit-test: name: Unit tests @@ -49,7 +49,7 @@ jobs: - name: Install dependencies run: python3 -m pip install tox - name: Run tests - run: tox run -e unit + run: make unit integration-test: name: Integration tests diff --git a/Makefile b/Makefile index 4337ade..d6bed58 100644 --- a/Makefile +++ b/Makefile @@ -17,20 +17,46 @@ FORMAT_YELLOW = \033[0;33m FORMAT_BLUE = \033[0;34m FORMAT_END = \033[0m +MUNGECTL := $(CURDIR)/src/mungectl +define INTEGRATION_TESTS + integration-configless +endef + +define mungectl + @make -f $(MUNGECTL)/Makefile -C $(MUNGECTL) $(1) +endef + +define slurmhelpers + @tox run -e $(1) +endef + ##@ Build .PHONY: snap -snap: ## Build Slurm snap package - @snapcraft -v pack +snap: ## Build snap package + snapcraft -v pack + +##@ Lint + +.PHONY: fmt +fmt: ## Format snap code + @$(call mungectl, "fmt") + @$(call slurmhelpers, "fmt") + +.PHONY: +lint: ## Lint snap code + @$(call mungectl, "lint") + @$(call slurmhelpers, "lint") ##@ Test -define INTEGRATION_TESTS - integration-configless -endef +.PHONY: unit +unit: ## Run snap unit tests + @$(call mungectl, "unit") + @$(call slurmhelpers, "unit") .PHONY: integration -integration: $(INTEGRATION_TESTS) ## Run Slurm integration tests with gambol +integration: $(INTEGRATION_TESTS) ## Run snap integration tests with gambol .PHONY: check-snap-exists check-snap-exists: From 117e885e726a363a1d47a0a39c3550f21059c4a8 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Tue, 2 Jul 2024 18:36:52 -0400 Subject: [PATCH 10/13] fix(ci): install golangci-lint Signed-off-by: Jason C. Nucciarone --- .github/workflows/ci.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index a825390..4fee975 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -36,7 +36,9 @@ jobs: - name: Checkout uses: actions/checkout@v4 - name: Install dependencies - run: python3 -m pip install tox + run: | + sudo snap install golangci-lint --classic + python3 -m pip install tox - name: Run linters run: make lint From b5495ecda2edcac54c16f1106ab87eb5303b0732 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Wed, 3 Jul 2024 16:38:15 -0400 Subject: [PATCH 11/13] feat: update mungectl API Signed-off-by: Jason C. Nucciarone --- .../cmd/mungectl/cmd/{ => key}/generate.go | 4 +-- .../cmd/mungectl/cmd/{ => key}/get.go | 6 ++-- src/mungectl/cmd/mungectl/cmd/key/root.go | 32 +++++++++++++++++++ .../cmd/mungectl/cmd/{ => key}/set.go | 6 ++-- src/mungectl/cmd/mungectl/cmd/root.go | 9 ++++-- 5 files changed, 47 insertions(+), 10 deletions(-) rename src/mungectl/cmd/mungectl/cmd/{ => key}/generate.go (95%) rename src/mungectl/cmd/mungectl/cmd/{ => key}/get.go (94%) create mode 100644 src/mungectl/cmd/mungectl/cmd/key/root.go rename src/mungectl/cmd/mungectl/cmd/{ => key}/set.go (94%) diff --git a/src/mungectl/cmd/mungectl/cmd/generate.go b/src/mungectl/cmd/mungectl/cmd/key/generate.go similarity index 95% rename from src/mungectl/cmd/mungectl/cmd/generate.go rename to src/mungectl/cmd/mungectl/cmd/key/generate.go index 2d0da98..e2a607c 100644 --- a/src/mungectl/cmd/mungectl/cmd/generate.go +++ b/src/mungectl/cmd/mungectl/cmd/key/generate.go @@ -13,7 +13,7 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -package cmd +package key import ( "fmt" @@ -25,7 +25,7 @@ import ( key "mungectl/internal/key" ) -const generateHelp = "generate a new munge key" +const generateHelp = "Generate a new munge key" const generateExample = `mungectl generate Generate a new munge key and write to key file location ` diff --git a/src/mungectl/cmd/mungectl/cmd/get.go b/src/mungectl/cmd/mungectl/cmd/key/get.go similarity index 94% rename from src/mungectl/cmd/mungectl/cmd/get.go rename to src/mungectl/cmd/mungectl/cmd/key/get.go index 7304299..79f4234 100644 --- a/src/mungectl/cmd/mungectl/cmd/get.go +++ b/src/mungectl/cmd/mungectl/cmd/key/get.go @@ -13,7 +13,7 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -package cmd +package key import ( "fmt" @@ -25,9 +25,9 @@ import ( key "mungectl/internal/key" ) -const getHelp = "get current munge key" +const getHelp = "Get the current munge key" const getExample = ` -mungectl get > key.out +mungectl key get > key.out Get current munge key, encode into a base64 string, and write to key.out. ` diff --git a/src/mungectl/cmd/mungectl/cmd/key/root.go b/src/mungectl/cmd/mungectl/cmd/key/root.go new file mode 100644 index 0000000..73626df --- /dev/null +++ b/src/mungectl/cmd/mungectl/cmd/key/root.go @@ -0,0 +1,32 @@ +// Copyright 2024 Canonical Ltd. +// +// 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 . + +package key + +import ( + "github.com/spf13/cobra" +) + +const keyHelp = "Manage munge key file" + +var KeyCmd = &cobra.Command{ + Use: "key", + Short: keyHelp, +} + +func init() { + KeyCmd.CompletionOptions.DisableDefaultCmd = true + KeyCmd.AddCommand(generateCmd, getCmd, setCmd) +} diff --git a/src/mungectl/cmd/mungectl/cmd/set.go b/src/mungectl/cmd/mungectl/cmd/key/set.go similarity index 94% rename from src/mungectl/cmd/mungectl/cmd/set.go rename to src/mungectl/cmd/mungectl/cmd/key/set.go index d458fc2..8a964a0 100644 --- a/src/mungectl/cmd/mungectl/cmd/set.go +++ b/src/mungectl/cmd/mungectl/cmd/key/set.go @@ -13,7 +13,7 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -package cmd +package key import ( "fmt" @@ -25,9 +25,9 @@ import ( key "mungectl/internal/key" ) -const setHelp = "set a new munge key" +const setHelp = "Set a new munge key" const setExample = ` -mungectl set < secret.key +mungectl key set < secret.key Replace old munge key with one read from stdin ` diff --git a/src/mungectl/cmd/mungectl/cmd/root.go b/src/mungectl/cmd/mungectl/cmd/root.go index 6b0050f..c73a57b 100644 --- a/src/mungectl/cmd/mungectl/cmd/root.go +++ b/src/mungectl/cmd/mungectl/cmd/root.go @@ -20,15 +20,20 @@ import ( "os" "github.com/spf13/cobra" + + key "mungectl/cmd/mungectl/cmd/key" ) +const help = "Control the munge authentication daemon" + var rootCmd = &cobra.Command{ - Use: "mungectl", + Use: "mungectl", + Short: help, } func init() { rootCmd.CompletionOptions.DisableDefaultCmd = true - rootCmd.AddCommand(generateCmd, getCmd, setCmd) + rootCmd.AddCommand(key.KeyCmd) } func Execute() { From 9e533ec5615004408df39817e998b24f4b9a3c71 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Wed, 3 Jul 2024 16:38:49 -0400 Subject: [PATCH 12/13] tests: update to use new mungectl API Signed-off-by: Jason C. Nucciarone --- tests/integration/configless-slurm/configless-slurm.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/integration/configless-slurm/configless-slurm.yaml b/tests/integration/configless-slurm/configless-slurm.yaml index 0d1e9a3..e6b00c8 100644 --- a/tests/integration/configless-slurm/configless-slurm.yaml +++ b/tests/integration/configless-slurm/configless-slurm.yaml @@ -99,7 +99,7 @@ acts: envsubst < slurm.conf > /var/snap/slurm/common/etc/slurm/slurm.conf snap start slurm.slurmctld snap restart slurm.munged - slurm.mungectl get | tee key.out + slurm.mungectl key get | tee key.out compute: name: "Provision workload scheduler (compute)" @@ -131,7 +131,7 @@ acts: mount -t nfs nfs-server:/home /home - name: "Start compute service" run: | - cat key.out | slurm.mungectl set + cat key.out | slurm.mungectl key set snap set slurm slurmd.config-server=controller:6817 snap restart slurm.munged snap start slurm.slurmd From 89f0b6197efe5523a9a2750aaac640db6157a1c3 Mon Sep 17 00:00:00 2001 From: "Jason C. Nucciarone" Date: Wed, 3 Jul 2024 16:39:24 -0400 Subject: [PATCH 13/13] feat: use mungectl key generate Signed-off-by: Jason C. Nucciarone --- src/slurmhelpers/models.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/slurmhelpers/models.py b/src/slurmhelpers/models.py index 4be2a68..99b7254 100644 --- a/src/slurmhelpers/models.py +++ b/src/slurmhelpers/models.py @@ -166,7 +166,7 @@ def generate_key(self) -> None: """ logging.info("Generating new secret file for service `munged`.") try: - subprocess.check_output(["mungectl", "generate"]) + subprocess.check_output(["mungectl", "key", "generate"]) except subprocess.CalledProcessError: logging.fatal("Failed to generate a new munge key") raise