reapi: use enum for go bindings match allocate

Problem: golang bindings for match allocate use strings to pass in
match options instead of using enum.

use enum match_op_t go go bindings. Change cgo include path to be
the base directory import of match_op.h.

Author: zekemorton

resource/CMakeLists.txt

@@ -22,7 +22,6 @@ set(RESOURCE_HEADERS
     traversers/dfu_impl.hpp
     policies/base/dfu_match_cb.hpp
     policies/base/matcher.hpp
-    policies/base/match_op.h
     readers/resource_namespace_remapper.hpp
     readers/resource_reader_base.hpp
     readers/resource_spec_grug.hpp

resource/reapi/bindings/go/src/fluxcli/reapi_cli.go

@@ -11,19 +11,14 @@
 package fluxcli
 
 /*
-#include "reapi_cli.h"
+#include "resource/reapi/bindings/c/reapi_cli.h"
 */
 import "C"
 import (
 	"fmt"
 	"unsafe"
-)
 
-const (
-	matchAllocate                = "allocate"
-	matchAllocateOrelseReserve   = "allocate_orelse_reserve"
-	matchAllocateWSatisfiability = "allocate_with_satisfiability"
-	matchSatisfiability          = "satisfiability"
+	"github.com/flux-framework/flux-sched/resource/reapi/bindings/go/src/pkg/types"
 )
 
 type (
@@ -105,14 +100,14 @@ func (cli *ReapiClient) InitContext(jgf string, options string) (err error) {
 //
 // \return          0 on success; -1 on error.
 func (cli *ReapiClient) Match(
-	match_op string,
+	match_op types.MatchType,
 	jobspec string,
 ) (reserved bool, allocated string, at int64, overhead float64, jobid uint64, err error) {
 	var r = C.CString("")
 	spec := C.CString(jobspec)
 
 	fluxerr := (int)(C.reapi_cli_match((*C.struct_reapi_cli_ctx)(cli.ctx),
-		(C.CString)(match_op),
+		C.match_op_t(match_op),
 		spec,
 		(*C.ulong)(&jobid),
 		(*C.bool)(&reserved),
@@ -154,12 +149,12 @@ func (cli *ReapiClient) MatchAllocate(
 	orelse_reserve bool,
 	jobspec string,
 ) (reserved bool, allocated string, at int64, overhead float64, jobid uint64, err error) {
-	var match_op string
+	var match_op types.MatchType
 
 	if orelse_reserve {
-		match_op = matchAllocateOrelseReserve
+		match_op = types.MatchAllocateOrElseReserve
 	} else {
-		match_op = matchAllocate
+		match_op = types.MatchAllocate
 	}
 
 	return cli.Match(match_op, jobspec)

resource/reapi/bindings/go/src/fluxmodule/reapi_module.go

@@ -10,18 +10,13 @@
 
 package fluxcli
 
-// #include "reapi_module.h"
+// #include "resource/reapi/bindings/c/reapi_module.h"
 import "C"
 import (
 	"fmt"
 	"unsafe"
-)
 
-const (
-	matchAllocate                = "allocate"
-	matchAllocateOrelseReserve   = "allocate_orelse_reserve"
-	matchAllocateWSatisfiability = "allocate_with_satisfiability"
-	matchSatisfiability          = "satisfiability"
+	"github.com/flux-framework/flux-sched/resource/reapi/bindings/go/src/pkg/types"
 )
 
 type (
@@ -62,7 +57,7 @@ func (m *ReapiModule) Destroy() {
 // int reapi_module_match_allocate (reapi_module_ctx_t *ctx, char *match_op,
 // at: is the scheduled time "at"
 func (m *ReapiModule) Match(
-	match_op string,
+	match_op types.MatchType,
 	jobspec string,
 	jobid int,
 ) (reserved bool, allocated string, at int64, overhead float64, err error) {
@@ -73,7 +68,7 @@ func (m *ReapiModule) Match(
 	spec := C.CString(jobspec)
 
 	fluxerr := (int)(C.reapi_module_match((*C.struct_reapi_module_ctx)(m.ctx),
-		(C.CString)(match_op),
+		C.match_op_t(match_op),
 		spec,
 		(C.ulong)(jobid),
 		(*C.bool)(&reserved),
@@ -99,9 +94,9 @@ func (m *ReapiModule) MatchAllocate(
 	var match_op string
 
 	if orelse_reserve {
-		match_op = matchAllocateOrelseReserve
+		match_op =types.MatchAllocateOrElseReserve
 	} else {
-		match_op = matchAllocate
+		match_op = types.MatchAllocate
 	}
 
 	return m.Match(match_op, jobspec, jobid)
@@ -112,7 +107,7 @@ func (m *ReapiModule) MatchSatisfy(
 	jobspec string,
 	jobid int,
 ) (reserved bool, allocated string, at int64, overhead float64, err error) {
-	match_op := matchSatisfiability
+	match_op := types.MatchSatisfiability
 	return m.Match(match_op, jobspec, jobid)
 }
 

resource/reapi/bindings/go/src/pkg/types/types.go

@@ -11,31 +11,23 @@ package types
 \*****************************************************************************/
 
 /*
-#include "reapi_cli.h"
-
-typedef enum {
-	MATCH_UNKNOWN = 0
-	MATCH_ALLOCATE = 1
-	MATCH_ALLOCATE_ORELSE_RESERVE = 2
-	MATCH_ALLOCATE_W_SATISFIABILITY = 3
-	MATCH_SATISFIABILITY = 4
-} match_op_enum;
+#include "resource/reapi/bindings/c/reapi_cli.h"
 
 /* usage:
 mt := MatchType
-C.match_op_enum(mt)
+C.match_op_t(mt)
 */
 
 import "C"
 
 type MatchType int
 
-// MatchUnknown serves as a sentinal value that it's undefined
+// MatchUnknown serves as a sentinel value that it's undefined
 const (
 	MatchUnknown                    MatchType = iota // unknown
 	MatchAllocate                                    // allocate
-	MatchAllocateOrElseReserve                       // allocate or else reserve
 	MatchAllocateWithSatisfiability                  // allocate with satisfiability
+	MatchAllocateOrElseReserve                       // allocate or else reserve
 	MatchSatisfiability                              // satisfiability
 )
 

resource/reapi/bindings/go/src/pkg/types/types_test.go

@@ -59,8 +59,8 @@ func TestAsInt(t *testing.T) {
 		{description: "unknown", input: MatchUnknown, expected: 0},
 		{description: "allocate", input: MatchAllocate, expected: 1},
 		{description: "satisfiability", input: MatchSatisfiability, expected: 4},
-		{description: "allocate or else reserve", input: MatchAllocateOrElseReserve, expected: 2},
-		{description: "allocate with satisfiability", input: MatchAllocateWithSatisfiability, expected: 3},
+		{description: "allocate or else reserve", input: MatchAllocateOrElseReserve, expected: 3},
+		{description: "allocate with satisfiability", input: MatchAllocateWithSatisfiability, expected: 2},
 	}
 	for _, item := range tests {
 		t.Run(item.description, func(t *testing.T) {

resource/reapi/bindings/go/src/test/CMakeLists.txt

@@ -1,6 +1,6 @@
 set(TARGET main)
 set(SRCS main.go)
-set(CGO_CFLAGS "-I${CMAKE_BINARY_DIR}/resource/reapi/bindings/c")
+set(CGO_CFLAGS "-I${CMAKE_BINARY_DIR}")
 
 # This is currently passed but not used because when passed into add_custom_command the spaces are escaped
 set(CGO_LIBRARY_FLAGS -Wl,-R

resource/reapi/bindings/go/src/test/main.go

@@ -16,6 +16,7 @@ import (
 	"os"
 
 	"github.com/flux-framework/flux-sched/resource/reapi/bindings/go/src/fluxcli"
+	"github.com/flux-framework/flux-sched/resource/reapi/bindings/go/src/pkg/types"
 )
 
 func main() {
@@ -61,7 +62,7 @@ func main() {
 	}
 	printOutput(reserved, allocated, at, jobid, err)
 
-	reserved, allocated, at, overhead, jobid, err = cli.Match("allocate", string(jobspec))
+	reserved, allocated, at, overhead, jobid, err = cli.Match(types.MatchAllocate, string(jobspec))
 	fmt.Println("Errors so far: \n", cli.GetErrMsg())
 
 	if err != nil {
@@ -70,7 +71,7 @@ func main() {
 	}
 	printOutput(reserved, allocated, at, jobid, err)
 
-	reserved, allocated, at, overhead, jobid, err = cli.Match("allocate_orelse_reserve", string(jobspec))
+	reserved, allocated, at, overhead, jobid, err = cli.Match(types.MatchAllocateOrElseReserve, string(jobspec))
 	fmt.Println("Errors so far: \n", cli.GetErrMsg())
 
 	if err != nil {
@@ -79,7 +80,7 @@ func main() {
 	}
 	printOutput(reserved, allocated, at, jobid, err)
 
-	reserved, allocated, at, overhead, jobid, err = cli.Match("allocate_with_satisfiability", string(jobspec))
+	reserved, allocated, at, overhead, jobid, err = cli.Match(types.MatchAllocateWithSatisfiability, string(jobspec))
 	fmt.Println("Errors so far: \n", cli.GetErrMsg())
 
 	if err != nil {