EH: Add basic qalter wrapper (#44)

* EH: Add basic qalter wrapper

Author: dgruber

pkg/qalter/v9.0/qalter.go

@@ -0,0 +1,25 @@
+/*___INFO__MARK_BEGIN__*/
+/*************************************************************************
+*  Copyright 2025 HPC-Gridware GmbH
+*
+*  Licensed under the Apache License, Version 2.0 (the "License");
+*  you may not use this file except in compliance with the License.
+*  You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+*  Unless required by applicable law or agreed to in writing, software
+*  distributed under the License is distributed on an "AS IS" BASIS,
+*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*  See the License for the specific language governing permissions and
+*  limitations under the License.
+*
+************************************************************************/
+/*___INFO__MARK_END__*/
+
+package qalter
+
+// QAlter is the interface for the qalter command.
+type QAlter interface {
+	NativeSpecification(args ...string) (string, error)
+}

pkg/qalter/v9.0/qalter_impl.go

@@ -0,0 +1,75 @@
+/*___INFO__MARK_BEGIN__*/
+/*************************************************************************
+*  Copyright 2025 HPC-Gridware GmbH
+*
+*  Licensed under the Apache License, Version 2.0 (the "License");
+*  you may not use this file except in compliance with the License.
+*  You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+*  Unless required by applicable law or agreed to in writing, software
+*  distributed under the License is distributed on an "AS IS" BASIS,
+*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*  See the License for the specific language governing permissions and
+*  limitations under the License.
+*
+************************************************************************/
+/*___INFO__MARK_END__*/
+
+package qalter
+
+import (
+	"bytes"
+	"fmt"
+	"os/exec"
+	"time"
+)
+
+type CommandLineQAlter struct {
+	config CommandLineQAlterConfig
+}
+
+type CommandLineQAlterConfig struct {
+	Executable string
+	DryRun     bool
+	// DelayAfter is the time to wait after executing a command.
+	// This is useful for not overloading qmaster when 1000s of
+	// configuration objects (like queues) are defined.
+	DelayAfter time.Duration
+}
+
+// NewCommandLineQAlter creates a new instance of CommandLineQAlter.
+func NewCommandLineQAlter(config CommandLineQAlterConfig) (*CommandLineQAlter, error) {
+	if config.Executable == "" {
+		config.Executable = "qalter"
+	}
+	return &CommandLineQAlter{config: config}, nil
+}
+
+func (q *CommandLineQAlter) NativeSpecification(args []string) (string, error) {
+	return q.RunCommand(args...)
+}
+
+// RunCommand executes the qalter command with the specified arguments.
+func (c *CommandLineQAlter) RunCommand(args ...string) (string, error) {
+	if c.config.DryRun {
+		fmt.Printf("Executing: %s, %v", c.config.Executable, args)
+		return "", nil
+	}
+	cmd := exec.Command(c.config.Executable, args...)
+	var out bytes.Buffer
+	cmd.Stdout = &out
+	cmd.Stderr = &out
+	// ensure that qalter returns a single line of output for each entry
+	cmd.Env = append(cmd.Environ(), "SGE_SINGLE_LINE=true")
+	err := cmd.Run()
+	if c.config.DelayAfter != 0 {
+		<-time.After(c.config.DelayAfter)
+	}
+	if err != nil {
+		return out.String(), fmt.Errorf("failed to run command (%s): %v",
+			out.String(), err)
+	}
+	return out.String(), err
+}

pkg/qalter/v9.0/qalter_impl_test.go

@@ -0,0 +1,52 @@
+/*___INFO__MARK_BEGIN__*/
+/*************************************************************************
+*  Copyright 2025 HPC-Gridware GmbH
+*
+*  Licensed under the Apache License, Version 2.0 (the "License");
+*  you may not use this file except in compliance with the License.
+*  You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+*  Unless required by applicable law or agreed to in writing, software
+*  distributed under the License is distributed on an "AS IS" BASIS,
+*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*  See the License for the specific language governing permissions and
+*  limitations under the License.
+*
+************************************************************************/
+/*___INFO__MARK_END__*/
+
+package qalter_test
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	qalter "github.com/hpc-gridware/go-clusterscheduler/pkg/qalter/v9.0"
+)
+
+var _ = Describe("QalterImpl", func() {
+
+	Context("Basic functionality", func() {
+
+		It("should be able to create a new qalter instance", func() {
+			qalter, err := qalter.NewCommandLineQAlter(qalter.CommandLineQAlterConfig{})
+			Expect(qalter).NotTo(BeNil())
+			Expect(err).To(BeNil())
+		})
+
+		It("should be able to run in dry-run mode", func() {
+			qalter, err := qalter.NewCommandLineQAlter(qalter.CommandLineQAlterConfig{
+				DryRun: true,
+			})
+			Expect(qalter).NotTo(BeNil())
+			Expect(err).To(BeNil())
+			output, err := qalter.RunCommand("qalter", "-w", "p", "whymyjobnotrunning")
+			Expect(err).To(BeNil())
+			Expect(output).To(BeEmpty())
+		})
+
+	})
+
+})

pkg/qalter/v9.0/qalter_suite_test.go

@@ -0,0 +1,32 @@
+/*___INFO__MARK_BEGIN__*/
+/*************************************************************************
+*  Copyright 2025 HPC-Gridware GmbH
+*
+*  Licensed under the Apache License, Version 2.0 (the "License");
+*  you may not use this file except in compliance with the License.
+*  You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+*  Unless required by applicable law or agreed to in writing, software
+*  distributed under the License is distributed on an "AS IS" BASIS,
+*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*  See the License for the specific language governing permissions and
+*  limitations under the License.
+*
+************************************************************************/
+/*___INFO__MARK_END__*/
+
+package qalter_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestV9_0(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "V9.0 QalterSuite")
+}